RubyGems - blocks - Versions diffs - 3.0.2 → 4.0.0 - Mend

blocks 3.0.2 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (58) hide show

checksums.yaml +5 -5
data/.ruby-version +1 -1
data/.travis.yml +61 -17
data/CHANGELOG.rdoc +27 -0
data/Gemfile +11 -10
data/Guardfile +1 -0
data/README.md +2 -0
data/bin/deploy_docs +1 -1
data/blocks.gemspec +3 -1
data/docs/_includes/configuration.md +3 -6
data/docs/_includes/defining.md +7 -7
data/docs/_includes/{introduction.md → features.md} +2 -2
data/docs/_includes/helper-blocks.md +5 -0
data/docs/_includes/helper-blocks/content_tag.md +44 -0
data/docs/_includes/installation.md +16 -2
data/docs/_includes/overview.md +21 -0
data/docs/_includes/templating.md +1 -1
data/docs/_includes/templating/bootstrap_4_cards.md +9 -9
data/docs/_layouts/slate.html +11 -9
data/docs/index.md +3 -1
data/gemfiles/Gemfile.rails-3-0-stable +1 -0
data/gemfiles/Gemfile.rails-3-1-stable +1 -0
data/gemfiles/Gemfile.rails-3-2-stable +1 -0
data/gemfiles/Gemfile.rails-4-0-stable +2 -1
data/gemfiles/Gemfile.rails-4-1-stable +2 -1
data/gemfiles/Gemfile.rails-4-2-stable +2 -1
data/gemfiles/Gemfile.rails-5-0-stable +4 -3
data/gemfiles/Gemfile.rails-5-1-stable +4 -3
data/gemfiles/Gemfile.rails-5-2-stable +13 -0
data/lib/blocks.rb +37 -29
data/lib/blocks/builders/block_definition.rb +45 -43
data/lib/blocks/builders/builder.rb +96 -60
data/lib/blocks/builders/hook_definition.rb +19 -4
data/lib/blocks/engine.rb +14 -0
data/lib/blocks/helpers/controller_extensions.rb +13 -0
data/lib/blocks/helpers/haml_capture.rb +44 -0
data/lib/blocks/{action_view_extensions → helpers}/view_extensions.rb +10 -4
data/lib/blocks/renderers/adjacent_blocks_renderer.rb +9 -7
data/lib/blocks/renderers/block_placeholder.rb +2 -0
data/lib/blocks/renderers/block_renderer.rb +26 -5
data/lib/blocks/renderers/block_with_hooks_renderer.rb +29 -19
data/lib/blocks/renderers/collection_renderer.rb +18 -6
data/lib/blocks/renderers/nesting_blocks_renderer.rb +9 -11
data/lib/blocks/renderers/partial_renderer.rb +16 -14
data/lib/blocks/renderers/renderer.rb +9 -24
data/lib/blocks/renderers/runtime_context.rb +175 -147
data/lib/blocks/renderers/wrapper_renderer.rb +21 -10
data/lib/blocks/utilities/configurator.rb +30 -6
data/lib/blocks/utilities/hash_with_caller.rb +36 -32
data/lib/blocks/utilities/hash_with_render_strategy.rb +67 -19
data/lib/blocks/utilities/options_set.rb +38 -63
data/lib/blocks/version.rb +3 -1
metadata +23 -22
data/docs/_includes/wip.md +0 -34
data/lib/blocks/experimental/builder_permissions.rb +0 -52
data/lib/blocks/experimental/invalid_permissions_handler.rb +0 -27
data/lib/blocks/renderers/abstract_renderer.rb +0 -69
data/lib/blocks/utilities/dynamic_configuration.rb +0 -71

data/docs/_layouts/slate.html CHANGED

@@ -23,15 +23,13 @@ under the License.
 {% assign images_url = '/' | prepend: site.images_dir | prepend: '/' | prepend: site_url %}
 <html>
   <head>
-    <!-- Global Site Tag (gtag.js) - Google Analytics -->
-    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-104699666-1"></script>
-    <script>
-      window.dataLayer = window.dataLayer || [];
-      function gtag(){dataLayer.push(arguments)};
-      gtag('js', new Date());
-      gtag('config', 'UA-104699666-1');
-    </script>
+    <!-- Google Tag Manager -->
+    <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+    new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+    j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+    'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+    })(window,document,'script','dataLayer','GTM-KG9MQ69');</script>
+    <!-- End Google Tag Manager -->
     <meta charset="utf-8">
     <meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
@@ -42,6 +40,10 @@ under the License.
   </head>
   <body class="{{ page_classes }}" data-languages='{{ language_tabs | jsonify }}'>
+    <!-- Google Tag Manager (noscript) -->
+    <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KG9MQ69"
+    height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
+    <!-- End Google Tag Manager (noscript) -->
     <a href="#" id="nav-button">
       <span>
         NAV

data/docs/index.md CHANGED

@@ -10,14 +10,16 @@ toc_footers:
   - <a href='https://github.com/tripit/slate'>Documentation Powered by Slate</a>
 includes:
-  - introduction
+  - features
   - installation
+  - overview
   - defining
   - rendering
   - hooks
   - wrappers
   - skipping
   - reserved-keywords
+  - helper-blocks
   - templating
   - configuration
   - custom-builders

data/gemfiles/Gemfile.rails-3-0-stable CHANGED

@@ -9,6 +9,7 @@ gem "public_suffix", "~> 1.4.6"
 gem "mime-types", "< 3.0"
 gem "rack", "< 2.0"
 gem "rspec", "~> 3.0.0"
+gem "rspec-its", "~> 1.2.0"
 gem "rails", github: "rails/rails", branch: "3-0-stable"
 gem "shoulda-matchers", "~> 2.0"
 gem 'test-unit', '~> 3.0'

data/gemfiles/Gemfile.rails-3-1-stable CHANGED

@@ -9,6 +9,7 @@ gem "public_suffix", "~> 1.4.6"
 gem "mime-types", "< 3.0"
 gem "rack", "< 2.0"
 gem "rspec", "~> 3.0.0"
+gem "rspec-its", "~> 1.2.0"
 gem "rails", github: "rails/rails", branch: "3-1-stable"
 gem "shoulda-matchers", "~> 2.0"
 gem 'test-unit', '~> 3.0'

data/gemfiles/Gemfile.rails-3-2-stable CHANGED

@@ -9,6 +9,7 @@ gem "public_suffix", "~> 1.4.6"
 gem "mime-types", "< 3.0"
 gem "rack", "< 2.0"
 gem "rspec", "~> 3.0.0"
+gem "rspec-its", "~> 1.2.0"
 gem "rails", github: "rails/rails", branch: "3-2-stable"
 gem "shoulda-matchers", "~> 2.0"
 gem 'test-unit', '~> 3.0'

data/gemfiles/Gemfile.rails-4-0-stable CHANGED

@@ -9,6 +9,7 @@ gem "public_suffix", "~> 1.4.6"
 gem "mime-types", "< 3.0"
 gem "rack", "< 2.0"
 gem "rspec", "~> 3.0.0"
+gem "rspec-its", "~> 1.2.0"
 gem "rails", github: "rails/rails", branch: "4-0-stable"
-gem "shoulda-matchers", "~> 2.0"
+gem "shoulda-matchers", "3.1.3"
 gem "haml", "4.0.4"

data/gemfiles/Gemfile.rails-4-1-stable CHANGED

@@ -9,6 +9,7 @@ gem "public_suffix", "~> 1.4.6"
 gem "mime-types", "< 3.0"
 gem "rack", "< 2.0"
 gem "rspec", "~> 3.0.0"
+gem "rspec-its", "~> 1.2.0"
 gem "rails", github: "rails/rails", branch: "4-1-stable"
-gem "shoulda-matchers", "~> 2.0"
+gem "shoulda-matchers", "3.1.3"
 gem "haml", "4.0.4"

data/gemfiles/Gemfile.rails-4-2-stable CHANGED

@@ -9,6 +9,7 @@ gem "public_suffix", "~> 1.4.6"
 gem "mime-types", "< 3.0"
 gem "rack", "< 2.0"
 gem "rspec", "~> 3.0.0"
+gem "rspec-its", "~> 1.2.0"
 gem "rails", github: "rails/rails", branch: "4-2-stable"
-gem "shoulda-matchers", "~> 2.0"
+gem "shoulda-matchers", "3.1.3"
 gem "haml", "4.0.4"

data/gemfiles/Gemfile.rails-5-0-stable CHANGED

@@ -2,11 +2,12 @@ source "https://rubygems.org"
 gemspec path: ".."
-# Requires min Ruby version 2.2.2
+# Requires min Ruby version 2.3
-gem "nokogiri", "1.6.8.1"
+gem "nokogiri", "1.10.7"
 gem "capybara"
 gem "rspec", "~> 3.6.0"
+gem "rspec-its", "~> 1.2.0"
 gem "rails", github: "rails/rails", branch: "5-0-stable"
-gem "shoulda-matchers", "~> 2.0"
+gem "shoulda-matchers", "3.1.3"
 gem "haml", "~> 5.0.0"

data/gemfiles/Gemfile.rails-5-1-stable CHANGED

@@ -2,11 +2,12 @@ source "https://rubygems.org"
 gemspec path: ".."
-# Requires min Ruby version 2.2.2
+# Requires min Ruby version 2.3
-gem "nokogiri", "1.6.8.1"
+gem "nokogiri", "1.10.7"
 gem "capybara"
 gem "rspec", "~> 3.6.0"
+gem "rspec-its", "~> 1.2.0"
 gem "rails", github: "rails/rails", branch: "5-1-stable"
-gem "shoulda-matchers", "~> 2.0"
+gem "shoulda-matchers", "3.1.3"
 gem "haml", "~> 5.0.0"

data/gemfiles/Gemfile.rails-5-2-stable ADDED

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+gemspec path: ".."
+# Requires min Ruby version 2.3
+gem "nokogiri", "1.10.7"
+gem "capybara"
+gem "rspec", "~> 3.6.0"
+gem "rspec-its", "~> 1.2.0"
+gem "rails", github: "rails/rails", branch: "5-2-stable"
+gem "shoulda-matchers", "3.1.3"
+gem "haml", "~> 5.0.0"

data/lib/blocks.rb CHANGED

@@ -1,47 +1,55 @@
+# frozen_string_literal: true
 require 'active_support/core_ext/hash'
-require 'active_support/hash_with_indifferent_access'
-require 'blocks/action_view_extensions/view_extensions'
+require 'blocks/helpers/view_extensions'
+require 'blocks/helpers/controller_extensions'
 module Blocks
   extend ActiveSupport::Autoload
+  # The following classes have no direct references when loading the rest
+  #  of the Blocks classes so they must be eager loaded to prevent them
+  #  from having to be loaded during the request
+  #  (http://blog.plataformatec.com.br/2012/08/eager-loading-for-greater-good/)
   eager_autoload do
+    autoload_under 'builders' do
+      autoload :BlockDefinition
+    end
     autoload_under 'renderers' do
-      autoload :Renderer
       autoload :RuntimeContext
-      autoload :AbstractRenderer
-      autoload :PartialRenderer
-      autoload :BlockWithHooksRenderer
-      autoload :AdjacentBlocksRenderer
-      autoload :NestingBlocksRenderer
-      autoload :CollectionRenderer
-      autoload :WrapperRenderer
-      autoload :BlockRenderer
       autoload :BlockPlaceholder
     end
+  end
-    autoload_under 'builders' do
-      autoload :HookDefinition
-      autoload :BlockDefinition
-      autoload :Builder
-    end
+  autoload_under 'renderers' do
+    autoload :Renderer
+    autoload :PartialRenderer
+    autoload :BlockWithHooksRenderer
+    autoload :AdjacentBlocksRenderer
+    autoload :NestingBlocksRenderer
+    autoload :CollectionRenderer
+    autoload :WrapperRenderer
+    autoload :BlockRenderer
+  end
-    autoload_under 'utilities' do
-      autoload :DynamicConfiguration
-      autoload :Configurator
-      autoload :OptionsSet
-      autoload :HashWithRenderStrategy
-      autoload :HashWithCaller
-    end
+  autoload_under 'builders' do
+    autoload :Builder
+    autoload :HookDefinition
   end
-  # WIP
-  # autoload_under 'experimental' do
-  #   autoload :BuilderPermissions
-  #   autoload :InvalidPermissionsHandler
-  # end
+  autoload_under 'utilities' do
+    autoload :Configurator
+    autoload :OptionsSet
+    autoload :HashWithRenderStrategy
+    autoload :HashWithCaller
+  end
-  autoload :Version
+  autoload_under 'helpers' do
+    autoload :HamlCapture
+  end
   include Configurator
 end
+require 'blocks/engine'

data/lib/blocks/builders/block_definition.rb CHANGED

@@ -1,12 +1,17 @@
+# frozen_string_literal: true
 module Blocks
   class BlockDefinition < OptionsSet
-    attr_accessor :options_set,
-                  :skip_content,
-                  :skip_completely,
-                  :anonymous,
-                  *HookDefinition::HOOKS.map {|hook| "#{hook}_hooks" }
+    attr_accessor :skip_content,
+      :skip_completely,
+      :anonymous,
+      :hooks
+    def initialize(*)
+      self.hooks = Hash.new {|hash, key| hash[key] = [] }
+      super
+    end
     def skip(completely=false)
       self.skip_content = true
       self.skip_completely = completely
@@ -20,49 +25,46 @@ module Blocks
       !!skip_completely
     end
-    def hooks_for(hook_name)
-      self.send("#{hook_name}_hooks")
+    def hooks_for(hook_type, initialize_when_missing: false)
+      hooks[hook_type] if initialize_when_missing || hooks.key?(hook_type)
     end
-    HookDefinition::HOOKS.each do |hook|
-      class_eval <<-RUBY, __FILE__, __LINE__ + 1
-        def #{hook}_hooks
-          @#{hook}_hooks ||= []
-        end
-      RUBY
+    def hooks_present?
+      hooks.present?
+    end
-      define_method(hook) do |*args, &block|
-        HookDefinition.new(self, hook, *args, &block).tap do |definition|
-          hooks_for(hook) << definition
+    HookDefinition::HOOKS.each do |hook|
+      define_method(hook) do |*args, &hook_definition|
+        HookDefinition.new(self, hook, *args, &hook_definition).tap do |definition|
+          hooks_for(hook, initialize_when_missing: true) << definition
         end
       end
     end
-    def to_s
-      description = []
-      description << super
-      options = [
-        runtime_options,
-        standard_options,
-        default_options
-      ].detect(&:render_strategy)
-      strategy = options.try(:render_strategy)
-      render_strategy_name = if strategy == HashWithRenderStrategy::RENDER_WITH_PROXY
-        caller_id = options.callers[HashWithRenderStrategy::RENDER_WITH_PROXY]
-        "proxy block \"#{options[strategy]}\""
-      elsif strategy == HashWithRenderStrategy::RENDER_WITH_BLOCK
-        caller_id = options.callers[HashWithRenderStrategy::RENDER_WITH_BLOCK]
-        "block defined at #{options[strategy].source_location}"
-      elsif strategy == HashWithRenderStrategy::RENDER_WITH_PARTIAL
-        caller_id = options.callers[HashWithRenderStrategy::RENDER_WITH_PARTIAL]
-        "partial \"#{options[strategy]}\""
-      end
-      if render_strategy_name
-        description << "Renders with #{render_strategy_name} [#{caller_id}]"
-      end
-      description.join("\n")
-    end
+    # def to_s
+    #   description = []
+    #   description << super
+    #   options = [
+    #     standard_options,
+    #     default_options
+    #   ].detect(&:render_strategy)
+    #
+    #   strategy = options.try(:render_strategy)
+    #   render_strategy_name = if strategy == HashWithRenderStrategy::RENDER_WITH_PROXY
+    #     # caller_id = options.callers[HashWithRenderStrategy::RENDER_WITH_PROXY]
+    #     "proxy block \"#{options[strategy]}\""
+    #   elsif strategy == HashWithRenderStrategy::RENDER_WITH_BLOCK
+    #     # caller_id = options.callers[HashWithRenderStrategy::RENDER_WITH_BLOCK]
+    #     "block defined at #{options[strategy].source_location}"
+    #   elsif strategy == HashWithRenderStrategy::RENDER_WITH_PARTIAL
+    #     # caller_id = options.callers[HashWithRenderStrategy::RENDER_WITH_PARTIAL]
+    #     "partial \"#{options[strategy]}\""
+    #   end
+    #   if render_strategy_name
+    #     # description << "Renders with #{render_strategy_name} [#{caller_id}]"
+    #   end
+    #
+    #   description.join("\n")
+    # end
   end
 end

data/lib/blocks/builders/builder.rb CHANGED

@@ -1,8 +1,10 @@
-require 'call_with_params'
+# frozen_string_literal: true
 module Blocks
   class Builder
-    include CallWithParams
+    if defined?(Haml)
+      prepend HamlCapture
+    end
     # A pointer to the view context
     attr_accessor :view
@@ -11,58 +13,55 @@ module Blocks
     attr_accessor :block_definitions
     # Options provided during initialization of builder
-    attr_accessor :options_set
+    attr_accessor :options
     attr_accessor :anonymous_block_number
-    delegate :content_tag, to: :view
-    delegate :render,
-             :render_with_overrides,
-             :deferred_render,
-             to: :renderer
-    delegate :runtime_options,
-             :standard_options,
-             :default_options,
-             to: :options_set
+    delegate :with_output_buffer, :output_buffer, to: :view
-    CONTENT_TAG_WRAPPER_BLOCK = :content_tag_wrapper
-    def initialize(view, options={})
-      if defined?(::Haml) && !view.instance_variables.include?(:@haml_buffer)
-        class << view
-          include Haml::Helpers
-        end
-        view.init_haml_helpers
-      end
+    def initialize(view, options=nil)
       self.view = view
       self.block_definitions = HashWithIndifferentAccess.new do |hash, key|
         hash[key] = BlockDefinition.new(key); hash[key]
       end
       self.anonymous_block_number = 0
-      self.options_set = OptionsSet.new("Builder Options", options)
-      define_helper_blocks
+      self.options = options
+    end
+    def render(*args, &block)
+      renderer_class.render(self, *args, &block)
+    end
+    def render_with_overrides(*args, &block)
+      warn "[DEPRECATION] `render_with_overrides` is deprecated.  Please use `render` instead."
+      render(*args, &block)
     end
-    def renderer
-      @renderer ||= Blocks.renderer_class.new(self)
+    def deferred_render(*args, &block)
+      renderer_class.deferred_render(self, *args, &block)
     end
     def block_for(block_name)
       block_definitions[block_name] if block_defined?(block_name)
     end
-    def block_defined?(block_name)
-      block_definitions.key?(block_name)
+    def hooks_for(block_name, hook_name)
+      block_for(block_name).try(:hooks_for, hook_name) || []
     end
-    def define_each(collection, block_name_proc, *args, &block)
-      collection.map do |object|
-        define(call_with_params(block_name_proc, object, *args), object, *args, &block)
+    def capture(*args, &block)
+      if block.arity >= 0
+        args = args[0, block.arity]
+      end
+      with_output_buffer do
+        output_buffer << view.capture(*args, &block)
       end
     end
+    def block_defined?(block_name)
+      block_definitions.key?(block_name)
+    end
     # Define a block, unless a block by the same name is already defined.
     #   <%= blocks.define :some_block_name, :parameter1 => "1", :parameter2 => "2" do |options| %>
     #     <%= options[:parameter1] %> and <%= options[:parameter2] %>
@@ -79,16 +78,17 @@ module Blocks
     def define(*args, &block)
       options = args.extract_options!
-      name, anonymous = if args.first
-        [args.shift, false]
+      name = if args.first
+        args.shift
       else
+        anonymous = true
         self.anonymous_block_number += 1
-        ["anonymous_block_#{anonymous_block_number}", true]
+        "anonymous_block_#{anonymous_block_number}"
       end
       block_definitions[name].tap do |block_definition|
-        block_definition.add_options options, &block
-        block_definition.anonymous = anonymous
+        block_definition.reverse_merge! options, &block
+        block_definition.anonymous = !!anonymous
       end
     end
@@ -132,8 +132,7 @@ module Blocks
       options = call_each_hash_value_with_params(options, *args) || {}
       options2 = call_each_hash_value_with_params(options2, *args) || {}
-      options.symbolize_keys.merge(options2.symbolize_keys) do |key, v1, v2|
+      options.merge(options2) do |key, v1, v2|
         if v1.is_a?(String) && v2.is_a?(String)
           "#{v1} #{v2}"
         else
@@ -142,29 +141,66 @@ module Blocks
       end
     end
-    protected
+    # Blocks::Builder#content_tag extends ActionView's content_tag method
+    #  by allowing itself to be used as a wrapper, hook, or called directly,
+    #  while also not requiring the content tag name (defaults to :div).
+    def content_tag(*args, &block)
+      options = args.extract_options!
+      escape = options.key?(:escape) ? options.delete(:escape) : true
+      if wrapper_type = options.delete(:wrapper_type)
+        html_option = options["#{wrapper_type}_html_option".to_sym] || options[:html_option]
+        wrapper_html = if html_option.is_a?(Array)
+          html_option.map { |html_attribute| options[html_attribute] }.compact.first
+        elsif html_option.present?
+          options[html_option]
+        end
-    # TODO: move this logic elsewhere
-    def define_helper_blocks
-      define CONTENT_TAG_WRAPPER_BLOCK, defaults: { wrapper_tag: :div } do |content_block, *args|
-        options = args.extract_options!
-        wrapper_options = if options[:wrapper_html_option]
-          if options[:wrapper_html_option].is_a?(Array)
-            wrapper_attribute = nil
-            options[:wrapper_html_option].each do |attribute|
-              if options[attribute].present?
-                wrapper_attribute = attribute
-                break
-              end
-            end
-            options[wrapper_attribute]
-          else
-            options[options[:wrapper_html_option]]
-          end
+        wrapper_html = concatenating_merge(options["#{wrapper_type}_html".to_sym] || options[:html], wrapper_html, *args, options)
+        wrapper_tag = options["#{wrapper_type}_tag".to_sym]
+      end
+      wrapper_html ||= call_each_hash_value_with_params(options[:html], options).presence || options
+      wrapper_tag ||= options.delete(:tag)
+      if !wrapper_tag
+        first_arg = args.first
+        wrapper_tag = if first_arg.is_a?(String) || first_arg.is_a?(Symbol)
+          args.shift
+        else
+          :div
         end
-        content_tag options[:wrapper_tag],
-          concatenating_merge(options[:wrapper_html], wrapper_options, *args, options),
-          &content_block
+      end
+      content_tag_args = [wrapper_tag]
+      if !block_given?
+        content_tag_args << (wrapper_html.delete(:content) || options[:content] || args.shift)
+      end
+      content_tag_args << wrapper_html
+      content_tag_args << escape
+      view.content_tag *content_tag_args, &block
+    end
+    protected
+    def renderer_class
+      @renderer_class ||= Blocks.renderer_class
+    end
+    def call_with_params(*args)
+      return nil if args.empty?
+      v = args.shift
+      v.is_a?(Proc) ? v.call(*(args[0, v.arity.abs])) : v
+    end
+    def call_each_hash_value_with_params(*args)
+      return {} if args.empty?
+      options = args.shift || {}
+      if options.is_a?(Proc)
+        call_with_params(options, *args)
+      else
+        options.inject(Hash.new) { |hash, (k, v)| hash[k] = call_with_params(v, *args); hash}
       end
     end
   end