refinuri 0.5.0

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Chris Kalafarski
+
+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/README.md

@@ -0,0 +1,186 @@
+# Refinuri
+
+Refinuri provides two primary functions related to querying and filtering data:
+
++ a simple way to produce pretty, meaningful URLs, even with complex query strings
++ a standardized, extensible interface to filtering metadata
+
+## Basics
+
+	@filters = Refinuri::Parser.parse_url('name:apple,banana,cherry;price:0-5;age:7-')
+	# sets up a new FilterSet based on the filter part of a URL
+	
+	Product.filtered(@filters)
+	# automatically applies all the filters to an ActiveRecord object just as though each were it's own #where()
+
+## In practice
+
+### Pretty URLs
+
+A 'traditional' style URL with standard query strings such as
+	
+	craigslist.org/search/housing?cat=loft&minPrice=500&maxPrice=1000&cats=true&dogs=true&bedrooms=2
+
+Will become
+
+	craigslist.org/search/housing/type:loft;price:500-1000;pets:cats,dogs;bedrooms:2/
+	
+### Internal interface to filters
+
+Filters are stored within a FilterSet, a Hash-like object that allows for easy access to properly-typed data and merging in changes to the set of filters. Filters and changes are passed into FilterSet as hashes.
+	
+	>> base_filters = { :name => ['apple','banana','cherry'], :price => 0..5, :weight => '4..' }
+	>> set = FilterSet.new(base_filters)
+	
+The filters can be exposed through
+
+	>> set[:name].value # => ['apple','banana','cherry']
+	>> set.to_url # => 'name:apple,banana,cherry;price:0-5;weight:4+'
+	>> set.to_h # => { :name => ['apple','banana','cherry'], :price => 0..5, :weight => '4..' }
+	
+Changes are merged into an existing filter set, either implicitly or explicitly as CRUD functions
+	
+	# implicit changes generally update existing values
+	>> changes = { :name => 'dewberry' }
+	>> set.merge!(changes)
+	>> set[:name].value # => ['apple','banana','cherry','dewberry']
+	
+	# explicilty stated CRUD functions
+	>> more_changes = { :update => { :name => ['eggplant','fig] }, :destroy => { :price => nil } }
+	>> set.merge!(more_changes)
+	>> set[:name].value # => ['apple','banana','cherry','dewberry','eggplant','fig']
+	>> set[:price] # => nil
+	
+## Benefits
+
+Not only does Refinuri improve the readability and length of URLs, but behind the scenes each piece of filtering data is being handled as the appropriate data type automatically. A range of prices is an actual Range, a list of brands is an Array, etc.
+
+This is useful both because it allows you to hand the queries off to ActiveRecord very easily, and also because the data can change very freely. A filter can change from an Integer to a Range with very little overhear need to change things on the backend.
+
+The hope is that with most of the heavy lifting being done automatically and in a consistent way, it will be much easier to actually implement a user-facing interface that allows for these more advanced controls than are generally being offered.
+
+## Usage
+
+### Installation
+	
+	$ sudo gem install refinuri
+
+### Common API aspects
+
+#### URL parsing
+	
+	>> Refinuri::Parser.parse_url('name:apple,banana,cherry')
+	=> #<Refinuri::Base::FilterSet:0x1003ad300>
+	
+#### Generating URL string
+	
+	>> @filter_set.to_url
+	=> 'name:apple,banana,cherry'
+	
+#### Available data types
+
+Currently supported datatypes include:
+
+##### Arrays
+
+	# in URLs an array is represented as
+	key:item1,item2,item3
+	
+	# which are parsed as standard Ruby arrays, available through the FilterSet
+	@set[:key] => ['item1','item2','item3']
+
+##### Bounded ranges
+
+	# in URLs a range is represented as
+	key:10-20
+	
+	# which are parsed as standard Ruby ranges, available through the FilterSet
+	@set[:key] => 10..20
+
+(Support for both inclusive and exclusive ranges is not yet included)
+
+##### Unbounded ranges
+
+Unbounded ranges are a non-standard datatype, which allows for a convenient way of defining only an upper- or lower-bound on a range.
+
+Lower-bound ranges
+
+	# represented in URLs as
+	key:10+
+	
+	# are parsed into strings in the format
+	@set[:key] => '10..'
+	
+	# and provides a convenience method for use in an ActiveRecord #where
+	@set[:key].to_db => 'key >= 10'
+
+Upper-bound ranges
+
+	# represented in URLs as
+	key:10-
+	
+	# are parsed into strings in the format
+	@set[:key] => '..10'
+	
+	# and provides a convenience method for use in an ActiveRecord #where
+	@set[:key].to_db => 'key <= 10'
+	
+#### Creating and modifying FilterSets
+
+New filters a populated with a hash
+
+	>> Refinuri::Base::FilterSet.new({ :name => ['apple','banana','cherry'] })
+
+Filters are modified with #merge! by passing in a hash of changes.
+
+Changes that are not explicitly stated as a CRUD function are assumed to be UPDATEs. UPDATEs will create a new filter if it does not already exist, or will add unique values to an array, or replace a range. CREATE will either create a new filter or completely replace an existing filter.
+
+	# implicit changes, treated as UPDATE
+	>> @filter.merge!({ :name => ['dewberry','eggplant'] })
+	# @filter[:name].value => ['apple','banana','cherry','dewberry','eggplant']
+	
+	# explicit UPDATE
+	>> @filter.merge!({ :update => { :name => ['dewberry','eggplant'] } })
+	# @filter[:name].value => ['apple','banana','cherry','dewberry','eggplant']
+	
+	# explicit CREATE
+	>> @filter.merge!({ :creaet => { :name => ['dewberry','eggplant'] } })
+	# @filter[:name].value => ['dewberry','eggplant']
+	
+	# explicit DELETE
+	>> @filter.merge!({ :delete => { :name => nil } })
+	# @filter[:name] => nil
+
+#### Using filters with ActiveRecord
+
+Each data type has a #to_db method which returns a value suitable for use as the argument for ActiveRecord's #where method
+
+	@set = Refinuri::Base::FilterSet.new({ :price => 10..20, :age => '10..' })
+	
+	Product.where(@set[:price].to_db)
+	# is equivalent to
+	Product.where(:price => 10..20)
+	
+and
+	Product.where(@set[:age].to_db)
+	# is equivalent to
+	Product.where('age >= 10')
+	
+If you would like to simply query an ActiveRecord object against all the filters in a FilterSet, the #filtered() method comes in handy
+
+	Product.filtered(@set)
+	# is equivalent to
+	Product.where(:price => 10..20).where('age >= 10')	
+	
+#### Helpers
+	
+	# creates a link to the current view, adding 'apple' the the :name filter, 
+	# or returning an unchanged link if 'apple' is already in the :name filter
+	>> filter_with_link("Apple", { :name => 'apple' })
+	
+	# toggles the value 'apple' within the name filter, adding it if is not
+	# in the set, or removing it if it is
+	>> toggle_filter_with_link("Apple", { :name => 'apple' })
+
+### Example Application
+*coming soon...*

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "refinuri"
+    gem.summary = %Q{Helps clean up complex URLs with filtering query string, like you may find in an online store}
+    gem.description = %Q{Helps clean up complex URLs with filtering query string, like you may find in an online store}
+    gem.email = "chris@farski.com"
+    gem.homepage = "http://github.com/farski/refinuri"
+    gem.authors = ["Chris Kalafarski"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "refinuri #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/lib/refinuri/base.rb

@@ -0,0 +1,110 @@
+module Refinuri
+  module Base    
+    class FilterSet
+      attr_reader :filters
+      def initialize(hash)
+        raise ArgumentError, "Argument must be a Hash", caller unless hash.is_a?(Hash)
+        @filters = Hash.new
+        modify_filters(hash)
+      end
+      
+      def merge!(hash)
+        hash[:update] ||= Hash.new
+        hash[:update].merge!(extract_implicit_filters(hash))
+        hash.each { |key,value| modify_filters(value,key) }
+        return self
+      end
+      
+      def [](filter_name)
+        @filters[filter_name]# && @filters[filter_name].value
+      end
+      
+      def to_h
+        filters = Hash.new
+        @filters.each { |key,value| filters[key] = value.value }
+        return filters
+      end
+      
+      def to_url
+        string_array = Array.new
+        @filters.each do |name,filter_obj|
+          string_array << "#{name}:#{filter_obj.to_s}"
+        end
+        return string_array.join(';')
+      end
+      
+      private        
+        def modify_filters(hash, function = :create)
+          case function
+            when :create then create_filters(hash)
+            when :update then update_filters(hash)
+            when :delete then delete_filters(hash)
+          end
+        end
+        
+        def create_filters(hash)
+          hash.each do |key,value|
+            delete_filters({ key => value }) if @filters.has_key?(key)
+            @filters[key] = case value
+              when Array then Filters::Array.new(key,value)
+              when Range then Filters::Range.new(key,value)
+              when String
+                case value
+                  when /\d\.\./ then Filters::UnboundedRange.new(key,value)
+                  when /\.\.\d/ then Filters::UnboundedRange.new(key,value)
+                  else Filters::Array.new(key,[value])
+                end
+            end
+          end
+        end
+        
+        def update_filters(hash)
+          hash.each do |key,value|
+            if @filters.has_key?(key)
+              @filters[key].update(value)
+            else
+              create_filters({ key => value })
+            end
+          end
+        end
+        
+        def delete_filters(hash)
+          hash.each do |key,value|
+            if @filters.has_key?(key)
+              @filters[key].delete(value)
+              @filters.delete(key) if @filters[key].value.nil? || @filters[key].value.empty?
+            end
+          end
+        end
+      
+        def extract_implicit_filters(hash)
+          implicits = Hash.new
+          hash.each do |key,value|
+            implicits[key] = value unless [:create,:read,:update,:delete].include?(key)
+          end
+          return implicits
+        end
+      # end of private methods
+    end
+
+    class Filter
+      attr_reader :name, :value
+      def initialize(name,value)
+        @name = name
+        @value = value
+      end
+      
+      def update(value)
+        @value = value
+      end
+      
+      def delete(value)
+        @value = nil
+      end
+      
+      def to_db
+        { @name => @value }
+      end
+    end
+  end
+end

data/lib/refinuri/filters.rb

@@ -0,0 +1,40 @@
+module Refinuri
+  module Filters
+    class Array < Base::Filter
+      def update(value)
+        (@value << [value]).flatten!.uniq!
+      end
+      
+      def delete(value)
+        [value].flatten.each { |v| @value.delete(v) }
+      end
+      
+      def to_s
+        value.join(',')
+      end
+    end
+    
+    class Range < Base::Filter
+      def to_s
+        Utilities.transcode_range(@value)
+      end
+    end
+    
+    class UnboundedRange < Base::Filter
+      def to_s
+        Utilities.transcode_unbounded_range(@value)
+      end
+      
+      def numeric_value
+        @value.sub(/\.{2,3}/, '')
+      end
+      
+      def to_db
+        case @value
+          when /^\.\./ then "#{@name} <= #{self.numeric_value}"
+          when /\.\.$/ then "#{@name} >= #{self.numeric_value}"
+        end
+      end
+    end
+  end
+end

data/lib/refinuri/helpers.rb

@@ -0,0 +1,27 @@
+module Refinuri
+  module Helpers
+    def filter_with_link(name, filters, options = nil, html_options = nil)
+      options = options || params
+      options[:filters] = @filters.merge!(filters).to_url
+      link_to(name,options,html_options)
+    end
+    
+    # TODO needs to get cleaned up
+    def toggle_filter_with_link(name, toggle_filter, options = nil, html_options = nil)
+      options = options || params
+    
+      key_to_toggle = toggle_filter.first[0]
+      if @filters.filters[key_to_toggle]
+        crud = case @filters.filters[key_to_toggle].value
+          when Array then (@filters.filters[key_to_toggle].value.include?(toggle_filter.first[1]) ? :delete : :update)
+          else :delete
+        end
+      else
+        crud = :update
+      end
+    
+      options[:filters] = @filters.merge!({ crud => toggle_filter }).to_url
+      link_to(name,options,html_options)
+    end
+  end
+end

data/lib/refinuri/parser.rb

@@ -0,0 +1,30 @@
+module Refinuri
+  module Parser
+    def self.parse_url(string)
+      Refinuri::Base::FilterSet.new(extract_filters(string))
+    end
+    
+    private
+      def self.extract_filters(string)
+        string.split(';').inject(Hash.new) do |filters, str|
+          filters.merge(parse_filter(str))
+        end
+      end
+    
+      def self.parse_filter(string)
+        name, value_string = string.split(':')
+        value = normalize_filter_value(value_string)
+        return { name.to_sym => value }
+      end
+
+      def self.normalize_filter_value(string)
+        case string
+          when /^(\d+(\.\d+)?)-(\d+(\.\d+)?)$/ then Utilities.transcode_range(string) #range
+          when /,/ then string.split(',') # array
+          when /\+$/ then Utilities.transcode_unbounded_range(string) #greater than
+          when /\-$/  then Utilities.transcode_unbounded_range(string) #less than
+          else string
+        end
+      end
+  end
+end

data/lib/refinuri/query.rb

@@ -0,0 +1,15 @@
+module Refinuri
+  module Query
+    def filtered(filterset)
+      filtered_self = self
+    
+      if filterset
+        filterset.filters.each do |name,filter_obj|
+          filtered_self = filtered_self.where(filter_obj.to_db)
+        end
+      end
+    
+      return filtered_self.scoped
+    end
+  end
+end

data/lib/refinuri/utilities.rb

@@ -0,0 +1,19 @@
+module Refinuri
+  module Utilities    
+    def self.transcode_range(range_or_string)
+      case range_or_string
+        when Range then "#{range_or_string.first}-#{range_or_string.last}"
+        when String then instance_eval(range_or_string.sub(/-/,'..'))
+      end
+    end
+
+    def self.transcode_unbounded_range(range)
+      case range
+        when /\+$/ then range.chop.concat('..')
+        when /\-$/ then "..".concat(range.chop)
+        when /\.{2}$/ then range.chop.chop.concat('+')
+        when /^\.{2}/ then range.reverse.chop.chop.reverse.concat('-')
+      end
+    end
+  end
+end

data/lib/refinuri.rb

@@ -0,0 +1,18 @@
+require 'refinuri/base'
+require 'refinuri/utilities'
+require 'refinuri/filters'
+require 'refinuri/parser'
+require 'refinuri/helpers'
+require 'refinuri/query'
+
+module Refinuri
+  include Refinuri::Base
+  include Refinuri::Utilities
+  include Refinuri::Filters
+  include Refinuri::Helpers
+  include Refinuri::Parser
+  include Refinuri::Query
+end
+
+ActionView::Base.send :include, Refinuri::Helpers
+ActiveRecord::Base.send :extend, Refinuri::Query

data/refinuri.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{refinuri}
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Kalafarski"]
+  s.date = %q{2010-02-07}
+  s.description = %q{Helps clean up complex URLs with filtering query string, like you may find in an online store}
+  s.email = %q{chris@farski.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/refinuri.rb",
+     "lib/refinuri/base.rb",
+     "lib/refinuri/filters.rb",
+     "lib/refinuri/helpers.rb",
+     "lib/refinuri/parser.rb",
+     "lib/refinuri/query.rb",
+     "lib/refinuri/utilities.rb",
+     "refinuri.gemspec",
+     "test/helper.rb",
+     "test/test_array_filters.rb",
+     "test/test_helpers.rb",
+     "test/test_parser.rb",
+     "test/test_range_filters.rb",
+     "test/test_refinuri.rb",
+     "test/test_unbounded_range_filters.rb",
+     "test/test_utilties.rb"
+  ]
+  s.homepage = %q{http://github.com/farski/refinuri}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Helps clean up complex URLs with filtering query string, like you may find in an online store}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_array_filters.rb",
+     "test/test_helpers.rb",
+     "test/test_parser.rb",
+     "test/test_range_filters.rb",
+     "test/test_refinuri.rb",
+     "test/test_unbounded_range_filters.rb",
+     "test/test_utilties.rb"
+  ]
+
+  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
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'refinuri'
+
+class Test::Unit::TestCase
+end

data/test/test_array_filters.rb

@@ -0,0 +1,164 @@
+require 'helper'
+
+class TestArrayFilters < Test::Unit::TestCase
+  context "When modifying a FilterSet that started as a string" do
+    setup do
+      @set = Refinuri::Base::FilterSet.new({:name=>"apple"})
+    end
+    
+    context "and running UPDATE actions on the original filter" do
+    
+      should "allow implicit additions as a string" do
+        assert_equal ["apple","banana"], @set.merge!({ :name => 'banana' }).filters[:name].value
+      end
+    
+      should "allow implicit additions as an array" do
+        assert_equal ["apple","banana"], @set.merge!({ :name => ['banana'] }).filters[:name].value
+        assert_equal ["apple","banana","cherry"], @set.merge!({ :name => ['banana','cherry'] }).filters[:name].value
+      end
+    
+      should "allow explicit additions as a string" do
+        assert_equal ["apple","banana"], @set.merge!({ :update => { :name => 'banana' } }).filters[:name].value
+      end
+    
+      should "allow explicit additions as an array" do
+        assert_equal ["apple","banana"], @set.merge!({ :update => { :name => ['banana'] } }).filters[:name].value
+        assert_equal ["apple","banana","cherry"], @set.merge!({ :update => { :name => ['banana','cherry'] } }).filters[:name].value
+      end
+    end
+    
+    context "and running CREATE actions on the original filter" do
+      should "replace the original filter" do
+        assert_equal ["banana"], @set.merge!({ :create => { :name => 'banana' } }).filters[:name].value
+        assert_equal ["banana"], @set.merge!({ :create => { :name => ['banana'] } }).filters[:name].value
+        assert_equal ["banana",'cherry'], @set.merge!({ :create => { :name => ['banana','cherry'] } }).filters[:name].value
+      end
+    end
+
+    context "and running UPDATE actions on a new filter" do
+      should "default to CREATE for the new filter and be able to return the original filter and the new filter" do
+        assert_equal ["apple"], @set.merge!({ :update => { :color => 'red' } }).filters[:name].value
+        assert_equal ["red"], @set.merge!({ :update => { :color => 'red' } }).filters[:color].value
+        assert_equal ["red"], @set.merge!({ :update => { :color => ['red'] } }).filters[:color].value
+        assert_equal ["red",'yellow'], @set.merge!({ :update => { :color => ['red','yellow'] } }).filters[:color].value
+      end
+    end
+
+    context "and running UPDATE actions on a new filter and the original filter" do
+      should "default to CREATE for the new filter and be able to return the UPDATEd filter and the new filter" do
+        assert_equal ["apple","banana"], @set.merge!({ :update => { :color => 'red', :name => 'banana' } }).filters[:name].value
+        assert_equal ["red"], @set.merge!({ :update => { :color => 'red', :name => 'banana' } }).filters[:color].value
+      end
+    end
+    
+    context "and running CREATE actions on the original filter and a new filter" do
+      should "replace the original filter" do
+        assert_equal ["banana"], @set.merge!({ :create => { :name => 'banana', :color => ['red'] } }).filters[:name].value
+        assert_equal ["red"], @set.merge!({ :create => { :name => 'banana', :color => ['red'] } }).filters[:color].value
+      end
+    end
+
+    context "and running simultaneous explicit CREATE and UPDATE actions" do
+      should "be able to update the original filter and create a new one" do
+        assert_equal ['apple',"banana"], @set.merge!({ :update => { :name => 'banana' }, :create => { :color => 'red' } }).filters[:name].value
+        assert_equal ['red'], @set.merge!({ :update => { :name => 'banana' }, :create => { :color => 'red' } }).filters[:color].value
+      end
+      
+      should "be able to replace the original filter and UPDATE (default to create) a new one" do
+        assert_equal ['banana'], @set.merge!({ :create => { :name => 'banana' }, :update => { :color => 'red' } }).filters[:name].value
+        assert_equal ['red'], @set.merge!({ :create => { :name => 'banana' }, :update => { :color => 'red' } }).filters[:color].value
+      end
+    end
+  end
+
+  context "When modifying a FilterSet that started as an array" do
+    setup do
+      @set = Refinuri::Base::FilterSet.new({:name=>["apple"]})
+    end
+    
+    context "and running UPDATE actions on the original filter" do
+    
+      should "allow implicit additions as a string" do
+        assert_equal ["apple","banana"], @set.merge!({ :name => 'banana' }).filters[:name].value
+      end
+    
+      should "allow implicit additions as an array" do
+        assert_equal ["apple","banana"], @set.merge!({ :name => ['banana'] }).filters[:name].value
+        assert_equal ["apple","banana","cherry"], @set.merge!({ :name => ['banana','cherry'] }).filters[:name].value
+      end
+    
+      should "allow explicit additions as a string" do
+        assert_equal ["apple","banana"], @set.merge!({ :update => { :name => 'banana' } }).filters[:name].value
+      end
+    
+      should "allow explicit additions as an array" do
+        assert_equal ["apple","banana"], @set.merge!({ :update => { :name => ['banana'] } }).filters[:name].value
+        assert_equal ["apple","banana","cherry"], @set.merge!({ :update => { :name => ['banana','cherry'] } }).filters[:name].value
+      end
+    end
+    
+    context "and running CREATE actions on the original filter" do
+      should "replace the original filter" do
+        assert_equal ["banana"], @set.merge!({ :create => { :name => 'banana' } }).filters[:name].value
+        assert_equal ["banana"], @set.merge!({ :create => { :name => ['banana'] } }).filters[:name].value
+        assert_equal ["banana",'cherry'], @set.merge!({ :create => { :name => ['banana','cherry'] } }).filters[:name].value
+      end
+    end
+
+    context "and running UPDATE actions on a new filter" do
+      should "default to CREATE for the new filter and be able to return the original filter and the new filter" do
+        assert_equal ["apple"], @set.merge!({ :update => { :color => 'red' } }).filters[:name].value
+        assert_equal ["red"], @set.merge!({ :update => { :color => 'red' } }).filters[:color].value
+        assert_equal ["red"], @set.merge!({ :update => { :color => ['red'] } }).filters[:color].value
+        assert_equal ["red",'yellow'], @set.merge!({ :update => { :color => ['red','yellow'] } }).filters[:color].value
+      end
+    end
+
+    context "and running UPDATE actions on a new filter and the original filter" do
+      should "default to CREATE for the new filter and be able to return the UPDATEd filter and the new filter" do
+        assert_equal ["apple","banana"], @set.merge!({ :update => { :color => 'red', :name => 'banana' } }).filters[:name].value
+        assert_equal ["red"], @set.merge!({ :update => { :color => 'red', :name => 'banana' } }).filters[:color].value
+      end
+    end
+    
+    context "and running CREATE actions on the original filter and a new filter" do
+      should "replace the original filter" do
+        assert_equal ["banana"], @set.merge!({ :create => { :name => 'banana', :color => ['red'] } }).filters[:name].value
+        assert_equal ["red"], @set.merge!({ :create => { :name => 'banana', :color => ['red'] } }).filters[:color].value
+      end
+    end
+
+    context "and running simultaneous explicit CREATE and UPDATE actions" do
+      should "be able to update the original filter and create a new one" do
+        assert_equal ['apple',"banana"], @set.merge!({ :update => { :name => 'banana' }, :create => { :color => 'red' } }).filters[:name].value
+        assert_equal ['red'], @set.merge!({ :update => { :name => 'banana' }, :create => { :color => 'red' } }).filters[:color].value
+      end
+      
+      should "be able to replace the original filter and UPDATE (default to create) a new one" do
+        assert_equal ['banana'], @set.merge!({ :create => { :name => 'banana' }, :update => { :color => 'red' } }).filters[:name].value
+        assert_equal ['red'], @set.merge!({ :create => { :name => 'banana' }, :update => { :color => 'red' } }).filters[:color].value
+      end
+    end
+  end
+
+  context "When DELETEing items from an Array filter" do
+    setup do
+      @set = Refinuri::Base::FilterSet.new({:name=>["apple","banana","cherry"]})
+    end
+    
+    should "remove only the item given, when only one item is given" do
+      assert_equal ['banana','cherry'], @set.merge!(:delete => { :name => 'apple' }).filters[:name].value
+      assert_equal ['banana','cherry'], @set.merge!(:delete => { :name => ['apple'] }).filters[:name].value
+    end
+    
+    should "remove only the items given, when only multiple items are given" do
+      assert_equal ['cherry'], @set.merge!(:delete => { :name => ['apple','banana'] }).filters[:name].value
+    end
+    
+    should "purge the filter entirely when there are no items left" do
+      assert_equal ['banana','cherry'], @set.merge!(:delete => { :name => ['apple'] }).filters[:name].value
+      assert_equal ['cherry'], @set.merge!(:delete => { :name => ['apple','banana'] }).filters[:name].value
+      assert_nil @set.merge!(:delete => { :name => ['apple','banana','cherry'] }).filters[:name]
+    end
+  end
+end

data/test/test_helpers.rb

@@ -0,0 +1,13 @@
+require 'helper'
+
+class TestHelpers < Test::Unit::TestCase
+  context "The filter_with_link help" do
+    setup do
+      params = { :controller => 'items', :action => 'index', :id => 1, :filters => "name:apple,banana,cherry;price:0-1;weight:4+;spots:-4" }
+    end
+    
+    # should "return like a normal link_to " do
+    #   assert true
+    # end
+  end
+end

data/test/test_parser.rb

@@ -0,0 +1,39 @@
+require 'helper'
+
+class TestParser < Test::Unit::TestCase
+  context "The URL :filters parser" do
+    setup do
+      @filter_string = "name:apple,banana,cherry;price:0-1;weight:4+;spots:4-"
+      @filter_string_with_single_value = "name:apple"
+    end
+    
+    should "parse the names as an array" do
+      assert_equal ['apple','banana','cherry'], Refinuri::Parser.parse_url(@filter_string).filters[:name].value
+      assert_equal ['apple'], Refinuri::Parser.parse_url(@filter_string_with_single_value).filters[:name].value
+    end
+    
+    should "parse the price as a range" do
+      assert_equal 0..1, Refinuri::Parser.parse_url(@filter_string).filters[:price].value
+      assert_kind_of Range, Refinuri::Parser.parse_url(@filter_string).filters[:price].value
+    end
+    
+    should "parse the weight as a string" do
+      assert_equal '4..', Refinuri::Parser.parse_url(@filter_string).filters[:weight].value
+    end
+    
+    should "parse the spots as a string" do
+      assert_equal '..4', Refinuri::Parser.parse_url(@filter_string).filters[:spots].value
+    end
+  end
+
+  context "The object parser" do
+    setup do
+      @set = Refinuri::Base::FilterSet.new({ :name => ['apple','banana', 'cherry'], :price => 0..1, :weight => '4..' })
+    end
+    
+    should "return a nicely formed URL string" do
+      # TODO this needs to get tested based on inclusion, not an exact string match
+      # assert_equal 'price:0-1;name:apple,banana,cherry;weight:4+', @set.to_url
+    end
+  end
+end

data/test/test_range_filters.rb

@@ -0,0 +1,36 @@
+require 'helper'
+
+class TestRangeFilters < Test::Unit::TestCase
+  context "When modifying a Range" do
+    setup do
+      @set = Refinuri::Base::FilterSet.new({:price=>0..1})
+    end
+    
+    should "update the value with an implicit update" do
+      assert_equal 1..2, @set.merge!({ :price => 1..2 }).filters[:price].value
+    end
+    
+    should "update the value with an explicit update" do
+      assert_equal 1..2, @set.merge!({ :update => { :price => 1..2 } }).filters[:price].value
+    end
+    
+    should "replace the value with an explicit create" do
+      assert_equal 1..2, @set.merge!({ :create => { :price => 1..2 } }).filters[:price].value
+    end
+    
+    should "purge the filter when deleted" do
+      assert_nil @set.merge!({ :delete => { :price => 1..2 } }).filters[:price]
+      assert_nil @set.merge!({ :delete => { :price => nil } }).filters[:price]
+    end
+  end
+  
+  context "When outputting values for use in ActiveRecord queries" do
+    setup do
+      @range = Refinuri::Base::FilterSet.new({:price=>10..20})
+    end
+    
+    should "output a hash suitable for #where" do
+      assert_equal({ :price => 10..20 }, @range[:price].to_db)
+    end
+  end
+end

data/test/test_refinuri.rb

@@ -0,0 +1,52 @@
+require 'helper'
+
+class TestRefinuri < Test::Unit::TestCase
+  context "The FilterSet class" do
+    should "raise an error if it's initialized with anything but a Hash" do
+			assert_raise ArgumentError do
+				Refinuri::Base::FilterSet.new(String.new)
+			end
+    end
+
+    should "initialize if it's given a basic hash" do
+      assert Refinuri::Base::FilterSet.new({:key => 'value'})
+    end
+    
+    context "when given an Array or a non-special String" do
+      should "be able to regurgitate the array as the filter value" do
+        assert_equal ['value'], Refinuri::Base::FilterSet.new({:key => ['value']}).filters[:key].value
+      end
+      
+      should "return an array even when the input is a string" do
+        assert_equal ['value'], Refinuri::Base::FilterSet.new({:key => 'value'}).filters[:key].value
+      end
+    end
+
+    context "when given a Range" do
+      should "return a Range as the filter value" do
+        assert_kind_of Range, Refinuri::Base::FilterSet.new({:key => 0..1}).filters[:key].value
+        assert_kind_of Range, Refinuri::Base::FilterSet.new({:key => 0...1}).filters[:key].value
+      end
+    end
+
+    context "when asked for standard output" do
+      setup do
+        @hsh = {:name => ['apple','banana'], :price => 0..1, :weight => '4..'}
+        @set = Refinuri::Base::FilterSet.new(@hsh)
+      end
+      
+      should "return a normal looking Hash" do
+        assert_equal @hsh, @set.to_h
+      end
+      
+      should "return the values of individual filters upon request" do
+        assert_equal ['apple','banana'], @set[:name].value
+        assert_equal 0..1, @set[:price].value
+      end
+      
+      should "return nil if the request filter doesn't exist" do
+        assert_nil @set[:nofilter]
+      end
+    end
+  end
+end

data/test/test_unbounded_range_filters.rb

@@ -0,0 +1,15 @@
+require 'helper'
+
+class TestUnboundedRangeFilters < Test::Unit::TestCase
+  context "When outputting values for use in ActiveRecord queries" do
+    setup do
+      @lower = Refinuri::Base::FilterSet.new({:price=>'10..'})
+      @upper = Refinuri::Base::FilterSet.new({:price=>'..10'})
+    end
+    
+    should "output a string suitable for #where" do
+      assert_equal "price >= 10", @lower[:price].to_db
+      assert_equal "price <= 10", @upper[:price].to_db
+    end
+  end
+end

data/test/test_utilties.rb

@@ -0,0 +1,52 @@
+require 'helper'
+
+class TestUtilities < Test::Unit::TestCase
+  context "The Refinuri utilities" do
+    context "when dealing with Ranges or Range-like strings" do
+      should "transcode from a legit Range to a string with a hyphen" do
+        assert_equal "0-1", Refinuri::Utilities.transcode_range(0..1)
+        assert_equal "10.5-20.5", Refinuri::Utilities.transcode_range(10.5..20.5)
+      end
+      
+      should "transcode from a string with a hyphen to a legit Range" do
+        assert_equal 0..1, Refinuri::Utilities.transcode_range('0-1')
+        assert_equal 10.5..20.5, Refinuri::Utilities.transcode_range('10.5-20.5')
+      end
+    end
+
+    context "when dealing with an UnboundedRange-like string" do
+      context "with a lower bound" do
+        should "transcode from X.. notation to URL-friendly X+ notation" do
+          assert_equal '1+', Refinuri::Utilities.transcode_unbounded_range('1..')
+          assert_equal '-1+', Refinuri::Utilities.transcode_unbounded_range('-1..')
+          assert_equal '1.0+', Refinuri::Utilities.transcode_unbounded_range('1.0..')
+          assert_equal '-1.0+', Refinuri::Utilities.transcode_unbounded_range('-1.0..')
+          # TODO check if a decimal point can/should be URL encoded
+        end
+        
+        should "transcode from X+ notation to X.. notation" do
+          assert_equal '1..', Refinuri::Utilities.transcode_unbounded_range('1+')
+          assert_equal '1.0..', Refinuri::Utilities.transcode_unbounded_range('1.0+')
+          assert_equal '-1..', Refinuri::Utilities.transcode_unbounded_range('-1+')
+          assert_equal '-1.0..', Refinuri::Utilities.transcode_unbounded_range('-1.0+')
+        end
+      end
+      
+      context "with an upper bound" do
+        should "transcode from ..X notation to URL-friendly X- notation" do
+          assert_equal '1-', Refinuri::Utilities.transcode_unbounded_range('..1')
+          assert_equal '1.0-', Refinuri::Utilities.transcode_unbounded_range('..1.0')
+          assert_equal '-1-', Refinuri::Utilities.transcode_unbounded_range('..-1')
+          assert_equal '-1.0-', Refinuri::Utilities.transcode_unbounded_range('..-1.0')
+        end
+        
+        should "transcode from X- notation to ..X notation" do
+          assert_equal '..1', Refinuri::Utilities.transcode_unbounded_range('1-')
+          assert_equal '..1.0', Refinuri::Utilities.transcode_unbounded_range('1.0-')
+          assert_equal '..-1', Refinuri::Utilities.transcode_unbounded_range('-1-')
+          assert_equal '..-1.0', Refinuri::Utilities.transcode_unbounded_range('-1.0-')
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: refinuri
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Chris Kalafarski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-07 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Helps clean up complex URLs with filtering query string, like you may find in an online store
+email: chris@farski.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/refinuri.rb
+- lib/refinuri/base.rb
+- lib/refinuri/filters.rb
+- lib/refinuri/helpers.rb
+- lib/refinuri/parser.rb
+- lib/refinuri/query.rb
+- lib/refinuri/utilities.rb
+- refinuri.gemspec
+- test/helper.rb
+- test/test_array_filters.rb
+- test/test_helpers.rb
+- test/test_parser.rb
+- test/test_range_filters.rb
+- test/test_refinuri.rb
+- test/test_unbounded_range_filters.rb
+- test/test_utilties.rb
+has_rdoc: true
+homepage: http://github.com/farski/refinuri
+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: Helps clean up complex URLs with filtering query string, like you may find in an online store
+test_files: 
+- test/helper.rb
+- test/test_array_filters.rb
+- test/test_helpers.rb
+- test/test_parser.rb
+- test/test_range_filters.rb
+- test/test_refinuri.rb
+- test/test_unbounded_range_filters.rb
+- test/test_utilties.rb