pox_paginate 0.1.0

data/README.rdoc

@@ -0,0 +1,5 @@
+= PoxPaginate
+
+PoxPaginate is an extension to WillPaginate and ActiveResource that makes it possible to transparently paginate over a collection of XML serialised resources.
+
+It currently depends on a patch to fix a bug in Rails that is documented in this {Lighthouse ticket}[https://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/3217-parsing-an-xml-file-with-multiple-records-and-extra-attributes-besides-type-fails].

data/Rakefile

@@ -0,0 +1,37 @@
+require 'spec'
+require 'spec/rake/spectask'
+
+desc 'Default: run spec tests.'
+task :default => 'spec:unit'
+
+namespace :spec do
+  desc "Run all unit specs"
+  Spec::Rake::SpecTask.new(:unit) do |task|
+    task.spec_files = FileList['spec/pox_paginate/**/*_spec.rb']
+    # task.spec_opts = ['--options', 'spec/spec.opts']
+  end
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "pox_paginate"
+    gemspec.summary = "Transparent support for pagination using WillPaginate using POX (Plain Old Xml) and ActiveResource"
+    gemspec.description = "Wrest is a HTTP and REST client library which allows you to quickly build well encapsulated, object oriented wrappers around any web service."
+    gemspec.authors = ["Sidu Ponnappa", "Niranjan Paranjape"]
+    gemspec.email = "opensource@c42.in"
+    gemspec.homepage = "http://github.com/kaiwren/wrest"
+    gemspec.has_rdoc = false
+    gemspec.require_path = "lib"
+    gemspec.files.exclude *['.gitignore']
+    gemspec.test_files.exclude *['.gitignore']
+    gemspec.add_dependency('activesupport', '>= 2.3.5')
+    gemspec.add_dependency('activeresource', '>= 2.3.5')
+    gemspec.add_dependency('will_paginate', '>= 2.3.12')
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install technicalpickles-jeweler -s http://gems.github.com"
+  puts "If you're using JRuby and are having trouble installing jeweler, try installing the git (gem install git) and rubyforge (gem install rubyforge) gems by hand. Also remember to update gems itself (jruby -S gem update --system)."
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/pox_paginate/active_resource/xml_format.rb

@@ -0,0 +1,22 @@
+module PoxPaginate
+  module ActiveResource
+    module XmlFormat
+      def self.included(mod)
+        mod.module_eval do
+          def decode_with_pagination_support(xml)
+            deserialised_xml = decode_without_pagination_support(xml)
+            root_attributes = ::ActiveSupport::XmlMini.root_node_attributes(xml)
+            if root_attributes['type'] == "array" && root_attributes['current_page']
+              RemoteCollection.create(root_attributes['current_page'], root_attributes['per_page'], root_attributes['total_entries']) do |pager|
+                pager.replace deserialised_xml
+              end
+            else
+              deserialised_xml
+            end
+          end
+          alias_method_chain :decode, :pagination_support
+        end
+      end
+    end
+  end
+end

data/lib/pox_paginate/active_resource.rb

@@ -0,0 +1,8 @@
+module PoxPaginate
+  module ActiveResource
+  end
+end
+
+require "#{PoxPaginate::Root}/pox_paginate/active_resource/xml_format"
+
+ActiveResource::Formats::XmlFormat.send :include, PoxPaginate::ActiveResource::XmlFormat

data/lib/pox_paginate/active_support/core_hash_ext.rb

@@ -0,0 +1,25 @@
+module PoxPaginate
+  module ActiveSupport
+    module CoreHashExt
+      def self.included(mod)
+        mod.module_eval do 
+          alias_method :from_xml_without_extension, :from_xml
+          def from_xml(xml)
+            typecast_xml_value(unrename_keys(remove_pagination_attributes(::ActiveSupport::XmlMini.parse(xml))))
+          end
+
+          def remove_pagination_attributes(deserialized_xml)
+            if deserialized_xml.values.size == 1 && deserialized_xml.values.first['type'] == 'array'
+              clone = deserialized_xml.clone
+              clone.values.first.delete 'per_page'
+              clone.values.first.delete 'current_page'
+              clone.values.first.delete 'total_entries'
+              return clone
+            end
+            deserialized_xml
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pox_paginate/active_support.rb

@@ -0,0 +1,8 @@
+module PoxPaginate
+  module ActiveSupport
+  end
+end
+
+require "#{PoxPaginate::Root}/pox_paginate/active_support/core_hash_ext"
+
+ActiveSupport::CoreExtensions::Hash::Conversions::ClassMethods.send :include, PoxPaginate::ActiveSupport::CoreHashExt

data/lib/pox_paginate/remote_collection.rb

@@ -0,0 +1,4 @@
+module PoxPaginate
+  class RemoteCollection < WillPaginate::Collection 
+  end
+end

data/lib/pox_paginate/will_paginate/collection_extensions.rb

@@ -0,0 +1,43 @@
+module PoxPaginate
+  module WillPaginate
+    module CollectionExtensions
+      def self.included(klass)
+        klass.class_eval do
+          
+          def to_xml(options = {})
+            raise "Not all elements respond to to_xml" unless all? { |e| e.respond_to? :to_xml }
+            require 'builder' unless defined?(Builder)
+
+            options = options.dup
+            options[:root]     ||= all? { |e| e.is_a?(first.class) && first.class.to_s != "Hash" } ? first.class.to_s.underscore.pluralize : "records"
+            options[:children] ||= options[:root].singularize
+            options[:indent]   ||= 2
+            options[:builder]  ||= Builder::XmlMarkup.new(:indent => options[:indent])
+
+            root     = options.delete(:root).to_s
+            children = options.delete(:children)
+
+            if !options.has_key?(:dasherize) || options[:dasherize]
+              root = root.dasherize
+            end
+
+            options[:builder].instruct! unless options.delete(:skip_instruct)
+
+            opts = options.merge({ :root => children })
+
+            xml = options[:builder]
+            if empty?
+              xml.tag!(root, options[:skip_types] ? {} : {:type => "array", :current_page => current_page, :per_page => per_page, :total_entries => total_entries})
+            else
+              xml.tag!(root, options[:skip_types] ? {} : {:type => "array", :current_page => current_page, :per_page => per_page, :total_entries => total_entries}) {
+                yield xml if block_given?
+                each { |e| e.to_xml(opts.merge({ :skip_instruct => true })) }
+              }
+            end
+          end
+          
+        end
+      end
+    end
+  end
+end

data/lib/pox_paginate/will_paginate.rb

@@ -0,0 +1,8 @@
+module PoxPaginate
+  module WillPaginate
+  end
+end
+
+require "#{PoxPaginate::Root}/pox_paginate/will_paginate/collection_extensions"
+
+WillPaginate::Collection.class_eval{ include PoxPaginate::WillPaginate::CollectionExtensions }

data/lib/pox_paginate/xml_mini/jdom.rb

@@ -0,0 +1,8 @@
+module PoxPaginate
+  module XmlMini
+    module JDOM
+      def root_node_attributes(xml)
+      end
+    end
+  end
+end

data/lib/pox_paginate/xml_mini/libxml.rb

@@ -0,0 +1,11 @@
+module PoxPaginate
+  module XmlMini
+    module LibXML
+      def root_node_attributes(xml)
+        parser = ::LibXML::XML::Reader.string(xml)
+        parser.read
+        parser.has_attributes? ? parser.node.attributes.to_h : {}
+      end
+    end
+  end
+end

data/lib/pox_paginate/xml_mini/nokogiri.rb

@@ -0,0 +1,11 @@
+module PoxPaginate
+  module XmlMini
+    module Nokogiri
+      def root_node_attributes(xml)
+        parser = ::Nokogiri::XML::Reader.from_memory(xml)
+        parser.read
+        parser.attributes
+      end
+    end
+  end
+end

data/lib/pox_paginate/xml_mini/rexml.rb

@@ -0,0 +1,16 @@
+module PoxPaginate
+  module XmlMini
+    module REXML
+      def root_node_attributes(xml)
+        require 'rexml/parsers/sax2parser'
+        parser = ::REXML::Parsers::SAX2Parser.new(xml)
+        root_attributes = nil
+        parser.listen(:start_element) do |uri, localname, qname, attributes|
+          root_attributes ||= attributes
+        end
+        parser.parse
+        root_attributes
+      end
+    end
+  end
+end

data/lib/pox_paginate/xml_mini.rb

@@ -0,0 +1,23 @@
+module PoxPaginate
+  module XmlMini
+  end
+end
+
+
+# require "#{PoxPaginate::Root}/pox_paginate/xml_mini/libxml"
+# require "#{PoxPaginate::Root}/pox_paginate/xml_mini/nokogiri"
+# require "#{PoxPaginate::Root}/pox_paginate/xml_mini/jdom"
+
+ActiveSupport::XmlMini.module_eval do
+  delegate :root_node_attributes, :to => :backend
+  
+  def backend_with_root_node_attributes=(name)
+    result = ActiveSupport::XmlMini.backend_without_root_node_attributes=(name)
+    deserialiser = @backend.name.demodulize.gsub('XmlMini_', '')
+    require "#{PoxPaginate::Root}/pox_paginate/xml_mini/#{deserialiser.downcase}"
+    @backend.extend "PoxPaginate::XmlMini::#{deserialiser}".constantize
+    result
+  end
+  alias_method_chain :backend=, :root_node_attributes
+end
+ActiveSupport::XmlMini.backend=(ActiveSupport::XmlMini.backend)

data/lib/pox_paginate.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'active_resource'
+require 'will_paginate'
+require 'active_support'
+
+module PoxPaginate
+  Root = File.dirname(__FILE__)
+end
+
+require "#{PoxPaginate::Root}/pox_paginate/active_support"
+require "#{PoxPaginate::Root}/pox_paginate/remote_collection"
+require "#{PoxPaginate::Root}/pox_paginate/active_resource"
+require "#{PoxPaginate::Root}/pox_paginate/will_paginate"
+require "#{PoxPaginate::Root}/pox_paginate/xml_mini"

data/spec/config/database.yml

@@ -0,0 +1,2 @@
+adapter: sqlite3
+database: ":memory:"

data/spec/db/migrate/001_create_oogas.rb

@@ -0,0 +1,12 @@
+class CreateOogas < ActiveRecord::Migration
+  def self.up
+    create_table :oogas do |t|
+      t.string :name
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :oogas
+  end
+end

data/spec/pox_paginate/active_resource/xml_format_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe PoxPaginate::ActiveResource::XmlFormat do
+  it "should foo" do
+    ::ActiveSupport::XmlMini.backend = 'LibXML'
+    collection = ActiveResource::Formats::XmlFormat.decode(paginated_xml(DateTime.parse('2010-02-06T21:09:48+05:30')))
+    collection.should be_a(PoxPaginate::RemoteCollection)
+  end
+end

data/spec/pox_paginate/active_support/core_hash_ext_spec.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe PoxPaginate::ActiveSupport::CoreHashExt do
+  
+  it 'should from_xml ignores any root attributes other than type' do
+    Hash.from_xml(paginated_xml(@date)).should == {"oogas"=>[
+              {"name"=>"Foo", "updated_at"=>@date, "id"=>3, "created_at"=>@date}, 
+              {"name"=>"Baz", "updated_at"=>@date, "id"=>4, "created_at"=>@date}
+                                                            ]}
+  end
+  
+end

data/spec/pox_paginate/will_paginate/collection_extensions_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe 'XmlSerializer Extensions' do
+  before :all do
+    Ooga.create!(:name => 'Coyote')
+    Ooga.create!(:name => 'Meh')
+    Ooga.create!(:name => 'Foo')
+    Ooga.create!(:name => 'Baz')
+    Ooga.create!(:name => 'Woot')
+  end
+  
+  it "should ooga" do
+    Ooga.count.should == 5
+  end
+  
+  it "should serialize to xml with root node attributes containing pagination metadata" do
+    page = Ooga.paginate :page => 2, :per_page => 2
+    xml = page.to_xml
+    xml.should match(/<oogas.*type=\"array\".*>\s+<ooga/)
+    xml.should match(/<oogas.*current_page=\"2\".*>\s+<ooga/)
+    xml.should match(/<oogas.*per_page=\"2\".*>\s+<ooga/)
+    xml.should match(/<oogas.*total_entries=\"5\".*>\s+<ooga/)
+  end
+  
+  it "should have rails patched to allow deserialisation of tags with more than one attribute" do
+    # Patch at https://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/3217-parsing-an-xml-file-with-multiple-records-and-extra-attributes-besides-type-fails
+    page = Ooga.paginate :page => 2, :per_page => 2
+    lambda{Hash.from_xml(page.to_xml)}.should_not raise_error
+  end
+end

data/spec/pox_paginate/xml_mini_spec.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe PoxPaginate::XmlMini do
+  before :all do
+    @date = DateTime.parse('2010-02-06T21:09:48+05:30')
+  end
+  
+  %w(REXML LibXML Nokogiri).each do |deserialiser|
+    describe "using #{deserialiser}" do
+      before :all do
+        ActiveSupport::XmlMini.backend = deserialiser
+      end
+
+      it "should be using the #{deserialiser} backend" do
+        ActiveSupport::XmlMini.backend.name.should == "ActiveSupport::XmlMini_#{deserialiser}"
+      end
+      
+      it "should decorate backend= to extend the XmlMini_#{deserialiser} module" do
+        "ActiveSupport::XmlMini_#{deserialiser}".constantize.should respond_to(:root_node_attributes)
+        ActiveSupport::XmlMini.backend.name.should == "ActiveSupport::XmlMini_#{deserialiser}"
+      end
+    
+      it "should parse xml with header attributes into a hash" do
+        Hash.from_xml(paginated_xml(@date)).should == {"oogas"=>[
+              {"name"=>"Foo", "updated_at"=>@date, "id"=>3, "created_at"=>@date}, 
+              {"name"=>"Baz", "updated_at"=>@date, "id"=>4, "created_at"=>@date}
+            ]}
+      end
+
+      it "should know how to extract root node attributes" do
+        ActiveSupport::XmlMini.root_node_attributes(paginated_xml(@date)).should == {
+          'type' => "array",
+          'total_entries' => "10",
+          'per_page' => "2",
+          'current_page' => "2"
+        }
+      end
+      
+      it "should not add root node attributes if there are none" do
+        ActiveSupport::XmlMini.root_node_attributes(unpaginated_xml(@date)).should == {
+          'type' => "array",
+        }
+      end
+      
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,54 @@
+require 'pp'
+require 'rubygems'
+require 'spec'
+require 'active_record'
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/pox_paginate")
+
+ActiveRecord::Base.establish_connection(YAML::load(File.open(File.dirname(__FILE__) + '/config/database.yml')))
+ActiveRecord::Base.logger = Logger.new(File.open(File.dirname(__FILE__) + '/../log/test.log', 'a'))
+ActiveRecord::Migrator.up(File.dirname(__FILE__) + '/db/migrate')
+WillPaginate.enable_activerecord
+
+class Ooga < ActiveRecord::Base
+end
+
+def paginated_xml(date)
+<<-EOXML
+<?xml version="1.0" encoding="UTF-8"?>
+<oogas type="array" total_entries="10" per_page="2" current_page="2">
+  <ooga>
+    <created-at type="datetime">#{date}</created-at>
+    <id type="integer">3</id>
+    <name>Foo</name>
+    <updated-at type="datetime">#{date}</updated-at>
+  </ooga>
+  <ooga>
+    <created-at type="datetime">#{date}</created-at>
+    <id type="integer">4</id>
+    <name>Baz</name>
+    <updated-at type="datetime">#{date}</updated-at>
+  </ooga>
+</oogas>
+EOXML
+end
+
+def unpaginated_xml(date)
+<<-EOXML
+<?xml version="1.0" encoding="UTF-8"?>
+<oogas type="array">
+  <ooga>
+    <created-at type="datetime">#{date}</created-at>
+    <id type="integer">3</id>
+    <name>Foo</name>
+    <updated-at type="datetime">#{date}</updated-at>
+  </ooga>
+  <ooga>
+    <created-at type="datetime">#{date}</created-at>
+    <id type="integer">4</id>
+    <name>Baz</name>
+    <updated-at type="datetime">#{date}</updated-at>
+  </ooga>
+</oogas>
+EOXML
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: pox_paginate
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Sidu Ponnappa
+- Niranjan Paranjape
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-09 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: will_paginate
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.12
+    version: 
+description: Wrest is a HTTP and REST client library which allows you to quickly build well encapsulated, object oriented wrappers around any web service.
+email: opensource@c42.in
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/pox_paginate.rb
+- lib/pox_paginate/active_resource.rb
+- lib/pox_paginate/active_resource/xml_format.rb
+- lib/pox_paginate/active_support.rb
+- lib/pox_paginate/active_support/core_hash_ext.rb
+- lib/pox_paginate/remote_collection.rb
+- lib/pox_paginate/will_paginate.rb
+- lib/pox_paginate/will_paginate/collection_extensions.rb
+- lib/pox_paginate/xml_mini.rb
+- lib/pox_paginate/xml_mini/jdom.rb
+- lib/pox_paginate/xml_mini/libxml.rb
+- lib/pox_paginate/xml_mini/nokogiri.rb
+- lib/pox_paginate/xml_mini/rexml.rb
+- spec/config/database.yml
+- spec/db/migrate/001_create_oogas.rb
+- spec/pox_paginate/active_resource/xml_format_spec.rb
+- spec/pox_paginate/active_support/core_hash_ext_spec.rb
+- spec/pox_paginate/will_paginate/collection_extensions_spec.rb
+- spec/pox_paginate/xml_mini_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kaiwren/wrest
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Transparent support for pagination using WillPaginate using POX (Plain Old Xml) and ActiveResource
+test_files: 
+- spec/db/migrate/001_create_oogas.rb
+- spec/pox_paginate/active_resource/xml_format_spec.rb
+- spec/pox_paginate/active_support/core_hash_ext_spec.rb
+- spec/pox_paginate/will_paginate/collection_extensions_spec.rb
+- spec/pox_paginate/xml_mini_spec.rb
+- spec/spec_helper.rb