Merge pull request #910 from ogidow/add-key-type-option

Add key_type option to table method

Author: andrykonchin

.rubocop.yml

@@ -7,8 +7,10 @@ inherit_from:
   - .rubocop_todo.yml
 
 require:
-  - rubocop-md
   - rubocop-packaging
+
+plugins:
+  - rubocop-md
   - rubocop-performance
   - rubocop-rake
   - rubocop-rspec
@@ -97,7 +99,9 @@ Style/DateTime:
   Enabled: false
 Style/MissingRespondToMissing:
   Enabled: false
-Naming/PredicateName:
+Naming/PredicatePrefix:
+  Enabled: false
+Naming/PredicateMethod:
   Enabled: false
 Security/YAMLLoad:
   Enabled: false

lib/dynamoid/fields.rb

@@ -197,9 +197,19 @@ def range(name, type = :string, options = {})
       #     field :id, :integer
       #   end
       #
+      # To declare a new attribute with not-default type as a table hash key a
+      # :key_type option can be used:
+      #
+      #   class User
+      #     include Dynamoid::Document
+      #
+      #     table key: :user_id, key_type: :integer
+      #   end
+      #
       # @param options [Hash] options to override default table settings
       # @option options [Symbol] :name name of a table
       # @option options [Symbol] :key name of a hash key attribute
+      # @option options [Symbol] :key_type type of a hash key attribute
       # @option options [Symbol] :inheritance_field name of an attribute used for STI
       # @option options [Symbol] :capacity_mode table billing mode - either +provisioned+ or +on_demand+
       # @option options [Integer] :write_capacity table write capacity units
@@ -210,11 +220,11 @@ def range(name, type = :string, options = {})
       # @since 0.4.0
       def table(options)
         self.options = options
-
         # a default 'id' column is created when Dynamoid::Document is included
         unless attributes.key? hash_key
           remove_field :id
-          field(hash_key)
+          key_type = options[:key_type] || :string
+          field(hash_key, key_type)
         end
 
         # The created_at/updated_at fields are declared in the `included` callback first.

spec/app/models/address.rb

@@ -3,7 +3,7 @@
 class Address
   include Dynamoid::Document
 
-  field :city
+  field :city, :string, alias: :CityName
   field :options, :serialized
   field :deliverable, :boolean
   field :latitude, :number

spec/dynamoid/adapter_plugin/aws_sdk_v3_spec.rb

@@ -1023,7 +1023,7 @@ def dynamo_request(table_name, conditions = [], options = {})
     it_behaves_like 'range queries'
 
     describe 'query' do
-      include_examples 'correctly handling limits', :query
+      it_behaves_like 'correctly handling limits', :query
     end
 
     # Scan

spec/dynamoid/document_spec.rb

@@ -41,17 +41,6 @@
     expect(address.attributes).to eq(city: 'Chicago')
   end
 
-  it 'allows interception of write_attribute on load' do
-    klass = new_class do
-      field :city
-
-      def city=(value)
-        self[:city] = value.downcase
-      end
-    end
-    expect(klass.new(city: 'Chicago').city).to eq 'chicago'
-  end
-
   it 'ignores unknown fields (does not raise error)' do
     klass = new_class do
       field :city
@@ -141,28 +130,6 @@ def city=(value)
     expect(address.errors.full_messages).to be_empty
   end
 
-  it 'has default table options' do
-    address = Address.create
-
-    expect(address.id).not_to be_nil
-    expect(Address.table_name).to eq 'dynamoid_tests_addresses'
-    expect(Address.hash_key).to eq :id
-    expect(Address.read_capacity).to eq 100
-    expect(Address.write_capacity).to eq 20
-    expect(Address.inheritance_field).to eq :type
-  end
-
-  it 'follows any table options provided to it' do
-    tweet = Tweet.create(group: 12_345)
-
-    expect { tweet.id }.to raise_error(NoMethodError)
-    expect(tweet.tweet_id).not_to be_nil
-    expect(Tweet.table_name).to eq 'dynamoid_tests_twitters'
-    expect(Tweet.hash_key).to eq :tweet_id
-    expect(Tweet.read_capacity).to eq 200
-    expect(Tweet.write_capacity).to eq 200
-  end
-
   describe '#hash_key' do
     context 'when there is already an attribute with name `hash_key`' do
       let(:klass) do
@@ -306,101 +273,6 @@ def city=(value)
     end
   end
 
-  describe 'TTL (Time to Live)' do
-    let(:model) do
-      new_class do
-        table expires: { field: :expired_at, after: 30 * 60 }
-
-        field :expired_at, :integer
-      end
-    end
-
-    let(:model_with_wrong_field_name) do
-      new_class do
-        table expires: { field: :foo, after: 30 * 60 }
-
-        field :expired_at, :integer
-      end
-    end
-
-    it 'sets default value at the creation' do
-      travel 1.hour do
-        obj = model.create
-        expect(obj.expired_at).to eq(Time.now.to_i + (30 * 60))
-      end
-    end
-
-    it 'sets default value at the updating' do
-      obj = model.create
-
-      travel 1.hour do
-        obj.update_attributes(expired_at: nil)
-        expect(obj.expired_at).to eq(Time.now.to_i + (30 * 60))
-      end
-    end
-
-    it 'does not override already existing value' do
-      obj = model.create(expired_at: 1024)
-      expect(obj.expired_at).to eq 1024
-
-      obj.update_attributes(expired_at: 512)
-      expect(obj.expired_at).to eq 512
-    end
-
-    it 'raises an error if specified wrong field name' do
-      # error messages may very on different Ruby versions and use either ` or '.
-      expect do
-        model_with_wrong_field_name.create
-      end.to raise_error(NoMethodError, /undefined method (`|')foo='/)
-    end
-  end
-
-  describe 'timestamps fields `created_at` and `updated_at`' do
-    let(:class_with_timestamps_true) do
-      new_class do
-        table timestamps: true
-      end
-    end
-
-    let(:class_with_timestamps_false) do
-      new_class do
-        table timestamps: false
-      end
-    end
-
-    it 'declares timestamps when Dynamoid::Config.timestamps = true', config: { timestamps: true } do
-      expect(new_class.attributes).to have_key(:created_at)
-      expect(new_class.attributes).to have_key(:updated_at)
-
-      expect(new_class.new).to respond_to(:created_at)
-      expect(new_class.new).to respond_to(:updated_at)
-    end
-
-    it 'does not declare timestamps when Dynamoid::Config.timestamps = false', config: { timestamps: false } do
-      expect(new_class.attributes).not_to have_key(:created_at)
-      expect(new_class.attributes).not_to have_key(:updated_at)
-
-      expect(new_class.new).not_to respond_to(:created_at)
-      expect(new_class.new).not_to respond_to(:updated_at)
-    end
-
-    it 'does not declare timestamps when Dynamoid::Config.timestamps = true but table timestamps = false', config: { timestamps: true } do
-      expect(class_with_timestamps_false.attributes).not_to have_key(:created_at)
-      expect(class_with_timestamps_false.attributes).not_to have_key(:updated_at)
-
-      expect(class_with_timestamps_false.new).not_to respond_to(:created_at)
-      expect(class_with_timestamps_false.new).not_to respond_to(:updated_at)
-    end
-
-    it 'declares timestamps when Dynamoid::Config.timestamps = false but table timestamps = true', config: { timestamps: false } do
-      expect(class_with_timestamps_true.attributes).to have_key(:created_at)
-      expect(class_with_timestamps_true.attributes).to have_key(:updated_at)
-
-      expect(class_with_timestamps_true.new).to respond_to(:created_at)
-      expect(class_with_timestamps_true.new).to respond_to(:updated_at)
-    end
-  end
-
   describe '#inspect' do
     it 'returns a String containing a model class name and a list of attributes and values' do
       klass = new_class(class_name: 'Person') do
@@ -409,7 +281,6 @@ def city=(value)
       end
 
       object = klass.new(name: 'Alex', age: 21)
-      puts object.attributes
       expect(object.inspect).to eql '#<Person id: nil, name: "Alex", age: 21, created_at: nil, updated_at: nil>'
     end