braai 1.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.log
+.DS_Store
+doc
+tmp
+pkg
+*.gem
+*.pid
+coverage
+coverage.data
+build/*
+*.pbxuser
+*.mode1v3
+.svn
+profile
+.console_history
+.sass-cache/*
+.rake_tasks~
+*.log.lck
+solr/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in braai.gemspec
+gemspec
+
+gem "rspec"

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    braai (0.0.1)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    multi_json (1.3.6)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  braai!
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mark Bates
+
+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 @@
+# Braai
+
+A fully extensible templating system. Sick and tired of all of those templating systems that force you to do things their way? Yeah, me too! Thankfully there's Braai. 
+Braai let's you write your own Regular Expression matchers and then do whatever you'd like when the template is parsed! Sounds fun, doesn't it?
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'braai'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install braai
+
+## Usage
+
+### Built-in Matchers
+
+Braai comes shipped with two simple matchers for you, but you can easily add your own.
+
+The first matcher is a simple <code>to_s</code> handler. It will match a single variable and then call <code>to_s</code> on it:
+
+<pre><code>
+template = "Hi {{ name }}!"
+response = Braai::Template.new(template).render(name: "Mark")
+response # => "Hi Mark!"
+</code></pre>
+
+The second matcher will call a method on the variable.
+
+<pre><code>
+template = "Hi {{ name.upcase }}!"
+response = Braai::Template.new(template).render(name: "Mark")
+response # => "Hi MARK!"
+</code></pre>
+
+### Custom Matchers
+
+Braai let's you easily define your own matchers to do whatever you would like to do.
+
+<pre><code>
+template = "I'm {{ name }} and {{ mmm... bbq }}!"
+Braai::Template.map(/mmm\.\.\. bbq/i) do |template, key, matches|
+  "Damn, I love BBQ!"
+end
+
+Braai::Template.map(/name/i) do |template, key, matches|
+  template.attributes[matches.first].upcase
+end
+
+Braai::Template.new(template).render # => "I'm MARK and Damn, I love BBQ!!"
+</code></pre>
+
+### For Loops
+
+Braai supports looping right out of the box.
+
+<pre><code>
+template = <<-EOF
+&lt;h1>{{ greet }}&lt;/h1>
+&lt;ul>
+  {{ for product in products }}
+    &lt;li>{{ product }}&lt;/li>
+  {{ /for }}
+&lt;/ul>
+&lt;div>
+  {{ for food in foods }}
+    &lt;p>{{ food }}&lt;/p>
+  {{ /for }}
+&lt;/div>
+&lt;h2>{{greet.upcase}}&lt;/h2>
+EOF
+
+Braai::Template.new(template).render(greet: "mark", products: %w{car boat truck}, foods: %w{apple orange})
+# =>
+"&lt;h1>mark&lt;/h1>
+&lt;ul>
+    &lt;li>car&lt;/li>
+    &lt;li>boat&lt;/li>
+    &lt;li>truck&lt;/li>
+&lt;/ul>
+&lt;div>
+    &lt;p>apple&lt;/p>
+    &lt;p>orange&lt;/p>
+&lt;/div>
+&lt;h2>MARK&lt;/h2>"
+</code></pre>
+
+## 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,7 @@
+require 'bundler'  
+Bundler::GemHelper.install_tasks
+
+desc "Run tests"
+task :default do
+  system "bundle exec rspec"
+end

data/braai.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'braai/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "braai"
+  gem.version       = Braai::VERSION
+  gem.authors       = ["Mark Bates"]
+  gem.email         = ["mark@markbates.com"]
+  gem.description   = %q{Fully extensible templating system.}
+  gem.summary       = %q{Fully extensible templating system.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency("activesupport")
+
+end

data/lib/braai/configuration.rb

@@ -0,0 +1,26 @@
+class Braai::Configuration
+
+  attr_accessor :logger
+  attr_accessor :raise_on_missing_handler
+  attr_accessor :swallow_handler_errors
+  attr_accessor :for_loop_regex
+  attr_accessor :handler_regex
+
+  def initialize
+    self.raise_on_missing_handler = false
+    self.swallow_handler_errors = true
+    self.handler_regex = /{{\s*[^}]+\s*}}/i
+    self.for_loop_regex = /({{\s*for (\w+) in (\w+)\s*}}(.+?){{\s*\/for\s*}})/im
+  end
+
+  def logger
+    @logger ||= begin
+      if defined?(Rails)
+        Rails.logger
+      else
+        Logger.new(STDOUT)
+      end
+    end
+  end
+
+end

data/lib/braai/context.rb

@@ -0,0 +1,66 @@
+class Braai::Context
+
+  attr_accessor :attributes
+  attr_accessor :template
+  attr_accessor :handlers
+
+  def initialize(template, handlers, attributes = {})
+    self.attributes = HashWithIndifferentAccess.new(attributes)
+    self.template = template.dup
+    self.handlers = handlers
+  end
+
+  def render
+    begin
+      self.render!
+    rescue Exception => e
+      Braai.logger.error(e)
+      raise e
+    end
+  end
+
+  def render!
+    self.process_loops
+    self.process_keys
+    return self.template
+  end
+
+  protected
+  def process_loops
+    loops = self.template.scan(Braai.config.for_loop_regex)
+    loops.each do |loop|
+      res = []
+      self.attributes[loop[2]].each do |val|
+        res << Braai::Context.new(loop[3], self.handlers, self.attributes.merge(loop[1] => val)).render!
+      end
+      self.template.gsub!(loop[0], res.join("\n"))
+    end
+  end
+
+  def process_keys
+    keys = self.template.scan(Braai.config.handler_regex).flatten.uniq
+    keys.each do |key|
+      self.handle_key(key)
+    end
+  end
+
+  def handle_key(key)
+    stripped_key = key.gsub(/({|})/, "").strip
+    matched = false
+    self.handlers.each do |regex, handler|
+      regex = Regexp.new(regex)
+      if regex.match(stripped_key)
+        begin
+          val = handler.call(self, stripped_key, stripped_key.scan(regex).flatten)
+          self.template.gsub!(key, val.to_s) if val
+        rescue Exception => e
+          raise e unless Braai.config.swallow_handler_errors
+        end
+        matched = true
+        break
+      end
+    end
+    raise Braai::MissingHandlerError.new(stripped_key) if !matched && Braai.config.raise_on_missing_handler    
+  end
+
+end

data/lib/braai/errors.rb

@@ -0,0 +1,7 @@
+module Braai
+  class MissingHandlerError < StandardError
+    def initialize(key)
+      super "#{key} was missing a handler! Please implement one."
+    end
+  end
+end

data/lib/braai/handlers.rb

@@ -0,0 +1,33 @@
+module Braai::Handlers
+
+  def handlers
+    @handlers ||= reset!
+  end
+
+  def map(regex, &block)
+    @handlers = {regex.to_s => block}.merge(self.handlers)
+  end
+
+  def unmap(regex)
+    self.handlers.delete(regex.to_s)
+  end
+
+  def clear!
+    self.handlers.clear
+  end
+
+  def reset!
+    @handlers = {
+      /^([\w]+)\.([\w]+)$/i => ->(template, key, matches) {
+        attr = template.attributes[matches.first]
+        attr ? attr.send(matches.last) : nil
+      },
+      /^(\w+)$/i => ->(template, key, matches) {
+        attr = template.attributes[matches.first]
+        attr ? attr.to_s : nil
+      }
+    }
+    return @handlers
+  end
+
+end

data/lib/braai/template.rb

@@ -0,0 +1,27 @@
+class Braai::Template
+  extend Braai::Handlers
+  include Braai::Handlers
+
+  attr_accessor :attributes
+  attr_accessor :template
+
+  def initialize(template, handlers = {})
+    self.template = template
+    @handlers = self.class.handlers.merge(handlers)
+  end
+
+  def render(attributes = {})
+    begin
+      return self.render!(attributes)
+    rescue Exception => e
+      Braai.logger.error(e)
+      raise e
+    end
+  end
+
+  def render!(attributes)
+    context = Braai::Context.new(self.template, self.handlers, attributes)
+    context.render!
+  end
+
+end

data/lib/braai/version.rb

@@ -0,0 +1,3 @@
+module Braai
+  VERSION = "1.0.1"
+end

data/lib/braai.rb

@@ -0,0 +1,26 @@
+require 'logger'
+require 'active_support/hash_with_indifferent_access'
+require "braai/version"
+require "braai/configuration"
+require "braai/errors"
+require "braai/handlers"
+require "braai/template"
+require "braai/context"
+
+module Braai
+
+  class << self
+
+    def config
+      @config ||= Braai::Configuration.new
+      yield @config if block_given?
+      return @config
+    end
+
+    def logger
+      self.config.logger
+    end
+
+  end
+
+end

data/spec/braai/handlers_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Braai::Handlers do
+  include Braai::Handlers
+  
+  describe 'map' do
+
+    it "maps a new handler" do
+      map("foo") {}
+      handlers.should include("foo")
+    end
+
+    it "makes the latest handler the first handler in the list" do
+      map("foo") {}
+      map("bar") {}
+      handlers.keys.first.should eql("bar")
+    end
+    
+  end
+
+  describe 'unmap' do
+    
+    it "unmaps a handler" do
+      map("foo") {}
+      handlers.should include("foo")
+      unmap("foo")
+      handlers.should_not include("foo")
+    end
+
+  end
+
+  describe 'clear!' do
+    
+    it "removes all of the handlers" do
+      map("foo") {}
+      handlers.should_not be_empty
+      clear!
+      handlers.should be_empty
+    end
+
+  end
+
+  describe 'reset!' do
+    
+    it "resets the handlers to their original state" do
+      handlers.should have(2).handlers
+      map("foo") {}
+      handlers.should have(3).handlers
+      reset!
+      handlers.should have(2).handlers
+    end
+
+  end
+
+end

data/spec/braai/template_spec.rb

@@ -0,0 +1,179 @@
+require 'spec_helper'
+
+describe Braai::Template do
+  
+  let(:greet_regex) { /^greet$/i }
+  let(:greet_handler) do
+    ->(view, key, matches) {
+      view.attributes[:greet]
+    }
+  end
+
+  describe '.map' do
+
+    it "let's you register a handler" do
+      Braai::Template.handlers.should_not have_key(greet_regex.to_s)
+      Braai::Template.map(greet_regex, &greet_handler)
+      Braai::Template.handlers.should have_key(greet_regex.to_s)
+    end
+    
+  end
+
+  describe '#render' do
+
+    before(:each) do
+      Braai::Template.map(greet_regex, &greet_handler)
+    end
+    
+    it "renders a simple template" do
+      res = Braai::Template.new("{{ greet }}").render(greet: "Hi Mark")
+      res.should eql("Hi Mark")
+    end
+
+    it "doesn't care about spaces" do
+      template = "<h1>{{greet}}</h1><h2>{{ greet }}</h2>"
+      res = Braai::Template.new(template).render(greet: "Hi Mark")
+      res.should eql("<h1>Hi Mark</h1><h2>Hi Mark</h2>")
+    end
+
+    context "for loops" do
+      
+      let(:template) do
+<<-EOF
+<h1>{{ greet }}</h1>
+<ul>
+  {{ for product in products }}
+    <li>{{ product }}</li>
+  {{ /for }}
+</ul>
+<div>
+  {{ for food in foods }}
+    <p>{{ food }}</p>
+  {{ /for }}
+</div>
+<h2>{{greet.upcase}}</h2>
+EOF
+      end
+
+      it "renders the loop" do
+        res = Braai::Template.new(template).render(greet: "mark", products: %w{car boat truck}, foods: %w{apple orange})
+        puts res
+        res.should match("<h1>mark</h1>")
+        res.should match("<li>car</li>")
+        res.should match("<li>boat</li>")
+        res.should match("<li>truck</li>")
+        res.should match("<p>apple</p>")
+        res.should match("<p>orange</p>")
+        res.should match("<h2>MARK</h2>")
+      end
+
+      # it "description" do
+      #   template = "I'm {{ name }} and {{ mmm... bbq }}!"
+      #   Braai::Template.map(/mmm\.\.\. bbq/i) do |template, key, matches|
+      #     puts "key: #{key.inspect}"
+      #     puts "matches: #{matches.inspect}"
+      #     "Damn, I love BBQ!"
+      #   end
+
+      #   Braai::Template.map(/name/i) do |template, key, matches|
+      #     template.attributes[matches.first].upcase
+      #   end
+
+      #   puts Braai::Template.new(template).render(name: "Mark")
+      # end
+
+    end
+
+    context "default handler" do
+      
+      let(:template) { "{{ greet }} {{ name.upcase }}" }
+
+      it "uses the default handler to render" do
+        res = Braai::Template.new(template).render(greet: "Hi", name: "mark")
+        res.should eql("Hi MARK")
+      end
+
+      it "handles the attribute not being there" do
+        res = Braai::Template.new(template).render(greet: "Hi")
+        res.should eql("Hi {{ name.upcase }}")
+      end
+
+    end
+
+    context "missing handlers" do
+
+      before(:each) do
+        Braai::Template.reset!
+      end
+
+      after(:each) do
+        Braai.config.raise_on_missing_handler = false
+      end
+      
+      context "raise_on_missing_handler is true" do
+        
+        before(:each) do
+          Braai.config.raise_on_missing_handler = true
+        end
+
+        it "raises an error" do
+          expect {
+            Braai::Template.new("{{ please.greet.me }}").render(greet: "Hi Mark")
+          }.to raise_error(Braai::MissingHandlerError)
+        end
+
+      end
+
+      context "raise_on_missing_handler is false" do
+
+        it "does not raise an error" do
+          expect {
+            res = Braai::Template.new("{{ greet }}").render(greet: "Hi Mark")
+            res.should eql("{{ greet }}")
+          }.to_not raise_error(Braai::MissingHandlerError)
+        end
+        
+      end
+
+    end
+
+    context "handler errors" do
+      
+      before(:each) do
+        Braai::Template.map(/^foo$/) do |view, key, matches|
+          raise ArgumentError 
+        end
+      end
+
+      let(:template) { "{{ foo }}" }
+
+      context "swallow_handler_errors is true" do
+        
+        it "swallows errors in the handler" do
+          expect {
+            res = Braai::Template.new(template).render()
+            res.should eql template
+          }.to_not raise_error
+        end
+
+      end
+
+      context "swallow_handler_errors is false" do
+
+        before(:each) do
+          Braai.config.swallow_handler_errors = false
+        end
+        
+        it "raises the errors from the handler" do
+          expect {
+            Braai::Template.new(template).render()
+          }.to raise_error(ArgumentError)
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'bundler/setup'
+
+require 'braai' # and any other gems you need
+
+Braai.config.logger = Logger.new(StringIO.new)
+
+RSpec.configure do |config|
+
+  config.before do
+    Braai::Template.reset!
+  end
+
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: braai
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mark Bates
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fully extensible templating system.
+email:
+- mark@markbates.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- braai.gemspec
+- lib/braai.rb
+- lib/braai/configuration.rb
+- lib/braai/context.rb
+- lib/braai/errors.rb
+- lib/braai/handlers.rb
+- lib/braai/template.rb
+- lib/braai/version.rb
+- spec/braai/handlers_spec.rb
+- spec/braai/template_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Fully extensible templating system.
+test_files:
+- spec/braai/handlers_spec.rb
+- spec/braai/template_spec.rb
+- spec/spec_helper.rb