protobuf-activerecord 1.1.0 → 1.1.1

data/Gemfile

@@ -1,4 +1,3 @@
-source 'http://gems.moneydesktop.com'
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in protobuf-activerecord.gemspec

data/README.md

@@ -102,11 +102,11 @@ end
 
 Once the desired protobuf message has been specified, Protoable adds a `to_proto` method to the model. Calling `to_proto` will automatically convert the model to the specified protobuf message using the same attribute to field mapping it uses to create and update objects from protobuf messages.
 
-### Field & column converters
+### Field & attribute converters
 
-Protoable will handle regular field conversions out of the box, but for those times when custom conversions are needed, they can be defined with the `convert_field` and `convert_column` methods. Field converters are used when creating or updating objects from a protobuf message and column converters are used when serializing objects to protobuf messages.
+Protoable will handle regular field conversions out of the box, but for those times when custom conversions are needed, they can be defined with the `convert_field` and `protoable_attribute` methods. Field converters are used when creating or updating objects from a protobuf message and attribute converters are used when serializing objects to protobuf messages.
 
-`convert_field` and `convert_column` both take the name of the field/column being converted and a method name or callable (lambda or proc). when converting that field, calls the given callable, passing it the value of the field being converted.
+`convert_field` and `protoable_attribute` both take the name of the field/attribute being converted and a method name or callable (lambda or proc). when converting that field, calls the given callable, passing it the value of the field being converted.
 
 **Converting fields**
 
@@ -123,21 +123,21 @@ class User < ActiveRecord::Base
 end
 ```
 
-**Converting columns**
+**Converting attributes**
 
 ```Ruby
 class User < ActiveRecord::Base
   include Protoable
 
   # Calls the lambda when serializing objects to protobuf messages, passing it
-  # the value of the status column from the database.
-  convert_column :status, lambda { |column_value| column_value_.to_s }
+  # the value of the status attribute.
+  protoable_attribute :status, lambda { |attribute_value| attribute_value_.to_s }
 end
 ```
 
-### Column transformers
+### Attribute transformers
 
-Protoable handles mapping protobuf message fields to object attributes, but what happens when an attribute doesn't have a matching field? Using the `transform_column` method, you can define custom column transformations. Simply call `transform_column`, passing it the name of the column and a method name or callable (lambda or proc). When creating or updating objects, Protoable will call the transformer, passing it the protobuf message.
+Protoable handles mapping protobuf message fields to object attributes, but what happens when an attribute doesn't have a matching field? Using the `attribute_from_proto` method, you can define custom attribute transformations. Simply call `attribute_from_prot`, passing it the name of the attribute and a method name or callable (lambda or proc). When creating or updating objects, Protoable will call the transformer, passing it the protobuf message.
 
 ```Ruby
 class User < ActiveRecord::Base
@@ -145,9 +145,54 @@ class User < ActiveRecord::Base
 
   # Calls the lambda when creating/updating objects, passing it the protobuf
   # message.
-  transform_column :account_id, lambda { |protobuf_message| # Some custom transformation... }
+  attribute_from_proto :account_id, lambda { |protobuf_message| # Some custom transformation... }
 end
 ```
+#### Searching
+
+Protoable's `search_scope` method takes the protobuf message and builds ARel scopes from it.
+
+Before you can use `search_scope`, you'll need to tell Protoable which fields should be searchable and what scope should be used to search with that field.
+
+Consider this protobuf message:
+
+```
+message UserSearchRequest {
+  repeated string guid = 1;
+  repeated string name = 2;
+  repeated string email = 3;
+}
+```
+
+To make the `name` field searchable, use the `field_scope` method:
+
+```Ruby
+class User < ActiveRecord::Base
+  include Protoable
+
+  scope :by_name, lambda { |*values| where(:name => values) }
+
+  field_scope :name, :by_name
+end
+```
+
+This tells Protoable that the name field should be searchable and that the scope with the given name should be used to build the search scope.
+
+Now that your class is configured with some searchable fields, you can use the `search_scope` method to build ARel scopes from a protobuf message.
+
+`search_scope` is chainable just like regular ARel scopes. It takes a protobuf messages and will build search scopes from any searchable fields that have values.
+
+Picking up our User class again:
+
+```Ruby
+# Build a search scope from the given protobuf message
+User.search_scope(request)
+
+# It's chainable too
+User.limit(10).search_scope(request)
+```
+
+Protoable also provides some aliases for the `search_scope` method in the event that you'd like something a little more descriptive. `by_fields`, `from_proto`, and `scope_from_proto` are all aliases of `search_scope`.
 
 ## Contributing
 

data/lib/protobuf-activerecord.rb

@@ -1,5 +1,5 @@
-require 'protobuf_ext/message'
-
-require 'protoable'
-
+require 'heredity'
+require 'protobuf'
 require 'protobuf/activerecord/version'
+require 'protobuf/activerecord/protobuf_ext/message'
+require 'protobuf/activerecord/protoable'

data/lib/protobuf/activerecord/protoable.rb

@@ -0,0 +1,17 @@
+require 'protobuf/activerecord/protoable/convert'
+require 'protobuf/activerecord/protoable/errors'
+require 'protobuf/activerecord/protoable/fields'
+require 'protobuf/activerecord/protoable/persistence'
+require 'protobuf/activerecord/protoable/scope'
+require 'protobuf/activerecord/protoable/serialization'
+
+module Protoable
+  def self.included(klass)
+    klass.extend Protoable::Fields
+    klass.extend Protoable::Scope
+
+    klass.__send__(:include, Protoable::Convert)
+    klass.__send__(:include, Protoable::Persistence)
+    klass.__send__(:include, Protoable::Serialization)
+  end
+end

data/lib/protobuf/activerecord/protobuf_ext/message.rb

@@ -0,0 +1,16 @@
+require 'protobuf'
+
+class Protobuf::Message
+  unless method_defined?(:respond_to_and_has?)
+    def respond_to_and_has?(key)
+      self.respond_to?(key) && self.has_field?(key)
+    end
+  end
+
+  unless method_defined?(:respond_to_and_has_and_present?)
+    def respond_to_and_has_and_present?(key)
+      self.respond_to_and_has?(key) &&
+        (self.__send__(key).present? || [true, false].include?(self.__send__(key)))
+    end
+  end
+end

data/lib/protobuf/activerecord/version.rb

@@ -1,5 +1,5 @@
 module Protobuf
   module ActiveRecord
-    VERSION = "1.1.0"
+    VERSION = "1.1.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protobuf-activerecord
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-10 00:00:00.000000000 Z
+date: 2012-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -202,16 +202,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/protoable.rb
-- lib/protoable/convert.rb
-- lib/protoable/errors.rb
-- lib/protoable/fields.rb
-- lib/protoable/persistence.rb
-- lib/protoable/scope.rb
-- lib/protoable/serialization.rb
 - lib/protobuf-activerecord.rb
+- lib/protobuf/activerecord/protoable.rb
+- lib/protobuf/activerecord/protoable/convert.rb
+- lib/protobuf/activerecord/protoable/errors.rb
+- lib/protobuf/activerecord/protoable/fields.rb
+- lib/protobuf/activerecord/protoable/persistence.rb
+- lib/protobuf/activerecord/protoable/scope.rb
+- lib/protobuf/activerecord/protoable/serialization.rb
+- lib/protobuf/activerecord/protobuf_ext/message.rb
 - lib/protobuf/activerecord/version.rb
-- lib/protobuf_ext/message.rb
 - protobuf-activerecord.gemspec
 - spec/protoable/convert_spec.rb
 - spec/protoable/fields_spec.rb
@@ -240,7 +240,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -185204863767589185
+      hash: 471675617945359118
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -249,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -185204863767589185
+      hash: 471675617945359118
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24

data/lib/protoable.rb

@@ -1,17 +0,0 @@
-require 'protoable/convert'
-require 'protoable/errors'
-require 'protoable/fields'
-require 'protoable/persistence'
-require 'protoable/scope'
-require 'protoable/serialization'
-
-module Protoable
-  def self.included(klass)
-    klass.extend Protoable::Fields
-    klass.extend Protoable::Scope
-
-    klass.__send__(:include, Protoable::Convert)
-    klass.__send__(:include, Protoable::Persistence)
-    klass.__send__(:include, Protoable::Serialization)
-  end
-end

data/lib/protobuf_ext/message.rb

@@ -1,12 +0,0 @@
-require 'protobuf'
-
-class Protobuf::Message
-  def respond_to_and_has?(key)
-    self.respond_to?(key) && self.has_field?(key)
-  end
-
-  def respond_to_and_has_and_present?(key)
-    self.respond_to_and_has?(key) &&
-      (self.__send__(key).present? || [true, false].include?(self.__send__(key)))
-  end
-end