representative 1.0.4 → 1.0.5

data/lib/representative/json.rb

@@ -7,12 +7,14 @@ module Representative
   class Json < Base
 
     DEFAULT_ATTRIBUTE_PREFIX = "@".freeze
+    DEFAULT_INDENTATION = 2 # two spaces
 
     def initialize(subject = nil, options = {})
       super(subject, options)
       @buffer = []
       @indent_level = 0
-      @attribute_prefix = options[:attribute_prefix] || DEFAULT_ATTRIBUTE_PREFIX
+      @indent_string = resolve_indentation(options.fetch(:indentation, DEFAULT_INDENTATION))
+      @attribute_prefix = options.fetch(:attribute_prefix, DEFAULT_ATTRIBUTE_PREFIX)
       now_at :beginning_of_buffer
       yield self if block_given?
     end
@@ -82,7 +84,7 @@ module Representative
     end
 
     def to_json
-      @buffer << "\n"
+      emit("\n") if indenting?
       @buffer.join
     end
 
@@ -92,6 +94,19 @@ module Representative
 
     private
 
+    def resolve_indentation(arg)
+      case arg
+      when Integer
+        " " * arg
+      when /\A[ \t]*\Z/
+        arg
+      when nil, false
+        false
+      else
+        raise ArgumentError, "invalid indentation setting"
+      end
+    end
+
     def emit(s)
       @buffer << s
     end
@@ -100,20 +115,27 @@ module Representative
       ActiveSupport::JSON.encode(data)
     end
 
-    def indentation
-      ("  " * @indent_level)
+    def indenting?
+      !!@indent_string
+    end
+
+    def current_indentation
+      (@indent_string * @indent_level)
     end
 
     def label(name)
       return false if @indent_level == 0
       new_item
-      emit(format_name(name).inspect + ": ")
+      emit(format_name(name).inspect + ":")
+      emit(" ") if indenting?
     end
 
     def new_item
       emit(",") if at? :end_of_item
-      emit("\n") unless at? :beginning_of_buffer
-      emit(indentation)
+      if indenting?
+        emit("\n") unless at? :beginning_of_buffer
+        emit(current_indentation)
+      end
       @pending_comma = ","
     end
 
@@ -123,7 +145,9 @@ module Representative
       now_at :beginning_of_block
       yield
       @indent_level -= 1
-      emit("\n" + indentation) unless at? :beginning_of_block
+      if indenting?
+        emit("\n" + current_indentation) unless at? :beginning_of_block
+      end
       emit(closing_char)
       now_at :end_of_item
     end

data/lib/representative/version.rb

@@ -1,3 +1,3 @@
 module Representative
-  VERSION = "1.0.4".freeze
+  VERSION = "1.0.5".freeze
 end

data/spec/representative/json_spec.rb

@@ -33,9 +33,9 @@ describe Representative::Json do
         end
 
       end
-      
+
       describe "with a nil value" do
-        
+
         it "generates null" do
           r.element :flavour, nil
           resulting_json.should == "null\n"
@@ -51,13 +51,13 @@ describe Representative::Json do
           end
 
         end
-        
+
       end
-      
+
       describe "with attributes" do
-        
+
         describe "and a block" do
-          
+
           it "generates labelled fields for the attributes" do
             @book = OpenStruct.new(:lang => "fr", :title => "En Edge")
             r.element :book, @book, :lang => :lang do
@@ -70,20 +70,20 @@ describe Representative::Json do
             }
             JSON
           end
-          
+
         end
 
         describe "and an explicit value" do
-          
+
           it "ignores the attributes" do
             r.element :review, "Blah de blah", :lang => "fr"
             resulting_json.should == undent(<<-JSON)
             "Blah de blah"
             JSON
           end
-          
+
         end
-        
+
       end
 
       describe "without an explicit value" do
@@ -144,7 +144,7 @@ describe Representative::Json do
           }
           JSON
         end
-        
+
       end
 
       describe "with a block" do
@@ -176,9 +176,9 @@ describe Representative::Json do
           ]
           JSON
         end
-        
+
       end
-      
+
       describe "with item attributes" do
         it "adds the attributes with an @ sign to child elements" do
           @authors = [
@@ -198,7 +198,7 @@ describe Representative::Json do
               "age": 3
             },
             {
-              "@about": "Dewey is 4 years old",              
+              "@about": "Dewey is 4 years old",
               "name": "Dewey",
               "age": 4
             },
@@ -211,19 +211,19 @@ describe Representative::Json do
           JSON
         end
       end
-      
+
       describe "with list attributes" do
         it "raises an ArgumentError" do
           @authors = []
           lambda{ r.list_of(:authors, @authors, :list_attributes => {}) {} }.should raise_exception(ArgumentError)
         end
       end
-      
+
       describe "with unnecessary arguments" do
         it "raises an ArgumentError" do
           @authors = []
-          lambda{ 
-            r.list_of(:authors, @authors, :unecessary_arg_should_cause_failure, :item_attributes => {}){} 
+          lambda{
+            r.list_of(:authors, @authors, :unecessary_arg_should_cause_failure, :item_attributes => {}){}
           }.should raise_exception(ArgumentError)
         end
       end
@@ -231,16 +231,16 @@ describe Representative::Json do
     end
 
     describe "#comment" do
-      
+
       it "inserts a comment" do
         r.comment "now pay attention"
         resulting_json.should == undent(<<-JSON)
         // now pay attention
         JSON
       end
-      
+
     end
-    
+
   end
 
   describe "within an element block" do
@@ -269,7 +269,7 @@ describe Representative::Json do
             r.element :age
           end
           resulting_json.should == undent(<<-JSON)
-          { 
+          {
             "name": "Fred",
             "age": 36
           }
@@ -281,7 +281,7 @@ describe Representative::Json do
     end
 
     describe "#attribute" do
-      
+
       it "generates labelled values, with a label prefix" do
         r.element :author, Object.new do
           r.attribute :href, "http://example.com/authors/1"
@@ -294,11 +294,11 @@ describe Representative::Json do
         }
         JSON
       end
-      
+
     end
-    
+
     describe "#comment" do
-      
+
       it "inserts a comment" do
         @author = OpenStruct.new(:name => "Fred", :age => 36)
         r.element :author, @author do
@@ -307,33 +307,33 @@ describe Representative::Json do
           r.element :age
         end
         resulting_json.should == undent(<<-JSON)
-        { 
+        {
           "name": "Fred",
           // age is irrelevant
           "age": 36
         }
         JSON
       end
-      
+
     end
-    
+
   end
 
   context "by default" do
-    
+
     it "does not tranform element names" do
       r.element :user, Object.new do
         r.element :full_name, "Fred Bloggs"
       end
       resulting_json.should == undent(<<-JSON)
-      { 
+      {
         "full_name": "Fred Bloggs"
       }
       JSON
     end
 
   end
-  
+
   context "with naming_strategy :camelcase" do
 
     it "generates camelCased element and attribute names" do
@@ -343,7 +343,7 @@ describe Representative::Json do
         r.element :full_name
       end
       resulting_json.should == undent(<<-JSON)
-      { 
+      {
         "@altUrl": "http://xyz.com",
         "fullName": "Fred Bloggs"
       }
@@ -352,4 +352,73 @@ describe Representative::Json do
 
   end
 
+  context "with :indentation option" do
+
+    before do
+      @authors = [
+        OpenStruct.new(:name => "Hewey", :age => 3),
+        OpenStruct.new(:name => "Dewey", :age => 4)
+      ]
+    end
+
+    context "set to an integer" do
+
+      it "indents the specified number of spaces" do
+        r(:indentation => 3).list_of :authors, @authors do
+          r.element :name
+          r.element :age
+        end
+        resulting_json.should == undent(<<-JSON)
+        [
+           {
+              "name": "Hewey",
+              "age": 3
+           },
+           {
+              "name": "Dewey",
+              "age": 4
+           }
+        ]
+        JSON
+      end
+
+    end
+
+    context "set to a whitespace String" do
+
+      it "indents the specified number of spaces" do
+        r(:indentation => "\t").list_of :authors, @authors do
+          r.element :name
+          r.element :age
+        end
+        resulting_json.should == undent(<<-JSON)
+        [
+        \t{
+        \t\t"name": "Hewey",
+        \t\t"age": 3
+        \t},
+        \t{
+        \t\t"name": "Dewey",
+        \t\t"age": 4
+        \t}
+        ]
+        JSON
+      end
+
+    end
+
+    context "set false" do
+
+      it "does not indent, or wrap" do
+        r(:indentation => false).list_of :authors, @authors do
+          r.element :name
+          r.element :age
+        end
+        resulting_json.should == %([{"name":"Hewey","age":3},{"name":"Dewey","age":4}])
+      end
+
+    end
+
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: representative
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-05 00:00:00.000000000Z
+date: 2012-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70110341854200 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,84 +21,60 @@ dependencies:
         version: 2.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *70110341854200
-- !ruby/object:Gem::Dependency
-  name: i18n
-  requirement: &70110341852520 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.4.1
-  type: :runtime
-  prerelease: false
-  version_requirements: *70110341852520
+        version: 2.2.2
 - !ruby/object:Gem::Dependency
-  name: builder
-  requirement: &70110341851600 !ruby/object:Gem::Requirement
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: 0.4.1
   type: :runtime
   prerelease: false
-  version_requirements: *70110341851600
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: &70110341850920 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.4.2
-  type: :runtime
-  prerelease: false
-  version_requirements: *70110341850920
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &70110341850100 !ruby/object:Gem::Requirement
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.8.7
-  type: :development
+        version: 2.1.2
+  type: :runtime
   prerelease: false
-  version_requirements: *70110341850100
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70110341848720 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.5.0
-  type: :development
-  prerelease: false
-  version_requirements: *70110341848720
+        version: 2.1.2
 - !ruby/object:Gem::Dependency
-  name: tilt
-  requirement: &70110341841560 !ruby/object:Gem::Requirement
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
+        version: 1.4.2
+  type: :runtime
   prerelease: false
-  version_requirements: *70110341841560
-- !ruby/object:Gem::Dependency
-  name: diff-lcs
-  requirement: &70110341840580 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70110341840580
+        version: 1.4.2
 description: 
 email: mdub@dogbiscuit.org
 executables: []
@@ -139,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 156870103319875874
+      hash: 868732793501301304
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -148,10 +124,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 156870103319875874
+      hash: 868732793501301304
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Builds XML and JSON representations of your Ruby objects