active_path-view_injection 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 970eba4c3d5a9ccaf4a6268efefe1fb56f019fa0
+  data.tar.gz: 0d9787274fcb67398fba02b3e430f9e008022574
+SHA512:
+  metadata.gz: cbc7a68086c86b838106116dde827b2ae0e6faedc04022ee32a0035d35208d1ca1ed63125bc39fc8b11c79158f2364ad2ab2d3523d9e729909e31a5134c3ad31
+  data.tar.gz: '038734bd1bd82e046997a3fbba0e2858db348d1c01edd084c27bbd639106e9d93bee908b2c0b13aeca3c7003921197e20e288c34b97f52026f032752692e4a29'

data/.gitignore

@@ -0,0 +1 @@
+.idea

data/README.md

@@ -0,0 +1,82 @@
+# ActivePath View Injection: 
+View injection for your partials.
+
+
+## Installation 
+
+Add to your Gemfile:
+
+```ruby
+gem 'active_path-view_injection'
+```
+
+Add the initializer `config/initializers/active_path.rb` and enable `ActivePath`:
+
+```ruby
+
+ActivePath.configure do |config|
+
+  config.enabled = true
+
+end
+
+```
+
+
+**View injection:**
+
+```ruby
+
+ActivePath.configure do |config|
+
+  ...
+
+  config.partials.prepend('pages/content').with('example/test')
+
+end
+
+```
+
+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. You can also use `append`:
+
+```ruby
+
+config.partials.append('pages/content').with('example/test')
+
+```
+
+
+The above renders 'example/test' after 'pages/content'.
+
+--
+
+**Conditions:**
+
+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(page_id: 9)
+
+```
+
+Or pass in a block for more flexibility with your conditions:
+
+```ruby
+
+config.partials.append('pages/content').with('example/test').when do |locals|
+  locals[:page_id] == 9
+end
+
+```
+
+
+Feel free to [submit issues](https://github.com/active-path/view-injection/issues) or [help make it better](https://github.com/active-path/view-injection/pulls). 

data/Rakefile

@@ -0,0 +1,15 @@
+#!/usr/bin/env rake
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'active_path/view_injection/version'
+
+desc "Release version #{ActivePath::ViewInjection::VERSION} of the gem"
+task :release do
+
+  system "git tag -a v#{ActivePath::ViewInjection::VERSION} -m 'Tagging #{ActivePath::ViewInjection::VERSION}'"
+  system 'git push --tags'
+
+  system "gem build active_path-view_injection.gemspec"
+  system "gem push active_path-view_injection-#{ActivePath::ViewInjection::VERSION}.gem"
+  system "rm active_path-view_injection-#{ActivePath::ViewInjection::VERSION}.gem"
+end

data/active_path-view_injection.gemspec

@@ -0,0 +1,17 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'active_path/view_injection/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'active_path-view_injection'
+  s.version     = ActivePath::ViewInjection::VERSION
+  s.date        = '2018-04-28'
+  s.summary     = "ActivePath View Injection"
+  s.description = "Inject partials before or after other partials!"
+  s.authors     = ["Ryan Tulino"]
+  s.email       = 'rtulino@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = 'http://rubygems.org/gems/active_path-view_injection'
+  s.required_ruby_version = '>= 2.2.0'
+  s.add_dependency 'rails', '~> 5'
+  s.add_dependency 'active_path', '~> 0.1.0'
+end

data/lib/active_path/view_injection.rb

@@ -0,0 +1 @@
+require 'active_path/view_injection/engine'

data/lib/active_path/view_injection/conditions/conditional.rb

@@ -0,0 +1,31 @@
+module ActivePath
+  module ViewInjection
+    module Conditions
+      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
+end

data/lib/active_path/view_injection/configuration/attachment.rb

@@ -0,0 +1,19 @@
+module ActivePath
+  module ViewInjection
+    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
+end

data/lib/active_path/view_injection/configuration/partial.rb

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

data/lib/active_path/view_injection/configuration/partials.rb

@@ -0,0 +1,28 @@
+require 'active_path/view_injection/configuration/partial'
+module ActivePath
+  module ViewInjection
+    module Configuration
+      class Partials
+        attr_reader :partials
+
+        def initialize
+          @partials = {}
+        end
+
+        def prepend(key)
+          partial(key, true)
+        end
+
+        def append(key)
+          partial(key, false)
+        end
+
+        private
+
+        def partial(key, prepend = true)
+          @partials["#{key}/#{prepend}"] ||= Partial.new
+        end
+      end
+    end
+  end
+end

data/lib/active_path/view_injection/engine.rb

@@ -0,0 +1,17 @@
+require 'active_path/view_injection/configuration/partials'
+require 'active_path/view_injection/subscriber'
+module ActivePath
+  module ViewInjection
+    class Engine < Rails::Engine
+      isolate_namespace ActivePath::ViewInjection
+
+      config.before_configuration do
+        config.active_path.partials = Configuration::Partials.new
+      end
+
+      config.after_initialize do
+        ActiveSupport::Notifications.subscribe(:render_partial, Subscriber.new)
+      end
+    end
+  end
+end

data/lib/active_path/view_injection/subscriber.rb

@@ -0,0 +1,41 @@
+require 'active_path/view_injection/conditions/conditional'
+require 'active_path/subscribers/subscriber'
+module ActivePath
+  module ViewInjection
+    class Subscriber < Subscribers::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/view_injection/version.rb

@@ -0,0 +1,5 @@
+module ActivePath
+  module ViewInjection
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: active_path-view_injection
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Tulino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: active_path
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: Inject partials before or after other partials!
+email: rtulino@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- Rakefile
+- active_path-view_injection.gemspec
+- lib/active_path/view_injection.rb
+- lib/active_path/view_injection/conditions/conditional.rb
+- lib/active_path/view_injection/configuration/attachment.rb
+- lib/active_path/view_injection/configuration/partial.rb
+- lib/active_path/view_injection/configuration/partials.rb
+- lib/active_path/view_injection/engine.rb
+- lib/active_path/view_injection/subscriber.rb
+- lib/active_path/view_injection/version.rb
+homepage: http://rubygems.org/gems/active_path-view_injection
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: ActivePath View Injection
+test_files: []