solid_cable 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9a6a47503cbd7f1e11a3ac05879bcf5eafb106f38ed0dc9b02726ba7152cd80
-  data.tar.gz: f754cc9413be68cdd822d5299f70ff75e6b8d59d26b332a9189a68d50a9bf50f
+  metadata.gz: 308be2095ff346a9b56b60f08d26adfabd2c2cfa24dbbf83f7e7df1a0b230b0e
+  data.tar.gz: 2875794b63122cb4b11297de037c733d8c91969e1372c1ebfc68dfdf21e7d04d
 SHA512:
-  metadata.gz: 9ace1cda46f5899bd5f13b9899ac7704b723291650b09d4a160ab5ecae32180e5240aa4d80355be6472921a01a4e8f45f7ee147a716be8ef2d9c2f1c5666eabb
-  data.tar.gz: b664e56ffaf4bb2062fe9a3d47c61d452b83a3a437748f9bd1188ac6ee5f83ad7fe2bfd27da77351ab9b59da17bf0b6b3694d0bf0bfe44fa0d01786a970c6b45
+  metadata.gz: 113f33268a0056e6233e3c4649f8a1acdbada127439ce47c1784e3c0f733ab7be68223f98b3f624ff7262ea21ec97a8480f52539995430e6f745c2075fca34ad
+  data.tar.gz: d153dfb2ac483315464cf2e3d4c870a4524c34ba48298e940511601ca9eae2d1ce07dcad5947426fcf3e4e9db2a694a4b6bd4f12cd854c1208384fa83707d59f

data/README.md

@@ -20,19 +20,57 @@ Or install it yourself as:
 $ gem install solid_cable
 ```
 
-Now, you need to install the necessary migrations and configure Action Cable's adapter.
+Now, you need to run the installer:
 
 ```bash
 $ bin/rails generate solid_cable:install
 ```
 
-If you want to install to a different database you can pass an env variable.
-```bash
-$ DATABASE=cable bin/rails generate solid_cable:install
+This will create the `db/cable_schema.rb` file.
+
+You will then have to add the configuration for the database in `config/database.yml`. If you're using SQLite, it'll look something like this:
+
+```yaml
+production:
+  primary:
+    <<: *default
+    database: storage/production.sqlite3
+  cable:
+    <<: *default
+    database: storage/production_cable.sqlite3
+    migrations_paths: db/cable_migrate
+```
+
+...or if you're using MySQL/PostgreSQL/Trilogy:
+
+```yaml
+production:
+  primary: &primary_production
+    <<: *default
+    database: app_production
+    username: app
+    password: <%= ENV["APP_DATABASE_PASSWORD"] %>
+  cable:
+    <<: *primary_production
+    database: app_production_cable
+    migrations_paths: db/cable_migrate
 ```
 
-Update `config/cable.yml` to use the new adapter. connects_to is can be omitted
-if you want to use the primary database.
+> [!NOTE]
+> Calling `bin/rails generate solid_cable:install` will automatically setup `config/cable.yml`, so no additional configuration is needed there (although you must make sure that you use the `cable` name in `database.yml` for this to match!). But if you want to use Solid Cable in a different environment (like staging or even development), you'll have to manually add that `connects_to` block to the respective environment in the `config/cable.yml` file. And, as always, make sure that the name you're using for the database in `config/cable.yml` matches the name you define in `config/database.yml`.
+
+Then run `db:prepare` in production to ensure the database is created and the schema is loaded.
+
+## Usage
+
+By default messages are kept around forever. SolidCable ships with a job to
+prune messages. You can run `SolidCable::PruneJob.perform_later` which removes
+Messages that are older than what is specified in `keep_messages_around_for`
+setting.
+
+## Configuration
+
+All configuration is managed via the `config/cable.yml`file. To use Solid Cable, the `adapter` value *must be* `solid_cable`. When using Solid Cable, the other values you can set are: `connects_to`, `polling_interval`, `silence_polling`, and `keep_messages_around_for`. For example:
 
 ```yaml
 default: &default
@@ -56,16 +94,5 @@ production:
   polling_interval: 0.1.seconds
 ```
 
-Finally, you need to run the migrations:
-
-```bash
-$ bin/rails db:migrate
-```
-
-By default messages are kept around forever. SolidCable ships with a job to
-prune messages. You can run `SolidCable::PruneJob.perform_later` which removes
-Messages that are older than what is specified in `keep_messages_around_for`
-setting.
-
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/generators/solid_cable/install/install_generator.rb

@@ -3,19 +3,36 @@
 class SolidCable::InstallGenerator < Rails::Generators::Base
   source_root File.expand_path("templates", __dir__)
 
-  class_option :database,
-               type: :string, aliases: %i(--db),
-               desc: "The database for your migration. By default, the " \
-                     "current environment's primary database is used."
-  class_option :skip_migrations, type: :boolean, default: nil,
-                                 desc: "Skip migrations"
+  def add_solid_errors_db_schema
+    template "cable_schema.rb"
+  end
+
+  def configure_production_cable
+    gsub_file("config/cable.yml",
+              old_production_cable_config,
+              new_production_cable_config)
+  end
 
-  def create_migrations
-    return if options[:skip_migrations]
+  private
 
-    db_clause = "DATABASE=#{options[:database]}" if options[:database].present?
+  def old_production_cable_config
+    <<~YAML
+      production:
+        adapter: redis
+        url: <%%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+        channel_prefix: <%= app_name %>_production
+    YAML
+  end
 
-    rails_command "railties:install:migrations FROM=solid_cable #{db_clause}".strip,
-                  inline: true
+  def new_production_cable_config
+    <<~YAML
+      production:
+        adapter: solid_cable
+        connects_to:
+          database:
+            writing: cable
+        polling_interval: 0.1.seconds
+        keep_messages_around_for: 1.day
+    YAML
   end
 end

data/lib/generators/solid_cable/install/templates/cable_schema.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+ActiveRecord::Schema[7.1].define(version: 1) do
+  create_table "solid_cable_messages", force: :cascade do |t|
+    t.text "channel"
+    t.text "payload"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["channel"], name: "index_solid_cable_messages_on_channel",
+                         length: 500
+    t.index ["created_at"], name: "index_solid_cable_messages_on_created_at"
+  end
+end

data/lib/solid_cable/railtie.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SolidCable
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/solid_cable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidCable
-  VERSION = "1.0.2"
+  VERSION = "1.0.4"
 end

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: solid_cable
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Nick Pezza
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-11 00:00:00.000000000 Z
+date: 2024-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: concurrent-ruby
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '9'
+        version: '7.2'
 description: Database-backed Action Cable backend.
 email:
 - pezza@hey.com
@@ -51,13 +37,13 @@ files:
 - app/jobs/solid_cable/prune_job.rb
 - app/models/solid_cable/message.rb
 - app/models/solid_cable/record.rb
-- db/migrate/20240103034713_create_solid_cable_message.rb
-- db/migrate/20240607184711_index_channels.rb
 - lib/action_cable/subscription_adapter/solid_cable.rb
 - lib/generators/solid_cable/install/USAGE
 - lib/generators/solid_cable/install/install_generator.rb
+- lib/generators/solid_cable/install/templates/cable_schema.rb
 - lib/solid_cable.rb
 - lib/solid_cable/engine.rb
+- lib/solid_cable/railtie.rb
 - lib/solid_cable/version.rb
 homepage: http://github.com/npezza93/solid_cable
 licenses:
@@ -74,14 +60,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: Database-backed Action Cable backend.

data/db/migrate/20240103034713_create_solid_cable_message.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-class CreateSolidCableMessage < ActiveRecord::Migration[7.1]
-  def change
-    create_table :solid_cable_messages, if_not_exists: true do |t|
-      t.text :channel
-      t.text :payload
-
-      t.timestamps
-
-      t.index :created_at
-    end
-  end
-end

data/db/migrate/20240607184711_index_channels.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-class IndexChannels < ActiveRecord::Migration[7.1]
-  def change
-    add_index :solid_cable_messages, :channel, length: 500
-  end
-end