wallaby-view 0.1.3 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9f47755d845bd5adf4199a5d7e11a50788f1505fdf8c786a447252e8fa0ac29
-  data.tar.gz: 4d953c4142e42b2341bf26c55b0d2ad84683c73f95bc526867d2091db3eb6ed1
+  metadata.gz: c7144207990b4071d9aa101d8a2bbee5b282264bd896768f5b4a0640d8eba14f
+  data.tar.gz: f8190dfba431bafbf38eb6c23cffb17932c6b223e7d52840c0846ddad2a654b3
 SHA512:
-  metadata.gz: 3a5e064cda03c29e6ce17b45e9b945e17bde7d9cb8c091106143624d9b997459ce015d44d07d9e0eb02d540fa05b7a307838c8208d382a021a3ea8eb45dc9ab3
-  data.tar.gz: af47857fa027f84384740f04b5e529e00397e477f493905456d410c0691ea2659f1f1681149376601931253884b9ad3f0f64dd5c3e7d57f4a3864d1576253056
+  metadata.gz: c44424c02029a37a88a5a7b090befda949dfb72838ff0dd113fa1efdaacc942b12e1aed6c15fcc5c38ec07e3e0fd8f38cc7c197a79b6bb89835714c7d3bb69ca
+  data.tar.gz: 0ed6828b6445a7b9c101a6cd07100d726308536c58e684a2f1d61531c74d62cbb6e0a8d0dd745d66776d4e912f715d8ecd9fdd065b8bbaf317f5acbb2ead712d

data/README.md

@@ -7,11 +7,14 @@
 [![Test Coverage](https://api.codeclimate.com/v1/badges/d3e924dd70cc12562eab/test_coverage)](https://codeclimate.com/github/wallaby-rails/wallaby-view/test_coverage)
 [![Inch CI](https://inch-ci.org/github/wallaby-rails/wallaby-view.svg?branch=master)](https://inch-ci.org/github/wallaby-rails/wallaby-view)
 
-`Wallaby::View` is a Ruby gem that extends Rails layout/template/partial inheritance chain to allow searching layout/template/partial using theme name and action name.
+**Wallaby::View** extends Rails template/partial inheritance chain to be able to:
+
+- organize partials in `#{controller_path}/#{action}` fashion on top of Rails' controller fashion by extending Rails' [\_prefixes](https://github.com/rails/rails/blob/master/actionview/lib/action_view/view_paths.rb#L90).
+- configure the theme (a set of layout/templates/partials starting with the theme prefix).
 
 ## Install
 
-Add `Wallaby::View` to `Gemfile`.
+Add **Wallaby::View** to `Gemfile`.
 
 ```ruby
 gem 'wallaby-view'
@@ -23,7 +26,7 @@ And re-bundle.
 bundle install
 ```
 
-Include `Wallaby::View` in the target controller (e.g. `ApplicationController`):
+Include **Wallaby::View** in the controller (e.g. **ApplicationController**):
 
 ```ruby
 # app/controllers/application_controller
@@ -43,18 +46,18 @@ class ApplicationController < ActionController::Base
 end
 
 # app/controllers/admin/application_controller
-class Admin::ApplicationController < ApplicationController
+class Admin::ApplicationController < ::ApplicationController
   self.theme_name = 'secure'
 end
 
 # app/controllers/admin/users_controller
 class Admin::UsersController < Admin::ApplicationController
   self.theme_name = 'account'
-  self.options = { mapping_actions: { edit: 'form' } }
+  self.prefix_options = { edit: 'form' }
 end
 ```
 
-By using `Wallaby::View`, the lookup folder order of `admin/application#edit` action becomes:
+By using **Wallaby::View**, a template/partial for the `admin/application#edit` action will be looked up in the following folder order from top to bottom:
 
 - app/views/admin/application/edit
 - app/views/admin/application
@@ -63,31 +66,63 @@ By using `Wallaby::View`, the lookup folder order of `admin/application#edit` ac
 - app/views/application/edit
 - app/views/application
 
-Then it is possible to create a relative partial in one of the above folder for `admin/application#edit` action, for instance:
+Then it depends on how a relative partial should be shared, the partial can be created in one of the above folders.
+For example, if a `form` partial is designed specifically for `admin/application#edit` action, then it can be created in `admin/application/edit` folder as below:
+
+```erb
+<%# app/views/admin/application/edit/_form.html.erb %>
+a form for `admin/application#edit`
+```
+
+Then in the `admin/application#edit` template, rendering the relative `form` partial will result in using the above partial.
 
 ```erb
 <%# app/views/admin/application/edit.html.erb %>
 <% render 'form' %>
-
-<%# app/views/secure/edit/_form.html.erb %>
-This form partial is under `secure` theme and `edit` action,
-but still can be rendered by `admin/application#edit` action
 ```
 
-For `admin/users#edit` action, since `mapping_actions` option is set, `edit` will be mapped to `form`.
+For `admin/users#edit` action, since `prefix_options` option is set, `edit` will be mapped to `form`, and `form` will be added to the prefixes as well.
 Therefore, the lookup folder order of `admin/users#edit` becomes:
 
+- app/views/admin/users/edit
 - app/views/admin/users/form
 - app/views/admin/users
+- app/views/secure/edit
 - app/views/secure/form
 - app/views/secure
+- app/views/admin/application/edit
 - app/views/admin/application/form
 - app/views/admin/application
+- app/views/secure/edit
 - app/views/secure/form
 - app/views/secure
+- app/views/application/edit
 - app/views/application/form
 - app/views/application
 
+## Advanced Usage
+
+It is possible to override the `_prefixes` method to make more changes to the prefixes before suffixing them with the action name:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include Wallaby::View
+
+  def _prefixes
+    super do |prefixes|
+      prefixes << 'last_resort'
+    end
+  end
+end
+```
+
+Then the lookup folder order of e.g. `application#edit` becomes:
+
+- app/views/application/edit
+- app/views/application
+- app/views/last_resort/edit
+- app/views/last_resort
+
 ## Documentation
 
 - [API Reference](https://www.rubydoc.info/gems/wallaby-view)

data/lib/wallaby/view/action_viewable.rb

@@ -7,17 +7,22 @@ module Wallaby
     module ActionViewable
       extend ActiveSupport::Concern
 
-      class << self
-        # @!attribute prefix_options
-        # It stores the options for {#_prefixes}. It can inherit options from superclass.
-        # @return [Hash] prefix options
-      end
-
-      class_methods do
+      module ClassMethods # :nodoc:
+        # @!attribute [w] prefix_options
         attr_writer :prefix_options
 
+        # @!attribute [r] prefix_options
+        # It stores the options for {#_prefixes #_prefixes}. It can inherit options from superclass.
+        # @return [Hash] prefix options
         def prefix_options
-          @prefix_options ||= superclass.try(:prefix_options)
+          @prefix_options ||= superclass.try(:prefix_options).try(:dup) || {}
+        end
+
+        # Add prefix options
+        # @param new_options [Hash]
+        # @return [Hash] merged prefix options
+        def merge_prefix_options(new_options)
+          prefix_options.merge!(new_options)
         end
       end
 
@@ -33,7 +38,7 @@ module Wallaby
       # Override
       # {https://github.com/rails/rails/blob/master/actionview/lib/action_view/view_paths.rb#L97 lookup_context}
       # to provide caching for template/partial lookup.
-      # @return {Wallaby::View::CustomLookupContext}
+      # @return {CustomLookupContext}
 
       # (see #lookup_context)
       def override_lookup_context
@@ -43,12 +48,12 @@ module Wallaby
 
       # @!method _prefixes(prefixes: nil, controller_path: nil, action_name: nil, themes: nil, options: nil, &block)
       # Override {https://github.com/rails/rails/blob/master/actionview/lib/action_view/view_paths.rb#L90 _prefixes}
-      # to allow other (e.g. {Wallaby::View::CustomPrefixes#action_name},
-      # {Wallaby::View::CustomPrefixes#themes}) to be added to the prefixes list.
+      # to allow other (e.g. {CustomPrefixes#action_name},
+      # {CustomPrefixes#themes}) to be added to the prefixes list.
       # @param prefixes [Array<String>] the base prefixes
       # @param action_name [String] the action name to add to the prefixes list
       # @param themes [String] the theme name to add to the prefixes list
-      # @param options [Hash] the options for {Wallaby::View::CustomPrefixes}
+      # @param options [Hash] the options that {CustomPrefixes} accepts
       # @return [Array<String>]
 
       # (see #_prefixes)
@@ -63,7 +68,7 @@ module Wallaby
             prefixes: prefixes || original_prefixes,
             action_name: action_name || params[:action],
             themes: themes || self.class.themes,
-            options: options || self.class.prefix_options, &block
+            options: self.class.prefix_options.merge(options || {}), &block
           )
       end
     end

data/lib/wallaby/view/custom_lookup_context.rb

@@ -4,11 +4,11 @@ module Wallaby
   module View
     # Custom lookup context to cache lookup results.
     class CustomLookupContext < ::ActionView::LookupContext
-      # Convert an ActionView::LookupContext instance into {Wallaby::View::CustomLookupContext}
+      # Convert an ActionView::LookupContext instance into {CustomLookupContext}
       # @param lookup_context [ActionView::LookupContext]
       # @param details [Hash]
       # @param prefixes [Array<String>]
-      # @return [Wallaby::View::CustomLookupContext]
+      # @return [CustomLookupContext]
       def self.convert(lookup_context, details: nil, prefixes: nil)
         return lookup_context if lookup_context.is_a? self
 

data/lib/wallaby/view/custom_prefixes.rb

@@ -7,17 +7,20 @@ module Wallaby
       # @!attribute [r] prefixes
       # Base prefixes to extend
       # @return [Array<String>]
-      # @see Wallaby::View::ActionViewable#_prefixes
+      # @see ActionViewable#_prefixes
       attr_reader :prefixes
+
       # @!attribute [r] action_name
       # Action name to be added
       # @return [String]
       attr_reader :action_name
+
       # @!attribute [r] themes
       # Themes to be inserted
       # @return [Array<Hash>]
-      # @see Wallaby::View::Themeable#.themes
+      # @see Themeable#.themes
       attr_reader :themes
+
       # @!attribute [r] options
       # Options for extending the given prefixes
       # @return [Hash]
@@ -28,6 +31,7 @@ module Wallaby
       #   Wallaby::View::CustomPrefixes.execute(
       #     prefixes: ['users', 'application'], action_name: 'index'
       #   )
+      #
       #   # => [
       #   #   'users/index',
       #   #   'users',
@@ -39,6 +43,7 @@ module Wallaby
       #     prefixes: ['users', 'application'], action_name: 'index',
       #     themes: [{ theme_name: 'secure', theme_path: 'users' }]
       #   )
+      #
       #   # => [
       #   #   'users/index',
       #   #   'users',
@@ -50,8 +55,9 @@ module Wallaby
       # @example To extend given prefixes with mapped action:
       #   Wallaby::View::CustomPrefixes.execute(
       #     prefixes: ['users', 'application'], action_name: 'edit',
-      #     options: { mapping_actions: { 'edit' => 'form' } }
+      #     options: { 'edit' => 'form' }
       #   )
+      #
       #   # => [
       #   #   'users/form',
       #   #   'users',
@@ -88,35 +94,37 @@ module Wallaby
       # @return [Array<String>]
       def execute(&block)
         new_prefixes(&block).each_with_object([]) do |prefix, array|
-          # Extend the prefix with action name suffix
-          array << "#{prefix}/#{suffix}" << prefix
+          # Extend the prefix with actions
+          actions.each { |action| array << "#{prefix}/#{action}" }
+          array << prefix
         end
       end
 
-      private
+      protected
 
+      # @yield [array] To allow the array to be further modified
+      # @yieldparam [Array<String>] array
       # @return [Array<String>]
       def new_prefixes
         prefixes.dup.try do |array|
           insert_themes_into array
 
           # Be able to change the array in overriding methods
-          # in {Wallaby::View::ActionViewable#override_prefixes}
+          # in {ActionViewable#override_prefixes}
           new_array = yield array if block_given?
 
-          # If the above block doesn't return an array,
-          # it's assumed that `array` is changed
+          # If the above block doesn't return a new array, it returns the old `array`.
           new_array.is_a?(Array) ? new_array : array
         end
       end
 
-      # Action name suffix
-      # @return [Hash]
-      def suffix
-        @suffix ||= mapped_action_name || action_name
+      # @return [Array<String>] Action names
+      def actions
+        @actions ||= [action_name, *mapped_action_name].compact
       end
 
-      # Insert theme name into the prefixes
+      # Insert theme names into the prefixes
+      # @param [Array<String>] array
       def insert_themes_into(array)
         themes.each do |theme|
           index = array.index theme[:theme_path]
@@ -125,9 +133,9 @@ module Wallaby
       end
 
       # Map the {#action_name} using `options[:mapping_actions]`
-      # @return [String, nil] mapped action name
+      # @return [Array<String>] mapped action name
       def mapped_action_name
-        options[:mapping_actions].try(:[], action_name)
+        Array((options[:mapping_actions] || options).try(:[], action_name))
       end
     end
   end

data/lib/wallaby/view/themeable.rb

@@ -6,8 +6,7 @@ module Wallaby
     module Themeable
       extend ActiveSupport::Concern
 
-      class << self
-        # @!attribute theme_name
+      module ClassMethods # :nodoc:
         # The theme name is used to specify the layout and prefixes
         # so that a set of theme implementation for the frontend (html/css/javascript)
         # can be applied
@@ -27,6 +26,7 @@ module Wallaby
         #
         #     def index
         #       _prefixes
+        #
         #       # =>
         #       # [
         #       #   'admin/application/index',
@@ -37,8 +37,22 @@ module Wallaby
         #       #   'application'
         #       # ]
         #     end
-        #     end
+        #   end
+        # @param theme_name [String]
+        # @param options [Hash] same options as Rails'
+        #   {https://api.rubyonrails.org/classes/ActionView/Layouts/ClassMethods.html#method-i-layout
+        #   layout} method
+        def theme_name=(theme_name, **options, &block)
+          layout theme_name, options, &block
+          @theme_path = theme_name && controller_path || nil
+          @theme_name = theme_name || nil
+        end
+
+        # @!attribute [r] theme_name
         # @return [String, nil] theme name
+        def theme_name
+          defined?(@theme_name) && @theme_name || superclass.try(:theme_name)
+        end
 
         # @!attribute [r] theme
         # @example Once theme is set, the metadata will be set as well:
@@ -46,6 +60,7 @@ module Wallaby
         #     self.theme_name = 'secure'
         #
         #     self.theme
+        #
         #     # =>
         #     # {
         #     #   theme_name: 'secure',
@@ -53,25 +68,6 @@ module Wallaby
         #     # }
         #   end
         # @return [Hash] theme metadata
-
-        # @!attribute [r] themes
-        # @return [Array<Hash>] a list of {.theme} metadata
-      end
-
-      class_methods do
-        # (see .theme_name)
-        def theme_name=(theme_name, **options, &block)
-          layout theme_name, options, &block
-          @theme_path = theme_name && controller_path || nil
-          @theme_name = theme_name || nil
-        end
-
-        # (see .theme_name)
-        def theme_name
-          defined?(@theme_name) && @theme_name || superclass.try(:theme_name)
-        end
-
-        # (see .theme)
         def theme
           defined?(@theme_name) && @theme_name && {
             theme_name: @theme_name,
@@ -79,7 +75,8 @@ module Wallaby
           } || superclass.try(:theme)
         end
 
-        # (see .themes)
+        # @!attribute [r] themes
+        # @return [Array<Hash>] a list of {#theme} metadata
         def themes
           list = superclass.try(:themes) || []
           list.prepend theme if defined?(@theme_name) && @theme_name

data/lib/wallaby/view/version.rb

@@ -2,6 +2,6 @@
 
 module Wallaby
   module View
-    VERSION = '0.1.3' # :nodoc:
+    VERSION = '0.1.7' # :nodoc:
   end
 end

data/lib/wallaby/view.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'request_store'
-require 'action_view/partial_renderer'
-
 require 'wallaby/view/version'
 require 'wallaby/view/action_viewable'
 require 'wallaby/view/themeable'
@@ -11,35 +8,18 @@ require 'wallaby/view/custom_prefixes'
 
 module Wallaby # :nodoc:
   # To extend Rails prefixes and improve lookup performance.
+  #
+  # For example, include {Wallaby::View} module in the controller:
+  #
+  # ```
+  # # app/controllers/application_controller
+  # class ApplicationController < ActionController::Base
+  #   include Wallaby::View
+  # end
+  # ```
   module View
     extend ActiveSupport::Concern
 
-    # This is the method executed when this module is included by other modules.
-    #
-    # Basically, it renames the methods so that it is possible
-    # to access the original methods after overriding them:
-    #
-    # 1. Rename the following original methods:
-    #
-    #     - rename {https://github.com/rails/rails/blob/master/actionview/lib/action_view/view_paths.rb#L97
-    #       lookup_context} to {Wallaby::View::ActionViewable#original_lookup_context original_lookup_context}
-    #     - rename {https://github.com/rails/rails/blob/master/actionview/lib/action_view/view_paths.rb#L90 _prefixes}
-    #       to {Wallaby::View::ActionViewable#original_prefixes original_prefixes}
-    #
-    # 2. Override the original methods:
-    #
-    #     - rename {Wallaby::View::ActionViewable#override_lookup_context override_lookup_context}
-    #       to {Wallaby::View::ActionViewable#lookup_context lookup_context}
-    #     - rename {Wallaby::View::ActionViewable#override_prefixes override_prefixes}
-    #       to {Wallaby::View::ActionViewable#\_prefixes \_prefixes}
-    # @param mod [Module]
-    def self.included(mod)
-      mod.send :alias_method, :original_lookup_context, :lookup_context
-      mod.send :alias_method, :original_prefixes, :_prefixes
-      mod.send :alias_method, :lookup_context, :override_lookup_context
-      mod.send :alias_method, :_prefixes, :override_prefixes
-    end
-
     COMMA = ',' # :nodoc:
     EMPTY_STRING = '' # :nodoc:
     DOT_RB = '.rb' # :nodoc:
@@ -49,5 +29,14 @@ module Wallaby # :nodoc:
 
     include ActionViewable
     include Themeable
+
+    included do
+      # NOTE: Basically, it renames the methods so that it is possible
+      # to access the original methods after overriding them:
+      alias_method :original_lookup_context, :lookup_context
+      alias_method :original_prefixes, :_prefixes
+      alias_method :lookup_context, :override_lookup_context
+      alias_method :_prefixes, :override_prefixes
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wallaby-view
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.7
 platform: ruby
 authors:
 - Tian Chen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-16 00:00:00.000000000 Z
+date: 2022-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -25,13 +25,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.2.0
 - !ruby/object:Gem::Dependency
-  name: request_store
+  name: github-markup
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -39,7 +39,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-rails
+  name: redcarpet
+  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: simplecov
+  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: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
 description: Wallaby View to extend Rails layout/template/partial inheritance chain.
 email:
 - me@tian.im
@@ -75,7 +117,6 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- lib/action_view/partial_renderer.rb
 - lib/wallaby/view.rb
 - lib/wallaby/view/action_viewable.rb
 - lib/wallaby/view/custom_lookup_context.rb
@@ -86,10 +127,11 @@ homepage: https://github.com/wallaby-rails/wallaby-view
 licenses:
 - MIT
 metadata:
+  rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/wallaby-rails/wallaby-view
   source_code_uri: https://github.com/wallaby-rails/wallaby-view
   changelog_uri: https://github.com/wallaby-rails/wallaby-view/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -104,8 +146,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Wallaby View to extend Rails layout/template/partial inheritance chain.
 test_files: []

data/lib/action_view/partial_renderer.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module ActionView # :nodoc:
-  # Re-open ActionView::PartialRenderer to disable logging for partials
-  # that have been rendered for more than once.
-  #
-  # Every log requires the IO. Reducing the logs will dramatically improve the performance.
-  # @see #instrument
-  class PartialRenderer
-    protected
-
-    # @!method original_instrument(name, **options, &block)
-    # Original method of {#instrument}
-    # @param name [String]
-    # @param options [Hash]
-    # @yield [payload]
-    # @yieldparam payload [Hash] payload object for instrument
-    # @return [ActionView::OutputBuffer]
-    alias original_instrument instrument
-
-    # Logs for partial rendering. Only one log will be printed
-    # even if a partial has been rendered for more than once.
-    #
-    # To disable this feature and see all logs,
-    # set `ENV['ALL_PARTIAL_LOGS']` to `true`
-    # @param name [String]
-    # @param options [Hash]
-    # @yield [payload]
-    # @yieldparam payload [Hash] payload object for instrument
-    # @return [ActionView::OutputBuffer]
-    def instrument(name, **options, &block)
-      identifier = options[:identifier] || @template.try(:identifier) || @path
-      instrumented = RequestStore.store[:instrumented] ||= {}
-
-      return yield({}) if !ENV['ALL_PARTIAL_LOGS'] && instrumented[identifier]
-
-      original_instrument(name, **options, &block).tap do
-        instrumented[identifier] ||= true
-      end
-    end
-  end
-end