view_component 2.13.0 → 2.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3950532a26d2d6d1ddcf412383bfd9cde269c1f69c3d6f7f03dd4e51e7d638e2
-  data.tar.gz: ee2524ef62b335376287f30709e62f2d39a71e43c0f5ec9853db8142b6c8fb3c
+  metadata.gz: d886f5b071663d4c5cd6bf96d94c02541d4fe86e470e79cc4ec51f1cfcc6c35b
+  data.tar.gz: 01f24da54ab8ebd5a701be24b019e7cbbd97e38cffc74b380d9af4fc006558e5
 SHA512:
-  metadata.gz: c4cc6925445d3486e4c9a6ef915254cf3f28d973ad6a2876fca4fe3435b19ac273f18e89432622eaa38c8bba22ab9e9cafa07e417299dab8537848742175d1c8
-  data.tar.gz: 66d2a44a74a07e78f694adc4790218ee7a9d729e8cd8bb9546d154669a79d5abaa20e7d0bffa0801dfc276ef539b93d5a13dd2b4d3d3093cd8d806972d2dac81
+  metadata.gz: f45dab99819a3b0cd15a812ebe4f678173212b3eaf7d33e76a1c5523462a144a8f8a47cf7466581a629614706a3e9176de0dac7dbda4f63fc7a0a96658a5e55e
+  data.tar.gz: ca67804e62bc095cd0a08373b1a5e415702173c770e9695b2242808546077211d571ccfda4c722031ad08c9d079d41eeaa627e0f206784648b3183debde71bd0

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # master
 
+# 2.14.0
+
+* Add `config.preview_paths` to support multiple locations of component preview files. Deprecate `config.preview_path`.
+
+    *Tomas Celizna*
+
+* Only print warning about a missing capybara dependency if the `DEBUG` environment variable is set.
+
+    *Richard Macklin*
+
 # 2.13.0
 
 * Add the ability to disable the render monkey patch with `config.view_component.render_monkey_patch_enabled`. In versions of Rails < 6.1, add `render_component` and `render_component_to_string` methods which can be used for rendering components instead of `render`.

data/README.md

@@ -664,11 +664,11 @@ class TestComponentPreview < ViewComponent::Preview
 end
 ```
 
-Preview classes live in `test/components/previews`, which can be configured using the `preview_path` option:
+Preview classes live in `test/components/previews`, which can be configured using the `preview_paths` option:
 
 `config/application.rb`
 ```ruby
-config.view_component.preview_path = "#{Rails.root}/lib/component_previews"
+config.view_component.preview_paths << "#{Rails.root}/lib/component_previews"
 ```
 
 Previews are served from <http://localhost:3000/rails/view_components> by default. To use a different endpoint, set the `preview_route` option:
@@ -708,7 +708,7 @@ To use component previews:
 
 `config/application.rb`
 ```ruby
-config.view_component.preview_path = "#{Rails.root}/spec/components/previews"
+config.view_component.preview_paths << "#{Rails.root}/spec/components/previews"
 ```
 
 ### Disabling the render monkey patch (Rails < 6.1)

data/lib/view_component/engine.rb

@@ -6,6 +6,7 @@ require "view_component"
 module ViewComponent
   class Engine < Rails::Engine # :nodoc:
     config.view_component = ActiveSupport::OrderedOptions.new
+    config.view_component.preview_paths ||= []
 
     initializer "view_component.set_configs" do |app|
       options = app.config.view_component
@@ -15,7 +16,14 @@ module ViewComponent
       options.preview_route ||= ViewComponent::Base.preview_route
 
       if options.show_previews
-        options.preview_path ||= defined?(Rails.root) ? "#{Rails.root}/test/components/previews" : nil
+        options.preview_paths << "#{Rails.root}/test/components/previews" if defined?(Rails.root)
+
+        if options.preview_path.present?
+          ActiveSupport::Deprecation.warn(
+            "`preview_path` will be removed in v3.0.0. Use `preview_paths` instead."
+          )
+          options.preview_paths << options.preview_path
+        end
       end
 
       ActiveSupport.on_load(:view_component) do

data/lib/view_component/preview.rb

@@ -65,13 +65,13 @@ module ViewComponent # :nodoc:
       private
 
       def load_previews
-        if preview_path
+        Array(preview_paths).each do |preview_path|
           Dir["#{preview_path}/**/*_preview.rb"].sort.each { |file| require_dependency file }
         end
       end
 
-      def preview_path
-        Base.preview_path
+      def preview_paths
+        Base.preview_paths
       end
 
       def show_previews

data/lib/view_component/previewable.rb

@@ -9,8 +9,11 @@ module ViewComponent # :nodoc:
     included do
       # Set the location of component previews through app configuration:
       #
-      #     config.view_component.preview_path = "#{Rails.root}/lib/component_previews"
+      #     config.view_component.preview_paths << "#{Rails.root}/lib/component_previews"
       #
+      mattr_accessor :preview_paths, instance_writer: false
+
+      # TODO: deprecated, remove in v3.0.0
       mattr_accessor :preview_path, instance_writer: false
 
       # Enable or disable component previews through app configuration:

data/lib/view_component/test_helpers.rb

@@ -14,7 +14,7 @@ module ViewComponent
         assert_no_selector("body")
       end
     rescue LoadError
-      warn "WARNING in `ViewComponent::TestHelpers`: You must add `capybara` to your Gemfile to use Capybara assertions."
+      warn "WARNING in `ViewComponent::TestHelpers`: You must add `capybara` to your Gemfile to use Capybara assertions." if ENV["DEBUG"]
     end
 
     attr_reader :rendered_component

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 13
+    MINOR = 14
     PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.13.0
+  version: 2.14.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-02 00:00:00.000000000 Z
+date: 2020-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport