muster 0.0.4 → 0.0.5

data/README.md

@@ -12,6 +12,7 @@ easier consumption in things like AR/DataMapper scopes and queries, making API d
     query = env['muster.query']
 
     @people = Person.select( query[:select] ).order( query[:order] )
+    @people = Person.select( query.select ).order( query.order )
 
 ## Strategies
 

data/lib/muster/results.rb

@@ -7,6 +7,7 @@ module Muster
   # Query parsed results helper class
   #
   # As with most Muster classes, all hashes returned and options specified support with indifferent access.
+  # You can also access results using the dot notation for the key name.
   #
   # @param data [Hash] the hash of query string results after parsing to load
   #
@@ -17,6 +18,8 @@ module Muster
   #
   #   # Filter values one at a time
   #   results.data                                     #=> { 'select' => [:id, :name, :created_at] }
+  #   results[:select]                                 #=> [:id, :name, :created_at]
+  #   results.select                                   #=> [:id, :name, :created_at]
   #   results.filter(:select, :only => [:id, :name])   #=> [:id, :name]
   #   results.filter(:select, :except => :created_at)  #=> [:id, :name]
   #   results.filter(:page, 1)                         #=> 1
@@ -26,6 +29,8 @@ module Muster
   #   results.add_filter(:select, :only => [:id, :name])
   #   results.add_filter(:page, 1)
   #   results.filtered                                 #=> { 'select' => [:id, :name], 'page' => 1 }
+  #   results.filtered[:select]                        #=> [:id, :name]
+  #   results.filtered.select                          #=> [:id, :name]
   class Results < ActiveSupport::HashWithIndifferentAccess
 
     # @attribute [r] data
@@ -75,8 +80,8 @@ module Muster
     #
     # @example
     #
-    #   results.add_filter(:select, :only => [:id, :name]
-    #   results.add_filter(:select, :except => [:id]
+    #   results.add_filter(:select, :only => [:id, :name])
+    #   results.add_filter(:select, :except => [:id])
     #   results.add_filter(:page, 1)
     def add_filter( key, *options )
       self.filters[key] = options
@@ -90,7 +95,7 @@ module Muster
     #
     # @example
     #
-    #   results.add_filter(:select, :only => [:id, :name]
+    #   results.add_filter(:select, :only => [:id, :name])
     #   results.add_dilter(:page, 1)
     #   results.filtered   #=> { 'select' => [:id, :name], 'page' => 1 }
     def filtered
@@ -127,13 +132,13 @@ module Muster
     #
     # @example
     #
-    #   data = { :select => [:id, :name, :created_at]
+    #   data = { :select => [:id, :name, :created_at] }
     #   results = Muster::Results.new(data)
-    #   results.filter(:select)                           #=> [:id, :name, :created_at]
-    #   results.filter(:select, :only => :name)           #=> :name
-    #   results.filter(:select, :only => [:other, :name]  #=> [:name]
-    #   results.filter(:other, :default)                  #=> :default
-    #   results.filter(:other)                            #=> KeyError
+    #   results.filter(:select)                            #=> [:id, :name, :created_at]
+    #   results.filter(:select, :only => :name)            #=> :name
+    #   results.filter(:select, :only => [:other, :name])  #=> [:name]
+    #   results.filter(:other, :default)                   #=> :default
+    #   results.filter(:other)                             #=> KeyError
     def filter( key, *options )
       if options.present? && options.first.instance_of?(Hash)
         options = options.first.with_indifferent_access
@@ -150,6 +155,20 @@ module Muster
 
     private
 
+    def method_missing(meth, *args, &block)
+      if self.has_key?(meth)
+        value = self[meth]
+
+        if value.kind_of?(Hash)
+          value = OpenStruct.new(value)
+        end
+
+        return value
+      end
+
+      super
+    end
+
     def filter_excluded_values( key, excluded )
       value = self[key]
       excluded = Array.wrap(excluded)

data/lib/muster/version.rb

@@ -1,4 +1,4 @@
 module Muster
   # Current version of Muster
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/muster.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'activesupport', '~> 3.0'
   gem.add_dependency 'rack',          '~> 1.4'
 
+  gem.add_development_dependency 'pry'
   gem.add_development_dependency 'rspec',     '~> 2.11.0'
   gem.add_development_dependency 'redcarpet', '~> 2.1'
   gem.add_development_dependency 'simplecov'

data/spec/muster/results_spec.rb

@@ -84,4 +84,37 @@ describe Muster::Results do
       end
     end
   end
+
+  describe '#method_missing' do
+    context 'with matching key' do
+      it 'returns the value of the key index' do
+        results.name.should eq results[:name]
+        results.name.should eq [1, 2, 3]
+      end
+
+      it 'returns an OpenStruct for a hash' do
+        data[:pagination] = {:page => 1, :per_page => 10}
+
+        results.pagination.should be_an_instance_of(OpenStruct)
+        results.pagination.page.should eq 1
+        results.pagination.per_page.should eq 10
+      end
+    end
+
+    context 'without matching key' do
+      it 'returns NoMethodError' do
+        expect{ results.foop }.to raise_error(NoMethodError)
+      end
+    end
+
+    context 'with filtered results' do
+      it 'returns Results with method_missing support' do
+        data[:name] = [1, 2, 3]
+
+        results.add_filter(:name, :only => [1])
+        results.filtered.name.should eq [1]
+        results.filtered[:name].should eq [1]
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ if ENV['COVERAGE']
   SimpleCov.start
 end
 
+require 'pry'
 require 'rack/mock'
 require 'muster'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: muster
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-06 00:00:00.000000000 Z
+date: 2012-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70339120081800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70339120081800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70339120081080 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,31 @@ dependencies:
         version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70339120081080
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70339120080560 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +69,15 @@ dependencies:
         version: 2.11.0
   type: :development
   prerelease: false
-  version_requirements: *70339120080560
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70339120080100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +85,15 @@ dependencies:
         version: '2.1'
   type: :development
   prerelease: false
-  version_requirements: *70339120080100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70339120079660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +101,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70339120079660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70339120079120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +117,12 @@ dependencies:
         version: 0.8.2
   type: :development
   prerelease: false
-  version_requirements: *70339120079120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.2
 description: Muster is a gem that turns query strings of varying formats into data
   structures suitable for easier consumption in AR/DataMapper scopes and queries.
 email:
@@ -133,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.16
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Muster various query string formats into a more reusable data structure.