hypertemplate 1.2.0

data/test/hypertemplate/helper_test.rb

@@ -0,0 +1,116 @@
+require 'test_helper'
+
+# every builder comes with a default helper, with collection and member methods. See lib/hypertemplate/builder.rb
+class TestDefaultHelper
+  extend Hypertemplate::Builder::Json.helper
+end
+
+# but here you can cheack how to pass other default options to helper methods
+class DummyAtom < Hypertemplate::Builder::Base
+  
+  def self.media_types
+    ["application/atom+xml"]
+  end
+
+  collection_helper_default_options :atom_type => :feed
+  member_helper_default_options     :atom_type => :entry
+  
+  def initialize(obj, options = {})
+    #do nothing
+  end
+  
+  def representation
+    "puft!"
+  end
+end
+class AtomGenerator
+  extend DummyAtom.helper
+end
+
+# how to complete override the helper
+module MyHelper
+  # these examples are just to show that you can freely change the behavior 
+  # of the helper methods, since you respect the methods signature
+  def collection(obj, *args, &block)
+    member(obj, *args, &block)
+  end
+
+  def member(obj, *args, &block)
+    default_options = {:my_option => "my_value"}
+    default_options.merge!(args.shift)
+    args.unshift(default_options)
+    OverwrittenHelperBuilder.build(obj, *args, &block)
+  end
+end
+class OverwrittenHelperBuilder < Hypertemplate::Builder::Base
+  def self.media_types
+    ["some/media+type"]
+  end
+
+  # just implement this method passing the new helper
+  def self.helper
+    MyHelper
+  end
+  
+  def initialize(obj, options = {})
+    #do nothing
+  end
+  
+  def representation
+    "pleft!"
+  end
+end
+class TestOverwrittenHelper
+  extend OverwrittenHelperBuilder.helper
+end
+
+class Hypertemplate::Builder::HelperTest < Test::Unit::TestCase
+  
+  def setup
+    @registry = Hypertemplate::Registry.new
+    @registry << DummyAtom
+  end
+
+  def test_default_helper
+    obj = { :foo => "bar" }
+    a_collection = [1,2,3,4]
+    json = TestDefaultHelper.collection(obj) do |collection|
+      collection.values do |values|
+        values.id "an_id"
+      end
+
+      collection.members(:collection => a_collection) do |member, number|
+        member.values do |values|
+          values.id number
+        end
+      end
+    end
+
+    hash = JSON.parse(json).extend(Methodize)
+
+    assert_equal "an_id", hash.id
+    assert_equal 1      , hash.members.first.id
+    assert_equal 4      , hash.members.size
+  end
+
+  def test_helper_with_options_overwritten
+    numbers = [1,2,3,4,5]
+    result = AtomGenerator.collection(numbers, :other_option => "an_option") do |collection, num, opt|
+      assert_equal :feed      , opt[:atom_type]
+      assert_equal "an_option", opt[:other_option]
+      assert_equal [1,2,3,4,5], num
+    end
+    assert_equal "puft!", result
+  end
+  
+  def test_overwritten_helper
+    numbers = [1,2,3,4,5]
+    result = TestOverwrittenHelper.collection(numbers, :other_option => "an_option") do |collection, num, opt|
+      assert_equal "an_option", opt[:other_option]
+      assert_equal "my_value" , opt[:my_option]
+      assert_equal [1,2,3,4,5], num
+    end
+    assert_equal "pleft!", result
+  end
+end
+

data/test/hypertemplate/hook/rails_test.rb

@@ -0,0 +1,77 @@
+require 'test/unit'
+require 'rubygems'
+require "methodize"
+require "rack/conneg"
+
+begin
+  require 'ruby-debug'
+rescue Exception => e; end
+
+require File.expand_path(File.dirname(__FILE__) + '/../../rails2_skel/config/environment.rb')
+
+# put the require below to use hypertemplate in your rails project
+require "hypertemplate/hook/rails"
+
+class Hypertemplate::Hook::RailsTest < ActionController::IntegrationTest
+
+  def test_view_generation_with_json
+    get '/test/show', {}, :accept => 'application/json'
+
+    json = @controller.response.body
+    hash = JSON.parse(json).extend(Methodize)
+
+    assert_equal "John Doe"               , hash.author.first.name
+    assert_equal "foobar@example.com"     , hash.author.last.email
+    assert_equal "http://example.com/json", hash.id
+
+    assert_equal "http://a.link.com/next" , hash.link.first.href
+    assert_equal "next"                   , hash.link.first.rel
+    assert_equal "application/json"       , hash.link.last.type
+
+    assert_equal "uri:1"                      , hash.articles.first.id
+    assert_equal "a great article"            , hash.articles.first.title
+    assert_equal "http://example.com/image/1" , hash.articles.last.link.first.href
+    assert_equal "image"                      , hash.articles.last.link.first.rel
+    assert_equal "application/json"           , hash.articles.last.link.last.type
+  end
+
+  def test_view_generation_with_xml
+    get '/test/show', {}, :accept => 'application/xml'
+
+    xml = @controller.response.body
+    xml = Nokogiri::XML::Document.parse(xml)
+
+    assert_equal "John Doe"               , xml.css("root > author").first.css("name").first.text
+    assert_equal "foobar@example.com"     , xml.css("root > author").last.css("email").first.text
+
+    assert_equal "http://a.link.com/next" , xml.css("root > link").first["href"]
+    assert_equal "next"                   , xml.css("root > link").first["rel"]
+    assert_equal "application/xml"        , xml.css("root > link").last["type"]
+
+    assert_equal "uri:1"                      , xml.css("root > articles").first.css("id").first.text
+    assert_equal "a great article"            , xml.css("root > articles").first.css("title").first.text
+    assert_equal "http://example.com/image/1" , xml.css("root > articles").first.css("link").first["href"]
+    assert_equal "image"                      , xml.css("root > articles").first.css("link").first["rel"]
+    assert_equal "application/json"           , xml.css("root > articles").first.css("link").last["type"]
+  end
+
+  def test_view_generation_with_partial
+    get '/test/feed', {}, :accept => 'application/xml'
+
+    xml = @controller.response.body
+    xml = Nokogiri::XML::Document.parse(xml)
+
+    assert_equal "John Doe"               , xml.css("root > author").first.css("name").first.text
+    assert_equal "foobar@example.com"     , xml.css("root > author").last.css("email").first.text
+
+    assert_equal "http://a.link.com/next" , xml.css("root > link").first["href"]
+    assert_equal "next"                   , xml.css("root > link").first["rel"]
+    assert_equal "application/xml"        , xml.css("root > link").last["type"]
+
+    assert_equal "uri:1"                      , xml.css("root > articles").first.css("id").first.text
+    assert_equal "a great article"            , xml.css("root > articles").first.css("title").first.text
+    assert_equal "http://example.com/image/1" , xml.css("root > articles").first.css("link").first["href"]
+    assert_equal "image"                      , xml.css("root > articles").first.css("link").first["rel"]
+    assert_equal "application/json"           , xml.css("root > articles").first.css("link").last["type"]
+  end
+end

data/test/hypertemplate/hook/sinatra_test.rb

@@ -0,0 +1,89 @@
+require 'test/unit'
+require 'rubygems'
+require "methodize"
+require "sinatra"
+require "rack/conneg"
+
+begin
+  require 'ruby-debug'
+rescue Exception => e; end
+
+# requiring the hook for sinatra
+require "hypertemplate/hook/sinatra"
+
+# simple sinatra app declaration
+set :views, File.expand_path(File.dirname(__FILE__) + '/../../rails2_skel/app/views/test')
+
+use(Rack::Hypertemplate)
+use(Rack::Conneg) do |conneg|
+  conneg.set :accept_all_extensions, false
+  conneg.set :fallback, :html
+  conneg.ignore('/public/')
+  conneg.provide([:json,:xml])
+end
+
+before do
+  if negotiated?
+    content_type negotiated_type
+  end
+end
+
+get "/" do
+  some_articles = [
+    {:id => 1, :title => "a great article", :updated => Time.now},
+    {:id => 2, :title => "another great article", :updated => Time.now}
+  ]
+  hyper :show, {}, {:@some_articles => some_articles}
+end
+
+require "rack/test"
+ENV['RACK_ENV'] = 'test'
+
+class Hypertemplate::Hook::SinatraTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    Sinatra::Application
+  end
+
+  def test_hypertemplate_builder_hook_with_sinatra_rendering_json
+    get '/', {}, {"HTTP_ACCEPT" => "application/json"}
+
+    assert last_response.ok?
+    hash     = JSON.parse(last_response.body).extend(Methodize)
+
+    assert_equal "John Doe"               , hash.author.first.name
+    assert_equal "foobar@example.com"     , hash.author.last.email
+    assert_equal "http://example.com/json", hash.id
+
+    assert_equal "http://a.link.com/next" , hash.link.first.href
+    assert_equal "next"                   , hash.link.first.rel
+    assert_equal "application/json"       , hash.link.last.type
+
+    assert_equal "uri:1"                      , hash.articles.first.id
+    assert_equal "a great article"            , hash.articles.first.title
+    assert_equal "http://example.com/image/1" , hash.articles.last.link.first.href
+    assert_equal "image"                      , hash.articles.last.link.first.rel
+    assert_equal "application/json"           , hash.articles.last.link.last.type
+  end
+
+  def test_hypertemplate_builder_hook_with_sinatra_rendering_xml
+    get '/', {}, {"HTTP_ACCEPT" => "application/xml"}
+
+    xml = Nokogiri::XML::Document.parse(last_response.body)
+
+    assert_equal "John Doe"               , xml.css("root > author").first.css("name").first.text
+    assert_equal "foobar@example.com"     , xml.css("root > author").last.css("email").first.text
+
+    assert_equal "http://a.link.com/next" , xml.css("root > link").first["href"]
+    assert_equal "next"                   , xml.css("root > link").first["rel"]
+    assert_equal "application/xml"        , xml.css("root > link").last["type"]
+
+    assert_equal "uri:1"                      , xml.css("root > articles").first.css("id").first.text
+    assert_equal "a great article"            , xml.css("root > articles").first.css("title").first.text
+    assert_equal "http://example.com/image/1" , xml.css("root > articles").first.css("link").first["href"]
+    assert_equal "image"                      , xml.css("root > articles").first.css("link").first["rel"]
+    assert_equal "application/json"           , xml.css("root > articles").first.css("link").last["type"]
+  end
+
+end

data/test/hypertemplate/hook/tilt_test.rb

@@ -0,0 +1,48 @@
+require 'test/unit'
+require 'rubygems'
+require "methodize"
+require "tilt"
+
+begin
+  require 'ruby-debug'
+rescue Exception => e; end
+
+require "hypertemplate/hook/tilt"
+
+class Hypertemplate::Hook::TiltTest < Test::Unit::TestCase
+  
+  def setup
+    @hypertemplate = Hypertemplate::Registry.new
+    @hypertemplate << Hypertemplate::Builder::Json
+  end
+  def hypertemplate_registry
+    @hypertemplate
+  end
+
+  def test_hypertemplate_builder_integration_with_tilt
+    
+    @some_articles = [
+      {:id => 1, :title => "a great article", :updated => Time.now},
+      {:id => 2, :title => "another great article", :updated => Time.now}
+    ]
+
+    view = File.expand_path(File.dirname(__FILE__) + '/../../rails2_skel/app/views/test/show.hyper')
+    template = Hypertemplate::Hook::Tilt::HypertemplateTemplate.new(@hypertemplate, view, :media_type => "application/json")
+    json     = template.render(self, :@some_articles => @some_articles)
+    hash     = JSON.parse(json).extend(Methodize)
+
+    assert_equal "John Doe"               , hash.author.first.name
+    assert_equal "foobar@example.com"     , hash.author.last.email
+    assert_equal "http://example.com/json", hash.id
+
+    assert_equal "http://a.link.com/next" , hash.link.first.href
+    assert_equal "next"                   , hash.link.first.rel
+    assert_equal "application/json"       , hash.link.last.type
+
+    assert_equal "uri:1"                      , hash.articles.first.id
+    assert_equal "a great article"            , hash.articles.first.title
+    assert_equal "http://example.com/image/1" , hash.articles.last.link.first.href
+    assert_equal "image"                      , hash.articles.last.link.first.rel
+    assert_equal "application/json"           , hash.articles.last.link.last.type
+  end
+end

data/test/hypertemplate/recipes_test.rb

@@ -0,0 +1,94 @@
+require 'test_helper'
+
+class Hypertemplate::RecipesTest < Test::Unit::TestCase
+  
+  def setup
+    @recipes = Hypertemplate::Recipes.new
+  end
+
+  def test_add_recipe_to_hypertemplate
+    @recipes.add "foo" do
+      string = "recipes are represented as blocks"
+    end
+    @recipes.add :bar do
+      string = "recipes are represented as blocks"
+    end
+
+    assert_equal Proc, @recipes["foo"].class
+    assert_equal Proc, @recipes[:bar].class
+    assert_equal nil , @recipes["undeclared recipe"]
+  end
+
+  def test_remove_recipe_from_hypertemplate
+    @recipes.add :bar do
+      string = "recipes are represented as blocks"
+    end
+    @recipes.remove(:bar)
+
+    assert_equal nil, @recipes[:bar]
+  end
+
+  def test_list_recipe_names
+    @recipes.add "foo" do
+      string = "recipes are represented as blocks"
+    end
+    @recipes.add :bar do
+      string = "recipes are represented as blocks"
+    end
+
+    assert @recipes.list.include?(:bar)
+    assert @recipes.list.include?("foo")
+  end
+
+  def test_builder_with_previously_declared_recipe
+    obj = [{ :foo => "bar" }]
+
+    @recipes.add :simple_feed do |collection|
+      collection.values do |values|
+        values.id "an_id"
+      end
+
+      collection.members do |member, some_foos|
+        member.values do |values|
+          values.id some_foos[:foo]
+        end
+      end
+    end
+
+    json = Hypertemplate::Builder::Json.build(obj, :recipe => @recipes[:simple_feed])
+    hash = JSON.parse(json).extend(Methodize)
+
+    assert_equal "an_id", hash.id
+    assert_equal "bar"  , hash.members.first.id
+  end
+
+  def test_raise_exception_with_a_undeclared_recipe
+    obj = [{ :foo => "bar" }]
+
+    assert_raise Hypertemplate::BuilderError do
+      json = Hypertemplate::Builder::Json.build(obj, :recipe => nil)
+    end
+  end
+
+  def test_builder_with_recipe_option_as_a_block
+    obj = [{ :foo => "bar" }]
+
+    json = Hypertemplate::Builder::Json.build(obj, :recipe => Proc.new { |collection|
+      collection.values do |values|
+        values.id "an_id"
+      end
+
+      collection.members do |member, some_foos|
+        member.values do |values|
+          values.id some_foos[:foo]
+        end
+      end
+    })
+    hash = JSON.parse(json).extend(Methodize)
+
+    assert_equal "an_id", hash.id
+    assert_equal "bar"  , hash.members.first.id
+  end
+
+end
+

data/test/rails2_skel/Rakefile

@@ -0,0 +1,16 @@
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+require 'rake'
+# require 'rake/testtask'
+# require 'rake/rdoctask'
+# require 'tasks/rails'
+
+# extracted from 'tasks/rails' since its the only tasks we're interested in
+$VERBOSE = nil
+
+task :default => :middleware
+task :environment do
+  $rails_rake_task = true
+  require(File.join(RAILS_ROOT, 'config', 'environment'))
+end
+
+

data/test/rails2_skel/app/controllers/application_controller.rb

@@ -0,0 +1 @@
+class ApplicationController < ActionController::Base; end