pistaa 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b7239fd73ce7ca80d1474305f70792790664cb3
+  data.tar.gz: d05b4023c36ce5a1e7fbda6f6bb8ebba4bb2a698
+SHA512:
+  metadata.gz: 2eb36ef4ea922e0d65e4ca7f4421e3a12be64e8d9f8ef5fffc887a3745bade86ae927d91a0acb336c69fc0129e5effa93d4185fdd138b9b9dbd7c5b4cbcaea53
+  data.tar.gz: b6a0abdef259f6d165e74f7c0d9e3c64c12df900e053687de20fd027ec70003ca788a95d7c848fb5fafde93a98f707fc0f3b276acc94223cea5b4d34f9569f2b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Rolf van de Krol
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+# Pistaa
+
+Simple structure for Ruby on Rails that allows templates for engines to accept 
+injected content from other engines.
+
+Suppose you are creating a modular product that consists of a main engine and
+some engines that can be used to extend the main engine. When some of the
+optional engines are enabled, you probably want to alter a template in the main
+engine, to show functionality that is included in one of the optional engines.
+But if you change the main engine to cater the needs of all optional engine, the
+main engine becomes a spaghetti of code for the optional engines.
+
+Pistaa provides another solution to this problem. It allows you to define 
+*slots* where other engines can inject *partials* so your main engine only has
+to call Pistaa to render a slot and automatically all injected partials will be
+rendered.
+
+## Usage
+
+Add Pistaa to the `gemspec` of your main engine.
+
+```ruby
+s.add_dependency "pistaa"
+```
+
+Change a template in the main engine to render a *slot* where other engines can
+inject *partials*. So let's change `news/show.html.erb`.
+
+```erb
+<%= render_pistaa_slot :news_body %>
+```
+
+Then, in one of the optional engines, register a *partial* in the *slot*.
+
+```ruby
+module MyEngine
+  class Engine < ::Rails::Engine
+    def self.activate
+      Pistaa[:news_body][:my_engine_content] = 'my_engine/news/my_engine_content'
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end
+```
+
+And make sure the template `my_engine/news/_my_engine_content.html.erb` exists. 
+This will be rendered just like any other partial, so you can use all the 
+instance variables that are available to the template in the main engine.
+
+Because Pistaa does not hijack the rendering logic in any way (it only provides
+simple helpers that loop over the *partials* in a *slot* and calls
+`render partial: 'path/to/partial'` for each partial), all functionality that
+Rails uses for rendering views is still available. So you can render other 
+partials for the injected partial, you can use any template language you like
+and you can even call Pistaa again from the injected partial.
+
+Because it essentially is simple partial rendering, overriding templates also
+works as expected. So if the application that uses both the main engine and
+MyEngine defines `my_engine/news/_my_engine_content.html.erb`, it will override
+the template from MyEngine.
+
+If the main application overrides the template `news/show.html.erb`, Pistaa
+exposes some helpers that allow the overriding template to control the order of
+the partials in the slot. Check `app/helpers/pistaa_helper.rb` for more 
+information. Smart combination of `render_pistaa_slot`, 
+`render_pistaa_slot_item` and `hide_pistaa_slot_item` will probably serve your
+needs.
+
+## Inspiration
+
+I'm aware of one other project that tries to solve this problem, but in a
+completely different way. [Deface](https://github.com/spree/deface is tool that
+was used in older versions of [Spree](https://spreecommerce.com/) and also 
+provides a way to alter templates from engines. It parses ERB templates to an
+XML structure using Nokogiri, exposes a DSL to manipulate the Nokogiri document
+and renders the document back to ERB. Although it works, it is quite error
+prone. Currently, it's stable versions only support Rails 3.
+
+The way `hide_pistaa_slot_item`, `render_pistaa_slot_item` and 
+`render_pistaa_slot` work, is inspired by [Drupal](https://drupal.org/)'s render
+arrays.
+
+## Roadmap
+
+The first thing that will be added to this gem, is a way to control the order
+of the partials from the engines.

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Pistaa'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/helpers/pistaa_helper.rb

@@ -0,0 +1,44 @@
+module PistaaHelper
+
+  # Render all templates in the slot, but skip the items that are registered as
+  # hidden. It repeatedly calls `render_pistaa_slot_item`, so the rendered
+  # templates will be registered as hidden.
+  def render_pistaa_slot(slot)
+    pistaa_slot_items(slot).map do |item|
+      next if pistaa_slot_item_hidden?(slot, item)
+
+      render_pistaa_slot_item(slot, item)
+    end.join("\n").html_safe
+  end
+
+  # Render a specific template from a slot (regardless of it was hidden), and
+  # register it as hidden, so it won't be rendered if `render_pistaa_slot` is 
+  # called. 
+  def render_pistaa_slot_item(slot, item)
+    hide_pistaa_slot_item(slot, item)
+    render partial: Pistaa[slot][item]
+  end
+
+  # List all the keys of the items in the slot.
+  def pistaa_slot_items(slot)
+    Pistaa[slot].item_keys
+  end
+
+  # Helper to access the hidden items. You shouldn't need to access this helper
+  # from the template. Use `pistaa_slot_item_hidden?` and 
+  #{ }`hide_pistaa_slot_item` instead.
+  def pistaa_hidden_items
+    @pistaa_hidden_items ||= []
+  end
+
+  # Register a template as hidden, so it won't be rendered with 
+  # `render_pistaa_slot`.
+  def hide_pistaa_slot_item(slot, item)
+    pistaa_hidden_items << [slot, item]
+  end
+
+  # Check if a template is hidden.
+  def pistaa_slot_item_hidden?(slot, item)
+    pistaa_hidden_items.include? [slot, item]
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/pistaa.rb

@@ -0,0 +1,42 @@
+require "pistaa/engine"
+
+module Pistaa
+  class << self
+    def [](slot_key)
+      slots[slot_key]
+    end
+
+    def slot_keys
+      slots.keys
+    end
+
+    protected
+
+    def slots
+      @slots ||= Hash.new do |hash, key| 
+        hash[key] = Pistaa::Slot.new
+      end
+    end
+  end
+
+  class Slot
+    def [](item_key)
+      raise IndexError if items[item_key.to_sym].nil?
+      items[item_key.to_sym]
+    end
+
+    def []=(item_key, template)
+      items[item_key.to_sym] = template
+    end
+
+    def item_keys
+      items.keys
+    end
+
+    protected
+
+    def items
+      @items ||= Hash.new
+    end
+  end
+end

data/lib/pistaa/engine.rb

@@ -0,0 +1,4 @@
+module Pistaa
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/pistaa/version.rb

@@ -0,0 +1,3 @@
+module Pistaa
+  VERSION = "0.0.1"
+end

data/lib/tasks/pistaa_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :pistaa do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: pistaa
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rolf van de Krol
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+description: Simple structure that allows extending templates from engines.
+email:
+- info@rolfvandekrol.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/helpers/pistaa_helper.rb
+- config/routes.rb
+- lib/pistaa.rb
+- lib/pistaa/engine.rb
+- lib/pistaa/version.rb
+- lib/tasks/pistaa_tasks.rake
+homepage: https://github.com/rolfvandekrol/pistaa
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Template extension helper
+test_files: []