blue_tree 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.8.7" > .rvmrc
+environment_id="ruby-1.8.7-p370@blue_tree"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.15.8 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in blue_tree.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Andy White
+
+MIT License
+
+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,100 @@
+# BlueTree
+
+Bluetree is a module of methods which allow you to create composable view 
+classes. Each class instance is initialized with an ERB template. The 
+templates of these views have access to all local instance variables and 
+methods plus access to the immediate parent and root node objects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'blue_tree'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blue_tree
+
+## Usage
+
+Say you wanted to create a composite view using a couple of different classes:
+
+    require 'blue_tree'
+    
+    class Page
+      include BlueTree::Node
+      use_template_path "path/to/my/templates" # defaults to "YOUR_GEM_PATH/templates"
+      use_template_ext  ".foo.erb"             # defaults to ".html.erb"
+      
+      attr_reader :page_title, :introduction, :conclusion
+      # More Page specific code...
+    end
+    
+    class Section
+      include BlueTree::Node
+
+      attr_reader :title, :description
+      # More Section specific code...
+    end
+    
+Set up your nodes (The symbol argument is the basename of the ERB template 
+file):
+    
+    main_page   = Page.new(:page_template)
+    section     = Section.new(:section_template)
+    sub_section = Section.new(:sub_section_template)
+    
+Compose your nodes:
+
+    section.add_child sub_section
+    main_page.add_child section
+    
+What you can reference in the templates:
+
+  * any methods and variables in the current object
+  * *children_nodes* - returns an array of child node objects
+  * *parent_node* - returns the immediate parent object
+  * *root_node* - returns the root object
+
+So for example, the sub_section template might look like this:
+
+    <h2><%= title %> (Part of the <%= root_node.page_title %> series)</h2>
+    <p>This follows on from the <%= parent_node.title %> section.</p>
+    <p><%= description %></p>
+    
+It's up to the templates to render any children nodes - so the main page 
+template might look like this (the trailing dash notation is accepted):
+
+    <h1><%= page_title %></h1>
+    <p><%= introduction %></p>
+    <% child_nodes.each do |c| -%>
+      <%= c.render %>
+    <% end -%>
+    <p><%= conclusion %></p>
+
+Rendering:
+    
+    main_page.render # => returns the recursively rendered string
+    
+### Rendering arbitrary templates
+
+You can also render templates not associated with any nodes by using the 
+*render_template* method. This can be useful if you want to reuse common
+templates like headers or footers. The template must exist in your
+*template_path*. Like any node, it has access to all variables and methods in the 
+current object, the parent object and the root object:
+
+    ...
+    <%= render_template(:common_footer_template) %>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/blue_tree.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blue_tree/version'
+
+Gem::Specification.new do |s|
+  s.name          = "blue_tree"
+  s.version       = BlueTree::VERSION
+  s.authors       = ["Andy White"]
+  s.email         = ["andy@wireworldmedia.co.uk"]
+  s.description   = %q{Build composite ERB templates}
+  s.summary       = %q{Bluetree is a module of methods which allow you to create composable view 
+classes. Each class instance is initialized with an ERB template. The 
+templates of these views have access to all local instance variables and 
+methods plus access to the immediate parent and root node objects.}
+  s.homepage      = ""
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+  s.add_development_dependency "rspec", ">= 0"
+end

data/fixtures/child1.txt.erb

@@ -0,0 +1,7 @@
+<%= title %>
+
+<%= description %>
+
+<% child_nodes.each do |c| -%>
+<%= c.render -%>
+<% end -%>

data/fixtures/child2.txt

@@ -0,0 +1,7 @@
+Section 1.1
+
+The root is titled 'The Main Title'.
+
+This is a child of 'Section 1'.
+
+Section 1.1 description...

data/fixtures/child2.txt.erb

@@ -0,0 +1,7 @@
+<%= title %>
+
+The root is titled '<%= root_node.page_title %>'.
+
+This is a child of '<%= parent_node.title %>'.
+
+<%= description %>

data/fixtures/child3.txt

@@ -0,0 +1,9 @@
+Section 1.2
+
+Section 1.2 description...
+
+----
+This is the footer.
+This title is 'Section 1.2'.
+Parent title is 'Section 1'.
+Root title is 'The Main Title'.

data/fixtures/child3.txt.erb

@@ -0,0 +1,6 @@
+<%= title %>
+
+<%= description %>
+
+----
+<%= render_template :footer %>

data/fixtures/footer.txt.erb

@@ -0,0 +1,4 @@
+This is the footer.
+This title is '<%= title %>'.
+Parent title is '<%= parent_node.title %>'.
+Root title is '<%= root_node.page_title %>'.

data/fixtures/page.foo.erb

@@ -0,0 +1,5 @@
+page start
+<% children.each do |child| -%>
+<%= child.render %>
+<% end -%>
+page end

data/fixtures/page.txt

@@ -0,0 +1,17 @@
+The Main Title
+
+The introduction...
+
+Section 1
+
+Section 1 description...
+
+Section 1.1
+
+The root is titled 'The Main Title'.
+
+This is a child of 'Section 1'.
+
+Section 1.1 description...
+
+The conclusion...

data/fixtures/page.txt.erb

@@ -0,0 +1,9 @@
+<%= page_title %>
+
+<%= introduction %>
+
+<% child_nodes.each do |c| -%>
+<%= c.render %>
+<% end -%>
+
+<%= conclusion %>

data/lib/blue_tree.rb

@@ -0,0 +1,2 @@
+require "blue_tree/version"
+require "blue_tree/node"

data/lib/blue_tree/node.rb

@@ -0,0 +1,75 @@
+require 'erb'
+
+module BlueTree
+  module Node
+    attr_reader :child_nodes, :parent_node, :root_node
+    
+    module ClassMethods
+      def use_template_path(path)
+        @template_path = path
+      end
+      
+      def template_path
+        @template_path
+      end
+    
+      def use_template_ext(ext)
+        @template_ext = ext
+      end
+    
+      def template_ext
+        @template_ext
+      end
+    end
+  
+    def self.included(base)
+      base.extend ClassMethods
+      base.use_template_path(
+        File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'templates'))
+      )
+      base.use_template_ext '.html.erb'
+    end
+    
+    def initialize(template_symbol)
+      @template = template_contents(template_symbol)
+      @child_nodes = []
+      @parent_node = nil
+      @root_node = nil
+    end
+    
+    def template_path
+      self.class.template_path
+    end
+    
+    def template_ext
+      self.class.template_ext
+    end
+    
+    def template_contents(template_symbol)
+      File.read(File.join(template_path, "#{template_symbol}#{template_ext}"))
+    end
+    
+    def add_child(child)
+      child.set_root_node(@root_node || self)
+      child.set_parent_node self
+      @child_nodes << child
+    end
+    
+    def set_root_node(root_node)
+      @root_node = root_node
+      child_nodes.each { |child| child.set_root_node(root_node) }
+    end
+    
+    def set_parent_node(parent)
+      @parent_node = parent
+    end
+  
+    def render
+      ERB.new(@template, nil, '-').result(binding)
+    end
+    
+    def render_template(template_symbol)
+      ERB.new(template_contents(template_symbol), nil, '-').result(binding)
+    end
+  end
+end

data/lib/blue_tree/version.rb

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

data/spec/helper.rb

@@ -0,0 +1,4 @@
+def fixtures(path = nil)
+  fixtures_path = File.join(File.dirname(__FILE__), '..', 'fixtures')
+  path.nil? ? fixtures_path : File.join(fixtures_path, path)
+end

data/spec/node_spec.rb

@@ -0,0 +1,112 @@
+require 'blue_tree/node'
+require File.dirname(__FILE__) + '/helper'
+
+describe BlueTree::Node do
+  describe "Class defaults and settings" do
+    before(:each) do
+      class Foo
+        include BlueTree::Node
+        use_template_path fixtures
+        use_template_ext  ".foo.erb"
+      end
+      
+      class Bar
+        include BlueTree::Node
+      end
+    end
+    
+    it "template_path set correctly" do
+      Foo.template_path.should == fixtures
+      Bar.template_path.should == File.expand_path(File.join(File.dirname(__FILE__), '..', 'templates'))
+    end
+
+    it "template_ext set correctly" do
+      Foo.template_ext.should == ".foo.erb"
+      Bar.template_ext.should == ".html.erb"
+    end
+  end
+  
+  describe "Building a composite page" do
+    before(:each) do
+      class Page
+        include BlueTree::Node
+        use_template_path fixtures
+        use_template_ext '.txt.erb'
+        attr_accessor :page_title, :introduction, :conclusion
+      end
+
+      class Section
+        include BlueTree::Node
+        use_template_path fixtures
+        use_template_ext '.txt.erb'
+        attr_accessor :title, :description
+      end
+  
+      @page = Page.new(:page)
+      @page.page_title = 'The Main Title'
+      @page.introduction = 'The introduction...'
+      @page.conclusion = 'The conclusion...'
+      
+      @child1 = Section.new(:child1)
+      @child1.title = 'Section 1'
+      @child1.description = 'Section 1 description...'
+
+      @child2 = Section.new(:child2)
+      @child2.title = 'Section 1.1'
+      @child2.description = 'Section 1.1 description...'
+      
+      @child1.add_child @child2
+      @page.add_child @child1
+    end
+    
+    describe "Instance defaults" do
+      it "should have correct template path" do
+        @page.template_path.should == fixtures
+      end
+
+      it "should have correct template ext" do
+        @page.template_ext.should == '.txt.erb'
+      end
+    end
+    
+    describe "Data access" do
+      it "should have access to child nodes" do
+        @page.child_nodes.should == [@child1]
+      end
+    
+      it "should have access to parent node" do
+        @child1.parent_node.should == @page
+        @child2.parent_node.should == @child1
+      end
+    
+      it "should have access to root node" do
+        @child1.root_node.should == @page
+        @child2.root_node.should == @page
+      end
+    end
+    
+    describe "Rendering" do
+      it "leaf node should render as expected" do
+        @child2.render.should == File.read(fixtures('child2.txt'))
+      end
+      
+      it "composite page should render as expected" do
+        @page.render.should == File.read(fixtures('page.txt'))
+      end
+      
+      context "Arbitrary templates" do
+        before(:each) do
+          @child3 = Section.new(:child3)
+          @child3.title = 'Section 1.2'
+          @child3.description = 'Section 1.2 description...'
+          
+          @child1.add_child @child3
+        end
+        
+        it "should render arbritary template" do
+          @child3.render.should == File.read(fixtures('child3.txt'))
+        end
+      end
+    end
+  end
+end

data/templates/child1.html.erb

@@ -0,0 +1,4 @@
+child1
+<% children.each do |child| -%>
+<%= child.render -%>
+<% end -%>

data/templates/child2.html.erb

@@ -0,0 +1 @@
+child2

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: blue_tree
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Andy White
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-09-11 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Build composite ERB templates
+email: 
+- andy@wireworldmedia.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- blue_tree.gemspec
+- fixtures/child1.txt.erb
+- fixtures/child2.txt
+- fixtures/child2.txt.erb
+- fixtures/child3.txt
+- fixtures/child3.txt.erb
+- fixtures/footer.txt.erb
+- fixtures/page.foo.erb
+- fixtures/page.txt
+- fixtures/page.txt.erb
+- lib/blue_tree.rb
+- lib/blue_tree/node.rb
+- lib/blue_tree/version.rb
+- spec/helper.rb
+- spec/node_spec.rb
+- templates/child1.html.erb
+- templates/child2.html.erb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Bluetree is a module of methods which allow you to create composable view  classes. Each class instance is initialized with an ERB template. The  templates of these views have access to all local instance variables and  methods plus access to the immediate parent and root node objects.
+test_files: 
+- spec/helper.rb
+- spec/node_spec.rb