dymos 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 036d8dac33aac8670a6e98ebc1b5edd52acb193f
-  data.tar.gz: bbcc269f35f7a4a717a62937e07281efd24e0f03
+  metadata.gz: 4e960079833a6e03ae80c5bb1374d504ccb8eb83
+  data.tar.gz: cf6b5b4cc3b06455ef702cde7aae8fef8694f4f8
 SHA512:
-  metadata.gz: 6e60e93b0a7b52e8758d2e62e5c3a3d2c2a810edee67fa0986257651158e2b4e61dffd3617ab65da12709fdc964d534274082cffc9744a8fdfaf7c3affaf57f3
-  data.tar.gz: ac6f103586f8d7d60f28670032e6c4bed0f0fd365dd950f4e739548865fccdaf2c5e7d8b93589283b20a9f45ddaf4e81a4d5d98d7c7399ca790217efe4eb5c6f
+  metadata.gz: 9e928ff07856ca7da1a51b51bd1a27c71502fdc6f6af9d52ea0d713ba02c2d9a07e744e73d1734841eef28c79d4067ac78c5d2882e1713f0d72c97801a37c200
+  data.tar.gz: 65cb61ad85949b518774863d0ddf01fcb5ee94143e5808f3631d2888bde4fd585e3d27d66fa9af0eeecf6916d9103c3514334c30d9252d65ae97a84fe30478f2

data/lib/dymos.rb

@@ -3,12 +3,14 @@ require "dymos/query/expect"
 require "dymos/query/builder"
 require "dymos/query/put_item"
 require "dymos/query/update_item"
+require "dymos/query/delete_item"
 require "dymos/query/get_item"
 require "dymos/query/describe"
 require "dymos/query/scan"
 require "dymos/query/query"
 require "dymos/attribute"
 require "dymos/command"
+require "dymos/persistence"
 require "dymos/model"
 require "dymos/version"
 

data/lib/dymos/command.rb

@@ -28,5 +28,9 @@ module Dymos
     def scan
       Dymos::Query::Scan.new(:scan, table_name, class_name)
     end
+
+    def delete
+      Dymos::Query::DeleteItem.new(:delete_item, table_name, class_name)
+    end
   end
 end

data/lib/dymos/model.rb

@@ -4,30 +4,43 @@ require 'active_model'
 module Dymos
   class Model
     include ActiveModel::Model
+    include ActiveModel::Dirty
+    include Dymos::Persistence
     extend Dymos::Command
     attr_accessor :metadata
 
     def initialize(params={})
-      @attributes = {}
+      @attributes={}
+      send :attributes=, params, true
       super
     end
 
-    def self.field(attr, type = :string)
-      define_method(attr) { read_attribute(attr) }
+    def self.field(attr, type, default: nil)
+      @fields ||= {}
+      @fields[attr]={
+          type: type,
+          default: default
+      }
+      define_attribute_methods attr
+      define_method(attr) { read_attribute(attr) || default }
       define_method("#{attr}_type") { type }
       define_method("#{attr}?") { !read_attribute(attr).nil? }
       define_method("#{attr}=") { |value| write_attribute(attr, value) }
     end
 
+    def self.fields
+      @fields
+    end
+
     def self.table(name)
       define_singleton_method('table_name') { name }
       define_method('table_name') { name }
     end
 
-    def attributes=(attributes = {})
+    def attributes=(attributes = {}, initialize = false)
       if attributes
         attributes.each do |attr, value|
-          write_attribute(attr, value)
+          write_attribute(attr, value, initialize)
         end
       end
     end
@@ -45,34 +58,30 @@ module Dymos
     end
 
     def self.find(key1, key2=nil)
-      indexes = new.global_indexes
+      indexes = key_scheme
       keys={}
       keys[indexes.first[:attribute_name].to_sym] = key1
       keys[indexes.last[:attribute_name].to_sym] = key2 if indexes.size > 1
       self.get.key(keys).execute
     end
 
-    def save
-      items = {}
-      attributes.each do |k, v|
-        if v != nil
-          items[k] =v
-        end
-      end
-      result = dynamo.put_item(
-          table_name: table_name,
-          item: items,
-          return_values: "ALL_OLD"
-      )
-      !result.error
+    def self.key_scheme
+      @key_scheme ||= new.describe_table[:table][:key_schema]
+    end
+
+    def reload!
+      reset_changes
     end
 
     def describe_table
-      @scheme ||= dynamo.describe_table(table_name: table_name)
+      self.class.send(:describe).execute
     end
 
-    def global_indexes
-      describe_table.data[:table][:key_schema]
+    def indexes
+      scheme = self.class.key_scheme.map do |scheme|
+        [scheme[:attribute_name], send(scheme[:attribute_name])]
+      end
+      scheme.to_h
     end
 
     def dynamo
@@ -94,7 +103,8 @@ module Dymos
       @attributes[name.to_sym]
     end
 
-    def write_attribute(name, value)
+    def write_attribute(name, value, initialize=false)
+      self.send "#{name}_will_change!" unless (initialize or value == @attributes[name.to_sym])
       @attributes[name.to_sym] = value
     end
 

data/lib/dymos/persistence.rb

@@ -0,0 +1,61 @@
+module Dymos
+  module Persistence
+    attr_accessor :new_record
+
+    def initialize(params={})
+      @new_record = true
+      @destroyed = false
+    end
+
+    def new_record?
+      @new_record
+    end
+
+    def destroyed?
+      @destroyed
+    end
+
+    def persisted?
+      !(new_record? || destroyed?)
+    end
+
+    def save(*)
+      create_or_update
+    rescue
+      false
+    end
+
+    def save!(*)
+      create_or_update || raise(Dymos::RecordNotSaved)
+    end
+
+    def delete
+      self.class.delete.key(indexes).execute if persisted?
+      @destroyed = true
+      freeze
+    end
+
+    private
+
+    def create_or_update
+      result = new_record? ? _create_record : _update_record
+      result != false
+    end
+
+    def _update_record()
+      _create_record
+    end
+
+    def _create_record()
+      result = dynamo.put_item(
+          table_name: table_name,
+          item: attributes,
+          return_values: "ALL_OLD"
+      )
+      changes_applied
+      @new_record = false
+      !result.error
+    end
+
+  end
+end

data/lib/dymos/query/builder.rb

@@ -43,22 +43,22 @@ module Dymos
           if res.data.respond_to? :items # scan, query
             metadata = extract(res, :items)
             res.data[:items].map do |datum|
-              obj = Object.const_get(@class_name).new
-              obj.attributes = datum
+              obj = Object.const_get(@class_name).new(datum)
               obj.metadata = metadata
+              obj.new_record = false
               obj
             end
           elsif res.data.respond_to? :attributes # put_item, update_item
             return nil if res.attributes.nil?
-            obj = Object.const_get(@class_name).new
-            obj.attributes = res.attributes
+            obj = Object.const_get(@class_name).new(res.attributes)
             obj.metadata = extract(res, :attributes)
             obj
           elsif res.respond_to? :data
-            if res.data.respond_to? :item # get_item
-              obj = Object.const_get(@class_name).new
-              obj.attributes = res.data.item
+            if res.data.respond_to? :item # get_item, delete_item
+              return nil if res.data.item.nil?
+              obj = Object.const_get(@class_name).new(res.data.item)
               obj.metadata = extract(res, :item)
+              obj.new_record = false
               obj
             else
               res.data.to_hash # describe

data/lib/dymos/query/delete_item.rb

@@ -0,0 +1,47 @@
+module Dymos
+  module Query
+    class DeleteItem < ::Dymos::Query::Builder
+
+      # @param [String] name
+      # @return [self]
+      def key(name)
+        @key = name
+        self
+      end
+
+      def expected(params)
+        @expected = Hash[params.map do |name, expression|
+          operator, values = expression.split(' ', 2)
+          if values.nil?
+            [name, ::Dymos::Query::Expect.new.condition(operator, nil).data]
+          else
+            value1, value2 = values.split(' ')
+            if value2.present?
+              [name, ::Dymos::Query::Expect.new.condition(operator, values).data]
+            else
+              [name, ::Dymos::Query::Expect.new.condition(operator, value1).data]
+            end
+          end
+
+        end]
+        self
+      end
+
+      def query
+        data = {
+            table_name: @table_name.to_s,
+            key: @key,
+            return_values: @return_values || 'ALL_OLD'
+        }
+
+        if @expected.present?
+          data[:expected] = @expected
+          if @expected.size > 1
+            data[:conditional_operator] = @conditional_operator || 'AND'
+          end
+        end
+        data
+      end
+    end
+  end
+end

data/lib/dymos/query/scan.rb

@@ -7,11 +7,17 @@ module Dymos
         self
       end
 
+      def exclusive_start_key(params)
+        @exclusive_start_key = params
+        self
+      end
+
       def query
         data = {
             table_name: @table_name.to_s,
         }
         data[:limit] = @limit if @limit.present?
+        data[:exclusive_start_key] = @exclusive_start_key if @exclusive_start_key.present?
         data
       end
     end

data/lib/dymos/version.rb

@@ -1,3 +1,3 @@
 module Dymos
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/lib/dymos/model_spec.rb

@@ -46,6 +46,7 @@ describe Dymos::Model do
     client.put_item(table_name: 'dummy', item: {id: 'hoge', name: '太郎', list: Set['a', 'b', 'c']})
     client.put_item(table_name: 'dummy', item: {id: 'fuga', name: '次郎'})
     client.put_item(table_name: 'dummy', item: {id: 'piyo', name: '三郎'})
+    client.put_item(table_name: 'dummy', item: {id: 'musashi', name: '巴'}) #削除用
 
     client.delete_table(table_name: 'post') if client.list_tables[:table_names].include?('post')
     client.create_table(
@@ -66,6 +67,36 @@ describe Dymos::Model do
 
 #  let(:model) { Dummy.new }
 
+  describe :fields do
+    it do
+      expect(DummyUser.fields.keys).to eq([:id, :name, :email, :list])
+    end
+  end
+  describe "クラスマクロのデフォルト値" do
+    it "設定されていなければnilを返す" do
+      expect(DummyPost.new.id).to eq(nil)
+    end
+
+    class DummyModel < Dymos::Model
+      field :id, :number, default: 0
+      field :body, :string, default: "none"
+    end
+
+    it "idは0を返す" do
+      expect(DummyModel.new.id).to eq(0)
+    end
+
+    it "bodyは'none'を返す" do
+      expect(DummyModel.new.body).to eq('none')
+    end
+
+    it "上書きすることができる" do
+      model = DummyModel.new
+      model.id=1
+      expect(model.id).to eq(1)
+    end
+  end
+
   describe :new do
 
     describe :field do
@@ -138,23 +169,21 @@ describe Dymos::Model do
       end
     end
 
-    describe :global_indexes do
+    describe :key_scheme do
       it "キー情報" do
-        model = DummyUser.new
-        expect(model.global_indexes.first[:attribute_name]).to eq('id')
-        expect(model.global_indexes.first[:key_type]).to eq('HASH')
+        expect(DummyUser.key_scheme.first[:attribute_name]).to eq('id')
+        expect(DummyUser.key_scheme.first[:key_type]).to eq('HASH')
 
-        model = DummyPost.new
-        expect(model.global_indexes.first[:attribute_name]).to eq('id')
-        expect(model.global_indexes.first[:key_type]).to eq('HASH')
-        expect(model.global_indexes.last[:attribute_name]).to eq('timestamp')
-        expect(model.global_indexes.last[:key_type]).to eq('RANGE')
+        expect(DummyPost.key_scheme.first[:attribute_name]).to eq('id')
+        expect(DummyPost.key_scheme.first[:key_type]).to eq('HASH')
+        expect(DummyPost.key_scheme.last[:attribute_name]).to eq('timestamp')
+        expect(DummyPost.key_scheme.last[:key_type]).to eq('RANGE')
       end
     end
 
     describe :find do
       it "ユーザを抽出" do
-        user = DummyUser.get.key(id:'hoge').execute
+        user = DummyUser.get.key(id: 'hoge').execute
         expect(user.id).to eq('hoge')
         expect(user.name).to eq('太郎')
       end
@@ -173,7 +202,7 @@ describe Dymos::Model do
     describe :all do
       it "すべてのユーザを抽出" do
         users = DummyUser.all
-        expect(users.size).to eq(4)
+        expect(users.size).to eq(5)
       end
     end
 
@@ -185,5 +214,58 @@ describe Dymos::Model do
       end
     end
   end
+
+  describe "変更検知" do
+    class DummyModel < Dymos::Model
+      field :id, :number, default: 0
+      field :body, :string, default: "none"
+    end
+
+    it "新規モデル" do
+      user = DummyModel.new
+      expect(user.changes).to eq({})
+      expect(user.changed?).to eq(false)
+      user.id = 1
+      expect(user.changed?).to eq(true)
+      expect(user.changes).to eq({"id" => [0, 1]})
+      user.body = "hoge"
+      expect(user.changes).to eq({"id" => [0, 1], "body" => ['none', 'hoge']})
+    end
+
+    describe "DBから引いたモデル" do
+      it "" do
+        user = DummyUser.get.key(id: 'hoge').execute
+        expect(user.changes).to eq({})
+        expect(user.changed?).to eq(false)
+        user.id = 1
+        expect(user.changed?).to eq(true)
+        expect(user.id_changed?).to eq(true)
+        expect(user.changes).to eq({"id" => ["hoge", 1]})
+      end
+    end
+  end
+
+  describe :persistence do
+    describe "新規モデル" do
+      it do
+        user = DummyUser.new
+        expect(user.new_record?).to eq(true)
+        expect(user.destroyed?).to eq(false)
+        expect(user.persisted?).to eq(false)
+      end
+
+      describe "DBから引いたモデル" do
+        it do
+          user = DummyUser.get.key(id: 'musashi').execute
+          expect(user.new_record?).to eq(false)
+          expect(user.destroyed?).to eq(false)
+          expect(user.persisted?).to eq(true)
+          user.delete
+          expect(user.destroyed?).to eq(true)
+          expect(DummyUser.get.key(id: 'musashi').execute).to eq(nil)
+        end
+      end
+    end
+  end
 end
 

data/spec/lib/dymos/query/delete_item_spec.rb

@@ -0,0 +1,76 @@
+describe Dymos::Query::DeleteItem do
+  before :all do
+    Aws.config[:region] = 'us-west-1'
+    Aws.config[:endpoint] = 'http://localhost:4567'
+    Aws.config[:access_key_id] = 'XXX'
+    Aws.config[:secret_access_key] = 'XXX'
+
+    client = Aws::DynamoDB::Client.new
+    client.delete_table(table_name: 'test_delete_item') if client.list_tables[:table_names].include?('test_delete_item')
+    client.create_table(
+        table_name: 'test_delete_item',
+        attribute_definitions: [
+            {attribute_name: 'id', attribute_type: 'S'},
+        ],
+        key_schema: [
+            {attribute_name: 'id', key_type: 'HASH'}
+        ],
+        provisioned_throughput: {
+            read_capacity_units: 1,
+            write_capacity_units: 1,
+        })
+    client.put_item(table_name: 'test_delete_item', item: {id: 'hoge', name: '太郎'})
+    client.put_item(table_name: 'test_delete_item', item: {id: 'fuga', count: 0})
+    client.put_item(table_name: 'test_delete_item', item: {id: 'poyo', name: '可奈'})
+    client.put_item(table_name: 'test_delete_item', item: {id: 'piyo', name: '杏奈', count: 10})
+
+    class TestItem < Dymos::Model
+      table :test_delete_item
+      field :id, :string
+      field :name, :string
+      field :count, :string
+    end
+  end
+
+  let(:client) { Aws::DynamoDB::Client.new }
+  describe :put_item do
+    describe "クエリ生成" do
+      let(:query) { TestItem.delete.key(id: "hoge") }
+      it :query do
+        expect(query.query).to eq({
+                                      table_name: "test_delete_item",
+                                      key: {id: "hoge"},
+                                      return_values: "ALL_OLD",
+                                  })
+      end
+      it "成功すると削除したアイテムを返す" do
+        res = query.execute client
+        expect(res.id).to eq("hoge")
+      end
+
+      describe "既存のアイテムを削除" do
+        describe "return_values :ALL_OLD" do
+          it "条件なし" do
+            query = TestItem.delete.key(id: "poyo")
+            res = query.execute client
+            expect(res.id).to eq("poyo")
+            expect(TestItem.get.key(id: "poyo").execute).to eq(nil)
+          end
+
+          it "条件付き" do
+            query = TestItem.delete.key(id: "fuga").expected(count: "== 0")
+            res = query.execute
+            expect(res.id).to eq("fuga")
+            expect(TestItem.get.key(id: "fuga").execute).to eq(nil)
+          end
+          it "条件付き失敗" do
+            query = TestItem.delete.key(id: "piyo").expected(count: "== 1")
+            res = query.execute
+            expect(res).to eq(false)
+          end
+        end
+      end
+    end
+  end
+end
+

data/spec/lib/dymos/query/get_item_spec.rb

@@ -27,6 +27,7 @@ describe Dymos::Query::GetItem do
     class TestItem < Dymos::Model
       table :test_get_item
       field :id, :string
+      field :category_id, :number
     end
   end
 

data/spec/lib/dymos/query/put_item_spec.rb

@@ -25,6 +25,7 @@ describe Dymos::Query::PutItem do
     class TestItem < Dymos::Model
       table :test_put_item
       field :id, :string
+      field :name, :string
     end
   end
 

data/spec/lib/dymos/query/query_spec.rb

@@ -48,6 +48,7 @@ describe Dymos::Query::Query do
     class TestItem < Dymos::Model
       table :test_query_item
       field :id, :string
+      field :other_id, :number
     end
   end
 

data/spec/lib/dymos/query/scan_spec.rb

@@ -46,6 +46,10 @@ describe Dymos::Query::Scan do
       expect(res.first.metadata).to eq(count: 5, scanned_count: 5, last_evaluated_key: nil, consumed_capacity: nil)
     end
 
+
+    it :query do
+      expect(TestItem.scan.limit(100).exclusive_start_key('hoge').query).to eq(table_name: "test_get_item", exclusive_start_key:"hoge", limit: 100)
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dymos
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - hoshina85
@@ -127,8 +127,10 @@ files:
 - lib/dymos/attribute.rb
 - lib/dymos/command.rb
 - lib/dymos/model.rb
+- lib/dymos/persistence.rb
 - lib/dymos/query/attribute.rb
 - lib/dymos/query/builder.rb
+- lib/dymos/query/delete_item.rb
 - lib/dymos/query/describe.rb
 - lib/dymos/query/expect.rb
 - lib/dymos/query/get_item.rb
@@ -140,6 +142,7 @@ files:
 - spec/lib/dymos/model_spec.rb
 - spec/lib/dymos/query/attribute_spec.rb
 - spec/lib/dymos/query/builder_spec.rb
+- spec/lib/dymos/query/delete_item_spec.rb
 - spec/lib/dymos/query/describe_spec.rb
 - spec/lib/dymos/query/expect_spec.rb
 - spec/lib/dymos/query/get_item_spec.rb
@@ -176,6 +179,7 @@ test_files:
 - spec/lib/dymos/model_spec.rb
 - spec/lib/dymos/query/attribute_spec.rb
 - spec/lib/dymos/query/builder_spec.rb
+- spec/lib/dymos/query/delete_item_spec.rb
 - spec/lib/dymos/query/describe_spec.rb
 - spec/lib/dymos/query/expect_spec.rb
 - spec/lib/dymos/query/get_item_spec.rb