dynamodb-migration 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74e3e254ecd09009114274031548f14690803466
-  data.tar.gz: abfbffb5f2a6612f483e5e7958e3fa36ac70e5a6
+  metadata.gz: 5dcad159e3025aaac1ec6e9cc97458875305c5e3
+  data.tar.gz: 77bb1576c448f3bbf3bf32bf26c80d3acd10c3ab
 SHA512:
-  metadata.gz: b0631860e3d249170eceb2b7b295dbda23986f7006b43a11e1770011306d0a67e493fc36b5cea13f0c9d0ce35471d5f4b8ac3d6f8729686bb55f1aedd62de17c
-  data.tar.gz: d7108c070a794dae4769ad5ad8a463a5b99a572834060b9ca8d8c8cd97c94d0c32c61f0855fce7e56186b2b4b553b2a2d67cdf85ecb7db57b00ea698c081299b
+  metadata.gz: 0b25d44cb893e76b70d750e63c5f859cd16f5edeb41d554b46873cb1d1fe56566873fe27c7ac559608161e40e181c65758790a6686f822b5a54f5f7734b5a600
+  data.tar.gz: 944824a9cc82b84f98da673db93530ed290d101be8ea585dbc35e7c4faf28e005f1d8069934e203dd87079be2ee79044db44e6d5279f85d11cfe81870350e259

data/README.md

@@ -1,10 +1,10 @@
-[![Gem Version](https://badge.fury.io/rb/dynamodb-client.svg)](https://badge.fury.io/rb/dynamodb-client)
+[![Gem Version](https://badge.fury.io/rb/dynamodb-migration.svg)](https://badge.fury.io/rb/dynamodb-migration)
 # DynamoDB::Migration
 
-Allows for the creation of simple DynamoDB commands that will be executed only
-once against a DynamoDB database to allow you to "migrate" the schema of the
-database over time. This is a simple implementation for DynamoDB, similar to
-tools such as FlywayDB and Active Record Migrations.
+Allows for the creation of simple DynamoDB migrations that will be executed
+only once against a DynamoDB database to allow you to "migrate" the schema of
+the database over time. This is a simple implementation for DynamoDB, similar
+to tools such as FlywayDB and Active Record Migrations.
 
 ## Installation
 
@@ -30,8 +30,9 @@ In a rake task or in your applications start up, simply add:
 require 'dynamodb/migration'
 
 options = {
-  client: dynamodb_client,        # an Aws::DynamoDB::Client instance
-  path: '~/my_project/migrations' # the full path to the folder where your migration classes will live
+  client: dynamodb_client,           # an Aws::DynamoDB::Client instance
+  path: '/app/my_project/migrations' # the full path to the folder where your migration classes will live
+  migration_table_name: 'migrations' # optional, the name of the table to use for migrations, default is "migrations"
 }
 DynamoDB::Migration.run_all_migrations(options)
 ```
@@ -46,6 +47,10 @@ require 'dynamodb/migration'
 # next to config.ru
 set :migrations_path, File.join(File.dirname(__FILE__), 'migrations')
 
+# optional, the name of the table to use for migrations, default is
+# "migrations"
+set :migration_table_name, 'migrations'
+
 # registering the below requires the "dynamodb-client" gem, alternatively
 # you can return a Aws::DynamoDB::Client instance from a method named
 # `dynamodb_client`
@@ -93,8 +98,9 @@ end
 ```
 
 DynamoDB::Migration will detect this class and execute once against your
-DynamoDB instance. It will record the execution in a table called `migrations`
-which it creates and maintains internally.
+DynamoDB instance. It will record the execution in a table specified by the
+option `:migration_table_name` (`migrations` by default) which it
+creates and maintains internally.
 
 ## Development
 
@@ -116,9 +122,7 @@ be a safe, welcoming space for collaboration, and contributors are expected to
 adhere to the [Contributor Covenant](http://contributor-covenant.org) code of
 conduct.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT
 License](http://opensource.org/licenses/MIT).
-

data/lib/dynamodb/migration.rb

@@ -4,20 +4,23 @@ require "dynamodb/migration/unit"
 
 module DynamoDB
   module Migration
-    def self.registered(app)
-      options = {
-        client: app.dynamodb_client,
-        path:   app.settings.migrations_path,
-      }
-      run_all_migrations(options)
-    end
+    class << self
+      def registered(app)
+        options = {
+          client:                 app.dynamodb_client,
+          path:                   app.settings.migrations_path,
+          migration_table_name:   app.settings.migration_table_name,
+        }
+        run_all_migrations(options)
+      end
 
-    def self.run_all_migrations(options)
-      Dir.glob("#{options[:path]}/**/*.rb").each do |file|
-        require file
+      def run_all_migrations(options)
+        Dir.glob("#{options[:path]}/**/*.rb").each do |file|
+          require file
+        end
+        Execute.new(options[:client], options[:migration_table_name])
+               .update_all
       end
-      Execute.new(options[:client])
-             .update_all
     end
   end
 end

data/lib/dynamodb/migration/execute.rb

@@ -1,8 +1,11 @@
 module DynamoDB
   module Migration
     class Execute
-      def initialize(client)
+      DEFAULT_MIGRATION_TABLE_NAME = 'migrations'
+
+      def initialize(client, migration_table_name)
         @client = client
+        @migration_table_name = migration_table_name
       end
 
       def update_all
@@ -30,7 +33,7 @@ module DynamoDB
 
       def record_failed_migration(clazz)
         client.delete_item({
-          table_name: "migrations",
+          table_name: migration_table_name,
           key: {
             "file" => clazz_filename(clazz),
           },
@@ -43,7 +46,7 @@ module DynamoDB
 
       def record_start_migration(clazz)
         client.put_item({
-          table_name: "migrations",
+          table_name: migration_table_name,
           item: {
             "file" => clazz_filename(clazz),
             "executed_at" => Time.now.iso8601,
@@ -57,7 +60,7 @@ module DynamoDB
 
       def record_successful_migration(clazz)
         client.update_item({
-          table_name: "migrations",
+          table_name: migration_table_name,
           key: {
             "file" => clazz_filename(clazz),
           },
@@ -87,7 +90,7 @@ module DynamoDB
 
       def migration_executed?(clazz)
         client.get_item({
-          table_name: "migrations",
+          table_name: migration_table_name,
           key: {
             "file" => clazz_filename(clazz),
           },
@@ -98,7 +101,7 @@ module DynamoDB
 
       def ensure_migrations_table_exists
         client.create_table(
-          table_name: "migrations",
+          table_name: migration_table_name,
           attribute_definitions: [
             {
               attribute_name: "file",
@@ -119,7 +122,7 @@ module DynamoDB
             stream_enabled: true,
             stream_view_type: "NEW_AND_OLD_IMAGES",
           },
-        ) unless table_exists?(client, 'migrations')
+        ) unless table_exists?(client, migration_table_name)
       end
 
       def table_exists?(client, table_name)
@@ -127,6 +130,12 @@ module DynamoDB
       rescue Aws::DynamoDB::Errors::ResourceNotFoundException => e
         false
       end
+
+      def migration_table_name
+        @migration_table_name ||
+          ENV['DYNAMODB_MIGRATION_TABLE_NAME'] ||
+          DEFAULT_MIGRATION_TABLE_NAME
+      end
     end
   end
 end

data/lib/dynamodb/migration/version.rb

@@ -1,5 +1,5 @@
 module DynamoDB
   module Migration
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamodb-migration
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Henry Lawson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-21 00:00:00.000000000 Z
+date: 2016-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk