protobuf-activerecord 1.0.2 → 1.0.3

data/Gemfile

@@ -4,6 +4,10 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in protobuf-activerecord.gemspec
 gemspec
 
-gem 'builder', '~> 3.0.3'
+gem 'builder', '~> 3.0.4' # Builder 3.1.x is not supported by Active Record
+                          # and Bundler has trouble resolving the dependency
+                          # with Geminabox.
 
-gem 'timecop', '~> 0.3.5', :group => :development
+gem 'timecop', '~> 0.3.5', :group => :development # Timecop 0.4.x is has a bug
+                                                  # when dealing with timezones
+                                                  # on Time objects.

data/README.md

@@ -1,6 +1,6 @@
 # Protobuf ActiveRecord
 
-Protobuf Active Record provides the ability to create Active Record objects from Protocol Buffer messages and vice versa. It adds methods that allow you to create, update, and destroy Active Record objects from protobuf messages. It also provides methods to serialize Active Record objects to protobuf messages.
+Protobuf Active Record provides the ability to create and update Active Record objects from protobuf messages and to serialize Active Record objects to protobuf messages.
 
 ## Installation
 
@@ -21,14 +21,12 @@ Or install it yourself as:
 Protobuf Active Record's functionality is contained within the `Protoable` module. To endow your Active Record models with the protoable behaviour, simply include it into your model:
 
 ```Ruby
+class User < ActiveRecord::Base
+  include Protoable
 
-	class User < ActiveRecord::Base
-	  include Protoable
-
-	  # Your awesome methods...
-	  #
-	end
-
+  # Your awesome methods...
+  #
+end
 ```
 
 Now you can pass protobuf messages to your user model just like you would attributes. Protoable will take care of converting the protobuf message to attributes and continue on with Active Record's normal behavior.
@@ -40,29 +38,25 @@ Just like Active Record maps database columns to your model's attributes, Protoa
 Given a table that looks like this:
 
 ```Ruby
-
-	create_table :users do |t|
-	  t.string :first_name
-	  t.string :last_name
-	  t.string :email
-	  t.integer :account_id
-
-	  t.timestamps
-	end
-
+create_table :users do |t|
+  t.string :first_name
+  t.string :last_name
+  t.string :email
+  t.integer :account_id
+
+  t.timestamps
+end
 ```
 
 and a protobuf message that looks like this:
 
 ```Ruby
-
-	class UserMessage < ::Protobuf::Message
-	  optional ::Protobuf::Field::StringField, :first_name, 1
-	  optional ::Protobuf::Field::StringField, :last_name, 2
-	  optional ::Protobuf::Field::StringField, :email, 3
-	  optional ::Protobuf::Field::IntegerField, :account_id, 4
-	end
-
+class UserMessage < ::Protobuf::Message
+  optional ::Protobuf::Field::StringField, :first_name, 1
+  optional ::Protobuf::Field::StringField, :last_name, 2
+  optional ::Protobuf::Field::StringField, :email, 3
+  optional ::Protobuf::Field::IntegerField, :account_id, 4
+end
 ```
 
 Protoable will map the `first_name`, `last_name`, `email`, & `account_id` columns, skipping the timestamp columns. Repeated fields and fields that are nil will not be mapped.
@@ -74,42 +68,87 @@ Since Protocol Buffer messages don't support sending date, time, or datetime fie
 Picking up our users table example again, if you wanted to add a `created_at` field to your protobuf message, if you add it as an integer field, Protoable will handle the conversions for you:
 
 ```Ruby
-
-	class UserMessage < ::Protobuf::Message
-	  optional ::Protobuf::Field::StringField, :first_name, 1
-	  optional ::Protobuf::Field::StringField, :last_name, 2
-	  optional ::Protobuf::Field::StringField, :email, 3
-	  optional ::Protobuf::Field::IntegerField, :account_id, 4
-
-	  # Add a datetime field as an integer and Protoable will map it for you
-	  optional ::Protobuf::Field::IntegerField, :created_at, 5
-	end
-
+class UserMessage < ::Protobuf::Message
+  optional ::Protobuf::Field::StringField, :first_name, 1
+  optional ::Protobuf::Field::StringField, :last_name, 2
+  optional ::Protobuf::Field::StringField, :email, 3
+  optional ::Protobuf::Field::IntegerField, :account_id, 4
+
+  # Add a datetime field as an integer and Protoable will map it for you
+  optional ::Protobuf::Field::IntegerField, :created_at, 5
+end
 ```
 
 **Mass-assignment**
 
 If a model has protected attributes defined, Protoable will skip any fields that map to them. Likewise, if there are accessible attributes defined, only they will be mapped.
 
-### Persistence
+### Creating/Updating
 
 Protoable doesn't alter Active Record's normal persistence methods. It simply adds to ability to pass protobuf messages to them in place of an attributes hash.
 
-### Serialization
+### Serialization to protobuf
 
 In addition to mapping protobuf message fields to Active Record objects when creating or updating records, Protoable also provides the ability to serialize Active Record objects to protobuf messages. Simply tell Protoable the protobuf message that should be used and it will take care of the rest:
 
 ```Ruby
+class User < ActiveRecord::Base
+  include Protoable
 
-	class User < ActiveRecord::Base
-    # Configures Protoable to use the UserMessage class and adds a :to_proto method.
-	  protobuf_message :user_message
-	end
-
+  # Configures Protoable to use the UserMessage class and adds :to_proto.
+  protobuf_message :user_message
+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
+
+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.
+
+`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.
+
+**Converting fields**
+
+```Ruby
+class User < ActiveRecord::Base
+  include Protoable
+
+  # Calls :map_status_from_proto when creating/updating objects, passing it the
+  # value of the status field from the protobuf message.
+  def self.map_status_from_proto(field_value)
+    # Some custom mapping
+  end
+  convert_field :status, :map_status_from_proto
+end
+```
+
+**Converting columns**
+
+```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 }
+end
+```
+
+### Column 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.
+
+```Ruby
+class User < ActiveRecord::Base
+  include Protoable
+
+  # Calls the lambda when creating/updating objects, passing it the protobuf
+  # message.
+  transform_column :account_id, lambda { |protobuf_message| # Some custom transformation... }
+end
+```
+
 ## Contributing
 
 1. Fork it

data/lib/protoable/persistence.rb

@@ -53,14 +53,14 @@ module Protoable
 
       # :nodoc:
       def create(attributes, options = {}, &block)
-        attributes = attributes_from_proto(proto) if attributes.is_a?(::Protobuf::Message)
+        attributes = attributes_from_proto(attributes) if attributes.is_a?(::Protobuf::Message)
 
         super(attributes, options)
       end
 
       # :nodoc:
       def create!(attributes, options = {}, &block)
-        attributes = attributes_from_proto(proto) if attributes.is_a?(::Protobuf::Message)
+        attributes = attributes_from_proto(attributes) if attributes.is_a?(::Protobuf::Message)
 
         super(attributes, options)
       end
@@ -99,14 +99,14 @@ module Protoable
 
     # :nodoc:
     def update_attributes(attributes, options = {})
-      attributes = attributes_from_proto(proto) if attributes.is_a?(::Protobuf::Message)
+      attributes = attributes_from_proto(attributes) if attributes.is_a?(::Protobuf::Message)
 
       super(attributes, options)
     end
 
     # :nodoc:
     def update_attributes!(attributes, options = {})
-      attributes = attributes_from_proto(proto) if attributes.is_a?(::Protobuf::Message)
+      attributes = attributes_from_proto(attributes) if attributes.is_a?(::Protobuf::Message)
 
       super(attributes, options)
     end

data/lib/protobuf/activerecord/version.rb

@@ -1,5 +1,5 @@
 module Protobuf
   module ActiveRecord
-    VERSION = "1.0.2"
+    VERSION = "1.0.3"
   end
 end

data/spec/protoable/persistence_spec.rb

@@ -52,6 +52,30 @@ describe Protoable::Persistence do
     end
   end
 
+  describe ".create" do
+    it "accepts a protobuf message" do
+      User.any_instance.should_receive(:save)
+      User.create(proto)
+    end
+
+    it "accepts a hash" do
+      User.any_instance.should_receive(:save)
+      User.create(user_attributes)
+    end
+  end
+
+  describe ".create!" do
+    it "accepts a protobuf message" do
+      User.any_instance.should_receive(:save!)
+      User.create!(proto)
+    end
+
+    it "accepts a hash" do
+      User.any_instance.should_receive(:save!)
+      User.create!(user_attributes)
+    end
+  end
+
   describe ".create_from_proto" do
     it "initializes a new object with attributes from the given protobuf message" do
       user = User.create_from_proto(proto)
@@ -110,6 +134,30 @@ describe Protoable::Persistence do
     end
   end
 
+  describe ".update_attributes" do
+    it "accepts a protobuf message" do
+      User.any_instance.should_receive(:save)
+      user.update_attributes(proto)
+    end
+
+    it "accepts a hash" do
+      User.any_instance.should_receive(:save)
+      user.update_attributes(user_attributes)
+    end
+  end
+
+  describe ".update_attributes!" do
+    it "accepts a protobuf message" do
+      User.any_instance.should_receive(:save!)
+      user.update_attributes!(proto)
+    end
+
+    it "accepts a hash" do
+      User.any_instance.should_receive(:save!)
+      user.update_attributes!(user_attributes)
+    end
+  end
+
   describe "#update_from_proto" do
     it "updates the object with attributes from the given protobuf message" do
       user.should_receive(:assign_attributes).with(user_attributes, {})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protobuf-activerecord
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-28 00:00:00.000000000 Z
+date: 2012-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -222,7 +222,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2932429429413082945
+      hash: 763481842519497626
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -231,7 +231,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2932429429413082945
+      hash: 763481842519497626
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24