view_component-contrib 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1df61bb2350983380af49ecddc12cb3e6e5f90b5b05bdc66466a40064c435508
-  data.tar.gz: 7b03a2c077b2c54cd16deb8720c3d878aa1a0a2d7e1240566aaa4c42fe4e616d
+  metadata.gz: 837ad4bbcf45a025383e628eb59f57b1aa9463468045d843eabd061cb3134f2c
+  data.tar.gz: c8e9169d866f92ba5c5a67a1214c2909dd6704f340eb8b3f1404ca8efb478bc3
 SHA512:
-  metadata.gz: 7ad12d739fad8a74bed8d299212ad41667021cd535f98bbd2a86055808a0f321b8a5919f11ca214f5bb4fc6cbff8199f19a1026d147eea92f2173986aaebcaaa
-  data.tar.gz: 01724fd258b05e894635ca0a438e45a0369160dc74645f7cd675eeae8eba0157f09f56e000951b0b2b7d3829582ff27950e8219f017a14b1f14252fbfdaadf39
+  metadata.gz: d418a0bd1a8cf862f88dd9f4b9bb8d51252e6d5705fb3240fce51d5e014be0c37f06196d8c281845f256d8773d8f558bcd761ffda550b72a7f3bcdb9eeef04c7
+  data.tar.gz: 5094714a83ed34e41b2fd2631db68c1ef09d03ffcdb10d2620acac0265771233402f262452bf14932a18587d8877a694b631259d0835a9c2afc8766e3f77cf8b

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## master
 
+## 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.

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
@@ -228,7 +241,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

@@ -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

@@ -30,13 +30,9 @@ module ViewComponentContrib
             Dir.glob(File.join(path, preview_name, "preview.html.*")).any?
           end
 
-          has_preview_template ? File.join(preview_name, "preview") : DEFAULT_TEMPLATE
+          has_preview_template ? File.join(preview_name, "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,7 @@
+# frozen_string_literal: true
+
+module ViewComponentContrib
+  class Railtie < Rails::Railtie
+    config.view_component.preview_paths << File.join(ViewComponentContrib::APP_PATH, "views")
+  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.1"
 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.1
 platform: ruby
 authors:
 - Vladimir Dementyev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-07 00:00:00.000000000 Z
+date: 2022-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: view_component
@@ -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.2.22
+signing_key:
 specification_version: 4
 summary: A collection of extensions and developer tools for ViewComponent
 test_files: []