jam-ruby 0.0.4

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem "rails", "3.0.9"
+gem "capybara", ">= 0.4.0"
+gem "sqlite3"
+gem 'tilt'
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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,94 @@
+= Jam
+
+  Jam - Simple, readable and flexible JSON Api Maker based on standart rails tools and hash syntax.
+
+== Installation
+
+  gem install jam
+
+== Configuration
+
+Standart Rails configuration:
+
+  ActiveRecord::Base.include_root_in_json = true
+
+== Examples
+
+=== Basic usage
+
+  object @post do |p|
+    {
+      :body => p.downcase
+    }
+  end
+
+=== Use to_json attributes (only, except, methods, root)
+
+  object @post, :only => [:title] do |p|
+    {
+      :body => p.downcase
+    }
+  end
+
+=== For collections
+
+  collection @posts { |p|
+    {
+      :body => p.downcase
+    }
+  }
+
+=== Use template
+
+  collection @posts do |post|
+    template('posts/show', :@post => post)
+  end
+
+=== Add children
+
+  collection @posts do |p|
+    {
+      :comments => collection p.comments, :only => [:body]...
+    }
+  end
+
+=== Root
+
+Works like in Rails to_json:
+
+  object @post, :root => :bost
+
+== Contributions
+
+We open for you contributions, sugesstions and ideas.
+
+== Inspired by
+
+- Tequila
+- Rabl
+
+Some of code was borrowed from RABL.
+
+== Licence
+
+The MIT License
+
+Copyright (c) 2011 Eduard Tsech edtsech@gmail.com
+
+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/Rakefile

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler'
+  require 'bundler/setup'
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+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
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'jam'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/jam/builder.rb')
+end

data/lib/jam/builder.rb

@@ -0,0 +1,87 @@
+module Jam
+  class Builder
+    include ActionView::Helpers
+
+    # Constructs a new engine based on given source and options
+    #
+    #   JamTemplate.new { 'object @post' }
+    def initialize(source, options={})
+      @_source = source
+      @_options = options
+    end
+
+    # Renders the representation based on source, object, scope and locals
+    #
+    #   JamTemplate.new { 'object @post' }.render(@scope)
+    def render(scope, locals, &block)
+      @_locals, @_scope = locals, scope
+      self.copy_instance_variables_from(@_scope, [:@assigns, :@helpers])
+
+      instance_eval(@_source) if @_source.present?
+    end
+
+    # Returns an hash representation for each element in the collection
+    # with options and passed block
+    #
+    #   collection @posts, :only => [:body] do |p|
+    #     { :title => p.title.titleize }
+    #   end
+    def collection(obj, options={}, &block)
+      obj.inject [] do |res, x|
+        res << object(x, options, &block)
+      end
+    end
+
+    # Returns an hash representation of the passed object
+    # with options and passed block
+    #
+    #   object @post, :only => [:body] do |p|
+    #     { :title => p.title.titleize }
+    #   end
+    def object(obj, options={}, &block)
+      if ActiveRecord::Base.include_root_in_json
+        root = options[:root] || obj.class.model_name.element
+      end
+
+      result = {}
+
+      result.merge!(obj.as_json(options))
+
+      if block
+        blk = block.call(obj).stringify_keys
+        result.merge!(blk) unless root
+        result[root].merge!(blk) if root
+      end
+
+      result.stringify_keys
+    end
+
+    # Render template with variables passed in the hash
+    #
+    #   template ('posts/show', :@post => post)
+    def template(file, vars={})
+      source = self.fetch_source(file)
+      vars.each do |k, v|
+        @_scope.instance_variable_set k, v
+      end
+      Jam::Builder.new(source).render(@_scope, @_locals)
+    end
+
+    protected
+
+    def copy_instance_variables_from(object, exclude = []) #:nodoc:
+      vars = object.instance_variables.map(&:to_s) - exclude.map(&:to_s)
+      vars.each { |name| instance_variable_set(name, object.instance_variable_get(name)) }
+    end
+
+    # Returns source for a given relative file
+    #
+    #   fetch_source("show", :view_path => "...") => "...contents..."
+    def fetch_source(file, options={})
+      root_path = Rails.root if defined?(Rails)
+      view_path = options[:view_path] || File.join(root_path, "app/views/")
+      file_path = Dir[File.join(view_path, file + "*.jam")].first
+      File.read(file_path) if file_path
+    end
+  end
+end

data/lib/jam/template.rb

@@ -0,0 +1,67 @@
+# TILT Template
+if defined?(Tilt)
+  class JamTemplate < Tilt::Template
+    def initialize_engine
+      return if defined?(::Jam)
+      require_template_library 'jam'
+    end
+
+    def prepare
+      options = @options.merge(:format => @options[:format])
+      @engine = ::Jam::Builder.new(data, options)
+    end
+
+    def evaluate(scope, locals, &block)
+      @engine.render(scope, locals, &block)
+    end
+  end
+
+  Tilt.register 'jam', JamTemplate
+end
+
+# Rails 2.X Template
+if defined?(Rails) && Rails.version =~ /^2/
+  require 'action_view/base'
+  require 'action_view/template'
+
+  module ActionView
+    module TemplateHandlers
+      class JamHandler < TemplateHandler
+        include Compilable
+
+        def compile(template) %{
+          ::Jam::Builder.new(#{template.source.inspect}, { :format => #{template.format.inspect} }).
+            render(self, assigns.merge(local_assigns)).to_json
+        } end
+      end
+    end
+  end
+
+  ActionView::Template.register_template_handler :jam, ActionView::TemplateHandlers::JamHandler
+end
+
+# Rails 3.X Template
+if defined?(Rails) && Rails.version =~ /^3/
+  module ActionView
+    module Template::Handlers
+      class Jam
+
+        class_attribute :default_format
+        self.default_format = Mime::JSON
+
+        def self.call(template)
+          source = if template.source.empty?
+            File.read(template.identifier)
+          else # use source
+            template.source
+          end
+
+          %{ ::Jam::Builder.new(#{source.inspect}).
+              render(self, assigns.merge(local_assigns)).to_json }
+        end
+      end
+    end
+  end
+
+  ActionView::Template.register_template_handler :jam, ActionView::Template::Handlers::Jam
+end

data/lib/jam.rb

@@ -0,0 +1,5 @@
+require File.join(File.dirname(__FILE__), 'jam/template.rb')
+require File.join(File.dirname(__FILE__), 'jam/builder.rb')
+
+module Jam
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: jam-ruby
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
+platform: ruby
+authors: 
+- Eduard Tsech
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-17 00:00:00 +07:00
+default_executable: 
+dependencies: []
+
+description: JSON Api Maker.
+email: 
+- edtsech@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/jam/builder.rb
+- lib/jam/template.rb
+- lib/jam.rb
+- MIT-LICENSE
+- Rakefile
+- Gemfile
+- README.rdoc
+has_rdoc: true
+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.5.2
+signing_key: 
+specification_version: 3
+summary: JSON Api Maker.
+test_files: []
+