store_field 1.0.0 → 1.1.0

data/README.md

@@ -17,9 +17,9 @@ user.tutorials[:quick_start] = :visited     # => NoMethodError: undefined method
 
 There are two ways to solve this problem - a. break down `options` into multiple columns like `tutorials` and `preference`, or b. define an accessor method for each to initialize with an empty `Hash` when accessed for the first time.
 
-The former is bad because the TEXT (or BLOB) column type could be [stored off-page](http://www.mysqlperformanceblog.com/2010/02/09/blob-storage-in-innodb/) when it gets big and you could hit some strange bugs and/or performance penalty. Furthermore, adding columns kills the primary purpose of having key-value store - you use this feature because you don't like migrations, right? So it's two-fold bad.
+The former is bad because the TEXT (or BLOB) column type could be stored off-page when it gets big and you could hit some [strange bugs and/or performance penalty](http://www.mysqlperformanceblog.com/2010/02/09/blob-storage-in-innodb/). Furthermore, adding columns kills the primary purpose of having key-value store - you use this feature because you don't like migrations, right? So it's two-fold bad.
 
-StoreField takes the latter approach. It defines accessors that initializes with an empty `Hash` or `Set` automatically. Now you have a single TEXT column for everything!
+StoreField takes the latter approach. It defines accessors that initialize with an empty `Hash` or `Set` automatically. Now you have a single TEXT column for everything!
 
 ## Usage
 
@@ -78,9 +78,21 @@ cart.funnel                     # => #<Set: {:add_item, :checkout}>
 cart.set_funnel(:checkout).save!    # => true
 ```
 
+Also you can enumerate acceptable values, which is validated on the `set_[field]` method.
+
+```ruby
+store_field :funnel, type: Set, values: [ :add_item, :checkout ]
+```
+
+With the definition above, the following code will raise an exception.
+
+```ruby
+set_funnel(:bogus)  # => ArgumentError: :bogus is not allowed
+```
+
 ## Use cases for the Set type
 
-Set is a great way to store an arbitrary number of states.
+Set is a great way to store an arbitrary number of named states.
 
 Consider you have a system that sends an alert when some criteria have been met.
 
@@ -105,3 +117,25 @@ end
 ```
 
 That way, the user won't receive the same alert again, until `unset_delivered` is called when the next billing cycle starts.
+
+## YAML serialization
+
+ActiveRecord::Store uses YAML to serialize Ruby objects. A StoreField will be stored as follows:
+
+```yaml
+---
+:funnel: !ruby/object:Set
+  hash:
+    :add_item: true
+    :checkout: true
+```
+
+As you can see, the `Set` class internally uses `Hash` for its storage.
+
+There is a [known compatibility problem](http://bugs.ruby-lang.org/issues/6910) between `psych` and `syck`, be sure to use `psych` from the beginning.
+
+```ruby
+YAML::ENGINE.yamler     # => "psych"
+```
+
+If you are using Ruby 1.9.2 or later, `psych` should be used by default.

data/lib/store_field/version.rb

@@ -1,3 +1,3 @@
 module StoreField
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/store_field.rb

@@ -7,26 +7,32 @@ module StoreField
 
   module ClassMethods
     def store_field(key, options = {})
-      raise ArgumentError.new(':in is invalid')   if options[:in] and serialized_attributes[options[:in].to_s].nil?
-      raise ArgumentError.new(':type is invalid') if options[:type] and ![ Hash, Set ].include?(options[:type])
+      raise ArgumentError.new(':in is invalid')     if options[:in] and serialized_attributes[options[:in].to_s].nil?
+      raise ArgumentError.new(':type is invalid')   if options[:type] and ![ Hash, Set ].include?(options[:type])
+      raise ArgumentError.new(':values is invalid') if options[:values] and !options[:values].is_a?(Array)
 
       klass = options[:type]
+      values = options[:values]
       store_attribute = options[:in] || serialized_attributes.keys.first
       raise ArgumentError.new('store method must be defined before store_field') if store_attribute.nil?
 
       # Accessor
       define_method(key) do
-        value = send("#{store_attribute}")[key]
+        value = send(store_attribute)[key]
         if value.nil?
           value = klass ? klass.new : {}
-          send("#{store_attribute}")[key] = value
+          send(store_attribute)[key] = value
         end
         value
       end
 
       # Utility methods for Set
       if options[:type] == Set
-        define_method("set_#{key}")     {|value| send(key).add(value); self }
+        define_method("set_#{key}") do |value|
+          raise ArgumentError.new("#{value.inspect} is not allowed") if values and !values.include?(value)
+          send(key).add(value)
+          self
+        end
         define_method("unset_#{key}")   {|value| send(key).delete(value); self }
         define_method("set_#{key}?")    {|value| send(key).include?(value) }
         define_method("unset_#{key}?")  {|value| !send(key).include?(value) }

data/spec/store_field_spec.rb

@@ -7,7 +7,7 @@ end
 class User < ActiveRecord::Base
   store :storage
   store_field :tutorials
-  store_field :delivered, type: Set
+  store_field :delivered, type: Set, values: [ :welcome, :balance_low ]
 end
 
 describe StoreField do
@@ -30,19 +30,22 @@ describe StoreField do
     @user.delivered.should == Set.new
   end
 
+  it 'raises when invalid value is given for Set' do
+    expect {
+      @user.set_delivered(:bogus)
+    }.to raise_error(ArgumentError)
+  end
+
   it 'sets and unsets keywords' do
     @user.set_delivered(:welcome)
-    @user.set_delivered(:first_deposit)
 
     # Consume balance, notify once and only once
     @user.set_delivered(:balance_low)
-    @user.set_delivered(:balance_negative)
 
     # Another deposit, restore balance
     @user.unset_delivered(:balance_low)
-    @user.unset_delivered(:balance_negative)
 
-    @user.delivered.should == Set.new([:welcome, :first_deposit])
+    @user.delivered.should == Set.new([:welcome])
   end
 
   it 'saves in-line' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: store_field
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-19 00:00:00.000000000 Z
+date: 2012-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord