ares-ext 0.0.1

data/.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+*.log
+pkg/*
+coverage/*
+doc/*
+benchmarks/*
+.bundle
+vendor

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    active_resource_extensions (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activeresource (2.3.5)
+      activesupport (= 2.3.5)
+    activesupport (2.3.5)
+    rspec (1.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_resource_extensions!
+  activeresource (= 2.3.5)
+  rspec (~> 1.3.1)

data/README.md

@@ -0,0 +1,4 @@
+active_resource_extensions
+==========================
+
+Add useful behaviors to ActiveResource models

data/Rakefile

@@ -0,0 +1,16 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+Bundler.setup
+#require 'appraisal'
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end

data/active_resource_extensions.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.authors = ["Benoît Dinocourt"]
+  gem.email = ["ghrind@gmail.com"]
+  gem.description = "Make activeresource model compatible with will_paginate and searchlogic helpers, and add a schema feature"
+  gem.summary = gem.description
+  gem.homepage = "http://github.com/Ghrind/active_resource_extensions"
+
+  gem.files = `git ls-files`.split($\)
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name = "ares-ext"
+  gem.require_paths = ["lib"]
+  gem.version = '0.0.1'
+  
+  #gem.extra_rdoc_files = [
+  #  "LICENSE",
+  #  "README.rdoc"
+  #]
+  # gem.date = %q{2011-08-15}
+  
+  gem.add_development_dependency 'rspec', '~> 1.3.1'
+  gem.add_development_dependency 'activeresource', '2.3.5'
+end

data/lib/active_resource_extensions/resource_with_schema.rb

@@ -0,0 +1,69 @@
+module ActiveResourceExtensions
+  # Get schema from webservice, detect missing attributes and cast known attributes appropriately
+  module ResourceWithSchema
+
+    def self.included base
+      base.extend ClassMethods
+      base.send :include, InstanceMethods
+    end
+
+    module ClassMethods
+
+      def is_attribute? name
+        schema.keys.include? name.to_s
+      end
+
+      def attribute_type name
+        schema[name.to_s]
+      end
+
+      protected
+
+      def schema
+        @schema ||= {}
+      end
+
+      def schema= new_schema
+        @schema = new_schema
+      end
+
+      def load_remote_schema
+        self.schema = get( :schema )
+      end
+
+    end
+
+    module InstanceMethods
+      def method_missing name, *args, &block
+        if self.class.is_attribute? name
+          value = attributes[name.to_s]
+          return if value.nil?
+          if self.class.is_attribute? name
+            case self.class.attribute_type name
+            when 'Time'
+              Time.parse value
+            when 'Integer'
+              value.to_i
+            when 'Float'
+              value.to_f
+            when 'Boolean'
+              [true, 1, '1'].include? value
+            when ''
+              value
+            else
+              begin
+                self.class.attribute_type( name ).constantize.new value
+              rescue ArgumentError, NameError
+                raise ArgumentError, "Can't cast #{value.inspect} into #{self.class.attribute_type( name )}"
+              end
+            end
+          else
+            return value
+          end
+        else
+          super name, *args, &block
+        end
+      end
+    end
+  end
+end

data/lib/active_resource_extensions/searchable_resource/collection.rb

@@ -0,0 +1,44 @@
+module ActiveResourceExtensions
+
+  module SearchableResource
+
+    # Proxy of an Array compatible with will_paginate
+    class Collection
+      instance_methods.each { |m| undef_method m unless m =~ /(^__|^send$|^object_id$)/ }
+
+      attr_reader :current_page, :total_entries, :per_page
+
+      def initialize target, current_page, per_page, total_entries
+        @target = target
+        @current_page = current_page
+        @per_page = per_page
+        @total_entries = total_entries
+      end
+
+      def total_pages
+        ( total_entries.to_f / @per_page ).ceil
+      end
+
+      def previous_page
+        current_page == 1 ? nil : ( current_page - 1 )
+      end
+
+      def next_page
+        current_page == total_pages ? nil : ( current_page + 1 )
+      end
+
+      def target
+        @target ||= []
+      end
+
+      protected
+
+      def method_missing(name, *args, &block)
+        target.send(name, *args, &block)
+      end
+
+    end
+
+  end
+
+end

data/lib/active_resource_extensions/searchable_resource/search.rb

@@ -0,0 +1,61 @@
+module ActiveResourceExtensions
+
+  module SearchableResource
+
+    class Search
+
+      DEFAULT_PAGE = 1
+      DEFAULT_PER_PAGE = 10
+
+      attr_reader :conditions
+
+      def initialize model, conditions = {}
+        @model = model
+        @conditions = conditions
+      end
+
+      def paginate pagination_options = {}
+        # Get the parameters corresponding to the search options
+        params = parse_conditions @conditions
+
+        total_entries = @model.count params
+
+        # Manage pagination
+        params[:page] = ( pagination_options[:page] || DEFAULT_PAGE ).to_i
+        params[:per_page] = ( pagination_options[:per_page] || DEFAULT_PER_PAGE ).to_i
+
+        SearchableResource::Collection.new @model.find( :all, :params => params ), params[:page], params[:per_page], total_entries
+      end
+
+      protected
+
+      # TODO We can add custom search options here
+      def parse_conditions conditions
+
+        # By default all empty options are removed
+        params = conditions.delete_if{ |k, v| v.blank? }
+
+        params
+      end
+
+      # If 
+      def method_missing(name, *args, &block)
+        name.to_s =~ /^([\w]*)(=?)$/
+        attr = $1.to_sym
+
+        ignore_attribute = ! @model.respond_to?( :is_attribute? )
+
+        if ignore_attribute or @model.is_attribute?( attr )
+          if $2 == '='
+            @conditions[attr]= args.first
+          else
+            @conditions[attr]
+          end
+        else
+          super name, *args, &block
+        end
+      end
+
+    end
+  end
+end

data/lib/active_resource_extensions/searchable_resource.rb

@@ -0,0 +1,22 @@
+module ActiveResourceExtensions
+  # Add search and pagination features to ActiveResource models
+  module SearchableResource
+
+    def self.included base
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      def search_for options = {}
+        SearchableResource::Search.new self, options
+      end
+
+      def count params = {}
+        get( :count, params )['count'].to_i
+      end
+
+    end
+
+  end
+end

data/lib/active_resource_extensions.rb

@@ -0,0 +1,4 @@
+require 'active_resource_extensions/resource_with_schema'
+require 'active_resource_extensions/searchable_resource'
+require 'active_resource_extensions/searchable_resource/search'
+require 'active_resource_extensions/searchable_resource/collection'

data/spec/active_resource_extensions/resource_with_schema_spec.rb

@@ -0,0 +1,168 @@
+require 'spec_helper'
+
+describe ActiveResourceExtensions::ResourceWithSchema do
+
+  before do
+    class Person < ActiveResource::Base
+      self.site = 'http://test.webservicehost.com'
+      include ActiveResourceExtensions::ResourceWithSchema
+    end
+  end
+
+  after do
+    class ::Object
+      remove_const :Person
+    end
+  end
+
+  it "should add a schema method" do
+    Person.respond_to?( :schema ).should be_true
+  end
+
+  it "should have an empty schema" do
+    Person.send( :schema ).should == {}
+  end
+
+  it "should replace schema" do
+    schema = { 'name' => 'String' }
+    Person.send( :schema=, schema )
+    Person.send( :schema ).should == schema
+  end
+
+  describe '::load_remote_schema' do
+    it "should use active_resource get method" do
+      Person.should_receive( :get ).with( :schema )
+      Person.send :load_remote_schema
+    end
+
+    it "should load schema from response" do
+      schema = { 'name' => 'String', 'age' => 'Integer' }
+      Person.should_receive( :get ).with( :schema ).and_return( schema )
+      Person.send :load_remote_schema
+      Person.send( :schema ).should == schema
+    end
+  end
+
+  describe '::is_attribute?' do
+
+    before do
+      Person.send( :schema=, { 'name' => 'String', 'age' => 'Integer' } )
+    end
+
+    it "should find attribute when name is a symbol" do
+      Person.is_attribute?( :name ).should be_true
+    end
+
+    it "should find attribute when name is a string" do
+      Person.is_attribute?( 'name' ).should be_true
+    end
+
+    it "should return false if attribute doesn't exists" do
+      Person.is_attribute?( 'firstname' ).should be_false
+    end
+  end
+
+  describe '::attribute_type?' do
+
+    before do
+      Person.send( :schema=, { 'name' => 'String', 'age' => 'Integer' } )
+    end
+
+    it "should return attribute's type when name is a string" do
+      Person.attribute_type( 'name' ).should == 'String'
+    end
+
+    it "should return attribute's type when name is a symbol" do
+      Person.attribute_type( :name ).should == 'String'
+    end
+
+    it "should return nil if attribute is unknown" do
+      Person.attribute_type( :firstname ).should == nil
+    end
+  end
+
+  describe '.method_missing' do
+
+    before do
+      Person.send( :schema=, {
+        'name'        => 'String',
+        'age'         => 'Integer',
+        'created_at'  => 'Time',
+        'is_musician' => 'Boolean',
+        'height'      => 'Float',
+        'unknown_1'   => 'Company',
+        'unknown_2'   => ''
+      } )
+    end
+
+    context "when method is not an attribute name" do
+
+      before do
+        @person = Person.new
+      end
+
+      it "should have default behavior" do
+        lambda do
+          @person.firstname
+        end.should raise_error NoMethodError
+      end
+    end
+
+    context "when method is an attribute name" do
+
+      context "when attribute has not been loaded" do
+
+        before do
+          @person = Person.new
+        end
+
+        it "should return nil" do
+          @person.name.should be_nil
+        end
+      end
+
+      context "when attribute has been loaded" do
+
+        before do
+          @person = Person.new(
+            :name        => 'John',
+            :age         => '26',
+            :height      => '5.3',
+            :is_musician => '1',
+            :created_at  => '2012-05-01 23:15:12',
+            :unknown_1   => 'a',
+            :unknown_2   => 'b' )
+        end
+
+        it "should cast value appropriately" do
+          @person.name.should == 'John'
+          @person.age.should == 26
+          @person.height.should == 5.3
+          @person.is_musician.should == true
+          @person.created_at.should == Time.parse('2012-05-01 23:15:12')
+
+          for value in [ '0', 0, false, 'true' ]
+            person = Person.new( :is_musician => value )
+            if person.is_musician != false
+              violated "#{value.inspect} should be cast as false"
+            end
+          end
+
+        end
+
+        it "should raise an ArgumentError if casting cannot be made" do
+          lambda do
+            @person.unknown_1
+          end.should raise_error ArgumentError
+        end
+
+        it "should return value if attribute type is an empty string" do
+          @person.unknown_2.should == 'b'
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/active_resource_extensions/searchable_resource_spec/collection_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe ActiveResourceExtensions::SearchableResource::Collection do
+
+  before do
+    @collection = ActiveResourceExtensions::SearchableResource::Collection.new [], 2, 10, 51
+  end
+
+  describe '.total_pages' do
+    it "should return correct page number" do
+      @collection.total_pages.should == 6
+    end
+  end
+
+  describe '.previous_page' do
+
+    context "when at the first page" do
+
+      before do
+        @collection = ActiveResourceExtensions::SearchableResource::Collection.new [], 1, 10, 51
+      end
+      
+      it "should return nil" do
+        @collection.previous_page.should be_nil
+      end
+
+    end
+
+    context "when not at the first page" do
+
+      it "should return correct page number" do
+        @collection.previous_page.should == 1
+      end
+
+    end
+  end
+
+  describe '.next_page' do
+    context "when at the last page" do
+
+      before do
+        @collection = ActiveResourceExtensions::SearchableResource::Collection.new [], 6, 10, 51
+      end
+
+      it "should return nil" do
+        @collection.next_page.should be_nil
+      end
+
+    end
+
+    context "when not at the last page" do
+
+      it "should return correct page number" do
+        @collection.next_page.should == 3
+      end
+
+    end
+  end
+
+end

data/spec/active_resource_extensions/searchable_resource_spec/search_spec.rb

@@ -0,0 +1,124 @@
+require 'spec_helper'
+
+describe ActiveResourceExtensions::SearchableResource::Search do
+
+  before do
+    class Person < ActiveResource::Base
+      self.site = 'http://test.webservicehost.com'
+      include ActiveResourceExtensions::SearchableResource
+    end
+    @search = Person.search_for
+  end
+
+  after do
+    class ::Object
+      remove_const :Person
+    end
+  end
+
+  describe '.method_missing' do
+    context "when class has a schema" do
+
+      before do
+        Person.send :include, ActiveResourceExtensions::ResourceWithSchema
+        Person.send :schema=, 'name' => 'String', 'age' => 'Integer'
+        @search = Person.search_for
+      end
+
+      context "when method name is a known attribute" do
+
+        it "should set condition" do
+          @search.age = 26
+          @search.conditions[:age].should == 26
+        end
+
+        it "should get condition" do
+          @search.instance_variable_set :@conditions, :age => 26
+          @search.age.should == 26
+        end
+
+      end
+
+      context "when method name is not an attribute" do
+        it "should have default behavior" do
+          lambda do
+            @search.firstname
+          end.should raise_error NoMethodError
+
+          lambda do
+            @search.firstname= 'bob'
+          end.should raise_error NoMethodError
+        end
+      end
+    end
+
+    context "when class has no schema" do
+      it "should set condition" do
+        @search.firstname = 'bob'
+        @search.conditions[:firstname].should == 'bob'
+      end
+      it "should get condition" do
+        @search.firstname.should be_nil
+      end
+    end
+  end
+
+  describe '.parse_conditions' do
+    it "should remove empty conditions" do
+      @search.send( :parse_conditions, :name_like => 'john', :age => '' ).should == { :name_like => 'john' }
+    end
+  end
+
+  describe '.paginate' do
+
+    it "should parse conditions" do
+      @search.name_like = 'john'
+      @search.age = ''
+
+      @search.should_receive( :parse_conditions ).with( :name_like => 'john', :age => '' ).and_return :name_like => 'john'
+
+      Person.should_receive( :count).with( { :name_like => 'john' } ).and_return 0
+      Person.should_receive( :find ).with( :all, :params => { :page => 1, :per_page => 10, :name_like => 'john' } ).and_return []
+
+      @search.paginate
+    end
+
+    it "should set collection 'current_page' attribute" do
+      Person.should_receive( :count).with( {} ).and_return 0
+      Person.should_receive( :find ).with( :all, :params => { :page => 5, :per_page => 10 } ).and_return []
+      @search.paginate( :page => 5 ).current_page.should == 5
+    end
+
+    it "should set collection 'per_page' attribute" do
+      Person.should_receive( :count).with( {} ).and_return 0
+      Person.should_receive( :find ).with( :all, :params => { :page => 1, :per_page => 100 } ).and_return []
+      @search.paginate( :per_page => 100 ).per_page.should == 100
+    end
+
+    describe "returned object" do
+
+      before do
+        @dataset = [Person.new, Person.new]
+        Person.should_receive( :count).with( anything ).and_return 2
+        Person.should_receive( :find ).with( :all, anything ).and_return @dataset
+      end
+
+      it "should use default if 'page' option is missing" do
+        @search.paginate.current_page.should == 1
+      end
+
+      it "should use default if 'per_page' option is missing" do
+        @search.paginate.per_page.should == 10
+      end
+
+      it "should set collection 'target' attribute" do
+        @search.paginate.target.should == @dataset
+      end
+
+      it "should set collection 'total_entries' attribute" do
+        @search.paginate.total_entries.should == 2
+      end
+    end
+  end
+
+end

data/spec/active_resource_extensions/searchable_resource_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe ActiveResourceExtensions::SearchableResource do
+
+  before do
+    class Person < ActiveResource::Base
+      self.site = 'http://test.webservicehost.com'
+      include ActiveResourceExtensions::SearchableResource
+    end
+  end
+
+  after do
+    class ::Object
+      remove_const :Person
+    end
+  end
+
+  describe '#search_for' do
+    it "should return an instance of ActiveResourceExtensions::SearchableResource::Search" do
+      Person.search_for.class.name.should == "ActiveResourceExtensions::SearchableResource::Search"
+    end
+  end
+
+  describe '#count' do
+    it "should return an integer with the count" do
+      Person.should_receive( :get ).with( :count, {} ).and_return({ 'count' => '3' })
+      Person.count.should == 3
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+Bundler.setup
+require 'active_resource'
+require 'active_resource_extensions'

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: ares-ext
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Beno\xC3\xAEt Dinocourt"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-23 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :development
+  version_requirements: *id002
+description: Make activeresource model compatible with will_paginate and searchlogic helpers, and add a schema feature
+email: 
+- ghrind@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- active_resource_extensions.gemspec
+- lib/active_resource_extensions.rb
+- lib/active_resource_extensions/resource_with_schema.rb
+- lib/active_resource_extensions/searchable_resource.rb
+- lib/active_resource_extensions/searchable_resource/collection.rb
+- lib/active_resource_extensions/searchable_resource/search.rb
+- spec/active_resource_extensions/resource_with_schema_spec.rb
+- spec/active_resource_extensions/searchable_resource_spec.rb
+- spec/active_resource_extensions/searchable_resource_spec/collection_spec.rb
+- spec/active_resource_extensions/searchable_resource_spec/search_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/Ghrind/active_resource_extensions
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: Make activeresource model compatible with will_paginate and searchlogic helpers, and add a schema feature
+test_files: 
+- spec/active_resource_extensions/resource_with_schema_spec.rb
+- spec/active_resource_extensions/searchable_resource_spec.rb
+- spec/active_resource_extensions/searchable_resource_spec/collection_spec.rb
+- spec/active_resource_extensions/searchable_resource_spec/search_spec.rb
+- spec/spec_helper.rb