komponent 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4023592e98d1c3fd22dee1153f0782e18c0e3008
-  data.tar.gz: f5c82a9ac16d366cddcc1c22c8517604b7f6deda
+  metadata.gz: f58c3da5a2b11f34695dcf60c3d2e4d943f0bb97
+  data.tar.gz: fc3d219e942b0649b983d2b943b254c151bbb43f
 SHA512:
-  metadata.gz: 167a8d4d1bb14e3ed1521dd5512b1496a527dbd77b8ef3b3f7d02fdf447e6428623bf3055330b840f6c55bcca615ced56e7beec6b3087da73496d268ef950ef7
-  data.tar.gz: faec5c09267be7d1fa4552672ae062c7a67e029dc972937640c53416e91dfb8f5313e631cd4ca3fa0557337f1af5a39ba22d9662895fd25da07f6d5531c2b913
+  metadata.gz: 12825b03452c3b914efe7ff4b0c9e3ac76fbb21b79da3f83ef03fdd48dbbd4bf737b1bc7e73e8f2af5be002f19330031999a0b407dfa6be3478868d8c063f01b
+  data.tar.gz: 25f321f222d8cd35224060365069d151e8535cf8910b86e942e778440bb15546be7d812539fdb3fb42d6c8106ca863d5bd6eaa9c87e979dfabff9e657dafa186

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Upcoming release
 
+**Enhancements:**
+- Support for Stimulus 1.0
+- `import`s are now sorted alphabetically every time you run the component generator
+- Added the `block_given_to_component?` helper to components
+
 ## v1.1.1 (2018-01-20)
 
 **Enhancements:**

data/README.md

@@ -30,6 +30,7 @@ This gem has been inspired by our Rails development practices at [Ouvrages](http
   - [Configuration](#configuration)
     - [Change default root path](#change-default-root-path)
     - [Default options for the generators](#default-options-for-the-generators)
+    - [Force default templating engine](#force-default-templating-engine)
     - [Additional paths](#additional-paths)
 - [Contributing](#contributing)
 - [License](#license)
@@ -124,6 +125,8 @@ The component also accepts a `block`. To render the block, just use the standard
   = yield
 ```
 
+You can check if the component has been called with a block using the `block_given_to_component?` helper from within the component.
+
 ### Properties
 
 Each component comes with a Ruby `module`. You can use it to set properties:
@@ -206,7 +209,9 @@ This will create the component in an `admin` folder, and name its Ruby module `A
 
 ### Stimulus integration
 
-You can pass `--stimulus` to both generators to use [stimulus](https://github.com/stimulusjs/stimulus) in your components.
+Komponent supports [stimulus](https://github.com/stimulusjs/stimulus) 1.0.
+
+You can pass `--stimulus` to both generators to use Stimulus in your components.
 
 ```sh
 rails generate komponent:install --stimulus
@@ -274,6 +279,14 @@ You can change the default root path (`frontend`) to another path where Komponen
 Rails.application.config.komponent.root = Rails.root.join("app/frontend")
 ```
 
+#### Force default templating engine
+
+If for some reason your preferred templating engine is not detected by Komponent, you can force it by manually defining it in your config:
+
+```rb
+Rails.application.config.generators.template_engine = :haml
+```
+
 #### Additional paths
 
 You may want to use components in a gem, or a Rails engine, and expose them to the main app. In order to do that, you just have to configure the paths where Komponent will look for components.
@@ -297,7 +310,7 @@ module MyGem
       app.config.autoload_paths << MyGem.root.join("frontend")
     end
   end
-  
+
   private
 
   def self.root

data/lib/generators/component/component_generator.rb

@@ -52,14 +52,16 @@ class ComponentGenerator < Rails::Generators::NamedBase
       import = imports.shift
       if import
         append_to_file(root_path_dup + "index.js") do
-          "import \"#{import}\";\n"
+          "\nimport \"#{import}\";\n"
         end
+        sort_lines_alphabetically!(root_path_dup + "index.js")
       end
     end
 
     append_to_file(base_path + "index.js") do
-      "import \"#{base_path.relative_path_from(root_path)}/#{component_name}/#{name_with_namespace.underscore}\";\n"
+      "\nimport \"#{base_path.relative_path_from(root_path)}/#{component_name}/#{name_with_namespace.underscore}\";\n"
     end
+    sort_lines_alphabetically!(base_path + "index.js")
   end
 
   protected
@@ -136,4 +138,20 @@ class ComponentGenerator < Rails::Generators::NamedBase
   def app_generators
     rails_configuration.app_generators
   end
+
+  def sort_lines_alphabetically!(path)
+    lines = File.readlines(path).map do |line|
+      line if line =~ /^import "(.*)";$/
+    end.compact
+
+    return if lines.empty?
+
+    lines = lines.sort
+
+    File.open(path, "w") do |f|
+      lines.each do |line|
+        f.write(line)
+      end
+    end
+  end
 end

data/lib/generators/component/templates/js.erb

@@ -1,11 +1,8 @@
-<%- if stimulus? -%>
-import application from 'stimulus_application';
-import { autoload } from "stimulus/webpack-helpers";
-
 import "./<%= name_with_namespace %>.<%= stylesheet_engine %>";
+<%- if stimulus? -%>
+import application from "stimulus_application";
+import { definitionsFromContext } from "stimulus/webpack-helpers";
 
 const context = require.context('./', true, /_controller\.js$/);
-autoload(context, application);
-<%- else -%>
-import "./<%= name_with_namespace %>.<%= stylesheet_engine %>";
+application.load(definitionsFromContext(context));
 <%- end -%>

data/lib/generators/component/templates/stimulus_controller_js.erb

@@ -1,9 +1,7 @@
 import { Controller } from "stimulus";
-import "./<%= name_with_namespace %>.<%= stylesheet_engine %>";
 
 export default class extends Controller {
   connect() {
     console.log("Hello, Stimulus!", this.element);
   }
 }
-

data/lib/komponent/core/component_helper.rb

@@ -7,5 +7,10 @@ module ComponentHelper
 
   def self.extended(component)
     component.properties = {}
+    component.class_eval do
+      def block_given_to_component?
+        @block_given_to_component.present?
+      end
+    end
   end
 end

data/lib/komponent/komponent_helper.rb

@@ -39,18 +39,15 @@ module KomponentHelper
       locals.each do |name, value|
         instance_variable_set(:"@#{name}", locals[name] || options[:default])
       end
+
+      instance_variable_set(:"@block_given_to_component", block)
     end
 
-    custom_method = :"render_#{component_name}"
-    if context.respond_to?(custom_method)
-      context.public_send(custom_method, locals, &capture_block)
-    else
-      begin
-        context.render("components/#{component}/#{parts.join('_')}", &capture_block)
-      rescue ActionView::MissingTemplate
-        warn "[DEPRECATION WARNING] `#{parts.last}` filename in namespace is deprecated in favor of `#{parts.join('_')}`."
-        context.render("components/#{component}/#{parts.last}", &capture_block)
-      end
+    begin
+      context.render("components/#{component}/#{parts.join('_')}", &capture_block)
+    rescue ActionView::MissingTemplate
+      warn "[DEPRECATION WARNING] `#{parts.last}` filename in namespace is deprecated in favor of `#{parts.join('_')}`."
+      context.render("components/#{component}/#{parts.last}", &capture_block)
     end
   end
   alias :c :component

data/lib/komponent/version.rb

@@ -1,3 +1,3 @@
 module Komponent
-  VERSION = "1.1.1"
+  VERSION = "1.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: komponent
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Ouvrages
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-20 00:00:00.000000000 Z
+date: 2018-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba