dynamodb-api 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3497adfb9b42e61ab127deb44c26834aff181ebe8a12e2842a49f4548f87b844
-  data.tar.gz: 9bdbb77d400193f402ae5e02502d2cd02ef39eee12f0455325b1f0bd1673c930
+  metadata.gz: 1176f23f9b8202950b14fb9f093a89a0e8a71408b07d1eee64e1cfa2f4771f68
+  data.tar.gz: '018fe530f3c0df9d3f025154569dd1958b476e1d84051b01091c4dd7f5337c9b'
 SHA512:
-  metadata.gz: ab22702e4ee21d4471a499a743bd99f15e9a2e231adbce737db77feb1c405e18ceed4ab833f602b135051a7fede6f5b1bd85ca7caba736bc5b88cb031e827999
-  data.tar.gz: 070f875b3e41688a0840ec506a3f12b04127e59d0dec90d2102e50abad14cdd742a6fccc7b274813065b9226330dc13f176d02c7144d586a57603c9df2c9d4a6
+  metadata.gz: c4da7e234eeff907f7382187281794ae788c57312b3e5d35c2ee9f7b4c2c686153d7111fa8b3633012c5dc6248c7cd41abb5e93ebf094e9d23dfd71a7cd5f270
+  data.tar.gz: 2a3e960e5d73b46d989ae006f18ecf8c4d5837b1e52d478f0b64c55ea608a04a5e7e3ccb9857e3839525629c9a6b906dc070f9ddcbb307638c5a64a421cd8aa3

data/.gitignore

@@ -10,3 +10,15 @@
 
 # rspec failure tracking
 .rspec_status
+
+.DS_Store
+.ruby-version
+Gemfile.lock
+
+# For Ctags
+tags
+
+# For Appraisals
+gemfiles/*.gemfile.lock
+gemfiles/.bundle/*
+gemfiles/vendor/*

data/.travis.yml

@@ -4,6 +4,10 @@ rvm:
   - 2.3
   - 2.4
   - 2.5
+gemfile:
+  - gemfiles/aws_sdk_2.gemfile
+  - gemfiles/aws_sdk_3.gemfile
+
 before_install: gem install bundler -v 1.16.2
 
 before_script:

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "aws-sdk-2" do
+  gem "aws-sdk", "~> 2"
+end
+
+appraise "aws-sdk-3" do
+  gem "aws-sdk", "~> 3"
+end

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.5.0] - 2018-09-30
+### Added
+- [#21](https://github.com/walkersumida/dynamodb-api/pull/21) Automatically add Expression Attribute Names
+
+### Removed
+- [#21](https://github.com/walkersumida/dynamodb-api/pull/21) `ex_attr` method

data/README.md

@@ -50,12 +50,12 @@ e.g.
 
 cars table.
 
-| maker_id(Partition key) | model | release_date(Sort key) |
-|:---|:---|:---|
-|1 |Accord |0.19760508e8 |
-|2 |CROWN |0.19550101e8 |
-|3 |Model S |0.20120601e8 |
-|1 |S2000 |0.19980101e8 |
+| maker_id(Partition key) | model | release_date(Sort key) | status |
+|:---|:---|:---|:---|
+|1 |Accord |0.19760508e8 |0 |
+|2 |CROWN |0.19550101e8 |0 |
+|3 |Model S |0.20120601e8 |0 |
+|1 |S2000 |0.19980101e8 |1 |
 
 ### Query
 https://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#query-instance_method
@@ -69,10 +69,10 @@ query.from('cars').index('index_maker_id_release_date').
 items = query.all.items
 ```
 
-| maker_id | model | release_date |
-|:---|:---|:---|
-|1 |S2000 |0.19980101e8 |
-|1 |Accord |0.19760508e8 |
+| maker_id(Partition key) | model | release_date(Sort key) | status |
+|:---|:---|:---|:---|
+|1 |S2000 |0.19980101e8 |1 |
+|1 |Accord |0.19760508e8 |0 |
 
 #### Partition key and Sort(Range) key
 
@@ -83,9 +83,9 @@ query.from('cars').index('index_maker_id_release_date').
 items = query.all.items
 ```
 
-| maker_id | model | release_date |
-|:---|:---|:---|
-|1 |S2000 |0.19980101e8 |
+| maker_id(Partition key) | model | release_date(Sort key) | status |
+|:---|:---|:---|:---|
+|1 |S2000 |0.19980101e8 |1 |
 
 #### Sorting
 
@@ -97,10 +97,10 @@ query.from('cars').index('index_maker_id_release_date').
 items = query.all.items
 ```
 
-| maker_id | model | release_date |
-|:---|:---|:---|
-|1 |Accord |0.19760508e8 |
-|1 |S2000 |0.19980101e8 |
+| maker_id(Partition key) | model | release_date(Sort key) | status |
+|:---|:---|:---|:---|
+|1 |Accord |0.19760508e8 |0 |
+|1 |S2000 |0.19980101e8 |1 |
 
 #### Filter
 
@@ -112,9 +112,9 @@ query.from('cars').index('index_maker_id_release_date').
 items = query.all.items
 ```
 
-| maker_id | model | release_date |
-|:---|:---|:---|
-|1 |S2000 |0.19980101e8 |
+| maker_id(Partition key) | model | release_date(Sort key) | status |
+|:---|:---|:---|:---|
+|1 |S2000 |0.19980101e8 |1 |
 
 #### Limit
 
@@ -127,15 +127,38 @@ query.from('cars').index('index_maker_id_release_date').
 items = query.all.items
 ```
 
-| maker_id | model | release_date |
-|:---|:---|:---|
-|1 |Accord |0.19760508e8 |
+| maker_id(Partition key) | model | release_date(Sort key) | status |
+|:---|:---|:---|:---|
+|1 |Accord |0.19760508e8 |0 |
+
+#### Expression Attribute Names
+
+Words reserved in DynamoDB can not be used without special processing.
+In `dynamodb-api` , you can omit the special processing by putting `#` at the beginning of the word.
+Refer to the list of reserved words from [here](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html).
+
+```ruby
+query = Dynamodb::Api::Query.new
+query.from('cars').index('index_maker_id_release_date').
+  where(['maker_id', '=', 1]).
+  filter('#status = :status', ':status': 1)
+items = query.all.items
+```
+
+| maker_id | model | release_date | status |
+|:---|:---|:---|:---|
+|1 |S2000 |0.19980101e8 |1 |
+
+If you don't add `#` to a reserved word, the following error will occur:
+
+    Aws::DynamoDB::Errors::ValidationException:
+      Invalid FilterExpression: Attribute name is a reserved keyword; reserved keyword: [reserved word]
 
 ## Development
 
 - Run `docker-compose up` to run the dynamodb_local.
 - After checking out the repo, run `bin/setup` to install dependencies.
-- Run `rake spec` to run the tests.
+- Run `bundle exec rake spec` to run the tests. Or run `bundle exec appraisal aws-sdk-* rake spec` to run the tests. Replase `*` with aws sdk major version.
 - You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 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 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).

data/dynamodb-api.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'aws-sdk', '~> 2'
+  spec.add_runtime_dependency 'aws-sdk', '>= 2'
   spec.add_runtime_dependency('activesupport', '>= 4')
 
   spec.add_development_dependency 'bundler', '~> 1.16'
@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rubocop-airbnb'
+  spec.add_development_dependency 'appraisal'
 end

data/gemfiles/aws_sdk_2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry-byebug", platforms: :ruby
+gem "aws-sdk", "~> 2"
+
+gemspec path: "../"

data/gemfiles/aws_sdk_3.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry-byebug", platforms: :ruby
+gem "aws-sdk", "~> 3"
+
+gemspec path: "../"

data/lib/dynamodb/api.rb

@@ -1,5 +1,6 @@
 require 'aws-sdk'
 require 'active_support'
+require 'active_support/core_ext'
 
 require 'dynamodb/api/version'
 require 'dynamodb/api/config'

data/lib/dynamodb/api/query.rb

@@ -14,20 +14,22 @@ module Dynamodb
       private
 
       def build_query
-        build_params = {
-          table_name: from_clause.name,
-          index_name: index_clause.name,
-          key_conditions: where_clause.key_conditions,
-        }.merge(build_filter_clause)
+        build_params = base_params.merge(build_filter_clause)
         build_params[:scan_index_forward] = order_direct(order_clause)
         build_params[:select] = select_name(select_clause)
-        if expression_attribute&.names
-          build_params[:expression_attribute_names] = expression_attribute.names
-        end
+        build_expression_attribute_names(build_params)
         build_params[:limit] = limit_clause.number if limit_clause&.number
         build_params
       end
 
+      def base_params
+        {
+          table_name: from_clause.name,
+          index_name: index_clause.name,
+          key_conditions: where_clause.key_conditions,
+        }
+      end
+
       def order_direct(clause)
         clause&.direct ? clause.direct : OrderClause.new.direct
       end
@@ -37,12 +39,21 @@ module Dynamodb
       end
 
       def build_filter_clause
-        return {} unless filter_clause&.expression
+        return {} if filter_clause&.expression.blank?
         {
           filter_expression: filter_clause.expression,
           expression_attribute_values: filter_clause.values,
         }
       end
+
+      def build_expression_attribute_names(params)
+        if filter_clause&.reserved_words.present?
+          expression_attribute.add(filter_clause.reserved_words)
+        end
+        if expression_attribute.names.present?
+          params[:expression_attribute_names] = expression_attribute.names
+        end
+      end
     end
   end
 end

data/lib/dynamodb/api/relation.rb

@@ -12,8 +12,16 @@ module Dynamodb
       attr_accessor :order_clause
       attr_accessor :where_clause
       attr_accessor :filter_clause
-      attr_accessor :expression_attribute
+      attr_accessor :attr_expression_attribute
       attr_accessor :limit_clause
+
+      def expression_attribute
+        if attr_expression_attribute.nil?
+          self.attr_expression_attribute = Relation::ExpressionAttributeNames.new
+        else
+          attr_expression_attribute
+        end
+      end
     end
   end
 end

data/lib/dynamodb/api/relation/expression_attribute_names.rb

@@ -4,10 +4,43 @@ module Dynamodb
   module Api
     module Relation
       class ExpressionAttributeNames
-        attr_reader :names
+        attr_accessor :names
 
-        def initialize(names)
-          @names = names
+        def initialize(names = {})
+          self.names = {}
+
+          case names.class.to_s
+          when 'String'
+            add(names)
+          when 'Array'
+            names.each do |name|
+              add(name)
+            end
+          when 'Hash'
+            self.names = names
+          else
+            raise "#{names.class} is not support"
+          end
+        end
+
+        def add(names)
+          _names = formatting(names)
+          self.names.merge!(_names)
+        end
+
+        private
+
+        def formatting(names)
+          _names = names.is_a?(Array) ? names : [names]
+          _names.each_with_object({}) do |name, hash|
+            next hash[name.to_sym] = remove_hash_tag(name) if name.is_a?(String)
+            next hash.merge!(name) if name.is_a?(Hash)
+            raise "#{name.class} is not support"
+          end
+        end
+
+        def remove_hash_tag(name)
+          name.gsub(/\#/, '')
         end
       end
     end

data/lib/dynamodb/api/relation/filter_clause.rb

@@ -6,10 +6,18 @@ module Dynamodb
       class FilterClause # :nodoc:
         attr_reader :expression
         attr_reader :values
+        attr_reader :reserved_words
 
         def initialize(expression, values)
           @expression = expression
           @values = values
+          @reserved_words = extract_reserved_words(@expression)
+        end
+
+        private
+
+        def extract_reserved_words(expression)
+          expression.scan(/\#\w+/)
         end
       end
     end

data/lib/dynamodb/api/relation/query_methods.rb

@@ -34,11 +34,6 @@ module Dynamodb
           self
         end
 
-        def ex_attr(names)
-          self.expression_attribute = Relation::ExpressionAttributeNames.new(names)
-          self
-        end
-
         def limit(value)
           self.limit_clause = Relation::LimitClause.new(value)
           self

data/lib/dynamodb/api/version.rb

@@ -1,5 +1,5 @@
 module Dynamodb
   module Api
-    VERSION = '0.4.2'.freeze
+    VERSION = '0.5.0'.freeze
   end
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: dynamodb-api
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - WalkerSumida
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-15 00:00:00.000000000 Z
+date: 2018-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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'
 description: aws dynamodb api
 email:
 - walkersumida@gmail.com
@@ -121,9 +135,10 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".travis.yml"
+- Appraisals
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -131,6 +146,8 @@ files:
 - bin/setup
 - docker-compose.yml
 - dynamodb-api.gemspec
+- gemfiles/aws_sdk_2.gemfile
+- gemfiles/aws_sdk_3.gemfile
 - lib/dynamodb/api.rb
 - lib/dynamodb/api/adapter.rb
 - lib/dynamodb/api/config.rb

data/Gemfile.lock

@@ -1,92 +0,0 @@
-PATH
-  remote: .
-  specs:
-    dynamodb-api (0.4.2)
-      activesupport (>= 4)
-      aws-sdk (~> 2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (5.2.0)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    ast (2.4.0)
-    aws-sdk (2.11.93)
-      aws-sdk-resources (= 2.11.93)
-    aws-sdk-core (2.11.93)
-      aws-sigv4 (~> 1.0)
-      jmespath (~> 1.0)
-    aws-sdk-resources (2.11.93)
-      aws-sdk-core (= 2.11.93)
-    aws-sigv4 (1.0.3)
-    byebug (10.0.2)
-    coderay (1.1.2)
-    concurrent-ruby (1.0.5)
-    diff-lcs (1.3)
-    i18n (1.0.1)
-      concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.1)
-    jmespath (1.4.0)
-    method_source (0.9.0)
-    minitest (5.11.3)
-    parallel (1.12.1)
-    parser (2.5.1.2)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-byebug (3.6.0)
-      byebug (~> 10.0)
-      pry (~> 0.10)
-    rainbow (3.0.0)
-    rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    rubocop (0.57.2)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.5)
-      powerpack (~> 0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    rubocop-airbnb (1.5.0)
-      rubocop (= 0.57.2)
-      rubocop-rspec (= 1.27.0)
-    rubocop-rspec (1.27.0)
-      rubocop (>= 0.56.0)
-    ruby-progressbar (1.10.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.4.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  dynamodb-api!
-  pry
-  pry-byebug
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  rubocop-airbnb
-
-BUNDLED WITH
-   1.16.2