tarantool-record 0.4.0

data/LICENSE

@@ -0,0 +1,24 @@
+/*
+ * Copyright (C) 2011-2012 Mail.RU
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */

data/lib/tarantool/record.rb

@@ -0,0 +1,164 @@
+require 'active_model'
+require 'tarantool/base_record'
+
+module Tarantool
+  class Record < BaseRecord
+    extend ActiveModel::Naming
+    include ActiveModel::AttributeMethods
+    include ActiveModel::Validations
+    include ActiveModel::Serialization
+    extend ActiveModel::Callbacks
+    include ActiveModel::Dirty
+
+    include ActiveModel::Serializers::JSON
+    include ActiveModel::Serializers::Xml
+
+    define_model_callbacks :save, :create, :update, :destroy
+    define_model_callbacks :initialize, :only => :after
+
+    class << self
+      def set_space_no(val)
+        self.space_no = val
+      end
+
+      def set_tarantool(val)
+        case val.class.name
+        when 'Tarantool::BlockDB', 'Tarantool::FiberDB'
+          self.tarantool = val
+        else
+          raise "Tarantool should be blocking of fibered!!! (i.e. of class Tarantool::BlockDB or Tarantool::FiberDB) (got #{val.class})"
+        end
+      end
+
+      def define_field_accessor(name, type)
+        generated_attribute_methods.class_eval <<-"EOF", __FILE__, __LINE__ - 1
+          def #{name}
+            @attributes[:"#{name}"]
+          end
+        EOF
+
+        if Symbol === type
+          convert_code = case type
+             when :int, :int64, :varint
+               "v = v.to_i  if String === v"
+             when :string, :bytes
+               ""
+             else
+               if serializer = Serializers::MAP[type]
+                 "v = Serializers::MAP[#{type.inspect}].decode(v)  if String === v"
+               else
+                 raise ArgumentError, "unknown field type #{type.inspect}"
+               end
+             end
+
+          generated_attribute_methods.class_eval <<-"EOF", __FILE__, __LINE__ - 1
+            def #{name}=(v)
+              #{convert_code}
+              #{name}_will_change!  unless v == @attributes[:"#{name}"] || new_record?
+              @attributes[:"#{name}"] = v
+            end
+          EOF
+        else
+          generated_attribute_methods.class_eval do
+            define_method("#{name}=") do |v|
+              v = type.decode(v)  if String === v
+              send(:"#{name}_will_change!") unless v == @attributes[name]
+              @attributes[name] = v
+            end
+          end
+        end
+        define_attribute_method name
+      end
+    end
+
+    def initialize(attributes = {})
+      @__new_record = true
+      @attributes = self.class.default_values.dup
+      run_callbacks(:initialize) do
+        init attributes
+      end
+    end
+
+    def init(attributes)
+      set_attributes(attributes)
+    end
+
+    def __fetched(attributes)
+      @__new_record = false
+      # well, initalize callback could call #attributes
+      @attributes = self.class.default_values.dup
+      run_callbacks(:initialize) do
+        @attributes = attributes
+      end
+      self
+    end
+
+    def _in_callbacks(&blk)
+      run_callbacks(:save) {
+        run_callbacks(new_record? ? :create : :update, &blk)
+      }
+    end
+
+    def save(and_reload = true)
+      _in_callbacks do
+        if valid?
+          changes = changes()
+          if new_record?
+            if and_reload
+              @attributes = space.insert(@attributes, return_tuple: true)
+            else
+              space.insert(@attributes)
+            end
+          else
+            return true if changes.size == 0
+            ops = []
+            changes.each do |k, (old, new)|
+              ops << [k.to_sym, :set, new]
+            end
+            if and_reload
+              unless new_attrs = space.update(id, ops, return_tuple: true)
+                _raise_doesnt_exists
+              end
+            else
+              if space.update(id, ops) == 0
+                _raise_doesnt_exists
+              end
+            end
+          end
+          @previously_changed = changes
+          @changed_attributes.clear
+          old_record!
+          true
+        else
+          false
+        end
+      end
+    end
+
+    # update record in db first, reload updated fileds then
+    # (Contrasting with LightRecord, where it reloads all fields)
+    # Consider that update operation does not count changes made by
+    # attr setters in your code, only field values in DB.
+    #
+    #   record.update({:state => 'sleep', :sleep_count => [:+, 1]})
+    #   record.update([[:state, 'sleep'], [:sleep_count, :+, 1]])
+    def update(ops)
+      raise UpdateNewRecord, "Could not call update on new record"  if @__new_record
+      unless new_attrs = space.update(id, ops, return_tuple: true)
+        _raise_doesnt_exists
+      end
+      for op in ops
+        field = op.flatten.first
+        @attributes[field] = new_attrs[field]
+      end
+      self
+    end
+
+    def destroy
+      run_callbacks :destroy do
+        self.class.delete id
+        true
+      end
+    end
+  end
+end

data/test/test_record.rb

@@ -0,0 +1,89 @@
+# -*- coding: utf-8 -*-
+require File.expand_path('../shared_record', __FILE__)
+require 'tarantool/record'
+
+describe 'Tarantool::Record' do
+  before { TConf.run(:master1) }
+  let(:base_class){ Tarantool::Record }
+  it_behaves_like :record
+
+
+  describe "update" do
+    let(:user) { user_class.create login: 'prepor', name: 'Andrew', email: 'ceo@prepor.ru' }
+    it "should not reload fields not reffered in operations" do
+      user.name = "Petr"
+      user.update(email: "prepor@ceo.ru")
+      user.name.must_equal "Petr"
+      user.email.must_equal "prepor@ceo.ru"
+
+      fetched = user_class.by_pk('prepor')
+      fetched.name.must_equal "Andrew"
+      fetched.email.must_equal "prepor@ceo.ru"
+    end
+  end
+
+  describe "validations" do
+    describe "with validator on login size" do
+      before do
+        user_class.validates_length_of(:login, minimum: 3)
+      end
+      it "should invalidate all records with login less then 3 chars" do
+        u = user_class.new login: 'pr', name: 'Andrew', email: 'ceo@prepor.ru'
+        u.save.must_equal false
+        u.valid?.must_equal false
+        u.errors.size.must_equal 1
+        u.login = 'prepor'
+        u.save.must_equal true
+        u.valid?.must_equal true
+        u.errors.size.must_equal 0
+      end
+    end
+  end
+
+  describe "callbacks" do
+    let(:u) { user_class.new login: 'prepor', name: 'Andrew', email: 'ceo@prepor.ru '}
+    it "should run before / after create callbackss in right places" do
+      user_class.before_create :action_before_create
+      user_class.after_create :action_after_create      
+      mock(u).action_before_create { u.new_record?.must_equal true }
+      mock(u).action_after_create { u.new_record?.must_equal false }
+      u.save
+    end
+
+    describe "initialize" do
+      it "should run after_initialize after any initialization" do
+        user_class.after_initialize :action_after_initialize
+        any_instance_of(user_class) do |u|
+          mock(u).action_after_initialize.twice
+        end
+        u.save
+        user_class.find u.login
+      end
+
+      it "should not run after_initialize after reload" do        
+        user_class.after_initialize :action_after_initialize
+        any_instance_of(user_class) do |u|
+          mock(u).action_after_initialize.once
+        end
+        u.save
+        u.reload
+      end
+
+      it "should properly save record inside after_initialize" do
+        user_class.after_initialize do |u|
+          u.save
+        end
+        u
+        user_class.find u.login
+      end
+    end
+  end
+
+  describe "serialization" do
+    it "should support AM serialization API" do
+      h = { login: 'prepor', name: 'Andrew', email: 'ceo@prepor.ru' }
+      u = user_class.create h
+      u.as_json.must_equal({ 'user' => h.merge(apples_count: 0) })
+    end
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: tarantool-record
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Rudenko
+- Sokolov Yura 'funny-falcon'
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tarantool
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: active_model
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Tarantool KV-storage ActiveModel-aware Record.
+email:
+- ceo@prepor.ru
+- funny.falcon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README_RECORD.md
+- LICENSE
+files:
+- lib/tarantool/record.rb
+- test/test_record.rb
+- LICENSE
+- README_RECORD.md
+homepage: http://github.com/mailru/tarantool-ruby
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Tarantool KV-storage ActiveModel-aware Record.
+test_files:
+- test/test_record.rb