opal_stimulus 0.1.4 → 0.1.5

data/spec-opal/spec_helper.rb

@@ -0,0 +1,24 @@
+# backtick_javascript: true
+
+require "opal"
+require "stimulus@3.2.2.umd.js"
+%x{
+  window.Stimulus    = Stimulus
+  window.Controller  = Stimulus.Controller
+  window.application = Stimulus.Application.start()
+}
+require "opal_stimulus/stimulus_controller"
+
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/spec-opal/stimulus_controller_spec.rb

@@ -0,0 +1,215 @@
+# backtick_javascript: true
+
+require "spec_helper"
+
+RSpec.describe StimulusController do
+  describe ".inherited" do
+    class MyController < described_class; end
+
+    it "bridges inherited class to Opal" do
+      expect {
+        Opal.bridge(described_class, MyController)
+      }.to raise_error("already bridged")
+    end
+  end
+
+  describe ".stimulus_controller" do
+    class MyController < described_class; end
+
+    it "sets `stimulus_controller` with a basic Controller" do
+      expect(`Object.getPrototypeOf(#{MyController.stimulus_controller})`).to eq(`Controller`)
+    end
+  end
+
+  describe ".stimulus_name" do
+    context "when is one word" do
+      class MyController < described_class; end
+
+      it "it returns it downcased" do
+        expect(MyController.stimulus_name).to eq("my")
+      end
+    end
+
+    context "when is multiple words" do
+      class MyBestController < described_class; end
+
+      it "it returns them separated by `-`" do
+        expect(MyBestController.stimulus_name).to eq("my-best")
+      end
+    end
+
+    context "when has namespaces" do
+      module My; end
+      class My::VeryBestController < described_class; end
+
+      it "it returns them separated by `--`" do
+        expect(My::VeryBestController.stimulus_name).to eq("my--very-best")
+      end
+    end
+  end
+
+  describe ".method_added" do
+    it "returns the same bridged class method result" do
+      class MyController < described_class
+        def hello_world
+          "Hello world!"
+        end
+      end
+
+      expect(MyController.new.hello_world).to eq(`#{MyController.stimulus_controller}.prototype["hello_world"]()`)
+    end
+  end
+
+  describe ".to_ruby_name" do
+    it "converts camelCase to snake_case" do
+      expect(described_class.to_ruby_name("myMethod")).to eq("my_method")
+      expect(described_class.to_ruby_name("anotherExample")).to eq("another_example")
+      expect(described_class.to_ruby_name("YetAnotherTest")).to eq("yet_another_test")
+    end
+
+    it "does not change already snake_case names" do
+      expect(described_class.to_ruby_name("already_snake_case")).to eq("already_snake_case")
+    end
+  end
+
+  describe ".register_all!" do
+    class MyController < described_class; end
+    StimulusController.register_all!
+
+    it "should register controller" do
+      expect(`application.router.modules[0].definition.identifier`).to eq("my")
+    end
+
+    it "sould respond to `dummy` method" do
+      expect(MyController.new).to respond_to(:dummy)
+    end
+  end
+
+  describe ".targets=" do
+    class MyController < described_class
+      self.targets = ["container"]
+
+      def container_target_connected = "Container Target connected!"
+      def container_target_disconnected = "Container Target disconnected!"
+    end
+
+    it "defines all target methods and maps callbacks" do
+      my_controller = MyController.new
+      expect(my_controller).to respond_to(:container_target)
+      expect(my_controller).to respond_to(:container_targets)
+      expect(my_controller).to respond_to(:has_container_target)
+      expect(MyController.new.container_target_connected)
+        .to eq(`#{MyController.stimulus_controller}.prototype["containerTargetConnected"]()`)
+      expect(MyController.new.container_target_disconnected)
+        .to eq(`#{MyController.stimulus_controller}.prototype["containerTargetDisconnected"]()`)
+    end
+
+    it "returns a `JS::Proxy` instance whe `container_target` is called" do
+      my_controller = MyController.new
+      expect(my_controller.container_target).to be_a(JS::Proxy)
+    end
+  end
+
+  describe ".outlets=" do
+    class MyController < described_class
+      self.outlets = ["container"]
+
+      def container_outlet_connected = "Container Outlet connected!"
+      def container_outlet_disconnected = "Container Outlet disconnected!"
+    end
+
+    it "defines all outlet methods and maps callbacks" do
+      my_controller = MyController.new
+      expect(my_controller).to respond_to(:container_outlet)
+      expect(my_controller).to respond_to(:container_outlets)
+      expect(my_controller).to respond_to(:has_container_outlet)
+      expect(MyController.new.container_outlet_connected)
+        .to eq(`#{MyController.stimulus_controller}.prototype["containerOutletConnected"]()`)
+      expect(MyController.new.container_outlet_disconnected)
+        .to eq(`#{MyController.stimulus_controller}.prototype["containerOutletDisconnected"]()`)
+    end
+  end
+
+  describe ".values=" do
+    it "sets bridged class `values`" do
+      class MyController < described_class
+        self.values = {
+          name:  :string,
+          age:   :number,
+          alive: :boolean,
+          cars:  :array,
+          notes: :object
+        }
+      end
+
+      expect(`#{MyController}.stimulus_controller.values.name === String`).to be_truthy
+      expect(`#{MyController}.stimulus_controller.values.age === Number`).to be_truthy
+      expect(`#{MyController}.stimulus_controller.values.alive === Boolean`).to be_truthy
+      expect(`#{MyController}.stimulus_controller.values.cars === Array`).to be_truthy
+      expect(`#{MyController}.stimulus_controller.values.notes === Object`).to be_truthy
+    end
+
+    it "defines all values methods" do
+      class MyController < described_class
+        self.values = {
+          name: :string
+        }
+
+        def name_value_changed(value, previous_value)
+          "Name value changed from #{previous_value} to #{value}!"
+        end
+      end
+
+      my_controller = MyController.new
+      expect(my_controller).to respond_to(:name_value)
+      expect(my_controller).to respond_to(:name_value=)
+      expect(my_controller).to respond_to(:has_name)
+      expect(MyController.new.name_value_changed(:new, :prev))
+        .to eq(`#{MyController.stimulus_controller}.prototype["nameValueChanged"]("new", "prev")`)
+    end
+
+    context "when unsupported type is passed" do
+      it "raises `ArgumentError`" do
+        expect {
+          class MyController < described_class
+            self.values = { age: :parsec }
+          end
+        }.to raise_error("Unsupported value type: parsec, please use :string, :number, :boolean, :array, or :object")
+      end
+    end
+  end
+
+  describe ".classes" do
+    it "defines all classes methods" do
+      class MyController < described_class
+        self.classes = ["active"]
+      end
+
+      my_controller = MyController.new
+      expect(my_controller).to respond_to(:active_class)
+      expect(my_controller).to respond_to(:active_classes)
+      expect(my_controller).to respond_to(:has_active_class)
+    end
+  end
+
+  describe "#element" do
+    it "has been tested with selenium" do
+    end
+  end
+
+  describe "#window" do
+    it "returns a `JS::Proxy`" do |example|
+      class MyController < described_class; end
+
+      expect(MyController.new.window).to be_a(JS::Proxy)
+    end
+  end
+
+  describe "#document" do
+    it "returns a `JS::Proxy`" do
+      class MyController < described_class; end
+
+      expect(MyController.new.document).to be_a(JS::Proxy)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opal_stimulus
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Joseph Schito
@@ -43,14 +43,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.1
 description: Opal Stimulus provides a way to write Stimulus controllers in Ruby, leveraging
   the Opal compiler to convert Ruby code into JavaScript. This allows developers familiar
   with Ruby to use the Stimulus framework without needing to write JavaScript directly.
@@ -60,22 +60,27 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec-opal"
 - ".rubocop.yml"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/USAGE
+- lib/generators/opal_stimulus_generator.rb
+- lib/generators/templates/controller.rb.tt
 - lib/install/Procfile.dev
 - lib/install/application.rb
-- lib/install/controllers/my_opal_controller.rb
-- lib/install/controllers_requires.rb
 - lib/install/dev
 - lib/install/install_opal_stimulus.rb
-- lib/install/opal
 - lib/opal_stimulus.rb
 - lib/opal_stimulus/stimulus_controller.rb
 - lib/opal_stimulus/version.rb
+- lib/tasks/build.rake
 - lib/tasks/install.rake
+- shared_fixtures/stimulus@3.2.2.umd.js
+- spec-opal/spec_helper.rb
+- spec-opal/stimulus_controller_spec.rb
 homepage: https://github.com/josephschito/opal_stimulus
 licenses:
 - MIT

data/lib/install/controllers/my_opal_controller.rb

@@ -1,5 +0,0 @@
-class MyOpalController < StimulusController
-  def connect
-    puts "'#{self.class.name}' connected!"
-  end
-end

data/lib/install/controllers_requires.rb

@@ -1,4 +0,0 @@
-# This file is automatically generated by `bin/opal`.
-# If you want to update this file, please run: `bin/opal --update-requires`.
-
-require 'controllers/my_opal_controller'

data/lib/install/opal

@@ -1,74 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "listen"
-require "opal"
-
-GEMS = ["opal_proxy", "opal_stimulus"]
-
-GEMS.each do |gem_name|
-  Opal.use_gem(gem_name) rescue Opal.append_path(File.expand_path("lib", Bundler.rubygems.find_name(gem_name).first.full_gem_path))
-end
-
-Opal.append_path("app/opal")
-
-build = -> {
-  puts "🔨 Compiling Opal..."
-
-  builder = Opal::Builder.new
-
-  result = builder.build("application")
-
-  output_path = "app/assets/builds/opal.js"
-  sourcemap_path = "#{output_path}.map"
-
-  js_code = result.to_s
-  source_map_json = result.source_map.to_json
-
-  File.write(output_path, js_code + "\n//# sourceMappingURL=/assets/opal.js.map")
-  File.write(sourcemap_path, source_map_json)
-
-  puts "✅ Compiled to #{output_path}"
-}
-
-update_opal_controllers_requires = -> {
-  file_path = "app/opal/controllers_requires.rb"
-
-  requires = Dir["app/opal/controllers/**/*.rb"].sort.map do |file|
-    "require '#{file.sub("app/opal/", "").sub(".rb", "")}'"
-  end
-
-  File.open(file_path, "w") do |f|
-    f.puts "# This file is automatically generated by `bin/opal`."
-    f.puts "# If you want to update this file, please run: `bin/opal --update-requires`."
-    f.puts
-    f.puts requires.join("\n")
-  end
-
-  puts "✅ Updated #{file_path} 🎉"
-}
-
-if ARGV.include?("--update-requires")
-  update_opal_controllers_requires.()
-  exit
-end
-
-update_opal_controllers_requires.()
-build.call
-
-exit unless ARGV.include?("--watch")
-
-listen = Listen.to("app/opal") do |modified, added, removed|
-  if added.any? || removed.any?
-    puts "🔄 Updating opal controllers requires..."
-    update_opal_controllers_requires.()
-  end
-
-  build.call
-end
-
-puts "👀 Watching app/opal for changes..."
-listen.start
-Signal.trap("INT") { listen.stop }
-sleep