rux-rails 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b7a679a3ee90ae6b529db0784f4b94012e90bbb25830520cdfd9e78d7ceb799
-  data.tar.gz: 43babb6951b66022a80188c441f3a8ef052255d15c7d95e38814c2af896e4a04
+  metadata.gz: 1dd540a2fa0ae930bc671d469c20928dc71faba5ad1ef3d52a13212f1e6373ef
+  data.tar.gz: 6f8d5e0c2897d8c03c4bdea2b6fec7c170a1103c9ca2ef5a58edf07396c98328
 SHA512:
-  metadata.gz: bebca880ba79a25eed37a0b1bb5fd8052a03d7a580301a5adc1ee8cab9e79b317cae245696521f98b3fd363ab916eae585796244330c3096711516fdf304a6f4
-  data.tar.gz: 9bdc46fd60266214a5eae8c4a83181625bf1ba87cdd33b512ad766169344618c83801203535c5490e9060ac8ea9cfa7b2db82f813039939497695de5ef5b1c0c
+  metadata.gz: 694511000ee0f54d57a382d18986d50130811e2c74d3f5f8b4963f7e9472b4629174a893d659fe42b9e03fa6f683f3b1e9e0ffad9714411c34d2de9a13d61949
+  data.tar.gz: 859fcf4b865afe9cd22f77d990263ac495acb275dccd21d487c0d01bf047b5ae0ab616ba57e61426c2d67d8eb8eebeadf90fea78048e7672e92376ba38849934

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 2.0.0
+* Remove the `Image`, `Audio`, and `Video` components (was anyone actually using these?)
+* Remove support for Rails 6.1 and 6.0.
+* Upgrade to onload v1.1 and rux to v1.3.
+  - Add `config.rux.ignore_path` to Rails config for controlling which ignore file should be populated with generated paths.
+* Add a series of Rails helper components:
+  - `Rails::ButtonTo`
+  - `Rails::LinkTo`
+  - `Rails::ContentTag`
+  - `Rails::FormWith`
+  - `Rails::Label`
+  - `Rails::Button`
+  - `Rails::HiddenField`
+  - `Rails::PasswordField`
+  - `Rails::TextField`
+* Add the `Rux::Component` component for rendering component instances.
+  - Eg: `<Rux::Component instance={@child} />`.
+
 ## 1.5.0
 * Extract monkeypatches into the [onload gem](https://github.com/camertron/onload).
 * Upgrade to rux v1.2.

data/Gemfile

@@ -11,9 +11,12 @@ group :development do
   gem 'appraisal'
   gem 'benchmark-ips'
   gem 'slim', '~> 5.0'
+  gem 'appraisal-run', '~> 1.0'
 end
 
 group :test do
   gem 'rspec-rails'
   gem 'capybara', '~> 3.0'
 end
+
+gem "csv"

data/README.md

@@ -282,6 +282,62 @@ There are also monkeypatches in place for Zeitwerk and `ActiveSupport::Dependenc
 
 Hit me up if you know of a less invasive way of enabling auto-transpilation.
 
+## Built-in Components
+
+The rux-rails gem contains several helper components to make it easier to work with Rails forms and tag helpers. Only a subset of Rails helpers are implemented. If you need others, please open an issue or, better yet, submit a pull request.
+
+### Tag Helpers
+
+The following tag helpers are available as components:
+
+1. `button_to`: Use the `Rails::ButtonTo` component, eg: `<Rails::ButtonTo url: "http://example.com" label: "Click me" />`.
+1. `link_to`: Use the `Rails::LinkTo` component, eg: `<Rails::LinkTo url="http://example.com" label="Navigate" />`.
+1. `content_tag`: Use the `Rails::ContentTag` component, eg: `<Rails::ContentTag tag={:div}>content</Rails::ContentTag>`
+
+### Form Helpers
+
+1. `form_with`: `Rails::FormWith`
+1. `button_tag` or `f.submit`: `Rails::Button`
+1. `label_tag` or `f.label`: `Rails::Label`
+1. `text_field_tag` or `f.text_field`: `Rails::TextField`
+1. `password_field_tag` or `f.password_field`: `Rails::PasswordField`
+1. `hidden_field_tag` or `f.hidden_field`: `Rails::HiddenField`
+
+### Form Example
+
+Here's how to use the above components to build eg. a simple sign up form:
+
+```ruby
+<Rails::FormWith model={User.new}>
+  <Rails::Label name="name">Name</Rails::Label>
+  <Rails::TextField name="name" />
+  <Rails::Label name="email_address">Email address</Rails::Label>
+  <Rails::TextField name="email_address" />
+  <Rails::Label name="password">Password</Rails::Label>
+  <Rails::PasswordField name="password" />
+  <Rails::Label name="password_confirm">Confirm password</Rails::Label>
+  <Rails::PasswordField name="password_confirmation" />
+</Rails::FormWith>
+```
+
+### The `Component` component
+
+Occasionally it can be useful to create an instance of a component outside the `call` method. While such a component can be rendered via the `render` method, doing so doesn't feel very "ruxy." That's where the `Rux::Component` component comes into play. It accepts a single `instance:` argument and renders it. For example:
+
+```ruby
+class ParentComponent < ApplicationComponent
+  def initialize
+    @child = ChildComponent.new
+  end
+
+  def call
+    <div>
+      <Rux::Component instance={@child} />
+    </div>
+  end
+end
+```
+
 ## Editor Support
 
 Sublime Text: [https://github.com/camertron/rux-SublimeText](https://github.com/camertron/rux-SublimeText)

data/lib/rux-rails/{railtie.rb → engine.rb}

@@ -1,13 +1,12 @@
-require 'rails/railtie'
 require 'onload'
 
 module RuxRails
-  class Railtie < Rails::Railtie
+  class Engine < ::Rails::Engine
+    isolate_namespace RuxRails
+
     config.rux = ActiveSupport::OrderedOptions.new
 
     initializer 'rux-rails.initialize', before: 'onload.initialize' do |app|
-      ViewComponent::Base.send(:include, RuxRails::Components)
-
       if config.rux.transpile.nil? && (Rails.env.development? || Rails.env.test?)
         config.rux.transpile = true
         Onload.enabled = true
@@ -29,6 +28,17 @@ module RuxRails
       end
     end
 
+    config.after_initialize do
+      ignore_path = config.rux.ignore_path || Onload.config.ignore_path
+
+      if ignore_path.nil? && Rails.root.join(".gitignore").exist?
+        ignore_path = Rails.root.join(".gitignore").to_s
+      end
+
+      Onload.config.ignore_path = ignore_path
+      config.rux.ignore_path = ignore_path
+    end
+
     rake_tasks do
       load File.expand_path(File.join(*%w(. tasks transpile.rake)), __dir__)
     end

data/lib/rux-rails/tasks/transpile.rake

@@ -3,18 +3,19 @@ require 'set'
 
 namespace :rux do
   task transpile: :environment do
-    config = Rails.application.config
-    paths = Set.new(config.autoload_paths + config.eager_load_paths)
+    ignore_file = if Rails.application.config.rux.ignore_path
+      Onload::IgnoreFile.load(Rails.application.config.rux.ignore_path)
+    end
+
+    Dir.glob(Rails.root.join('**/*.rux')) do |file|
+      rux_file = Rux::File.new(file)
+      rux_file.write
 
-    paths.each do |path|
-      # Skip library paths. Libraries should ship with all their rux files
-      # pre-transpiled.
-      next if Rux.library_paths.include?(path)
+      puts "Wrote #{rux_file.default_outfile}"
 
-      Dir.glob(File.join(path, '**/*.rux')).each do |file|
-        Rux::File.new(file).write
-        puts "Wrote #{file}"
-      end
+      ignore_file&.add(rux_file.default_outfile)
     end
+
+    ignore_file&.persist!
   end
 end

data/lib/rux-rails/version.rb

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

data/lib/rux-rails.rb

@@ -24,7 +24,10 @@ end
 
 
 require 'rux'
-require 'rux-rails/railtie'
+
+if defined?(Rails)
+  require 'rux-rails/engine'
+end
 
 Rux.tag_builder = RuxRails.tag_builder
 Rux.buffer = RuxRails::OutputBuffer

data/rux-rails.gemspec

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

data/spec/components/rails/button_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Rails::Button, type: :component do
+  it 'renders with defaults' do
+    render_inline(described_class.new)
+    expect(rendered_content).to eq("<button name=\"button\" type=\"submit\">Button</button>")
+  end
+
+  it 'renders with the given label' do
+    render_inline(described_class.new(label: "Click me"))
+    expect(rendered_content).to eq("<button name=\"button\" type=\"submit\">Click me</button>")
+  end
+
+  it 'renders with the given attributes' do
+    render_inline(described_class.new(disabled: true))
+    expect(rendered_content).to eq("<button name=\"button\" type=\"submit\" disabled=\"disabled\">Button</button>")
+  end
+end

data/spec/components/rails/button_to_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Rails::ButtonTo, type: :component do
+  it 'renders with defaults' do
+    render_inline(described_class.new(url: "http://example.com"))
+    expect(rendered_content).to include(
+      /<form .* action=\"http:\/\/example.com".*<button type=\"submit\"><\/button>/
+    )
+  end
+
+  it 'renders with a label' do
+    render_inline(described_class.new(label: "Click me", url: "http://example.com"))
+    expect(rendered_content).to include(
+      /<form .* action=\"http:\/\/example.com".*<button type=\"submit\">Click me<\/button>/
+    )
+  end
+
+  it 'renders with the content as the label' do
+    render_inline(described_class.new(url: "http://example.com")) { "Click me" }
+    expect(rendered_content).to include(
+      /<form .* action=\"http:\/\/example.com".*<button type=\"submit\">Click me<\/button>/
+    )
+  end
+end

data/spec/components/rails/content_tag_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Rails::ContentTag, type: :component do
+  it 'renders an empty tag by default' do
+    render_inline(described_class.new(tag: :div))
+    expect(rendered_content).to eq("<div></div>")
+  end
+
+  it 'renders content within the tags' do
+    render_inline(described_class.new(tag: :div)) { 'Hello, world' }
+    expect(rendered_content).to eq("<div>Hello, world</div>")
+  end
+end

data/spec/components/rails/form_with_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Rails::FormWith, type: :component do
+  it 'renders with defaults' do
+    render_inline(described_class.new(url: "/foo"))
+    expect(rendered_content).to include("<form action=\"/foo\" accept-charset=\"UTF-8\" method=\"post\"><input type=\"hidden\" name=\"authenticity_token\"")
+  end
+
+  it 'adds the builder to the rux context' do
+    builder = nil
+
+    render_inline(described_class.new(url: "/foo")) do
+      UseContext.use_context(:rux, :form_builder) do |f|
+        builder = f
+      end
+    end
+
+    expect(builder).to be_a(ActionView::Helpers::FormBuilder)
+  end
+end

data/spec/components/rails/hidden_field_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Rails::HiddenField, type: :component do
+  it 'renders with defaults' do
+    render_inline(Rails::FormWith.new(url: "/foo")) do
+      described_class.new(name: "bar").render_in(view_context)
+    end
+
+    expect(rendered_content).to include("<input autocomplete=\"off\" type=\"hidden\" name=\"bar\" id=\"bar\" />")
+  end
+end

data/spec/components/rails/label_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Rails::Label, type: :component do
+  it 'renders with defaults' do
+    render_inline(Rails::FormWith.new(url: "/foo")) do
+      described_class.new(name: "bar").render_in(view_context)
+    end
+
+    expect(rendered_content).to include("<label for=\"bar\">Bar</label>")
+  end
+
+  it 'renders content within the tags' do
+    render_inline(Rails::FormWith.new(url: "/foo")) do
+      described_class.new(name: "bar").render_in(view_context) do
+        "Hello, world"
+      end
+    end
+
+    expect(rendered_content).to include("<label for=\"bar\">Hello, world</label>")
+  end
+end

data/spec/components/rails/link_to_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Rails::LinkTo, type: :component do
+  it 'renders with defaults' do
+    render_inline(described_class.new(url: "http://example.com", label: "foo"))
+    expect(rendered_content).to eq("<a href=\"http://example.com\">foo</a>")
+  end
+
+  it 'renders the content between the tags' do
+    render_inline(described_class.new(url: "http://example.com")) do
+      "Hello, world"
+    end
+
+    expect(rendered_content).to eq("<a href=\"http://example.com\">Hello, world</a>")
+  end
+end

data/spec/components/rails/password_field_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Rails::PasswordField, type: :component do
+  it 'renders with defaults' do
+    render_inline(Rails::FormWith.new(url: "/foo")) do
+      described_class.new(name: "bar").render_in(view_context)
+    end
+
+    expect(rendered_content).to include("<input type=\"password\" name=\"bar\" id=\"bar\" />")
+  end
+end

data/spec/components/rails/text_field_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Rails::TextField, type: :component do
+  it 'renders with defaults' do
+    render_inline(Rails::FormWith.new(url: "/foo")) do
+      described_class.new(name: "bar").render_in(view_context)
+    end
+
+    expect(rendered_content).to include("<input type=\"text\" name=\"bar\" id=\"bar\" />")
+  end
+end

data/spec/components/rux/component_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Rux::Component, type: :component do
+  it 'renders the given instance' do
+    render_inline(Rux::Component.new(instance: Image.new(src: "foo.png")))
+
+    expect(rendered_content).to include("<img src=\"/images/foo.png\" />")
+  end
+end

data/spec/controllers/home_controller_spec.rb

@@ -4,7 +4,7 @@ describe HomeController, type: :request do
   describe '#index' do
     before(:each) do
       # Force a recompile to avoid test pollution
-      HomeComponent.compile
+      HomeComponent.respond_to?(:__vc_compile) ? HomeComponent.__vc_compile : HomeComponent.compile
     end
 
     it 'transpiles the file' do

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class Image < ViewComponent::Base
+  include ActionView::Helpers::AssetUrlHelper
+
+  attr_reader :src, :params
+
+  def initialize(src:, **params)
+    @src = src
+    @params = params
+  end
+
+  def call
+    image_tag(src, **params)
+  end
+end