representative_view 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in representative_view.gemspec
+gemspec
+
+group :test do
+  gem "rake"
+  gem "rspec", "~> 2.0.1"
+  gem "rr", "~> 1.0.0"
+  gem "minstrel"
+end

data/README.markdown

@@ -0,0 +1,57 @@
+Representative View
+===================
+
+"Representative View" integrates [Representative](http://github.com/mdub/representative) as a Rails template format, making it possible to generate XML and JSON representations of data <u>using the same template</u>.
+
+Installing it
+-------------
+
+Simply add the '`representative_view`' gem to your `Gemfile` 
+
+    gem "representative_view"
+    
+and run "`bundle install`".
+
+Using it
+--------
+
+In your controller, declare that you can provide both XML and JSON, e.g.
+
+    class BooksController < ApplicationController
+  
+      def index
+        respond_to do |format|
+          format.xml
+          format.json
+        end
+      end
+  
+    end
+
+Next, create a template with the suffix "`.rep`" (to select the Representative View template handler) and use the Representative DSL to generate elements and lists, e.g.
+
+    # app/views/books/index.rep
+    
+    r.list_of :books, @books do
+      r.element :title
+      r.list_of :authors
+    end
+
+Note that it's "`index.rep`", not "`index.xml.rep`" or "`index.json.rep`"; by omitting the format specifier, the template will be used to render both formats.
+
+### Partials
+
+Representative View happily supports the use of partials, as long as they're also in Representative format.  Because Representative keeps track of the current "subject" as it renders, there's no need to explicitly pass an object into the partial:
+
+    # app/views/books/index.rep
+
+    r.list_of :books, @books do
+      render :partial => 'book'
+    end
+
+    # app/views/books/_book.rep
+
+    r.element :title
+    r.element :published do
+      r.element :by
+    end

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+
+task "default" => "spec"
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = ["--colour", "--format", "nested"]
+end

data/lib/representative_view.rb

@@ -0,0 +1 @@
+require 'representative_view/template_handler'

data/lib/representative_view/template_handler.rb

@@ -0,0 +1,60 @@
+require 'action_view'
+
+module RepresentativeView
+
+  class TemplateHandler < ActionView::Template::Handler
+
+    include ActionView::Template::Handlers::Compilable
+
+    self.default_format = Mime::XML
+
+    def compile(template)
+      require 'representative/json'
+      require 'representative/nokogiri'
+      <<-RUBY
+      representative_view do |r|
+        #{template.source}
+      end
+      RUBY
+    end
+
+  end
+
+  module ViewHelpers
+
+    def mime_type
+      format_extension = formats.first
+      Mime::Type.lookup_by_extension(format_extension.to_s) || begin
+        raise "unrecognised format #{format_extension.inspect}"
+      end
+    end
+    
+    def appropriate_representative_class
+      case mime_type.to_s
+      when /xml/
+        ::Representative::Nokogiri
+      when /json/
+        ::Representative::JSON
+      else
+        raise "cannot determine appropriate Representative class for #{mime_type.to_s.inspect}"
+      end
+    end
+
+    def representative_view
+      included = defined?(@_representative)
+      @_representative ||= appropriate_representative_class.new
+      yield @_representative
+      @_representative.to_s unless included
+    end
+    
+  end
+  
+end
+
+ActionView::Template.register_template_handler(:rep, RepresentativeView::TemplateHandler)
+
+class ActionView::Base
+  
+  include RepresentativeView::ViewHelpers
+  
+end

data/lib/representative_view/version.rb

@@ -0,0 +1,3 @@
+module RepresentativeView
+  VERSION = "0.0.1"
+end

data/representative_view.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "representative_view/version"
+
+Gem::Specification.new do |gem|
+  
+  gem.name = "representative_view"
+  gem.summary = "Builds XML and JSON from a single view template"
+  gem.homepage = "http://github.com/mdub/representative_view"
+  gem.authors = ["Mike Williams"]
+  gem.email = "mdub@dogbiscuit.org"
+
+  gem.version = RepresentativeView::VERSION.dup
+  gem.platform = Gem::Platform::RUBY
+
+  gem.add_runtime_dependency("representative", "~> 0.3.1")
+  gem.add_runtime_dependency("actionpack", "~> 3.0.1")
+  gem.add_runtime_dependency("nokogiri", ">= 1.4.2")
+  gem.add_runtime_dependency("json", ">= 1.4.5")
+
+  gem.require_paths = ["lib"]
+  
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files = `git ls-files -- spec/*`.split("\n")
+
+end

data/spec/fixtures/books.rb

@@ -0,0 +1,31 @@
+module Books
+
+  def all
+    [
+      OpenStruct.new(
+      :title => "Sailing for old dogs", 
+      :authors => ["Jim Watson"],
+      :published => OpenStruct.new(
+      :by => "Credulous Print",
+      :year => 1994
+      )
+      ),
+      OpenStruct.new(
+      :title => "On the horizon", 
+      :authors => ["Zoe Primpton", "Stan Ford"],
+      :published => OpenStruct.new(
+      :by => "McGraw-Hill",
+      :year => 2005
+      )
+      ),
+      OpenStruct.new(
+      :title => "The Little Blue Book of VHS Programming",
+      :authors => ["Henry Nelson"],
+      :rating => "****"
+      )
+    ]
+  end
+  
+  extend self
+  
+end

data/spec/representative_view/template_handler_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+describe "a Representative template" do
+
+  before do
+    write_template 'books.rep', <<-RUBY
+      r.list_of :books, @books do
+        r.element :title
+      end
+    RUBY
+  end
+  
+  it "can generate XML" do
+    render("books", :xml, :books => Books.all).should == undent(<<-XML)
+      <?xml version="1.0"?>
+      <books type="array">
+        <book>
+          <title>Sailing for old dogs</title>
+        </book>
+        <book>
+          <title>On the horizon</title>
+        </book>
+        <book>
+          <title>The Little Blue Book of VHS Programming</title>
+        </book>
+      </books>
+    XML
+  end
+
+  it "can generate XML dialects" do
+    Mime::Type.register "application/vnd.books+xml", :book_xml
+    render("books", :book_xml, :books => Books.all).should == undent(<<-XML)
+      <?xml version="1.0"?>
+      <books type="array">
+        <book>
+          <title>Sailing for old dogs</title>
+        </book>
+        <book>
+          <title>On the horizon</title>
+        </book>
+        <book>
+          <title>The Little Blue Book of VHS Programming</title>
+        </book>
+      </books>
+    XML
+  end
+
+  it "can generate JSON" do
+    render("books", :json, :books => Books.all).should == undent(<<-JSON)
+      [
+        {
+          "title": "Sailing for old dogs"
+        },
+        {
+          "title": "On the horizon"
+        },
+        {
+          "title": "The Little Blue Book of VHS Programming"
+        }
+      ]
+    JSON
+  end
+
+  it "can include partials" do
+
+    write_template 'books_with_partial.rep', <<-RUBY
+    r.list_of :books, @books do
+      render :partial => 'book'
+    end
+    RUBY
+
+    write_template '_book.rep', <<-RUBY
+    r.element :title
+    r.element :published do
+      r.element :by
+    end
+    RUBY
+
+    render("books_with_partial", :json, :books => Books.all).should == undent(<<-JSON)
+      [
+        {
+          "title": "Sailing for old dogs",
+          "published": {
+            "by": "Credulous Print"
+          }
+        },
+        {
+          "title": "On the horizon",
+          "published": {
+            "by": "McGraw-Hill"
+          }
+        },
+        {
+          "title": "The Little Blue Book of VHS Programming",
+          "published": null
+        }
+      ]
+    JSON
+
+  end
+  
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,52 @@
+require 'action_view'
+require 'minstrel'
+require 'representative_view'
+require 'rspec'
+
+require 'pathname'
+require 'fixtures/books'
+
+$tmp_dir = Pathname(__FILE__).parent.parent + "tmp"
+$template_dir = $tmp_dir + "templates"
+    
+module Fixtures
+  
+  def write_template(name, content)
+    template_path = $template_dir + name
+    template_path.parent.mkpath
+    template_path.open("w") do |io|
+      io << content
+    end
+  end
+
+  def render(file, format = :xml, assigns = {})
+    @base = ActionView::Base.new($template_dir.to_str, assigns)
+    @base.lookup_context.freeze_formats([format])
+    @base.render(:file => file)
+  end
+
+end
+
+Rspec.configure do |config|
+  
+  config.mock_with :rr
+  config.include(Fixtures)
+  
+  config.before do
+    $template_dir.mkpath
+  end
+
+  config.after do
+    $tmp_dir.rmtree if $tmp_dir.exist?
+  end
+
+end
+
+def undent(raw)
+  if raw =~ /\A( +)/
+    indent = $1
+    raw.gsub(/^#{indent}/, '').gsub(/ +$/, '')
+  else
+    raw
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification 
+name: representative_view
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mike Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-10 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 0
+        - 3
+        - 1
+        version: 0.3.1
+  prerelease: false
+  type: :runtime
+  requirement: *id001
+  name: representative
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        - 0
+        - 1
+        version: 3.0.1
+  prerelease: false
+  type: :runtime
+  requirement: *id002
+  name: actionpack
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 4
+        - 2
+        version: 1.4.2
+  prerelease: false
+  type: :runtime
+  requirement: *id003
+  name: nokogiri
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 4
+        - 5
+        version: 1.4.5
+  prerelease: false
+  type: :runtime
+  requirement: *id004
+  name: json
+description: 
+email: mdub@dogbiscuit.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/representative_view.rb
+- lib/representative_view/template_handler.rb
+- lib/representative_view/version.rb
+- representative_view.gemspec
+- spec/fixtures/books.rb
+- spec/representative_view/template_handler_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mdub/representative_view
+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.0
+signing_key: 
+specification_version: 3
+summary: Builds XML and JSON from a single view template
+test_files: 
+- spec/fixtures/books.rb
+- spec/representative_view/template_handler_spec.rb
+- spec/spec_helper.rb