view_component-contrib 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1df61bb2350983380af49ecddc12cb3e6e5f90b5b05bdc66466a40064c435508
-  data.tar.gz: 7b03a2c077b2c54cd16deb8720c3d878aa1a0a2d7e1240566aaa4c42fe4e616d
+  metadata.gz: 1f439e065cd49e9a08753fbcdfda2fbccc3b96f2a72f5d0ccb6896cd3da7b74e
+  data.tar.gz: 211ea998a9033327fdf57cc6094dcea1a269bb9022f539b2f182aece95fd6eb1
 SHA512:
-  metadata.gz: 7ad12d739fad8a74bed8d299212ad41667021cd535f98bbd2a86055808a0f321b8a5919f11ca214f5bb4fc6cbff8199f19a1026d147eea92f2173986aaebcaaa
-  data.tar.gz: 01724fd258b05e894635ca0a438e45a0369160dc74645f7cd675eeae8eba0157f09f56e000951b0b2b7d3829582ff27950e8219f017a14b1f14252fbfdaadf39
+  metadata.gz: 8bfa8779d3a7cc39519f92e9d020c325bf0f4f6d8e845dc3de21d1aef129959ebad4a68249b2229d3e49edf19096c73107fff6ffbccee43b8408db217fedf91e
+  data.tar.gz: 3add0d31953c16acc07a58637be8f6d5acd4dc7505a7466a635924c5afdddd23b0f6ffbded2e03e3c4195df45c04ba54f0822e58d72413b0aacd4a998469511e

data/CHANGELOG.md

@@ -2,8 +2,26 @@
 
 ## master
 
+## 0.1.2 (2023-01-13)
+
+- Fix compatibility with sidecar translations. ([@palkan][])
+
+- Detect Webpack when using Rails 7 + jsbundling-rails. ([@unikitty37][])
+
+- Skip autoloading of Preview files when viewing previews is disabled. ([@dhnaranjo][])
+
+- Automatic publish to RailsBytes in CI. ([@fargelus][])
+
+## 0.1.1 (2022-03-14)
+
+- Fix adding gem's previews to the app's path. ([@palkan][])
+
+- Fix configurable default template.
+
 ## 0.1.0 (2021-04-07)
 
 - Initial release.
 
 [@palkan]: https://github.com/palkan
+[@fargelus]: https://github.com/fargelus
+[@dhnaranjo]: https://github.com/dhnaranjo

data/README.md

@@ -98,12 +98,25 @@ We provide a `ViewComponentContrib::Preview` class, which helps to reduce the bo
 
 The default template shipped with the gem is as follows:
 
-```html
+```erb
 <div class="<%= container_class %>">
-  <%= render component %>
+  <%- if component -%>
+    <%= render component %>
+  <%- else -%>
+    Failed to infer a component from the preview: <%= error %>
+  <%- end -%>
 </div>
 ```
 
+To define your own default template:
+```ruby
+class ApplicationViewComponentPreview < ViewComponentContrib::Preview::Base
+  # ...
+  self.default_preview_template = "path/to/your/template.html.{erb,haml,slim}"
+  # ...
+end
+```
+
 Let's assume that you have the following `ApplicationViewComponentPreview`:
 
 ```ruby
@@ -154,9 +167,7 @@ class Banner::Preview < ApplicationViewComponentPreview
 end
 ```
 
-If you need more control over your template, you can add a custom `preview.html.erb` file.
-**NOTE:** We assume that all examples uses the same `preview.html`. If it's not the case,
-you can use the original `#render_with_template` method.
+If you need more control over your template, you can add a custom `preview.html.*` template (which will be used for all examples in this preview), or even create an example-specific `previews/example.html.*` (e.g. `previews/mobile.html.erb`).
 
 ## Organizing assets (JS, CSS)
 
@@ -228,7 +239,7 @@ context.keys().forEach((path) => {
   //   nav/user_info/index.js -> nav--user-info
   const identifier = path.replace(/^\.\//, '')
     .replace(/\/index\.js$/, '')
-    .replace(/\//, '--');
+    .replace(/\//g, '--');
 
   application.register(identifier, mod.Controller);
 });

data/app/templates/install/index.stimulus.js

@@ -14,7 +14,7 @@ context.keys().forEach((path) => {
   //   nav/user_info/index.js -> nav--user-info
   const identifier = path.replace(/^\\.\\//, '')
     .replace(/\\/index\\.js$/, '')
-    .replace(/\\//, '--');
+    .replace(/\\//g, '--');
 
   application.register(identifier, mod.Controller);
 });

data/app/templates/install/postcss-modules.js

@@ -4,7 +4,7 @@
       if (!matches) return name;
 
       // identifier here is the same identifier we used for Stimulus controller (see above)
-      const identifier = matches[1].replace("/", "--");
+      const identifier = matches[1].replace(/\\//g, "--");
 
       // We also add the `c-` prefix to all components classes
       return `c-${identifier}-${name}`;

data/app/templates/install/template.rb

@@ -3,7 +3,7 @@ say "👋 Welcome to interactive ViewComponent installer and configurator. " \
 
 run "bundle add view_component view_component-contrib --skip-install"
 
-inject_into_file "config/application.rb", "require \"view_component/engine\"\n", before: "\nBundler.require(*Rails.groups)"
+inject_into_file "config/application.rb", "\nrequire \"view_component/engine\"\n", before: "\nBundler.require(*Rails.groups)"
 
 say_status :info, "✅ ViewComponent gems added"
 
@@ -65,7 +65,7 @@ end
 
 say_status :info, "✅ RSpec configured"
 
-USE_WEBPACK = File.directory?("config/webpack")
+USE_WEBPACK = File.directory?("config/webpack") || File.file?("webpack.config.js")
 
 if USE_WEBPACK
   USE_STIMULUS = yes? "Do you use StimulusJS?"
@@ -85,6 +85,8 @@ if USE_WEBPACK
   say_status :info, "✅ Added index.js to load components JS/CSS"
   say "⚠️   Don't forget to import component JS/CSS (#{ROOT_PATH}/index.js) from your application.js entrypoint"
 
+  say "⚠️   Don't forget to add #{ROOT_PATH} to `additional_paths` in your `webpacker.yml` (unless your `source_path` already includes it)"
+
   USE_POSTCSS_MODULES = yes? "Would you like to use postcss-modules to isolate component styles?"
 
   if USE_POSTCSS_MODULES
@@ -122,6 +124,8 @@ if USE_WEBPACK
 
     say_status :info, "✅ postcss-modules configured"
   end
+else
+  say "⚠️  See the discussion on how to configure non-Wepback JS/CSS installations: https://github.com/palkan/view_component-contrib/discussions/14"
 end
 
 <%= embed("./generator.rb") %>

data/lib/view_component_contrib/preview/abstract.rb

@@ -14,7 +14,8 @@ module ViewComponentContrib
         alias_method :abstract_class?, :abstract_class
 
         def all
-          super.reject(&:abstract_class?)
+          load_previews if descendants.reject(&:abstract_class?).empty?
+          descendants.reject(&:abstract_class?)
         end
       end
     end

data/lib/view_component_contrib/preview/default_template.rb

@@ -23,20 +23,24 @@ module ViewComponentContrib
             end
         end
 
-        def preview_example_template_path(...)
+        def preview_example_template_path(example)
           super
         rescue ViewComponent::PreviewTemplateError
-          has_preview_template = preview_paths.find do |path|
+          has_example_preview = preview_paths.find do |path|
+            Dir.glob(File.join(path, preview_name, "previews", "#{example}.html.*")).any?
+          end
+
+          return File.join(preview_name, "previews", example) if has_example_preview
+
+          has_root_preview = preview_paths.find do |path|
             Dir.glob(File.join(path, preview_name, "preview.html.*")).any?
           end
 
-          has_preview_template ? File.join(preview_name, "preview") : DEFAULT_TEMPLATE
+          return File.join(preview_name, "preview") if has_root_preview
+
+          default_preview_template
         end
       end
     end
   end
 end
-
-ActiveSupport.on_load(:view_component) do
-  ViewComponent::Base.preview_paths << File.join(ViewComponentContrib::APP_PATH, "views")
-end

data/lib/view_component_contrib/railtie.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ViewComponentContrib
+  class Railtie < Rails::Railtie
+    config.view_component.preview_paths << File.join(ViewComponentContrib::APP_PATH, "views")
+
+    initializer "view_component-contrib.skip_loading_previews_if_disabled" do
+      unless Rails.application.config.view_component.show_previews
+        previews = Rails.application.config.view_component.preview_paths.flat_map do |path|
+          Pathname(path).glob("**/*preview.rb")
+        end
+        Rails.autoloaders.each { |autoloader| autoloader.ignore(previews) }
+      end
+    end
+  end
+end

data/lib/view_component_contrib/translation_helper.rb

@@ -22,22 +22,22 @@ module ViewComponentContrib
           end
       end
 
-      def i18n_scope
-        return @i18n_scope if defined?(@i18n_scope)
+      def contrib_i18n_scope
+        return @contrib_i18n_scope if defined?(@contrib_i18n_scope)
 
-        @i18n_scope = name.sub("::Component", "").underscore.split("/")
+        @contrib_i18n_scope = name.sub("::Component", "").underscore.split("/")
       end
 
       def i18n_scope=(val)
         raise ArgumentError, "Must be array" unless val.is_a?(Array)
 
-        @i18n_scope = val.dup.freeze
+        @contrib_i18n_scope = val.dup.freeze
       end
 
       def virtual_path
         @contrib_virtual_path ||= [
           i18n_namespace,
-          *i18n_scope
+          *contrib_i18n_scope
         ].join(".")
       end
     end

data/lib/view_component_contrib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ViewComponentContrib # :nodoc:all
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/view_component_contrib.rb

@@ -3,6 +3,8 @@
 require "ruby-next/language/setup"
 RubyNext::Language.setup_gem_load_path
 
+require "view_component"
+
 module ViewComponentContrib
   APP_PATH = File.expand_path(File.join(__dir__, "../app"))
 
@@ -14,4 +16,5 @@ module ViewComponentContrib
   autoload :Preview, "view_component_contrib/preview"
 end
 
+require "view_component_contrib/railtie" if defined?(::Rails::Railtie)
 require "view_component_contrib/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component-contrib
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Vladimir Dementyev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-07 00:00:00.000000000 Z
+date: 2023-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: view_component
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ruby-next-core
+  name: ruby-next
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -166,6 +166,7 @@ files:
 - lib/view_component_contrib/preview/base.rb
 - lib/view_component_contrib/preview/default_template.rb
 - lib/view_component_contrib/preview/sidecarable.rb
+- lib/view_component_contrib/railtie.rb
 - lib/view_component_contrib/translation_helper.rb
 - lib/view_component_contrib/version.rb
 - lib/view_component_contrib/wrapped_helper.rb
@@ -179,7 +180,7 @@ metadata:
   documentation_uri: http://github.com/palkan/view_component-contrib
   homepage_uri: http://github.com/palkan/view_component-contrib
   source_code_uri: http://github.com/palkan/view_component-contrib
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -187,15 +188,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.3.11
+signing_key:
 specification_version: 4
 summary: A collection of extensions and developer tools for ViewComponent
 test_files: []