view_component 1.17.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91485b58594a99f3189bf1ee9eb24f5943e264dc3581b1331d8586b0547923df
-  data.tar.gz: 47629f3e6d93eaf333dffb53f2d465fdf8669034aa48592a9e144de04e67fe86
+  metadata.gz: 45ac24e1dc67b91015f67efc09208e7b185c90bb1ca84de486b810dc1d699116
+  data.tar.gz: b87bcf3c0c50e8ca497757951736e9029cbd0411bdbd97134b136511f2855740
 SHA512:
-  metadata.gz: 650f7631c2b3b11ab5399c567e96639158641484950c70aefc1c73982b79c8fc19082cd1d3b9571806af5576aa5417e1aad8682353ad9031c52d89b127478b0a
-  data.tar.gz: 2d7bccb44d21f6a9232b39b278cb66dc2deb068ea00660fbabfa2737e28c70dbc09a4990fecb308c1ae318839480010f07aa7b6bf3df69259d8ff9b275afa2d4
+  metadata.gz: 41aa382866ac371d48e305383df40fcfd8568c7ea4e98c0acf38784c7bee267adb40ce8a9b065de55a5c5622ca9e8584a55b66e838c7203a52fa5646eca4f0c6
+  data.tar.gz: e66a6eccab9e8774dea217944e2a00a38f09276aac57c200e0dee7075a9cfa096029d2ad28debc5ee6ea66ad7c3af2a3248a5f6803bbcc94198364a5cb2f98c4

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # master
 
+# v2.0.0
+
+* Move to `ViewComponent` namespace, removing all references to `ActionView`.
+
+    * The gem name is now `view_component`.
+    * ViewComponent previews are now accessed at `/rails/view_components`.
+    * ViewComponents can _only_ be rendered with the instance syntax: `render(MyComponent.new)`. Support for all other syntaxes has been removed.
+    * ActiveModel::Validations have been removed. ViewComponent generators no longer include validations.
+    * In Rails 6.1, no monkey patching is used.
+    * `to_component_class` has been removed.
+    * All gem configuration is now in `config.view_component`.
+
 # v1.17.0
 
 * Support Ruby 2.4 in CI.

data/CONTRIBUTING.md

@@ -34,13 +34,13 @@ Here are a few things you can do that will increase the likelihood of your pull
 If you are the current maintainer of this gem:
 
 1. Create a branch for the release: `git checkout -b release-vxx.xx.xx`
-1. Bump gem version in `lib/action_view/component/version.rb`. Try to adhere to SemVer.
+1. Bump gem version in `lib/view_component/version.rb`. Try to adhere to SemVer.
 1. Add version heading/entries to `CHANGELOG.md`.
 1. Make sure your local dependencies are up to date: `bundle`
 1. Ensure that tests are green: `bundle exec rake`
 1. Make a PR to github/view_component.
-1. Build a local gem: `gem build actionview-component.gemspec`
+1. Build a local gem: `gem build view_component.gemspec`
 1. Merge github/view_component PR
 1. Tag and push: `git tag vx.xx.xx; git push --tags`
 1. Create a GitHub release with the pushed tag (https://github.com/github/view_component/releases/new) and populate it with a list of the commits from `git log --pretty=format:"- %s" --reverse refs/tags/[OLD TAG]...refs/tags/[NEW TAG]`
-1. Push to rubygems.org -- `gem push actionview-component-VERSION.gem`
+1. Push to rubygems.org -- `gem push view_component-VERSION.gem`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    actionview-component (1.17.0)
+    view_component (2.0.0)
       capybara (~> 3)
 
 GEM
@@ -187,7 +187,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  actionview-component!
   better_html (~> 1)
   bundler (~> 1.14)
   haml (~> 5)
@@ -197,6 +196,7 @@ DEPENDENCIES
   rubocop (= 0.74)
   rubocop-github (~> 0.13.0)
   slim (~> 4.0)
+  view_component!
 
 BUNDLED WITH
    1.17.3

data/README.md

@@ -15,7 +15,8 @@ This gem is in the process of a name / API change from `ActionView::Component` t
 
 ### How to migrate to ViewComponent
 
-1. In `application.rb`, require `view_component/engine`
+1. Update `Gemfile` to use `view_component`.
+1. In `application.rb`, require `view_component/engine`.
 1. Update components to inherit from `ViewComponent::Base`.
 1. Update component tests to inherit from `ViewComponent::TestCase`.
 1. Update component previews to inherit from `ViewComponent::Preview`.
@@ -33,14 +34,14 @@ This library is designed to integrate as seamlessly as possible with Rails, with
 
 ## Compatibility
 
-`actionview-component` is tested for compatibility with combinations of Ruby `2.4`/`2.5`/`2.6`/`2.7` and Rails `5.0.0`/`5.2.3`/`6.0.0`/`master`.
+`view_component` is tested for compatibility with combinations of Ruby `2.4`/`2.5`/`2.6`/`2.7` and Rails `5.0.0`/`5.2.3`/`6.0.0`/`master`.
 
 ## Installation
 
 In `Gemfile`, add:
 
 ```ruby
-gem "actionview-component"
+gem "view_component"
 ```
 
 In `config/application.rb`, add:
@@ -322,9 +323,9 @@ class TestComponentPreview < ViewComponent::Preview
 end
 ```
 
-Which generates <http://localhost:3000/rails/components/test_component/with_default_title>,
-<http://localhost:3000/rails/components/test_component/with_long_title>,
-and <http://localhost:3000/rails/components/test_component/with_content_block>.
+Which generates <http://localhost:3000/rails/view_components/test_component/with_default_title>,
+<http://localhost:3000/rails/view_components/test_component/with_long_title>,
+and <http://localhost:3000/rails/view_components/test_component/with_content_block>.
 
 The `ViewComponent::Preview` base class includes
 [`ActionView::Helpers::TagHelper`][tag-helper], which provides the [`tag`][tag]
@@ -351,7 +352,7 @@ To use `lib/component_previews`:
 
 `config/application.rb`
 ```ruby
-config.action_view_component.preview_path = "#{Rails.root}/lib/component_previews"
+config.view_component.preview_path = "#{Rails.root}/lib/component_previews"
 ```
 
 #### Configuring TestController
@@ -360,7 +361,7 @@ Component tests and previews assume the existence of an `ApplicationController`
 
 `config/application.rb`
 ```ruby
-config.action_view_component.test_controller = "BaseController"
+config.view_component.test_controller = "BaseController"
 ```
 
 ### Setting up RSpec
@@ -382,7 +383,7 @@ To use component previews:
 
 `config/application.rb`
 ```ruby
-config.action_view_component.preview_path = "#{Rails.root}/spec/components/previews"
+config.view_component.preview_path = "#{Rails.root}/spec/components/previews"
 ```
 
 ## Frequently Asked Questions
@@ -418,7 +419,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/github
 
 ## Contributors
 
-`actionview-component` is built by:
+`view_component` is built by:
 
 |<img src="https://avatars.githubusercontent.com/joelhawksley?s=256" alt="joelhawksley" width="128" />|<img src="https://avatars.githubusercontent.com/tenderlove?s=256" alt="tenderlove" width="128" />|<img src="https://avatars.githubusercontent.com/jonspalmer?s=256" alt="jonspalmer" width="128" />|<img src="https://avatars.githubusercontent.com/juanmanuelramallo?s=256" alt="juanmanuelramallo" width="128" />|<img src="https://avatars.githubusercontent.com/vinistock?s=256" alt="vinistock" width="128" />|
 |:---:|:---:|:---:|:---:|:---:|

data/app/controllers/rails/{components_controller.rb → view_components_controller.rb}

@@ -2,7 +2,7 @@
 
 require "rails/application_controller"
 
-class Rails::ComponentsController < Rails::ApplicationController # :nodoc:
+class Rails::ViewComponentsController < Rails::ApplicationController # :nodoc:
   prepend_view_path File.expand_path("../../../lib/railties/lib/rails/templates/rails", __dir__)
   prepend_view_path "#{Rails.root}/app/views/" if defined?(Rails.root)
 

data/lib/railties/lib/rails/templates/rails/components/index.html.erb

@@ -1,8 +1,8 @@
 <% @previews.each do |preview| %>
-  <h3><%= link_to preview.preview_name.titleize, "/rails/components/#{preview.preview_name}" %></h3>
+  <h3><%= link_to preview.preview_name.titleize, "/rails/view_components/#{preview.preview_name}" %></h3>
   <ul>
     <% preview.examples.each do |preview_example| %>
-      <li><%= link_to preview_example, "/rails/components/#{preview.preview_name}/#{preview_example}" %></li>
+      <li><%= link_to preview_example, "/rails/view_components/#{preview.preview_name}/#{preview_example}" %></li>
     <% end %>
   </ul>
 <% end %>

data/lib/railties/lib/rails/templates/rails/components/previews.html.erb

@@ -1,6 +1,6 @@
 <h3><%= @preview.preview_name.titleize %></h3>
 <ul>
   <% @preview.examples.each do |example| %>
-    <li><%= link_to example, "/rails/components/#{@preview.preview_name}/#{example}" %></li>
+    <li><%= link_to example, "/rails/view_components/#{@preview.preview_name}/#{example}" %></li>
   <% end %>
 </ul>

data/lib/view_component.rb

@@ -6,7 +6,6 @@ module ViewComponent
   extend ActiveSupport::Autoload
 
   autoload :Base
-  autoload :Conversion
   autoload :Preview
   autoload :Previewable
   autoload :TestHelpers
@@ -15,16 +14,3 @@ module ViewComponent
   autoload :RenderingMonkeyPatch
   autoload :TemplateError
 end
-
-module ActionView
-  module Component
-    extend ActiveSupport::Autoload
-
-    autoload :Base
-    autoload :Preview
-    autoload :TestCase
-    autoload :TestHelpers
-  end
-end
-
-ActiveModel::Conversion.include ViewComponent::Conversion

data/lib/view_component/base.rb

@@ -274,6 +274,6 @@ module ViewComponent
       end
     end
 
-    ActiveSupport.run_load_hooks(:action_view_component, self)
+    ActiveSupport.run_load_hooks(:view_component, self)
   end
 end

data/lib/view_component/engine.rb

@@ -5,10 +5,10 @@ require "view_component"
 
 module ViewComponent
   class Engine < Rails::Engine # :nodoc:
-    config.action_view_component = ActiveSupport::OrderedOptions.new
+    config.view_component = ActiveSupport::OrderedOptions.new
 
-    initializer "action_view_component.set_configs" do |app|
-      options = app.config.action_view_component
+    initializer "view_component.set_configs" do |app|
+      options = app.config.view_component
 
       options.show_previews = Rails.env.development? if options.show_previews.nil?
 
@@ -16,48 +16,48 @@ module ViewComponent
         options.preview_path ||= defined?(Rails.root) ? "#{Rails.root}/test/components/previews" : nil
       end
 
-      ActiveSupport.on_load(:action_view_component) do
+      ActiveSupport.on_load(: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
+    initializer "view_component.set_autoload_paths" do |app|
+      options = app.config.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
+    initializer "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
+    initializer "view_component.compile_config_methods" do
+      ActiveSupport.on_load(:view_component) do
         config.compile_methods! if config.respond_to?(:compile_methods!)
       end
     end
 
-    initializer "action_view_component.monkey_patch_render" do
+    initializer "view_component.monkey_patch_render" do
       ActiveSupport.on_load(:action_view) do
-        ActionView::Base.prepend ViewComponent::RenderMonkeyPatch
+        ActionView::Base.prepend ViewComponent::RenderMonkeyPatch if Rails.version.to_f < 6.1
       end
 
       ActiveSupport.on_load(:action_controller) do
-        ActionController::Base.prepend ViewComponent::RenderingMonkeyPatch
+        ActionController::Base.prepend ViewComponent::RenderingMonkeyPatch if Rails.version.to_f < 6.1
       end
     end
 
     config.after_initialize do |app|
-      options = app.config.action_view_component
+      options = app.config.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
+          get "/rails/view_components"       => "rails/view_components#index", :internal => true
+          get "/rails/view_components/*path" => "rails/view_components#previews", :internal => true
         end
       end
     end

data/lib/view_component/previewable.rb

@@ -9,13 +9,13 @@ module ViewComponent # :nodoc:
     included do
       # Set the location of component previews through app configuration:
       #
-      #     config.action_view_component.preview_path = "#{Rails.root}/lib/component_previews"
+      #     config.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
+      #     config.view_component.show_previews = true
       #
       # Defaults to +true+ for development environment
       #

data/lib/view_component/render_monkey_patch.rb

@@ -3,26 +3,8 @@
 module ViewComponent
   module RenderMonkeyPatch # :nodoc:
     def render(options = {}, args = {}, &block)
-      if options.respond_to?(:render_in) && Rails.version.to_f < 6.1
+      if options.respond_to?(:render_in)
         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

data/lib/view_component/rendering_monkey_patch.rb

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

data/lib/view_component/version.rb

@@ -2,8 +2,8 @@
 
 module ViewComponent
   module VERSION
-    MAJOR = 1
-    MINOR = 17
+    MAJOR = 2
+    MINOR = 0
     PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 2.0.0
 platform: ruby
 authors:
 - GitHub Open Source
@@ -156,14 +156,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- app/controllers/rails/components_controller.rb
+- app/controllers/rails/view_components_controller.rb
 - docs/case-studies/jellyswitch.md
-- lib/action_view/component.rb
-- lib/action_view/component/base.rb
-- lib/action_view/component/preview.rb
-- lib/action_view/component/railtie.rb
-- lib/action_view/component/test_case.rb
-- lib/action_view/component/test_helpers.rb
 - lib/rails/generators/component/USAGE
 - lib/rails/generators/component/component_generator.rb
 - lib/rails/generators/component/templates/component.rb.tt
@@ -183,7 +177,6 @@ files:
 - lib/railties/lib/rails/templates/rails/components/previews.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

data/lib/action_view/component.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-require "active_model"
-require "view_component"

data/lib/action_view/component/base.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module ActionView
-  module Component
-    class Base < ViewComponent::Base
-      include ActiveModel::Validations
-
-      def before_render_check
-        validate!
-      end
-    end
-  end
-end

data/lib/action_view/component/preview.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module ActionView
-  module Component # :nodoc:
-    class Preview < ViewComponent::Preview
-    end
-  end
-end

data/lib/action_view/component/railtie.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require "view_component/engine"

data/lib/action_view/component/test_case.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module ActionView
-  module Component
-    class TestCase
-      include ActionView::Component::TestHelpers
-    end
-  end
-end

data/lib/action_view/component/test_helpers.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module ActionView
-  module Component
-    module TestHelpers
-      include ViewComponent::TestHelpers
-
-      def render_component(component, **args, &block)
-        ActiveSupport::Deprecation.warn(
-          "`render_component` has been deprecated in favor of `render_inline`, and will be removed in v2.0.0."
-        )
-
-        render_inline(component, args, &block)
-      end
-    end
-  end
-end

data/lib/view_component/conversion.rb

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