dynomite 1.0.9 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 071e6c1ee0bb76726ab666edb5ea866bcd290b310c5e2c3e83f2fa57cca9ca2e
-  data.tar.gz: 10d559b3073cf2a325aeb9861b80b0cb62c872881f3de96a1eecebc0bc5f1a53
+  metadata.gz: b15b33b315b312ab9d3b277d49b91601a2a873de2f381a2cc12085b30f784df0
+  data.tar.gz: 46636c01df3e78e6470e01b81fb829e1a379d3193dd276b0905ebd1af36ff94d
 SHA512:
-  metadata.gz: 4cadb8ab579bc8097355dbeedd107c3507f27862698a9caacce2fbf0e138d8a93c0855231f6ceb89d5700e85440395324922bf5b05351d4fa2b4585e50b5d9e6
-  data.tar.gz: 5063b5f792153f649a447fc0676dd74877f1c070ac3fe820f912bf4d596d0218060c443f67e9abe5d452c9c0b52ffe5c6b02bbe29e3db750f562fc5650494cf4
+  metadata.gz: 50bc0730c3dad8654ae6323c98984e8c492d8d3bbccd9bf119ca1454ed50e9f4d183f51a822143e2e0bfa88902807d3d52497f913b736c0f126a748d065c0713
+  data.tar.gz: f54b0f900e63317ea9dfc9cc68ef6ccda244939f146497d5d783dcf1abc24526b7da0334dbcc67fd5d05a8c0cdd167b324e4b247c6cfe447a9d8faf83dfddb12

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [1.1.0]
+- Merge pull request #5 from tongueroo/fix-index-creation
+- fix index creation dsl among other things
+
 ## [1.0.9]
 - allow item.replace(hash) to work
 - Merge pull request #3 from mveer99/patch-1 Update comments: Fixed typo in project_name

data/docs/migrations/short-example.rb

@@ -3,14 +3,19 @@ class CreateCommentsMigration < Dynomite::Migration
     create_table :comments do |t|
       t.partition_key "post_id:string" # required
       t.sort_key  "created_at:string" # optional
-      t.provisioned_throughput(5) # sets both read and write, defaults to 5 when not set
+      t.provisioned_throughput(1) # sets both read and write, defaults to 5 when not set
 
       t.lsi do |i|
-        i.partition_key "user_id:string"
-        i.sort_key "updated_at:string" # optional
-
-        i.provisioned_throughput(10)
+        i.partition_key "post_id:string"
+        i.sort_key "updated_at:string" # required for lsi
+        i.provisioned_throughput(2)
       end
+
+      # t.gsi do |i|
+      #   i.partition_key "post_id:string"
+      #   i.sort_key "deleted_at:string" # optional for gsi
+      #   i.provisioned_throughput(2)
+      # end
     end
   end
 end
@@ -20,13 +25,12 @@ class UpdateCommentsMigration < Dynomite::Migration
     update_table :comments do |t|
       t.gsi(:create) do |i|
         i.partition_key "post_id:string"
-        i.sort_key "updated_at:string" # optional
-
-        i.provisioned_throughput(10)
+        i.sort_key "flagged_at:string" # optional for gsi
+        i.provisioned_throughput(3)
       end
 
       t.gsi(:update, "update-me-index") do |i|
-        i.provisioned_throughput(10)
+        i.provisioned_throughput(5)
       end
 
       t.gsi(:delete, "delete-me-index")

data/lib/dynomite/migration/dsl.rb

@@ -35,7 +35,7 @@ class Dynomite::Migration
     #   i.partition_key = "category:string"
     #   i.sort_key = "created_at:string" # optional
     # end
-    def gsi(action, index_name=nil, &block)
+    def gsi(action=:create, index_name=nil, &block)
       gsi_index = GlobalSecondaryIndex.new(action, index_name, &block)
       @gsi_indexes << gsi_index # store @gsi_index for the parent Dsl to use
     end
@@ -50,7 +50,7 @@ class Dynomite::Migration
       lsi_index = LocalSecondaryIndex.new(index_name, &block)
       @lsi_indexes << lsi_index # store @lsi_index for the parent Dsl to use
     end
-    alias_method :local_secondary_index, :gsi
+    alias_method :local_secondary_index, :lsi
 
     def evaluate
       return if @evaluated
@@ -74,6 +74,9 @@ class Dynomite::Migration
     end
 
     def params_create_table
+      merge_lsi_attribute_definitions!
+      merge_gsi_attribute_definitions!
+
       params = {
         table_name: namespaced_table_name,
         key_schema: @key_schema,
@@ -81,14 +84,31 @@ class Dynomite::Migration
         provisioned_throughput: @provisioned_throughput
       }
 
-      params[:local_secondary_index_creates] = local_secondary_index_creates unless @lsi_indexes.empty?
+      params[:local_secondary_indexes] = lsi_secondary_index_creates unless @lsi_indexes.empty?
+      params[:global_secondary_indexes] = gsi_secondary_index_creates unless @gsi_indexes.empty?
+      params
+    end
+
+    def params_update_table
+      merge_gsi_attribute_definitions!
+
+      params = {
+        table_name: namespaced_table_name,
+        attribute_definitions: @attribute_definitions,
+        # update table take values only some values for the "parent" table
+        # no key_schema, update_table does not handle key_schema for the "parent" table
+      }
+      # only set "parent" table provisioned_throughput if user actually invoked
+      # it in the dsl
+      params[:provisioned_throughput] =  @provisioned_throughput if @provisioned_throughput_set_called
+      params[:global_secondary_index_updates] = global_secondary_index_updates
       params
     end
 
     # Goes thorugh all the lsi_indexes that have been built up in memory.
     # Find the lsi object that creates an index and then grab the
     # attribute_definitions from it.
-    def lsi_create_attribute_definitions
+    def merge_lsi_attribute_definitions!
       lsi = @lsi_indexes.first # DynamoDB only supports adding one index at a time anyway. The reason @lsi_indexes is an Array is because we're sharing the same class code for LSI and GSI
       if lsi
         lsi.evaluate # force early evaluate since we need the params to
@@ -100,7 +120,7 @@ class Dynomite::Migration
                   else
                     @attribute_definitions
                   end
-      all_attrs.uniq
+      @attribute_definitions = all_attrs.uniq
     end
 
     # maps each lsi to the hash structure expected by dynamodb update_table
@@ -111,40 +131,42 @@ class Dynomite::Migration
     #   { delete: {...} }
     def lsi_secondary_index_creates
       @lsi_indexes.map do |lsi|
-        { lsi.action => lsi.params }
+        lsi.params
       end
     end
 
-    def params_update_table
-      params = {
-        table_name: namespaced_table_name,
-        attribute_definitions: gsi_create_attribute_definitions,
-        # update table take values only some values for the "parent" table
-        # no key_schema, update_table does not handle key_schema for the "parent" table
-      }
-      # only set "parent" table provisioned_throughput if user actually invoked
-      # it in the dsl
-      params[:provisioned_throughput] =  @provisioned_throughput if @provisioned_throughput_set_called
-      params[:global_secondary_index_updates] = global_secondary_index_updates
-      params
+    # maps each lsi to the hash structure expected by dynamodb update_table
+    # under the global_secondary_index_updates key:
+    #
+    #   { create: {...} }
+    #   { update: {...} }
+    #   { delete: {...} }
+    def gsi_secondary_index_creates
+      @gsi_indexes.map do |gsi|
+        gsi.params
+      end
     end
 
     # Goes thorugh all the gsi_indexes that have been built up in memory.
     # Find the gsi object that creates an index and then grab the
     # attribute_definitions from it.
-    def gsi_create_attribute_definitions
-      gsi = @gsi_indexes.find { |gsi| gsi.action == :create }
+    def merge_gsi_attribute_definitions!
+      gsi_attrs = []
+
+      gsi = @gsi_indexes.find { |i| i.action == :create }
       if gsi
         gsi.evaluate # force early evaluate since we need the params to
           # add: gsi_attribute_definitions + gsi_attrs
         gsi_attrs = gsi.attribute_definitions
       end
-      all_attrs = if gsi_attrs
-                    gsi_attribute_definitions + gsi_attrs
-                  else
-                    gsi_attribute_definitions
-                  end
-      all_attrs.uniq
+
+      # Merge existing attributes for update table
+      all_gsi_attrs = @method_name == :update_table ?
+        gsi_attribute_definitions + gsi_attrs :
+        gsi_attrs
+
+      all_attrs = (@attribute_definitions + all_gsi_attrs).uniq
+      @attribute_definitions = all_attrs
     end
 
     # maps each gsi to the hash structure expected by dynamodb update_table

data/lib/dynomite/migration/dsl/base_secondary_index.rb

@@ -62,7 +62,8 @@ class Dynomite::Migration::Dsl
         }
       end
 
-      if [:create, :update].include?(@action)
+      if self.is_a?(GlobalSecondaryIndex) && [:create, :update].include?(@action)
+        # provisioned_throughput is required for gsi index definition
         params[:provisioned_throughput] = @provisioned_throughput
       end
 

data/lib/dynomite/migration/executor.rb

@@ -19,11 +19,19 @@ class Dynomite::Migration
         # Examples:
         #   result = db.create_table(@params)
         #   result = db.update_table(@params)
+
+        # Leaving this verbose output in here until this DSL is more hardened to help debug
+        unless ENV['DYNOMITE_ENV'] == 'test'
+          puts "Calling #{@method_name} with params:"
+          pp @params
+        end
+
+        return if ENV['DYNOMITE_DRY'] # dry run flag
         result = db.send(@method_name, @params)
 
         puts "DynamoDB Table: #{@table_name} Status: #{result.table_description.table_status}"
       rescue Aws::DynamoDB::Errors::ServiceError => error
-        puts "Unable to #{@method_name.to_s.gsub('_',' ')}: #{error.message}"
+        puts "Unable to #{@method_name.to_s.gsub('_',' ')}: #{error.message}".colorize(:red)
       end
     end
   end

data/lib/dynomite/version.rb

@@ -1,3 +1,3 @@
 module Dynomite
-  VERSION = "1.0.9"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynomite
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.1.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-06 00:00:00.000000000 Z
+date: 2019-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport