representative_view 1.1.0 → 1.2.0

data/CHANGES.markdown

@@ -0,0 +1,10 @@
+1.2.0 - 2011-09-06
+------------------
+
+### Enhancements
+
+  - Addition of `representative(FORMAT)` method, allowing a format to be forced.
+
+### Removals
+
+  - We no longer attempt to infer an output format from the template format.

data/README.markdown

@@ -37,7 +37,7 @@ Next, create a template with the suffix "`.rep`" (to select the Representative V
       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.
+Note that it's "`index.rep`", not "`index.xml.rep`" or "`index.json.rep`"; those will work, too, but by omitting the format specifier, the same template can be used to render both formats.
 
 ### Partials
 
@@ -56,6 +56,25 @@ Representative View happily supports the use of partials, as long as they're als
       r.element :by
     end
 
+#### Forcing a format
+
+It can occasionally be useful to include a ".rep" partial from within a non-Representative template, for instance to generate a sample JSON or XML representation in HTML-based API documentation.  This is possible by forcing a format using the `representative` helper-method, as follows:
+
+    # app/views/doc/things.html.erb
+
+    <h2>Sample JSON output</h2>
+
+    <pre>
+    <%= representative(:json) { render :partial => 'sample_things' } %>
+    </pre>
+
+    # app/views/doc/_sample_things.rep
+
+    r.list_of :things, SampleThings.all do
+      r.element :name
+      r.element :description
+    end
+
 Configuration
 -------------
 

data/lib/representative_view/action_pack_3_handler.rb

@@ -2,17 +2,13 @@ require 'representative_view/view_helpers'
 
 module RepresentativeView
 
-  class ActionPack3Handler < ActionView::Template::Handler
+  class ActionPack3Handler
 
-    include ActionView::Template::Handlers::Compilable
-
-    self.default_format = nil
-
-    def compile(template)
+    def self.call(template)
       require 'representative/json'
       require 'representative/nokogiri'
       <<-RUBY
-      representative_view(#{template.formats.first.inspect}) do |r|
+      representative_view(formats.first) do |r|
         #{template.source}
       end
       RUBY

data/lib/representative_view/version.rb

@@ -1,3 +1,3 @@
 module RepresentativeView
-  VERSION = "1.1.0"
+  VERSION = "1.2.0".freeze
 end

data/lib/representative_view/view_helpers.rb

@@ -5,16 +5,36 @@ module RepresentativeView
   module ViewHelpers
 
     def representative_view(format)
-      if defined?(@_representative) 
-        yield @_representative # included
+      if current_representative
+        yield current_representative
       else
-        @_representative = create_representative(format)
-        yield @_representative
-        @_representative.to_s
+        representative(format) do
+          yield current_representative
+        end
       end
     end
 
-    private 
+    def representative(format, &block)
+      r = create_representative(format)
+      with_representative(r, &block)
+      r.to_s
+    end
+
+    private
+
+    def current_representative
+      @_current_representative
+    end
+
+    def with_representative(representative)
+      old_representative = @_current_representative
+      begin
+        @_current_representative = representative
+        yield representative
+      ensure
+        @_current_representative = old_representative
+      end
+    end
 
     def create_representative(format)
       mime_type = Mime::Type.lookup_by_extension(format) || begin

data/representative_view.gemspec

@@ -3,7 +3,7 @@ $:.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"
@@ -13,13 +13,11 @@ Gem::Specification.new do |gem|
   gem.version = RepresentativeView::VERSION.dup
   gem.platform = Gem::Platform::RUBY
 
-  gem.add_runtime_dependency("representative", "~> 0.3.1")
+  gem.add_runtime_dependency("representative", "~> 1.0.2")
   gem.add_runtime_dependency("actionpack", "> 2.3.0", "< 4.0.0")
-  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")
 

data/spec/representative_view/template_handler_spec.rb

@@ -102,30 +102,67 @@ describe "a Representative template" do
 
   end
 
-  it "can infer the format from the file" do
-    write_template 'more_books.json.rep', <<-RUBY
+  it "can force a format for partials" do
+
+    write_template '_books.rep', <<-RUBY
       r.list_of :books, @books do
         r.element :title
       end
     RUBY
 
-    render("more_books.json", :html, :books => Books.all).should == undent(<<-JSON)
+    write_template 'books.html.erb', undent(<<-HTML)
+      <h2>JSON REPRESENTATION</h2>
+
+      <pre>
+      <%= h representative(:json) { render :partial => 'books' } %></pre>
+
+      <h2>XML REPRESENTATION</h2>
+
+      <pre>
+      <%= h representative(:xml) { render :partial => 'books' } %></pre>
+    HTML
+
+    render("books", :html, :books => Books.all).should == undent(<<-HTML)
+      <h2>JSON REPRESENTATION</h2>
+
+      <pre>
       [
         {
-          "title": "Sailing for old dogs"
+          &quot;title&quot;: &quot;Sailing for old dogs&quot;
         },
         {
-          "title": "On the horizon"
+          &quot;title&quot;: &quot;On the horizon&quot;
         },
         {
-          "title": "The Little Blue Book of VHS Programming"
+          &quot;title&quot;: &quot;The Little Blue Book of VHS Programming&quot;
         }
       ]
-    JSON
+      </pre>
+
+      <h2>XML REPRESENTATION</h2>
+
+      <pre>
+      &lt;?xml version=&quot;1.0&quot;?&gt;
+      &lt;books type=&quot;array&quot;&gt;
+        &lt;book&gt;
+          &lt;title&gt;Sailing for old dogs&lt;/title&gt;
+        &lt;/book&gt;
+        &lt;book&gt;
+          &lt;title&gt;On the horizon&lt;/title&gt;
+        &lt;/book&gt;
+        &lt;book&gt;
+          &lt;title&gt;The Little Blue Book of VHS Programming&lt;/title&gt;
+        &lt;/book&gt;
+      &lt;/books&gt;
+      </pre>
+    HTML
+
   end
 
   it "allows configuration of json_options" do
+
     RepresentativeView.json_options = {:naming_strategy => :upcase}
+
     render("books", :json, :books => Books.all).should == undent(<<-JSON)
       [
         {
@@ -139,11 +176,13 @@ describe "a Representative template" do
         }
       ]
     JSON
+
   end
 
   it "allows configuration of xml_options" do
 
     RepresentativeView.xml_options = {:naming_strategy => :upcase}
+
     render("books", :xml, :books => Books.all).should == undent(<<-XML)
       <?xml version="1.0"?>
       <BOOKS TYPE="array">
@@ -158,6 +197,7 @@ describe "a Representative template" do
         </BOOK>
       </BOOKS>
     XML
+
   end
 
-end
+end

metadata

@@ -1,74 +1,49 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: representative_view
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.2.0
   prerelease: 
-  version: 1.1.0
 platform: ruby
-authors: 
+authors:
 - Mike Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-28 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-09-06 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: representative
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70240665487840 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.3.1
+      - !ruby/object:Gem::Version
+        version: 1.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70240665487840
+- !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &70240665487140 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">"
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
         version: 2.3.0
     - - <
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 4.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: nokogiri
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.4.2
-  type: :runtime
-  prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: json
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.4.5
-  type: :runtime
-  prerelease: false
-  version_requirements: *id004
+  version_requirements: *70240665487140
 description: 
 email: mdub@dogbiscuit.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- CHANGES.markdown
 - Gemfile
 - README.markdown
 - Rakefile
@@ -84,38 +59,35 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/mdub/representative_view
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 738900437358486891
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 2640363158941591145
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 738900437358486891
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 2640363158941591145
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Builds XML and JSON from a single view template
-test_files: 
+test_files:
 - spec/fixtures/books.rb
 - spec/representative_view/template_handler_spec.rb
 - spec/spec_helper.rb