rangetastic 0.3.2

data/MIT-License

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Chris Herring
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/Manifest

@@ -0,0 +1,11 @@
+MIT-License
+Manifest
+README.markdown
+Rakefile
+lib/rangetastic.rb
+rangetastic.gemspec
+spec/fixtures/models.rb
+spec/fixtures/structure.sql
+spec/rangetastic_spec.rb
+spec/spec_helper.rb
+spec/test_helper.rb

data/README.markdown

@@ -0,0 +1,40 @@
+Introduction
+============
+Rangetastic allows you to filter results of a named_scope call on any dates using any of a list of whitelisted fields you specify.
+
+Configuration & Usage
+=====================
+
+To acheive this you need to install rangetastic
+
+    sudo gem install cherring-rangetastic
+    
+Then inside your environment.rb
+
+    config.gem "cherring-rangetastic", :lib => "rangetastic", :source => "http://gems.github.com"
+    
+Then in your model pass in the fields you wish to allow to be searchable using the between filter
+
+    class Order < ActiveRecord::Base
+      acts_as_rangetastic :fields => ["ordered_on", "fulfilled_on"]
+    end
+    
+You can then chain the between scope with any named_scope call you make:
+
+    Order.fulfilled.between(1.week.ago, 10.minutes.ago, "fulfilled_on")
+
+But if you (or someone nasty!) try to use a field that is not whitelisted, it will raise ActiveRecord::StatementInvalid
+    
+Now you can also access this with the following syntax for any field ending with _on that is on the Model you are calling from like so.
+
+    Order.fulfilled.ordered_between(1.week.ago, 10.minutes.ago)
+
+In this new version of rangetastic you can also query on _at fields. If you have an _at field such as created_at you can now
+
+    Order.fulfilled.created_between(1.week.ago, 10.minutes.ago)
+    
+However if you have an _on field and _at field the on field will take precedence over the at. If you want to access the _at field over _on field you will need to use the .between and whitelisted fields method specified first.
+
+But if your field isn't on the Model or isn't an _on or an _at field then it will raise the standard NoMethodError.
+
+Thanks to [spraints](http://github.com/spraints) for some inspiration.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('rangetastic', '0.3.2') do |p|
+  p.description     = "Chain a date range to any named_scope on any date field with specified white listed fields"
+  p.url             = "http://github.com/cherring/rangetastic"
+  p.author          = "Chris Herring"
+  p.email           = "chris.herring.iphone@gmail.com"
+  p.ignore_pattern  = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/rangetastic.rb

@@ -0,0 +1,62 @@
+module Rangetastic
+  
+  def self.included(base)
+    base.extend ClassMethods
+  end
+  
+  module ClassMethods
+    def acts_as_rangetastic(options = {:fields => []})
+      @fields = options[:fields]
+      named_scope :between, lambda{ |start_date, end_date, fieldname|
+        field = @fields.include?(fieldname) ? fieldname : raise(ActiveRecord::StatementInvalid)
+        { :conditions => ["#{field} >= ? AND #{field} <= ?", start_date, end_date] }
+      }
+    end
+    
+    private
+      def method_missing(symbol, *args, &block)
+        if (field(symbol) || @fields.include?(field_to_query))
+          make_scope(symbol, field_to_query, *args)
+        else
+          super(symbol, *args)
+        end
+      end
+      
+      def field(symbol)
+        if columns_hash.has_key? on_field(symbol)
+          @field = on_field(symbol)
+        elsif columns_hash.has_key? at_field(symbol)
+          @field = at_field(symbol)
+        else
+          @field = nil
+        end
+      end
+      
+      def at_field(symbol)
+        "#{symbol.to_s.gsub("_between","")}_at"
+      end
+      
+      def on_field(symbol)
+        "#{symbol.to_s.gsub("_between","")}_on"
+      end
+      
+      def field_to_query
+        @field
+      end
+      
+      def make_scope(scope, field, *args)
+        named_scope scope, lambda{ |start_date, end_date|
+          { :conditions => ["#{field} BETWEEN ? AND ?", start_date, end_date] }
+        }
+        call_scope(scope, *args)
+      end
+    
+      def call_scope(scope, *args)
+        self.send(scope, args[0], args[1])
+      end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  include Rangetastic
+end

data/rangetastic.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rangetastic}
+  s.version = "0.3.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Herring"]
+  s.date = %q{2009-09-20}
+  s.description = %q{Chain a date range to any named_scope on any date field with specified white listed fields}
+  s.email = %q{chris.herring.iphone@gmail.com}
+  s.extra_rdoc_files = ["README.markdown", "lib/rangetastic.rb"]
+  s.files = ["MIT-License", "Manifest", "README.markdown", "Rakefile", "lib/rangetastic.rb", "rangetastic.gemspec", "spec/fixtures/models.rb", "spec/fixtures/structure.sql", "spec/rangetastic_spec.rb", "spec/spec_helper.rb", "spec/test_helper.rb"]
+  s.homepage = %q{http://github.com/cherring/rangetastic}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Rangetastic", "--main", "README.markdown"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rangetastic}
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Chain a date range to any named_scope on any date field with specified white listed fields}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/fixtures/models.rb

@@ -0,0 +1,7 @@
+class Order < ActiveRecord::Base
+
+  acts_as_rangetastic :fields => ["fulfilled_on","ordered_on","shipped_at"]
+  
+  named_scope :fulfilled, :conditions => ["fulfilled_on is not null"]
+  
+end

data/spec/fixtures/structure.sql

@@ -0,0 +1,20 @@
+DROP TABLE IF EXISTS orders;
+
+DROP SEQUENCE IF EXISTS orders_id_seq;
+
+CREATE SEQUENCE orders_id_seq
+    START WITH 1
+    INCREMENT BY 1
+    NO MAXVALUE
+    NO MINVALUE
+    CACHE 1;
+    
+CREATE TABLE orders (
+    id integer NOT NULL default nextval('orders_id_seq'),
+    ordered_on timestamp,
+    fulfilled_on timestamp,
+    shipped_at timestamp,
+    created_at timestamp without time zone,
+    updated_at timestamp without time zone
+);
+

data/spec/rangetastic_spec.rb

@@ -0,0 +1,42 @@
+require 'spec/spec_helper'
+require 'rangetastic'
+include Rangetastic
+
+describe Order do
+
+  it "should have 25 orders" do
+    Order.count.should == 25
+  end
+  
+  it "should respond to between" do
+    Order.respond_to?(:between).should == true
+  end
+  
+  it "should have 5 orders fulfilled that were ordered no more than 10 days ago" do
+    Order.fulfilled.between(10.days.ago, 1.day.ago,"ordered_on").size.should == 5
+  end
+  
+  it "should raise an error if the field is not in fields => []" do
+    lambda{ Order.fulfilled.between(1.week.ago, 1.day.ago, "not_a_field") }.should raise_error(ActiveRecord::StatementInvalid)
+  end
+  
+  it "should be able to filter on any field that is in fields => []" do
+    %w(ordered_on fulfilled_on shipped_at).each do |field|
+      lambda{ Order.fulfilled.between(1.week.ago, 1.day.ago, field) }.should_not raise_error(ActiveRecord::StatementInvalid)
+    end
+  end
+  
+  it "should have 5 orders fulfilled that were ordered no more than 10 days ago - 3" do
+    Order.fulfilled.ordered_between(10.days.ago, 1.day.ago).size.should == 5
+  end
+  
+  %w(ordered shipped fulfilled created updated).each do |field|
+    it "should be able to access #{field}_between" do
+      lambda{ Order.send("#{field}_between", 1.day.ago, Date.today) }.should_not raise_error(NoMethodError)
+    end
+  end
+  
+  it "should raise no method error when a field doesn't exist" do
+    lambda{ Order.eaten_between(1.day.ago, Date.today) }.should raise_error(NoMethodError)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+# Inspiration gained from Thinking Sphinx's test suite via Ryan Bigg's by_star test suite.
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'rubygems'
+require 'activerecord'
+require 'rangetastic'
+require 'spec/fixtures/models'
+require 'spec/test_helper'
+
+FileUtils.mkdir_p "#{Dir.pwd}/tmp"
+
+ActiveRecord::Base.logger = Logger.new(StringIO.new)
+
+Spec::Runner.configure do |config|  
+  test = TestHelper.new
+  test.setup_postgresql
+end

data/spec/test_helper.rb

@@ -0,0 +1,42 @@
+class TestHelper
+  attr_accessor :host, :username, :password
+  attr_reader   :path
+  
+  def initialize
+    @host     = "localhost"
+    @username = "chris" #Insert username for db here
+    @password = ""
+
+    @path = File.expand_path(File.dirname(__FILE__))
+  end
+  
+  def setup_postgresql
+    ActiveRecord::Base.establish_connection(
+      :adapter  => 'postgresql',
+      :database => 'rangetastic',
+      :username => @username,
+      :password => @password,
+      :host     => @host
+    )
+    ActiveRecord::Base.logger = Logger.new(File.open("tmp/activerecord.log", "a"))
+    
+    structure = File.open("spec/fixtures/structure.sql") { |f| f.read.chomp }
+    structure.split(';').each { |table|
+      ActiveRecord::Base.connection.execute table
+    }
+    
+    10.times do
+      Order.create(:ordered_on => 2.weeks.ago, :fulfilled_on => 2.days.ago)
+    end
+
+    10.times do
+      Order.create(:ordered_on => 3.weeks.ago, :fulfilled_on => 2.days.ago)
+    end
+    
+    5.times do
+      Order.create(:ordered_on => 1.weeks.ago, :fulfilled_on => 2.days.ago)
+    end
+      
+  end
+  
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: rangetastic
+version: !ruby/object:Gem::Version 
+  version: 0.3.2
+platform: ruby
+authors: 
+- Chris Herring
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-20 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: Chain a date range to any named_scope on any date field with specified white listed fields
+email: chris.herring.iphone@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+- lib/rangetastic.rb
+files: 
+- MIT-License
+- Manifest
+- README.markdown
+- Rakefile
+- lib/rangetastic.rb
+- rangetastic.gemspec
+- spec/fixtures/models.rb
+- spec/fixtures/structure.sql
+- spec/rangetastic_spec.rb
+- spec/spec_helper.rb
+- spec/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/cherring/rangetastic
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Rangetastic
+- --main
+- README.markdown
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: rangetastic
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Chain a date range to any named_scope on any date field with specified white listed fields
+test_files: []
+