bean_sprout 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad556a445c248234bf3b69666980b4eb813be8b2
-  data.tar.gz: 4f7b1207e40e413aa6c3b8731e5763dde0583a1c
+  metadata.gz: c78c75ce139193f5d079d27d004b5753e929a359
+  data.tar.gz: bd2f0336d6869c9b207c6c202edd1eb2aa669fc6
 SHA512:
-  metadata.gz: 3794701939adf78a543a6c81bce53e8b06e46219e522688d5b10e4a7f8de8e9d083e50bdb3425a4a8d49f290186bfc277fe1df100b769bdfc2e5d3d4a514c7fb
-  data.tar.gz: 2130fa37267176c0a9928ccf8f8027b8f74fbb25ffb17abf12445e03fcaeb2163222225ceaa81a81fda029e50e08cf72e624df8d90ff2a61b26fa05bd62621db
+  metadata.gz: 52c30a7a443a6e54d3c532d8ad2df273cec319995688244ba78951bac657163856d021d795078339dd448fe503093e50718433aebd50f8372e1760c845eb5f02
+  data.tar.gz: e43fd99707829ccf80964f31b2c60d2052747645594623b20686ce2485e919802b40f6269a0b9d8aa3b77e40b0f2a7814ee5cfb9f4a42cf870012767ae210b7a

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/bean_sprout.rb

@@ -0,0 +1,10 @@
+require 'bean_sprout/account'
+require 'bean_sprout/accounting_entry'
+require 'bean_sprout/glass_jar'
+require 'bean_sprout/struct_archive_mixin'
+require 'bean_sprout/struct_from_hash_mixin'
+require 'bean_sprout/transaction'
+require 'bean_sprout/version'
+
+module BeanSprout
+end

data/lib/bean_sprout/account.rb

@@ -0,0 +1,28 @@
+require 'bean_sprout/struct_from_hash_mixin'
+require 'bean_sprout/struct_archive_mixin'
+
+module BeanSprout
+  class Account < Struct.new(:currency, :other_data)
+    include StructFromHashMixin
+    include StructArchiveMixin
+
+    def initialize *fields
+      super *fields
+      @entries = []
+      @balances = [0]
+    end
+
+    def append_entry entry
+      @entries.push entry
+      @balances.push balance + entry.accurate_amount
+    end
+
+    def entries
+      @entries.clone
+    end
+
+    def balance
+      @balances.last
+    end
+  end
+end

data/lib/bean_sprout/accounting_entry.rb

@@ -0,0 +1,25 @@
+require 'bean_sprout/struct_from_hash_mixin'
+require 'bean_sprout/struct_archive_mixin'
+require 'bigdecimal'
+require 'bigdecimal/util'
+
+module BeanSprout
+  # AccountingEntry is made up of the following fields:
+  # 1. The account owns the entry, the currency of which is defined as the local
+  # currency;
+  # 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 AccountingEntry < Struct.new(:account, :amount, :rate, :other_data)
+    include StructFromHashMixin
+    include StructArchiveMixin
+
+    def rate_or_one
+      rate or 1
+    end
+
+    def accurate_amount
+      @accurate_amount ||= amount.to_d
+    end
+  end
+end

data/lib/bean_sprout/glass_jar.rb

@@ -0,0 +1,100 @@
+module BeanSprout
+  class GlassJar
+    attr_reader :base_currency
+
+    def initialize base_currency
+      @base_currency = base_currency
+
+      @accounts = {}
+      @account_id = 0
+
+      @transactions = {}
+      @transaction_id = 0
+
+      @entries = {}
+    end
+
+    def create_account account
+      account.archive_in_glass_jar self, next_account_id
+      @accounts[account.id] = account
+    end
+
+    def accounts
+      @accounts.values
+    end
+
+    # External ID is not supported. Clients must implement
+    # external ID to internal ID mapping.
+    def account id
+      @accounts[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
+
+    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

@@ -0,0 +1,16 @@
+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

@@ -0,0 +1,14 @@
+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
+

data/lib/bean_sprout/transaction.rb

@@ -0,0 +1,28 @@
+require 'bean_sprout/struct_archive_mixin'
+
+module BeanSprout
+  class Transaction < Struct.new(:entries, :other_data)
+    include StructArchiveMixin
+
+    alias entries_data entries
+    private :entries_data
+
+    public
+    def balanced?
+      balance = 0
+      entries_data.each do |entry|
+        balance += entry.accurate_amount / entry.rate_or_one
+      end
+      balance == 0
+    end
+
+    def balanced!
+      raise "#{entries_data} is not balanced." unless balanced?
+    end
+
+    def entries
+      entries_data.clone
+    end
+  end
+end
+

data/lib/bean_sprout/version.rb

@@ -1,3 +1,3 @@
 module BeanSprout
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bean_sprout
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Liqing Muyi
@@ -60,8 +60,16 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - MIT-LICENSE
+- Rakefile
+- lib/bean_sprout.rb
+- lib/bean_sprout/account.rb
+- lib/bean_sprout/accounting_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/transaction.rb
 - lib/bean_sprout/version.rb
-homepage: http://github.com/muyiliqing/feidee_utils
+homepage: http://github.com/muyiliqing/bean_sprout
 licenses:
 - MIT
 metadata: {}