active_path 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11521118a9c1286cbef1df712f650ecad8e146c8
-  data.tar.gz: c669aa1ecef84937035bba5a4a8ed457671ee7a1
+  metadata.gz: 212776f05fd76c2a04a29697b2136ac5b07b9ecf
+  data.tar.gz: 5638ceb2a84610ad98e0b5ffec0adc53c81a4b9c
 SHA512:
-  metadata.gz: 6748d8386d87b2d375110dc783a02dd38904fedfe7d383631a820cbfec33be4faf45f0da1a9d5bcaf72ec7542ccce781eea389d4361e9e8cc7213bf195ed8422
-  data.tar.gz: '048da2e8401bb24de04b27d6a9f280dd6cbfa33f4780ba7dfbca9da86d4493ae419bd4f05959149c6f1b7ef8f83aad396333c650047873b8c004479ac12ba5f2'
+  metadata.gz: 4766f9ad22588546c2f819d0124d609f94c4d22c9bed2570379386ac181f6a503afec8b4126398986e887be3ec2cffd1153af111895fb368997da8180d40a192
+  data.tar.gz: ee97a9efdf88b22b8399b6f2b68dcdf9aa06164a7812dbcce1ab977c4e39663b493963a908e9caa84289e927aff5bafc922f81bd3fea5134d326bd9fefe6939e

data/README.md

@@ -33,34 +33,68 @@ ActivePath.configure do |config|
 
   ...
 
-  config.partials.prepend('page_content').with('example/test')
+  config.partials.prepend('pages/content').with('example/test')
 
 end
 
 ```
 
-The above example assumes your application renders a partial called 'page_content' and you want to `prepend` a partial called 'example/test'.
+The above example assumes your application renders a partial called 'pages/content' and you want to `prepend` a partial called 'example/test'.
 
-Your partial will have the same local parameters access as the prepended partial.
+Your partial will have the same local parameters access as the prepended partial. You can also use `append`:
 
+```ruby
+
+config.partials.append('pages/content').with('example/test')
+
+```
+
+
+With the above configuration 'example/test' will be rendered after 'pages/content'.
 
 --
 
-**Path hints:** (use in development only)
+**Conditions:**
+
+The `when` condition gives you the ability to conditionally apply your partial.
 
 
 ```ruby
 
-ActivePath.configure do |config|
+config.partials.append('pages/content').with('example/test').when(title: 'Welcome')
 
-  ...
+```
+
+Or pass in a block for more flexibility with your conditions:
 
-  config.path_hints = true
+```ruby
 
+config.partials.append('pages/content').with('example/test').when do |locals|
+  locals[:title] == 'Welcome'
 end
 
+```
+
+--
+
+**Path hints:** (use in development only)
+
+
+```ruby
+
+config.path_hints = true
+
 ```  
 
-HTML comments are added before and after each partial.
+HTML comments are added before and after each partial. Here is the output from our above examples:
+
+```html
+<!-- start pages/content -->
+<p>page content</p>
+<!-- end pages/content -->
+<!-- start example/test -->
+<p>example test</p>
+<!-- end example/test -->
 
+```
 Feel free to [submit issues](https://github.com/ryaan-anthony/active-path/issues) or [help make it better](https://github.com/ryaan-anthony/active-path/pulls). 

data/lib/active_path/configuration/attachment.rb

@@ -0,0 +1,17 @@
+module ActivePath
+  module Configuration
+    class Attachment
+      attr_reader :partial, :conditions
+
+      def initialize(partial)
+        @partial = partial
+        @conditions = []
+      end
+
+      def when(condition = nil, &block)
+        @conditions << (condition || block)
+        self
+      end
+    end
+  end
+end

data/lib/active_path/configuration/partial.rb

@@ -1,15 +1,16 @@
+require 'active_path/configuration/attachment'
 module ActivePath
   module Configuration
     class Partial
       attr_reader :attachments
 
-      def initialize(key)
-        @key = key
+      def initialize
         @attachments = []
       end
 
-      def with(args)
-        @attachments << args
+      def with(partial_name)
+        @attachments << Attachment.new(partial_name)
+        @attachments.last
       end
     end
   end

data/lib/active_path/configuration/partials.rb

@@ -19,7 +19,7 @@ module ActivePath
       private
 
       def partial(key, prepend = true)
-        @partials["#{key}/#{prepend}"] ||= Partial.new(key)
+        @partials["#{key}/#{prepend}"] ||= Partial.new
       end
     end
   end

data/lib/active_path/renderer/conditional.rb

@@ -0,0 +1,29 @@
+module ActivePath
+  module Renderer
+    module Conditional
+      def conditions_match?(conditions)
+        conditions.all? do |condition|
+          condition_match?(condition)
+        end
+      end
+
+      def condition_match?(condition)
+        if condition.is_a?(Hash)
+          hash_match?(condition)
+        elsif condition.is_a?(Proc)
+          proc_match?(condition)
+        end
+      end
+
+      def hash_match?(condition)
+        condition.all? do |k,v|
+          options[:locals][k] == v
+        end
+      end
+
+      def proc_match?(condition)
+        condition.call(options[:locals])
+      end
+    end
+  end
+end

data/lib/active_path/renderer/partial_renderer.rb

@@ -1,7 +1,11 @@
+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
@@ -10,16 +14,42 @@ module ActivePath
 
       def render
         output_buffer = yield
-        partials.prepend(partial_name).attachments.each do |attachment|
+        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
-        partials.append(partial_name).attachments.each do |attachment|
+      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
-        output_buffer
       end
 
-      private
+      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
@@ -30,12 +60,12 @@ module ActivePath
       end
 
       def render_attachment(attachment)
-        options_hash = attachment_options(attachment)
+        options_hash = attachment_options(attachment.partial)
         context.render(options_hash)
       end
 
-      def attachment_options(attachment)
-        hash = { partial: attachment }
+      def attachment_options(partial_name)
+        hash = { partial: partial_name }
         options.is_a?(Hash) ? options.merge(hash) : hash
       end
     end

data/lib/active_path/renderer/path_hints.rb

@@ -0,0 +1,25 @@
+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)
+      end
+
+      private
+
+      def with_local_variables
+        if options.is_a?(Hash)
+          variables = options[:locals].map do |k,v|
+            count = (" (#{v.count})" if v.is_a?(Array)).to_s
+            "#{k} => #{v.class}#{count}"
+          end
+          "\nwith local variables: #{JSON.pretty_generate(variables)}"
+        end
+      end
+    end
+  end
+end

data/lib/active_path/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_path
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ryan Tulino
@@ -36,12 +36,14 @@ files:
 - active_path.gemspec
 - lib/active_path.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/path_hints.rb
+- lib/active_path/renderer/conditional.rb
 - lib/active_path/renderer/partial_renderer.rb
+- lib/active_path/renderer/path_hints.rb
 - lib/active_path/version.rb
 homepage: http://rubygems.org/gems/active_path
 licenses: []

data/lib/active_path/path_hints.rb

@@ -1,7 +0,0 @@
-module ActivePath
-  module PathHints
-
-    #TODO
-
-  end
-end