dynamo-record 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7fbbd08b9fb9bbcd706585dce0bf61514301ca9
-  data.tar.gz: 7c5dfdafd9205e5d14d6d63abd5383fc5a6343d3
+  metadata.gz: cc3a4024e4ef59d2f27311c320b5bf33aa91ffb4
+  data.tar.gz: 793d770c42ac639e77a0ce1e4db3ca1fd6cef2fb
 SHA512:
-  metadata.gz: 97f011ec20b9522efa7aa16b665dc2feec5e98432ee49af336de64334fcf4a2f2771e664a849c6f8b0ac4aee82634b1074e53f3a77b517b52a2d2be913badc5e
-  data.tar.gz: 6e9796415449e386eaccefabbfda6f69b9bdb92160a27b205bc9271a9791ffe0b5585cafaea5cc321ae37ed4397ea45fc151b14074fb1bcfb1af2f14da5aec4e
+  metadata.gz: 19daa6e06995bfc7d57d4c05d5454e6def992562742edc9d20b0aea56fd8011f3ca8343f9b5dcba1c5ba21b8921aa1c3ec2ce644963273e0ab992e6dc1ead98b
+  data.tar.gz: 9578863c9c36e8dfa7577af2f48b5f357eea6b7f9281c2964fa3bcde6134a02b87677769fcfde57c69ac990c808ab6f465f10304f9d84a55d5200ba68afe72b0

data/.dockerignore

@@ -0,0 +1,15 @@
+/coverage/
+/doc/
+/Dockerfile
+/docker-compose.yml
+/docker-compose.override.example.yml
+/docker-compose.override.yml
+/Gemfile.lock
+/log/
+/pkg/
+/spec/gemfiles/.bundle/
+/spec/dummy/log/
+/spec/dummy/tmp/
+/spec/gemfiles/*.gemfile.lock
+/switchman-inst-jobs-*.gem
+/tmp/

data/.gitignore

@@ -1,12 +1,16 @@
-/docker-compose.override.yml
-
 /.bundle/
+/.rspec_status
+/.ruby-version
 /.yardoc
 /_yardoc/
 /coverage/
+/docker-compose.override.yml
+/dynamo-record-*.gem
+/Gemfile.lock
 /pkg/
+/spec/gemfiles/.bundle/
+/spec/dummy/log/
+/spec/dummy/tmp/
+/spec/gemfiles/*.gemfile.lock
 /spec/reports/
 /tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1 +1,2 @@
+--color
 --require spec_helper

data/.rubocop.yml

@@ -1,13 +1,13 @@
 Rails:
   Enabled: true
 
-Rails/HttpPositionalArguments:
-  # Renable once we are on Rails v5
-  Enabled: false
-
 AllCops:
+  TargetRailsVersion: 4.2
   TargetRubyVersion: 2.3
 
+Metrics/AbcSize:
+  Max: 20 # Default: 15
+
 Metrics/ClassLength:
   Max: 200 # Default: 100
 
@@ -20,9 +20,10 @@ Metrics/MethodLength:
 Metrics/BlockLength:
   Max: 30
   Exclude:
+    - 'dynamo-record.gemspec'
     - 'spec/**/*.rb'
 
-Style/AlignParameters:
+Layout/AlignParameters:
   # Alignment of parameters in multi-line method calls.
   #
   # The `with_fixed_indentation` style aligns the following lines with one
@@ -32,24 +33,8 @@ Style/AlignParameters:
   #       b)
   EnforcedStyle: with_fixed_indentation
 
-Style/ClassAndModuleChildren:
-  # Checks the style of children definitions at classes and modules.
-  #
-  # Basically there are two different styles:
-  #
-  # `nested` - have each child on a separate line
-  #   class Foo
-  #     class Bar
-  #     end
-  #   end
-  #
-  # `compact` - combine definitions as much as possible
-  #   class Foo::Bar
-  #   end
-  #
-  # The compact style is only forced, for classes / modules with one child.
-  EnforcedStyle: nested
-  Enabled: false
+Lint/EndAlignment:
+  EnforcedStyleAlignWith: variable
 
 Style/Documentation:
   # This cop checks for missing top-level documentation of classes and modules.
@@ -58,12 +43,6 @@ Style/Documentation:
   # classes or other modules.
   Enabled: false
 
-Lint/EndAlignment:
-  AlignWith: variable
-
-Style/CaseIndentation:
-  IndentWhenRelativeTo: end
-
 Style/FrozenStringLiteralComment:
   # `when_needed` will add the frozen string literal comment to files
   # only when the `TargetRubyVersion` is set to 2.3+.
@@ -78,4 +57,4 @@ Style/FrozenStringLiteralComment:
 
 Style/NumericPredicate:
   Exclude:
-    - 'spec/**/*'
+    - 'spec/**/*.rb'

data/.travis.yml

@@ -1,5 +1,21 @@
+dist: trusty
 sudo: false
 language: ruby
+cache: bundler
+
 rvm:
-  - 2.3.0
-before_install: gem install bundler -v 1.14.6
+  - 2.3
+  - 2.4
+
+gemfile:
+  - spec/gemfiles/rails-4.2.gemfile
+  - spec/gemfiles/rails-5.0.gemfile
+  - spec/gemfiles/rails-5.1.gemfile
+
+before_install: gem update bundler
+bundler_args: --jobs 3
+install: bundle install --jobs 3
+
+script:
+  - bash -c "if [ '$TRAVIS_RUBY_VERSION' = '2.4' ] && [[ '$BUNDLE_GEMFILE' == *'rails-5.0'* ]]; then bundle exec rubocop --fail-level autocorrect; fi"
+  - bundle exec rspec

data/Dockerfile

@@ -0,0 +1,22 @@
+FROM instructure/rvm
+
+WORKDIR /app
+
+COPY dynamo-record.gemspec Gemfile /app/
+COPY lib/dynamo/record/version.rb /app/lib/dynamo/record/version.rb
+
+USER root
+RUN mkdir -p /app/coverage \
+             /app/spec/gemfiles/.bundle \
+             /app/spec/internal/log \
+ && chown -R docker:docker /app
+
+USER docker
+RUN /bin/bash -l -c "cd /app && rvm-exec 2.4 bundle install --jobs 5"
+COPY . /app
+
+USER root
+RUN chown -R docker:docker /app
+USER docker
+
+CMD /bin/bash -l -c "rvm-exec 2.4 bundle exec wwtd"

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in dynamo-record.gemspec
 gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Instructure, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,8 +1,9 @@
-# DynamoRecord
+# Dynamo::Record
 
 Provides helpful rake tasks and model extensions on top of
 [aws-record](https://github.com/aws/aws-sdk-ruby-record).
 
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -19,11 +20,12 @@ Or install it yourself as:
 
     $ gem install dynamo-record
 
+
 ## Usage
 
 ### Models
 
-In `app/models`, create a class that includes `DynamoRecord::Model` and contains
+In `app/models`, create a class that includes `Dynamo::Record::Model` and contains
 one or more of the
 [standard set](http://docs.aws.amazon.com/awssdkrubyrecord/api/Aws/Record.html)
 of attribute declarations, along with the following new composite attribute
@@ -34,9 +36,9 @@ types:
 
 An example file:
 
-```
+```ruby
 class MyModel
-  include DynamoRecord::Model
+  include Dynamo::Record::Model
   composite_string_attr(
     :model_key,
     hash_key: true,
@@ -57,7 +59,7 @@ Declaring secondary indexes are included in `aws-record` and are defined
 
 As an example, a global secondary index can be defined as follows:
 
-```
+```ruby
   global_secondary_index(
     :user_idx,
     hash_key: :user_id,
@@ -73,7 +75,7 @@ As an example, a global secondary index can be defined as follows:
 
 As an example, a local secondary index can be defined as follows:
 
-```
+```ruby
   local_secondary_index(
     :score_idx,
     range_key: :score,
@@ -98,7 +100,7 @@ Query helpers are included as class methods.
 For models that have composite attributes, create a composite key value from the
 individual attribute parts:
 
-```
+```ruby
 hash_key = MyModel.composite_key('model_1', 'account_1')
 ```
 
@@ -106,7 +108,7 @@ hash_key = MyModel.composite_key('model_1', 'account_1')
 
 Split a composite attribute value into its individual attribute parts:
 
-```
+```ruby
 model_id, acccount_id = MyModel.split_composite(hash_key)
 ```
 
@@ -115,7 +117,7 @@ model_id, acccount_id = MyModel.split_composite(hash_key)
 Find all item instances that match a given hash key value. `opts` are options
 passed to the underlying query.
 
-```
+```ruby
 MyModel.find_all_by_hash_key(hash_key)
 ```
 
@@ -124,7 +126,7 @@ MyModel.find_all_by_hash_key(hash_key)
 Find all item instances using a global secondary instance using a hash key
 value. `opts` are options passed to the underlying query.
 
-```
+```ruby
 MyModel.find_all_by_gsi_hash_key('user_idx', 'user_1')
 ```
 
@@ -133,7 +135,7 @@ MyModel.find_all_by_gsi_hash_key('user_idx', 'user_1')
 Find all item instances using a global secondary instance using a hash key value
 and range key value.
 
-```
+```ruby
 MyModel.find_all_by_gsi_hash_key('user_idx', 'user_1', 0.0)
 ```
 
@@ -142,7 +144,7 @@ MyModel.find_all_by_gsi_hash_key('user_idx', 'user_1', 0.0)
 Find all item instances using a local secondary instance using a hash key value.
 `opts` are options passed to the underlying query.
 
-```
+```ruby
 MyModel.find_all_by_lsi_hash_key('score_idx', 'user_1')
 ```
 
@@ -151,7 +153,7 @@ MyModel.find_all_by_lsi_hash_key('score_idx', 'user_1')
 Find all item instances using a local secondary instance using a hash key value
 and range key value.
 
-```
+```ruby
 MyModel.find_all_by_lsi_hash_key('score_idx', 'user_1', 0.0)
 ```
 
@@ -163,9 +165,9 @@ follows the style of standard Rails migration files like
 `YYYYMMDDHHMMSS_create_model_1.rb`. A migration file that creates a Dynamo table
 looks like:
 
-```
+```ruby
 module DynamoMigrate
-  class CreateMyModel < DynamoRecord::TableMigration
+  class CreateMyModel < Dynamo::Record::TableMigration
     def self.up
       migrate(MyModel) do |migration|
         migration.create!(
@@ -191,12 +193,68 @@ throughput of the secondary index.
 
 A migration file that creates a Dynamo stream looks like:
 
-```
+```ruby
 module DynamoMigrate
-  class AddMyModelStream < DynamoRecord::TableMigration
+  class AddMyModelStream < Dynamo::Record::TableMigration
     def self.update
       add_stream(MyModel)
     end
   end
 end
 ```
+
+
+## Development
+
+A simple docker environment has been provided for spinning up and testing this
+gem with multiple versions of Ruby. This requires docker and docker-compose to
+be installed. To get started, run the following:
+
+```bash
+./build.sh
+```
+
+This will install the gem in a docker image with all versions of Ruby installed,
+and install all gem dependencies in the Ruby 2.4 set of gems. It will also
+download and spin up a DynamoDB Local container for use with specs. Finally, it
+will run [wwtd](https://github.com/grosser/wwtd), which runs all specs across
+all supported version of Ruby and Rails, bundling gems for each combination
+along the way.
+
+The first build will take a long time, however, docker images and gems are
+cached, making additional runs significantly faster.
+
+Individual spec runs can be started like so:
+
+```bash
+docker-compose run --rm app /bin/bash -l -c \
+  "BUNDLE_GEMFILE=spec/gemfiles/rails-5.0.gemfile rvm-exec 2.4 bundle exec rspec"
+```
+
+If you'd like to mount your git checkout within the docker container running
+tests so changes are easier to test, use the override provided:
+
+```bash
+cp docker-compose.override.example.yml docker-compose.override.yml
+```
+
+
+## Making a new Release
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then just
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/instructure/dynamo-record.
+
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/build.sh

@@ -1,28 +1,18 @@
-#!/bin/bash
-
-export COMPOSE_PROJECT_NAME=dynamorecord
-export COMPOSE_FILE=docker-compose.yml
+#!/bin/bash -ex
 
 function cleanup() {
   exit_code=$?
   set +e
-  docker-compose stop test
-  docker-compose rm -fa test
-  docker rmi -f $(docker images -qf "dangling=true") &>/dev/null
+  docker cp coverage:/app/coverage .
+  docker-compose kill
+  docker-compose rm -f
   exit $exit_code
 }
 trap cleanup INT TERM EXIT
 
-set -e
-
-docker-compose build --pull
-docker-compose run --name test test
-docker cp test:/usr/src/app/coverage .
-
-#echo "Reporting test coverage"
-#if [[ $? -eq 0 && -a 'coverage/.last_run.json' ]]; then
-#  ruby_coverage=$(cat coverage/api/.last_run.json | grep 'covered_percent' | egrep -o '[0-9]+(\.[0-9]+)?')
-#  echo "Sending to gergich"
-#  gergich message ":ruby: <http://jenkins.instructure.com/job/dynamo-record/${BUILD_ID}/|${ruby_coverage}%>"
-#  gergich publish
-#fi
+docker-compose pull dynamo
+docker-compose up -d dynamo
+docker-compose build --pull app
+docker-compose run --rm app /bin/bash -l -c \
+  "rvm-exec 2.4 bundle exec rubocop --fail-level autocorrect"
+docker-compose run --name coverage app $@

data/docker-compose.override.example.yml

@@ -0,0 +1,19 @@
+version: '2'
+
+services:
+  app:
+    volumes:
+      - .:/app
+      - gems:/home/docker/.rvm/gems
+      # Disable the rest of these volumes if the container can safely write to
+      # your host filesystem mount named above. You might want to use the rest
+      # of these unless you're using dinghy on OSX (usually needed for linux).
+      - coverage:/app/coverage
+      - bundle-config:/app/spec/gemfiles/.bundle
+      - internal-log:/app/spec/internal/log
+
+volumes:
+  coverage: {}
+  bundle-config: {}
+  gems: {}
+  internal-log: {}