solid_cable 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a86a886aa1ce9834ba57de871e4d24539bac07799d4fae79add90fb62f5d3de
-  data.tar.gz: 4bab771f89c8f57dbc9e6473d9ddf4e76dfa1136f6230d940b639de68b0e8fa2
+  metadata.gz: bc6eab3ef9348ae133b005484482e8dccefe7c98aadeb8810ca23b632a976783
+  data.tar.gz: 1f867d1c133390a0894956c1c621e8e561b4bf1de14096196ae1768a541c59ac
 SHA512:
-  metadata.gz: a04ebc9e56a752312afe728b2b64b105b4b88c9f53b798b2028ddb5fb1e111ab33b89e6af006f8ebfb9b9080808f5d2ac512914db9656b46dca94252d41eb630
-  data.tar.gz: c571e0388c3eb6ca10b054c920f5ece841ce5eae0940edbe87eea514b0812653bcc85a454de9653f5c56ee992f948787536e2ccf8de9436ad72520351e79e91e
+  metadata.gz: 1d6ffad7a1564e2e2aaa20cc5bf459fe630a6e739fb574c5eb0509ea6c3bfa31e38d47ac75a5ea74e2293c87804445d2700b9f4e1cecafd199724d07850cf433
+  data.tar.gz: 3caf1229b5582c91d9c06d7e18a32d79edff83c9453c2ca387b713b9d7caef985a4667faed648aa6c7a95c9174440594c3fd0e83b99d9c261dc9b9ee3259f99a

data/README.md

@@ -26,22 +26,34 @@ Now, you need to install the necessary migrations and configure Action Cable's a
 $ bin/rails generate solid_cable:install
 ```
 
-Update `config/cable.yml` to use the new adapter:
+If you want to install to a different database you can pass an env variable.
+```bash
+$ DATABASE=cable bin/rails generate solid_cable:install
+```
+
+Update `config/cable.yml` to use the new adapter. connects_to is can be omitted
+if you want to use the primary database.
 
 ```yaml
-development:
+default: &default
   adapter: solid_cable
+  polling_interval: 1.second
+  keep_messages_around_for: 1.day
+
+development:
+  <<: *default
   silence_polling: true
-  polling_interval: 1
-  keep_messages_around_for: 30.minutes
+  connects_to:
+    database:
+      writing: solid_cable_primary
+      reading: solid_cable_replica
 
 test:
   adapter: test
 
 production:
-  adapter: solid_cable
-  polling_interval: 0.1
-  keep_messages_around_for: 10.minutes
+  <<: *default
+  polling_interval: 0.1.seconds
 ```
 
 Finally, you need to run the migrations:
@@ -50,5 +62,10 @@ Finally, you need to run the migrations:
 $ 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/app/models/jobs/solid_cable/prune_job.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module SolidCable
+  class PruneJob < ActiveJob::Base
+    def perform
+      ::SolidCable::Message.prunable.delete_all
+    end
+  end
+end

data/app/models/solid_cable/message.rb

@@ -8,9 +8,5 @@ module SolidCable
     scope :broadcastable, lambda { |channels, last_id|
       where(channel: channels).where(id: (last_id + 1)..).order(:id)
     }
-
-    def self.prune
-      prunable.delete_all
-    end
   end
 end

data/db/migrate/20240607184711_index_channels.rb

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

data/lib/action_cable/subscription_adapter/solid_cable.rb

@@ -11,7 +11,7 @@ module ActionCable
       end
 
       def broadcast(channel, payload)
-        ::SolidCable::Message.create(channel:, payload:)
+        ::SolidCable::Message.insert({ channel:, payload: })
       end
 
       def subscribe(channel, callback, success_callback = nil)
@@ -64,8 +64,6 @@ module ActionCable
 
         def remove_channel(channel)
           channels.delete(channel)
-
-          ::SolidCable::Message.prune
         end
 
         def invoke_callback(*)

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

@@ -3,13 +3,19 @@
 class SolidCable::InstallGenerator < Rails::Generators::Base
   source_root File.expand_path("templates", __dir__)
 
-  class_option :skip_migrations, type: :boolean, default: nil, 
+  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 create_migrations
     return if options[:skip_migrations]
 
-      rails_command "railties:install:migrations FROM=solid_cable", inline: true
-    
+    db_clause = "DATABASE=#{options[:database]}" if options[:database].present?
+
+    rails_command "railties:install:migrations FROM=solid_cable #{db_clause}".strip,
+                  inline: true
   end
 end

data/lib/solid_cable/engine.rb

@@ -3,13 +3,5 @@
 module SolidCable
   class Engine < ::Rails::Engine
     isolate_namespace SolidCable
-
-    config.solid_cable = ActiveSupport::OrderedOptions.new
-
-    initializer "solid_cable.config" do
-      config.solid_cable.each do |name, value|
-        SolidCable.public_send("#{name}=", value)
-      end
-    end
   end
 end

data/lib/solid_cable/version.rb

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

data/lib/solid_cable.rb

@@ -5,24 +5,36 @@ require "solid_cable/engine"
 require "action_cable/subscription_adapter/solid_cable"
 
 module SolidCable
-  mattr_accessor :connects_to
+  class << self
+    def connects_to
+      cable_config.connects_to
+    end
 
-  def self.silence_polling?
-    !!Rails.application.config_for("cable")[:silence_polling]
-  end
+    def silence_polling?
+      !!cable_config.silence_polling
+    end
 
-  def self.polling_interval
-    Rails.application.config_for("cable")[:polling_interval].presence || 0.1
-  end
+    def polling_interval
+      parse_duration(cable_config.polling_interval, default: 0.1.seconds)
+    end
 
-  def self.keep_messages_around_for
-    duration = Rails.application.config_for("cable")[:keep_messages_around_for]
+    def keep_messages_around_for
+      parse_duration(cable_config.keep_messages_around_for, default: 1.day)
+    end
+
+    private
+
+    def cable_config
+      Rails.application.config_for("cable")
+    end
 
-    if duration.present?
-      amount, units = duration.to_s.split(".")
-      amount.to_i.public_send(units)
-    else
-      30.minutes
+    def parse_duration(duration, default:)
+      if duration.present?
+        *amount, units = duration.to_s.split(".")
+        amount.join(".").to_f.public_send(units)
+      else
+        default
+      end
     end
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: solid_cable
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Nick Pezza
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-28 00:00:00.000000000 Z
+date: 2024-06-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  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
@@ -34,9 +48,11 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/models/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