mustache_json 0.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 Intridea, Inc. and Michael Bleigh
+
+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,51 @@
+= Mustache JSON Serialization
+
+The <tt>mustache_json</tt> gem provides a simple way to encode Mustaches
+into JSON for cross-compatibility with other Mustache rendering libraries
+such as mustache.js (http://github.com/janl/mustache.js).
+
+It extends Mustache in a simple way such that all public instance methods
+declared in your Mustache will be automatically serialized into json when
+the <tt>#to_json</tt> method is called. Any context variables that have 
+been set will be included as well. For example, take this Mustache:
+
+    require 'mustache_json'
+    
+    class Person < Mustache
+      def initialize(first_name, last_name)
+        context[:first_name], context[:last_name] = first_name, last_name
+      end
+      
+      def initials
+        "#{context[:first_name][0..0]}.#{context[:last_name][0..0]}."
+      end
+      
+      def listing
+        "#{context[:last_name]}, #{context[:first_name]}"
+      end
+    end
+    
+With <tt>mustache_json</tt> you are able to do this:
+
+    bob = Person.new('Bob', 'Bobson')
+    bob.to_json
+    
+Which will output:
+
+    {"last_name":"Bobson","initials":"B.B.","listing":"Bobson, Bob","first_name":"Bob"}
+    
+It's a simple addition to Mustache but provides some powerful functionality
+toward views that can be rendered either server-side (in Ruby) or client-side
+(in Javascript).
+
+== 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.
+
+== Copyright
+
+Copyright (c) 2010 Intridea, Inc. and Michael Bleigh. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mustache_json"
+    gem.summary = %Q{Easily serialize Mustaches to JSON.}
+    gem.description = %Q{Easily serialize Mustaches to JSON.}
+    gem.email = "michael@intridea.com"
+    gem.homepage = "http://github.com/mbleigh/mustache-json"
+    gem.authors = ["Michael Bleigh"]
+    gem.add_dependency "mustache"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # 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: sudo 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
+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 = "mustache-json #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/mustache/json/backends/active_support.rb

@@ -0,0 +1,13 @@
+require 'active_support/json' unless defined?(::ActiveSupport::JSON)
+
+class Mustache
+  module JSON
+    module Backends
+      class ActiveSupport
+        def self.encode(object)
+          ::ActiveSupport::JSON.encode(object)
+        end
+      end
+    end
+  end
+end

data/lib/mustache/json/backends/json_gem.rb

@@ -0,0 +1,13 @@
+require 'json' unless defined?(::JSON)
+
+class Mustache
+  module JSON
+    module Backends
+      class JsonGem
+        def self.encode(object)
+          ::JSON.generate(object)
+        end
+      end
+    end
+  end
+end

data/lib/mustache/json/backends/json_pure.rb

@@ -0,0 +1,13 @@
+require 'json/pure' unless defined?(::JSON)
+
+class Mustache
+  module JSON
+    module Backends
+      class JsonPure
+        def self.encode(object)
+          ::JSON.generate(object)
+        end
+      end
+    end
+  end
+end

data/lib/mustache/json/backends/yajl.rb

@@ -0,0 +1,13 @@
+require 'yajl' unless defined?(Yajl)
+
+class Mustache
+  module JSON
+    module Backends
+      class Yajl
+        def self.encode(object)
+          ::Yajl::Encoder.encode(object)
+        end
+      end
+    end
+  end
+end

data/lib/mustache_json.rb

@@ -0,0 +1,61 @@
+require 'mustache'
+
+class Mustache
+  # An array of methods that should be used for serialization.
+  # By default it is all public instance methods defined on the
+  # specific class (no superclasses). Override this for more
+  # specific control.
+  def self.serializable_methods
+    public_instance_methods(false)
+  end
+  
+  # A hash of the compiled Mustache, including all
+  # serializable methods as well as the specified context.
+  def serializable_hash
+    hash = self.class.serializable_methods.inject({}) do |result, method|
+      # Symbolize the method to work better with the Mustache Context.
+      result[method.to_sym] = self.send(method)
+      result
+    end
+    
+    hash.merge!(context)
+  end
+  
+  # Convert the current Mustache object to JSON and
+  # provide optional additional context for the result.
+  def to_json(additional_context = {})
+    context.merge(additional_context)
+    Mustache::JSON.encode(serializable_hash)
+  end
+  
+  module JSON
+    def self.backend #:nodoc:
+      self.backend = :json_gem unless defined?(@backend)
+      @backend
+    end
+    
+    # Set the back-end for the JSON encoder in a swappable fashion.
+    # Currently supported backends:
+    #
+    # * <tt>:json_gem</tt>
+    # * <tt>:json_pure</tt>
+    # * <tt>:active_support</tt>
+    # * <tt>:yajl</tt>
+    #
+    # The default backend is the JSON gem.
+    def self.backend=(backend)
+      require "mustache/json/backends/#{backend.to_s.downcase}.rb"
+      @backend = class_for(backend)
+    end
+    
+    # Generic JSON encoder that will use the specified back-end.
+    def self.encode(object)
+      self.backend.encode(object)
+    end
+    
+    def self.class_for(backend)#:nodoc:
+      class_name = backend.to_s.split('_').map(&:capitalize).join('')
+      eval "Mustache::JSON::Backends::#{class_name}"
+    end
+  end
+end

data/spec/mustache_json_spec.rb

@@ -0,0 +1,76 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Mustache do
+  class MustachioedPerson < Mustache
+    def first_name
+      "Bob"
+    end
+    
+    def last_name
+      "Stevens"
+    end
+    
+    protected
+    
+    def dont_show
+      "secrets"
+    end
+    
+    private
+    
+    def really_secret
+      "bad stuff"
+    end
+  end
+  
+  describe '#serializable_hash' do
+    before do
+      @stache = MustachioedPerson.new
+      @hash = @stache.serializable_hash
+    end
+    
+    it 'should include publicly declared methods' do
+      @hash[:first_name].should == 'Bob'
+      @hash[:last_name].should == 'Stevens'
+    end
+    
+    it 'should not include protected or private methods' do
+      @hash.keys.should_not be_include(:dont_show)
+      @hash.keys.should_not be_include(:really_secret)
+    end
+    
+    it 'should include any additional context' do
+      @stache.context.update(:foo => 'bar')
+      @stache.serializable_hash[:foo].should == 'bar'
+    end
+  end
+  
+  describe '.serializable_methods' do
+    it 'should be the public instance methods of the specific class' do
+      MustachioedPerson.serializable_methods.should == MustachioedPerson.public_instance_methods(false)
+    end
+  end
+  
+  describe '#to_json' do
+    before do
+      @stache = MustachioedPerson.new
+    end
+    
+    [:json_gem, :json_pure, :yajl, :active_support].each do |backend|
+      describe " with the #{backend} backend" do
+        before do
+          Mustache::JSON.backend = backend
+        end
+        
+        it 'should call the appropriate backend' do
+          Mustache::JSON.class_for(backend).should_receive(:encode)
+          @stache.to_json
+        end
+        
+        it 'should include expected values' do
+          @stache.to_json.should be_include('"first_name":"Bob"')
+        end
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'mustache_json'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: mustache_json
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael Bleigh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-21 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mustache
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: Easily serialize Mustaches to JSON.
+email: michael@intridea.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/mustache/json/backends/active_support.rb
+- lib/mustache/json/backends/json_gem.rb
+- lib/mustache/json/backends/json_pure.rb
+- lib/mustache/json/backends/yajl.rb
+- lib/mustache_json.rb
+- spec/mustache_json_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mbleigh/mustache-json
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Easily serialize Mustaches to JSON.
+test_files: 
+- spec/mustache_json_spec.rb
+- spec/spec_helper.rb