dynomite 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfae7abac0c8aa642ef93bde33f936415bbd4b51ee6dde84585e3cae63bef118
-  data.tar.gz: 37160a6a7e0b36463fa4702c491ad177c10aa45c19bb474b5533d2e96c24b8e4
+  metadata.gz: f7ffbee55e643480271f74155ba0e255875a13c28efc7a133da1d9eb23280ac9
+  data.tar.gz: 6125daeb754588170f4150e90b8de7b67259b4254ce5780128321f0b83e67cce
 SHA512:
-  metadata.gz: c228bf5f39aca9fa1efbb889bbdf6f339c8874efe7b8669f94f11291219659dc7f8ff194bb3ff6b93b3513b5f67f04d9e9aa3d7be2ae480f9837378f85e68eab
-  data.tar.gz: e78f78984b046fb167a9f0ca6ef8b99be104b1f95648bd03863175b80517b342c4aed2cbaf1f39a5f24b286d299239de10f2e88ca786d70479e0a9899419c763
+  metadata.gz: 4d2f33a6a016d9e689df6b68bcdd12dc8a93a435ddc5b3d41bb821c9aa86ca548d65ac6615a071e9493a955851fa3b917ee3db7c00e8c4f9354bbf576a5c5d2f
+  data.tar.gz: cb7b866347a3b8dab6bc1552d1bf0d07469832d2a451c67539b8914d92229cd7ee72a430262fe2f0017f990dffe6b65005b106b210852d727149cf748b483a2b

data/CHANGELOG.md

@@ -3,6 +3,14 @@
 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.2.0]
+- #7 from patchkit-net/feature/validations
+- Add a way to quickly define getters and setters using `column` method
+- Can be used with `ActiveModel::Validations`
+- Add ActiveModel::Validations (group=test,development) dependency
+- Add ActiveModel::Validations Item integration spec
+- Add Dynomite::Item.replace and .replace! spec with validations
+
 ## [1.1.1]
 - #6 from patchkit-net/feature/table-count: add Item.count
 

data/Gemfile

@@ -4,3 +4,7 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in dynomite.gemspec
 gemspec
+
+group :development, :test do
+  gem "activemodel"
+end

data/README.md

@@ -11,6 +11,8 @@ First define a class:
 ```ruby
 class Post < Dynomite::Item
   # partition_key "id" # optional, defaults to id
+  
+  column :id, :title, :desc
 end
 ```
 
@@ -93,6 +95,50 @@ Post.where({category: "Drama"}, {index_name: "category-index"})
 
 Examples are also in [item_spec.rb](spec/lib/dynomite/item_spec.rb).
 
+## Column Lists
+
+You can define your column list using the `column` method inside your item class. This gives you
+a possibility to access your column fields using getters and setters. Also, any predefined column
+can be passed to `ActiveModel::Validations` (see Validations).
+
+```ruby
+class Post < Dynomite::Item
+  column :id, :name
+end
+
+post = Post.new
+post.name = "My First Post"
+post.replace
+
+puts post.id # 1962DE7D852298C5CDC809C0FEF50D8262CEDF09
+puts post.name # "My First Post"
+``` 
+
+Note that any column not defined using the `column` method can still be accessed using the `attrs`
+method.
+
+## Validations
+
+You can add validations known from ActiveRecord to your Dynomite items.
+Just add `include ActiveModel::Validations` at the top of your item class.
+
+```ruby
+class Post < Dynomite::Item
+  include ActiveModel::Validations
+  
+  column :id, :name # needed
+  
+  validate :id, presence: true
+  validate :name, presence: true
+end
+``` 
+
+**Be sure to define all validated columns using `column` method**.  
+
+Validations are executed by default as soon as you call the `replace` method, returning `false` on
+failure. It also can be ran manually using the `valid?` method just like with ActiveRecord models.
+
+
 ## Migration Support
 
 Dynomite supports ActiveRecord-like migrations.  Here's a short example:

data/lib/dynomite/item.rb

@@ -3,6 +3,8 @@ require "aws-sdk-dynamodb"
 require "digest"
 require "yaml"
 
+require "dynomite/reserved_words"
+
 # The modeling is ActiveRecord-ish but not exactly because DynamoDB is a
 # different type of database.
 #
@@ -67,10 +69,24 @@ module Dynomite
     # The method is named replace to clearly indicate that the item is
     # fully replaced.
     def replace(hash={})
-      attrs = self.class.replace(@attrs.deep_merge(hash))
+      @attrs = @attrs.deep_merge(hash)
+
+      # valid? method comes from ActiveModel::Validations
+      if respond_to? :valid?
+        return false unless valid?
+      end
+
+      attrs = self.class.replace(@attrs)
+
       @attrs = attrs # refresh attrs because it now has the id
     end
 
+    # Similar to replace, but raises an error on failed validation.
+    # Works that way only if ActiveModel::Validations are included
+    def replace!(hash={})
+      raise "Validation failed: #{errors.full_messages.join(', ')}" unless replace(hash)
+    end
+
     def find(id)
       self.class.find(id)
     end
@@ -295,5 +311,25 @@ module Dynomite
     def self.count
       table.item_count
     end
+
+    # Defines column. Defined column can be accessed by getter and setter methods of the same
+    # name (e.g. [model.my_column]). Attributes with undefined columns can be accessed by
+    # [model.attrs] method.
+    def self.column(*names)
+      names.each(&method(:add_column))
+    end
+
+    # @see Item.column
+    def self.add_column(name)
+      raise "'#{name}' is a reserved word" if Dynomite::RESERVED_WORDS.include?(name)
+
+      define_method(name) do
+        @attrs[name.to_s]
+      end
+
+      define_method("#{name}=") do |value|
+        @attrs[name.to_s] = value
+      end
+    end
   end
 end

data/lib/dynomite/reserved_words.rb

@@ -0,0 +1,18 @@
+module Dynomite
+  RESERVED_WORDS = %w[
+    as_json
+    attrs
+    attributes
+    delete
+    columns
+    find
+    getter
+    new_record
+    param_name
+    partition_key
+    replace
+    setter
+    scan
+    table_name
+  ].freeze
+end

data/lib/dynomite/version.rb

@@ -1,3 +1,3 @@
 module Dynomite
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynomite
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-10 00:00:00.000000000 Z
+date: 2019-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -114,6 +114,7 @@ files:
 - lib/dynomite/migration/generator.rb
 - lib/dynomite/migration/templates/create_table.rb
 - lib/dynomite/migration/templates/update_table.rb
+- lib/dynomite/reserved_words.rb
 - lib/dynomite/version.rb
 homepage: https://github.com/tongueroo/dynomite
 licenses: []