dynamoid 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66d793bb4519ccd94ce9e8dd46550c02db75390e
-  data.tar.gz: 55f4da7a601691112e2eac068a81f3194b893fa5
+  metadata.gz: '04313866f14532a020f286b09a32b7c27745aa56'
+  data.tar.gz: fbd6aef851145aa731ea684a0a5ccfadc1f71659
 SHA512:
-  metadata.gz: f26bf8ba08816cffae591a78e2b9148abed5423bd8a84c556888bba9c9e35dd24e971b9425e2729ae71be6ec0ee015eab274e321bcfe99fe18243339e13e2e2b
-  data.tar.gz: c2f267ed34a44de9c940416ebbbc950ab6588aa1e75de85d016171d881466613966223c24d59b669fea09919f1b5a47d8fc1005c68692f9b8c4003dd89a0a045
+  metadata.gz: 5f71ed0b06f92ce3d296732a839f14778a841754a3856c889a0693b9bf81986fb43762f1b45bc9ddc998a11e9e4ab6ff44a1295ebef36b1c83d6004378624b1c
+  data.tar.gz: 8e34652d0b05adbd2a6b30c405140acec063a31a42c41580edfd8bb2a51b792f572f651baf6f136e752ff860b774d777ce4914b28149a7ed39b49db404632b9d

data/.gitignore

@@ -65,3 +65,4 @@ Gemfile.lock
 /spec/reports/
 /tmp/
 /spec/DynamoDBLocal-latest/
+/vendor/

data/.travis.yml

@@ -2,10 +2,26 @@ language: ruby
 rvm:
   - ruby-2.0.0-p648
   - ruby-2.1.10
-  - ruby-2.2.5
-  - ruby-2.3.1
-  - jruby-9.1.4.0
-before_install: gem install bundler -v 1.12.5
+  - ruby-2.2.6
+  - ruby-2.3.3
+  - ruby-2.4.1
+  - jruby-9.1.8.0
+gemfile:
+  - gemfiles/rails_4_0.gemfile
+  - gemfiles/rails_4_1.gemfile
+  - gemfiles/rails_4_2.gemfile
+  - gemfiles/rails_5_0.gemfile
+matrix:
+  exclude:
+    - rvm: ruby-2.0.0-p648
+      gemfile: gemfiles/rails_5_0.gemfile
+    - rvm: ruby-2.1.10
+      gemfile: gemfiles/rails_5_0.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.14.6
 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

data/Appraisals

@@ -0,0 +1,15 @@
+appraise "rails-4-0" do
+  gem "rails", "~> 4.0.0"
+end
+
+appraise "rails-4-1" do
+  gem "rails", "~> 4.1.0"
+end
+
+appraise "rails-4-2" do
+  gem "rails", "~> 4.2.0"
+end
+
+appraise "rails-5-0" do
+  gem "rails", "~> 5.0.0"
+end

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # HEAD
 
+# 1.3.1
+
+* Adds support for Rails 5 without warnings.
+* Adds rake tasks for working with a DynamoDB database:
+  * rake dynamoid:create_tables
+  * rake dynamoid:ping
+* Automatically requires the Railtie when in Rails (which loads the rake tasks)
+* Prevent duplicate entries in Dynamoid.included_models
+* Added wwtd and appraisal to spec suite for easier verification of the compatibility matrix
+* Support is now officially Ruby 2.0+, (including JRuby 9000) and Rails 4.0+
+
 # 1.3.0
 
 * Fixed specs (@AlexNisnevich & @pboling)

data/README.md

@@ -10,6 +10,11 @@ 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
+
 ## Installation
 
 Installing Dynamoid is pretty simple. First include the Gem in your Gemfile:
@@ -75,7 +80,18 @@ Then you need to initialize Dynamoid config to get it going. Put code similar to
 
 ```
 
-Once you have the configuration set up, you need to move on to making models.
+### Compatibility Matrix
+
+| Ruby / Active Record  | 4.0.x | 4.1.x | 4.2.x | 5.0.x |
+|:---------------------:|:-----:|:-----:|:-----:|:-----:|
+| 2.0.0                 | ✓     | ✓     | ✓     |       |
+| 2.1.x                 | ✓     | ✓     | ✓     |       |
+| 2.2.0-2.2.1           | ✓     | ✓     | ✓     |       |
+| 2.2.2+                | ✓     | ✓     | ✓     | ✓     |
+| 2.3.x                 | ✓     | ✓     | ✓     | ✓     |
+| 2.3.x                 | ✓     | ✓     | ✓     | ✓     |
+| 2.4.x                 |       |       | ✓     | ✓     |
+| jruby-9.X             | ✓     | ✓     | ✓     | ✓     |
 
 ## Setup
 
@@ -335,6 +351,39 @@ 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!
 
+### Global Secondary Indexes
+
+The query I use is as follows, but I really do not know a lot about Dynamoid, and got this working by reading through other Amazon Dynamo code bases and the documentation form Amazon.
+
+```ruby
+find_all_by_secondary_index(
+    {
+        dynamo_primary_key_column_name => dynamo_primary_key_value
+    }, # The signature of find_all_by_secondary_index is ugly, so must be an explicit hash here
+    :range => {
+        "#{range_column}.#{range_modifier}" => range_value
+    },
+    # false is the same as DESC in SQL (newest timestamp first)
+    # true is the same as ASC in SQL (oldest timestamp first)
+    :scan_index_forward => false # or true
+)
+```
+where the range modifier is one of Dynamoid::Finders::RANGE_MAP.keys, where the RANGE_MAP is:
+
+```ruby
+RANGE_MAP = {
+  'gt'            => :range_greater_than,
+  'lt'            => :range_less_than,
+  'gte'           => :range_gte,
+  'lte'           => :range_lte,
+  'begins_with'   => :range_begins_with,
+  'between'       => :range_between,
+  'eq'            => :range_eq
+}
+```
+
+Most range searches, like `eq`, need a single value, and searches like `between`, need an array with two values.
+
 ## Concurrency
 
 Dynamoid supports basic, ActiveRecord-like optimistic locking on save operations. Simply add a `lock_version` column to your table like so:
@@ -353,6 +402,11 @@ In this example, all saves to `MyTable` will raise an `Dynamoid::Errors::StaleOb
 
 Calls to `update` and `update!` also increment the `lock_version`, however they do not check the existing value. This guarantees that a update operation will raise an exception in a concurrent save operation, however a save operation will never cause an update to fail. Thus, `update` is useful & safe only for doing atomic operations (e.g. increment a value, add/remove from a set, etc), but should not be used in a read-modify-write pattern.
 
+## Rake Tasks
+
+  * `rake dynamoid:create_tables`
+  * `rake dynamoid:ping`
+
 ## Test Environment
 
 In test environment you will most likely want to clean the database between test runs to keep tests completely isolated. This can be achieved like so
@@ -439,6 +493,21 @@ Running the tests is fairly simple. You should have an instance of DynamoDB runn
     rake
     ```
 
+ * When you are done, remember to stop the local test instance of dynamodb
+
+    ```shell
+    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.
+
+```shell
+rvm use 2.0.0-p648
+gem install rubygems-update
+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)
 

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
 
+require "bundler/setup"
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -7,6 +8,9 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
+if defined?(Rails)
+  load "./lib/dynamoid/tasks/database.rake"
+end
 
 require "rake"
 require "rspec/core/rake_task"
@@ -61,4 +65,6 @@ task :publish do
   `git checkout master`
 end
 
+require "wwtd/tasks"
+
 task :default => :spec

data/dynamoid.gemspec

@@ -38,20 +38,25 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  if Gem::Version.new(RUBY_VERSION) > Gem::Version.new("2.2.2")
-    spec.add_runtime_dependency(%q<activemodel>, [">= 4"])
-  else
-    spec.add_runtime_dependency(%q<activemodel>, ["~> 4"])
-  end
+  # This form of switching the gem dependencies is not compatible with wwtd & appraisal
+  # if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.2.2")
+  #   spec.add_runtime_dependency(%q<activemodel>, [">= 4", "< 5.1.0"])
+  #   spec.add_development_dependency(%q<activesupport>, [">= 4", "< 5.1.0"])
+  # else
+  #   spec.add_runtime_dependency(%q<activemodel>, ["~> 4"])
+  #   spec.add_development_dependency(%q<activesupport>, ["~> 4"])
+  # end
+  spec.add_runtime_dependency(%q<activemodel>, [">= 4"])
+  spec.add_development_dependency(%q<activesupport>, [">= 4"])
   spec.add_runtime_dependency(%q<aws-sdk-resources>, ["~> 2"])
   spec.add_runtime_dependency(%q<concurrent-ruby>, [">= 1.0"])
-  spec.add_development_dependency(%q<rake>, [">= 10"])
-  spec.add_development_dependency(%q<bundler>, ["~> 1.12"])
-  spec.add_development_dependency(%q<rspec>, [">= 3"])
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "appraisal", "~> 2.1"
+  spec.add_development_dependency "wwtd", "~> 1.3"
   spec.add_development_dependency(%q<yard>, [">= 0"])
-  spec.add_development_dependency(%q<github-markup>, [">= 0"])
-  spec.add_development_dependency(%q<pry>, [">= 0"])
   spec.add_development_dependency(%q<coveralls>, [">= 0"])
   spec.add_development_dependency(%q<rspec-retry>, [">= 0"])
-  spec.add_development_dependency(%q<activesupport>, ["~> 4"])
 end

data/gemfiles/rails_4_0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.0.0"
+# Still tested against Ruby 2.0.0, which can't install nokogiri 1.7+
+gem "nokogiri", "~> 1.6.8.1"
+
+gemspec :path => "../"

data/gemfiles/rails_4_0.gemfile.lock

@@ -0,0 +1,150 @@
+PATH
+  remote: ..
+  specs:
+    dynamoid (1.3.0)
+      activemodel (>= 4)
+      aws-sdk-resources (~> 2)
+      concurrent-ruby (>= 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.0.13)
+      actionpack (= 4.0.13)
+      mail (~> 2.5, >= 2.5.4)
+    actionpack (4.0.13)
+      activesupport (= 4.0.13)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.13)
+      activesupport (= 4.0.13)
+      builder (~> 3.1.0)
+    activerecord (4.0.13)
+      activemodel (= 4.0.13)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.13)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.4)
+    activesupport (4.0.13)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    appraisal (2.1.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (4.0.2)
+    aws-sdk-core (2.8.11)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.8.11)
+      aws-sdk-core (= 2.8.11)
+    aws-sigv4 (1.0.0)
+    builder (3.1.4)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.5)
+    coveralls (0.8.19)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.12.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    erubis (2.7.0)
+    i18n (0.8.1)
+    jmespath (1.3.1)
+    json (2.0.3)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (4.7.5)
+    multi_json (1.12.1)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.5.5)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.0.13)
+      actionmailer (= 4.0.13)
+      actionpack (= 4.0.13)
+      activerecord (= 4.0.13)
+      activesupport (= 4.0.13)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.13)
+      sprockets-rails (~> 2.0)
+    railties (4.0.13)
+      actionpack (= 4.0.13)
+      activesupport (= 4.0.13)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.0.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-retry (0.5.3)
+      rspec-core (> 3.3, < 3.6)
+    rspec-support (3.5.0)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (2.3.3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    term-ansicolor (1.4.1)
+      tins (~> 1.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tins (1.13.2)
+    tzinfo (0.3.53)
+    wwtd (1.3.0)
+    yard (0.9.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 4)
+  appraisal (~> 2.1)
+  bundler (~> 1.14)
+  coveralls
+  dynamoid!
+  nokogiri (~> 1.6.8.1)
+  pry (~> 0.10)
+  rails (~> 4.0.0)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rspec-retry
+  wwtd (~> 1.3)
+  yard
+
+BUNDLED WITH
+   1.14.6

data/gemfiles/rails_4_1.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.1.0"
+# Still tested against Ruby 2.0.0, which can't install nokogiri 1.7+
+gem "nokogiri", "~> 1.6.8.1"
+
+gemspec :path => "../"

data/gemfiles/rails_4_1.gemfile.lock

@@ -0,0 +1,154 @@
+PATH
+  remote: ..
+  specs:
+    dynamoid (1.3.0)
+      activemodel (>= 4)
+      aws-sdk-resources (~> 2)
+      concurrent-ruby (>= 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.16)
+      actionpack (= 4.1.16)
+      actionview (= 4.1.16)
+      mail (~> 2.5, >= 2.5.4)
+    actionpack (4.1.16)
+      actionview (= 4.1.16)
+      activesupport (= 4.1.16)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.16)
+      activesupport (= 4.1.16)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.16)
+      activesupport (= 4.1.16)
+      builder (~> 3.1)
+    activerecord (4.1.16)
+      activemodel (= 4.1.16)
+      activesupport (= 4.1.16)
+      arel (~> 5.0.0)
+    activesupport (4.1.16)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    appraisal (2.1.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (5.0.1.20140414130214)
+    aws-sdk-core (2.8.11)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.8.11)
+      aws-sdk-core (= 2.8.11)
+    aws-sigv4 (1.0.0)
+    builder (3.2.3)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.5)
+    coveralls (0.8.19)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.12.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    erubis (2.7.0)
+    i18n (0.8.1)
+    jmespath (1.3.1)
+    json (1.8.6)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.5.5)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.1.16)
+      actionmailer (= 4.1.16)
+      actionpack (= 4.1.16)
+      actionview (= 4.1.16)
+      activemodel (= 4.1.16)
+      activerecord (= 4.1.16)
+      activesupport (= 4.1.16)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.16)
+      sprockets-rails (~> 2.0)
+    railties (4.1.16)
+      actionpack (= 4.1.16)
+      activesupport (= 4.1.16)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.0.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-retry (0.5.3)
+      rspec-core (> 3.3, < 3.6)
+    rspec-support (3.5.0)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (2.3.3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    term-ansicolor (1.4.1)
+      tins (~> 1.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tins (1.13.2)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    wwtd (1.3.0)
+    yard (0.9.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 4)
+  appraisal (~> 2.1)
+  bundler (~> 1.14)
+  coveralls
+  dynamoid!
+  nokogiri (~> 1.6.8.1)
+  pry (~> 0.10)
+  rails (~> 4.1.0)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rspec-retry
+  wwtd (~> 1.3)
+  yard
+
+BUNDLED WITH
+   1.14.6