cable_ready 4.4.3 → 5.0.0.pre1

data/lib/cable_ready/sanity_checker.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+class CableReady::SanityChecker
+  LATEST_VERSION_FORMAT = /^(\d+\.\d+\.\d+)$/
+  NODE_VERSION_FORMAT = /(\d+\.\d+\.\d+.*):/
+  JSON_VERSION_FORMAT = /(\d+\.\d+\.\d+.*)"/
+
+  class << self
+    def check!
+      return if CableReady.config.on_failed_sanity_checks == :ignore
+      return if called_by_generate_config?
+
+      instance = new
+      instance.check_javascript_package_version
+      instance.check_new_version_available
+    end
+
+    private
+
+    def called_by_generate_config?
+      ARGV.include? "cable_ready:initializer"
+    end
+  end
+
+  def check_javascript_package_version
+    if javascript_package_version.nil?
+      warn_and_exit <<~WARN
+        Can't locate the cable_ready npm package.
+        Either add it to your package.json as a dependency or use "yarn link cable_ready" if you are doing development.
+      WARN
+    end
+
+    unless javascript_version_matches?
+      warn_and_exit <<~WARN
+        The cable_ready npm package version (#{javascript_package_version}) does not match the Rubygem version (#{gem_version}).
+        To update the cable_ready npm package:
+          yarn upgrade cable_ready@#{gem_version}
+      WARN
+    end
+  end
+
+  def check_new_version_available
+    return unless Rails.env.development?
+    return if CableReady.config.on_new_version_available == :ignore
+    return unless using_stable_release
+    begin
+      latest_version = URI.open("https://raw.githubusercontent.com/stimulusreflex/cable_ready/master/LATEST", open_timeout: 1, read_timeout: 1).read.strip
+      if latest_version != CableReady::VERSION
+        puts <<~WARN
+
+          There is a new version of CableReady available!
+          Current: #{CableReady::VERSION} Latest: #{latest_version}
+
+          If you upgrade, it is very important that you update BOTH Gemfile and package.json
+          Then, run `bundle install && yarn install` to update to #{latest_version}.
+
+        WARN
+        exit if CableReady.config.on_new_version_available == :exit
+      end
+    rescue
+      puts "CableReady #{CableReady::VERSION} update check skipped: connection timeout"
+    end
+  end
+
+  private
+
+  def javascript_version_matches?
+    javascript_package_version == gem_version
+  end
+
+  def using_stable_release
+    stable = CableReady::VERSION.match?(LATEST_VERSION_FORMAT)
+    puts "CableReady #{CableReady::VERSION} update check skipped: pre-release build" unless stable
+    stable
+  end
+
+  def gem_version
+    @_gem_version ||= CableReady::VERSION.gsub(".pre", "-pre")
+  end
+
+  def javascript_package_version
+    @_js_version ||= find_javascript_package_version
+  end
+
+  def find_javascript_package_version
+    if (match = search_file(package_json_path, regex: /version/))
+      match[JSON_VERSION_FORMAT, 1]
+    elsif (match = search_file(yarn_lock_path, regex: /^cable_ready/))
+      match[NODE_VERSION_FORMAT, 1]
+    end
+  end
+
+  def search_file(path, regex:)
+    return unless File.exist?(path)
+    File.foreach(path).grep(regex).first
+  end
+
+  def package_json_path
+    Rails.root.join("node_modules", "cable_ready", "package.json")
+  end
+
+  def yarn_lock_path
+    Rails.root.join("yarn.lock")
+  end
+
+  def initializer_path
+    @_initializer_path ||= Rails.root.join("config", "initializers", "cable_ready.rb")
+  end
+
+  def warn_and_exit(text)
+    puts "WARNING:"
+    puts text
+    exit_with_info if CableReady.config.on_failed_sanity_checks == :exit
+  end
+
+  def exit_with_info
+    puts
+
+    if File.exist?(initializer_path)
+      puts <<~INFO
+        If you know what you are doing and you want to start the application anyway,
+        you can add the following directive to the CableReady initializer,
+        which is located at #{initializer_path}
+
+          CableReady.configure do |config|
+            config.on_failed_sanity_checks = :warn
+          end
+
+      INFO
+    else
+      puts <<~INFO
+        If you know what you are doing and you want to start the application anyway,
+        you can create a CableReady initializer with the command:
+
+        bundle exec rails generate cable_ready:config
+
+        Then open your initializer at
+
+        #{initializer_path}
+
+        and then add the following directive:
+
+          CableReady.configure do |config|
+            config.on_failed_sanity_checks = :warn
+          end
+
+      INFO
+    end
+    exit false unless Rails.env.test?
+  end
+end

data/lib/cable_ready/stream_identifier.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CableReady
+  module StreamIdentifier
+    def verified_stream_identifier(signed_stream_identifier)
+      CableReady.signed_stream_verifier.verified signed_stream_identifier
+    end
+
+    def signed_stream_identifier(compoundable)
+      CableReady.signed_stream_verifier.generate compoundable
+    end
+  end
+end

data/lib/cable_ready/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CableReady
-  VERSION = "4.4.3"
+  VERSION = "5.0.0.pre1"
 end

data/lib/generators/cable_ready/channel_generator.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+class CableReady::ChannelGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("templates", __dir__)
+
+  class_option :stream_from, type: :string
+  class_option :stream_for, type: :string
+  class_option :stimulus, type: :boolean
+
+  def check_options
+    raise "Can't specify --stream-from and --stream-for at the same time" if options.key?(:stream_from) && options.key?(:stream_for)
+  end
+
+  def create_channel
+    generate "channel", file_name
+  end
+
+  def enhance_channels
+    if using_broadcast_to?
+      gsub_file "app/channels/#{file_name}_channel.rb", /# stream_from.*\n/, "stream_for #{resource}.find(params[:id])\n"
+      template "app/javascript/controllers/%file_name%_controller.js" if using_stimulus?
+    else
+      prepend_to_file "app/javascript/channels/#{file_name}_channel.js", "import CableReady from 'cable_ready'\n"
+      inject_into_file "app/javascript/channels/#{file_name}_channel.js", after: "// Called when there's incoming data on the websocket for this channel\n" do
+        <<-JS
+    if (data.cableReady) CableReady.perform(data.operations)
+        JS
+      end
+
+      gsub_file "app/channels/#{file_name}_channel.rb", /# stream_from.*\n/, "stream_from \"#{identifier}\"\n"
+    end
+  end
+
+  private
+
+  def option_given?
+    options.key?(:stream_from) || options.key?(:stream_for)
+  end
+
+  def using_broadcast_to?
+    @using_broadcast_to ||= option_given? ? options.key?(:stream_for) : yes?("Are you streaming to a resource using broadcast_to? (y/N)")
+  end
+
+  def using_stimulus?
+    @using_stimulus ||= options.fetch(:stimulus) {
+      yes?("Are you going to use a Stimulus controller to subscribe to this channel? (y/N)")
+    }
+  end
+
+  def resource
+    return @resource if @resource
+
+    stream_for = options.fetch(:stream_for) {
+      ask("Which resource are you streaming for?", default: class_name)
+    }
+
+    stream_for = file_name if stream_for == "stream_for"
+    @resource = stream_for.camelize
+  end
+
+  def identifier
+    return @identifier if @identifier
+
+    stream_from = options.fetch(:stream_from) {
+      ask("What is the stream identifier that goes into stream_from?", default: file_name)
+    }
+
+    stream_from = file_name if stream_from == "stream_from"
+    @identifier = stream_from.underscore
+  end
+end

data/lib/generators/cable_ready/initializer_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module CableReady
+  class InitializerGenerator < Rails::Generators::Base
+    desc "Creates a CableReady initializer template in config/initializers"
+    source_root File.expand_path("templates", __dir__)
+
+    def copy_initializer_file
+      copy_file "config/initializers/cable_ready.rb"
+    end
+  end
+end

data/lib/generators/cable_ready/stream_from_generator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "fileutils"
+
+module CableReady
+  class StreamFromGenerator < Rails::Generators::Base
+    desc "Initializes CableReady with a reference to the shared ActionCable consumer"
+    source_root File.expand_path("templates", __dir__)
+
+    def copy_controller_file
+      main_folder = defined?(Webpacker) ? Webpacker.config.source_path.to_s.gsub("#{Rails.root}/", "") : "app/javascript"
+
+      filepath = [
+        "#{main_folder}/controllers/index.js",
+        "#{main_folder}/controllers/index.ts",
+        "#{main_folder}/packs/application.js",
+        "#{main_folder}/packs/application.ts"
+      ]
+        .select { |path| File.exist?(path) }
+        .map { |path| Rails.root.join(path) }
+        .first
+
+      lines = File.open(filepath, "r") { |f| f.readlines }
+
+      unless lines.find { |line| line.start_with?("import CableReady") }
+        matches = lines.select { |line| line =~ /\A(require|import)/ }
+        lines.insert lines.index(matches.last).to_i + 1, "import CableReady from 'cable_ready'\n"
+        File.open(filepath, "w") { |f| f.write lines.join }
+      end
+
+      unless lines.find { |line| line.start_with?("import consumer") }
+        matches = lines.select { |line| line =~ /\A(require|import)/ }
+        lines.insert lines.index(matches.last).to_i + 1, "import consumer from '../channels/consumer'\n"
+        File.open(filepath, "w") { |f| f.write lines.join }
+      end
+
+      unless lines.find { |line| line.include?("CableReady.initialize({ consumer })") }
+        append_to_file filepath, "CableReady.initialize({ consumer })"
+      end
+    end
+  end
+end

data/lib/generators/cable_ready/templates/config/initializers/cable_ready.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+CableReady.configure do |config|
+  # Enable/disable exiting / warning when the sanity checks fail options:
+  # `:exit` or `:warn` or `:ignore`
+
+  # config.on_failed_sanity_checks = :exit
+
+  # Enable/disable exiting / warning when there's a new CableReady release
+  # `:exit` or `:warn` or `:ignore`
+
+  # config.on_new_version_available = :ignore
+
+  # Define your own custom operations
+  # https://cableready.stimulusreflex.com/customization#custom-operations
+
+  # config.add_operation_name :jazz_hands
+end

data/test/lib/cable_ready/cable_car_test.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require_relative "../../../lib/cable_ready"
+
+class CableReady::CableCarTest < ActiveSupport::TestCase
+  setup do
+    @cable_car = CableReady::CableCar.instance
+  end
+
+  test "dispatch should return json-ifiable payload" do
+    CableReady::CableCar.instance.reset!
+    dispatch = CableReady::CableCar.instance.inner_html(selector: "#users", html: "<span>winning</span>").dispatch
+    assert_equal({"innerHtml" => [{"selector" => "#users", "html" => "<span>winning</span>"}]}, dispatch)
+  end
+
+  test "dispatch should clear operations" do
+    CableReady::CableCar.instance.reset!
+    CableReady::CableCar.instance.inner_html(selector: "#users", html: "<span>winning</span>").dispatch
+    assert_equal({}, CableReady::CableCar.instance.instance_variable_get(:@enqueued_operations))
+  end
+
+  test "dispatch should maintain operations if clear is false" do
+    CableReady::CableCar.instance.reset!
+    CableReady::CableCar.instance.inner_html(selector: "#users", html: "<span>winning</span>").dispatch(clear: false)
+    assert_equal({"inner_html" => [{"selector" => "#users", "html" => "<span>winning</span>"}]}, CableReady::CableCar.instance.instance_variable_get(:@enqueued_operations))
+  end
+end

data/test/lib/cable_ready/identifiable_test.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require_relative "../../../lib/cable_ready"
+
+class User
+  include ActiveModel::Model
+
+  attr_accessor :id
+end
+
+class CableReady::IdentifiableTest < ActiveSupport::TestCase
+  include CableReady::Identifiable
+
+  test "should handle nil" do
+    assert_equal "#", dom_id(nil)
+  end
+
+  test "should work with strings" do
+    assert_equal "#users", dom_id("users")
+    assert_equal "#users", dom_id("users  ")
+    assert_equal "#users", dom_id("  users  ")
+  end
+
+  test "should work with symbols" do
+    assert_equal "#users", dom_id(:users)
+    assert_equal "#active_users", dom_id(:active_users)
+  end
+
+  test "should just return one hash" do
+    assert_equal "#users", dom_id("users")
+    assert_equal "#users", dom_id("#users")
+    assert_equal "#users", dom_id("##users")
+  end
+
+  test "should strip prefixes" do
+    assert_equal "#active_users", dom_id("  users ", "     active    ")
+    assert_equal "#all_active_users", dom_id(" users  ", "  all_active ")
+  end
+
+  test "should not include provided prefix if prefix is nil" do
+    assert_equal "#users", dom_id("users", nil)
+  end
+
+  test "should work with ActiveRecord::Relation" do
+    relation = mock("ActiveRecord::Relation")
+
+    relation.stubs(:is_a?).with(ActiveRecord::Relation).returns(true).at_least_once
+    relation.stubs(:is_a?).with(ActiveRecord::Base).never
+    relation.stubs(:model_name).returns(OpenStruct.new(plural: "users"))
+
+    assert_equal "#users", dom_id(relation)
+    assert_equal "#users", dom_id(relation, nil)
+    assert_equal "#active_users", dom_id(relation, "active")
+  end
+
+  test "should work with ActiveRecord::Base" do
+    User.any_instance.stubs(:is_a?).with(ActiveRecord::Relation).returns(false)
+    User.any_instance.stubs(:is_a?).with(ActiveRecord::Base).returns(true)
+
+    assert_equal "#new_user", dom_id(User.new(id: nil))
+
+    user = User.new(id: 42)
+
+    assert_equal "#user_42", dom_id(user)
+    assert_equal "#user_42", dom_id(user, nil)
+    assert_equal "#all_active_user_42", dom_id(user, "all_active")
+
+    user = User.new(id: 99)
+
+    assert_equal "#user_99", dom_id(user)
+    assert_equal "#user_99", dom_id(user, nil)
+    assert_equal "#all_active_user_99", dom_id(user, "all_active")
+  end
+end

data/test/lib/cable_ready/operation_builder_test.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require_relative "../../../lib/cable_ready"
+
+class CableReady::OperationBuilderTest < ActiveSupport::TestCase
+  setup do
+    @operation_builder = CableReady::OperationBuilder.new("test")
+  end
+
+  test "should create enqueued operations" do
+    assert_not_nil @operation_builder.instance_variable_get(:@enqueued_operations)
+  end
+
+  test "should add observer to cable ready" do
+    assert_not_nil CableReady.config.instance_variable_get(:@observer_peers)[@operation_builder]
+  end
+
+  test "should remove observer when destroyed" do
+    @operation_builder = nil
+    assert_nil CableReady.config.instance_variable_get(:@observer_peers)[@operation_builder]
+  end
+
+  test "should add operation method" do
+    @operation_builder.add_operation_method("foobar")
+    assert @operation_builder.respond_to?(:foobar)
+  end
+
+  test "added operation method should add keys" do
+    @operation_builder.add_operation_method("foobar")
+    @operation_builder.foobar({name: "passed_option"})
+
+    operations = @operation_builder.instance_variable_get(:@enqueued_operations)
+
+    assert_equal 1, operations["foobar"].size
+    assert_equal({"name" => "passed_option"}, operations["foobar"].first)
+  end
+
+  test "should json-ify operations" do
+    @operation_builder.add_operation_method("foobar")
+    @operation_builder.foobar({name: "passed_option"})
+    assert_equal("{\"foobar\":[{\"name\":\"passed_option\"}]}", @operation_builder.to_json)
+  end
+
+  test "should apply! many operations" do
+    @operation_builder.apply!(foobar: [{name: "passed_option"}])
+
+    operations = @operation_builder.instance_variable_get(:@enqueued_operations)
+    assert_equal 1, operations["foobar"].size
+    assert_equal({"name" => "passed_option"}, operations["foobar"].first)
+  end
+
+  test "should apply! many operations from a string" do
+    @operation_builder.apply!(JSON.generate({foobar: [{name: "passed_option"}]}))
+
+    operations = @operation_builder.instance_variable_get(:@enqueued_operations)
+    assert_equal 1, operations["foobar"].size
+    assert_equal({"name" => "passed_option"}, operations["foobar"].first)
+  end
+
+  test "operations payload should omit empty operations" do
+    @operation_builder.add_operation_method("foobar")
+    payload = @operation_builder.operations_payload
+    assert_equal({}, payload)
+  end
+
+  test "operations payload should camelize keys" do
+    @operation_builder.add_operation_method("foo_bar")
+    @operation_builder.foo_bar({beep_boop: "passed_option"})
+    assert_equal({"fooBar" => [{"beepBoop" => "passed_option"}]}, @operation_builder.operations_payload)
+  end
+
+  test "should take first argument as selector" do
+    @operation_builder.add_operation_method("inner_html")
+
+    @operation_builder.inner_html("#smelly", html: "<span>I rock</span>")
+
+    operations = {
+      "innerHtml" => [{"html" => "<span>I rock</span>", "selector" => "#smelly"}]
+    }
+
+    assert_equal(operations, @operation_builder.operations_payload)
+  end
+
+  test "should use previously passed selector in next operation" do
+    @operation_builder.add_operation_method("inner_html")
+    @operation_builder.add_operation_method("set_focus")
+
+    @operation_builder.set_focus("#smelly").inner_html(html: "<span>I rock</span>")
+
+    operations = {
+      "setFocus" => [{"selector" => "#smelly"}],
+      "innerHtml" => [{"html" => "<span>I rock</span>", "selector" => "#smelly"}]
+    }
+
+    assert_equal(operations, @operation_builder.operations_payload)
+  end
+
+  test "should clear previous_selector after calling reset!" do
+    @operation_builder.add_operation_method("inner_html")
+    @operation_builder.inner_html(selector: "#smelly", html: "<span>I rock</span>")
+
+    @operation_builder.reset!
+
+    @operation_builder.inner_html(html: "<span>winning</span>")
+
+    assert_equal({"innerHtml" => [{"html" => "<span>winning</span>"}]}, @operation_builder.operations_payload)
+  end
+
+  test "should use previous_selector if present and should use `selector` if explicitly provided" do
+    @operation_builder.add_operation_method("inner_html")
+    @operation_builder.add_operation_method("set_focus")
+
+    @operation_builder.set_focus("#smelly").inner_html(html: "<span>I rock</span>").inner_html(html: "<span>I rock too</span>", selector: "#smelly2")
+
+    operations = {
+      "setFocus" => [
+        {"selector" => "#smelly"}
+      ],
+      "innerHtml" => [
+        {"html" => "<span>I rock</span>", "selector" => "#smelly"},
+        {"html" => "<span>I rock too</span>", "selector" => "#smelly2"}
+      ]
+    }
+
+    assert_equal(operations, @operation_builder.operations_payload)
+  end
+end