dynomite 1.2.7 → 2.0.0

data/lib/jets/commands/dynamodb_command.rb

@@ -0,0 +1,29 @@
+require "dynomite"
+
+module Jets::Command
+  class Dynamodb < Base
+    desc "migrate", "Runs migrations"
+    long_desc Help.text('dynamodb:migrate')
+    def migrate
+      Jets.boot
+      Dynomite::Migration::Runner.new(options).run
+    end
+
+    desc "generate NAME", "Creates a migration for a DynamoDB table"
+    long_desc Help.text('dynamodb:generate')
+    option :action, desc: "create_table, update_table, delete_table. Defaults to convention based on the name of the migration."
+    option :partition_key, default: "id", desc: "table's partition key"
+    option :sort_key, default: nil, desc: "table's sort key"
+    option :table_name, desc: "override the the conventional table name"
+    def generate(name)
+      Dynomite::Migration::Generator.new(name, options).generate
+    end
+
+    desc "seed", "Seed data"
+    long_desc Help.text('dynamodb:seed')
+    def seed
+      Jets.boot
+      Dynomite::Seed.new(options).run
+    end
+  end
+end

data/lib/jets/commands/help/generate.md

@@ -0,0 +1,33 @@
+## Examples
+
+    jets dynamodb:generate create_products --partition-key category --sort-key product_id:number
+    jets dynamodb:generate create_comments --partition-key post_id:string --sort-key created_at:string
+    jets dynamodb:generate create_posts    --partition-key id        # default attribute type is string
+    jets dynamodb:generate create_posts    --partition-key id:number # attribute type will be number
+
+## Running migrations
+
+    $ jets dynamodb:migrate
+
+To add global secondary indexes:
+
+    $ jets dynamodb:generate update_comments --partition-key user_id:string --sort-key created_at:string
+
+To run:
+
+    $ jets dynamodb:migrate
+
+## Conventions
+
+A create_table or update_table migration file is generated based name you provide.  If `update` is included in the name then an update_table migration table is generated. If `create` is included in the name then a create_table migration table is generated.
+
+The table_name is also inferred from the migration name you provide.  Examples:
+
+    $ jets dynamodb:generate create_posts    # table_name: posts
+    $ jets dynamodb:generate update_comments # table_name: comments
+
+You can override both of these conventions:
+
+    $ jets dynamodb:generate create_my_posts --table-name posts
+    $ jets dynamodb:generate my_posts --action create_table --table-name posts
+    $ jets dynamodb:generate my_posts --action update_table --table-name posts

data/lib/jets/commands/help/migrate.md

@@ -0,0 +1,3 @@
+## Examples
+
+    jets dynamodb:migrate

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: dynomite
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 2.0.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-12 00:00:00.000000000 Z
+date: 2023-12-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: memoist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +122,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cli_markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,10 +192,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ActiveRecord-ish Dynamodb Model
+description: 
 email:
 - tongueroo@gmail.com
-executables: []
+executables:
+- dynomite
 extensions: []
 extra_rdoc_files: []
 files:
@@ -105,35 +204,120 @@ files:
 - ".rspec"
 - CHANGELOG.md
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- docs/migrations/long-example.rb
-- docs/migrations/short-example.rb
 - dynomite.gemspec
+- exe/dynomite
 - lib/dynomite.rb
+- lib/dynomite/associations.rb
+- lib/dynomite/associations/association.rb
+- lib/dynomite/associations/belongs_to.rb
+- lib/dynomite/associations/has_and_belongs_to_many.rb
+- lib/dynomite/associations/has_many.rb
+- lib/dynomite/associations/has_one.rb
+- lib/dynomite/associations/many_association.rb
+- lib/dynomite/associations/single_association.rb
+- lib/dynomite/autoloader.rb
+- lib/dynomite/cli.rb
+- lib/dynomite/client.rb
+- lib/dynomite/command.rb
+- lib/dynomite/completer.rb
+- lib/dynomite/completer/script.rb
+- lib/dynomite/completer/script.sh
+- lib/dynomite/config.rb
 - lib/dynomite/core.rb
-- lib/dynomite/db_config.rb
+- lib/dynomite/engine.rb
 - lib/dynomite/erb.rb
-- lib/dynomite/errors.rb
+- lib/dynomite/error.rb
+- lib/dynomite/help.rb
+- lib/dynomite/help/completion.md
+- lib/dynomite/help/completion_script.md
+- lib/dynomite/help/migrate.md
+- lib/dynomite/install.rb
 - lib/dynomite/item.rb
-- lib/dynomite/log.rb
+- lib/dynomite/item/abstract.rb
+- lib/dynomite/item/components.rb
+- lib/dynomite/item/dsl.rb
+- lib/dynomite/item/id.rb
+- lib/dynomite/item/indexes.rb
+- lib/dynomite/item/indexes/finder.rb
+- lib/dynomite/item/indexes/index.rb
+- lib/dynomite/item/indexes/primary_index.rb
+- lib/dynomite/item/locking.rb
+- lib/dynomite/item/magic_fields.rb
+- lib/dynomite/item/primary_key.rb
+- lib/dynomite/item/query.rb
+- lib/dynomite/item/query/delegates.rb
+- lib/dynomite/item/query/params.rb
+- lib/dynomite/item/query/params/base.rb
+- lib/dynomite/item/query/params/expression_attribute.rb
+- lib/dynomite/item/query/params/filter.rb
+- lib/dynomite/item/query/params/function/attribute_exists.rb
+- lib/dynomite/item/query/params/function/attribute_type.rb
+- lib/dynomite/item/query/params/function/base.rb
+- lib/dynomite/item/query/params/function/begins_with.rb
+- lib/dynomite/item/query/params/function/contains.rb
+- lib/dynomite/item/query/params/function/size_fn.rb
+- lib/dynomite/item/query/params/helpers.rb
+- lib/dynomite/item/query/params/key_condition.rb
+- lib/dynomite/item/query/partiql.rb
+- lib/dynomite/item/query/partiql/executer.rb
+- lib/dynomite/item/query/relation.rb
+- lib/dynomite/item/query/relation/chain.rb
+- lib/dynomite/item/query/relation/comparision_expression.rb
+- lib/dynomite/item/query/relation/comparision_map.rb
+- lib/dynomite/item/query/relation/delete.rb
+- lib/dynomite/item/query/relation/ids.rb
+- lib/dynomite/item/query/relation/math.rb
+- lib/dynomite/item/query/relation/where_field.rb
+- lib/dynomite/item/query/relation/where_group.rb
+- lib/dynomite/item/read.rb
+- lib/dynomite/item/read/find.rb
+- lib/dynomite/item/read/find_with_event.rb
+- lib/dynomite/item/sti.rb
+- lib/dynomite/item/table_namespace.rb
+- lib/dynomite/item/typecaster.rb
+- lib/dynomite/item/waiter_methods.rb
+- lib/dynomite/item/write.rb
+- lib/dynomite/item/write/base.rb
+- lib/dynomite/item/write/delete_item.rb
+- lib/dynomite/item/write/put_item.rb
+- lib/dynomite/item/write/update_item.rb
 - lib/dynomite/migration.rb
-- lib/dynomite/migration/common.rb
 - lib/dynomite/migration/dsl.rb
-- lib/dynomite/migration/dsl/base_secondary_index.rb
-- lib/dynomite/migration/dsl/global_secondary_index.rb
-- lib/dynomite/migration/dsl/local_secondary_index.rb
-- lib/dynomite/migration/executor.rb
+- lib/dynomite/migration/dsl/accessor.rb
+- lib/dynomite/migration/dsl/index.rb
+- lib/dynomite/migration/dsl/index/base.rb
+- lib/dynomite/migration/dsl/index/gsi.rb
+- lib/dynomite/migration/dsl/index/lsi.rb
+- lib/dynomite/migration/dsl/primary_key.rb
+- lib/dynomite/migration/dsl/provisioned_throughput.rb
+- lib/dynomite/migration/file_info.rb
 - lib/dynomite/migration/generator.rb
+- lib/dynomite/migration/helpers.rb
+- lib/dynomite/migration/internal/migrate/create_schema_migrations.rb
+- lib/dynomite/migration/internal/models/schema_migration.rb
+- lib/dynomite/migration/runner.rb
 - lib/dynomite/migration/templates/create_table.rb
+- lib/dynomite/migration/templates/delete_table.rb
 - lib/dynomite/migration/templates/update_table.rb
 - lib/dynomite/query.rb
 - lib/dynomite/reserved_words.rb
+- lib/dynomite/seed.rb
+- lib/dynomite/types.rb
 - lib/dynomite/version.rb
+- lib/dynomite/waiter.rb
+- lib/generators/application_item/application_item_generator.rb
+- lib/generators/application_item/templates/application_item.rb.tt
+- lib/jets/commands/dynamodb_command.rb
+- lib/jets/commands/help/generate.md
+- lib/jets/commands/help/migrate.md
 homepage: https://github.com/tongueroo/dynomite
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -150,8 +334,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.12
+rubygems_version: 3.4.20
 signing_key: 
 specification_version: 4
-summary: ActiveRecord-ish Dynamodb Model
+summary: ActiveRecord-ish DynamoDB ORM
 test_files: []

data/docs/migrations/long-example.rb

@@ -1,127 +0,0 @@
-# Note: table name created will be namespaced based on
-# Dynomite::Migration.table_namespace.  This can be set in
-# config/dynamodb.yml
-#
-# development:
-#   table_namespace: "mynamespace"
-#
-# This results in:
-#   create_table "posts"
-# Produces:
-#   table name: "mynamespace-posts"
-#
-# When you're in a in Jets project you can set the namespace based on
-# Jets.config.table_namespace, which is based on the project name and
-# a short version of the environment.  Example:
-#
-# `config/dynamodb.yml`:
-# development:
-#   table_namespace: <%= Jets.config.table_namespace %>
-#
-# If your project_name is demo and environment is production:
-#   create_table "posts" => table name: "demo-prod-posts"
-#
-# If your project_name is demo and environment is staging:
-#   create_table "posts" => table name: "demo-stag-posts"
-#
-# If your project_name is demo and environment is development:
-#   create_table "posts" => table name: "demo-dev-posts"
-#
-# If the table_namespace is set to a blank string or nil, then a namespace
-# will not be prepended at all.
-
-class CreateCommentsMigration < Dynomite::Migration
-  def up
-    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
-
-      # Instead of using partition_key and sort_key you can set the
-      # key schema directly also
-      # t.key_schema([
-      #     {attribute_name: "id", :key_type=>"HASH"},
-      #     {attribute_name: "created_at", :key_type=>"RANGE"}
-      #   ])
-      # t.attribute_definitions([
-      #   {attribute_name: "id", attribute_type: "N"},
-      #   {attribute_name: "created_at", attribute_type: "S"}
-      # ])
-
-      # other ways to set provisioned_throughput
-      # t.provisioned_throughput(:read, 10)
-      # t.provisioned_throughput(:write, 10)
-      # t.provisioned_throughput(
-      #   read_capacity_units: 5,
-      #   write_capacity_units: 5
-      # )
-
-      # set the billing mode to on-demand (NOTE: this overrides provisioned_throughput)
-      # t.billing_mode(:pay_per_request)
-    end
-  end
-end
-
-class UpdateCommentsMigration < Dynomite::Migration
-  def up
-    update_table :comments do |t|
-      # You can update from provisioned_throughput to on-demand pricing
-      # t.billing_mode(:pay_per_request)
-
-      # t.global_secondary_index do
-      # t.gsi(METHOD, INDEX_NAME) do
-
-      # You normally create an index like so:
-      #
-      #  t.gsi(:create) do |i|
-      #    i.partition_key = "post_id:string" # partition_key is required
-      #    i.sort_key = "updated_at:string" # sort_key is optional
-      #  end
-      #
-      # The index name will be inferred from the partition_key and sort_key when
-      # not explicitly set.  Examples:
-      #
-      #   index_name = "#{partition_key}-#{sort_key}-index"
-      #   index_name = "post_id-index" # no sort key
-      #   index_name = "post_id-updated_at-index" # has sort key
-      #
-      # The inference allows you to not have to worry about the index
-      # naming scheme. You can still set the index_name explicitly like so:
-      #
-      #  t.gsi(:create, "post_id-updated_at-index") do |i|
-      #    i.partition_key = "post_id:string" # partition_key is required
-      #    i.sort_key = "updated_at:string" # sort_key is optional
-      #  end
-      #
-      t.gsi(:create) do |i|
-        i.partition_key "post_id:string"
-        i.sort_key "updated_at:string" # optional
-
-        # translates to
-        # i.key_schema({...})
-        # also makes sure that the schema_keys are added to the attributes_definitions
-
-        # t.projected_attributes(:all) # default if not called
-        # t.projected_attributes(:keys_only) # other ways to call
-        # t.projected_attributes([:id, :body, :tags, :updated_at])
-        # translates to:
-        # Valid Values: ALL | KEYS_ONLY | INCLUDE
-        # t.projection(
-        #   projection_type: :all, # defaults to all
-        # )
-        # t.projection(
-        #   projection_type: :include, # defaults to all
-        #   non_key_attributes: [:id, :body, :tags, :updated_at], # defaults to all
-        # )
-
-        i.provisioned_throughput(10)
-      end
-
-      t.gsi(:update, "category-index") do |i|
-        i.provisioned_throughput(10)
-      end
-
-      t.gsi(:delete, "category-index")
-    end
-  end
-end

data/docs/migrations/short-example.rb

@@ -1,40 +0,0 @@
-class CreateCommentsMigration < Dynomite::Migration
-  def up
-    create_table :comments do |t|
-      t.partition_key "post_id:string" # required
-      t.sort_key  "created_at:string" # optional
-      t.provisioned_throughput(1) # sets both read and write, defaults to 5 when not set
-
-      t.lsi do |i|
-        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
-
-class UpdateCommentsMigration < Dynomite::Migration
-  def up
-    update_table :comments do |t|
-      t.gsi(:create) do |i|
-        i.partition_key "post_id:string"
-        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(5)
-      end
-
-      t.gsi(:delete, "delete-me-index")
-    end
-  end
-end
-

data/lib/dynomite/db_config.rb

@@ -1,121 +0,0 @@
-require "aws-sdk-dynamodb"
-require 'fileutils'
-require 'erb'
-require 'yaml'
-
-module Dynomite::DbConfig
-  def self.included(base)
-    base.extend(ClassMethods)
-  end
-
-  def db
-    self.class.db
-  end
-
-  # NOTE: Class including Dynomite::DbConfig is required to have table_name method defined
-  def namespaced_table_name
-    [self.class.table_namespace, table_name].reject {|s| s.nil? || s.empty?}.join('-')
-  end
-
-  module ClassMethods
-    @@db = nil
-    def db
-      return @@db if @@db
-
-      config = db_config
-      endpoint = ENV['DYNAMODB_ENDPOINT'] || config['endpoint']
-      check_dynamodb_local!(endpoint)
-
-      # Normally, do not set the endpoint to use the current configured region.
-      # Probably want to stay in the same region anyway for db connections.
-      #
-      # List of regional endpoints: https://docs.aws.amazon.com/general/latest/gr/rande.html#ddb_region
-      # Example:
-      #   endpoint: https://dynamodb.us-east-1.amazonaws.com
-      options = endpoint ? { endpoint: endpoint } : {}
-      @@db ||= Aws::DynamoDB::Client.new(options)
-    end
-
-    # When endoint has been configured to point at dynamodb local: localhost:8000
-    # check if port 8000 is listening and timeout quickly. Or else it takes a
-    # for DynamoDB local to time out, about 10 seconds...
-    # This wastes less of the users time.
-    def check_dynamodb_local!(endpoint)
-      return unless endpoint && endpoint.include?("8000")
-      
-      host, port = endpoint.gsub("http://", "").split(":")
-      ip = get_endpoint_ip(host)
-      unless ip
-        raise "You have configured your app to use DynamoDB local, but it is not running on the host: #{host}."
-      end       
-      
-      open = port_open?(ip, 8000, 0.2)
-      unless open
-        raise "You have configured your app to use DynamoDB local, but it is not running.  Please start DynamoDB local. Example: brew install --cask dynamodb-local && dynamodb-local"
-      end
-    end
-    
-    def get_endpoint_ip(host)
-      begin
-        IPSocket.getaddress(host)
-      rescue SocketError
-        false # Can return anything you want here
-      end
-    end
-
-    # Thanks: https://gist.github.com/ashrithr/5305786
-    def port_open?(ip, port, seconds=1)
-      # => checks if a port is open or not
-      Timeout::timeout(seconds) do
-        begin
-          TCPSocket.new(ip, port).close
-          true
-        rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, SocketError
-          false
-        end
-      end
-    rescue Timeout::Error
-      false
-    end
-
-    # useful for specs
-    def db=(db)
-      @@db = db
-    end
-
-    def db_config
-      return @db_config if @db_config
-
-      if defined?(Jets)
-        config_path = "#{Jets.root}/config/dynamodb.yml"
-        env = Jets.env
-      else
-        config_path = ENV['DYNOMITE_CONFIG'] || "./config/dynamodb.yml"
-        env = ENV['DYNOMITE_ENV'] || "development"
-      end
-
-      config = YAML.load(Dynomite::Erb.result(config_path))
-      @db_config ||= config[env] || {}
-    end
-
-    def table_namespace(*args)
-      case args.size
-      when 0
-        get_table_namespace
-      when 1
-        set_table_namespace(args[0])
-      end
-    end
-
-    def get_table_namespace
-      return @table_namespace if defined?(@table_namespace)
-
-      config = db_config
-      @table_namespace = config['table_namespace']
-    end
-
-    def set_table_namespace(value)
-      @table_namespace = value
-    end
-  end
-end

data/lib/dynomite/errors.rb

@@ -1,15 +0,0 @@
-module Dynomite
-  module Errors
-    class ValidationError < StandardError
-      def initialize(msg)
-        super
-      end
-    end
-
-    class ReservedWordError < StandardError
-      def initialize(msg)
-        super
-      end
-    end
-  end
-end

data/lib/dynomite/log.rb

@@ -1,15 +0,0 @@
-module Dynomite::Log
-  def self.included(base)
-    base.extend(ClassMethods)
-  end
-
-  def log(msg)
-    self.class.log(msg)
-  end
-
-  module ClassMethods
-    def log(msg)
-      Dynomite.logger.info(msg)
-    end
-  end
-end