actionview-component 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c48fe5574dd67f62c3552735fc62e4dc324fe21b604e52b7d0bf1b20c0f5a041
-  data.tar.gz: e91a31acd0dc6df545ddfb8c0f58beabc401e55937b850830eeac204cecfa66f
+  metadata.gz: 59f02a9bdd999da01d26a2f7a9c80d0ec6cd1cf96d0195f8d2aa983f504d9908
+  data.tar.gz: ea36b326f6c565cf64acc827449dc11372a2bf10c49a77b5e994d9597234e926
 SHA512:
-  metadata.gz: 359d329d3126da4f07b655da1f057a2bf9920534039fa7767d2f8d208bd7e535cd6de6fda3ef0a63c5976f6a4c81aabc2515db121ea3b6370572b3543adc3c41
-  data.tar.gz: c141f0bd9c595bf6bdb7079b91dd193af8483d5c74fd29ab4ab94cc9b444ea76a1f19ae625d1be3395c19bade5f39b650d03db318539b3eea13a97aa989863ca
+  metadata.gz: e87095b78618384e60884166c0a6eb9d024c94afe0f5e4d44b1295dd5fbdf8a84000e304d8c4b56e51e8c6112f6416718fe04667b9e13bca4b2a5283c6346b49
+  data.tar.gz: '08dc5a1408d730948c08239a90edea25cfde9cc144a7e4b24ecfd4ee6817f7a49c19df7acec9fdfd58b26545c8fe182080dc436f3ac9aa14b17479365a40166b'

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+*   Components now inherit from ActionView::Component::base
+
+    *Joel Hawksley*
+
+*   Always recompile component templates outside production.
+
+    *Joel Hawksley, John Hawthorn*

data/CONTRIBUTING.md

@@ -39,7 +39,7 @@ If you are the current maintainer of this gem:
    1. Bump the Gemfile and Gemfile.lock versions for an app which relies on this gem
    1. Install the new gem locally
    1. Test behavior locally, branch deploy, whatever needs to happen
-1. Bump gem version in `action_view/component`.
+1. Bump gem version in `actionview-component.gemspec`.
 1. Make a PR to github/actionview-component.
 1. Build a local gem: `gem build actionview-component.gemspec`
 1. Merge github/actionview-component PR

data/README.md

@@ -28,7 +28,7 @@ $ bundle
 In `config/application.rb`, add:
 
 ```bash
-require "action_view/component"
+require "action_view/component/base"
 ```
 
 ## Guide
@@ -89,7 +89,9 @@ Components are most effective in cases where view code is reused or needs to be
 
 ### Building components
 
-Components are subclasses of `ActionView::Component` and live in `app/components`. You may wish to create an `ApplicationComponent` that is a subclass of `ActionView::Component` and inherit from that instead.
+Components are subclasses of `ActionView::Component::Base` and live in `app/components`. You may wish to create an `ApplicationComponent` that is a subclass of `ActionView::Component::Base` and inherit from that instead.
+
+Component class names end in -`Component`.
 
 Components support ActiveModel validations. Components are validated after initialization, but before rendering.
 
@@ -101,7 +103,7 @@ An `ActionView::Component` is a Ruby file and corresponding template file (in an
 
 `app/components/test_component.rb`:
 ```ruby
-class TestComponent < ActionView::Component
+class TestComponent < ActionView::Component::Base
   validates :content, :title, presence: true
 
   def initialize(title:)
@@ -152,10 +154,10 @@ An error will be raised:
 Components are unit tested directly. The `render_component` test helper renders a component and wraps the result in `Nokogiri.HTML`, allowing us to test the component above as:
 
 ```ruby
-require "action_view/component_test_helpers"
+require "action_view/component/test_helpers"
 
 class MyComponentTest < Minitest::Test
-  include ActionView::ComponentTestHelpers
+  include ActionView::Component::TestHelpers
 
   def test_render_component
     assert_equal(

data/actionview-component.gemspec

@@ -6,7 +6,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "actionview-component"
-  spec.version       = "1.0.1"
+  spec.version       = "1.1.0"
   spec.authors       = ["GitHub Open Source"]
   spec.email         = ["opensource+actionview-component@github.com"]
 

data/lib/action_view/component/base.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+# Monkey patch ActionView::Base#render to support ActionView::Component
+#
+# Upstreamed in https://github.com/rails/rails/pull/36388
+# Necessary for Rails versions < 6.1.0.alpha
+class ActionView::Base
+  module RenderMonkeyPatch
+    def render(component, _ = nil, &block)
+      return super unless component.respond_to?(:render_in)
+
+      component.render_in(self, &block)
+    end
+  end
+
+  prepend RenderMonkeyPatch unless Rails::VERSION::MINOR > 0 && Rails::VERSION::MAJOR == 6
+end
+
+module ActionView
+  module Component
+    class Base < ActionView::Base
+      include ActiveModel::Validations
+
+      # Entrypoint for rendering components. Called by ActionView::Base#render.
+      #
+      # view_context: ActionView context from calling view
+      # args(hash): params to be passed to component being rendered
+      # block: optional block to be captured within the view context
+      #
+      # returns HTML that has been escaped by the respective template handler
+      #
+      # Example subclass:
+      #
+      # app/components/my_component.rb:
+      # class MyComponent < ActionView::Component::Base
+      #   def initialize(title:)
+      #     @title = title
+      #   end
+      # end
+      #
+      # app/components/my_component.html.erb
+      # <span title="<%= @title %>">Hello, <%= content %>!</span>
+      #
+      # In use:
+      # <%= render MyComponent.new(title: "greeting") do %>world<% end %>
+      # returns:
+      # <span title="greeting">Hello, world!</span>
+      #
+      def render_in(view_context, *args, &block)
+        self.class.compile
+        @content = view_context.capture(&block) if block_given?
+        validate!
+        call
+      end
+
+      def initialize(*); end
+
+      class << self
+        def inherited(child)
+          child.include Rails.application.routes.url_helpers unless child < Rails.application.routes.url_helpers
+
+          super
+        end
+
+        # Compile template to #call instance method, assuming it hasn't been compiled already.
+        # We could in theory do this on app boot, at least in production environments.
+        # Right now this just compiles the template the first time the component is rendered.
+        def compile
+          return if @compiled && ActionView::Base.cache_template_loading
+
+          class_eval("def call; @output_buffer = ActionView::OutputBuffer.new; #{compiled_template}; end")
+
+          @compiled = true
+        end
+
+        private
+
+        def compiled_template
+          handler = ActionView::Template.handler_for_extension(File.extname(template_file_path).gsub(".", ""))
+          template = File.read(template_file_path)
+
+          if handler.method(:call).parameters.length > 1
+            handler.call(DummyTemplate.new, template)
+          else
+            handler.call(DummyTemplate.new(template))
+          end
+        end
+
+        def template_file_path
+          raise NotImplementedError.new("#{self} must implement #initialize.") unless self.instance_method(:initialize).owner == self
+
+          filename = self.instance_method(:initialize).source_location[0]
+          filename_without_extension = filename[0..-(File.extname(filename).length + 1)]
+          sibling_files = Dir["#{filename_without_extension}.*"] - [filename]
+
+          if sibling_files.length > 1
+            raise StandardError.new("More than one template found for #{self}. There can only be one sidecar template file per component.")
+          end
+
+          if sibling_files.length == 0
+            raise NotImplementedError.new(
+              "Could not find a template file for #{self}."
+            )
+          end
+
+          sibling_files[0]
+        end
+      end
+
+      class DummyTemplate
+        attr_reader :source
+
+        def initialize(source = nil)
+          @source = source
+        end
+
+        def identifier
+          ""
+        end
+
+        # we'll eventually want to update this to support other types
+        def type
+          "text/html"
+        end
+      end
+
+      private
+
+      attr_reader :content
+    end
+  end
+end

data/lib/action_view/component/test_helpers.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ActionView
+  module Component
+    module TestHelpers
+      def render_component(component, &block)
+        Nokogiri::HTML(component.render_in(ApplicationController.new.view_context, &block))
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionview-component
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-23 00:00:00.000000000 Z
+date: 2019-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,6 +118,7 @@ files:
 - ".github/workflows/ruby_on_rails.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
@@ -126,8 +127,8 @@ files:
 - README.md
 - Rakefile
 - actionview-component.gemspec
-- lib/action_view/component.rb
-- lib/action_view/component_test_helpers.rb
+- lib/action_view/component/base.rb
+- lib/action_view/component/test_helpers.rb
 - script/bootstrap
 - script/console
 - script/install

data/lib/action_view/component.rb

@@ -1,132 +0,0 @@
-# frozen_string_literal: true
-
-# Monkey patch ActionView::Base#render to support ActionView::Component
-#
-# Upstreamed in https://github.com/rails/rails/pull/36388
-# Necessary for Rails versions < 6.1.0.alpha
-class ActionView::Base
-  module RenderMonkeyPatch
-    def render(component, _ = nil, &block)
-      return super unless component.respond_to?(:render_in)
-
-      component.render_in(self, &block)
-    end
-  end
-
-  prepend RenderMonkeyPatch unless Rails::VERSION::MINOR > 0 && Rails::VERSION::MAJOR == 6
-end
-
-module ActionView
-  class Component < ActionView::Base
-    VERSION = "1.0.0"
-
-    include ActiveModel::Validations
-
-    # Entrypoint for rendering components. Called by ActionView::Base#render.
-    #
-    # view_context: ActionView context from calling view
-    # args(hash): params to be passed to component being rendered
-    # block: optional block to be captured within the view context
-    #
-    # returns HTML that has been escaped by the respective template handler
-    #
-    # Example subclass:
-    #
-    # app/components/my_component.rb:
-    # class MyComponent < ActionView::Component
-    #   def initialize(title:)
-    #     @title = title
-    #   end
-    # end
-    #
-    # app/components/my_component.html.erb
-    # <span title="<%= @title %>">Hello, <%= content %>!</span>
-    #
-    # In use:
-    # <%= render MyComponent.new(title: "greeting") do %>world<% end %>
-    # returns:
-    # <span title="greeting">Hello, world!</span>
-    #
-    def render_in(view_context, *args, &block)
-      self.class.compile
-      @content = view_context.capture(&block) if block_given?
-      validate!
-      call
-    end
-
-    def initialize(*); end
-
-    class << self
-      def inherited(child)
-        child.include Rails.application.routes.url_helpers unless child < Rails.application.routes.url_helpers
-
-        super
-      end
-
-      # Compile template to #call instance method, assuming it hasn't been compiled already.
-      # We could in theory do this on app boot, at least in production environments.
-      # Right now this just compiles the template the first time the component is rendered.
-      def compile
-        return if @compiled && ActionView::Base.cache_template_loading
-
-        class_eval("def call; @output_buffer = ActionView::OutputBuffer.new; #{compiled_template}; end")
-
-        @compiled = true
-      end
-
-      private
-
-      def compiled_template
-        handler = ActionView::Template.handler_for_extension(File.extname(template_file_path).gsub(".", ""))
-        template = File.read(template_file_path)
-
-        if handler.method(:call).parameters.length > 1
-          handler.call(DummyTemplate.new, template)
-        else
-          handler.call(DummyTemplate.new(template))
-        end
-      end
-
-      def template_file_path
-        raise NotImplementedError.new("#{self} must implement #initialize.") unless self.instance_method(:initialize).owner == self
-
-        filename = self.instance_method(:initialize).source_location[0]
-        filename_without_extension = filename[0..-(File.extname(filename).length + 1)]
-        sibling_files = Dir["#{filename_without_extension}.*"] - [filename]
-
-        if sibling_files.length > 1
-          raise StandardError.new("More than one template found for #{self}. There can only be one sidecar template file per component.")
-        end
-
-        if sibling_files.length == 0
-          raise NotImplementedError.new(
-            "Could not find a template file for #{self}."
-          )
-        end
-
-        sibling_files[0]
-      end
-    end
-
-    class DummyTemplate
-      attr_reader :source
-
-      def initialize(source = nil)
-        @source = source
-      end
-
-      def identifier
-        ""
-      end
-
-      # we'll eventually want to update this to support other types
-      def type
-        "text/html"
-      end
-    end
-
-    private
-
-    attr_reader :content
-  end
-end

data/lib/action_view/component_test_helpers.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module ActionView
-  module ComponentTestHelpers
-    def render_component(component, &block)
-      Nokogiri::HTML(component.render_in(ApplicationController.new.view_context, &block))
-    end
-  end
-end