muster 0.0.1

data/spec/muster/strategies/filter_expression_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+
+describe Muster::Strategies::FilterExpression do
+  let(:options) { {} }
+  subject { Muster::Strategies::FilterExpression.new(options) }
+
+  describe '#parse' do
+
+    context 'by default' do
+      it 'returns empty hash for empty query string' do
+        subject.parse('').should == {}
+      end
+
+      it 'returns hash of all key/value pairs' do
+        subject.parse('where=id:1&filter=name:foop').should == { 'where' => {'id' => '1'}, 'filter' => {'name' => 'foop'} }
+      end
+
+      it 'hash supports indifferent key access' do
+        hash = subject.parse('where=id:1')
+        hash[:where][:id].should eq '1'
+        hash['where']['id'].should eq '1'
+      end
+
+      it 'combines multiple expressions into an array' do
+        subject.parse('where=id:1&where=id:2').should == { 'where' => {'id' => ['1', '2']} }
+      end
+
+      it 'support for multiple values using |' do
+        subject.parse('where=id:1|2&where=id:3').should == { 'where' => {'id' => ['1', '2', '3']} }
+      end
+
+      it 'support for multiple expressions using ,' do
+        subject.parse('where=id:1,id:2,id:3').should == { 'where' => {'id' => ['1', '2', '3']} }
+      end
+
+      it 'discards non unique values' do
+        subject.parse('where=id:1&where=id:2&where=id:1').should == { 'where' => {'id' => ['1', '2']} }
+      end
+    end
+
+    context 'with :value_separator option' do
+      context 'as regex' do
+        before do
+          options[:expression_separator] = '|'
+          options[:value_separator] = /,\s*/
+        end
+
+        it 'converts comma separated value into Array' do
+          subject.parse('where=id:1,2').should == { 'where' => {'id' => ['1', '2']} }
+        end
+
+        it 'ignores spaces after commas' do
+          subject.parse('where=id:1,+2,%20   3').should == { 'where' => {'id' => ['1', '2', '3']} }
+        end
+      end
+
+      context 'as string' do
+        before do
+          options[:expression_separator] = '|'
+          options[:value_separator] = ','
+        end
+
+        it 'converts comma separated value into Array' do
+          subject.parse('where=id:1,2,3').should == { 'where' => {'id' => ['1', '2', '3']} }
+        end
+      end
+    end
+
+    context 'with :field_separator option' do
+      context 'as regex' do
+        before { options[:field_separator] = /\s*!\s*/ }
+
+        it 'splits field from values' do
+          subject.parse('where=id!1').should == { 'where' => {'id' => '1'} }
+        end
+
+        it 'ignores spaces after field' do
+          subject.parse('where=id ! 1').should == { 'where' => {'id' => '1'} }
+        end
+      end
+
+      context 'as string' do
+        before { options[:field_separator] = '!' }
+
+        it 'converts comma separated value into Array' do
+          subject.parse('where=id!1').should == { 'where' => {'id' => '1'} }
+        end
+      end
+    end
+
+    context 'with :fields option' do
+      context 'as symbol' do
+        before { options[:field] = :where }
+
+        it 'fields returns expressions for the key specified' do
+          subject.parse('where=id:1&filters=id:2').should == { 'where' => {'id' => '1'} }
+        end
+      end
+
+      context 'as Array of symbols' do
+        before { options[:fields] = [:where, :filter] }
+
+        it 'fields returns expressions for the keys specified' do
+          subject.parse('where=id:1&filter=id:2&attribute=id:3').should == { 'where' => {'id' => '1'}, 'filter' => {'id' => '2'} }
+        end
+      end
+
+      context 'as string' do
+        before { options[:field] = 'where' }
+
+        it 'fields returns expressions for the key specified' do
+          subject.parse('where=id:1&filter=id:2').should == { 'where' => {'id' => '1'} }
+        end
+      end
+
+      context 'as Array of strings' do
+        before { options[:fields] = ['where', 'filter'] }
+
+        it 'fields returns expressions for the keys specified' do
+          subject.parse('where=id:1&filter=id:2&attribute=id:3').should == { 'where' => {'id' => '1'}, 'filter' => {'id' => '2'} }
+        end
+      end
+    end
+
+  end
+end

data/spec/muster/strategies/hash_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe Muster::Strategies::Hash do
+  let(:options) { {} }
+  subject { Muster::Strategies::Hash.new(options) }
+
+  describe '#parse' do
+
+    context 'by default' do
+      it 'returns empty hash for empty query string' do
+        subject.parse('').should == {}
+      end
+
+      it 'returns hash of all key/value pairs' do
+        subject.parse('a=1&b=2').should == {'a' => '1', 'b' => '2'}
+      end
+
+      it 'hash supports indifferent key access' do
+        hash = subject.parse('a=1')
+        hash[:a].should eq '1'
+        hash['a'].should eq '1'
+      end
+
+      it 'combines multiple key values into an array' do
+        subject.parse('a=1&a=2').should == {'a' => ['1', '2']}
+      end
+
+      it 'discards non unique values' do
+        subject.parse('a=1&a=2&a=1').should == {'a' => ['1', '2']}
+      end
+    end
+
+    context 'with :value_separator option' do
+      context 'as regex' do
+        before { options[:value_separator] = /,\s*/ }
+
+        it 'converts comma separated value into Array' do
+          subject.parse('a=1,2&a=3').should == {'a' => ['1', '2', '3']}
+        end
+
+        it 'ignores spaces after commas' do
+          subject.parse('a=1,+2,%20   3').should == {'a' => ['1', '2', '3']}
+        end
+      end
+
+      context 'as string' do
+        before { options[:value_separator] = '|' }
+
+        it 'converts comma separated value into Array' do
+          subject.parse('a=1|2|3').should == {'a' => ['1', '2', '3']}
+        end
+      end
+    end
+
+    context 'with :fields option' do
+      context 'as symbol' do
+        before { options[:field] = :a }
+
+        it 'fields returns values for the key specified' do
+          subject.parse('a=1&b=2').should == {'a' => '1'}
+        end
+      end
+
+      context 'as Array of symbols' do
+        before { options[:fields] = [:a, :b] }
+
+        it 'fields returns values for the keys specified' do
+          subject.parse('a=1&b=2&c=3').should == {'a' => '1', 'b' => '2'}
+        end
+      end
+
+      context 'as string' do
+        before { options[:field] = 'a' }
+
+        it 'fields returns values for the key specified' do
+          subject.parse('a=1&b=2').should == {'a' => '1'}
+        end
+      end
+
+      context 'as Array of strings' do
+        before { options[:fields] = ['a', 'b'] }
+
+        it 'fields returns values for the keys specified' do
+          subject.parse('a=1&b=2&c=3').should == {'a' => '1', 'b' => '2'}
+        end
+      end
+    end
+
+  end
+end

data/spec/muster/strategies/pagination_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe Muster::Strategies::Pagination do
+  let(:options) { {} }
+  subject { Muster::Strategies::Pagination.new(options) }
+
+  describe '#parse' do
+    context 'by default' do
+      it 'returns default hash for empty query string' do
+        subject.parse('').should == {'pagination' => {'page' => 1, 'per_page' => 30}, 'offset' => nil, 'limit' => 30}
+      end
+
+      it 'ensures page is positive integer' do
+        subject.parse('page=foop')[:pagination].should == {'page' => 1, 'per_page' => 30}
+      end
+
+      it 'ensures per_page is positive integer' do
+        subject.parse('per_page=foop')[:pagination].should == {'page' => 1, 'per_page' => 30}
+      end
+
+      it 'accepts page_size instead of per_page' do
+        subject.parse('page_size=10')[:pagination].should == {'page' => 1, 'per_page' => 10}
+      end
+
+      it 'calculates offset from pagination' do
+        subject.parse('page=1&per_page=5')[:offset].should eq nil
+        subject.parse('page=2&per_page=5')[:offset].should eq 5
+        subject.parse('page=3&per_page=5')[:offset].should eq 10
+      end
+    end
+
+    context 'with :default_page_size option' do
+      before { options[:default_page_size] = 5 }
+
+      it 'uses default page size instead of 30' do
+        subject.parse('')[:limit].should eq 5
+      end
+    end
+
+    context 'with :fields option' do
+      context 'as symbol' do
+        before { options[:field] = :limit }
+
+        it 'fields returns values for the key specified' do
+          subject.parse('per_page=10').should == {'limit' => 10}
+        end
+      end
+
+      context 'as Array of symbols' do
+        before { options[:fields] = [:limit, :offset] }
+
+        it 'fields returns values for the keys specified' do
+          subject.parse('per_page=10&page=2').should == {'limit' => 10, 'offset' => 10}
+        end
+      end
+
+      context 'as string' do
+        before { options[:field] = 'limit' }
+
+        it 'fields returns values for the key specified' do
+          subject.parse('per_page=10').should == {'limit' => 10}
+        end
+      end
+
+      context 'as Array of strings' do
+        before { options[:fields] = ['limit', 'offset'] }
+
+        it 'fields returns values for the keys specified' do
+          subject.parse('per_page=10&page=2').should == {'limit' => 10, 'offset' => 10}
+        end
+      end
+    end
+  end
+end

data/spec/muster/strategies/sort_expression_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe Muster::Strategies::SortExpression do
+  let(:options) { {} }
+  subject { Muster::Strategies::SortExpression.new(options) }
+
+  describe '#parse' do
+
+    context 'by default' do
+      it 'returns empty hash for empty query string' do
+        subject.parse('').should == {}
+      end
+
+      it 'returns hash of all key/value pairs' do
+        subject.parse('sort=id&order=name').should == { 'sort' => 'id asc', 'order' => 'name asc' }
+      end
+
+      it 'hash supports indifferent key access' do
+        hash = subject.parse('sort=name')
+        hash[:sort].should eq 'name asc'
+        hash['sort'].should eq 'name asc'
+      end
+
+      it 'combines multiple expressions into an array' do
+        subject.parse('sort=id&sort=name').should == { 'sort' => ['id asc', 'name asc'] }
+      end
+
+      it 'supports comma separated expressions with directions' do
+        subject.parse('sort=id:asc,name:desc').should == { 'sort' => ['id asc', 'name desc'] }
+      end
+
+      it 'supports comma separated expressions without directions' do
+        subject.parse('sort=id,name').should == { 'sort' => ['id asc', 'name asc'] }
+      end
+      
+      it 'discards non unique values' do
+        subject.parse('sort=id&sort=name&sort=id').should == { 'sort' => ['id asc', 'name asc'] }
+      end
+    end
+
+    context 'with direction' do
+      it 'supports asc' do
+        subject.parse('sort=id:asc').should == { 'sort' => 'id asc' }
+      end
+
+      it 'supports desc' do
+        subject.parse('sort=id:desc').should == { 'sort' => 'id desc' }
+      end
+
+      it 'supports ascending' do
+        subject.parse('sort=id:ascending').should == { 'sort' => 'id asc' }
+      end
+
+      it 'supports desc' do
+        subject.parse('sort=id:descending').should == { 'sort' => 'id desc' }
+      end
+    end
+
+    context 'with :fields option' do
+      context 'as symbol' do
+        before { options[:field] = :sort }
+
+        it 'fields returns expressions for the key specified' do
+          subject.parse('sort=id&order=name').should == { 'sort' => 'id asc' }
+        end
+      end
+
+      context 'as Array of symbols' do
+        before { options[:fields] = [:sort, :order] }
+
+        it 'fields returns expressions for the keys specified' do
+          subject.parse('sort=id&order=name&direction=place').should == { 'sort' => 'id asc', 'order' => 'name asc' }
+        end
+      end
+
+      context 'as string' do
+        before { options[:field] = 'sort' }
+
+        it 'fields returns expressions for the key specified' do
+          subject.parse('sort=id&order=name').should == { 'sort' => 'id asc' }
+        end
+      end
+
+      context 'as Array of strings' do
+        before { options[:fields] = ['sort', 'order'] }
+
+        it 'fields returns expressions for the keys specified' do
+          subject.parse('sort=id&order=name&direction=place').should == { 'sort' => 'id asc', 'order' => 'name asc' }
+        end
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rack/mock'
+require 'muster'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: muster
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Christopher H. Laco
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70300796875420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70300796875420
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70300796873700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70300796873700
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70300796873220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: *70300796873220
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &70300796872700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: *70300796872700
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70300796872220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: *70300796872220
+description: Muster is a gem that turns query string options in varying formats into
+  data structures suitable for use in AR scopes and queryies.
+email:
+- claco@chrislaco.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/muster.rb
+- lib/muster/rack.rb
+- lib/muster/strategies.rb
+- lib/muster/strategies/active_record.rb
+- lib/muster/strategies/filter_expression.rb
+- lib/muster/strategies/hash.rb
+- lib/muster/strategies/pagination.rb
+- lib/muster/strategies/rack.rb
+- lib/muster/strategies/sort_expression.rb
+- lib/muster/version.rb
+- muster.gemspec
+- spec/muster/rack_spec.rb
+- spec/muster/strategies/active_record_spec.rb
+- spec/muster/strategies/filter_expression_spec.rb
+- spec/muster/strategies/hash_spec.rb
+- spec/muster/strategies/pagination_spec.rb
+- spec/muster/strategies/sort_expression_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/claco/muster
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Muster various query string options into AR query compatable options.
+test_files:
+- spec/muster/rack_spec.rb
+- spec/muster/strategies/active_record_spec.rb
+- spec/muster/strategies/filter_expression_spec.rb
+- spec/muster/strategies/hash_spec.rb
+- spec/muster/strategies/pagination_spec.rb
+- spec/muster/strategies/sort_expression_spec.rb
+- spec/spec_helper.rb
+has_rdoc: