Support inheritance

CHANGELOG.md

@@ -1,3 +1,8 @@
+Unreleased Changes
+------------------
+
+* Feature - Add support for inheritance. Aws Record models can now be extended using standard ruby inheritance (#80).
+
 2.8.0 (2022-10-12)
 ------------------
 

README.md

@@ -88,3 +88,34 @@ item.name = "Item"
 item.active = false
 item.save
 ```
+
+### Inheritance Support
+Aws Record models can be extended using standard ruby inheritance. The child model must 
+include `Aws::Record` in their model and the following will be inherited:
+* [set_table_name](https://docs.aws.amazon.com/sdk-for-ruby/aws-record/api/Aws/Record/RecordClassMethods.html#set_table_name-instance_method)
+* [Attributes and Keys](https://docs.aws.amazon.com/sdk-for-ruby/aws-record/api/Aws/Record/Attributes.html#initialize-instance_method)
+* Mutation Tracking:
+  * [enable_mutation_tracking](https://docs.aws.amazon.com/sdk-for-ruby/aws-record/api/Aws/Record/RecordClassMethods.html#enable_mutation_tracking-instance_method)
+  * [disable_mutation_tracking](https://docs.aws.amazon.com/sdk-for-ruby/aws-record/api/Aws/Record/RecordClassMethods.html#disable_mutation_tracking-instance_method)
+* [local_secondary_indexes](https://docs.aws.amazon.com/sdk-for-ruby/aws-record/api/Aws/Record/SecondaryIndexes/SecondaryIndexesClassMethods.html#local_secondary_indexes-instance_method)
+* [global_secondary_indexes](https://docs.aws.amazon.com/sdk-for-ruby/aws-record/api/Aws/Record/SecondaryIndexes/SecondaryIndexesClassMethods.html#global_secondary_indexes-instance_method)
+* [configure_client](https://docs.aws.amazon.com/sdk-for-ruby/aws-record/api/Aws/Record/ClientConfiguration.html#configure_client-instance_method)
+
+See example below to see the feature in action.
+
+```ruby
+class Animal
+  include Aws::Record
+  string_attr :name, hash_key: true
+  integer_attr :age
+end
+
+class Dog < Animal
+  include Aws::Record
+  boolean_attr :family_friendly
+end
+
+dog = Dog.find(name: 'Sunflower')
+dog.age = 3
+dog.family_friendly = true
+```

features/inheritance/inheritance.feature

@@ -0,0 +1,168 @@
+# Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You may not
+# use this file except in compliance with the License. A copy of the License is
+# located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is distributed on
+# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+# or implied. See the License for the specific language governing permissions
+# and limitations under the License.
+
+# language: en
+
+@dynamodb @inheritance
+Feature: Amazon DynamoDB Inheritance
+  This feature tests inheritance between parent class and child classes. To run
+  these tests, you will need to have valid AWS credentials that are accessible
+  with the AWS SDK for Ruby's standard credential provider chain. In practice,
+  this means a shared credential file or environment variables with your credentials.
+  These tests may have some AWS costs associated with running them since AWS resources
+  are created and destroyed within these tests.
+
+
+  Background:
+    Given a Parent model with definition:
+      """
+      set_table_name('Animal')
+      integer_attr  :id,    hash_key: true
+      string_attr :name, range_key: true
+      string_attr :size
+      list_attr :characteristics
+      global_secondary_index(
+        :gsi,
+        hash_key:  :id,
+        range_key: :size,
+        projection: {
+          projection_type: "ALL"
+        }
+      )
+      """
+
+  Scenario: Create a Table and be able to create Items from both Child model and Parent model
+    Given a Child model with definition:
+      """
+      boolean_attr :family_friendly
+      """
+    And a TableConfig of:
+      """
+      Aws::Record::TableConfig.define do |t|
+        t.model_class(TableConfigTestModel)
+        t.read_capacity_units(2)
+        t.write_capacity_units(2)
+        t.global_secondary_index(:gsi) do |i|
+          i.read_capacity_units(1)
+          i.write_capacity_units(1)
+        end
+        t.client_options(region: "us-east-1")
+      end
+      """
+    When we migrate the TableConfig
+    Then eventually the table should exist in DynamoDB
+    And the table should have a global secondary index named "gsi"
+    And we create a new instance of the Child model with attribute value pairs:
+      """
+      [
+        ["id", 1],
+        ["name", "Cheeseburger"],
+        ["size", "Large"],
+        ["characteristics", ["Friendly", "Curious", "Loves kisses"]],
+        ["family_friendly", true]
+      ]
+      """
+    And we save the model instance
+    And we call the 'find' class method with parameter data:
+      """
+      {
+        "id": 1,
+        "name": "Cheeseburger"
+      }
+      """
+    Then we should receive an aws-record item with attribute data:
+      """
+      {
+        "id": 1,
+        "name": "Cheeseburger",
+        "size": "Large",
+        "characteristics": ["Friendly", "Curious", "Loves kisses"],
+        "family_friendly": true
+      }
+      """
+    And we create a new instance of the Parent model with attribute value pairs:
+      """
+      [
+        ["id", 2],
+        ["name", "Applejack"],
+        ["size", "Medium"],
+        ["characteristics", ["Aloof", "Dignified"]]
+      ]
+      """
+    And we save the model instance
+    And we call the 'find' class method with parameter data:
+      """
+      {
+        "id": 2,
+        "name": "Applejack"
+      }
+      """
+    Then we should receive an aws-record item with attribute data:
+      """
+      {
+        "id": 2,
+        "name": "Applejack",
+        "size": "Medium",
+        "characteristics": ["Aloof", "Dignified"]
+      }
+      """
+
+  Scenario:  Create a Table based on the Child Model and be able to create an item
+    Given a Child model with definition:
+      """
+      set_table_name('Cat')
+      integer_attr  :toe_beans
+      """
+    And a TableConfig of:
+      """
+      Aws::Record::TableConfig.define do |t|
+        t.model_class(TableConfigTestModel)
+        t.read_capacity_units(2)
+        t.write_capacity_units(2)
+        t.global_secondary_index(:gsi) do |i|
+          i.read_capacity_units(1)
+          i.write_capacity_units(1)
+        end
+        t.client_options(region: "us-east-1")
+      end
+      """
+    When we migrate the TableConfig
+    Then eventually the table should exist in DynamoDB
+    And we create a new instance of the Child model with attribute value pairs:
+      """
+      [
+        ["id", 1],
+        ["name", "Donut"],
+        ["size", "Chonk"],
+        ["characteristics", ["Makes good bread", "Likes snacks"]],
+        ["toe_beans", 9]
+      ]
+      """
+    And we save the model instance
+    And we call the 'find' class method with parameter data:
+      """
+      {
+        "id": 1,
+        "name": "Donut"
+      }
+      """
+    Then we should receive an aws-record item with attribute data:
+      """
+      {
+        "id": 1,
+        "name": "Donut",
+        "size": "Chonk",
+        "characteristics": ["Makes good bread", "Likes snacks"],
+        "toe_beans": 9
+      }
+      """

features/inheritance/step_definitions.rb

@@ -0,0 +1,49 @@
+# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You may not
+# use this file except in compliance with the License. A copy of the License is
+# located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is distributed on
+# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+# or implied. See the License for the specific language governing permissions
+# and limitations under the License.
+
+
+
+Given(/^a (Parent|Child) model with definition:$/) do |model, string|
+  case model
+    when 'Parent'
+      @parent = Class.new do
+        include(Aws::Record)
+      end
+      @parent.class_eval(string)
+      @table_name = @parent.table_name
+    when 'Child'
+      @model = Class.new(@parent) do
+        include(Aws::Record)
+      end
+      @model.class_eval(string)
+      @table_name = @model.table_name
+    else
+      raise 'Model must be either a Parent or Child'
+  end
+end
+
+And(/^we create a new instance of the (Parent|Child) model with attribute value pairs:$/) do |model, string|
+  data = JSON.parse(string)
+  case model
+    when 'Parent'
+      @instance = @parent.new
+    when 'Child'
+      @instance = @model.new
+    else
+      raise 'Model must be either a Parent or Child'
+  end
+  data.each do |row|
+    attribute, value = row
+    @instance.send(:"#{attribute}=", value)
+  end
+end