ilex 0.1.3 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05f0478149655dc4fc56136bc17054bd1b89a2a7ba20a701f0043c96a5ccf423
-  data.tar.gz: 8161c073bc92aa9ef0698dd3526181a4f3d96ce986130dba0eab4efac47bb83f
+  metadata.gz: 0270cc4a6ad17198cccaa8dfe059fc68a8acb05d9d690ac54d2b4590bed94e16
+  data.tar.gz: faa95ab242ab07977737971bb7b98c76afbf5b3a7f5450c919716a92fcdc393c
 SHA512:
-  metadata.gz: 2aa4d959ae5d0e38db60a6ce4b5dc79bb80034a555a485d839d08c9da9e39b3c2fdc7f096954d9b27c2187234f96036042efde2ba8658125069e402d6bc353aa
-  data.tar.gz: d4f7a0c6f6c3e046f201b823a306684a0717eccdbcd078687927dcd2bbda7c7532515a2d7056cacbf370f24a860424fbc4e69e72e065474c65c8c10530407d62
+  metadata.gz: 7730bd1a0fd1552619a659347437fc206ca393c57859ff85e3270002274d9619005a2c97f813e591b29fd0488cc89d1a4b9802c1332a795baea90d272da0f2dd
+  data.tar.gz: 7b8dfb00406cb0916000945feb3c0df9188f6d4c941777e64bde12a16ecdbcf19524913bdad2ec382c254677a9be67e8a735251aaa1af08b35c802717273efb2

data/.versionrc.json

@@ -1,7 +1,7 @@
-{
-  "skip": {
-    "tag": true
-  },
-  "NAME": "Ilex",
-  "VERSION": "0.1.0"
-}
+{
+  "skip": {
+    "tag": true
+  },
+  "NAME": "Ilex",
+  "VERSION": "0.1.6"
+}

data/CHANGELOG.md

@@ -2,6 +2,50 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.1.8](https://github.com/joshleblanc/ilex/compare/v0.1.7...v0.1.8) (2021-06-16)
+
+
+### Bug Fixes
+
+* handle rendering arrays ([fd09349](https://github.com/joshleblanc/ilex/commit/fd093493a790ada7403acfa8cf2496783cdfbfce))
+* handle root level slot text nodes ([6913197](https://github.com/joshleblanc/ilex/commit/6913197ab4286115734bbbbb4b2fc1c01f286d84))
+
+### [0.1.7](https://github.com/joshleblanc/ilex/compare/v0.1.6...v0.1.7) (2021-06-16)
+
+
+### Bug Fixes
+
+* try and convert component arrays into strings ([13e0438](https://github.com/joshleblanc/ilex/commit/13e0438d1da6ebd0bc0b46c9ca7cc6828bd99a7f))
+
+### [0.1.6](https://github.com/joshleblanc/cedar/compare/v0.1.5...v0.1.6) (2021-04-18)
+
+
+### Bug Fixes
+
+* allow rendering form helpers with blocks ([9a24ed7](https://github.com/joshleblanc/cedar/commit/9a24ed7388c60f7a7ed4398dc4871974302c87f3)), closes [activeadmin/arbre#64](https://github.com/activeadmin/arbre/issues/64)
+
+### [0.1.5](https://github.com/joshleblanc/cedar/compare/v0.1.4...v0.1.5) (2021-04-17)
+
+
+### Features
+
+* add helpers for rendering namespaced components ([3b0a5af](https://github.com/joshleblanc/cedar/commit/3b0a5af421e4b4c9a3b45b07b11647df65908552))
+
+
+### Bug Fixes
+
+* allow appending helpers with _component ([7097420](https://github.com/joshleblanc/cedar/commit/7097420d3529533910fd5174af175aae15c16aa0))
+* appease intellisense with unused splat ([854c8a8](https://github.com/joshleblanc/cedar/commit/854c8a8c7f121d4f531bb5a6d56b487f29772bb8))
+* component content wasn't rendering ([041efb2](https://github.com/joshleblanc/cedar/commit/041efb21cbc0760ac94d1fa0093dc57d5185d0d0))
+* override arbre render method ([235763b](https://github.com/joshleblanc/cedar/commit/235763b5820fbcbf7faaee934e14c90f381b128a))
+
+### [0.1.4](https://github.com/joshleblanc/cedar/compare/v0.1.3...v0.1.4) (2021-04-16)
+
+
+### Bug Fixes
+
+* redirect content to view_component ([b13943f](https://github.com/joshleblanc/cedar/commit/b13943fec1fe22e4a9c47c6300ba306eb1bd248a))
+
 ### [0.1.3](https://github.com/joshleblanc/cedar/compare/v0.1.2...v0.1.3) (2021-04-16)
 
 ### [0.1.2](https://github.com/joshleblanc/ilex/compare/v0.1.1...v0.1.2) (2021-04-16)

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    ilex (0.1.3)
+    ilex (0.1.8)
       arbre
+      rails (>= 5.2, < 7.0)
 
 GEM
   remote: https://rubygems.org/
@@ -90,6 +91,8 @@ GEM
     nio4r (2.5.7)
     nokogiri (1.11.2-x64-mingw32)
       racc (~> 1.4)
+    nokogiri (1.11.2-x86_64-linux)
+      racc (~> 1.4)
     parallel (1.20.1)
     parser (3.0.0.0)
       ast (~> 2.4.1)
@@ -163,6 +166,7 @@ GEM
 
 PLATFORMS
   x64-mingw32
+  x86_64-linux
 
 DEPENDENCIES
   ilex!

data/cedar.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
   spec.add_dependency "arbre"
+  spec.add_dependency "rails", [">= 5.2", "< 7.0"]
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/ilex.rb

@@ -6,8 +6,14 @@ require_relative "ilex/component_warden"
 require_relative "ilex/component_wardens"
 require_relative "ilex/context"
 require_relative "ilex/component"
+require_relative "ilex/arbre_ext/element"
+require_relative "ilex/arbre_ext/element/builder_methods"
+require_relative "ilex/arbre_ext/html/text_node"
+require_relative "ilex/rails_ext/action_view/base"
+require_relative "ilex/engine"
 
 module Ilex
   class Error < StandardError; end
   # Your code goes here...
 end
+

data/lib/ilex/arbre_ext/element.rb

@@ -0,0 +1,27 @@
+module Ilex
+  module ArbreExt
+    module Element
+      ruby2_keywords def method_missing(name, *args, &block)
+        if current_arbre_element.respond_to?(name)
+          current_arbre_element.send name, *args, &block
+        elsif assigns && assigns.has_key?(name)
+          assigns[name]
+        elsif helpers.respond_to?(name)
+          helper_capture(name, *args, &block)
+        else
+          super
+        end
+      end
+
+      # The helper might have a block that builds Arbre elements
+      # which will be rendered (#to_s) inside ActionView::Base#capture.
+      # We do not want such elements added to self, so we push a dummy
+      # current_arbre_element.
+      def helper_capture(name, *args, &block)
+        s = ""
+        within(Element.new) { s = helpers.send(name, *args, &block) }
+        s.is_a?(Element) ? s.to_s : s
+      end
+    end
+  end
+end

data/lib/ilex/arbre_ext/element/builder_methods.rb

@@ -0,0 +1,20 @@
+module Ilex
+  module ArbreExt
+    module Element
+      module BuilderMethods
+        private
+
+        def append_return_block(tag)
+          return nil if current_arbre_element.children?
+          return unless appendable_tag?(tag)
+
+          current_arbre_element << if tag.is_a? Array
+                                     Arbre::HTML::TextNode.from_string(tag.join.html_safe)
+                                   else
+                                     Arbre::HTML::TextNode.from_string(tag.to_s)
+                                   end
+        end
+      end
+    end
+  end
+end

data/lib/ilex/arbre_ext/html/text_node.rb

@@ -0,0 +1,15 @@
+module Ilex
+  module ArbreExt
+    module HTML
+      module TextNode
+        def build(string)
+          @content = if string.is_a? Array
+                       string.join.html_safe
+                     else
+                       string
+                     end
+        end
+      end
+    end
+  end
+end

data/lib/ilex/component.rb

@@ -1,45 +1,49 @@
-# frozen_string_literal: true
-
-module Ilex
-
-  ##
-  # InlineRender provides a `render` dsl to your components
-  # which will render any arbre tree within.
-  #
-  # It will also convert snake case component names to component instances
-  # for example, this would be equivalent to `ButtonComponent.new(label: "Test")`
-  #
-  # ```ruby
-  # render do
-  #   div do
-  #     button label: "Test"
-  #   end
-  # end
-  # ```
-  module Component
-    include Arbre::HTML
-
-    # The empty first arg is just to trick rubymine
-    # when using `render` inside the arbre context
-    def render(&blk)
-      define_method :call do
-        ctx = Context.new(self)
-        ctx.instance_eval(&blk).to_s
-      end
-    end
-
-    def find_component(name)
-      if const_defined?(name)
-        const_get(name)
-      else
-        if superclass.respond_to?(:find_component)
-          superclass.find_component(name)
-        else
-          adjusted_name = name.chomp("Component").underscore
-          raise(NameError, "undefined local variable or method `#{adjusted_name}` for #{self}")
-        end
-
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Ilex
+
+  ##
+  # InlineRender provides a `render` dsl to your components
+  # which will render any arbre tree within.
+  #
+  # It will also convert snake case component names to component instances
+  # for example, this would be equivalent to `ButtonComponent.new(label: "Test")`
+  #
+  # ```ruby
+  # render do
+  #   div do
+  #     button label: "Test"
+  #   end
+  # end
+  # ```
+  module Component
+    include Arbre::HTML
+
+    def render(*args, &blk)
+      define_method :call do
+        ctx = Context.new(self)
+        ctx.instance_eval(&blk).to_s
+      end
+    end
+
+    def find_component(name, base_module = nil)
+      target = if base_module
+        base_module
+      else
+        self
+      end
+
+      if target.const_defined?(name)
+        target.const_get(name)
+      else
+        if target.superclass.respond_to?(:find_component)
+          target.superclass.find_component(name)
+        else
+          adjusted_name = name.chomp("Component").underscore
+          raise(NameError, "undefined local variable or method `#{adjusted_name}` for #{self}")
+        end
+
+      end
+    end
+  end
+end

data/lib/ilex/component_warden.rb

@@ -1,45 +1,65 @@
-# frozen_string_literal: true
-
-module Ilex
-  ##
-  # A ComponentWarden is responsible for locating potential components
-  # given a snake_case representation of that component.
-  #
-  # If a component exists, the warden is also responsible for calling the correct
-  # instantiation method, depending if the component is a collection or not
-  class ComponentWarden
-    def initialize(component, string)
-      @component = component
-      @raw_input = string
-
-      @collection = @raw_input.end_with? "_collection"
-      @input = @raw_input.to_s.chomp("_collection")
-    end
-
-    def collection?
-      @collection
-    end
-
-    def component_name
-      "#{@input}_component".camelize
-    end
-
-    def component_class
-      @component_class ||= @component.class.find_component(component_name)
-    end
-
-    def exists?
-      component_class.present?
-    end
-
-    def new(*args, &block)
-      return nil unless exists?
-
-      if collection?
-        component_class.with_collection(*args, &block)
-      else
-        component_class.new(*args, &block)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Ilex
+  ##
+  # A ComponentWarden is responsible for locating potential components
+  # given a snake_case representation of that component.
+  #
+  # If a component exists, the warden is also responsible for calling the correct
+  # instantiation method, depending if the component is a collection or not
+  class ComponentWarden
+    def initialize(component, string)
+      @component = component
+      @input = string.to_s
+
+      @collection = @input.end_with? "_collection"
+      @nested = @input.include? "__"
+
+      process_input!(@input)
+    end
+
+    def collection?
+      @collection
+    end
+
+    def nested?
+      @nested
+    end
+
+    def component_name
+      "#{@input}_component".camelize
+    end
+
+    def component_class
+      @component_class ||= @component.class.find_component(component_name, @base_module)
+    end
+
+    def exists?
+      component_class.present?
+    end
+
+    def new(*args, &block)
+      return nil unless exists?
+
+      if collection?
+        component_class.with_collection(*args)
+      else
+        component_class.new(*args)
+      end
+    end
+
+    private
+
+    def process_input!(input)
+      @input.chomp! "_collection"
+      @input.chomp! "_component"
+
+      if nested?
+        parts = @input.split("__")
+        @input = parts.pop
+
+        @base_module = parts.map(&:camelize).join("::").constantize
+      end
+    end
+  end
+end

data/lib/ilex/component_wardens.rb

@@ -1,18 +1,18 @@
-# frozen_string_literal: true
-
-module Ilex
-  ##
-  # Thin wrapper around a hash of component wardens
-  # such that the default is always an instance of ComponentWarden
-  class ComponentWardens
-    def initialize(component)
-      @wardens = Hash.new do |hash, key|
-        hash[key] = ComponentWarden.new(component, key)
-      end
-    end
-
-    def [](key)
-      @wardens[key]
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Ilex
+  ##
+  # Thin wrapper around a hash of component wardens
+  # such that the default is always an instance of ComponentWarden
+  class ComponentWardens
+    def initialize(component)
+      @wardens = Hash.new do |hash, key|
+        hash[key] = ComponentWarden.new(component, key)
+      end
+    end
+
+    def [](key)
+      @wardens[key]
+    end
+  end
+end

data/lib/ilex/context.rb

@@ -1,37 +1,69 @@
-# frozen_string_literal: true
-
-module Ilex
-  ##
-  # Inject a component's instance variables into arbre's default context
-  # as well as provide implicit handling of snake-cased component names as
-  # tags
-  class Context < Arbre::Context
-
-    def initialize(component)
-      super({}, component)
-
-      @component = component
-      @component_wardens = ComponentWardens.new(@component)
-
-      # Copy all of the instance variables from the component to the context,
-      # so we have access to them when rendering
-      @component.instance_variables.each do |iv|
-        instance_variable_set(iv, @component.instance_variable_get(iv))
-      end
-    end
-
-    def respond_to_missing?(method, include_all)
-      @component.respond_to?(method) || @component_wardens[method].exists? || super
-    end
-
-    def method_missing(method, *args, &content_block)
-      if @component.respond_to?(method)
-        @component.send(method, *args, &content_block)
-      elsif @component_wardens[method].exists?
-        render @component_wardens[method].new(*args, &content_block)
-      else
-        super
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Ilex
+  ##
+  # Inject a component's instance variables into arbre's default context
+  # as well as provide implicit handling of snake-cased component names as
+  # tags
+  class Context < Arbre::Context
+
+    def initialize(component, &blk)
+      @component = component
+
+
+      # Copy all of the instance variables from the component to the context,
+      # so we have access to them when rendering
+      @component.instance_variables.each do |iv|
+        instance_variable_set(iv, @component.instance_variable_get(iv))
+      end
+
+      super({}, component, &blk)
+    end
+
+    def content
+      @component.send :content
+    end
+
+    def component_wardens
+      @component_wardens ||= ComponentWardens.new(@component)
+    end
+
+    # This is overriding arbre::rails::rendering
+    # It performs the same actions, but returns html_safe on a passed block
+    #
+    # Not 100% sure this is needed, but view_components won't render their
+    # contents without it, when rendered in an arbre tree
+    def render(*args)
+      rendered = helpers.render(*args) do
+        if block_given?
+          contents = yield
+          if contents.is_a? Array
+            contents.join.html_safe
+          else
+            contents.html_safe
+          end
+        end
+      end
+      case rendered
+      when Arbre::Context
+        current_arbre_element.add_child rendered
+      else
+        text_node rendered
+      end
+    end
+
+    def respond_to_missing?(method, include_all)
+      @component.respond_to?(method) || component_wardens[method].exists? || super
+    end
+
+    def method_missing(method, *args, &content_block)
+      if @component.respond_to?(method)
+        @component.send(method, *args, &content_block)
+      elsif component_wardens[method].exists?
+        render component_wardens[method].new(*args), &content_block
+      else
+        super
+      end
+    end
+  end
+end

data/lib/ilex/engine.rb

@@ -0,0 +1,11 @@
+module Ilex
+  class Engine < ::Rails::Engine
+
+    config.to_prepare do
+      ActionView::Base.prepend RailsExt::ActionView::Base
+      Arbre::Element.prepend ArbreExt::Element
+      Arbre::Element::BuilderMethods.prepend ArbreExt::Element::BuilderMethods
+      Arbre::HTML::TextNode.prepend ArbreExt::HTML::TextNode
+    end
+  end
+end

data/lib/ilex/rails_ext/action_view/base.rb

@@ -0,0 +1,21 @@
+module Ilex
+  module RailsExt
+    module ActionView
+      module Base
+        def capture(*args)
+          value = nil
+          buffer = with_output_buffer { value = yield(*args) }
+
+          # Override to handle Arbre elements inside helper blocks.
+          # See https://github.com/rails/rails/issues/17661
+          # and https://github.com/rails/rails/pull/18024#commitcomment-8975180
+          value = value.to_s if value.is_a?(Arbre::Element)
+
+          if (string = buffer.presence || value) && string.is_a?(String)
+            ERB::Util.html_escape string
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ilex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ilex
-  VERSION = "0.1.3"
+  VERSION = "0.1.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ilex
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.8
 platform: ruby
 authors:
 - Joshua LeBlanc
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-16 00:00:00.000000000 Z
+date: 2021-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: arbre
@@ -24,6 +24,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 description: Extends view components to allow rendering inline arbre templates
 email:
 - jleblanc@hey.com
@@ -46,10 +66,15 @@ files:
 - bin/setup
 - cedar.gemspec
 - lib/ilex.rb
+- lib/ilex/arbre_ext/element.rb
+- lib/ilex/arbre_ext/element/builder_methods.rb
+- lib/ilex/arbre_ext/html/text_node.rb
 - lib/ilex/component.rb
 - lib/ilex/component_warden.rb
 - lib/ilex/component_wardens.rb
 - lib/ilex/context.rb
+- lib/ilex/engine.rb
+- lib/ilex/rails_ext/action_view/base.rb
 - lib/ilex/version.rb
 homepage: https://github.com/joshleblanc/ilex
 licenses:
@@ -59,7 +84,7 @@ metadata:
   homepage_uri: https://github.com/joshleblanc/ilex
   source_code_uri: https://github.com/joshleblanc/ilex
   changelog_uri: https://github.com/joshleblanc/ilex
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -74,8 +99,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.2.15
+signing_key: 
 specification_version: 4
 summary: Provides inline rendering to view components
 test_files: []