tiny_ds 0.0.1

data/lib/tiny_ds/base_tx.rb~

@@ -0,0 +1,180 @@
+=begin
+使い方
+class TxMoveUserPoint < BaseTx
+  def src_phase(src, args)
+    src[:point] -= args[:amount]
+  end
+  def dest_phase(dest, args)
+    dest[:point] += args[:amount]
+  end
+end
+
+u1 = User.create(:point=>1000)                                   
+=> #<User @sid=21 @name=nil @message=nil @point=1000 @created_at=Thu, 17 Dec 2009 21:14:29 +0900 @updated_at=Thu, 17 Dec 2009 21:14:29 +0900>
+
+u2 = User.create(:point=>1000)                                   
+=> #<User @sid=22 @name=nil @message=nil @point=1000 @created_at=Thu, 17 Dec 2009 21:14:33 +0900 @updated_at=Thu, 17 Dec 2009 21:14:33 +0900>
+
+TxMoveUserPoint.exec(u1.__entity__, u2.__entity__, :amount=>200)  
+=> true
+
+u1.reload
+=> #<User @sid=21 @name=nil @message=nil @point=800 @created_at=Thu, 17 Dec 2009 21:14:29 +0900 @updated_at=Thu, 17 Dec 2009 21:14:29 +0900>
+
+u2.reload
+=> #<User @sid=22 @name=nil @message=nil @point=1200 @created_at=Thu, 17 Dec 2009 21:14:33 +0900 @updated_at=Thu, 17 Dec 2009 21:14:33 +0900>
+
+TxMoveUserPoint.roll_forward_all
+=end
+# memo デプロイ時に未完了のトランザクションがあってトランザクション定義がかわったら？version???
+
+class BaseTx
+  LowDS = TinyDS::LowDS
+
+  def src_phase(src, args)
+    raise "no impl."
+  end
+  def dest_phase(dest, args)
+    raise "no impl."
+  end
+  def self.tx_kind
+    name
+  end
+  def roll_forward_retries_limit
+    100
+  end
+  attr_reader :tx_key
+
+  # トランザクション実行
+  #          :  src_phase   dest_phase
+  #   raised :    failed      ----
+  #   false  :    OK          failed
+  #   true   :    OK          OK
+  def self.exec(src, dest, args={})
+    tx = new
+    tx.create_tx(src, dest, args)
+    begin
+      tx.roll_forward
+    rescue AppEngine::Datastore::TransactionFailed => e
+      return false
+    end
+    return true
+  end
+
+  def self.roll_forward_all(limit=50)
+    pending_tx_query.each(:limit=>limit) do |tx_ent|
+      tx = new
+      tx.restore_tx(tx_ent)
+      begin
+        tx.roll_forward
+      rescue => e
+        # logger.warn("roll_forward failed. tx=[#{tx.tx_key}] e=[#{e.inspect}]")
+      end
+    end
+    nil
+  end
+
+  def self.pending_tx_query(status="pending", dire=:asc) # pending/done/failed
+    direction = dire==:desc ? AppEngine::Datastore::Query::DESCENDING : AppEngine::Datastore::Query::ASCENDING
+    AppEngine::Datastore::Query.new("TxSrc").
+      filter(:tx_kind, AppEngine::Datastore::Query::EQUAL, tx_kind).
+      filter(:status,  AppEngine::Datastore::Query::EQUAL, status).
+      sort(:created_at, direction)
+  end
+
+  # doneなTxSrcと対応するTxDoneを削除する
+#  def self.delete_done_tx
+#  end
+
+  require "benchmark"
+  def create_tx(src, dest, args)
+    #RAILS_DEFAULT_LOGGER.info ["create_tx", Benchmark.measure{
+      _create_tx(src, dest, args)
+    #}].inspect
+  end
+  def roll_forward
+    #RAILS_DEFAULT_LOGGER.info ["roll_forward", Benchmark.measure{
+      _roll_forward
+    #}].inspect
+  end
+
+  # トランザクション前半
+  #   TODO TxIDを指定できるようにする。TxSrc#key.nameにTxIDを指定して重複実行防止
+  def _create_tx(src, dest, args)
+    tx_ent = nil
+    ds_transaction{
+      src = src.class.get(src.key)
+      src_phase(src, args)
+      src.save
+
+      attrs = {
+        :tx_kind                   => self.class.tx_kind,
+        :dest_key                  => dest.key.to_s,
+        :status                    => "pending",
+        :roll_forward_failed_count => 0,
+        :args                      => args.to_yaml,
+        :created_at                => Time.now
+      }
+      tx_ent = LowDS.create("TxSrc", attrs, :parent=>src.entity) # srcがparent, tx_entがchild
+      # COMMIT:「srcの処理(=src_phase)、TxSrc作成」
+    }
+    @tx_key = tx_ent.key.to_s
+    nil
+  end
+
+  def restore_tx(tx_ent)
+    @tx_key = tx_ent.key.to_s
+    nil
+  end
+
+  # トランザクション後半
+  def _roll_forward
+    tx_ent = LowDS.get(@tx_key, :kind=>"TxSrc")
+
+    ds_transaction{
+      dest_key = LowDS::KeyFactory.stringToKey(tx_ent[:dest_key])
+      dest = dest_key.kind.constantize.get(dest_key)
+      done_name = "TxDone_#{@tx_key}"
+      done_key = LowDS::KeyFactory.createKey(dest.key, "TxDone", done_name)
+      begin
+        LowDS.get(done_key, "TxDone")
+        # なにもしない : TxDoneが存在しているということはdest_phaseは処理済み
+      rescue AppEngine::Datastore::EntityNotFound => e
+        # TxDoneが無い→dest_phaseが未実行
+        attrs = {:done_at=>Time.now}
+        done_ent = LowDS.create("TxDone", attrs, :parent=>dest.entity, :name=>done_name)
+        dest_phase(dest, YAML.load(tx_ent[:args])) # destの処理を実行
+        dest.save
+      end
+      # memo: done_keyが同じTxDoneをcommitしようとするとTransactionFailedになるはず→dest_phaseもキャンセル
+      # COMMIT:「destの処理(=dest_phase)、TxDone作成」
+    }
+
+    # TxSrc#statusをdoneに
+    ds_transaction{
+      tx_ent = LowDS.get(@tx_key, :kind=>"TxSrc")
+      if tx_ent[:status]=="pending"
+        tx_ent[:status] = "done"
+        tx_ent[:done_at] = Time.now
+        LowDS.save(tx_ent)
+      end
+    }
+    return true
+  rescue
+    ds_transaction{
+      tx_ent = LowDS.get(@tx_key, :kind=>"TxSrc")
+      tx_ent[:roll_forward_failed_count] += 1
+      if roll_forward_retries_limit < tx_ent[:roll_forward_failed_count]
+        tx_ent[:status] = "failed"
+      end
+      LowDS.save(tx_ent)
+    }
+    return false
+  end
+
+  # EntityGroup単位のtransaction
+  def ds_transaction(&block)
+    retries = 3
+    AppEngine::Datastore.transaction(retries, &block)
+  end
+end

data/lib/tiny_ds/low_ds.rb

@@ -0,0 +1,77 @@
+require 'appengine-apis/datastore'
+
+module TinyDS
+module LowDS
+  KeyFactory = com.google.appengine.api.datastore.KeyFactory
+
+  # build
+  def self.build(kind, attrs, opts={})
+    raise "invalid kind=#{kind}" unless kind.kind_of?(String)
+    raise "invalid opts=#{opts.inspect}" if [:id, :name, :key].collect{|k| opts[k] }.compact.size >= 2
+    raise ":id must be Integer"  if opts[:id]   && !opts[:id].kind_of?(Integer)
+    raise ":name must be String" if opts[:name] && !opts[:name].kind_of?(String)
+    raise ":key must be Key or String" if opts[:key] && !(opts[:key].kind_of?(String) || opts[:key].kind_of?(AppEngine::Datastore::Key))
+    name_or_id = opts[:name] || opts[:id] # name(String) or id(Integer)
+    key        = opts[:key].kind_of?(String) ? KeyFactory.stringToKey(opts[:key]) : opts[:key]
+    parent     = opts[:parent]
+    ent = if key
+            AppEngine::Datastore::Entity.new(key)
+          elsif parent
+            parent_key = case parent
+                         when AppEngine::Datastore::Entity; parent.key
+                         when AppEngine::Datastore::Key;    parent
+                         when String; KeyFactory.stringToKey(parent)
+                         else raise "invalid parent type parent=[#{parent.inspect}]"
+                         end
+            if name_or_id
+              new_key = KeyFactory.createKey(parent_key, kind, name_or_id)
+              AppEngine::Datastore::Entity.new(new_key)
+            else
+              AppEngine::Datastore::Entity.new(kind, parent_key)
+            end
+          else
+            if name_or_id
+              new_key = KeyFactory.createKey(kind, name_or_id)
+              AppEngine::Datastore::Entity.new(new_key)
+            else
+              AppEngine::Datastore::Entity.new(kind)
+            end
+          end
+    attrs.each do |k,v|
+      ent[k] = v
+    end
+    ent
+  end
+
+  # create
+  def self.create(kind, attrs, opts={})
+    ent = build(kind, attrs, opts)
+    AppEngine::Datastore.put(ent)
+    ent
+  end
+
+  # get by key
+  def self.get(key, opts={})
+    key = case key
+          when AppEngine::Datastore::Key; key
+          when String; KeyFactory.stringToKey(key)
+          else raise "invalid key type key.class=[#{key.class}] key.inspect=[#{key.inspect}]"
+          end
+    ent = AppEngine::Datastore.get(key)
+    if opts[:kind]
+      raise "kind missmatch. #{ent.kind}!=#{opts[:kind]}" if ent.kind!=opts[:kind]
+    end
+    ent
+  end
+
+  # update
+  def self.save(ent)
+    AppEngine::Datastore.put(ent)
+  end
+
+  # delete
+  def self.delete(ent)
+    AppEngine::Datastore.delete([ent.key])
+  end
+end
+end

data/lib/tiny_ds/low_ds.rb~

@@ -0,0 +1,80 @@
+module LowDS
+  KeyFactory = com.google.appengine.api.datastore.KeyFactory
+
+  # create
+  def self.build(kind, attrs, opts={})
+    raise "invalid opts=#{opts.inspect}" if [:id, :name, :key].collect{|k| opts[k] }.compact.size >= 2
+    raise ":id must be Integer"  if opts[:id]   && !opts[:id].kind_of?(Integer)
+    raise ":name must be String" if opts[:name] && !opts[:name].kind_of?(String)
+    raise ":key must be Key or String" if opts[:key] && !(opts[:key].kind_of?(String) || opts[:key].kind_of?(AppEngine::Datastore::Key))
+    name_or_id = opts[:name] || opts[:id] # name(String) or id(Integer)
+    key        = opts[:key].kind_of?(String) ? KeyFactory.stringToKey(parent) : opts[:key]
+    parent     = opts[:parent]
+    ent = if key
+            AppEngine::Datastore::Entity.new(key)
+          elsif parent
+            parent_key = case parent
+                         when AppEngine::Datastore::Entity; parent.key
+                         when AppEngine::Datastore::Key;    parent
+                         when String; KeyFactory.stringToKey(parent)
+                         else raise "invalid parent type parent=[#{parent.inspect}]"
+                         end
+            if name_or_id
+              new_key = KeyFactory.createKey(parent_key, kind, name_or_id)
+              AppEngine::Datastore::Entity.new(new_key)
+            else
+              AppEngine::Datastore::Entity.new(kind, parent_key)
+            end
+          else
+            if name_or_id
+              new_key = KeyFactory.createKey(kind, name_or_id)
+              AppEngine::Datastore::Entity.new(new_key)
+            else
+              AppEngine::Datastore::Entity.new(kind)
+            end
+          end
+    attrs.each do |k,v|
+      ent[k] = v
+    end
+    ent
+  end
+
+  def self.create(kind, attrs, opts={})
+    ent = build(kind, attrs, opts)
+    AppEngine::Datastore.put(ent)
+    ent
+  end
+
+  # get by key
+  def self.get(key, opts={})
+    key = case key
+          when AppEngine::Datastore::Key; key
+          when String; KeyFactory.stringToKey(key)
+          else raise "invalid key type key.class=[#{key.class}] key.inspect=[#{key.inspect}]"
+          end
+    ent = AppEngine::Datastore.get(key)
+    if opts[:kind]
+      raise "kind missmatch. #{ent.kind}!=#{opts[:kind]}" if ent.kind!=opts[:kind]
+    end
+    ent
+  end
+
+  # search
+  def self.search
+    # TODO
+  end
+
+  # update
+  def self.save(ent)
+    AppEngine::Datastore.put(ent)
+  end
+
+  # delete
+  def self.delete(ent)
+    AppEngine::Datastore.delete(ent.key)
+  end
+
+  def self.tx(retries=0, &block)
+    AppEngine::Datastore.transaction(retries, &block)
+  end
+end

data/lib/tiny_ds/property_definition.rb

@@ -0,0 +1,68 @@
+module TinyDS
+class PropertyDefinition
+  def initialize(pname, ptype, opts)
+    @pname = pname
+    @ptype = ptype
+    @opts  = opts
+  end
+  def default_value
+    raise "no default." unless has_default?
+    default = @opts[:default]
+    case default
+    when Proc
+      default.call
+    else
+      default
+    end
+  end
+  def has_default?
+    @opts.has_key?(:default)
+  end
+  def to_ds_value(v)
+    case @ptype
+    when :string
+      v.nil? ? nil : v.to_s
+    when :integer
+      v.nil? ? nil : v.to_i
+    when :text
+      v.nil? ? nil : com.google.appengine.api.datastore::Text.new(v.to_s)
+    when :time
+      case v
+      when Time
+        v
+      when NilClass
+        nil
+      else
+        raise "not Time value."
+      end
+    when :list
+      case v
+      when Array
+        v.empty? ? nil : v
+      when NilClass
+        nil
+      else
+        raise "not Array value."
+      end
+    else
+      raise "unknown property type '#{@ptype}'"
+    end
+  end
+  def to_ruby_value(ds_v)
+    case @ptype
+    when :string
+      ds_v.nil? ? nil : ds_v.to_s
+    when :integer
+      ds_v.nil? ? nil : ds_v.to_i
+    when :text
+      ds_v.nil? ? nil : ds_v.to_s
+    when :time
+      ds_v.nil? ? nil : ds_v
+    when :list
+      ds_v.nil? ? []  : ds_v.to_a
+    else
+      raise "unknown property type '#{@ptype}'"
+    end
+  end
+end
+end

data/lib/tiny_ds/property_definition.rb~

@@ -0,0 +1,54 @@
+module TinyDS
+  class PropertyDefinition
+    def initialize(pname, ptype, opts)
+      @pname = pname
+      @ptype = ptype
+      @opts  = opts
+    end
+    def default_value
+      if @opts.has_key?(:default)
+        default = @opts[:default]
+        case default
+        when Proc
+          default.call
+        else
+          default
+        end
+      end
+    end
+    def to_ds_value(v)
+      return nil if v.nil?
+      case @ptype
+      when :string
+        v.to_s
+      when :integer
+        v.to_i
+      when :text
+        com.google.appengine.api.datastore::Text.new(java.lang.String.new(v))
+      when :time
+        Time.parse(v.to_s)
+      #when :list
+      #  raise "todo"
+      else
+        raise "unknown type @ptype=#{@ptype}"
+      end
+    end
+    def to_ruby_value(ds_v)
+      return nil if ds_v.nil?
+      case @ptype
+      when :string
+        ds_v.to_s
+      when :integer
+        ds_v.to_i
+      when :text
+        ds_v.to_s
+      when :time
+        Time.parse(ds_v.to_s)
+      #when :list
+      #  raise "todo"
+      else
+        raise "unknown type @ptype=#{@ptype}"
+      end
+    end
+  end
+end

data/lib/tiny_ds/query.rb

@@ -0,0 +1,76 @@
+module TinyDS
+class Query
+  def initialize(model_class)
+    @model_class = model_class
+    @q = AppEngine::Datastore::Query.new(@model_class.kind)
+  end
+  def ancestor(anc)
+    anc = case anc
+          when Base;   anc.key
+          when String; LowDS::KeyFactory.stringToKey(anc)
+          when AppEngine::Datastore::Key; anc
+          else raise "unknown type. anc=#{anc.inspect}"
+          end
+    @q.set_ancestor(anc)
+    self
+  end
+  def filter(*args)
+    if args.size==1 && args.first.kind_of?(Hash)
+      args.first.each do |k,v|
+        filter(k,"==",v)
+      end
+    else
+      name, operator, value = *args
+      @model_class.property_definition(name) # check exist?
+      @q.filter(name, operator, value)
+    end
+    self
+  end
+  def sort(name, dir=:asc)
+    @model_class.property_definition(name) # check exist?
+    direction = {
+      :asc  => AppEngine::Datastore::Query::ASCENDING,
+      :desc => AppEngine::Datastore::Query::DESCENDING
+    }[dir]
+    @q.sort(name, direction)
+    self
+  end
+  def keys_only
+    @q.java_query.setKeysOnly
+    self
+  end
+  def count #todo(tx=nil)
+    @q.count
+  end
+  def one #todo(tx=nil)
+    @model_class.new_from_entity(@q.entity)
+  end
+  def all(opts={}) #todo(tx=nil)
+    models = []
+    @q.each(opts) do |entity|
+      models << @model_class.new_from_entity(entity)
+    end
+    models
+  end
+  def each(opts={}) #todo(tx=nil)
+    @q.each(opts) do |entity|
+      yield(@model_class.new_from_entity(entity))
+    end
+  end
+  def collect(opts={}) #todo(tx=nil)
+    collected = []
+    @q.each(opts) do |entity|
+      collected << yield(@model_class.new_from_entity(entity))
+    end
+    collected
+  end
+  def keys(opts={}) #todo(tx=nil)
+    keys = []
+    self.keys_only
+    @q.each(opts) do |entity|
+      keys << entity.key
+    end
+    keys
+  end
+end
+end

data/lib/tiny_ds/query.rb~

@@ -0,0 +1,68 @@
+module TinyDS
+  class Query
+    def initialize(model_class)
+      @model_class = model_class
+      @q = AppEngine::Datastore::Query.new(@model_class.kind)
+    end
+    def ancestor(anc)
+      anc = case anc
+            when Base;   anc.key
+            when String; LowDS::KeyFactory.stringToKey(anc)
+            when AppEngine::Datastore::Key; anc
+            else raise "unknown type. anc=#{anc.inspect}"
+            end
+      @q.set_ancestor(anc)
+      self
+    end
+    def filter(name, operator, value)
+      @q.filter(name, operator, value)
+      self
+    end
+    def sort(name, dir=:asc)
+      direction = {
+        :asc  => AppEngine::Datastore::Query::ASCENDING,
+        :desc => AppEngine::Datastore::Query::DESCENDING
+      }[dir]
+      @q.sort(name, direction)
+      self
+    end
+    def keys_only
+      @q.java_query.setKeysOnly
+      self
+    end
+
+    def count #todo(tx=nil)
+      @q.count
+    end
+    def one #todo(tx=nil)
+      @model_class.new_from_entity(@q.entity)
+    end
+    def all(opts={}) #todo(tx=nil)
+      models = []
+      @q.each(opts) do |entity|
+        models << @model_class.new_from_entity(entity)
+      end
+      models
+    end
+    def each(opts={}) #todo(tx=nil)
+      @q.each(opts) do |entity|
+        yield(@model_class.new_from_entity(entity))
+      end
+    end
+    def collect(opts={}) #todo(tx=nil)
+      collected = []
+      @q.each(opts) do |entity|
+        collected << yield(@model_class.new_from_entity(entity))
+      end
+      collected
+    end
+    def keys(opts={}) #todo(tx=nil)
+      keys = []
+      self.keys_only
+      @q.each(opts) do |entity|
+        keys << entity.key
+      end
+      keys
+    end
+  end
+end

data/lib/tiny_ds/validations.rb

@@ -0,0 +1,26 @@
+module TinyDS
+  class Base
+    def valid?
+      true # todo
+    end
+    def self.create!(attrs={}, opts={})
+      m = new(attrs, opts)
+      m.save!
+      m
+    end
+    def save
+      save!
+      true
+    rescue RecordInvalid => e
+      false
+    end
+    def save!
+      unless valid?
+        raise RecordInvalid
+      end
+      do_save
+    end
+  end
+  class RecordInvalid < StandardError
+  end
+end

data/lib/tiny_ds/validations.rb~

@@ -0,0 +1,9 @@
+
+module TinyDS
+  module Validations
+    def save
+    end
+    def save!
+    end
+  end
+end

data/lib/tiny_ds/version.rb

@@ -0,0 +1,3 @@
+module TinyDS
+  VERSION = '0.0.1'.freeze
+end

data/lib/tiny_ds.rb

@@ -0,0 +1,16 @@
+require 'appengine-apis'
+require 'appengine-apis/datastore'
+require File.dirname(__FILE__)+"/tiny_ds/low_ds.rb"
+require File.dirname(__FILE__)+"/tiny_ds/property_definition.rb"
+require File.dirname(__FILE__)+"/tiny_ds/base.rb"
+require File.dirname(__FILE__)+"/tiny_ds/query.rb"
+require File.dirname(__FILE__)+"/tiny_ds/validations.rb"
+require File.dirname(__FILE__)+"/tiny_ds/base_tx.rb"
+
+module TinyDS
+  def self.tx(retries=0, &block)
+    AppEngine::Datastore.transaction(retries){
+      yield(block)
+    }
+  end
+end

data/lib/tiny_ds.rb~

@@ -0,0 +1,2 @@
+module TinyDS
+end

data/lib/tinyds.rb~

@@ -0,0 +1,2 @@
+module TinyDs
+end