actionview-component 1.7.0 → 1.17.0

data/lib/view_component/conversion.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ViewComponent # :nodoc:
+  module Conversion
+    def to_component_class
+      "#{self.class.name}Component".safe_constantize
+    end
+  end
+end

data/lib/view_component/engine.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "rails"
+require "view_component"
+
+module ViewComponent
+  class Engine < Rails::Engine # :nodoc:
+    config.action_view_component = ActiveSupport::OrderedOptions.new
+
+    initializer "action_view_component.set_configs" do |app|
+      options = app.config.action_view_component
+
+      options.show_previews = Rails.env.development? if options.show_previews.nil?
+
+      if options.show_previews
+        options.preview_path ||= defined?(Rails.root) ? "#{Rails.root}/test/components/previews" : nil
+      end
+
+      ActiveSupport.on_load(:action_view_component) do
+        options.each { |k, v| send("#{k}=", v) }
+      end
+    end
+
+    initializer "action_view_component.set_autoload_paths" do |app|
+      options = app.config.action_view_component
+
+      if options.show_previews && options.preview_path
+        ActiveSupport::Dependencies.autoload_paths << options.preview_path
+      end
+    end
+
+    initializer "action_view_component.eager_load_actions" do
+      ActiveSupport.on_load(:after_initialize) do
+        ViewComponent::Base.descendants.each(&:compile)
+      end
+    end
+
+    initializer "action_view_component.compile_config_methods" do
+      ActiveSupport.on_load(:action_view_component) do
+        config.compile_methods! if config.respond_to?(:compile_methods!)
+      end
+    end
+
+    initializer "action_view_component.monkey_patch_render" do
+      ActiveSupport.on_load(:action_view) do
+        ActionView::Base.prepend ViewComponent::RenderMonkeyPatch
+      end
+
+      ActiveSupport.on_load(:action_controller) do
+        ActionController::Base.prepend ViewComponent::RenderingMonkeyPatch
+      end
+    end
+
+    config.after_initialize do |app|
+      options = app.config.action_view_component
+
+      if options.show_previews
+        app.routes.prepend do
+          get "/rails/components"       => "rails/components#index", :internal => true
+          get "/rails/components/*path" => "rails/components#previews", :internal => true
+        end
+      end
+    end
+  end
+end

data/lib/view_component/preview.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "active_support/descendants_tracker"
+
+module ViewComponent # :nodoc:
+  class Preview
+    include ActionView::Helpers::TagHelper
+    extend ActiveSupport::DescendantsTracker
+
+    def render(component, **args, &block)
+      { component: component, args: args, block: block }
+    end
+
+    class << self
+      # Returns all component preview classes.
+      def all
+        load_previews if descendants.empty?
+        descendants
+      end
+
+      # Returns the arguments for rendering of the component in its layout
+      def render_args(example)
+        new.public_send(example).merge(layout: @layout)
+      end
+
+      # Returns the component object class associated to the preview.
+      def component
+        name.chomp("Preview").constantize
+      end
+
+      # Returns all of the available examples for the component preview.
+      def examples
+        public_instance_methods(false).map(&:to_s).sort
+      end
+
+      # Returns +true+ if the example of the component preview exists.
+      def example_exists?(example)
+        examples.include?(example)
+      end
+
+      # Returns +true+ if the preview exists.
+      def exists?(preview)
+        all.any? { |p| p.preview_name == preview }
+      end
+
+      # Find a component preview by its underscored class name.
+      def find(preview)
+        all.find { |p| p.preview_name == preview }
+      end
+
+      # Returns the underscored name of the component preview without the suffix.
+      def preview_name
+        name.chomp("Preview").underscore
+      end
+
+      # Setter for layout name.
+      def layout(layout_name)
+        @layout = layout_name
+      end
+
+      private
+
+      def load_previews
+        if preview_path
+          Dir["#{preview_path}/**/*_preview.rb"].sort.each { |file| require_dependency file }
+        end
+      end
+
+      def preview_path
+        Base.preview_path
+      end
+
+      def show_previews
+        Base.show_previews
+      end
+    end
+  end
+end

data/lib/view_component/previewable.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module ViewComponent # :nodoc:
+  module Previewable
+    extend ActiveSupport::Concern
+
+    included do
+      # Set the location of component previews through app configuration:
+      #
+      #     config.action_view_component.preview_path = "#{Rails.root}/lib/component_previews"
+      #
+      mattr_accessor :preview_path, instance_writer: false
+
+      # Enable or disable component previews through app configuration:
+      #
+      #     config.action_view_component.show_previews = true
+      #
+      # Defaults to +true+ for development environment
+      #
+      mattr_accessor :show_previews, instance_writer: false
+    end
+  end
+end

data/lib/view_component/render_monkey_patch.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module RenderMonkeyPatch # :nodoc:
+    def render(options = {}, args = {}, &block)
+      if options.respond_to?(:render_in) && Rails.version.to_f < 6.1
+        options.render_in(self, &block)
+      elsif options.is_a?(Class) && options < ActionView::Component::Base
+        ActiveSupport::Deprecation.warn(
+          "`render MyComponent, foo: :bar` has been deprecated and will be removed in v2.0.0. Use `render MyComponent.new(foo: :bar)` instead."
+        )
+
+        options.new(args).render_in(self, &block)
+      elsif options.is_a?(Hash) && options.has_key?(:component) && options[:component] < ActionView::Component::Base
+        ActiveSupport::Deprecation.warn(
+          "`render component: MyComponent, locals: { foo: :bar }` has been deprecated and will be removed in v2.0.0. Use `render MyComponent.new(foo: :bar)` instead."
+        )
+
+        options[:component].new(options[:locals]).render_in(self, &block)
+      elsif options.respond_to?(:to_component_class) && !options.to_component_class.nil? && options.to_component_class < ActionView::Component::Base
+        ActiveSupport::Deprecation.warn(
+          "rendering objects that respond_to `to_component_class` has been deprecated and will be removed in v2.0.0. Use `render MyComponent.new(foo: :bar)` instead."
+        )
+
+        options.to_component_class.new(options).render_in(self, &block)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/view_component/rendering_monkey_patch.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module RenderingMonkeyPatch # :nodoc:
+    def render(options = {}, args = {})
+      if options.respond_to?(:render_in) && Rails.version.to_f < 6.1
+        self.response_body = options.render_in(self.view_context)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/view_component/template_error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  class TemplateError < StandardError
+    def initialize(errors)
+      super(errors.join(", "))
+    end
+  end
+end

data/lib/view_component/test_case.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "active_support/test_case"
+
+module ViewComponent
+  class TestCase < ActiveSupport::TestCase
+    include ViewComponent::TestHelpers
+  end
+end

data/lib/view_component/test_helpers.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "capybara/minitest"
+
+module ViewComponent
+  module TestHelpers
+    include Capybara::Minitest::Assertions
+
+    def page
+      Capybara::Node::Simple.new(@raw)
+    end
+
+    def refute_component_rendered
+      assert_no_selector("body")
+    end
+
+    def render_inline(component, **args, &block)
+      @raw = controller.view_context.render(component, args, &block)
+
+      Nokogiri::HTML.fragment(@raw)
+    end
+
+    def controller
+      @controller ||= Base.test_controller.constantize.new.tap { |c| c.request = request }.extend(Rails.application.routes.url_helpers)
+    end
+
+    def request
+      @request ||= ActionDispatch::TestRequest.create
+    end
+
+    def with_variant(variant)
+      old_variants = controller.view_context.lookup_context.variants
+
+      controller.view_context.lookup_context.variants = variant
+      yield
+      controller.view_context.lookup_context.variants = old_variants
+    end
+  end
+end

data/lib/view_component/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module VERSION
+    MAJOR = 1
+    MINOR = 17
+    PATCH = 0
+
+    STRING = [MAJOR, MINOR, PATCH].join(".")
+  end
+end

data/script/console

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require "bundler/setup"
-require "action_view/component"
+require "view_component"
 
 require "irb"
 IRB.start(__FILE__)

metadata

@@ -1,27 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: actionview-component
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.17.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-09 00:00:00.000000000 Z
+date: 2020-03-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.14'
 - !ruby/object:Gem::Dependency
@@ -30,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -122,9 +136,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.13.0
-description: View components for Rails, intended for upstreaming in Rails 6.1
+description: 
 email:
-- opensource+actionview-component@github.com
+- opensource+view_component@github.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -143,43 +157,56 @@ files:
 - README.md
 - Rakefile
 - actionview-component.gemspec
+- app/controllers/rails/components_controller.rb
+- docs/case-studies/jellyswitch.md
 - lib/action_view/component.rb
 - lib/action_view/component/base.rb
-- lib/action_view/component/conversion.rb
 - lib/action_view/component/preview.rb
-- lib/action_view/component/previewable.rb
 - lib/action_view/component/railtie.rb
-- lib/action_view/component/render_monkey_patch.rb
-- lib/action_view/component/template_error.rb
 - lib/action_view/component/test_case.rb
 - lib/action_view/component/test_helpers.rb
-- lib/action_view/component/version.rb
 - lib/rails/generators/component/USAGE
 - lib/rails/generators/component/component_generator.rb
-- lib/rails/generators/component/templates/component.html.erb.tt
 - lib/rails/generators/component/templates/component.rb.tt
+- lib/rails/generators/erb/component_generator.rb
+- lib/rails/generators/erb/templates/component.html.erb.tt
+- lib/rails/generators/haml/component_generator.rb
+- lib/rails/generators/haml/templates/component.html.haml.tt
 - lib/rails/generators/rspec/component_generator.rb
 - lib/rails/generators/rspec/templates/component_spec.rb.tt
+- lib/rails/generators/slim/component_generator.rb
+- lib/rails/generators/slim/templates/component.html.slim.tt
 - lib/rails/generators/test_unit/component_generator.rb
 - lib/rails/generators/test_unit/templates/component_test.rb.tt
 - lib/railties/lib/rails.rb
-- lib/railties/lib/rails/component_examples_controller.rb
-- lib/railties/lib/rails/components_controller.rb
 - lib/railties/lib/rails/templates/rails/components/index.html.erb
 - lib/railties/lib/rails/templates/rails/components/preview.html.erb
 - lib/railties/lib/rails/templates/rails/components/previews.html.erb
-- lib/railties/lib/rails/templates/rails/examples/show.html.erb
+- lib/view_component.rb
+- lib/view_component/base.rb
+- lib/view_component/conversion.rb
+- lib/view_component/engine.rb
+- lib/view_component/preview.rb
+- lib/view_component/previewable.rb
+- lib/view_component/render_monkey_patch.rb
+- lib/view_component/rendering_monkey_patch.rb
+- lib/view_component/template_error.rb
+- lib/view_component/test_case.rb
+- lib/view_component/test_helpers.rb
+- lib/view_component/version.rb
 - script/bootstrap
 - script/console
 - script/install
 - script/release
 - script/test
-homepage: https://github.com/github/actionview-component
+homepage: https://github.com/github/view_component
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message: 'WARNING: actionview-component has been renamed to view_component,
+  and will no longer be published in this namespace. Please update your Gemfile to
+  use view_component.'
 rdoc_options: []
 require_paths:
 - lib
@@ -194,8 +221,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: View components for Rails
+summary: MOVED to view_component.
 test_files: []