npmpackage.info

@rails/actioncable

Ruby on Rails

8.0.0

56,132

MIT

Ruby

2.98 kB

106,871,889 6

Installations

npm install @rails/actioncable

Score

99.7

Supply Chain

77.3

Quality

97.8

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

730

Total

35,595

Closed

10,611

Merged

24,254

Issues

Open

527

Total

17,772

Closed

17,245

Releases

140

8.0.0

v8.0.0

Published on 07 Nov 2024

7.2.2

v7.2.2

Published on 31 Oct 2024

7.1.5

v7.1.5

Published on 31 Oct 2024

8.0.0.rc2

v8.0.0.rc2

Published on 30 Oct 2024

7.2.1.2

v7.2.1.2

Published on 23 Oct 2024

7.1.4.2

v7.1.4.2

Published on 23 Oct 2024

View all 140 releases

Developer

rails

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

22.10.0

NPM Version

10.9.0 Statistics

56,132 Stars

93,793 Commits

21,700 Forks

2,325 Watching

62 Branches

5,094 Contributors

Updated on 27 Nov 2024

Bundle Size

9.70 kB

Minified

2.98 kB

Minified + Gzipped

Bundlephobia

Languages

Ruby (97%)

JavaScript (1.3%)

HTML (1.13%)

SCSS (0.29%)

CSS (0.27%)

Dockerfile (0.01%)

Total Downloads

Cumulative downloads

Total Downloads

106,871,889

Last day

7.6%

173,169

Compared to previous day

Last week

11.7%

843,469

Compared to previous week

Last month

18.4%

3,288,607

Compared to previous month

Last year

17.6%

32,782,500

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@rollup/plugin-commonjs @rollup/plugin-node-resolve eslint eslint-plugin-import karma karma-chrome-launcher karma-qunit karma-sauce-launcher mock-socket qunit rollup rollup-plugin-terser

Versions

Welcome to Rails

What's Rails?

Rails is a web-application framework that includes everything needed to create database-backed web applications according to the Model-View-Controller (MVC) pattern.

Understanding the MVC pattern is key to understanding Rails. MVC divides your application into three layers: Model, View, and Controller, each with a specific responsibility.

Model layer

The Model layer represents the domain model (such as Account, Product, Person, Post, etc.) and encapsulates the business logic specific to your application. In Rails, database-backed model classes are derived from ActiveRecord::Base. Active Record allows you to present the data from database rows as objects and embellish these data objects with business logic methods. Although most Rails models are backed by a database, models can also be ordinary Ruby classes, or Ruby classes that implement a set of interfaces as provided by the Active Model module.

View layer

The View layer is composed of "templates" that are responsible for providing appropriate representations of your application's resources. Templates can come in a variety of formats, but most view templates are HTML with embedded Ruby code (ERB files). Views are typically rendered to generate a controller response or to generate the body of an email. In Rails, View generation is handled by Action View.

Controller layer

The Controller layer is responsible for handling incoming HTTP requests and providing a suitable response. Usually, this means returning HTML, but Rails controllers can also generate XML, JSON, PDFs, mobile-specific views, and more. Controllers load and manipulate models, and render view templates in order to generate the appropriate HTTP response. In Rails, incoming requests are routed by Action Dispatch to an appropriate controller, and controller classes are derived from ActionController::Base. Action Dispatch and Action Controller are bundled together in Action Pack.

Frameworks and libraries

Active Record, Active Model, Action Pack, and Action View can each be used independently outside Rails.

In addition to that, Rails also comes with:

Action Mailer, a library to generate and send emails
Action Mailbox, a library to receive emails within a Rails application
Active Job, a framework for declaring jobs and making them run on a variety of queuing backends
Action Cable, a framework to integrate WebSockets with a Rails application
Active Storage, a library to attach cloud and local files to Rails applications
Action Text, a library to handle rich text content
Active Support, a collection of utility classes and standard library extensions that are useful for Rails, and may also be used independently outside Rails

Getting Started

Install Rails at the command prompt if you haven't yet:
```
1$ gem install rails
```
At the command prompt, create a new Rails application:
```
1$ rails new myapp
```
where "myapp" is the application name.
Change directory to myapp and start the web server:
```
1$ cd myapp
2$ bin/rails server
```
Run with --help or -h for options.
Go to http://localhost:3000 and you'll see the Rails bootscreen with your Rails and Ruby versions.
Follow the guidelines to start developing your application. You may find the following resources handy:

Contributing

We encourage you to contribute to Ruby on Rails! Please check out the Contributing to Ruby on Rails guide for guidelines about how to proceed. Join us!

Trying to report a possible security vulnerability in Rails? Please check out our security policy for guidelines about how to proceed.

Everyone interacting in Rails and its sub-projects' codebases, issue trackers, chat rooms, and mailing lists is expected to follow the Rails code of conduct.

License

Ruby on Rails is released under the MIT License.

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Security-Policy

Determines if the project has published a security policy.

10

License

Determines if the project has defined a license.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

8

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

3

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

2

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Info: Possibly incomplete results: error parsing shell code: a command can only contain words and redirects; encountered (: railties/lib/rails/generators/rails/app/templates/Dockerfile.tt:17-19
Info: Possibly incomplete results: error parsing shell code: a command can only contain words and redirects; encountered (: railties/lib/rails/generators/rails/app/templates/Dockerfile.tt:31-33
Info: Possibly incomplete results: error parsing shell code: > must be followed by a word: railties/lib/rails/generators/rails/app/templates/Dockerfile.tt:56-58
Info: Possibly incomplete results: error parsing shell code: a command can only contain words and redirects; encountered (: railties/lib/rails/generators/rails/app/templates/Dockerfile.tt:103-105
Info: Possibly incomplete results: error parsing shell code: > must be followed by a word: railties/lib/rails/generators/rails/app/templates/docker-entrypoint.tt:0
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/devcontainer-smoke-test.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/rails/rails/devcontainer-smoke-test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/devcontainer-smoke-test.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/rails/rails/devcontainer-smoke-test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/devcontainer-smoke-test.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/rails/rails/devcontainer-smoke-test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/devcontainer-smoke-test.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/rails/rails/devcontainer-smoke-test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/devcontainer-smoke-test.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/rails/rails/devcontainer-smoke-test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/devcontainer-smoke-test.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/rails/rails/devcontainer-smoke-test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/devcontainer-smoke-test.yml:88: update your workflow using https://app.stepsecurity.io/secureworkflow/rails/rails/devcontainer-smoke-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rail_inspector.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/rails/rails/rail_inspector.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/rail_inspector.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/rails/rails/rail_inspector.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rails-new-docker.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/rails/rails/rails-new-docker.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/rails-new-docker.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/rails/rails/rails-new-docker.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/rails-new-docker.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/rails/rails/rails-new-docker.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rails_releaser_tests.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/rails/rails/rails_releaser_tests.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/rails_releaser_tests.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/rails/rails/rails_releaser_tests.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/rails/rails/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/rails/rails/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/rails/rails/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/rails/rails/release.yml/main?enable=pin
Warn: containerImage not pinned by hash: .devcontainer/Dockerfile:5
Warn: containerImage not pinned by hash: railties/lib/rails/generators/rails/app/templates/Dockerfile.tt:12
Warn: containerImage not pinned by hash: railties/lib/rails/generators/rails/app/templates/Dockerfile.tt:29
Warn: containerImage not pinned by hash: railties/lib/rails/generators/rails/app/templates/Dockerfile.tt:97
Warn: containerImage not pinned by hash: railties/lib/rails/generators/rails/devcontainer/templates/devcontainer/Dockerfile.tt:3
Warn: containerImage not pinned by hash: railties/test/fixtures/Dockerfile.test:5
Warn: containerImage not pinned by hash: railties/test/fixtures/Dockerfile.test:21
Warn: containerImage not pinned by hash: railties/test/fixtures/Dockerfile.test:42
Warn: npmCommand not pinned by hash: railties/lib/rails/generators/rails/app/templates/Dockerfile.tt:41-44
Warn: downloadThenRun not pinned by hash: railties/lib/rails/generators/rails/app/templates/Dockerfile.tt:51
Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 12 third-party GitHubAction dependencies pinned
Info: 0 out of 1 npmCommand dependencies pinned
Info: 0 out of 1 downloadThenRun dependencies pinned
Info: 0 out of 8 containerImage dependencies pinned

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

6

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @rails/actioncable

@types/rails__actioncable

6.1.11

TypeScript definitions for @rails/actioncable

action-cable-react-jwt

0.0.5

Rails actioncable integration with JWT Authentication for React and ReactNative

actioncable-js-jwt

0.6.3

Rails actioncable integration with JWT Authentication for React and ReactNative

ngx-actioncable

4.0.0

Library for real-time communication over websockets with Rails ActionCable.