dynamini 2.6.0 → 2.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c71e8851f1dcde97317c1fd5034423cb4698a823
-  data.tar.gz: e62c81d4d011bc3bc99365dd577a6d11e054fdda
+  metadata.gz: eb80f52caa4a21c3f189d5427e7aa9ae90a1a2e0
+  data.tar.gz: 1c2f76b9cd36ccba731f263efabceeeafeb8ae97
 SHA512:
-  metadata.gz: 65bb9e2e742706642974c9509100afc9c96fb1f71a1d06fb32413b342b7b61a613e4687c88ee4364ddd5b9663074794c028601eb4b5403720ce3395ca005ce7c
-  data.tar.gz: acd5c9f3c9b30a2c5e512493348f7acc6fde4ffaa25cdd667519999b8f58ee7ca80613b0507da5b2cc03b9de92c622bcac8bc06bb9f3ddf901d3acea3da8c44e
+  metadata.gz: 0fc0ddf4c8c732c6943800a1fe735a1176203bb9f3740b2fb6cf762cfbe1d614bb684c7b34c32b9f04893668bc66f7745aa6d93addb55b9c199c09de81866a2e
+  data.tar.gz: a658de15ef8a2b607b68f7799d3ed23262df8df223fbfc838039e310a3986cfba8a99392fe0b5642eb56de2b38b4aa3d221fa244b22af109a34cd5dc5968d7dc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dynamini (2.6.0)
+    dynamini (2.6.2)
       activemodel (>= 3, < 5.0)
       aws-sdk (~> 2)
 

data/README.md

@@ -43,6 +43,7 @@ There are also some new functions specific to DynamoDB's API:
 * find_or_nil(hash_key, range_key) - since ActiveRecord's find_by isn't applicable to noSQL, use this method if you want a .find that doesn't raise exceptions when the item doesn't exist 
 * batch_find([keys]) - to retrieve multiple objects at once.
 * increment!({attribute1: amount, attribute2: amount}) - to update your record using DynamoDB's Atomic Counter functionality. (For more information, see http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.AtomicCounters )
+* add_to(attribute, value) - If you use this to modify your attribute, when saving, Dynamini will update that attribute with ADD instead of PUT. Your attribute must be handled as an addable type - :integer, :float, :array, :set, :date, or :time. (For more information on ADD actions, see http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateItem.html )
 
 ## Configuration
 In application.rb, or in initializers/dynamini.rb, include your AWS settings like so:
@@ -99,12 +100,13 @@ The following datatypes are supported by handle:
 * :time
 * :string
 * :array
+* :set
 
 Booleans and strings don't actually need to be translated, but you can set up defaults for those fields this way.
 The magic fields updated_at and created_at are handled as :time by default.
 
-## Array Support
-You can save arrays to your Dynamini model. Optionally, you can have Dynamini perform type conversion on each element of your array. Here's how it works:
+## Enumerable Support
+You can save arrays and sets to your Dynamini model. Optionally, you can have Dynamini perform type conversion on each element of your enumerable. Here's how it works:
 
 ```ruby
 class Vehicle < Dynamini::Base
@@ -138,7 +140,7 @@ Vehicle.find('H3LLO').other_array
 > ['wheel', 'brakes', BigDecimal(5)]
 ```
 
-Please note that changing arrays in place using mutator methods like << or map! will not record a change to the object. 
+Please note that changing enumerables in place using mutator methods like << or map! will not record a change to the object. 
 
 If you want to make changes like this, either clone it then use the assignment operator (e.g. model.array = model.array.dup << 'foo') or call model.mark(:attribute) after mutation and before saving to force Dynamini to write the change.
 
@@ -222,7 +224,7 @@ config.after(:each) {
 * You can also write any arbitrary attribute to your model.
 * Other models in your app cannot have a has_one or has_many relationship with your Dynamini model, since these would require a table scan. Your other models can still use belongs_to.
 * If you change the primary key value on an instance of your model, then resave it, you'll have two copies in your database.
-* If you use non-numeric strings for your primary key, remember to change your foreign key columns on related objects to be string type.
+* If you use non-numeric strings for your primary key, remember to change your foreign key columns on related ActiveRecord tables to be string type.
 * You might want to conditionally set the table name for your model based on the Rails.env, enabling separate tables for development and production.
 
 ## Contributing

data/dynamini.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'dynamini'
-  s.version = '2.6.0'
+  s.version = '2.6.2'
   s.summary = 'DynamoDB interface'
   s.description = 'Lightweight DynamoDB interface gem designed as
                    a drop-in replacement for ActiveRecord.

data/lib/dynamini/type_handler.rb

@@ -9,8 +9,8 @@ module Dynamini
         symbol:   proc { |v| v.to_sym },
         string:   proc { |v| v },
         boolean:  proc { |v| v },
-        array:    proc { |v| v },
-        set:      proc { |v| v }
+        array:    proc { |v| v.to_a },
+        set:      proc { |v| Set.new(v) }
     }
 
     SETTER_PROCS = {
@@ -21,8 +21,8 @@ module Dynamini
         string:   proc { |v| v },
         boolean:  proc { |v| v },
         date:     proc { |v| v.to_time.to_f },
-        array:    proc { |v| v },
-        set:      proc { |v| v }
+        array:    proc { |v| v.to_a },
+        set:      proc { |v| Set.new(v) }
     }
 
     module ClassMethods
@@ -71,13 +71,11 @@ module Dynamini
     end
 
     def attribute_callback(procs, handle, value)
-      type = handle[:options][:of] || handle[:format]
-      callback = procs[type]
-      if value.is_a?(Array)
-        value.map { |e| callback.call(e) }
-      elsif value.is_a?(Set)
-        Set.new(value.map { |e| callback.call(e) })
-      elsif handled_as?(handle, [:array, :set])
+      callback = procs[handle[:format]]
+      if should_convert_elements?(handle, value)
+        result = convert_elements(value, procs[handle[:options][:of]])
+        callback.call(result)
+      elsif invalid_enumerable_value?(handle, value)
         raise ArgumentError, "Can't write a non-enumerable value to field handled as #{handle[:format]}"
       else
         callback.call(value)
@@ -92,5 +90,17 @@ module Dynamini
       base.extend ClassMethods
     end
 
+    def should_convert_elements?(handle, value)
+      handle[:options][:of] && (value.is_a?(Array) || value.is_a?(Set))
+    end
+
+    def invalid_enumerable_value?(handle, value)
+      handled_as?(handle, [:array, :set]) && !value.is_a?(Enumerable)
+    end
+
+    def convert_elements(enumerable, callback)
+      enumerable.map { |e| callback.call(e) }
+    end
+
   end
 end

data/spec/dynamini/type_handler_spec.rb

@@ -16,10 +16,6 @@ describe Dynamini::TypeHandler do
         object = HandledClass.new
         expect(object.price).to eq(9)
       end
-      it 'should return an array with formatted items if handled' do
-        object = HandledClass.new(price: ["1", "2"])
-        expect(object.price).to eq([1, 2])
-      end
     end
 
     context 'when writing the handled attribute' do
@@ -101,6 +97,11 @@ describe Dynamini::TypeHandler do
     it 'should allow default values for arrays' do
       expect(handle_model.defaulted_ary).to eq([1, 2, 3])
     end
+
+    it 'should convert sets to arrays' do
+      handle_model.float_array = Set.new([12,24,48])
+      expect(handle_model.float_array).to_not be_a(Set)
+    end
   end
 
   context 'when handling as set' do
@@ -121,17 +122,10 @@ describe Dynamini::TypeHandler do
     it 'should allow default values for arrays' do
       expect(handle_model.defaulted_ary).to eq([1, 2, 3])
     end
-  end
-
-  context 'legacy support' do
-    it 'should save casted arrays' do
-      handle_model.int_list = [12, 24, 48]
-      expect(handle_model.int_list).to eq([12, 24, 48])
-    end
 
-    it 'should retrieve casted arrays' do
-      handle_model.sym_list = ['foo', 'bar', 'baz']
-      expect(handle_model.sym_list).to eq([:foo, :bar, :baz])
+    it 'should convert arrays to sets' do
+      handle_model.float_set = [12,24,48]
+      expect(handle_model.float_set).to_not be_a(Array)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynamini
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.6.2
 platform: ruby
 authors:
 - Greg Ward
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-21 00:00:00.000000000 Z
+date: 2016-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel