pump 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4b95096c96dfa59274e8b007a7946f0223e507c
-  data.tar.gz: 12e6c47f2239231db115c160575870739141ef95
+  metadata.gz: 928aa1adcc5c2a7fc5dd530840b2ceb48c60e872
+  data.tar.gz: 7b80bb36b960b06a57ce69f3c4e9aea5cefe8862
 SHA512:
-  metadata.gz: 9725fb7b0bb3152bae3321623744f15e280bfc4edae242836702b3971bd69039007f7c54bc8b1e7a49f49b0d440f7d66db989642b64ad2b8e09858ff1d32e210
-  data.tar.gz: 360c20c887a7c50232df40b77805e86a26d8a8c399695fba4e360121eb721841768918f4738ac6fe957b75bac8d0c161b19eebdee27ebdd95707d45d7ccb758b
+  metadata.gz: cac714cccc025776bcef431bf8d47707f1ca3e588162807171b478d5583092dc19bdae802ee6bcc3906c430c50baa23c1092a193ce4ada0091e64d60723b3850
+  data.tar.gz: c32c95412ebf0b979b212d4596f48b268228f93bf8eb5a45fa0ea8e04a3ddbd26ec876358bb813dbd9d8488ed2166702221362c32f121e66b57e2554ad3adb47

data/CHANGES.md

@@ -1,6 +1,14 @@
 ### dev
 
-[full changelog](http://github.com/yolk/pump/compare/v0.0.1...master)
+[full changelog](http://github.com/yolk/pump/compare/v0.6.1...master)
+
+### 0.6.1 / 2013-07-25
+
+[full changelog](http://github.com/yolk/valvat/compare/v0.6.0...v0.6.1)
+
+* Fixed issues with time/date objects in JSON
+* XML defaults now to dasherized key names, JSON to underscores
+* Added :xml_key_style & :json_key_style options
 
 ### 0.6.0 / 2013-07-24
 

data/README.md

@@ -1,5 +1,7 @@
 # Pump
 
+[![Build Status](https://travis-ci.org/yolk/pump.png?branch=master)](https://travis-ci.org/yolk/pump)
+
 Fast but inflexible XML and JSON encoding for ruby objects.
 
 ## Quick benchmark
@@ -7,7 +9,11 @@ Fast but inflexible XML and JSON encoding for ruby objects.
 Serializing an array of 100 random entries 1.000 times.
 
                                    user     system      total        real
-Pump::Xml#encode               1.450000   0.010000   1.460000 (  1.466962)
-Pump::Xml#encode (optimized)   1.100000   0.010000   1.110000 (  1.110234)
-Ox                             1.490000   0.000000   1.490000 (  1.483275)
-ActiveModel#serialize         23.280000   0.060000  23.340000 ( 23.333999)
+    Pump::Json#encode              0.600000   0.010000   0.610000 (  0.603469)
+    Pump::Xml#encode               1.140000   0.020000   1.160000 (  1.162651)
+    Pump::Xml#encode (optimized)   0.830000   0.020000   0.850000 (  0.858750)
+    Ox                             1.200000   0.010000   1.210000 (  1.203765)
+    Oj                             0.560000   0.000000   0.560000 (  0.566166)
+    Yajl                           1.490000   0.000000   1.490000 (  1.493032)
+    ActiveModel#to_xml            24.110000   0.050000  24.160000 ( 24.170127)
+    ActiveModel#to_json            3.860000   0.010000   3.870000 (  3.866130)

data/lib/pump/json.rb

@@ -1,4 +1,5 @@
 require "pump/encoder"
+require 'active_support/json/encoding'
 require "oj"
 
 module Pump
@@ -90,7 +91,7 @@ module Pump
     end
 
     def format_name(name)
-      return name if encoder_options[:underscore] == false
+      return name.to_s.dasherize if encoder_options[:json_key_style] == :dashes
       name.to_s.underscore
     end
   end

data/lib/pump/version.rb

@@ -1,3 +1,3 @@
 module Pump
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

data/lib/pump/xml/node.rb

@@ -24,6 +24,7 @@ module Pump
       def add_node(node)
         node.level = level + 1
         node.options[:extra_indent] = options[:extra_indent]
+        node.options[:xml_key_style] = options[:xml_key_style]
         nodes << node
       end
 
@@ -38,6 +39,11 @@ module Pump
       def extra_indent
         options[:extra_indent] || 0
       end
+
+      def format_name(name)
+        return name.to_s.underscore if options[:xml_key_style] == :underscores
+        name.to_s.dasherize
+      end
     end
   end
 end

data/lib/pump/xml/tag.rb

@@ -29,7 +29,7 @@ module Pump
       end
 
       def open_tag
-        "#{prefix}<#{name}#{attributes_string}"
+        "#{prefix}<#{format_name(name)}#{attributes_string}"
       end
 
       def prefix
@@ -42,7 +42,7 @@ module Pump
 
       def value_and_close_tag(path=nil)
         value = value_nodes? ? nodes.first.to_s(path) : ("\n" << nodes.map(&:to_s).join)
-        ">#{value}#{tabs unless value_nodes?}</#{name}>\n"
+        ">#{value}#{tabs unless value_nodes?}</#{format_name(name)}>\n"
       end
 
       def value_and_close_tag_with_nil_check
@@ -51,7 +51,7 @@ module Pump
 
       def static_value_and_close_tag
         return " nil=\\\"true\\\"/>\n" if options[:static_value].nil?
-        ">#{options[:static_value]}</#{name}>\n"
+        ">#{options[:static_value]}</#{format_name(name)}>\n"
       end
 
       def attributes_string

data/lib/pump/xml/tag_array.rb

@@ -5,16 +5,19 @@ module Pump
   class Xml
     class TagArray < Node
       def initialize(name, attributes={}, nodes=[], options={})
-        tag = Tag.new(name, attributes, nodes, {:level => 1, :extra_indent => options[:extra_indent]})
+        tag = Tag.new(name, attributes, nodes, {
+          :level => 1, :extra_indent => options[:extra_indent],
+          :xml_key_style => options[:xml_key_style]
+        })
         array_root = options[:array_root] || name.to_s.pluralize
         super(array_root, {}, [tag], options)
       end
 
       def to_s
         if options.has_key?(:static_value)
-          "#{prefix}<#{name} type=\\\"array\\\"#{static_value_and_close_tag}"
+          "#{prefix}<#{format_name name} type=\\\"array\\\"#{static_value_and_close_tag}"
         else
-          "#{prefix}<#{name} type=\\\"array\\\"#{loop_and_close_tag}"
+          "#{prefix}<#{format_name name} type=\\\"array\\\"#{loop_and_close_tag}"
         end
       end
 
@@ -25,12 +28,12 @@ module Pump
       end
 
       def loop_and_close_tag
-        "\#{ #{objects_path}.empty? ? \"/>\n\" : \">\n#{tag_loop}#{tabs}</#{name}>\n\" }"
+        "\#{ #{objects_path}.empty? ? \"/>\n\" : \">\n#{tag_loop}#{tabs}</#{format_name name}>\n\" }"
       end
 
       def static_value_and_close_tag
         return "/>\n" if options[:static_value].nil?
-        ">#{options[:static_value]}</#{name}>\n"
+        ">#{options[:static_value]}</#{format_name name}>\n"
       end
 
       def objects_path

data/lib/pump/xml.rb

@@ -27,18 +27,25 @@ module Pump
     def build_tag(config)
       tag_name, method_name = config.keys.first, config.values.first
       attrs = config[:attributes]
+      options = config.merge({:xml_key_style => encoder_options[:xml_key_style]})
       if method_name.is_a?(Array)
-        Tag.new(tag_name, attrs, method_name.map{|conf| build_tag(conf) }, config)
+        Tag.new(tag_name, attrs, method_name.map{|conf| build_tag(conf) }, options)
       elsif config[:array]
-        config.merge!(:array_method => method_name, :array_root => tag_name)
-        TagArray.new(config[:child_root] || tag_name.to_s.singularize, attrs, config[:array].map{|conf| build_tag(conf) }, config)
+        options.merge!(:array_method => method_name, :array_root => tag_name)
+        child_root = config[:child_root] || tag_name.to_s.singularize
+        tags = config[:array].map{|conf| build_tag(conf) }
+        TagArray.new(child_root, attrs, tags, options)
       else
-        Tag.new(tag_name, attrs, Value.new(method_name), config)
+        Tag.new(tag_name, attrs, Value.new(method_name), options)
       end
     end
 
     def tag_options
-      {:instruct => add_instruct?, :extra_indent => encoder_options[:extra_indent], :array_root => encoder_options[:array_root] }
+      {
+        :instruct => add_instruct?, :extra_indent => encoder_options[:extra_indent],
+        :array_root => encoder_options[:array_root],
+        :xml_key_style => encoder_options[:xml_key_style]
+      }
     end
 
     def add_instruct?

data/pump.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'pump/version'
+require "pump/version"
 
 Gem::Specification.new do |gem|
   gem.name          = "pump"
@@ -11,15 +11,15 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Fast but inflexible XML and JSON encoding for ruby objects.}
   gem.summary       = %q{Fast but inflexible XML and JSON encoding for ruby objects.}
   gem.homepage      = "https://github.com/yolk/pump"
-  gem.license       = 'MIT'
+  gem.license       = "MIT"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'activesupport'
-  gem.add_dependency 'oj'
-  gem.add_development_dependency 'rspec',       '>= 2.12.0'
-  gem.add_development_dependency 'guard-rspec', '>=2.2.2'
+  gem.add_dependency "activesupport",           ">=3.2"
+  gem.add_dependency "oj",                      ">=2.0"
+  gem.add_development_dependency "rspec",       ">= 2.12.0"
+  gem.add_development_dependency "guard-rspec", ">=2.2.2"
 end

data/spec/pump/json_spec.rb

@@ -14,6 +14,33 @@ describe Pump::Json do
       json.encode(person).should eql("{\"person\":{\"name\":\"Benny\"}}")
     end
 
+    context "with time object" do
+      let(:person) { Struct.new(:born).new(Time.new(2007,11,1,15,25,0, "+09:00")) }
+      let(:json) { Pump::Json.new('person', [{:born => :born}]) }
+
+      it "formats time as iso string" do
+        json.encode(person).should eql("{\"person\":{\"born\":\"2007-11-01T15:25:00+09:00\"}}")
+      end
+    end
+
+    context "with date object" do
+      let(:person) { Struct.new(:born).new(Date.new(2007,11,1)) }
+      let(:json) { Pump::Json.new('person', [{:born => :born}]) }
+
+      it "formats time as iso string" do
+        json.encode(person).should eql("{\"person\":{\"born\":\"2007-11-01\"}}")
+      end
+    end
+
+    context "with datetime object" do
+      let(:person) { Struct.new(:born).new(DateTime.new(2007,11,1,15,25,0, "+09:00")) }
+      let(:json) { Pump::Json.new('person', [{:born => :born}]) }
+
+      it "formats time as iso string" do
+        json.encode(person).should eql("{\"person\":{\"born\":\"2007-11-01T15:25:00+09:00\"}}")
+      end
+    end
+
     context "with array" do
 
       context "with one entry" do
@@ -183,7 +210,7 @@ describe Pump::Json do
       end
     end
 
-    context "with underscore option" do
+    context "with :json_key_style option" do
       context "not set" do
         let(:json) { Pump::Json.new('my-person', [{"first-name" => :name}]) }
 
@@ -192,16 +219,16 @@ describe Pump::Json do
         end
       end
 
-      context "set to false" do
-        let(:json) { Pump::Json.new('my-person', [{"first-name" => :name}], :underscore => false) }
+      context "set to :dashes" do
+        let(:json) { Pump::Json.new('my-person', [{"first-name" => :name}], :json_key_style => :dashes) }
 
         it "returns json string with dashes" do
           json.encode(person).should eql("{\"my-person\":{\"first-name\":\"Benny\"}}")
         end
       end
 
-      context "set to true" do
-        let(:json) { Pump::Json.new('my-person', [{"first-name" => :name}], :underscore => true) }
+      context "set to :underscores" do
+        let(:json) { Pump::Json.new('my-person', [{"first-name" => :name}], :json_key_style => :underscores) }
 
         it "returns json string with underscores" do
           json.encode(person).should eql("{\"my_person\":{\"first_name\":\"Benny\"}}")
@@ -209,7 +236,7 @@ describe Pump::Json do
       end
     end
 
-    context "with exclude_root_in_json option" do
+    context "with :exclude_root_in_json option" do
       it "returns json string without root" do
         json.encode(person, :exclude_root_in_json => true).should eql("{\"name\":\"Benny\"}")
       end

data/spec/pump/object_spec.rb

@@ -111,7 +111,7 @@ describe Pump::Object do
     end
 
     it "should return xml on pump_to_xml" do
-      subject.new.pump_to_xml.should eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<my_object>\n  <name>MyName</name>\n</my_object>\n")
+      subject.new.pump_to_xml.should eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<my-object>\n  <name>MyName</name>\n</my-object>\n")
     end
 
     it "should return json on pump_to_json" do
@@ -131,15 +131,15 @@ describe Pump::Object do
     end
 
     it "should return default xml on pump_to_xml" do
-      subject.new.pump_to_xml.should eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<my_object>\n  <name>MyName</name>\n</my_object>\n")
+      subject.new.pump_to_xml.should eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<my-object>\n  <name>MyName</name>\n</my-object>\n")
     end
 
     it "should return special xml on set option" do
-      subject.new.pump_to_xml(:set => :sometimes).should eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<my_object>\n  <name>MyName</name>\n  <age type=\"integer\">72</age>\n</my_object>\n")
+      subject.new.pump_to_xml(:set => :sometimes).should eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<my-object>\n  <name>MyName</name>\n  <age type=\"integer\">72</age>\n</my-object>\n")
     end
 
     it "should return default xml on pump_to_xml with unknown set option" do
-      subject.new.pump_to_xml(:set => :unknown).should eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<my_object>\n  <name>MyName</name>\n</my_object>\n")
+      subject.new.pump_to_xml(:set => :unknown).should eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<my-object>\n  <name>MyName</name>\n</my-object>\n")
     end
 
     it "should return default json on pump_to_json" do
@@ -163,7 +163,7 @@ describe Pump::Object do
     end
 
     it "should return default xml on pump_to_xml" do
-      subject.new.pump_to_xml.should eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<my_object>\n  <name>MyName</name>\n  <role>my_role</role>\n</my_object>\n")
+      subject.new.pump_to_xml.should eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<my-object>\n  <name>MyName</name>\n  <role>my_role</role>\n</my-object>\n")
     end
 
     it "should return default json on pump_to_json" do
@@ -171,7 +171,7 @@ describe Pump::Object do
     end
 
     it "should return special inherited xml on pump_to_xml(:set => :restricted)" do
-      subject.new.pump_to_xml(:set => :restricted).should eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<my_object>\n  <name>MyName</name>\n  <role>basic_role</role>\n  <age type=\"integer\">72</age>\n</my_object>\n")
+      subject.new.pump_to_xml(:set => :restricted).should eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<my-object>\n  <name>MyName</name>\n  <role>basic_role</role>\n  <age type=\"integer\">72</age>\n</my-object>\n")
     end
 
     it "should return special inherited json on pump_to_json(:set => :restricted)" do

data/spec/pump/xml_spec.rb

@@ -283,5 +283,54 @@ describe Pump::Xml do
         end
       end
     end
+
+    context "with :xml_key_style option" do
+      context "not set" do
+        let(:xml) { Pump::Xml.new('my_person', [{"first_name" => :name}]) }
+
+        it "returns xml string with dashes" do
+          xml.encode(person).should eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<my-person>\n  <first-name>Benny</first-name>\n</my-person>\n")
+        end
+      end
+
+      context "set to :dashes" do
+        let(:xml) { Pump::Xml.new('my_person', [{"first-name" => :name}], :xml_key_style => :dashes) }
+
+        it "returns xml string with dashes" do
+          xml.encode(person).should eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<my-person>\n  <first-name>Benny</first-name>\n</my-person>\n")
+        end
+      end
+
+      context "set to :underscores" do
+        let(:xml) { Pump::Xml.new('my_person', [{"first-name" => :name}], :xml_key_style => :underscores) }
+
+        it "returns xml string with underscores" do
+          xml.encode(person).should eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<my_person>\n  <first_name>Benny</first_name>\n</my_person>\n")
+        end
+
+        context "on complex array like" do
+          let(:person) {
+            Struct.new(:name, :children).new('Gustav', [
+              Struct.new(:name).new('Lilly'),
+              Struct.new(:name).new('Lena')
+          ]) }
+
+          let(:xml) { Pump::Xml.new('my-person', [{:"my-name" => :name}, {:"the-children" => :children,
+                                                :array => [{:"child-name" => :name}]}], :xml_key_style => :underscores) }
+
+          it "returns xml string with underscores" do
+            xml.encode(person).should eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<my_person>\n  <my_name>Gustav</my_name>\n  <the_children type=\"array\">\n    <the_child>\n      <child_name>Lilly</child_name>\n    </the_child>\n    <the_child>\n      <child_name>Lena</child_name>\n    </the_child>\n  </the_children>\n</my_person>\n")
+          end
+        end
+
+        context "on complex array like" do
+          let(:xml) { Pump::Xml.new('a-person', [{:"my-name" => :name}, {:"the-parent" => [{:"a-name" => :name}, {:"la-age" => :age}]}], :xml_key_style => :underscores) }
+
+          it "returns xml string with underscores" do
+            xml.encode(person).should eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<a_person>\n  <my_name>Benny</my_name>\n  <the_parent>\n    <a_name>Benny</a_name>\n    <la_age>9</la_age>\n  </the_parent>\n</a_person>\n")
+          end
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pump
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Sebastian Munz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-24 00:00:00.000000000 Z
+date: 2013-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement