rux-rails 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69a808afcb08d05209e5e4c8a759bf96524ec8f2580647ac216332a585271fac
-  data.tar.gz: bce97762fcd5076e2a572661aedc2a02424fdabf804f1d869d8a7156acc73c0a
+  metadata.gz: 7b7a679a3ee90ae6b529db0784f4b94012e90bbb25830520cdfd9e78d7ceb799
+  data.tar.gz: 43babb6951b66022a80188c441f3a8ef052255d15c7d95e38814c2af896e4a04
 SHA512:
-  metadata.gz: 73031ea1107540cf63e5834a8b7cdb46e7470d49832cc45b4b86f51edbd5a29611bb120b8f6cefa35505a6c2e2173c08cab1b6996fc2e3d7b435f58d37c66daa
-  data.tar.gz: b3a6049fbbfd8972a9c09dd445193da594f23080d0b0b121bf2b795c0683dac64eb248eaa22de6278543479d08d5d7b42eac84984a72e77c6de628ae5cfc386a
+  metadata.gz: bebca880ba79a25eed37a0b1bb5fd8052a03d7a580301a5adc1ee8cab9e79b317cae245696521f98b3fd363ab916eae585796244330c3096711516fdf304a6f4
+  data.tar.gz: 9bdc46fd60266214a5eae8c4a83181625bf1ba87cdd33b512ad766169344618c83801203535c5490e9060ac8ea9cfa7b2db82f813039939497695de5ef5b1c0c

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 1.5.0
+* Extract monkeypatches into the [onload gem](https://github.com/camertron/onload).
+* Upgrade to rux v1.2.
+* Drop official support for Rails < 6 and Ruby < 3.
+
+## 1.4.0
+* Make rux-rails safe to load in production.
+  - All the monkeypatches to `Kernel`, etc are now only loaded if `config.rux.transpile` is `true`.
+
 ## 1.3.0
 * Add support for view_component v3.0.
 

data/Gemfile

@@ -2,15 +2,15 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'rux', github: 'camertron/rux'  # path: '/Users/cdutro/workspace/rux'
-
 group :development, :test do
-  gem 'pry-byebug'
   gem 'rake'
+  gem 'debug'
 end
 
 group :development do
   gem 'appraisal'
+  gem 'benchmark-ips'
+  gem 'slim', '~> 5.0'
 end
 
 group :test do

data/README.md

@@ -81,11 +81,9 @@ In my humble opinion, the rux version:
 
 Integrating rux into your Rails app is pretty straightforward.
 
-1. Add rux-rails to the development group in your Gemfile, eg:
+1. Add rux-rails to your Gemfile, eg:
     ```ruby
-    group :development do
-      gem 'rux-rails', '~> 1.0'
-    end
+    gem 'rux-rails', '~> 1.0'
     ```
 1. Run `bundle install`
 1. ... that's it.
@@ -104,7 +102,7 @@ config.rux.transpile = false
 
 ### Production Environment
 
-By including rux-rails in the `:development` group in your Gemfile, rux-rails and its monkeypatches to `Kernel` aren't loaded in production (which is a good thing). You could choose to include rux-rails in the default group, but automatic transpilation of .rux files is disabled in the production environment for the same reasons the asset pipeline is disabled. Your view components (and static assets) don't change once deployed, so it's more efficient to precompile (or pre-transpile) them before deploying. Rux-rails comes with a handy rake task that can pre-transpile all your .rux templates:
+By default, `config.rux.transpile` is set to `false` in the production environment, which means rux-rails' monkeypatches to `Kernel`, etc aren't loaded in production (which is a good thing). You could choose to turn it on, but automatic transpilation of .rux files is disabled automatically in the production environment for the same reasons the asset pipeline is disabled. Your view components (and static assets) don't change once deployed, so it's more efficient to precompile (or pre-transpile) them before deploying. Rux-rails comes with a handy rake task that can pre-transpile all your .rux templates:
 
 ```bash
 bundle exec rake rux:transpile

data/lib/rux-rails/output_buffer.rb

@@ -0,0 +1,13 @@
+require 'action_view'
+
+module RuxRails
+  class OutputBuffer < ActionView::OutputBuffer
+    def safe_append(obj)
+      Array(obj).each { |o| self.safe_append=(o) }
+    end
+
+    def append(obj)
+      Array(obj).each { |o| self.append=(o) }
+    end
+  end
+end

data/lib/rux-rails/railtie.rb

@@ -1,58 +1,32 @@
 require 'rails/railtie'
-
-require 'active_support'
-require 'active_support/isolated_execution_state' if ActiveSupport::VERSION::MAJOR > 6
+require 'onload'
 
 module RuxRails
   class Railtie < Rails::Railtie
     config.rux = ActiveSupport::OrderedOptions.new
 
-    initializer 'rux-rails.initialize', before: :set_autoload_paths do |app|
-      if Rails.respond_to?(:autoloaders) && Rails.autoloaders.zeitwerk_enabled?
-        require 'rux-rails/core_ext/kernel_zeitwerk'
-        require 'rux-rails/ext/zeitwerk/loader'
+    initializer 'rux-rails.initialize', before: 'onload.initialize' do |app|
+      ViewComponent::Base.send(:include, RuxRails::Components)
 
-        RuxRails.zeitwerk_mode = true
+      if config.rux.transpile.nil? && (Rails.env.development? || Rails.env.test?)
+        config.rux.transpile = true
+        Onload.enabled = true
       else
-        require 'rux-rails/core_ext/kernel'
-        require 'rux-rails/ext/activesupport/dependencies'
-
-        RuxRails.zeitwerk_mode = false
+        Onload.enabled = config.rux.transpile
       end
 
-      begin
-        require 'bootsnap'
-      rescue LoadError
-      else
-        require 'rux-rails/ext/bootsnap/autoload'
+      if config.rux.transpile
+        Onload.register('.rux', RuxRails::RuxLoader)
       end
 
       ActionView::Template.register_template_handler(
         :ruxt, RuxRails::TemplateHandler
       )
 
-      if config.rux.transpile.nil? && (Rails.env.development? || Rails.env.test?)
-        config.rux.transpile = true
-      end
-
-      RuxRails.transpile_on_load = -> () { config.rux.transpile }
-
       Rux.library_paths.each do |library_path|
         app.config.eager_load_paths << library_path
         app.config.autoload_paths << library_path
       end
-
-      if config.rux.transpile && app.config.file_watcher
-        paths = Set.new(app.config.eager_load_paths + app.config.autoload_paths)
-
-        dirs = paths.each_with_object({}) do |path, ret|
-          ret[path] = %w(rux)
-        end
-
-        app.reloaders << app.config.file_watcher.new([], dirs) do
-          # empty block, watcher seems to need it?
-        end
-      end
     end
 
     rake_tasks do

data/lib/rux-rails/rux_loader.rb

@@ -0,0 +1,7 @@
+module RuxRails
+  class RuxLoader
+    def self.call(source)
+      Rux.to_ruby(source)
+    end
+  end
+end

data/lib/rux-rails/tag_builder.rb

@@ -2,8 +2,8 @@ require 'rux'
 
 module RuxRails
   class TagBuilder < ::Rux::DefaultTagBuilder
-    def call(*args)
-      super.html_safe
+    def call(*args, &block)
+      build(*args, &block).html_safe
     end
   end
 end

data/lib/rux-rails/version.rb

@@ -1,3 +1,3 @@
 module RuxRails
-  VERSION = '1.3.0'
+  VERSION = '1.5.0'
 end

data/lib/rux-rails.rb

@@ -1,6 +1,7 @@
 module RuxRails
   autoload :Components,      'rux-rails/components'
-  autoload :SafeBuffer,      'rux-rails/safe_buffer'
+  autoload :OutputBuffer,    'rux-rails/output_buffer'
+  autoload :RuxLoader,       'rux-rails/rux_loader'
   autoload :TagBuilder,      'rux-rails/tag_builder'
   autoload :TemplateHandler, 'rux-rails/template_handler'
   autoload :Visitor,         'rux-rails/visitor'
@@ -16,23 +17,14 @@ module RuxRails
     def tag_builder
       @tag_builder ||= TagBuilder.new
     end
-
-    def transpile_on_load?
-      transpile_on_load.call
-    end
   end
 
-  self.transpile_on_load = -> () { true }
+  self.transpile_on_load = true
 end
 
 
 require 'rux'
 require 'rux-rails/railtie'
 
-# require both of these to support multiple versions of view_component
-require 'view_component'
-require 'view_component/engine'
-
-ViewComponent::Base.send(:include, RuxRails::Components)
 Rux.tag_builder = RuxRails.tag_builder
-Rux.buffer = RuxRails::SafeBuffer
+Rux.buffer = RuxRails::OutputBuffer

data/rux-rails.gemspec

@@ -10,9 +10,10 @@ Gem::Specification.new do |s|
   s.description = s.summary = 'Rux view components on Rails.'
   s.platform = Gem::Platform::RUBY
 
-  s.add_dependency 'rux', '~> 1.0'
+  s.add_dependency 'rux', '~> 1.2'
   s.add_dependency 'railties', '>= 5.0'
   s.add_dependency 'view_component', '>= 2', '< 4'
+  s.add_dependency 'onload', '~> 1.0'
 
   s.require_path = 'lib'
 

data/spec/controllers/home_controller_spec.rb

@@ -2,7 +2,12 @@ require 'spec_helper'
 
 describe HomeController, type: :request do
   describe '#index' do
-    it 'works' do
+    before(:each) do
+      # Force a recompile to avoid test pollution
+      HomeComponent.compile
+    end
+
+    it 'transpiles the file' do
       get '/'
 
       expect(response).to have_http_status(:ok)
@@ -10,5 +15,36 @@ describe HomeController, type: :request do
         have_selector("div.container img[src='/images/cat.png'] + button", text: "Click Me!")
       )
     end
+
+    it "allows hot reloading" do
+      get "/"
+
+      expect(response).to have_http_status(:ok)
+      expect(response.body).to(
+        have_selector(".container", text: "Click Me!")
+      )
+
+      new_contents = <<~RUX
+        class HomeComponent < ViewComponent::Base
+          def call
+            <div class="container">
+              <Image src="cat.png" size="40" />
+              <Button outline={true} disabled size={:large}>
+                Click if you dare
+              </Button>
+            </div>
+          end
+        end
+      RUX
+
+      with_file_contents(Rails.root.join(*%w[app components home_component.rux]), new_contents) do
+        get "/"
+
+        expect(response).to have_http_status(:ok)
+        expect(response.body).to(
+          have_selector(".container", text: "Click if you dare")
+        )
+      end
+    end
   end
 end

data/spec/dummy/app/components/html_safety_component.rb

@@ -0,0 +1,13 @@
+class HtmlSafetyComponent < ViewComponent::Base
+  def initialize(value:)
+    @value = value
+  end
+
+  def call
+    Rux.tag("div") {
+      Rux.create_buffer.tap { |_rux_buf_|
+        _rux_buf_.append(@value)
+      }.to_s
+    }
+  end
+end

data/spec/dummy/app/components/html_safety_component.rux

@@ -0,0 +1,9 @@
+class HtmlSafetyComponent < ViewComponent::Base
+  def initialize(value:)
+    @value = value
+  end
+
+  def call
+    <div>{@value}</div>
+  end
+end

data/spec/dummy/config/application.rb

@@ -1,3 +1,7 @@
+# require both of these to support multiple versions of view_component
+require 'view_component'
+require 'view_component/engine'
+
 module RuxRails
   class DummyApplication < ::Rails::Application
     if config.respond_to?(:load_defaults)