dynamoid 1.3.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 563c512230d5a7f2485b6cf226eff77accfa2a3e
-  data.tar.gz: e2f88e774032ddf472bc81a2b9e2a5844b61933a
+  metadata.gz: a2fdea2ccbdac2b53135bbd2bed6dedc5b501551
+  data.tar.gz: 31174f8f8b12baf0b7f40ab573dc7eed0f05d057
 SHA512:
-  metadata.gz: 4a9dba2ea759a74d83f27ef984e3ca963230ddebde577084e89324eb69dd08c65c4c19690891e4086bc9cacadb17eaed5c460c03944dcc9db1eb109044ceef91
-  data.tar.gz: 314ffb14350619c950bd6615d46ccb3ca32383116f1a1dfe0aa39891694575e89d3376051bfac53b4e4a0f584257c0315a334365e5715727bcc767a31c2daa5e
+  metadata.gz: 1de8d6315cbef5ce26f26a850cb95669e93a4d4b3e4badc2ea5305e224dcdf4ffcaf66cf2d0cd5baca4e7644b57765bb92cf31f841ed1fed1cc1d6a789433d7a
+  data.tar.gz: 33f582e685f63655d6b57c9cb5484eacf71d04634e34829370aff67fc173511c4f26acba4affb151f0774998477577ed8dd0a66f8af8615e41d12797163212ac

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -69,3 +69,6 @@ Gemfile.lock
 
 # For vagrant
 .vagrant
+
+# For Appraisals
+gemfiles/*.gemfile.lock

data/.travis.yml

@@ -1,3 +1,5 @@
+sudo: required
+
 language: ruby
 rvm:
   - ruby-2.0.0-p648
@@ -6,26 +8,49 @@ rvm:
   - ruby-2.3.4
   - ruby-2.4.1
   - jruby-9.1.9.0
+gemfile:
 gemfile:
   - gemfiles/rails_4_0.gemfile
   - gemfiles/rails_4_1.gemfile
   - gemfiles/rails_4_2.gemfile
   - gemfiles/rails_5_0.gemfile
+  - gemfiles/rails_5_1.gemfile
 matrix:
   exclude:
     - rvm: ruby-2.0.0-p648
       gemfile: gemfiles/rails_5_0.gemfile
+    - rvm: ruby-2.0.0-p648
+      gemfile: gemfiles/rails_5_1.gemfile
     - rvm: ruby-2.1.10
       gemfile: gemfiles/rails_5_0.gemfile
+    - rvm: ruby-2.1.10
+      gemfile: gemfiles/rails_5_1.gemfile
     - rvm: ruby-2.4.1
       gemfile: gemfiles/rails_4_0.gemfile
     - rvm: ruby-2.4.1
       gemfile: gemfiles/rails_4_1.gemfile
-before_install: gem install bundler -v 1.15.4
-install:
-  - wget http://dynamodb-local.s3-website-us-west-2.amazonaws.com/dynamodb_local_latest.zip --quiet -O spec/dynamodb_temp.zip
-  - unzip -qq spec/dynamodb_temp.zip -d spec/DynamoDBLocal-latest
-  - rm spec/dynamodb_temp.zip
-script:
+
+### BUILD LIFECYCLE STEPS ###
+
+before_install:
+  # Debugging: Print out the current docker-compose version.
+  - docker-compose --version
+
+  # If one of your containers does not build for
+  # whatever reason it's best to report that now before your tests start
+  # otherwise it can be really tricky to debug why tests are failing sometimes.
+  - docker ps
+
+after_install:
+  - gem install bundler -v 1.15.4
   - bundle install
-  - bundle exec rake unattended_spec
+
+before_script:
+  # Start Docker Compose as a daemon
+  - docker-compose up -d
+
+script:
+  - bundle exec rake spec
+
+after_script:
+  - docker-compose down

data/Appraisals

@@ -1,15 +1,22 @@
 appraise "rails-4-0" do
   gem "rails", "~> 4.0.0"
+  gem "nokogiri", "~> 1.6.8" # can be removed once we drop support for Ruby 2.0.0
 end
 
 appraise "rails-4-1" do
   gem "rails", "~> 4.1.0"
+  gem "nokogiri", "~> 1.6.8" # can be removed once we drop support for Ruby 2.0.0
 end
 
 appraise "rails-4-2" do
   gem "rails", "~> 4.2.0"
+  gem "nokogiri", "~> 1.6.8" # can be removed once we drop support for Ruby 2.0.0
 end
 
 appraise "rails-5-0" do
   gem "rails", "~> 5.0.0"
 end
+
+appraise "rails-5-1" do
+  gem "rails", "~> 5.1.0"
+end

data/CHANGELOG.md

@@ -1,8 +1,75 @@
 # HEAD
 
+## Breaking
+
+* N/A
+
+## Improvements
+
+* N/A
+
+## Fixes
+
+* N/A
+
+# 2.0.0
+
+## Breaking
+
+Breaking changes in this release generally bring Dynamoid behavior closer to the Rails-way.
+
+* Change: [#186](https://github.com/Dynamoid/Dynamoid/pull/186) Consistent behavior for `Model.where({}).all` (@andrykonchin)
+    * <= 1.3.x behaviour - 
+        * load lazily if user specified batch size
+        * load all collection into memory otherwise
+    * New behaviour -
+        * always return lazy evaluated collection
+        * It means Model.where({}).all returns Enumerator instead of Array.
+        * If you need Array interface you have to convert collection to Array manually with to_a method call
+* Change: [#195](https://github.com/Dynamoid/Dynamoid/pull/195) Failed `#find` returns error (@andrykonchin)
+    * <= 1.3.x behaviour - find returns nil or smaller array.
+    * New behaviour - it raises RecordNotFound if one or more records can not be found for the requested ids
+* Change: [#196](https://github.com/Dynamoid/Dynamoid/pull/196) Return value of `#save` (@andrykonchin)
+    * <= 1.3.x behaviour - save returns self if model is saved successfully
+    * New behaviour - it returns true
+
+## Improvements
+
+* Feature: [#185](https://github.com/Dynamoid/Dynamoid/pull/185) `where`, finders and friends take into account STI (single table inheritance) now (@andrykonchin)
+    * query will return items of the model class and all subclasses
+* Feature: [#190](https://github.com/Dynamoid/Dynamoid/pull/190) Allow passing options to range when defining attributes of the document (@richardhsu)
+    * Allows for serialized fields and passing the serializer option.
+* Feature: [#198](https://github.com/Dynamoid/Dynamoid/pull/198) Enhanced `#create` and `#create!` to allow multiple document creation like `#import` (@andrykonchin)
+    * `User.create([{name: 'Josh'}, {name: 'Nick'}])`
+* Feature: [#199](https://github.com/Dynamoid/Dynamoid/pull/199) Added `Document.import` method (@andrykonchin)
+* Feature: [#205](https://github.com/Dynamoid/Dynamoid/pull/205) Use batch deletion via `batch_write_item` for `delete_all` (@andrykonchin)
+* Rename: [#205](https://github.com/Dynamoid/Dynamoid/pull/205) `Chain#destroy_all` as `Chain#delete_all`, to better match Rails conventions when no callbacks are run (@andrykonchin)
+    * kept the old name as an alias, for backwards compatibility
+* Feature: [#207](https://github.com/Dynamoid/Dynamoid/pull/207) Added slicing by 25 requests in #batch_write_item (@andrykonchin)
+* Feature: [#211](https://github.com/Dynamoid/Dynamoid/pull/211) Improved Vagrant setup for testing (@richardhsu)
+* Feature: [#212](https://github.com/Dynamoid/Dynamoid/pull/212) Add foreign_key option (@andrykonchin)
+* Feature: [#213](https://github.com/Dynamoid/Dynamoid/pull/213) Support Boolean raw type (@andrykonchin)
+* Improved Documentation (@pboling, @andrykonchin)
+
+## Fixes
+
+* Bug: [#191](https://github.com/Dynamoid/Dynamoid/pull/191), [#192](https://github.com/Dynamoid/Dynamoid/pull/192) Support lambdas as fix for value types were not able to be used as default values (@andrykonchin)(@richardhsu) 
+* Bug: [#202](https://github.com/Dynamoid/Dynamoid/pull/202) Fix several issues with associations (@andrykonchin)
+    * setting `nil` value raises an exception
+    * document doesn't keep assigned model and loads it from the storage
+    * delete call doesn't update cached ids of associated models
+    * fix clearing old `has_many` association while add model to new `has_many` association
+* Bug: [#204](https://github.com/Dynamoid/Dynamoid/pull/204) Fixed issue where `Document.where(:"id.in" => [])` would do `Query` operation instead of `Scan` (@andrykonchin)
+    * Fixed `Chain#key_present?`
+* Bug: [#205](https://github.com/Dynamoid/Dynamoid/pull/205) Fixed `delete_all` (@andrykonchin)
+    * Fixed exception when makes scan and sort key is declared in model
+    * Fixed exception when makes scan and any condition is specified in where clause (like Document.where().delete_all) 
+    * Fixed exception when makes query and sort key isn't declared in model
+* Bug: [#207](https://github.com/Dynamoid/Dynamoid/pull/207) Fixed `#delete` method for case `adapter.delete(table_name, [1, 2, 3], range_key: 1)` (@andrykonchin)
+
 # 1.3.4
 
-Improving
+## Improvements
 
 * Added `Chain#last` method (@andrykonchin)
 * Added `date` field type (@andrykonchin)
@@ -19,7 +86,7 @@ Improving
 * Support querying Global/Local Secondary Indices in `where` clause (@richardhsu)
 * Only query on GSI if projects all attributes in `where` clause (@richardhsu)
 
-Fixes
+## Fixes
 
 * Fix incorrect applying of default field value (#36 and #117, @andrykonchin)
 * Fix sync table creation/deletion (#160, @mirokuxy)

data/Gemfile

@@ -2,3 +2,5 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in dynamoid.gemspec
 gemspec
+
+gem "pry-byebug", platforms: :ruby

data/README.md

@@ -1,5 +1,9 @@
 # Dynamoid
 
+You are viewing the README for the unreleased version 2 of Dynamoid.
+  
+For version 1.3.x use the [1-3-stable branch](https://github.com/Dynamoid/Dynamoid/blob/1-3-stable/README.md).
+
 Dynamoid is an ORM for Amazon's DynamoDB for Ruby applications. It
 provides similar functionality to ActiveRecord and improves on
 Amazon's existing
@@ -10,10 +14,20 @@ DynamoDB is not like other document-based databases you might know, and is very
 
 But if you want a fast, scalable, simple, easy-to-use database (and a Gem that supports it) then look no further!
 
-## Call For Maintainers
 
-Please inquire within.
-https://github.com/Dynamoid/Dynamoid/issues/125
+| Project                 |  Dynamoid         |
+|------------------------ | ----------------- |
+| gem name                |  dynamoid         |
+| license                 |  MIT              |
+| download rank           |  [![Total Downloads](https://img.shields.io/gem/rt/Dynamoid.png)](https://rubygems.org/gems/dynamoid) |
+| version                 |  [![Gem Version](https://badge.fury.io/rb/dynamoid.png)](http://badge.fury.io/rb/dynamoid) |
+| dependencies            |  [![Dependency Status](https://gemnasium.com/badges/github.com/Dynamoid/Dynamoid.png)](https://gemnasium.com/github.com/Dynamoid/Dynamoid) |
+| code quality            |  [![Code Climate](https://codeclimate.com/github/Dynamoid/Dynamoid.png)](https://codeclimate.com/github/Dynamoid/Dynamoid) |
+| continuous integration  |  [![Build Status](https://secure.travis-ci.org/Dynamoid/Dynamoid.png?branch=master)](https://travis-ci.org/Dynamoid/Dynamoid) |
+| test coverage           |  [![Coverage Status](https://coveralls.io/repos/github/Dynamoid/Dynamoid/badge.png?branch=master)](https://coveralls.io/github/Dynamoid/Dynamoid?branch=master) |
+| triage helpers          |  [![Coverage Status](https://www.codetriage.com/dynamoid/dynamoid/badges/users.png)](https://www.codetriage.com/dynamoid/dynamoid) |
+| homepage                |  [https://github.com/Dynamoid/Dynamoid](https://github.com/Dynamoid/Dynamoid) |
+| documentation           |  [http://rdoc.info/github/Dynamoid/Dynamoid/frames](http://rdoc.info/github/Dynamoid/Dynamoid/frames) |
 
 ## Installation
 
@@ -124,6 +138,23 @@ By default, fields are assumed to be of type ```:string```. Other built-in types
 If built-in types do not suit you, you can use a custom field type represented by an arbitrary class, provided that the class supports a compatible serialization interface.
 The primary use case for using a custom field type is to represent your business logic with high-level types, while ensuring portability or backward-compatibility of the serialized representation.
 
+#### Note on boolean type
+
+The boolean fields are stored as `"t", "f"` strings by default. DynamoDB
+supports boolean type natively. So if you want to use native boolean
+type or already have table with native boolean attribute you can easily
+achieve this with `store_as_native_boolean` option:
+
+```ruby
+class Document
+  include DynamoId::Document
+
+  field :active, :boolean, store_as_native_boolean: true
+end
+```
+
+#### Magic Columns
+
 You get magic columns of id (string), created_at (datetime), and updated_at (datetime) for free.
 
 ```ruby
@@ -140,6 +171,8 @@ class User
 end
 ```
 
+#### Default Values
+
 You can optionally set a default value on a field using either a plain value or a lambda:
 
 ```ruby
@@ -147,6 +180,8 @@ You can optionally set a default value on a field using either a plain value or
   field :joined_at, :datetime, {default: ->(){Time.now}}
 ```
 
+#### Custom Types
+
 To use a custom type for a field, suppose you have a `Money` type.
 
 ```ruby
@@ -159,7 +194,7 @@ To use a custom type for a field, suppose you have a `Money` type.
 
     def self.dynamoid_load(serialized_str)
       # parse serialized representation and return a Money instance
-      Money.new(...)
+      Money.new(1.23)
     end
   end
 
@@ -181,7 +216,7 @@ add a level of indirection for serializing.)  Example:
 
   class MoneyAdapter
     def self.dynamoid_load(money_serialized_str)
-      Money.new(...)
+      Money.new(1.23)
     end
 
     def self.dynamoid_dump(money_obj)
@@ -201,8 +236,8 @@ This is especially important if you want to use your custom field as a numeric r
 number-oriented queries.  By default custom fields are persisted as a string attribute, but
 your custom class can override this with a `.dynamoid_field_type` class method, which would
 return either `:string` or `:number`.
-(DynamoDB supports some other attribute types, but Dynamoid does not yet.)
 
+DynamoDB may support some other attribute types that are not yet supported by Dynamoid.
 
 ### Associations
 
@@ -214,12 +249,13 @@ The only supported associations (so far) are ```has_many```, ```has_one```, ```h
 class User
   include Dynamoid::Document
 
-  ...
+  # ...
 
   has_many :addresses
   has_many :students, :class => User
   belongs_to :teacher, :class_name => :user
   belongs_to :group
+  belongs_to :group, :foreign_key => :group_id
   has_one :role
   has_and_belongs_to_many :friends, :inverse_of => :friending_users
 
@@ -228,7 +264,7 @@ end
 class Address
   include Dynamoid::Document
 
-  ...
+  # ...
 
   belongs_to :user # Automatically links up with the user model
 
@@ -245,7 +281,7 @@ Dynamoid bakes in ActiveModel validations, just like ActiveRecord does.
 class User
   include Dynamoid::Document
 
-  ...
+  # ...
 
   validates_presence_of :name
   validates_format_of :email, :with => /@/
@@ -268,7 +304,7 @@ Dynamoid also employs ActiveModel callbacks. Right now, callbacks are defined on
 class User
   include Dynamoid::Document
 
-  ...
+  # ...
 
   before_save :set_default_password
   after_create :notify_friends
@@ -325,6 +361,19 @@ address.city = 'Chicago'
 address.save
 ```
 
+To create multiple documents at once:
+
+```ruby
+User.create([{name: 'Josh'}, {name: 'Nick'}])
+```
+
+There is an efficient and low-level way to create multiple documents
+(without validation and callbacks running):
+
+```ruby
+users = User.import([{name: 'Josh'}, {name: 'Nick'}])
+```
+
 ### Querying
 
 Querying can be done in one of three ways:
@@ -386,21 +435,21 @@ You are able to optimize query with condition for sort key. Following operators
 
 ```ruby
 Address.where(latitude: 10212)
-Address.where('latitude.gt': 10212)
-Address.where('latitude.lt': 10212)
-Address.where('latitude.gte': 10212)
-Address.where('latitude.lte': 10212)
-Address.where('city.begins_with': 'Lon')
-Address.where('latitude.between': [10212, 20000])
+Address.where('latitude.gt' => 10212)
+Address.where('latitude.lt' => 10212)
+Address.where('latitude.gte' => 10212)
+Address.where('latitude.lte' => 10212)
+Address.where('city.begins_with' => 'Lon')
+Address.where('latitude.between' => [10212, 20000])
 ```
 
 You are able to filter results on the DynamoDB side and specify conditions for non-key fields.
 Following operators are available: `in`, `contains`, `not_contains`:
 
 ```ruby
-Address.where('city.in': ['London', 'Edenburg', 'Birmingham'])
-Address.where('city.contains': [on])
-Address.where('city.not_contains': [ing])
+Address.where('city.in' => ['London', 'Edenburg', 'Birmingham'])
+Address.where('city.contains' => [on])
+Address.where('city.not_contains' => [ing])
 ```
 
 ### Consistent Reads
@@ -423,8 +472,42 @@ User.where("created_at.lt" => DateTime.now - 1.day).all
 
 It also supports .gte and .lte. Turning those into symbols and allowing a Rails SQL-style string syntax is in the works. You can only have one range argument per query, because of DynamoDB's inherent limitations, so use it sensibly!
 
+### Deleting
+
+In order to delete some items `delete_all` method should be used.
+Any callback wont be called. Items delete in efficient way in batch.
+
+```ruby
+Address.where(city: "London").delete_all
+```
+
 ### Global Secondary Indexes
 
+You can define index with `global_secondary_index`:
+
+```ruby
+class User
+  include Dynamoid::Document
+
+  field :name
+  field :age, :number
+
+  global_secondary_index hash_key: :age
+end
+```
+
+There are following options:
+* `hash_key` - is used as hash key of an index,
+* `range_key` - is used as range key of an index,
+* `projected_attributes` - list of fields to store in an index or has a predefiled value `:keys_only`, `:all`; `:keys_only` is a default,
+* `name` - an index will be created with this name when a table is created; by default name is generated and contains table name and keys names,
+* `read_capacity` - is used when table creates and used as an index capacity; by default equals `Dynamoid::Config.read_capacity`,
+* `write_capacity` - is used when table creates and used as an index capacity; by default equals `Dynamoid::Config.write_capacity`
+
+The only mandatory option is `name`.
+
+To use index in `Document.where` implicitly you need to project all the fields with option `projected_attributes: :all`.
+
 There are two ways to query Global Secondary Indexes (GSI).
 
 #### Explicit
@@ -485,7 +568,7 @@ the table since a query against GSI then a query on base table is still likely f
 
 ## Configuration
 
-There are listed all the configuration options:
+Listed below are all configuration options.
 
 * `adapter` - usefull only for the gem developers to switch to a new adapter. Default and the only available value is `aws_sdk_v2`
 * `namespace` - prefix for table names, default is `dynamoid_#{application_name}_#{environment}` for Rails application and `dynamoid` otherwise
@@ -515,11 +598,11 @@ Dynamoid supports basic, ActiveRecord-like optimistic locking on save operations
 
 ```ruby
 class MyTable
-  ...
+  # ...
 
   field :lock_version, :integer
 
-  ...
+  # ...
 end
 ```
 
@@ -598,9 +681,9 @@ Also, without contributors the project wouldn't be nearly as awesome. So many th
 
 ## Running the tests
 
-Running the tests is fairly simple. You should have an instance of DynamoDB running locally. Follow this steps to be able to run the tests:
+Running the tests is fairly simple. You should have an instance of DynamoDB running locally. Follow these steps to setup your test environment.
 
- * First download and unpack the latest version of DynamoDB.
+ * First download and unpack the latest version of DynamoDB.  We have a script that will do this for you if you use homebrew on a Mac.
 
     ```shell
     bin/setup
@@ -624,7 +707,7 @@ Running the tests is fairly simple. You should have an instance of DynamoDB runn
     bin/stop_dynamodblocal
     ```
 
-If you want to run all the specs that travis runs, use `bundle exec wwtd`, but first you will need to setup all the rubies, for each of `%w( 2.0.0-p648 2.1.10 2.2.6 2.3.3 2.4.1 jruby-9.1.8.0 )`.  WHen you run `bundle exec wwtd` it will take care of starting and stopping the local dynamodb instance.
+If you want to run all the specs that travis runs, use `bundle exec wwtd`, but first you will need to setup all the rubies, for each of `%w( 2.0.0-p648 2.1.10 2.2.6 2.3.3 2.4.1 jruby-9.1.8.0 )`.  When you run `bundle exec wwtd` it will take care of starting and stopping the local dynamodb instance.
 
 ```shell
 rvm use 2.0.0-p648
@@ -633,9 +716,6 @@ gem install bundler
 bundle install
 ```
 
-[![Build Status](https://travis-ci.org/Dynamoid/Dynamoid.svg)](https://travis-ci.org/Dynamoid/Dynamoid)
-[![Coverage Status](https://coveralls.io/repos/Dynamoid/Dynamoid/badge.svg?branch=master&service=github)](https://coveralls.io/github/Dynamoid/Dynamoid?branch=master)
-
 ## Copyright
 
 Copyright (c) 2012 Josh Symonds.