komponent 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83a583b1f8468d26403f19dfdd6113e3dd0f10be
-  data.tar.gz: f2a0d993bdc7349b0b7c1370df7758b618664f09
+  metadata.gz: 2c0aadad91b23804da8724b26704c6bb481f2869
+  data.tar.gz: 5ef9c5fb02bf7f6f7e53c2ea0397f1724dfa6116
 SHA512:
-  metadata.gz: 7d07b311a6fc9fd55ce0bfa06f08991b48498db7361bfa59da47e90b0a49c098378b965049fa5be51f622e000f41b9238b280eb0b0ae7673da37a47999e9d38e
-  data.tar.gz: fe2e28f5cc9ff5f55c591e0d0680c8d8741e3892d68c47c9307f05dde502471c47442831e7c7801767e10abb4d511b87ad9959255bd6c0e277b4ced1af180da4
+  metadata.gz: ade22af3b7e1b13484f8e0d3b35648e6c35bbbd1393d71c399b25648655a05524dd2fc5d36c40beb89177cb9b2634e093ba596f200b9b0664f6cf7571618117a
+  data.tar.gz: 3a8d50d8c461372f1d8f3edde97651cd352213d48fb6d40c26518d3a2041150c7593112e3c07a4b76b0c4329a01eb7aa0d74bcf8daf3b6edde88e557239b40ad

data/.gitignore

@@ -7,3 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+/fixtures/my_app/tmp
+/fixtures/my_app/log

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.2
   DisabledByDefault: true
   Exclude:
     - 'node_modules/**/*'
@@ -33,6 +33,10 @@ Style/MethodCallWithoutArgsParentheses:
 Style/MethodDefParentheses:
   Enabled: true
 
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+
 Naming/ConstantName:
   Enabled: true
 

data/.travis.yml

@@ -1,7 +1,33 @@
-sudo: false
 language: ruby
+sudo: false
+
+before_install:
+  - gem update --system
+
 rvm:
+  - 2.2
+  - 2.3
   - 2.4
+  - 2.5
+  - ruby-head
+
+gemfile:
+  - Gemfile-rails.4.2.x
+  - Gemfile-rails.5.0.x
+  - Gemfile-rails.5.1.x
+  - Gemfile-rails.5.2.x
+
+cache:
+  bundler: true
+  yarn: true
+
+install:
+  - bundle install
+  - nvm install node
+  - node -v
+  - npm i -g yarn
+  - yarn
+
 script:
   - bundle exec rubocop
-  - bundle exec cucumber
+  - bundle exec rake test

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## Upcoming release
 
+## v1.1.4 (2018-03-05)
+
+**Enhancements:**
+
+- Added `frozen_string_literal` option to optimize performance
+- Removed useless `autoload_paths` config definition (it was not taken into account)
+- Install generator can be ran several times in order to enable features
+- Autoloading is now appended to `config/application.rb` when you run `rails g komponent:install`
+- Make all locals passed to `component` helper available through `properties` helper method
+
+## v1.1.3 (2018-02-22)
+
 **Enhancements:**
 - Custom destroy for the component generator: you can now safely run `rails d component button`
 

data/Gemfile

@@ -1,6 +1,17 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in komponent.gemspec
 gemspec
+
+gem "rails"
+gem "rake", ">= 11.1"
+gem "rubocop", require: false
+
+group :test do
+  gem "aruba"
+  gem "cucumber"
+end

data/README.md

@@ -93,7 +93,7 @@ Check [Webpacker documentation](https://github.com/rails/webpacker) for further
 
 ### Passing variables
 
-You can pass `locals` to the helper. They are accessible within the component partial, as instance variables.
+You can pass `locals` to the helper. They are accessible within the component partial, as instance variables. Additionally, the entire `locals` hash is made available through a `properties` helper method.
 
 ```slim
 / app/views/pages/home.html.slim

data/Rakefile

@@ -1,2 +1,25 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
-task :default => :spec
+require "rake/testtask"
+require 'cucumber'
+require 'cucumber/rake/task'
+
+namespace :test do
+  task all: [:unit, :cucumber]
+
+  Rake::TestTask.new(:unit) do |t|
+    t.libs << "test"
+    t.libs << "lib"
+    t.test_files = FileList["test/**/*_test.rb"]
+    t.verbose = true
+  end
+
+  Cucumber::Rake::Task.new(:cucumber) do |t|
+    t.cucumber_opts = "--format pretty"
+  end
+end
+
+task test: 'test:all'
+
+task default: :test

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "komponent"

data/gemfiles/Gemfile-rails.4.2.x

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem "komponent", path: ".."
+
+gem "rails", "~> 4.2"
+gem "rake", ">= 11.1"
+gem "rubocop", require: false
+gem "webpacker"

data/gemfiles/Gemfile-rails.5.0.x

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem "komponent", path: ".."
+
+gem "rails", "~> 5.0"
+gem "rake", ">= 11.1"
+gem "rubocop", require: false
+gem "webpacker"

data/gemfiles/Gemfile-rails.5.1.x

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem "komponent", path: ".."
+
+gem "rails", "~> 5.1"
+gem "rake", ">= 11.1"
+gem "rubocop", require: false
+gem "webpacker"

data/gemfiles/Gemfile-rails.5.2.x

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem "komponent", path: ".."
+
+gem "rails", "~> 5.2"
+gem "rake", ">= 11.1"
+gem "rubocop", require: false
+gem "webpacker"

data/komponent.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "komponent/version"
@@ -20,12 +22,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "aruba"
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "cucumber"
-  spec.add_development_dependency "rails", ">= 5.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rubocop", '~> 0.52.1'
+  spec.required_ruby_version = '>= 2.2.0'
 
-  spec.add_runtime_dependency "webpacker", ">= 3.0.0"
+  spec.add_dependency "activesupport", ">= 4.2"
+  spec.add_dependency "railties", ">= 4.2"
+  spec.add_dependency "webpacker", ">= 3.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
 end

data/lib/generators/component/component_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ComponentGenerator < Rails::Generators::NamedBase
   source_root File.expand_path('../templates', __FILE__)
 
@@ -177,7 +179,7 @@ class ComponentGenerator < Rails::Generators::NamedBase
 
     return if lines.empty?
 
-    lines = lines.sort
+    lines = lines.uniq.sort
 
     File.open(path, "w") do |f|
       lines.each do |line|

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

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

data/lib/generators/komponent/install_generator.rb

@@ -1,15 +1,21 @@
+# frozen_string_literal: true
+
 module Komponent
   module Generators
     class InstallGenerator < Rails::Generators::Base
       class_option :stimulus, type: :boolean, default: false
 
       def check_webpacker_dependency
+        return if komponent_already_installed?
+
         unless File.exist?(webpacker_configuration_file) and File.directory?(webpacker_default_structure)
           raise Thor::Error, dependencies_not_met_error_message
         end
       end
 
       def create_root_directory
+        return if File.directory?(komponent_root_directory)
+
         empty_directory(komponent_root_directory)
       end
 
@@ -18,18 +24,29 @@ module Komponent
       end
 
       def move_webpacker_default_structure
+        return if File.directory?(komponent_root_directory)
+
         run("mv #{webpacker_default_structure}/* #{komponent_root_directory}")
       end
 
       def create_komponent_default_structure
+        return if File.exist?(components_directory.join("index.js"))
+
         empty_directory(components_directory)
         create_file(components_directory.join("index.js"))
       end
 
       def create_stimulus_file
+        return if File.exist?(stimulus_application_path)
+
         create_file(stimulus_application_path, stimulus? ? stimulus_application_template : "")
       end
 
+      def append_to_application_configuration
+        application "config.autoload_paths << config.root.join('#{relative_path_from_rails}/components')"
+        application "config.i18n.load_path += Dir[config.root.join('#{relative_path_from_rails}/components/**/*.yml')]"
+      end
+
       def append_to_application_pack
         append_to_file(application_pack_path, "import 'components';")
       end
@@ -45,11 +62,13 @@ module Komponent
       protected
 
       def stimulus_application_template
-        <<~HEREDOC
-          import { Application } from "stimulus";
-          const application = Application.start();
-          export default application;
-        HEREDOC
+        <<-JAVASCRIPT
+import { Application } from "stimulus";
+
+const application = Application.start();
+
+export default application;
+        JAVASCRIPT
       end
 
       def stimulus_application_path
@@ -76,6 +95,10 @@ module Komponent
         Rails.root.join("app", "javascript")
       end
 
+      def komponent_already_installed?
+        File.directory?(relative_path_from_rails)
+      end
+
       def dependencies_not_met_error_message
         "Seems you don't have webpacker installed in your project. Please install webpacker, and follow instructions at https://github.com/rails/webpacker"
       end

data/lib/komponent.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "komponent/version"
 
 module Komponent

data/lib/komponent/core/component_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ComponentHelper
   def property(name, options = {})
     @properties[name] = options

data/lib/komponent/core/component_path_resolver.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Komponent
   class ComponentPathResolver
     def resolve(component_name)

data/lib/komponent/core/translation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Komponent
   module Translation
     def translate(key, options = {})

data/lib/komponent/komponent_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KomponentHelper
   def component(component, locals = {}, &block)
     component_path = Komponent::ComponentPathResolver.new.resolve(component)
@@ -40,6 +42,8 @@ module KomponentHelper
         instance_variable_set(:"@#{name}", locals[name])
       end
 
+      define_singleton_method(:properties) { locals }
+
       instance_variable_set(:"@block_given_to_component", block)
     end
 

data/lib/komponent/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'webpacker'
 require 'komponent/core/component_helper'
 require 'komponent/core/translation'
@@ -29,14 +31,6 @@ module Komponent
           app.config.komponent.root
         )
       end
-
-      ActiveSupport.on_load :i18n do
-        I18n.load_path.concat(
-          Dir["#{app.config.komponent.root}/components/**/*.yml"]
-        )
-      end
-
-      app.config.autoload_paths += [app.config.komponent.root]
     end
   end
 end

data/lib/komponent/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Komponent
-  VERSION = "1.1.3"
+  VERSION = "1.1.4"
 end

metadata

@@ -1,113 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: komponent
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Ouvrages
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-22 00:00:00.000000000 Z
+date: 2018-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: aruba
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '4.2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '4.2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: webpacker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
+        version: 3.0.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.1
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.1
-- !ruby/object:Gem::Dependency
-  name: webpacker
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '1.15'
 description: An opinionated way of organizing front-end code in Ruby on Rails, based
   on components
 email:
@@ -127,6 +85,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/Gemfile-rails.4.2.x
+- gemfiles/Gemfile-rails.5.0.x
+- gemfiles/Gemfile-rails.5.1.x
+- gemfiles/Gemfile-rails.5.2.x
 - komponent.gemspec
 - lib/generators/component/USAGE
 - lib/generators/component/component_generator.rb
@@ -164,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="