api_builder 0.0.1 → 1.0.2

data/lib/api_builder.rb

@@ -1,2 +1,3 @@
+require 'api_builder/with_name'
 require 'api_builder/renderer'
 require 'api_builder/template'

data/lib/api_builder/renderer.rb

@@ -1,92 +1,92 @@
 module ApiBuilder
-  class ArrayRenderer
-    def self.render(*args, &block)
-      renderer = self.new(*args, &block)
-      renderer.out
+  module Renderer
+    def id(*args, &block)
+      method_missing(:id, *args, &block)
     end
+    
+    def method_missing(name, *args, &block)
+      @_out = {} if @_out.nil?
 
-    attr_reader :out
-
-    def initialize(*args, &block)
-      @out = []
-      instance_eval(&block)
-    end
-
-    def element(*args, &block)
-      @out << ElementRenderer.render(*args, &block)
-    end
-
-    def array(*args, &block)
-      @out << ArrayRenderer.render(*args, &block)
-    end
-  end
-
-  class ElementRenderer
-    def self.render(*args, &block)
-      renderer = self.new(*args, &block)
-      renderer.out
-    end
-
-    attr_reader :out
-
-    def initialize(*args, &block)
       if block_given?
-        @out = {}
-        instance_eval(&block)
+        out = @_out
+        @_out = {}
+        block.call
+        out[name] = @_out
+        @_out = out
       else
-        @out = args[0]
+        @_out[name] = args[0]
       end
     end
 
-    def id(value)
-      @out.update :id => value
-    end
-
-    def property(hash)
-      @out.update hash
-    end
-
-    def array(name, &block)
-      @out.update name => ArrayRenderer.render(&block)
+    def array(name, value = nil, &block)
+      if @_out.nil?
+        @_out = ArrayWithName.new(name)
+        block.call
+      elsif @_out.is_a?(Array)
+        out = @_out
+        @_out = ArrayWithName.new(name)
+        block.call
+        out << @_out
+        @_out = out
+      else # out is a hash
+        out = @_out
+        @_out = []
+        block.call
+        out[name] = @_out
+        @_out = out
+      end
     end
 
-    def method_missing(name, *args, &block)
+    def element(name, value = nil, &block)
       if block_given?
-        @out.update name => ElementRenderer.render(&block)
+        if @_out.nil?
+          @_out = HashWithName.new(name)
+          block.call
+        elsif @_out.is_a?(Array)
+          out = @_out
+          @_out = HashWithName.new(name)
+          block.call
+          out << @_out
+          @_out = out
+        else # out is a hash
+          out = @_out
+          @_out = {}
+          block.call
+          out[name] = @_out
+          @_out = out
+        end
+      elsif name.is_a?(Hash)
+        if @_out.nil?
+          @_out = StringWithName.new(name.keys[0], name.values[0])
+        elsif @_out.is_a?(Array)
+          @_out << StringWithName.new(name.keys[0], name.values[0])
+        else # out is a hash
+          @_out[name.keys[0]] = name.values[0]
+        end
       else
-        @out.update name => args[0]
+        if @_out.nil?
+          @_out = StringWithName.new(name, value)
+        elsif @_out.is_a?(Array)
+          @_out << StringWithName.new(name, value)
+        else # out is a hash
+          @_out[name] = value
+        end
       end
     end
-  end
-
-  class BaseRenderer
-    def self.render(format = "json", &block)
-      renderer = self.new(&block)
-      
-      case format
-      when "json"
-        renderer.out.to_json
-      when "xml"
-        renderer.out.to_xml
+    
+    def get_output
+      case params[:format].to_sym
+      when :json
+        if params[:callback]
+          "#{params[:callback]}(#{@_out.to_json})"
+        else
+          @_out.to_json
+        end
+      when :xml
+        @_out.to_xml
       else
-        raise "unknown format #{format}"
+        raise "unknown format '#{params[:format]}'"
       end
     end
-
-    attr_reader :out
-
-    def initialize(*args, &block)
-      instance_eval(&block)
-    end
-
-    def element(*args, &block)
-      raise "root element already defined" unless @out.nil?
-      @out = ElementRenderer.render(*args, &block)
-    end
-
-    def array(&block)
-      raise "root element already defined" unless @out.nil?
-      @out = ArrayRenderer.render(&block)
-    end
   end
 end

data/lib/api_builder/template.rb

@@ -3,12 +3,14 @@ require 'action_view/template'
 
 module ActionView
   module Template::Handlers
-    class ApiBuilder < Template::Handler
-      include Compilable
+    class ApiBuilder
 
-      def compile(template)
-        "block = lambda { " + template.source + " };" +
-        "ApiBuilder::BaseRenderer.render(params[:format], &block);"
+      def self.call(template)
+        "
+        extend ApiBuilder::Renderer
+        #{template.source}
+        get_output
+        "
       end
     end
   end

data/lib/api_builder/with_name.rb

@@ -0,0 +1,46 @@
+require 'builder'
+
+module ApiBuilder
+  class HashWithName < Hash
+    send :attr_accessor, :name
+    
+    def initialize(name)
+      @name = name
+    end
+
+    def to_xml(options = {})
+      super options.update(:root => name, :skip_types => true, :dasherize => false)
+    end
+  end
+
+  class ArrayWithName < Array
+    send :attr_accessor, :name
+    
+    def initialize(name)
+      @name = name
+    end
+
+    def to_xml(options = {})
+      super options.update(:root => name, :skip_types => true, :dasherize => false)
+    end
+  end
+
+  class StringWithName < String
+    send :attr_accessor, :name
+    
+    def initialize(name, value)
+      @name = name
+      super value.to_s
+    end
+
+    def to_xml(options = {})
+      if options[:builder]
+        xml = options[:builder]
+      else
+        xml = Builder::XmlMarkup.new
+        xml.instruct!
+      end
+      xml.tag! name, to_s
+    end
+  end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: api_builder
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 19
+  prerelease: 
   segments: 
-  - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Lasse Bunk
@@ -14,11 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-11 00:00:00 +02:00
-default_executable: 
+date: 2011-09-20 00:00:00 Z
 dependencies: []
 
-description: ApiBuilder is a Ruby on Rails template engine that allows for multiple formats being laid out in one specification, currently XML and JSON.
+description: ApiBuilder is a Ruby on Rails template engine that allows for multiple formats being laid out in a single specification, currently XML and JSON.
 email: lassebunk@gmail.com
 executables: []
 
@@ -27,15 +27,10 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- api_builder.gemspec
-- init.rb
 - lib/api_builder/renderer.rb
 - lib/api_builder/template.rb
+- lib/api_builder/with_name.rb
 - lib/api_builder.rb
-- MIT-LICENSE
-- Rakefile
-- README.rdoc
-has_rdoc: true
 homepage: http://github.com/lassebunk/api_builder
 licenses: []
 
@@ -45,23 +40,27 @@ 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.3.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Multiple API formats from a single specification.

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2011 Lasse Bunk
-
-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

@@ -1,42 +0,0 @@
-== About
-
-ApiBuilder is a Ruby on Rails template engine that allows for multiple formats being laid out in one specification, currently XML and JSON.
-The template engine currently returns a hash that is converted to either JSON or XML, JSON being the only usable format right now.
-
-== Installation
-
-  $ rails plugin install git://github.com/lassebunk/api_builder.git
-
-== Examples
-
-In app/views/users/index.apibuilder:
-
-  array do
-    @users.each do |user|
-      element do
-        id @user.id
-        name @user.name
-      end
-    end
-  end
-
-In app/views/users/show.apibuilder:
-
-  element do
-    id @user.id
-    name @user.name
-    address do
-      street @user.street
-      city @user.city
-    end
-    array :interests do
-      @user.interests.each do |interest|
-        element interest.name
-      end
-    end
-  end
-
-More examples to come. This is the first version which will be expanded as I use this myself.
-Inputs are welcome at lassebunk@gmail.com.
-
-Copyright (c) 2011 Lasse Bunk, released under the MIT license

data/Rakefile

@@ -1,23 +0,0 @@
-#!/usr/bin/env rake
-require 'rake/testtask'
-require 'rdoc/task'
-
-desc 'Default: run unit tests.'
-task :default => :test
-
-desc 'Test the api_builder plugin.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
-
-desc 'Generate documentation for the api_builder plugin.'
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'ApiBuilder'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/api_builder.gemspec

@@ -1,11 +0,0 @@
-Gem::Specification.new do |s|
-  s.name = "api_builder"
-  s.version = "0.0.1"
-
-  s.author = "Lasse Bunk"
-  s.email = "lassebunk@gmail.com"
-  s.description = "ApiBuilder is a Ruby on Rails template engine that allows for multiple formats being laid out in one specification, currently XML and JSON."
-  s.summary = "Multiple API formats from a single specification."
-  s.homepage = "http://github.com/lassebunk/api_builder"
-  s.files = Dir['**/*']
-end

data/init.rb

@@ -1 +0,0 @@
-require 'api_builder'