bean_sprout 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4733d40d0fe67374824dead281510cda6053ec71
-  data.tar.gz: e8865c4596897622f821e6c379c3d766732def86
+  metadata.gz: 8f8703dcac93814b06f78ef5c7f6081d41e3809c
+  data.tar.gz: 3d50d400de7ff74305f88db06a0feef6c6816658
 SHA512:
-  metadata.gz: d13adb40a9589069865f7c72e217fc92017fc1db491040dc87fba2f30e8a6fa73dff009cb10a63b6a5956243e1a9a7885b5549ac87ff1f1652ba45602d201b39
-  data.tar.gz: 8a608a9d8d6822c9c04f4b0ae26493eedef5b9ce3c5ceb2ba39a05a35f4532e8295cc92a19486ea94cd8b12bf3192374917969428b04177ef59edfad2f08e87c
+  metadata.gz: 73181700e7e1a3e20b552bc4010cdd4820718fc19c7990968183fad0e8f3e4aa99a49b043099e261e5a60556b06a7d5e56de2744516f54babbb0776dcba93c41
+  data.tar.gz: 85fb4800498552ed1a3a5f3b491c07456467044f048682ea3198387bef22f1ff407634449f8723ca9991d5646939242f7c58fd9b9a9c7c0edc24559b76e32757

data/lib/bean_sprout/account.rb

@@ -1,31 +1,46 @@
-require 'bean_sprout/struct_from_hash_mixin'
-require 'bean_sprout/struct_archive_mixin'
+require 'bean_sprout/package_private'
 
 module BeanSprout
-  class Account < Struct.new(:currency, :external_id, :other_data)
-    include StructFromHashMixin
-    include StructArchiveMixin
+  # TODO: abstract :id?
+  class Bean
+    include PackagePrivate::InternalClass
 
-    class BalanceHolder < Struct.new(:value)
-    end
+    attr_reader :id, :balance, :currency, :sprouts
+
+    define_public_interface :Account
 
-    def initialize *fields
-      super *fields
-      @entries = []
-      @balance = BalanceHolder.new(0)
+    def initialize id, currency
+      @id = id
+      @currency = currency
+
+      @sprouts = Set.new
+      @balance = 0
     end
 
-    def append_entry entry
-      @entries.push entry
-      @balance.value += entry.accurate_amount
+    def grow sprout
+      @sprouts.add sprout
+      @balance += sprout.amount
     end
 
-    def entries
-      @entries.clone
+    def pick sprout
+      @sprouts.delete sprout
+      @balance -= sprout.amount
     end
+  end
+
+  # Public interface.
+  class Account < PackagePrivate::PublicInterfaceBase
+    def_default_delegators :balance, :currency
+    def_private_default_delegators :sprouts
 
-    def balance
-      @balance.value
+    def entries
+      sprouts.map do |sprout|
+        if block_given?
+          yield sprout.to_entry
+        else
+          sprout.to_entry
+        end
+      end
     end
   end
 end

data/lib/bean_sprout/entry.rb

@@ -1,5 +1,4 @@
-require 'bean_sprout/struct_from_hash_mixin'
-require 'bean_sprout/struct_archive_mixin'
+require 'bean_sprout/package_private'
 require 'bigdecimal'
 require 'bigdecimal/util'
 
@@ -10,16 +9,31 @@ module BeanSprout
   # 2. The amount to be added to the account balance, in local currency;
   # 3. Convention rate from local currency to the base currency;
   # 4. Other arbitrary data.
-  class Entry < Struct.new(:account, :amount, :rate, :other_data)
-    include StructFromHashMixin
-    include StructArchiveMixin
+  class Sprout
+    include PackagePrivate::InternalClass
+    attr_reader :id, :bean, :amount, :rate
 
-    def rate_or_one
-      rate or 1
+    define_public_interface :Entry
+
+    def initialize id, bean, amount, rate = 1
+      @id = id
+      @bean = bean
+      @amount = amount.to_d
+      @rate = rate
+    end
+
+    def unified_amount
+      amount * rate
     end
+  end
+
+  # Public Interface.
+  class Entry < PackagePrivate::PublicInterfaceBase
+    def_default_delegators :amount, :unified_amount, :rate
+    def_private_default_delegators :bean
 
-    def accurate_amount
-      @accurate_amount ||= amount.to_d
+    def account
+      bean.to_account
     end
   end
 end

data/lib/bean_sprout/forwardable_delegate.rb

@@ -0,0 +1,24 @@
+require 'forwardable'
+
+module BeanSprout
+  class ForwardableDelegate
+    extend Forwardable
+
+    def initialize obj
+      @target = obj
+    end
+
+    class << self
+      def def_default_delegators *args
+        def_delegators :@target, *args
+      end
+
+      def def_private_default_delegators *args
+        def_default_delegators *args
+        private *args
+      end
+
+      private :def_default_delegators, :def_private_default_delegators
+    end
+  end
+end

data/lib/bean_sprout/ledger.rb

@@ -0,0 +1,129 @@
+require 'bean_sprout/sparse_array'
+require 'bean_sprout/account'
+require 'bean_sprout/entry'
+require 'bean_sprout/transaction'
+
+module BeanSprout
+  class Ledger
+    attr_reader :base_currency
+
+    def initialize base_currency
+      @base_currency = base_currency
+
+      @beans = SparseArray.new
+      @sprout_bunches = SparseArray.new
+      @sprouts = SparseArray.new
+    end
+
+    def create_account currency, other_data: nil
+      bean = @beans.store do |next_id|
+        Bean.new(next_id, currency)
+      end
+
+      Account.new(bean, other_data)
+    end
+
+    def create_entry account, amount, rate = nil, other_data: nil
+      bean = get_target account
+      if not @beans.has_key? bean.id
+        raise "Unkown account #{bean.to_account} refered."
+      end
+
+      if not (rate or bean.currency == base_currency)
+        raise "Rate must be specified if account is not in base currency " +
+          "#{base_currency}."
+      end
+      rate ||= 1
+
+
+      sprout = @sprouts.store do |next_id|
+        Sprout.new(next_id, bean, amount, rate)
+      end
+
+      Entry.new(sprout, other_data)
+    end
+
+    def create_transaction entries, other_data: nil
+      sprouts = entries.map do |entry| get_target entry end
+      sprout_bunch = @sprout_bunches.store do |next_id|
+        SproutBunch.new(next_id, sprouts)
+      end
+
+      Transaction.new(sprout_bunch, other_data)
+    end
+
+    def transfer from_acc, to_acc, amount
+      if from_acc.currency != @base_currency || to_acc.currency != @base_currency
+        raise "Cannot transfer between two forex accounts."
+      end
+
+      entry0 = create_entry from_acc, -amount
+      entry1 = create_entry to_acc, amount
+      commit_entries [entry0, entry1]
+    end
+
+    def base_currency_forex_transfer from_acc, to_acc, from_amount, to_amount
+      raise "Amount can't be 0." unless from_amount != 0 && to_amount != 0
+
+      rate0 = rate1 = nil
+      if from_acc.currency == @base_currency
+        rate1 = from_amount / to_amount
+      elsif to_acc.currency == @base_currency
+        rate0 = to_amount / from_amount
+      else
+        raise "Forex transfer must be to or from an account of base currency."
+      end
+
+      entry0 = create_entry from_acc, -from_amount, rate0
+      entry1 = create_entry to_acc, to_amount, rate1
+      commit_entries [entry0, entry1]
+    end
+
+    # TODO: clients can't access ID.
+    def account id
+      @beans.fetch(id).to_account
+    end
+
+    # TODO: clients can't access ID.
+    def transaction id
+      @sprout_bunches.fetch(id).to_transaction
+    end
+
+    # TODO: test
+    def accounts
+      @beans.values.map do |bean|
+        if block_given?
+          yield bean.to_account
+        else
+          bean.to_account
+        end
+      end
+    end
+
+    # TODO: test
+    def transactions
+      @sprout_bunches.values.map do |sprout_bunch|
+        if block_given?
+          yield sprout_bunch.to_transaction
+        else
+          sprout_bunch.to_transaction
+        end
+      end
+    end
+
+    def dummy_account
+      @dummy_account ||= create_account @base_currency, other_data: "This is a dummy account."
+    end
+
+    private
+    def get_target obj
+      obj.instance_variable_get :@target
+    end
+
+    def commit_entries entries
+      trans = create_transaction entries
+      trans.commit
+      trans
+    end
+  end
+end

data/lib/bean_sprout/package_private.rb

@@ -0,0 +1,41 @@
+require 'bean_sprout/forwardable_delegate'
+
+module BeanSprout
+  # Implements the concept of package private methods.
+  module PackagePrivate
+    # A module to be included by the delegatee.
+    module InternalClass
+      # The public interface, set by PublicInterfaceBase.
+      attr_reader :public_interface
+
+      def self.included klass
+        klass.extend ClassMethods
+      end
+
+      def bind_public_interface public_interface
+        raise "Cannot bind public interface to null." if public_interface.nil?
+        raise "Cannot bind public interface twice." unless @public_interface.nil?
+        @public_interface = public_interface
+      end
+
+      module ClassMethods
+        def define_public_interface klass_name
+          define_method "to_#{(klass_name.to_s.split "::").last.downcase}" do
+            @public_interface
+          end
+        end
+      end
+    end
+
+    # A base class for delegator classes.
+    class PublicInterfaceBase < ForwardableDelegate
+      def initialize obj, other_data = nil
+        super(obj)
+        obj.bind_public_interface self
+        @other_data = other_data
+      end
+
+      attr_accessor :other_data
+    end
+  end
+end

data/lib/bean_sprout/sparse_array.rb

@@ -0,0 +1,33 @@
+require 'forwardable'
+
+module BeanSprout
+  class SparseArray
+    extend Forwardable
+
+    def_delegators :@entities, :each, :has_key?, :each_value, :values
+
+    def initialize index_offset = 0
+      @entities = {}
+      @index = index_offset
+    end
+
+    def store
+      index = next_index
+      @entities[index] = yield index
+    end
+
+    def fetch index
+      @entities[index]
+    end
+
+    def fetch! index
+      raise "Unkown index #{index}." unless @entities.has_key? index
+      fetch index
+    end
+
+    private
+    def next_index
+      @index += 1
+    end
+  end
+end

data/lib/bean_sprout/transaction.rb

@@ -1,29 +1,87 @@
-require 'bean_sprout/struct_archive_mixin'
+require 'bean_sprout/package_private'
 
 module BeanSprout
-  class Transaction < Struct.new(:entries, :other_data)
-    include StructFromHashMixin
-    include StructArchiveMixin
+  class SproutBunch
+    include PackagePrivate::InternalClass
 
-    alias entries_data entries
-    private :entries_data
+    attr_reader :sprouts
+
+    define_public_interface :Transaction
+
+    class NotBalancedError < StandardError
+    end
+
+    class IllegalStateError < StandardError
+    end
+
+    def initialize id, sprouts
+      @id = id
+      @sprouts = sprouts
+    end
 
-    public
     def balanced?
       balance = 0
-      entries_data.each do |entry|
-        balance += entry.accurate_amount / entry.rate_or_one
+      @sprouts.each do |sprout|
+        balance += sprout.unified_amount
       end
       balance == 0
     end
 
     def balanced!
-      raise "#{entries_data} is not balanced." unless balanced?
+      raise NotBalancedError.new("#{@sprouts} not balanced.") unless balanced?
+    end
+
+    def plant
+      balanced!
+      raise IllegalStateError, "Can't plant twice." if @in_place
+      sprouts.each do |sprout|
+        sprout.bean.grow sprout
+      end
+      @in_place = true
+    end
+
+    def remove
+      balanced!
+      raise IllegalStateError, "Must plant before remove." unless @in_place
+      sprouts.each do |sprout|
+        sprout.bean.pick sprout
+      end
+      @in_place = false
+    end
+  end
+
+  class Transaction < PackagePrivate::PublicInterfaceBase
+    def_default_delegators :balanced?
+    def_private_default_delegators :sprouts, :plant, :remove
+
+    def commit
+      begin
+        plant
+      rescue SproutBunch::NotBalancedError
+        raise "Cannot commit an imbalance transaction."
+      rescue SproutBunch::IllegalStateError
+        raise "Cannot commit a transaction more than once."
+      end
+    end
+
+    def revert
+      begin
+        remove
+      rescue SproutBunch::NotBalancedError
+        raise "Cannot revert an imbalance transaction."
+      rescue SproutBunch::IllegalStateError
+        raise "Cannot revert a transaction more than once."
+      end
     end
 
     def entries
-      entries_data.clone
+      sprouts.map do |sprout|
+        if block_given?
+          yield sprout.to_entry
+        else
+          sprout.to_entry
+        end
+      end
     end
   end
 end
-

data/lib/bean_sprout/version.rb

@@ -1,3 +1,3 @@
 module BeanSprout
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/bean_sprout.rb

@@ -1,8 +1,6 @@
 require 'bean_sprout/account'
 require 'bean_sprout/entry'
-require 'bean_sprout/glass_jar'
-require 'bean_sprout/struct_archive_mixin'
-require 'bean_sprout/struct_from_hash_mixin'
+require 'bean_sprout/ledger'
 require 'bean_sprout/transaction'
 require 'bean_sprout/version'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bean_sprout
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Liqing Muyi
@@ -64,9 +64,10 @@ files:
 - lib/bean_sprout.rb
 - lib/bean_sprout/account.rb
 - lib/bean_sprout/entry.rb
-- lib/bean_sprout/glass_jar.rb
-- lib/bean_sprout/struct_archive_mixin.rb
-- lib/bean_sprout/struct_from_hash_mixin.rb
+- lib/bean_sprout/forwardable_delegate.rb
+- lib/bean_sprout/ledger.rb
+- lib/bean_sprout/package_private.rb
+- lib/bean_sprout/sparse_array.rb
 - lib/bean_sprout/transaction.rb
 - lib/bean_sprout/version.rb
 homepage: http://github.com/muyiliqing/bean_sprout

data/lib/bean_sprout/glass_jar.rb

@@ -1,123 +0,0 @@
-module BeanSprout
-  class GlassJar
-    # TODO: maybe each transaction can have its own
-    # currency.
-    attr_reader :base_currency
-
-    def initialize base_currency
-      @base_currency = base_currency
-
-      @accounts = {}
-      @account_id = 0
-      @account_external_ids = {}
-
-      @transactions = {}
-      @transaction_id = 0
-
-      @entries = {}
-    end
-
-    def open_account account
-      account.archive_in_glass_jar self, next_account_id
-      @accounts[account.id] = account
-      @account_external_ids[account.external_id] = account
-    end
-
-    def create_account currency, external_id = nil, other_data: nil
-      account = Account.new currency, external_id, other_data
-      open_account account
-    end
-
-    def accounts
-      @accounts.values
-    end
-
-    def account id
-      @accounts[id]
-    end
-
-    def account_for external_id
-      @account_external_ids[external_id]
-    end
-
-    def transactions
-      @transactions.values
-    end
-
-    def transaction id
-      @transactions[id]
-    end
-
-    def entries
-      @entries.values
-    end
-
-    def entry id
-      @entries[id]
-    end
-
-    AccountEntitySizeBits = 30
-    def commit_transaction trans
-      raise "Creating transaction with no entries." if trans.entries.empty?
-      if trans.entries.size >= (1 << AccountEntitySizeBits)
-        raise "Creating transaction with too many entries."
-      end
-
-      # Validate trans status.
-      trans.entries.each do |entry|
-        valid_account! entry.account
-        valid_rate! entry
-      end
-      trans.balanced!
-
-      trans.archive_in_glass_jar self, next_transaction_id
-      trans.entries.each_with_index do |entry, index|
-        entry_id = (trans.id << AccountEntitySizeBits) + index
-        entry.archive_in_glass_jar self, entry_id
-
-        @entries[entry_id] = entry
-        account(entry.account).append_entry(entry)
-      end
-      @transactions[trans.id] = trans
-    end
-
-    def create_transaction *entries, other_data: nil
-      trans = Transaction.new(entries, other_data)
-      commit_transaction(trans)
-    end
-
-    def new_account *args
-      Account.new args
-    end
-
-    def new_transaction *args
-      Transaction.new args
-    end
-
-    def new_entry *args
-      Entry.new args
-    end
-
-    private
-    def next_account_id
-      @account_id += 1
-    end
-
-    def next_transaction_id
-      @transaction_id += 1
-    end
-
-    def valid_account! account
-      if not @accounts.has_key? account
-        raise "Unkown account #{account} refered."
-      end
-    end
-
-    def valid_rate! entry
-      if not (entry.rate or account(entry.account).currency == base_currency)
-        raise "Rate must be specified if entry is not in base currency " +
-          "#{base_currency}.\n Entry is #{entry}"
-      end
-    end
-  end
-end

data/lib/bean_sprout/struct_archive_mixin.rb

@@ -1,16 +0,0 @@
-module BeanSprout
-  module StructArchiveMixin
-    def self.included klass
-      klass.class_eval do
-        attr_reader :id
-        attr_reader :glass_jar
-      end
-    end
-
-    def archive_in_glass_jar glass_jar, id
-      @glass_jar = glass_jar
-      @id = id
-      freeze
-    end
-  end
-end

data/lib/bean_sprout/struct_from_hash_mixin.rb

@@ -1,14 +0,0 @@
-module BeanSprout
-  module StructFromHashMixin
-    def self.included klass
-      klass.extend ClassMethods
-    end
-
-    module ClassMethods
-      def from_hash hash
-        new(*hash.values_at(*members))
-      end
-    end
-  end
-end
-