tokamak 1.0.0.beta2

data/.document

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,27 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+	if RUBY_VERSION < "1.9"
+	  gem "ruby-debug"
+	else
+	  gem "ruby-debug19", :require => "ruby-debug"
+	end
+end
+
+group :test do
+	gem "nokogiri"
+end
+
+gem "activesupport", ">= 3.0.0"
+gem "actionpack", ">= 3.0.0"
+gem "libxml-ruby"
+gem "json_pure"

data/Gemfile.lock

@@ -0,0 +1,77 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionpack (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activesupport (3.0.0)
+    archive-tar-minitar (0.5.2)
+    builder (2.1.2)
+    columnize (0.3.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    i18n (0.4.1)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json_pure (1.4.6)
+    libxml-ruby (1.1.4)
+    linecache19 (0.5.11)
+      ruby_core_source (>= 0.1.4)
+    nokogiri (1.4.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.12)
+      rack (>= 1.0.0)
+    rack-test (0.5.4)
+      rack (>= 1.0)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    ruby-debug-base19 (0.11.24)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.4)
+      archive-tar-minitar (>= 0.5.2)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (>= 3.0.0)
+  activesupport (>= 3.0.0)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  json_pure
+  libxml-ruby
+  nokogiri
+  rcov
+  rspec (~> 2.3.0)
+  ruby-debug19

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Guilherme Silveira
+
+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,69 @@
+= tokamak
+
+Tokamak is a hypermedia template engine created to enpower Restfulie.
+
+== Get it on baby!
+
+Based on Cipriani's example on the Restfulie mailing list, this is a simple Tokamak description:
+
+collection(@activities) do |collection|
+	collection.members do |m, activity|
+		member.values { |v| v.id = activity.id }
+		member.link "similar", url_for activity.similar
+	end
+end
+
+There is an entire chapter on tokamak usage on Restfulie's documentation. Go for it! If it still does not show what you want to generate, feel free to ask at Restfulie's mailing list.
+
+== A full bodied example
+
+collection(@activities) do |collection|
+  collection.members do |member, activity|
+    member.values { |values|
+
+      values.id           activity.id
+      values.title        activity.title
+
+      values.actor { 
+         values.type activity.actor_type.downcase
+         values.id   activity.actor_id
+      }
+
+      values.verbs  activity.verbs
+
+      values.object {
+        values.type activity.object_type.downcase
+        values.id   activity.object_id 
+        values.content activity.object.content if activity.object_content?
+      } 
+
+      if activity.indirect_object
+        values.indirect_object {
+          values.type activity.indirect_object_type.downcase
+          values.id   activity.indirect_object_id
+        }
+      end
+    }
+
+  end
+end
+
+== Team
+
+It was created by the team who contributed to Restfulie.
+
+== Contributing to tokamak
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 Guilherme Silveira. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "tokamak"
+  gem.homepage = "http://github.com/caelum/tokamak"
+  gem.license = "MIT"
+  gem.summary = %Q{A template engine for hypermedia resources}
+  gem.description = %Q{A template engine for hypermedia resources}
+  gem.email = "guilherme.silveira@caelum.com.br"
+  gem.authors = ["Guilherme Silveira"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tokamak #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0.beta2

data/lib/tokamak.rb

@@ -0,0 +1,21 @@
+require 'tokamak/xml'
+require 'tokamak/json'
+require 'tokamak/atom'
+require 'tokamak/values'
+require 'tokamak/representation'
+require 'tokamak/error'
+
+module Tokamak
+  
+  # Returns the default root element name for an item or collection
+  def self.root_element_for(obj)
+    if obj.kind_of?(Hash) && obj.size==1
+      obj.keys.first.to_s
+    elsif obj.kind_of?(Array) && !obj.empty?
+      root_element_for(obj.first).to_s.underscore.pluralize
+    else
+      obj.class.to_s.underscore
+    end
+  end
+  
+end

data/lib/tokamak/atom.rb

@@ -0,0 +1,8 @@
+module Tokamak
+  module Atom
+    autoload :Base, 'tokamak/atom/base'
+    autoload :Builder, 'tokamak/atom/builder'
+    autoload :Helpers, 'tokamak/atom/helpers'
+    extend Base::ClassMethods
+  end
+end

data/lib/tokamak/atom/base.rb

@@ -0,0 +1,87 @@
+require 'active_support/core_ext/hash/conversions'
+
+module Tokamak
+  module Atom
+    module Base
+      module ClassMethods 
+        mattr_reader :media_type_name
+        @@media_type_name = 'application/atom+xml'
+    
+        mattr_reader :headers
+        @@headers = { 
+          :get  => { 'Accept'       => media_type_name },
+          :post => { 'Content-Type' => media_type_name }
+        }
+    
+        mattr_reader :recipes
+        @@recipes = {}
+    
+        def helper
+          Tokamak::Atom::Helpers
+        end
+  
+        def describe_recipe(recipe_name, options={}, &block)
+          raise 'Undefined recipe' unless block_given?
+          raise 'Undefined recipe_name'   unless recipe_name
+          @@recipes[recipe_name] = block
+        end
+  
+        def to_atom(obj = nil, options = {}, &block)
+          # just instantiate the string with the atom factory
+          return Tokamak::Representation::Atom::Factory.create(obj) if obj.kind_of?(String)
+          
+          if block_given?
+            recipe = block
+          elsif options[:recipe]          
+            recipe = @@recipes[options[:recipe]]
+          else
+            return obj if obj.respond_to?(:atom_type) && (obj.atom_type == "feed" || obj.atom_type == "entry")
+            raise Tokamak::ConverterError.new("Recipe required")
+          end
+          
+          # execute with the builder if a recipe is set (even if the obj is an atom)
+          options[:atom_type] ||= obj.respond_to?(:each) ? :feed : :entry
+          raise Tokamak::ConverterError.new("Undefined atom type #{options[:atom_type]}") unless [:entry,:feed].include?(options[:atom_type])
+  
+          # Create representation and proxy
+          builder = Builder.new(options[:atom_type], obj)
+  
+          # Check recipe arity size before calling it
+          recipe.call(*[builder, obj, options][0,recipe.arity])
+  
+          builder.representation
+        end
+        
+        alias_method :unmarshal, :to_atom
+  
+        def to_hash(obj)
+          return obj if obj.kind_of?(Hash)
+  
+          xml = nil
+          
+          if obj.kind_of?(::String)
+             xml = obj
+          elsif obj.respond_to?(:to_xml)
+             xml = obj.to_xml
+          end
+  
+          Hash.from_xml(xml).with_indifferent_access unless xml.nil?
+        end
+  
+  
+        def to_s(obj)
+          return obj if obj.kind_of?(String)
+          if obj.respond_to?(:to_xml)
+            obj.to_xml.to_s
+          else
+            obj.to_s
+          end
+        end
+  
+        def marshal(obj, options = nil)
+          to_atom(obj, options).to_xml
+        end
+      end
+    end
+  end
+end

data/lib/tokamak/atom/builder.rb

@@ -0,0 +1,107 @@
+module Tokamak
+  module Atom
+    class Builder
+      attr_accessor :atom_type
+      def initialize(atom_type, obj)
+        @doc    = Nokogiri::XML::Document.new
+        @obj    = obj
+        @parent = @doc.create_element(atom_type.to_s)
+        @parent.add_namespace_definition(nil, "http://www.w3.org/2005/Atom")
+        @parent.parent = @doc
+      end
+  
+      def values(options = {}, &block)
+        options.each do |key,value|
+          attr = key.to_s
+          if attr =~ /^xmlns(:\w+)?$/
+            ns = attr.split(":", 2)[1]
+            @parent.add_namespace_definition(ns, value)
+          end
+        end            
+        yield Values.new(self)
+      end
+      
+      def members(options = {}, &block)
+        collection = options[:collection] || @obj 
+        raise Error::BuilderError.new("Members method require a collection to execute") unless collection.respond_to?(:each)
+        collection.each do |member|
+          entry = @doc.create_element("entry")
+          entry.parent = @parent
+          @parent = entry
+          block.call(self, member)
+          @parent = entry.parent
+        end
+      end
+      
+      def link(relationship, uri, options = {})
+        options["rel"] = relationship.to_s
+        options["href"] = uri
+        options["type"] ||= "application/atom+xml"
+        insert_value("link", nil, options)
+      end
+  
+      def insert_value(name, prefix, *args, &block)
+        node = create_element(name.to_s, prefix, *args)
+        node.parent = @parent            
+        if block_given?
+          @parent = node
+          block.call
+          @parent = node.parent
+        end
+      end
+  
+      def representation
+        Tokamak::Representation::Atom::Factory.create(@doc)
+      end
+      
+    private
+    
+      def create_element(node, prefix, *args)
+        node = @doc.create_element(node) do |n|
+          if prefix
+            if namespace = prefix_valid?(prefix)
+              # Adding namespace prefix
+              n.namespace = namespace
+              namespace = nil
+            end
+          end
+  
+          args.each do |arg|
+            case arg
+            # Adding XML attributes
+            when Hash
+              arg.each { |k,v|
+                key = k.to_s
+                if key =~ /^xmlns(:\w+)?$/
+                  ns_name = key.split(":", 2)[1]
+                  n.add_namespace_definition(ns_name, v)
+                  next
+                end
+                n[k.to_s] = v.to_s
+              }
+            # Adding XML node content
+            else            
+              arg.kind_of?(Time) || arg.kind_of?(DateTime) ? content = arg.xmlschema : content = arg
+              n.content = content
+            end
+          end
+        end
+      end
+      
+      def prefix_valid?(prefix)
+        ns = @parent.namespace_definitions.find { |x| x.prefix == prefix.to_s }
+        
+        unless ns
+          @parent.ancestors.each do |a|
+            next if a == @doc
+            ns = a.namespace_definitions.find { |x| x.prefix == prefix.to_s }
+            break if ns
+          end      
+        end
+        
+        return ns
+        #TODO: raise ArgumentError, "Namespace #{prefix} has not been defined" if wanted
+      end
+    end
+  end
+end