liquify 0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Dane Harrigan
+
+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.rdoc

@@ -0,0 +1,64 @@
+= liquify
+
+Liquify is a wrapper to Tobi's <a href="http://rubygems/liquid">Liquid Markup</a> gem.
+
+== Examples
+
+  ## configuring Liquify
+  Liquify.setup do
+    register_filter MyFilters
+    register_tag :include, IncludeTag
+    register_drop :page, PageDrop
+  end
+
+  # Any filter, tag or drop registered to Liquify is available anything
+  # rendered through +Liquify.render+.
+
+  ## Using Liquify
+  # rendering source
+  Liquify.render("{{ page.name }}")
+
+  # rendering from a file (from a full path)
+  Liquify.render(:template => '/path/to/file.liquid')
+  
+  # rendering from a file (from a relative path)
+  # setup template root location
+  Liquify.setup do
+    template_root '/path/to/templates'
+  end
+
+  Liquify.render(:template => 'relative/path/file.liquid')
+
+  ## my_filters.rb
+  module MyFilters
+    def bold_text(text)
+      text = Liquify.parameter(text)
+      "<strong>#{text}</strong>"
+    end
+  end
+
+  ## include_tag.rb
+  class IncludeTag < Liquify::Tag
+    def invoke
+      Liquify.render("#{parameter}.liquid")
+    end
+  end
+
+== Todo
+
+Make a helpful classes that improve on Liquid's Drop and Block class.
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Dane Harrigan. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "liquify"
+    gem.version = "0.1"
+    gem.summary = %Q{Liquify is a wrapper to Liquid Markup to make it easier to use}
+    gem.description = gem.summary
+    gem.email = "dane.harrigan@gmail.com"
+    gem.homepage = "http://github.com/daneharrigan/liquify"
+    gem.authors = ["Dane Harrigan"]
+    gem.add_development_dependency "rspec", ">= 1.3.0"
+    gem.add_dependency "liquid", "2.1.2"
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+  spec.rcov_opts = ['--exclude', 'gem,spec']
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "liquify #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/liquify.rb

@@ -0,0 +1,100 @@
+require 'liquid'
+
+class Liquify
+  @@filters = []
+  @@drops = {}
+  @@tags = {}
+  @@template_root = nil
+
+  class << self
+    def setup(&block)
+      new.instance_eval(&block)
+      @@filters.each { |filter| Liquid::Template.register_filter(filter) }
+      @@tags.each { |tag, klass| Liquid::Template.register_tag(tag, klass) }
+    end
+
+    def render(args)
+      source = case
+        when String === args
+          args
+        when args[:template]
+          path = [@@template_root, args[:template]].compact.join('/')
+          File.read(path) if File.exist? path
+      end
+  
+      Liquid::Template.parse(source).render(@@drops)
+    end
+
+    def parameters(params)
+      return if params.nil?
+      params = params.split(',')
+      params.map! { |param| param.strip.gsub(/(^('|")|('|")$)/,'') }
+    end
+
+    def parameter(params)
+      params = parameters(params)
+      params.first if params
+    end
+  end
+
+  # +register_filter+ - This method accepts a module and is used to add
+  # Liquid filters.
+  #   Liquify.setup do
+  #     register_filter MyFilters
+  #   end
+  #
+  # A filter is a method stored in a module. The +MyFilters+ would be
+  # setup like this:
+  #   module MyFilters
+  #     def bold_text(text)
+  #       "<strong>#{text}</strong>"
+  #     end
+  #   end
+  #
+  # The +MyFilters+ methods will be available in any liquid source
+  # rendered with +Liquify.render+.
+  # 
+  #   Liquify.render("{{ 'my sample' | bold_text }}")
+  #   # or read from a file
+  #   Liquify.render(:template => 'path/to/file.liquid')
+  #   # => <strong>my sample</strong>
+  def register_filter(mod)
+    @@filters << mod unless @@filters.include? mod
+  end
+
+  def register_drop(name, klass)
+    @@drops[name.to_s] ||= klass.new
+  end
+
+  # +register_tag+ - This method accepts two arguments, a symbol
+  # of the tag name used within the Liquid source and the custom
+  # tag class made by you.
+  #
+  #   Liquify.setup do
+  #     register_tag :include, IncludeDrop
+  #   end
+  #
+  # A tag is a class that inherits from the class +Liquid::Tag+
+  # or +<tt>Liquify::Tag</tt>+. 
+  # setup like this:
+  #   class IncludeTag < Liquify::Tag
+  #     def invoke
+  #       # your impressive ruby code here
+  #     end
+  #   end
+  #
+  # The +MyFilters+ methods will be available in any liquid source
+  # rendered with +Liquify.render+.
+  # 
+  #   Liquify.render("{{ 'my sample' | bold_text }}")
+  #   # or read from a file
+  #   Liquify.render(:template => 'path/to/file.liquid')
+  #   # => <strong>my sample</strong>
+  def register_tag(name, klass)
+    @@tags[name.to_s] ||= klass
+  end
+
+  def template_root(path)
+    @@template_root = path
+  end
+end

data/lib/liquify/tag.rb

@@ -0,0 +1,20 @@
+class Liquify
+  class Tag < Liquid::Tag
+    def initialize(tag_name, markup, tokens)
+      @_params = Liquify.parameters(markup)
+    end
+
+    def render(context)
+      invoke if respond_to? :invoke
+    end
+
+    private
+    def parameters
+      return @_params
+    end
+
+    def parameter
+      parameters.first
+    end
+  end
+end

data/spec/liquid/spec_drop.rb

@@ -0,0 +1,5 @@
+class SpecDrop < Liquid::Drop
+  def name
+    "Spec Drop: #{param}"
+  end
+end

data/spec/liquid/spec_filter.rb

@@ -0,0 +1,6 @@
+module SpecFilter
+  def bold_text(text)
+    text = Liquify.parameter(text)
+    "<strong>#{text}</strong>"
+  end
+end

data/spec/liquid/spec_tag.rb

@@ -0,0 +1,5 @@
+class SpecTag < Liquify::Tag
+  def invoke
+    "Spec Tag: #{parameter.capitalize}"
+  end
+end

data/spec/liquid/templates/sample.liquid

@@ -0,0 +1 @@
+{{ 'sample text' }}

data/spec/liquify/tag_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__)+'/../spec_helper')
+
+describe "Liquify::Tag" do
+  it "should parse parameters" do
+    tag = Liquify::Tag.new('tag_name',"'param-1', 'param-2'", nil)
+    tag.send(:parameters).should == %W{param-1 param-2}
+  end
+
+  it "should parse a single parameter" do
+    tag = Liquify::Tag.new('tag_name',"'param-1'", nil)
+    tag.send(:parameter).should == 'param-1'
+  end
+end

data/spec/liquify_spec.rb

@@ -0,0 +1,93 @@
+path = File.expand_path(File.dirname(__FILE__))
+require "#{path}/spec_helper"
+
+describe "Liquify" do
+  it "should have a setup method" do
+    Liquify.respond_to?(:setup).should == true
+  end
+
+  it "should return an array of parameters" do
+    # extra white space is intentional
+    output = Liquify.parameters("'param-1', 'param-2', 'param-3' ")
+    output.should == %W{param-1 param-2 param-3}
+  end
+
+  it "should return a single parameter" do
+    # extra white space is intentional
+    Liquify.parameter("'param-1' ").should == 'param-1'
+  end
+
+  context "when rendering a liquid template" do
+    it "should render the source" do
+      Liquify.render("{{ 'sample text' }}").should =~ /^sample text$/
+    end
+
+    it "should render the template" do
+      Liquify.render(:template => "#{path}/liquid/templates/sample.liquid").should =~ /^sample text$/
+    end
+
+    it "should render nil" do
+      Liquify.render(:template => "#{path}/does_not_exist.liquid").should be_empty
+    end
+
+    it "should render the template as a relative path" do
+      Liquify.setup do
+        template_root path
+      end
+
+      Liquify.render(:template => 'liquid/templates/sample.liquid')
+    end
+  end
+
+  context "when adding a filter" do
+    before(:all) do
+      Liquify.setup do
+        register_filter SpecFilter
+      end      
+    end
+  
+    it "should render bold text" do
+      output = Liquify.render("{{ 'sample text' | bold_text }}")
+      output.should =~ /^\<strong\>sample text\<\/strong\>$/
+    end
+  end
+
+  context "when adding a drop" do
+    before(:all) do
+      Liquify.setup do
+        register_drop :item, SpecDrop
+      end
+    end
+
+    it "should render the name" do
+      Liquify.render("{{ item.name }}").should =~ /Spec Drop/
+    end
+  end
+
+  context "when adding a tag" do
+    before(:all) do
+      Liquify.setup do
+        register_tag :tag_name, SpecTag
+      end
+    end
+
+    it "should render tag_name" do
+      Liquify.render("{% tag_name 'dane' %}").should =~ /Spec Tag: Dane/
+    end
+  end
+end
+
+# # initializer.rb
+# Liquify.setup do
+#   register_filter SomeFilters
+#   register_tag :include, MyInclude
+#   register_drop :site, SiteDrop
+#   template_root ''
+# end
+
+# liquify :file => 'my/path/to/file'
+# liquify '{{ my_source_code }}'
+# liquify :template => 'dane/file'
+
+# Liquify.render(:file => "my/path/to/file")
+# Liquify.render("{{ this is my whatever }}")

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'liquify'
+require 'liquify/tag'
+
+require 'liquid/spec_filter'
+require 'liquid/spec_tag'
+require 'liquid/spec_drop'

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: liquify
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Dane Harrigan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-11 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: liquid
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 1
+        - 2
+        version: 2.1.2
+  type: :runtime
+  version_requirements: *id002
+description: Liquify is a wrapper to Liquid Markup to make it easier to use
+email: dane.harrigan@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/liquify.rb
+- lib/liquify/tag.rb
+- spec/liquid/spec_drop.rb
+- spec/liquid/spec_filter.rb
+- spec/liquid/spec_tag.rb
+- spec/liquid/templates/sample.liquid
+- spec/liquify/tag_spec.rb
+- spec/liquify_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/daneharrigan/liquify
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.7
+signing_key: 
+specification_version: 3
+summary: Liquify is a wrapper to Liquid Markup to make it easier to use
+test_files: 
+- spec/liquid/spec_drop.rb
+- spec/liquid/spec_filter.rb
+- spec/liquid/spec_tag.rb
+- spec/liquify/tag_spec.rb
+- spec/liquify_spec.rb
+- spec/spec_helper.rb