cable_ready 4.4.3 → 5.0.0.pre1

data/test/lib/generators/cable_ready/channel_generator_test.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "generators/cable_ready/channel_generator"
+
+class CableReady::ChannelGeneratorTest < Rails::Generators::TestCase
+  include ::GeneratorTestHelpers
+
+  tests CableReady::ChannelGenerator
+  destination File.expand_path("../../../../tmp/dummy", __dir__)
+
+  prepare_destination
+  create_sample_app
+
+  MiniTest.after_run do
+    remove_sample_app
+  end
+
+  test "should generate channel with the same resource name and stimulus controller" do
+    run_generator ["user", "--stream-for=user", "--stimulus"]
+
+    assert_file "app/channels/user_channel.rb" do |content|
+      assert_match(/class\ UserChannel\ </, content)
+      assert_match(/stream_for\ User\.find\(params\[:id\]\)/, content)
+    end
+
+    assert_file "app/javascript/channels/user_channel.js", /"UserChannel"/
+    assert_file "app/javascript/controllers/user_controller.js", /'UserChannel'/
+  end
+
+  test "should generate channel with different resource name" do
+    run_generator ["my_name", "--stream-for=under_scored_resource_name", "--no-stimulus"]
+
+    assert_file "app/channels/my_name_channel.rb" do |content|
+      assert_match(/class\ MyNameChannel\ </, content)
+      assert_match(/stream_for\ UnderScoredResourceName\.find\(params\[:id\]\)/, content)
+    end
+
+    assert_file "app/javascript/channels/my_name_channel.js", /"MyNameChannel"/
+    assert_no_file "app/javascript/controllers/my_name_controller.js"
+  end
+
+  test "should not generate stimulus controller if not requested" do
+    run_generator ["comment", "--stream-for=comment", "--no-stimulus"]
+
+    assert_file "app/channels/comment_channel.rb"
+    assert_file "app/javascript/channels/comment_channel.js"
+    assert_no_file "app/javascript/controllers/comment_controller.js"
+  end
+
+  test "should run the generator when streaming from identifier" do
+    run_generator ["page", "--stream-from=page"]
+
+    assert_file "app/channels/page_channel.rb" do |content|
+      assert_match(/PageChannel/, content)
+      assert_match(/stream_from\ "page"/, content)
+    end
+
+    assert_file "app/javascript/channels/page_channel.js" do |content|
+      assert_match(/"PageChannel"/, content)
+      assert_match(/import\ CableReady/, content)
+      assert_match(/if\ \(data\.cableReady\)\ CableReady\.perform\(data\.operations\)/, content)
+    end
+  end
+
+  test "should run the generator when streaming without resource and different identifier" do
+    run_generator ["my_page", "--stream-from=ThisIsMyPage"]
+
+    assert_file "app/channels/my_page_channel.rb" do |content|
+      assert_match(/MyPageChannel/, content)
+      assert_match(/stream_from\ "this_is_my_page"/, content)
+    end
+
+    assert_file "app/javascript/channels/my_page_channel.js" do |content|
+      assert_match(/"MyPageChannel"/, content)
+      assert_match(/import\ CableReady/, content)
+      assert_match(/if\ \(data\.cableReady\)\ CableReady\.perform\(data\.operations\)/, content)
+    end
+  end
+
+  test "should run the generator and use the NAME for --stream-from if nothing passed" do
+    run_generator ["house", "--stream-from"]
+
+    assert_file "app/channels/house_channel.rb" do |content|
+      assert_match(/HouseChannel/, content)
+      assert_match(/stream_from\ "house"/, content)
+    end
+
+    assert_file "app/javascript/channels/house_channel.js" do |content|
+      assert_match(/"HouseChannel"/, content)
+      assert_match(/import\ CableReady/, content)
+      assert_match(/if\ \(data\.cableReady\)\ CableReady\.perform\(data\.operations\)/, content)
+    end
+  end
+
+  test "should run the generator and use the NAME for --stream-for if nothing passed" do
+    run_generator ["option", "--stream-for", "--stimulus"]
+
+    assert_file "app/channels/option_channel.rb" do |content|
+      assert_match(/class\ OptionChannel\ </, content)
+      assert_match(/stream_for\ Option\.find\(params\[:id\]\)/, content)
+    end
+
+    assert_file "app/javascript/channels/option_channel.js", /"OptionChannel"/
+    assert_file "app/javascript/controllers/option_controller.js", /'OptionChannel'/
+  end
+
+  test "should run not generate anything if passed stream_from and stream_for" do
+    assert_raises "Can't specify --stream-from and --stream-for at the same time" do
+      run_generator ["error", "--stream-from=1", "--stream-for=2"]
+    end
+  end
+
+  # some tests without generator options to simulate the inputs passed via cli
+
+  test "should generate channel with the same resource name and stimulus controller (without options)" do
+    CableReady::ChannelGenerator.any_instance.stubs(:using_broadcast_to?).returns(true)
+    CableReady::ChannelGenerator.any_instance.stubs(:resource).returns("Post")
+    CableReady::ChannelGenerator.any_instance.stubs(:using_stimulus?).returns(true)
+
+    run_generator ["post"]
+
+    assert_file "app/channels/post_channel.rb" do |content|
+      assert_match(/class\ PostChannel\ </, content)
+      assert_match(/stream_for\ Post\.find\(params\[:id\]\)/, content)
+    end
+
+    assert_file "app/javascript/channels/post_channel.js", /PostChannel/
+    assert_file "app/javascript/controllers/post_controller.js", /'PostChannel'/
+  end
+
+  test "should not generate stimulus controller if not requested (without options)" do
+    CableReady::ChannelGenerator.any_instance.stubs(:using_broadcast_to?).returns(true)
+    CableReady::ChannelGenerator.any_instance.stubs(:resource).returns("Admin")
+    CableReady::ChannelGenerator.any_instance.stubs(:using_stimulus?).returns(false)
+
+    run_generator ["admin"]
+
+    assert_file "app/channels/admin_channel.rb"
+    assert_file "app/javascript/channels/admin_channel.js"
+    assert_no_file "app/javascript/controllers/admin_controller.js"
+  end
+
+  test "should run the generator when streaming from identifier (without options)" do
+    CableReady::ChannelGenerator.any_instance.stubs(:using_broadcast_to?).returns(false)
+    CableReady::ChannelGenerator.any_instance.stubs(:identifier).returns("index_identifier")
+
+    run_generator ["index"]
+
+    assert_file "app/channels/index_channel.rb" do |content|
+      assert_match(/IndexChannel/, content)
+      assert_match(/stream_from\ "index_identifier"/, content)
+    end
+
+    assert_file "app/javascript/channels/index_channel.js", /"IndexChannel"/
+  end
+end

data/test/support/generator_test_helpers.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module GeneratorTestHelpers
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def sample_app_path
+      File.expand_path("../../tmp/dummy", __dir__)
+    end
+
+    def prepare_destination
+      FileUtils.rm_rf(sample_app_path) if Dir.exist?(sample_app_path)
+      FileUtils.mkdir_p(sample_app_path)
+    end
+
+    def create_sample_app
+      FileUtils.cd(sample_app_path) do
+        system "rails new . --minimal --skip-active-record --skip-test-unit --skip-spring --skip-bundle --quiet --force"
+      end
+    end
+
+    def remove_sample_app
+      FileUtils.rm_rf(destination_root)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require "mocha"
+require "rails"
+require "rails/generators"
+require "rails/test_help"
+require "minitest/mock"
+require "mocha/minitest"
+require "pry"
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each { |f| require f }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cable_ready
 version: !ruby/object:Gem::Version
-  version: 4.4.3
+  version: 5.0.0.pre1
 platform: ruby
 authors:
 - Nathan Hopkins
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-01 00:00:00.000000000 Z
+date: 2021-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: thread-local
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: github_changelog_generator
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +122,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
 email:
 - natehop@gmail.com
 executables: []
@@ -119,27 +147,44 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- LATEST
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/channels/cable_ready/stream.rb
+- app/helpers/cable_ready_helper.rb
+- app/jobs/cable_ready_broadcast_job.rb
 - bin/console
 - bin/loc
 - bin/setup
 - bin/standardize
-- cable_ready.gemspec
 - lib/cable_ready.rb
 - lib/cable_ready/broadcaster.rb
+- lib/cable_ready/cable_car.rb
 - lib/cable_ready/channel.rb
 - lib/cable_ready/channels.rb
+- lib/cable_ready/compoundable.rb
+- lib/cable_ready/config.rb
+- lib/cable_ready/identifiable.rb
+- lib/cable_ready/operation_builder.rb
+- lib/cable_ready/sanity_checker.rb
+- lib/cable_ready/stream_identifier.rb
 - lib/cable_ready/version.rb
-- package.json
-- tags
-- yarn.lock
-homepage: https://github.com/hopsoft/cable_ready
+- lib/generators/cable_ready/channel_generator.rb
+- lib/generators/cable_ready/initializer_generator.rb
+- lib/generators/cable_ready/stream_from_generator.rb
+- lib/generators/cable_ready/templates/config/initializers/cable_ready.rb
+- test/lib/cable_ready/cable_car_test.rb
+- test/lib/cable_ready/identifiable_test.rb
+- test/lib/cable_ready/operation_builder_test.rb
+- test/lib/generators/cable_ready/channel_generator_test.rb
+- test/support/generator_test_helpers.rb
+- test/test_helper.rb
+homepage: https://github.com/stimulusreflex/cable_ready
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -150,12 +195,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Out-of-Band Server Triggered DOM Operations
-test_files: []
+test_files:
+- test/support/generator_test_helpers.rb
+- test/lib/generators/cable_ready/channel_generator_test.rb
+- test/lib/cable_ready/cable_car_test.rb
+- test/lib/cable_ready/identifiable_test.rb
+- test/lib/cable_ready/operation_builder_test.rb
+- test/test_helper.rb

data/cable_ready.gemspec

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require File.expand_path("../lib/cable_ready/version", __FILE__)
-
-Gem::Specification.new do |gem|
-  gem.name = "cable_ready"
-  gem.license = "MIT"
-  gem.version = CableReady::VERSION
-  gem.authors = ["Nathan Hopkins"]
-  gem.email = ["natehop@gmail.com"]
-  gem.homepage = "https://github.com/hopsoft/cable_ready"
-  gem.summary = "Out-of-Band Server Triggered DOM Operations"
-
-  gem.files = Dir["lib/**/*.rb", "app/assets/javascripts/cable_ready.js", "bin/*", "[A-Z]*"]
-  gem.test_files = Dir["test/**/*.rb"]
-
-  gem.add_dependency "rails", ">= 5.2"
-
-  gem.add_development_dependency "github_changelog_generator"
-  gem.add_development_dependency "magic_frozen_string_literal"
-  gem.add_development_dependency "pry"
-  gem.add_development_dependency "pry-nav"
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "standardrb"
-end

data/package.json

@@ -1,36 +0,0 @@
-{
-  "name": "cable_ready",
-  "version": "4.4.2",
-  "description": "CableReady helps you create great real-time user experiences by making it simple to trigger client-side DOM changes from server-side Ruby.",
-  "keywords": [
-    "ruby",
-    "rails",
-    "websockets",
-    "actioncable",
-    "cable",
-    "ssr",
-    "stimulus_reflex",
-    "client-side",
-    "dom"
-  ],
-  "homepage": "https://cableready.stimulusreflex.com/",
-  "bugs": {
-    "url": "https://github.com/hopsoft/cable_ready/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com:hopsoft/cable_ready.git"
-  },
-  "license": "MIT",
-  "author": "Nathan Hopkins <natehop@gmail.com>",
-  "main": "./javascript/cable_ready.js",
-  "scripts": {
-    "prettier-standard-check": "yarn run prettier-standard --check ./javascript/**/*.js"
-  },
-  "dependencies": {
-    "morphdom": "^2.6.1"
-  },
-  "devDependencies": {
-    "prettier-standard": "^16.1.0"
-  }
-}

data/tags

@@ -1,57 +0,0 @@
-!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
-!_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
-!_TAG_PROGRAM_AUTHOR	Darren Hiebert	/dhiebert@users.sourceforge.net/
-!_TAG_PROGRAM_NAME	Exuberant Ctags	//
-!_TAG_PROGRAM_URL	http://ctags.sourceforge.net	/official site/
-!_TAG_PROGRAM_VERSION	5.8	//
-Broadcaster	lib/cable_ready/broadcaster.rb	/^  module Broadcaster$/;"	m	class:CableReady
-CableReady	lib/cable_ready.rb	/^module CableReady$/;"	m
-CableReady	lib/cable_ready/broadcaster.rb	/^module CableReady$/;"	m
-CableReady	lib/cable_ready/channel.rb	/^module CableReady$/;"	m
-CableReady	lib/cable_ready/channels.rb	/^module CableReady$/;"	m
-CableReady	lib/cable_ready/version.rb	/^module CableReady$/;"	m
-Channel	lib/cable_ready/channel.rb	/^  class Channel$/;"	c	class:CableReady
-Channels	lib/cable_ready/channels.rb	/^  class Channels$/;"	c	class:CableReady
-Engine	lib/cable_ready.rb	/^  class Engine < Rails::Engine$/;"	c	class:CableReady
-[]	lib/cable_ready/channels.rb	/^    def [](identifier)$/;"	f	class:CableReady.Channels
-add_operation	lib/cable_ready/channels.rb	/^    def add_operation(operation, &implementation)$/;"	f	class:CableReady.Channels
-broadcast	lib/cable_ready/channel.rb	/^    def broadcast(clear = true)$/;"	f	class:CableReady.Channel
-broadcast	lib/cable_ready/channels.rb	/^    def broadcast(*identifiers, clear: true)$/;"	f	class:CableReady.Channels
-broadcast_to	lib/cable_ready/channel.rb	/^    def broadcast_to(model, clear = true)$/;"	f	class:CableReady.Channel
-broadcast_to	lib/cable_ready/channels.rb	/^    def broadcast_to(model, *identifiers, clear: true)$/;"	f	class:CableReady.Channels
-cable_ready	lib/cable_ready/broadcaster.rb	/^    def cable_ready$/;"	f	class:CableReady.Broadcaster
-channel_broadcast	lib/cable_ready/channel.rb	/^    def channel_broadcast(clear)$/;"	f	class:CableReady.Channel
-channel_broadcast_to	lib/cable_ready/channel.rb	/^    def channel_broadcast_to(model, clear)$/;"	f	class:CableReady.Channel
-configure	lib/cable_ready/channels.rb	/^    def self.configure$/;"	F	class:CableReady.Channels
-const.bubbles	javascript/cable_ready.js	/^  const init = { bubbles: true, cancelable: true, detail: detail }$/;"	p
-const.cancelable	javascript/cable_ready.js	/^  const init = { bubbles: true, cancelable: true, detail: detail }$/;"	p
-const.color	javascript/cable_ready.js	/^  color: true,$/;"	p
-const.date	javascript/cable_ready.js	/^  date: true,$/;"	p
-const.datetime	javascript/cable_ready.js	/^  datetime: true,$/;"	p
-const.datetime-local	javascript/cable_ready.js	/^  'datetime-local': true,$/;"	p
-const.detail	javascript/cable_ready.js	/^  const init = { bubbles: true, cancelable: true, detail: detail }$/;"	p
-const.email	javascript/cable_ready.js	/^  email: true,$/;"	p
-const.month	javascript/cable_ready.js	/^  month: true,$/;"	p
-const.number	javascript/cable_ready.js	/^  number: true,$/;"	p
-const.password	javascript/cable_ready.js	/^  password: true,$/;"	p
-const.pushState	javascript/cable_ready.js	/^  pushState: config => {$/;"	p
-const.range	javascript/cable_ready.js	/^  range: true,$/;"	p
-const.search	javascript/cable_ready.js	/^  search: true,$/;"	p
-const.select-multiple	javascript/cable_ready.js	/^  'select-multiple': true,$/;"	p
-const.select-one	javascript/cable_ready.js	/^  'select-one': true,$/;"	p
-const.tel	javascript/cable_ready.js	/^  tel: true,$/;"	p
-const.text	javascript/cable_ready.js	/^  text: true,$/;"	p
-const.textarea	javascript/cable_ready.js	/^  textarea: true,$/;"	p
-const.time	javascript/cable_ready.js	/^  time: true,$/;"	p
-const.url	javascript/cable_ready.js	/^  url: true,$/;"	p
-const.value	javascript/cable_ready.js	/^    const ignore = { value: true }$/;"	p
-const.week	javascript/cable_ready.js	/^  week: true$/;"	p
-dom_id	lib/cable_ready/broadcaster.rb	/^    def dom_id(record, prefix = nil)$/;"	f	class:CableReady.Broadcaster
-enqueue_operation	lib/cable_ready/channel.rb	/^    def enqueue_operation(key, options)$/;"	f	class:CableReady.Channel
-import.INPUT	javascript/cable_ready.js	/^  INPUT: true,$/;"	p
-import.SELECT	javascript/cable_ready.js	/^  SELECT: true$/;"	p
-import.TEXTAREA	javascript/cable_ready.js	/^  TEXTAREA: true,$/;"	p
-initialize	lib/cable_ready/channel.rb	/^    def initialize(identifier, available_operations)$/;"	f	class:CableReady.Channel
-initialize	lib/cable_ready/channels.rb	/^    def initialize$/;"	f	class:CableReady.Channels
-mutex	lib/cable_ready/channels.rb	/^    def mutex$/;"	f	class:CableReady.Channels
-reset	lib/cable_ready/channel.rb	/^    def reset$/;"	f	class:CableReady.Channel