pump 0.4.0 → 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b9056ee092ab29fe87298579710bd70071d6a6d
+  data.tar.gz: ef775b68abb7303644d320ff315f23e643817576
+SHA512:
+  metadata.gz: 29d00d8d8999018fa340ec2c6e77569dbfabb60419cce2437a89290fdd93f46bfdd7e5ed431724498305f8e97ce32d84bf4d99cca13abf004321d04b1d6b4d8c
+  data.tar.gz: 633002231a25894b1512e764e0513c5dc054b46be7e4fae8ff19a5d4cdd1c091f934778519fd125a1bfa059cc2dbe01c2ac3fac9f2461abe8ed64137c55bd6c6

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 2.0.0
+  - 1.9.3
+gemfile:
+  - gemfiles/activesupport-4
+  - gemfiles/activesupport-3-2

data/gemfiles/activesupport-3-2

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gem "activemodel", "3.2.13"
+
+gem 'rspec', '>= 2.4.0'
+gem 'rake'

data/gemfiles/activesupport-4

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gem "activemodel", "4.0"
+
+gem 'rspec', '>= 2.4.0'
+gem 'rake'

data/lib/pump/array.rb

@@ -0,0 +1,20 @@
+module Pump
+  module Array
+    def pump_to_xml(options={})
+      encoder = get_pump_encoder(options[:set], :xml)
+      return to_xml(options) unless encoder
+      encoder.encode(self)
+    end
+
+    private
+
+    def get_pump_encoder(set, format)
+      return if empty? || !first.class.respond_to?(:pumps)
+      first.class.pumps.get(set, format)
+    end
+  end
+end
+
+class ::Array
+  include Pump::Array
+end

data/lib/pump/collection.rb

@@ -0,0 +1,21 @@
+module Pump
+  class Collection
+    def initialize
+      @pumps = {}
+    end
+
+    def add(set, format, value)
+      @pumps[format] ||= {}
+      @pumps[format][set || :default] = value
+    end
+
+    def get(set, format)
+      pumps = @pumps[format]
+      pumps && (pumps[set] || pumps[:default])
+    end
+
+    def size
+      @pumps.values.map(&:size).inject(0) {|sum, it| sum += it; it}
+    end
+  end
+end

data/lib/pump/object.rb

@@ -0,0 +1,28 @@
+require 'pump/collection'
+require 'pump/xml'
+require 'active_support/concern'
+
+module Pump
+  module Object
+    extend ActiveSupport::Concern
+
+    def pump_to_xml(options={})
+      encoder = self.class.pumps.get(options[:set], :xml)
+      if encoder
+        encoder.encode(self)
+      else
+        self.to_xml(options)
+      end
+    end
+
+    module ClassMethods
+      def pumps
+        @pumps ||= Pump::Collection.new
+      end
+
+      def add_pump(name, set=nil, options={}, &block)
+        pumps.add(set, :xml, Pump::Xml.new(name, options, &block))
+      end
+    end
+  end
+end

data/lib/pump/version.rb

@@ -1,3 +1,3 @@
 module Pump
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/pump.rb

@@ -1,5 +1,7 @@
 require "pump/version"
 require "pump/xml"
+require "pump/object"
+require "pump/array"
 
 # Fast but inflexible XML encoding for ruby objects.
 module Pump

data/spec/pump/array_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+class Array
+  def to_xml(options={})
+    "<Array#to_xml />"
+  end
+end
+
+class ArrayObjectWithoutInclude
+end
+
+class ArrayObjectWithInclude
+  include Pump::Object
+end
+
+class ArrayObject
+  include Pump::Object
+
+  add_pump 'array-object' do
+    string :name
+  end
+
+  add_pump 'array-object', :with_age do
+    string :name
+    integer :age
+  end
+
+  def name
+    "Tintin"
+  end
+
+  def age
+    27
+  end
+end
+
+describe Pump::Array do
+  it "should extend ::Array by default with pump_to_xml" do
+    [].respond_to?(:pump_to_xml).should eql(true)
+  end
+
+  context "with objects without include" do
+    subject{ [ArrayObjectWithoutInclude.new] }
+
+    it "should return default to_xml" do
+      subject.pump_to_xml.should eql("<Array#to_xml />")
+    end
+  end
+
+  context "with objects with include but without encoders" do
+    subject{ [ArrayObjectWithInclude.new] }
+
+    it "should return default to_xml" do
+      subject.pump_to_xml.should eql("<Array#to_xml />")
+    end
+  end
+
+  context "with objects with include and encoders" do
+    subject{ [ArrayObject.new] }
+
+    it "should encode with default encoder" do
+      subject.pump_to_xml.should eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<array-objects type=\"array\">\n  <array-object>\n    <name>Tintin</name>\n  </array-object>\n</array-objects>\n")
+    end
+
+    it "should encode with specified encoder" do
+      subject.pump_to_xml(:set => :with_age).should eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<array-objects type=\"array\">\n  <array-object>\n    <name>Tintin</name>\n    <age type=\"integer\">27</age>\n  </array-object>\n</array-objects>\n")
+    end
+
+    it "should encode with default encoder on unknown set" do
+      subject.pump_to_xml(:set => :bla).should eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<array-objects type=\"array\">\n  <array-object>\n    <name>Tintin</name>\n  </array-object>\n</array-objects>\n")
+    end
+  end
+end

data/spec/pump/collection_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe Pump::Collection do
+  subject { Pump::Collection.new }
+
+  describe ".new" do
+    it "should not accept any arguments" do
+      subject
+      lambda{ Pump::Collection.new("") }.should raise_error(ArgumentError)
+    end
+
+    its(:size) { should eql(0) }
+  end
+
+  describe "#add" do
+    it "should add entry" do
+      subject.add(:set_name, :xml, :value)
+      subject.size.should eql(1)
+    end
+
+    it "should allow different formats" do
+      subject.add(:set_name, :json, :value)
+      subject.size.should eql(1)
+    end
+
+    it "should default to :default set" do
+      subject.add(nil, :xml, :value)
+      subject.get(:default, :xml).should eql(:value)
+    end
+  end
+
+  describe "#get" do
+    it "should return nil on unknown entry" do
+      subject.get(:set_name, :xml).should eql(nil)
+      subject.get(:default, :xml).should eql(nil)
+      subject.get(nil, :xml).should eql(nil)
+      subject.get(:default, :json).should eql(nil)
+    end
+
+    context "when entries are added" do
+      before{ subject.add(:set_name, :xml, :value); subject.add(:default, :xml, :value2) }
+
+      it "should return given value" do
+        subject.get(:set_name, :xml).should eql(:value)
+        subject.get(:default, :xml).should eql(:value2)
+      end
+
+      it "should return nil with wrong format" do
+        subject.get(:set_name, :json).should eql(nil)
+        subject.get(:default, :json).should eql(nil)
+      end
+
+      it "should default to :default on unknwon set" do
+        subject.get(:unknown, :xml).should eql(:value2)
+      end
+    end
+  end
+end

data/spec/pump/object_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+class ObjectWithoutInclude
+
+end
+
+class ObjectWithInclude
+  include Pump::Object
+
+  def to_xml(options={})
+    "<to_xml />"
+  end
+end
+
+class ObjectWithIncludeAndPumps
+  include Pump::Object
+
+  add_pump :my_object do
+    string  "name"
+  end
+
+  def name
+    "MyName"
+  end
+end
+
+class ObjectWithIncludeAndMultiplePumps
+  include Pump::Object
+
+  add_pump :my_object do
+    string  "name"
+  end
+
+  add_pump :my_object, :sometimes do
+    string  "name"
+    integer  "age"
+  end
+
+  def name
+    "MyName"
+  end
+
+  def age
+    72
+  end
+end
+
+describe Pump::Object do
+  it "should not extend all objects by default" do
+    ObjectWithoutInclude.respond_to?(:pumps).should eql(false)
+  end
+
+  context "when included" do
+    subject { ObjectWithInclude }
+
+    it "should add pumps class method" do
+      subject.respond_to?(:pumps).should eql(true)
+      subject.pumps.size.should eql(0)
+    end
+
+    it "should add pump_to_xml instance method" do
+      subject.new.respond_to?(:pump_to_xml).should eql(true)
+    end
+
+    it "should fall back to original to_xml on pump_to_xml" do
+      subject.new.pump_to_xml.should eql("<to_xml />")
+    end
+  end
+
+  context "when included with one encoder added" do
+    subject { ObjectWithIncludeAndPumps }
+
+    it "should add pump" do
+      subject.pumps.size.should eql(1)
+    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")
+    end
+  end
+
+  context "when included with multiple encoders added" do
+    subject { ObjectWithIncludeAndMultiplePumps }
+
+    it "should add pumps" do
+      subject.pumps.size.should eql(2)
+    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")
+    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")
+    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")
+    end
+
+  end
+end

data/spec/pump/xml_spec.rb

@@ -158,11 +158,11 @@ describe Pump::Xml do
     end
 
     context "with datetime attribute" do
-      let(:person) { Struct.new(:at).new(Time.new(2013, 2, 7, 0, 0, 0)) }
+      let(:person) { Struct.new(:at).new(Time.utc(2013, 2, 7, 0, 0, 0)) }
       let(:xml) { Pump::Xml.new('person', [{:at => :at, :typecast => :xmlschema, :attributes => {:type => 'datetime'}}]) }
 
       it "returns xml string" do
-        xml.encode(person).should eql("#{XML_INSTRUCT}<person>\n  <at type=\"datetime\">2013-02-07T00:00:00+01:00</at>\n</person>\n")
+        xml.encode(person).should eql("#{XML_INSTRUCT}<person>\n  <at type=\"datetime\">2013-02-07T00:00:00Z</at>\n</person>\n")
       end
 
       context "but nil" do

data/spec/spec_helper.rb

@@ -7,6 +7,5 @@ RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
   config.order = 'random'
-
-   config.backtrace_clean_patterns = [/rspec\/(core|expectations)/]
+  config.backtrace_exclusion_patterns = [/rspec\/(core|expectations)/]
 end

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: pump
 version: !ruby/object:Gem::Version
-  version: 0.4.0
-  prerelease: 
+  version: 0.5.0
 platform: ruby
 authors:
 - Sebastian Munz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-13 00:00:00.000000000 Z
+date: 2013-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.12.0
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.2.2
 description: Fast but inflexible XML encoding for ruby objects.
@@ -67,9 +60,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rbenv-gemsets
-- .rbenv-version
 - .rspec
+- .ruby-version
+- .travis.yml
 - .yardopts
 - CHANGES.md
 - Gemfile
@@ -78,7 +71,12 @@ files:
 - README.md
 - Rakefile
 - benchmarks/encode.rb
+- gemfiles/activesupport-3-2
+- gemfiles/activesupport-4
 - lib/pump.rb
+- lib/pump/array.rb
+- lib/pump/collection.rb
+- lib/pump/object.rb
 - lib/pump/version.rb
 - lib/pump/xml.rb
 - lib/pump/xml/dsl.rb
@@ -87,6 +85,9 @@ files:
 - lib/pump/xml/tag_array.rb
 - lib/pump/xml/value.rb
 - pump.gemspec
+- spec/pump/array_spec.rb
+- spec/pump/collection_spec.rb
+- spec/pump/object_spec.rb
 - spec/pump/xml/dsl_spec.rb
 - spec/pump/xml/tag_array_spec.rb
 - spec/pump/xml/tag_spec.rb
@@ -96,33 +97,34 @@ files:
 homepage: https://github.com/yolk/pump
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Fast but inflexible XML encoding for ruby objects.
 test_files:
+- spec/pump/array_spec.rb
+- spec/pump/collection_spec.rb
+- spec/pump/object_spec.rb
 - spec/pump/xml/dsl_spec.rb
 - spec/pump/xml/tag_array_spec.rb
 - spec/pump/xml/tag_spec.rb
 - spec/pump/xml/value_spec.rb
 - spec/pump/xml_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/.rbenv-gemsets

@@ -1 +0,0 @@
-plugin

data/.rbenv-version

@@ -1 +0,0 @@
-1.9.3-p286