lite-component 1.0.7 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a8da63bbff0a8b2ff1ed61b3c3a8ae03219c44c068f3a4ae341f2cf28505e16
-  data.tar.gz: 9e47f787be905cc2f3d08818aec1d8a91f111f3998e8f36bdfdd322d6c1f817f
+  metadata.gz: 2d9bdfa9c79cc9a007b6b1e35c42072dcbbbf6cf319c09b7d69738ef0133f284
+  data.tar.gz: 790df7f0ced92eec0f4403740ac4e433dc80e11f1f5ab2305d3d2fe935359afd
 SHA512:
-  metadata.gz: '029d1ed5a40fc81b0692d7a911a75a6f0238e2bc5bf54e2f41398f4a0293f75a44a32c44b990b181377ffe68c245d84b8ab9cc50e5e7e5e76eb4837b6a5da285'
-  data.tar.gz: 8db291f7a80fcbb8824460c0fc7bc8d92beb8baf5300fefc630242f5e159f5bcf9e4cfb5a94ec3fa84ad06b88a1a5fa978f68d62b55ed9d9ff79427791e46272
+  metadata.gz: bda36b4310e86b25b3f1f6e57b24a42b8a1eec4afe178bcdcf4886a7bffcd025de9110a15aba00589062c3aacf5ae5294763acccfa70bd2690f8a45229db4196
+  data.tar.gz: 139d5bd118979cdb4d6ed7edcfe5f5e95e34d517aba028a5ef6bd462fe5955e7a2c36bed6dd7381bd79bba81eb69b95d48d3dbbc65f09eb870d26d9e507b917f

data/.rubocop.yml

@@ -1,10 +1,16 @@
 require:
   - rubocop-performance
+  - rubocop-rake
   - rubocop-rspec
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
   DisplayCopNames: true
   DisplayStyleGuide: true
+  NewCops: enable
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
 Layout/EmptyLinesAroundBlockBody:
   Exclude:
     - 'spec/**/**/*'
@@ -14,6 +20,12 @@ Layout/EmptyLinesAroundModuleBody:
   EnforcedStyle: empty_lines_except_namespace
 Layout/LineLength:
   Max: 100
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
 Metrics/BlockLength:
   Enabled: false
 Metrics/ClassLength:
@@ -30,3 +42,13 @@ Style/Documentation:
   Enabled: false
 Style/ExpandPathArguments:
   Enabled: false
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: false

data/CHANGELOG.md

@@ -6,6 +6,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.1.0] - 2021-01-20
+### Added
+- Add improved collection rendering
+### Removed
+- Collection class is no longer needed
+
+## [1.0.11] - 2020-04-24
+### Added
+- Added `to_h` and  `to_hash` aliases for dumping locals
+
+## [1.0.10] - 2020-04-06
+### Added
+- Added `render?` method for checking complex logic
+
+## [1.0.9] - 2020-01-08
+### Added
+- Added block support to yield other components
+### Changed
+- Changed how the helper generated the component
+
+## [1.0.8] - 2019-12-26
+### Added
+- Added `c` local variable to access the component
+
 ## [1.0.7] - 2019-12-24
 ### Changed
 - Fixed path to nested partials

data/Gemfile.lock

@@ -1,59 +1,60 @@
 PATH
   remote: .
   specs:
-    lite-component (1.0.7)
+    lite-component (1.1.0)
       actionview
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.0.2.1)
-      actionview (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
-      rack (~> 2.0, >= 2.0.8)
+    actionpack (6.1.1)
+      actionview (= 6.1.1)
+      activesupport (= 6.1.1)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.2.1)
-      activesupport (= 6.0.2.1)
+    actionview (6.1.1)
+      activesupport (= 6.1.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.0.2.1)
+    activesupport (6.1.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
-    ast (2.4.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.1)
     builder (3.2.4)
     colorize (0.8.1)
-    concurrent-ruby (1.1.5)
-    crass (1.0.5)
-    diff-lcs (1.3)
-    erubi (1.9.0)
-    fasterer (0.8.1)
+    concurrent-ruby (1.1.8)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    fasterer (0.8.3)
       colorize (~> 0.7)
       ruby_parser (>= 3.14.1)
     generator_spec (0.9.4)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
-    i18n (1.7.0)
+    i18n (1.8.7)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    loofah (2.4.0)
+    loofah (2.9.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    method_source (0.9.2)
-    mini_portile2 (2.4.0)
-    minitest (5.13.0)
-    nokogiri (1.10.7)
-      mini_portile2 (~> 2.4.0)
-    parallel (1.19.1)
-    parser (2.6.5.0)
-      ast (~> 2.4.0)
-    rack (2.0.8)
+    method_source (1.0.0)
+    mini_portile2 (2.5.0)
+    minitest (5.14.3)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    racc (1.5.2)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
@@ -61,48 +62,57 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    railties (6.1.1)
+      actionpack (= 6.1.1)
+      activesupport (= 6.1.1)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
+      thor (~> 1.0)
     rainbow (3.0.0)
-    rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
-    rubocop (0.78.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    rubocop (1.8.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.1)
-      rubocop (>= 0.71.0)
-    rubocop-rspec (1.37.1)
-      rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
-    ruby_parser (3.14.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.0)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.2)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.1.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby_parser (3.15.1)
       sexp_processor (~> 4.9)
-    sexp_processor (4.13.0)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
-    zeitwerk (2.2.2)
+    sexp_processor (4.15.2)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -116,7 +126,8 @@ DEPENDENCIES
   rspec
   rubocop
   rubocop-performance
+  rubocop-rake
   rubocop-rspec
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/README.md

@@ -104,6 +104,20 @@ Render collection of components just as you would render collections of partials
 <%= component("comment_card", collection: @comments, spacer_template: "components/spacer") %>
 ```
 
+If you can skip rendering by evaluating complex logic in the `render?` method:
+
+```ruby
+# app/components/alert_component.rb
+
+class AlertComponent < Lite::Component::Base
+
+  def render?
+    object.some_complex_check?
+  end
+
+end
+```
+
 ### Context
 
 All components include `ActionView::Context` which will give you access to request context such as
@@ -146,6 +160,7 @@ end
 ### Locals
 
 All components include access to partial locals via the `locals` or `l` methods.
+You can dump locals to hash via the `to_h` and `to_hash` methods.
 *Note: Objects will be automatically added to locals when rendering collections.*
 
 ```erb
@@ -220,7 +235,7 @@ accessed by their key.
 ```
 
 Access to anything provided within its `*_component.rb` file can be done using the
-`component` local which is the instance of the component.
+`component` or `c` local methods which is the instance of the component.
 
 ```erb
 <%# app/views/components/_alert.html.erb %>
@@ -262,6 +277,36 @@ class AlertComponent < Lite::Component::Base
 end
 ```
 
+To add components as part of another component build a `block` and `yield` it in the component's view.
+
+```erb
+<%# app/views/components/_sidebar.html.erb %>
+
+<div class="sidebar">
+  <%= component("sidebar/navigation", locals: { class_name: "js-nav-links" }) do |c| %>
+    <% c.add("sidebar/navigation/link", locals: { text: "Link: 1", path: "/home", active: false }) %>
+    <% c.add("sidebar/navigation/link", locals: { text: "Link: 2", path: "/about", active: true }) %>
+    <% c.add("sidebar/navigation/link", locals: { text: "Link: 3", path: "/help", active: false }) do |n_c| %>
+      <% n_c.add("sidebar/something", locals: { test: "something" }) %>
+    <% end %>
+  <% end %>
+</div>
+```
+
+```erb
+<%# app/views/components/sidebar/_navigation.html.erb %>
+
+<div class="sidebar-navigation">
+  <%= c.yield %>
+</div>
+```
+
+```erb
+<%# app/views/components/sidebar/navigation/_link.html.erb %>
+
+<%= link_to(text, path, class: ("active" if l.active)) %>
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/app/helpers/lite/component/component_helper.rb

@@ -4,9 +4,9 @@ module Lite
   module Component
     module ComponentHelper
 
-      def component(name, options = {})
-        name = name.component_path if name.respond_to?(:component_path)
-        "#{name}_component".classify.constantize.render(self, options)
+      def component(name, options = {}, &block)
+        klass = Lite::Component::Base.build(name)
+        klass.render(self, options, &block)
       end
 
     end

data/lib/lite/component.rb

@@ -2,7 +2,7 @@
 
 require 'action_view'
 
-%w[version engine iteration collection locals base].each do |filename|
+%w[version engine iteration locals base].each do |filename|
   require "lite/component/#{filename}"
 end
 

data/lib/lite/component/base.rb

@@ -7,20 +7,34 @@ module Lite
       include ActionView::Context
       include ActionView::Helpers
 
-      attr_reader :context, :options
-      attr_writer :iteration
+      attr_accessor :components
+      attr_reader :context, :iteration, :options
+
+      # rubocop:disable Layout/LineLength
+      def initialize(context, options = {}, &block)
+        @components = []
+        @iteration = (options[:locals] || {}).delete(:iteration) || Lite::Component::Iteration.new(1, 0)
 
-      def initialize(context, options = {})
         @context = context
         @options = default_options.deep_merge(options)
+
+        yield(self) if block
       end
+      # rubocop:enable Layout/LineLength
 
       alias helpers context
       alias c context
       alias h helpers
+      alias i iteration
 
       class << self
 
+        def build(name)
+          return name if name.respond_to?(:component_path)
+
+          "#{name}_component".classify.constantize
+        end
+
         def component_name
           component_path.split('/').last
         end
@@ -29,19 +43,17 @@ module Lite
           name.underscore.sub('_component', '')
         end
 
-        def render(context, options = {})
-          klass = new(context, options)
+        def render(context, options = {}, &block)
+          klass = new(context, options, &block)
           klass.render
         end
 
       end
 
-      def iteration
-        @iteration ||= Lite::Component::Iteration.new(1, 0)
+      def add(name, options = {}, &block)
+        components << [name, options, block]
       end
 
-      alias i iteration
-
       def locals
         @locals ||= Lite::Component::Locals.new(options[:locals])
       end
@@ -49,14 +61,16 @@ module Lite
       alias l locals
 
       def render
+        return unless render?
+
         collection = options.delete(:collection)
-        return render_content if collection.nil? || !collection.respond_to?(:each)
+        return render_collection(collection) if collection.respond_to?(:each)
+
+        render_content
+      end
 
-        Lite::Component::Collection.render(
-          collection,
-          component: self,
-          spacer_template: options.delete(:spacer_template)
-        )
+      def render?
+        true
       end
 
       def render_content
@@ -67,6 +81,10 @@ module Lite
         "components/#{self.class.component_path}"
       end
 
+      def yield
+        context.safe_join(yield_content)
+      end
+
       private
 
       def default_options
@@ -75,12 +93,36 @@ module Lite
           object: self,
           as: :component,
           locals: {
+            c: self,
             object: nil,
             iteration: iteration
           }
         }
       end
 
+      # rubocop:disable Metrics/AbcSize
+      def render_collection(collection)
+        collection_size = collection.size
+        spacer_template = options.delete(:spacer_template)
+
+        results = collection.each_with_object([]).with_index do |(item, array), index|
+          array << context.render(spacer_template) if index.positive? && spacer_template
+          iteration = Lite::Component::Iteration.new(collection_size, index)
+          instance = self.class.new(context, locals: { object: item, iteration: iteration })
+          array << instance.render
+        end
+
+        context.safe_join(results)
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      def yield_content
+        components.map do |name, options, block|
+          klass = self.class.build(name)
+          klass.render(context, options, &block)
+        end
+      end
+
     end
   end
 end

data/lib/lite/component/locals.rb

@@ -6,6 +6,9 @@ module Lite
 
       attr_reader :locals
 
+      alias to_hash locals
+      alias to_h locals
+
       def initialize(locals)
         @locals = (locals || {}).symbolize_keys
       end

data/lib/lite/component/version.rb

@@ -3,7 +3,7 @@
 module Lite
   module Component
 
-    VERSION ||= '1.0.7'
+    VERSION ||= '1.1.0'
 
   end
 end

data/lite-component.gemspec

@@ -46,5 +46,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rake'
   spec.add_development_dependency 'rubocop-rspec'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lite-component
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.1.0
 platform: ruby
 authors:
 - Juan Gomez
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-12-24 00:00:00.000000000 Z
+date: 2021-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - j.gomez@drexed.com
 executables: []
@@ -166,7 +180,6 @@ files:
 - lib/generators/rails/templates/component.scss
 - lib/lite/component.rb
 - lib/lite/component/base.rb
-- lib/lite/component/collection.rb
 - lib/lite/component/engine.rb
 - lib/lite/component/iteration.rb
 - lib/lite/component/locals.rb
@@ -176,7 +189,7 @@ homepage: http://drexed.github.io/lite-component
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -191,8 +204,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.1
-signing_key: 
+rubygems_version: 3.2.5
+signing_key:
 specification_version: 4
 summary: Generate component from collections of data points
 test_files: []

data/lib/lite/component/collection.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-module Lite
-  module Component
-    class Collection
-
-      attr_reader :collection, :component, :spacer_template
-
-      def initialize(collection, component:, spacer_template: nil)
-        @collection = collection
-        @component = component
-        @spacer_template = spacer_template
-      end
-
-      class << self
-
-        def render(collection, component)
-          klass = new(collection, component)
-          klass.render
-        end
-
-      end
-
-      def render
-        component.context.safe_join(iterated_collection)
-      end
-
-      private
-
-      def collection_size
-        @collection_size ||= begin
-          if collection.respond_to?(:size)
-            collection.size
-          elsif collection.respond_to?(:to_a)
-            collection.to_a.size
-          elsif collection.respond_to?(:to_hash)
-            collection.to_hash.size
-          end
-        end
-      end
-
-      # rubocop:disable Metrics/AbcSize
-      def iterated_collection
-        collection.each_with_object([]).with_index do |(object, array), index|
-          component.iteration = Lite::Component::Iteration.new(collection_size, index)
-          component.options.deep_merge!(locals: { object: object, iteration: component.iteration })
-
-          array << component.render_content
-          next unless spacer_template && !component.iteration.last?
-
-          array << component.context.render(spacer_template)
-        end
-      end
-      # rubocop:enable Metrics/AbcSize
-
-    end
-  end
-end