komponent 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4658a034e4427f5870e308f64d0699e9b588b198
-  data.tar.gz: ef78a5b00c52b95676b15741765c8d221d12c697
+  metadata.gz: 4023592e98d1c3fd22dee1153f0782e18c0e3008
+  data.tar.gz: f5c82a9ac16d366cddcc1c22c8517604b7f6deda
 SHA512:
-  metadata.gz: e362c8e4e277a68bfbf469c27c15f47a2544925710c16901b94eaf4b3d56a7359237f2b747a9b157ec68cc256476d11212456a37bc89e151b2d6aa6b8c823e2d
-  data.tar.gz: d8d8e23f3b219769d250cb58c46428bcc6344bbc68c18b300b39ef3d75d7d2ad8935ae44920da98d0a756dfd4efa08073d45f6e79222d492ff799454b027b5d2
+  metadata.gz: 167a8d4d1bb14e3ed1521dd5512b1496a527dbd77b8ef3b3f7d02fdf447e6428623bf3055330b840f6c55bcca615ced56e7beec6b3087da73496d268ef950ef7
+  data.tar.gz: faec5c09267be7d1fa4552672ae062c7a67e029dc972937640c53416e91dfb8f5313e631cd4ca3fa0557337f1af5a39ba22d9662895fd25da07f6d5531c2b913

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Upcoming release
 
+## v1.1.1 (2018-01-20)
+
+**Enhancements:**
+- Add an option to change default root path where Komponent is installed, and components are generated
+
 ## v1.1.0 (2018-01-12)
 
 **Enhancements:**

data/README.md

@@ -28,6 +28,7 @@ This gem has been inspired by our Rails development practices at [Ouvrages](http
   - [Stimulus integration](#stimulus-integration)
   - [Internationalization](#internationalization)
   - [Configuration](#configuration)
+    - [Change default root path](#change-default-root-path)
     - [Default options for the generators](#default-options-for-the-generators)
     - [Additional paths](#additional-paths)
 - [Contributing](#contributing)
@@ -71,6 +72,23 @@ Then, render it in your views with the `component` helper (or its alias `c`).
 = c "button"
 ```
 
+Make sure to include javascript pack tag and stylesheet pack tag in your application layout file, for instance:
+
+```slim
+/ app/views/layouts/application.html.slim
+
+doctype html
+html
+  head
+    = stylesheet_pack_tag "application"
+
+  body
+    = yield
+    = javascript_pack_tag "application"
+```
+
+Check [Webpacker documentation](https://github.com/rails/webpacker) for further information.
+
 ### Passing variables
 
 You can pass `locals` to the helper. They are accessible within the component partial, as instance variables.
@@ -214,20 +232,23 @@ This will create a `yml` file for each locale (using `I18n.available_locales`).
 
 ```slim
 / frontend/components/button/_button.html.slim
+
 = a.button(href=@href)
   = @text
   = render("suffix", text: t(".external_link")) if external_link?
 ```
 
 ```yml
-/ frontend/components/button/button.en.yml
+# frontend/components/button/button.en.yml
+
 en:
   button_component:
     external_link: "external link"
 ```
 
 ```yml
-/ frontend/components/button/button.fr.yml
+# frontend/components/button/button.fr.yml
+
 fr:
   button_component:
     external_link: "lien externe"
@@ -245,6 +266,14 @@ config.generators do |g|
 end
 ```
 
+#### Change default root path
+
+You can change the default root path (`frontend`) to another path where Komponent should be installed and components generated. You need to change `komponent.root` in an initializer.
+
+```rb
+Rails.application.config.komponent.root = Rails.root.join("app/frontend")
+```
+
 #### 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.
@@ -255,24 +284,24 @@ From a gem:
 module MyGem
   class Railtie < Rails::Railtie
     config.after_initialize do |app|
-      app.config.komponent.component_paths.append(self.root.join("frontend/components"))
+      app.config.komponent.component_paths.append(MyGem.root.join("frontend/components"))
     end
 
     initializer "my_gem.action_dispatch" do |app|
       ActiveSupport.on_load :action_controller do
-        ActionController::Base.prepend_view_path self.root.join("frontend")
+        ActionController::Base.prepend_view_path MyGem.root.join("frontend")
       end
     end
 
     initializer 'my_gem.autoload', before: :set_autoload_paths do |app|
-      app.config.autoload_paths << self.root.join("frontend")
+      app.config.autoload_paths << MyGem.root.join("frontend")
     end
+  end
+  
+  private
 
-    private
-
-    def self.root
-      Pathname.new(File.dirname(__dir__))
-    end
+  def self.root
+    Pathname.new(File.dirname(__dir__))
   end
 end
 ```

data/lib/generators/component/component_generator.rb

@@ -33,7 +33,7 @@ class ComponentGenerator < Rails::Generators::NamedBase
   end
 
   def import_to_packs
-    root_path = Pathname.new("frontend")
+    root_path = default_path
     base_path = root_path + "components"
 
     imports = []
@@ -77,7 +77,7 @@ class ComponentGenerator < Rails::Generators::NamedBase
   end
 
   def component_path
-    path_parts = ["frontend", "components", *split_name]
+    path_parts = [default_path, "components", *split_name]
 
     Pathname.new(path_parts.join("/"))
   end
@@ -106,6 +106,10 @@ class ComponentGenerator < Rails::Generators::NamedBase
     end
   end
 
+  def default_path
+    rails_configuration.komponent.root
+  end
+
   def locale?
     return options[:locale] if options[:locale]
     komponent_configuration[:locale]
@@ -119,7 +123,10 @@ class ComponentGenerator < Rails::Generators::NamedBase
   private
 
   def komponent_configuration
-    { stimulus: nil, locale: nil }.merge app_generators.komponent
+    {
+      stimulus: nil,
+      locale: nil,
+    }.merge(app_generators.komponent)
   end
 
   def rails_configuration

data/lib/generators/component/templates/stimulus_view.html.slim.erb

@@ -1,6 +1,6 @@
-div data-controller="<%= component_class_name %>" class="<%= component_class_name %>"
+.<%= component_class_name %>(data-controller="<%= component_class_name %>")
   <%- if locale? -%>
   = t ".component_name"
   <%- else -%>
-  <%= module_name.underscore %>
+  | <%= module_name.underscore %>
   <%- end -%>

data/lib/generators/component/templates/view.html.slim.erb

@@ -1,6 +1,6 @@
-div class="<%= component_class_name %>"
+.<%= component_class_name %>
   <%- if locale? -%>
   = t "<%= module_name.underscore %>.component_name"
   <%- else -%>
-  <%= module_name.underscore %>
+  | <%= module_name.underscore %>
   <%- end -%>

data/lib/generators/komponent/install_generator.rb

@@ -14,7 +14,7 @@ module Komponent
       end
 
       def modify_webpacker_configuration
-        gsub_file(webpacker_configuration_file, /source_path: app\/javascript$/, "source_path: frontend")
+        gsub_file(webpacker_configuration_file, /source_path: app\/javascript$/, "source_path: #{relative_path_from_rails}")
       end
 
       def move_webpacker_default_structure
@@ -27,12 +27,7 @@ module Komponent
       end
 
       def create_stimulus_file
-        template = <<-eos
-import { Application } from "stimulus";
-const application = Application.start();
-export default application;
-        eos
-        create_file(stimulus_application_path, stimulus? ? template : "")
+        create_file(stimulus_application_path, stimulus? ? stimulus_application_template : "")
       end
 
       def append_to_application_pack
@@ -47,7 +42,15 @@ export default application;
         end
       end
 
-      private
+      protected
+
+      def stimulus_application_template
+        <<~HEREDOC
+          import { Application } from "stimulus";
+          const application = Application.start();
+          export default application;
+        HEREDOC
+      end
 
       def stimulus_application_path
         komponent_root_directory.join("stimulus_application.js")
@@ -58,7 +61,7 @@ export default application;
       end
 
       def komponent_root_directory
-        Rails.root.join("frontend")
+        default_path
       end
 
       def components_directory
@@ -82,10 +85,21 @@ export default application;
         komponent_configuration[:stimulus]
       end
 
+      def default_path
+        rails_configuration.komponent.root
+      end
+
+      def relative_path_from_rails
+        default_path.relative_path_from(Rails.root)
+      end
+
       private
 
       def komponent_configuration
-        { stimulus: nil, locale: nil }.merge app_generators.komponent
+        {
+          stimulus: nil,
+          locale: nil,
+        }.merge(app_generators.komponent)
       end
 
       def rails_configuration

data/lib/komponent/railtie.rb

@@ -6,34 +6,37 @@ require 'komponent/core/component_path_resolver'
 module Komponent
   class Railtie < Rails::Railtie
     config.komponent = ActiveSupport::OrderedOptions.new
+    config.komponent.root = nil
     config.komponent.component_paths = []
 
     config.before_configuration do |app|
+      app.config.komponent.root = app.config.root.join("frontend")
       app.config.komponent = config.komponent
-      app.config.komponent.component_paths.append(app.config.root.join("frontend/components"))
     end
 
-    initializer "komponent.action_view" do |app|
+    config.after_initialize do |app|
+      app.config.komponent.component_paths.prepend(
+        app.config.komponent.root.join("components")
+      )
+
       ActiveSupport.on_load :action_view do
         require 'komponent/komponent_helper'
         include KomponentHelper
       end
-    end
 
-    initializer "komponent.action_dispatch" do |app|
       ActiveSupport.on_load :action_controller do
-        ActionController::Base.prepend_view_path "#{app.config.root}/frontend"
+        ActionController::Base.prepend_view_path(
+          app.config.komponent.root
+        )
       end
-    end
 
-    initializer "komponent.i18n" do |app|
       ActiveSupport.on_load :i18n do
-        I18n.load_path.concat(Dir["#{app.config.root}/frontend/components/**/*.yml"])
+        I18n.load_path.concat(
+          Dir["#{app.config.komponent.root}/components/**/*.yml"]
+        )
       end
-    end
 
-    initializer 'komponent.autoload', before: :set_autoload_paths do |app|
-      app.config.autoload_paths << "#{app.config.root}/frontend"
+      app.config.autoload_paths += [app.config.komponent.root]
     end
   end
 end

data/lib/komponent/version.rb

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

metadata

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