protobuf-activerecord 2.0.1 → 2.1.0.beta

data/lib/protobuf/activerecord/protoable/scope.rb

@@ -10,18 +10,47 @@ module Protoable
     end
 
     # Define fields that should be searchable via `search_scope`. Accepts a
-    # protobuf field and an already defined scope.
+    # protobuf field and an already defined scope. If no scope is specified,
+    # the scope will be the field name, prefixed with `by_` (e.g. when the
+    # field is :guid, the scope will be :by_guid).
+    #
+    # Optionally, a parser can be provided that will be called, passing the
+    # field value as an argument. This allows custom data parsers to be used
+    # so that they don't have to be handled by scopes. Parsers must respond
+    # to `call` and accept a single parameter.
     #
     # Examples:
     #
     #   class User < ActiveRecord::Base
     #     scope :by_guid, lambda { |*guids| where(:guid => guids) }
+    #     scope :custom_guid_scope, lambda { |*guids| where(:guid => guids) }
+    #
+    #     # Equivalent to `field_scope :guid, :by_guid`
+    #     field_scope :guid
+    #
+    #     # With a custom scope
+    #     field_scope :guid, :custom_guid_scope
     #
-    #     field_scope :guid, :by_guid
+    #     # With a custom parser that converts the value to an integer
+    #     field_scope :guid, :by_guid, lambda { |value| value.to_i }
     #   end
     #
-    def field_scope(field, scope_name)
+    def field_scope(field, scope_name = nil, parser = nil)
+      scope_name ||= :"by_#{field}"
       searchable_fields[field] = scope_name
+
+      # When no parser is defined, define one that simply returns the value
+      searchable_field_parsers[field] = parser || proc { |value| value }
+    end
+
+    # :noapi:
+    def parse_search_values(proto, field)
+      value = proto.__send__(field)
+      value = searchable_field_parsers[field].call(value)
+
+      values = [ value ].flatten
+      values.map!(&:to_i) if proto.get_field_by_name(field).enum?
+      values
     end
 
     # Builds and returns a Arel relation based on the fields that are present
@@ -45,10 +74,8 @@ module Protoable
           raise Protoable::SearchScopeError, "Undefined scope :#{scope_name}."
         end
 
-        values = [ proto.__send__(field) ].flatten
-        values.map!(&:to_i) if proto.get_field_by_name(field).enum?
-
-        relation = relation.__send__(scope_name, *values)
+        search_values = parse_search_values(proto, field)
+        relation = relation.__send__(scope_name, *search_values)
       end
 
       return relation
@@ -58,5 +85,10 @@ module Protoable
     def searchable_fields
       @_searchable_fields ||= {}
     end
+
+    # :noapi:
+    def searchable_field_parsers
+      @_searchable_field_parsers ||= {}
+    end
   end
 end

data/lib/protobuf/activerecord/version.rb

@@ -1,5 +1,5 @@
 module Protobuf
   module ActiveRecord
-    VERSION = "2.0.1"
+    VERSION = "2.1.0.beta"
   end
 end

data/spec/protoable/scope_spec.rb

@@ -4,6 +4,10 @@ describe Protoable::Scope do
   describe ".search_scope" do
     let(:request) { UserSearchMessage.new(:guid => ["foo"], :email => ["foo@test.co"]) }
 
+    before {
+      User.stub(:searchable_field_parsers).and_return({ :email => proc { |val| val } })
+    }
+
     it "builds scopes for searchable fields" do
       User.stub(:searchable_fields).and_return({ :email =>  :by_email })
       User.search_scope(request).should eq User.by_email("foo@test.co")

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: protobuf-activerecord
 version: !ruby/object:Gem::Version
-  version: 2.0.1
-  prerelease: 
+  version: 2.1.0.beta
+  prerelease: 6
 platform: ruby
 authors:
 - Adam Hutchison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-25 00:00:00.000000000 Z
+date: 2013-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -239,16 +239,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -468184549556839603
+      hash: 2337364999688507357
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -468184549556839603
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25