active_path 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 212776f05fd76c2a04a29697b2136ac5b07b9ecf
-  data.tar.gz: 5638ceb2a84610ad98e0b5ffec0adc53c81a4b9c
+  metadata.gz: 8794ff562056311cf10ac54cf375f96986a96de3
+  data.tar.gz: 176ef110a98d119a2f15329d39fdc631754bb87e
 SHA512:
-  metadata.gz: 4766f9ad22588546c2f819d0124d609f94c4d22c9bed2570379386ac181f6a503afec8b4126398986e887be3ec2cffd1153af111895fb368997da8180d40a192
-  data.tar.gz: ee97a9efdf88b22b8399b6f2b68dcdf9aa06164a7812dbcce1ab977c4e39663b493963a908e9caa84289e927aff5bafc922f81bd3fea5134d326bd9fefe6939e
+  metadata.gz: da11c5dddf9a1ab9abec7da09634a2e4c9eb066e9b7e2068ae2f749249210f6008c096daa7368fa147bd02504f5fab6c653aa19535ace0ecebf72d5984bb2774
+  data.tar.gz: e362383364329d229a2844f317f433daa3ebd6dd1dcbdeedcd89689dafee359c8715f35d51b75731ad185c591fad478beef18a0bea2b301f9928c63beb178ddc

data/README.md

@@ -50,18 +50,23 @@ config.partials.append('pages/content').with('example/test')
 ```
 
 
-With the above configuration 'example/test' will be rendered after 'pages/content'.
+The above renders 'example/test' after 'pages/content'.
 
 --
 
 **Conditions:**
 
-The `when` condition gives you the ability to conditionally apply your partial.
+The `when` method allows you to conditionally inject your view. Consider this partial:
 
+```ruby
+render partial: 'pages/content', locals: { page_id: 9 }
+```
+
+You can pass in a hash which must match the local variables.
 
 ```ruby
 
-config.partials.append('pages/content').with('example/test').when(title: 'Welcome')
+config.partials.append('pages/content').with('example/test').when(page_id: 9)
 
 ```
 
@@ -70,7 +75,7 @@ Or pass in a block for more flexibility with your conditions:
 ```ruby
 
 config.partials.append('pages/content').with('example/test').when do |locals|
-  locals[:title] == 'Welcome'
+  locals[:page_id] == 9
 end
 
 ```
@@ -93,7 +98,7 @@ HTML comments are added before and after each partial. Here is the output from o
 <p>page content</p>
 <!-- end pages/content -->
 <!-- start example/test -->
-<p>example test</p>
+<p>example content</p>
 <!-- end example/test -->
 
 ```

data/lib/active_path/{renderer → conditions}/conditional.rb

@@ -1,5 +1,5 @@
 module ActivePath
-  module Renderer
+  module Conditions
     module Conditional
       def conditions_match?(conditions)
         conditions.all? do |condition|

data/lib/active_path/engine.rb

@@ -1,3 +1,5 @@
+require 'active_path/subscribers/view_injection'
+require 'active_path/subscribers/path_hints'
 require 'active_path/helpers/rendering_helper'
 module ActivePath
   class Engine < Rails::Engine
@@ -12,5 +14,12 @@ module ActivePath
         _helpers.module_eval { include ActivePath::Helpers::RenderingHelper }
       end
     end
+
+    config.after_initialize do
+      if ActivePath.config.path_hints
+        ActiveSupport::Notifications.subscribe(:render_partial, Subscribers::PathHints.new)
+      end
+      ActiveSupport::Notifications.subscribe(:render_partial, Subscribers::ViewInjection.new)
+    end
   end
 end

data/lib/active_path/helpers/rendering_helper.rb

@@ -1,13 +1,13 @@
-require 'active_path/renderer/partial_renderer'
 module ActivePath
   module Helpers
     module RenderingHelper
       extend ActionView::Helpers::RenderingHelper
-      # Delegate rendering to the activepath renderer
+      # Notify subscribers that a partial has rendered
       def render(options = {}, locals = {}, &block)
-        Renderer::PartialRenderer.new(self, options).render do
-          super
-        end
+        buffer = super
+        opts = { buffer: buffer, context: self, options: options }
+        ActiveSupport::Notifications.instrument(:render_partial, opts)
+        buffer
       end
     end
   end

data/lib/active_path/{renderer → subscribers}/path_hints.rb

@@ -1,12 +1,10 @@
+require 'active_path/subscribers/subscriber'
 module ActivePath
-  module Renderer
-    module PathHints
-      def start_path_hints(output_buffer)
-        output_buffer.prepend("<!-- start #{partial_name}#{with_local_variables.to_s} --!>".html_safe)
-      end
-
-      def end_path_hints(output_buffer)
-        output_buffer.concat("<!-- end #{partial_name} --!>".html_safe)
+  module Subscribers
+    class PathHints < Subscriber
+      def perform
+        buffer.prepend("<!-- start #{partial}#{with_local_variables.to_s} --!>".html_safe)
+        buffer.concat("<!-- end #{partial} --!>".html_safe)
       end
 
       private

data/lib/active_path/subscribers/subscriber.rb

@@ -0,0 +1,22 @@
+module ActivePath
+  module Subscribers
+    class Subscriber
+      attr_reader :buffer, :context, :options
+
+      def call(name, started, finished, unique_id, payload)
+        @buffer = payload[:buffer]
+        @context = payload[:context]
+        @options = payload[:options]
+        perform
+      end
+
+      def partial
+        options.is_a?(Hash) ? options[:partial] : options.to_s
+      end
+
+      def perform
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/active_path/subscribers/view_injection.rb

@@ -0,0 +1,41 @@
+require 'active_path/subscribers/subscriber'
+require 'active_path/conditions/conditional'
+module ActivePath
+  module Subscribers
+    class ViewInjection < Subscriber
+      include Conditions::Conditional
+
+      def perform
+        prepend_attachments.each do |attachment|
+          buffer.prepend(render_attachment(attachment))
+        end
+
+        append_attachments.each do |attachment|
+          buffer.concat(render_attachment(attachment))
+        end
+      end
+
+      private
+
+      def append_attachments
+        attachments(ActivePath.config.partials.append(partial))
+      end
+
+      def prepend_attachments
+        attachments(ActivePath.config.partials.prepend(partial))
+      end
+
+      def attachments(configuration)
+        configuration.attachments.select do |attachment|
+          conditions_match?(attachment.conditions)
+        end
+      end
+
+      def render_attachment(attachment)
+        hash = { partial: attachment.partial }
+        options_hash = options.is_a?(Hash) ? options.merge(hash) : hash
+        context.render(options_hash)
+      end
+    end
+  end
+end

data/lib/active_path/version.rb

@@ -1,3 +1,3 @@
 module ActivePath
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_path
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Ryan Tulino
@@ -35,15 +35,16 @@ files:
 - Rakefile
 - active_path.gemspec
 - lib/active_path.rb
+- lib/active_path/conditions/conditional.rb
 - lib/active_path/configuration.rb
 - lib/active_path/configuration/attachment.rb
 - lib/active_path/configuration/partial.rb
 - lib/active_path/configuration/partials.rb
 - lib/active_path/engine.rb
 - lib/active_path/helpers/rendering_helper.rb
-- lib/active_path/renderer/conditional.rb
-- lib/active_path/renderer/partial_renderer.rb
-- lib/active_path/renderer/path_hints.rb
+- lib/active_path/subscribers/path_hints.rb
+- lib/active_path/subscribers/subscriber.rb
+- lib/active_path/subscribers/view_injection.rb
 - lib/active_path/version.rb
 homepage: http://rubygems.org/gems/active_path
 licenses: []

data/lib/active_path/renderer/partial_renderer.rb

@@ -1,73 +0,0 @@
-require 'active_path/renderer/conditional'
-require 'active_path/renderer/path_hints'
-module ActivePath
-  module Renderer
-    class PartialRenderer
-      attr_reader :context, :options
-      include Conditional
-      include PathHints
-
-      def initialize(context, options = {})
-        @context = context
-        @options = options
-      end
-
-      def render
-        output_buffer = yield
-        prepend_to(output_buffer)
-        append_to(output_buffer)
-        output_buffer
-      end
-
-      private
-
-      def prepend_to(output_buffer)
-        start_path_hints(output_buffer) if ActivePath.config.path_hints
-
-        prepend_attachments.each do |attachment|
-          output_buffer.prepend(render_attachment(attachment))
-        end
-      end
-
-      def append_to(output_buffer)
-        end_path_hints(output_buffer) if ActivePath.config.path_hints
-
-        append_attachments.each do |attachment|
-          output_buffer.concat(render_attachment(attachment))
-        end
-      end
-
-      def append_attachments
-        attachments(partials.append(partial_name))
-      end
-
-      def prepend_attachments
-        attachments(partials.prepend(partial_name))
-      end
-
-      def attachments(partial)
-        partial.attachments.select do |attachment|
-          conditions_match?(attachment.conditions)
-        end
-      end
-
-      def partials
-        ActivePath.config.partials
-      end
-
-      def partial_name
-        options.is_a?(Hash) ? options[:partial] : options.to_s
-      end
-
-      def render_attachment(attachment)
-        options_hash = attachment_options(attachment.partial)
-        context.render(options_hash)
-      end
-
-      def attachment_options(partial_name)
-        hash = { partial: partial_name }
-        options.is_a?(Hash) ? options.merge(hash) : hash
-      end
-    end
-  end
-end