komponent 1.1.4 → 2.0.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c0aadad91b23804da8724b26704c6bb481f2869
-  data.tar.gz: 5ef9c5fb02bf7f6f7e53c2ea0397f1724dfa6116
+  metadata.gz: 6f4a2e93f4dd2d59cfe137824c4cf0befd7a827d
+  data.tar.gz: 531498a2ea3eb8063057a840ad29d4d6d3ec2b28
 SHA512:
-  metadata.gz: ade22af3b7e1b13484f8e0d3b35648e6c35bbbd1393d71c399b25648655a05524dd2fc5d36c40beb89177cb9b2634e093ba596f200b9b0664f6cf7571618117a
-  data.tar.gz: 3a8d50d8c461372f1d8f3edde97651cd352213d48fb6d40c26518d3a2041150c7593112e3c07a4b76b0c4329a01eb7aa0d74bcf8daf3b6edde88e557239b40ad
+  metadata.gz: ba27094468525618389dba4e707a19f8bd488e0dcdf74ad3ddf17e5a88e61f18ef6556d644a76251aad595232f25eae7d08bf563433c7656dc190a0fa7a95c00
+  data.tar.gz: ea2a13b0eebb2885baa9d43a3e3763dce0d36baef252408645005b142893e310ae01c3632f83f520c42b359080b03cd4df961ab5ca63cbb232363a5b70ab9e74

data/.rubocop.yml

@@ -52,29 +52,29 @@ Naming/PredicateName:
 Naming/VariableName:
   Enabled: true
 
-Lint/BlockAlignment:
+Lint/DeprecatedClassMethods:
   Enabled: true
-  EnforcedStyleAlignWith: start_of_block
 
-Lint/ConditionPosition:
+Layout/AlignParameters:
   Enabled: true
 
-Lint/DefEndAlignment:
+Layout/BlockAlignment:
   Enabled: true
+  EnforcedStyleAlignWith: start_of_block
 
-Lint/DeprecatedClassMethods:
+Layout/BlockEndNewline:
   Enabled: true
 
-Layout/AlignParameters:
+Layout/CaseIndentation:
   Enabled: true
 
-Layout/BlockEndNewline:
+Layout/ClosingParenthesisIndentation:
   Enabled: true
 
-Layout/CaseIndentation:
+Layout/ConditionPosition:
   Enabled: true
 
-Layout/ClosingParenthesisIndentation:
+Layout/DefEndAlignment:
   Enabled: true
 
 Layout/DotPosition:

data/.simplecov

@@ -0,0 +1,7 @@
+SimpleCov.minimum_coverage 90
+
+SimpleCov.start do
+  add_filter "/fixtures/"
+  add_filter "/test/"
+  add_filter "/features/"
+end

data/.travis.yml

@@ -29,5 +29,4 @@ install:
   - yarn
 
 script:
-  - bundle exec rubocop
-  - bundle exec rake test
+  - bundle exec rake test:all_with_coverage

data/CHANGELOG.md

@@ -2,10 +2,21 @@
 
 ## Upcoming release
 
-## v1.1.4 (2018-03-05)
+## v2.0.0.pre.1 (2018-04-12)
+
+**Breaking changes:**
+- Removed deprecated `render_partial` method
+- Removed rendering of namespaced component with the old naming convention
 
 **Enhancements:**
+- Changed `@block_given_to_component` from an instance variable to a method `block_given_to_component` available in the view context
+- Implemented component caching with the `cached: true` option
+- Added a `stylesheet_engine` option to Komponent configuration
+- When generating a new component, the `frozen_string_literal: true` magic comment is prepended to Ruby files
 
+## 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

data/Gemfile

@@ -14,4 +14,6 @@ gem "rubocop", require: false
 group :test do
   gem "aruba"
   gem "cucumber"
+  gem "simplecov", require: false
+  gem "coveralls", require: false
 end

data/README.md

@@ -1,6 +1,8 @@
 # <img alt="Komponent" src="https://raw.github.com/ouvrages/komponent/master/logo.svg?sanitize=true" width="200" height="40" />
 [![Build Status](https://travis-ci.org/komposable/komponent.svg?branch=master)](https://travis-ci.org/komposable/komponent)
 [![Gem](https://img.shields.io/gem/v/komponent.svg)](https://github.com/komposable/komponent)
+[![Dependency Status](https://beta.gemnasium.com/badges/github.com/komposable/komponent.svg)](https://beta.gemnasium.com/projects/github.com/komposable/komponent)
+[![Coverage Status](https://coveralls.io/repos/github/komposable/komponent/badge.svg?branch=master)](https://coveralls.io/github/komposable/komponent?branch=master)
 
 **Komponent** implements an opinionated way of organizing front-end code in Ruby on Rails, based on _components_.
 
@@ -17,9 +19,12 @@ This gem has been inspired by our Rails development practices at [Ouvrages](http
 
 ## Table of contents
 
+- [Compatibility](#compatibility)
 - [Getting started](#getting-started)
 - [Usage](#usage)
   - [Passing variables](#passing-variables)
+  - [Passing options](#passing-options)
+    - [Component caching](#component-caching)
   - [Passing a block](#passing-a-block)
   - [Properties](#properties)
   - [Helpers](#helpers)
@@ -31,11 +36,18 @@ 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)
+    - [Change default stylesheet engine](#change-default-stylesheet-engine)
     - [Force default templating engine](#force-default-templating-engine)
     - [Additional paths](#additional-paths)
 - [Contributing](#contributing)
 - [License](#license)
 
+## Compatibility
+
+- Ruby 2.2+
+- Rails 4.2+
+- Webpacker 3.0.0+
+
 ## Getting started
 
 ```ruby
@@ -108,6 +120,25 @@ You can pass `locals` to the helper. They are accessible within the component pa
   = @text
 ```
 
+### Passing options
+
+#### Component caching
+
+Komponent relies on [Rails Low-level caching](http://guides.rubyonrails.org/caching_with_rails.html#low-level-caching).
+
+You can cache the component by passing the `cached: true` option. The cache will expire when the locals, options or block change.
+If you want better control of the cache expiration, you can provide a custom `cache_key`. When the `cache_key` changes, the cache will be cleared.
+
+```slim
+/ app/views/pages/home.html.slim
+
+/ Cache the component based on its locals
+= component "button", { text: "Click here" }, cached: true
+
+/ or cache the component with a specific key, such as the last update of a model
+= component "button", { text: "Click here" }, cached: true, cache_key: @product.updated_at
+```
+
 ### Passing a block
 
 The component also accepts a `block`. To render the block, just use the standard `yield`.
@@ -186,9 +217,10 @@ You can also choose to split your component into partials. In this case, we can
 ```slim
 / frontend/components/button/_button.html.slim
 
-= a.button(href=@href)
+a.button(href=@href)
   = @text
-  = render("suffix", text: "external link") if external_link?
+  - if external_link?
+    = render "suffix", text: "external link"
 ```
 
 ```slim
@@ -207,7 +239,6 @@ rails generate component admin/header
 
 This will create the component in an `admin` folder, and name its Ruby module `AdminHeaderComponent`.
 
-
 ### Stimulus integration
 
 Komponent supports [stimulus](https://github.com/stimulusjs/stimulus) 1.0.
@@ -267,8 +298,19 @@ You can whitelist the locales you use by setting this into an initializer, as ex
 I18n.available_locales = [:en, :fr]
 ```
 
+> If you have the `rails-i18n` gem in your `Gemfile`, you should whitelist locales to prevent creating a lot of
+> locale files when you generate a new component.
+
 ### Configuration
 
+#### 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")
+```
+
 #### Default options for the generators
 
 You can configure the generators in an initializer or in `application.rb`, so you don't have to add `--locale` and/or `--stimulus` flags every time you generate a fresh component.
@@ -279,12 +321,12 @@ config.generators do |g|
 end
 ```
 
-#### Change default root path
+#### Change default stylesheet engine
 
-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.
+You can configure the stylesheet engine used for generate stylesheet file, values allowed are ':css', ':scss', ':sass'.
 
 ```rb
-Rails.application.config.komponent.root = Rails.root.join("app/frontend")
+Rails.application.config.komponent.stylesheet_engine = :css # default value is :css
 ```
 
 #### Force default templating engine

data/Rakefile

@@ -1,25 +1,33 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
+require "rubocop/rake_task"
 require "rake/testtask"
-require 'cucumber'
-require 'cucumber/rake/task'
+require "cucumber"
+require "cucumber/rake/task"
+require "coveralls/rake/task"
 
 namespace :test do
-  task all: [:unit, :cucumber]
+  task all: [:rubocop, :unit, :cucumber]
+  task all_with_coverage: [:all, "coveralls:push"]
+
+  RuboCop::RakeTask.new
 
   Rake::TestTask.new(:unit) do |t|
     t.libs << "test"
     t.libs << "lib"
     t.test_files = FileList["test/**/*_test.rb"]
     t.verbose = true
+    t.warning = false
   end
 
   Cucumber::Rake::Task.new(:cucumber) do |t|
     t.cucumber_opts = "--format pretty"
   end
+
+  Coveralls::RakeTask.new
 end
 
-task test: 'test:all'
+task test: "test:all"
 
 task default: :test

data/komponent.gemspec

@@ -5,25 +5,31 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "komponent/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "komponent"
-  spec.version       = Komponent::VERSION
-  spec.authors       = ["Ouvrages"]
-  spec.email         = ["contact@ouvrages-web.fr"]
+  spec.name        = "komponent"
+  spec.version     = Komponent::VERSION
+  spec.authors     = ["Ouvrages"]
+  spec.email       = ["contact@ouvrages-web.fr"]
 
-  spec.summary       = "An opinionated way of organizing front-end code in Ruby on Rails, based on components"
-  spec.description   = "An opinionated way of organizing front-end code in Ruby on Rails, based on components"
-  spec.homepage      = "http://komponent.io"
-  spec.license       = "MIT"
+  spec.summary     = "An opinionated way of organizing front-end code in Ruby on Rails, based on components"
+  spec.description = "An opinionated way of organizing front-end code in Ruby on Rails, based on components"
+  spec.homepage    = "http://komponent.io"
+  spec.license     = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.metadata    = {
+    "homepage_uri"    => "http://komponent.io",
+    "changelog_uri"   => "https://github.com/komposable/komponent/blob/master/CHANGELOG.md",
+    "source_code_uri" => "https://github.com/komposable/komponent",
+    "bug_tracker_uri" => "https://github.com/komposable/komponent/issues",
+  }
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features|fixtures)/})
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
 
+  spec.require_paths = ["lib"]
   spec.required_ruby_version = '>= 2.2.0'
 
+  spec.add_dependency "actionview", ">= 4.2"
   spec.add_dependency "activesupport", ">= 4.2"
   spec.add_dependency "railties", ">= 4.2"
   spec.add_dependency "webpacker", ">= 3.0.0"

data/lib/generators/component/component_generator.rb

@@ -134,11 +134,7 @@ class ComponentGenerator < Rails::Generators::NamedBase
   end
 
   def stylesheet_engine
-    if sass = rails_configuration.try(:sass)
-      sass[:preferred_syntax]
-    else
-      :css
-    end
+    rails_configuration.komponent.stylesheet_engine
   end
 
   def default_path

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module <%= module_name %>
   extend ComponentHelper
 end

data/lib/komponent/{core/component_helper.rb → component_helper.rb}

@@ -9,10 +9,5 @@ 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/component_renderer.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Komponent
+  class ComponentRenderer
+    include ActionView::Helpers::CaptureHelper
+
+    attr_accessor :output_buffer
+    attr_reader :context
+
+    def initialize(controller)
+      @context = controller.view_context.dup
+      @view_renderer = @context.view_renderer = @context.view_renderer.dup
+      @lookup_context = @view_renderer.lookup_context = @view_renderer.lookup_context.dup
+    end
+
+    def render(component, locals = {}, options = {}, &block)
+      cached = options.delete(:cached)
+      if cached
+
+        cached_block = block ? block.call : nil
+        key = [component, locals, options, cached_block].to_s
+        cache_key = Digest::SHA1.hexdigest(key)
+
+        Rails.cache.fetch(cache_key) do
+          _render(component, locals, options, &block)
+        end
+      else
+        _render(component, locals, options, &block)
+      end
+    end
+
+    private
+
+    def _render(component, locals = {}, options = {}, &block)
+      parts = component.split("/")
+      component_name = parts.join("_")
+
+      component_module_path = resolved_component_path(component)
+        .join("#{component_name}_component")
+      require_dependency(component_module_path)
+      component_module = "#{component_name}_component".camelize.constantize
+
+      @context.class_eval { prepend component_module }
+      @context.class_eval { prepend Komponent::Translation }
+
+      @lookup_context.prefixes = ["components/#{component}"]
+
+      @context.instance_eval do
+        if component_module.respond_to?(:properties)
+          locals = locals.dup
+          component_module.properties.each do |name, options|
+            unless locals.has_key?(name)
+              if options.has_key?(:default)
+                locals[name] = options[:default]
+              elsif options[:required]
+                raise "Missing required component parameter: #{name}"
+              end
+            end
+          end
+        end
+
+        locals.each do |name, value|
+          instance_variable_set(:"@#{name}", locals[name])
+        end
+
+        define_singleton_method(:properties) { locals }
+        define_singleton_method(:block_given_to_component?) { block_given? }
+        define_singleton_method(:block_given_to_component) { block }
+      end
+
+      @context.render("components/#{component}/#{parts.join('_')}", &block)
+    end
+
+    def resolved_component_path(component)
+      Komponent::ComponentPathResolver.new.resolve(component)
+    end
+  end
+end

data/lib/komponent/komponent_helper.rb

@@ -1,82 +1,16 @@
 # frozen_string_literal: true
 
 module KomponentHelper
-  def component(component, locals = {}, &block)
-    component_path = Komponent::ComponentPathResolver.new.resolve(component)
-
-    parts = component.split("/")
-    component_name = parts.join("_")
-    component_path = component_path.join("#{component_name}_component")
-
-    require_dependency(component_path)
-
-    component_module = "#{component_name}_component".camelize.constantize
-    context = controller.view_context.dup
-
-    context.view_flow = view_flow
-
-    view_renderer = context.view_renderer = context.view_renderer.dup
-    lookup_context = view_renderer.lookup_context = view_renderer.lookup_context.dup
-    lookup_context.prefixes = ["components/#{component}"]
-
-    context.class_eval { prepend component_module }
-    context.class_eval { prepend Komponent::Translation }
-
-    capture_block = proc { capture(&block) } if block
-
-    context.instance_eval do
-      if component_module.respond_to?(:properties)
-        locals = locals.dup
-        component_module.properties.each do |name, options|
-          unless locals.has_key?(name)
-            if options.has_key?(:default)
-              locals[name] = options[:default]
-            elsif options[:required]
-              raise "Missing required component parameter: #{name}"
-            end
-          end
-        end
-      end
-
-      locals.each do |name, value|
-        instance_variable_set(:"@#{name}", locals[name])
-      end
-
-      define_singleton_method(:properties) { locals }
-
-      instance_variable_set(:"@block_given_to_component", 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
+  def component(component_name, locals = {}, options = {}, &block)
+    captured_block = proc { capture(&block) } if block_given?
+    Komponent::ComponentRenderer.new(
+      controller,
+    ).render(
+      component_name,
+      locals,
+      options,
+      &captured_block
+    )
   end
   alias :c :component
-
-  def render_partial(partial_name, locals = {}, &block)
-    warn "[DEPRECATION WARNING] `render_partial` is deprecated. Please use default `render` instead."
-
-    context = controller.view_context
-    view_paths = context.lookup_context.view_paths.dup
-    components_path = Rails.root.join "frontend/components"
-
-    capture_block = proc { capture(&block) } if block
-
-    current_dir = Pathname.new(@virtual_path).dirname
-
-    context.lookup_context.prefixes.prepend current_dir
-    context.lookup_context.view_paths.unshift components_path
-
-    rendered_partial = capture do
-      context.render partial_name, locals, &capture_block
-    end
-
-    context.lookup_context.prefixes.delete current_dir
-    context.lookup_context.view_paths = view_paths
-
-    rendered_partial
-  end
 end

data/lib/komponent/railtie.rb

@@ -1,19 +1,21 @@
 # frozen_string_literal: true
 
 require 'webpacker'
-require 'komponent/core/component_helper'
-require 'komponent/core/translation'
-require 'komponent/core/component_path_resolver'
+require 'komponent/component_helper'
+require 'komponent/component_path_resolver'
+require 'komponent/component_renderer'
+require 'komponent/translation'
 
 module Komponent
   class Railtie < Rails::Railtie
     config.komponent = ActiveSupport::OrderedOptions.new
     config.komponent.root = nil
     config.komponent.component_paths = []
+    config.komponent.stylesheet_engine = :css
 
     config.before_configuration do |app|
-      app.config.komponent.root = app.config.root.join("frontend")
       app.config.komponent = config.komponent
+      app.config.komponent.root = app.config.root.join("frontend")
     end
 
     config.after_initialize do |app|

data/lib/komponent/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Komponent
-  VERSION = "1.1.4"
+  VERSION = "2.0.0.pre.1"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: komponent
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 2.0.0.pre.1
 platform: ruby
 authors:
 - Ouvrages
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-03-05 00:00:00.000000000 Z
+date: 2018-04-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -76,6 +90,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".simplecov"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -107,17 +122,22 @@ files:
 - lib/generators/component/templates/view.html.slim.erb
 - lib/generators/komponent/install_generator.rb
 - lib/komponent.rb
-- lib/komponent/core/component_helper.rb
-- lib/komponent/core/component_path_resolver.rb
-- lib/komponent/core/translation.rb
+- lib/komponent/component_helper.rb
+- lib/komponent/component_path_resolver.rb
+- lib/komponent/component_renderer.rb
 - lib/komponent/komponent_helper.rb
 - lib/komponent/railtie.rb
+- lib/komponent/translation.rb
 - lib/komponent/version.rb
 - logo.svg
 homepage: http://komponent.io
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: http://komponent.io
+  changelog_uri: https://github.com/komposable/komponent/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/komposable/komponent
+  bug_tracker_uri: https://github.com/komposable/komponent/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -129,9 +149,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.13