feidee_utils 0.0.4.3 → 0.0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd2d6afd486620f91184ac15f846ae7fef857b7c
-  data.tar.gz: d0b20dca231364ca6ee87392c9c57b69220c81d0
+  metadata.gz: 9cc0908a9717145ac9f863abad4f5d4ff910a898
+  data.tar.gz: 64d25e89e933a547ba71e6e412b64178dc7a9310
 SHA512:
-  metadata.gz: addacf49613d3cfb3be9a830046046abc84ace8091a514589bdbd46c01f09437dbeee95c00f2ba147e1986096e64b077171f3f2105a782df9821e63de998860b
-  data.tar.gz: 0fb69c197627fc5ddacf43bf956fe2649aaacd18159812fd8f0cb903be5de9755faf6489e141e4bdb06f5cc72d8ec84e5a8cd106d7f2540728f46e6f8e0a9e58
+  metadata.gz: 0fc21e8b91f1f7f44404163478533ffcdffc4c42455bdd0f81881758c1a5faa12e49193d500869d22cf52a416fc2ce4a5a38ad71d5f6552194f265fdbb4649dc
+  data.tar.gz: 3e78c29a78d14c2ca7e0ce2c5cab4c914ae02b2a39a13feb337726e859ba6de0a56cb42bab28c18c602f42c7b0bc828ce6d11c77b7a142e1135622caf23054fe

data/README.md

@@ -2,7 +2,7 @@ Feidee Utils
 ============
 [![Build Status](https://travis-ci.org/muyiliqing/feidee_utils.svg?branch=master)](https://travis-ci.org/muyiliqing/feidee_utils)
 
-Free users' data from [Feidee](http://www.feidee.com) private backups (.kbf).
+Free user data from [Feidee](http://www.feidee.com) private backups (.kbf).
 
 Feidee And The KBF Format
 -----------
@@ -26,9 +26,9 @@ A set of ActiveRecord-like classes are provided to access the information in the
 require 'feidee_utils'
 
 kbf = FeideeUtils::Kbf.open_file(path_to_kbf_file)
-database = kbf.sqlite_db
-all_accounts = database.namespaced::Account.all
-all_transactions = database.namespaced::Transaction.all
+database = kbf.db
+all_accounts = database.ledger::Account.all
+all_transactions = database.ledger::Transaction.all
 ```
 
 For more examples see ```examples/``` (To be added).

data/lib/feidee_utils/account.rb

@@ -5,17 +5,34 @@ require 'bigdecimal'
 module FeideeUtils
   class Account < Record
     def validate_integrity
-      raise "Account type should always be 0, but it's #{field["type"]}.\n" + inspect unless not field["type"] or field["type"] == 0
-      raise "Account usedCount should always be 0, but it's #{field["usedCount"]}.\n" + inspect unless field["usedCount"] == 0
-      raise "Account uuid should always be empty, but it's #{field["uuid"]}.\n" + inspect unless field["uuid"].to_s.empty?
-      raise "Account hierachy contains more than 2 levels.\n" + inspect unless flat_parent_hierachy?
-      raise "Account hidden should be either 0 or 1, but it's #{raw_hidden}.\n" + inspect unless (raw_hidden == 1 or raw_hidden == 0)
+      unless not field["type"] or field["type"] == 0
+        raise "Account type should always be 0, but it's #{field["type"]}.\n" +
+          inspect
+      end
+      unless field["usedCount"] == 0
+        raise "Account usedCount should always be 0," +
+          " but it's #{field["usedCount"]}.\n"+
+          inspect
+      end
+      unless field["uuid"].to_s.empty?
+        raise "Account uuid should always be empty,"+
+          " but it's #{field["uuid"]}.\n" +
+          inspect
+      end
+      unless flat_parent_hierachy?
+        raise "Account hierachy contains more than 2 levels.\n" + inspect
+      end
+      unless (raw_hidden == 1 or raw_hidden == 0)
+        raise "Account hidden should be either 0 or 1," +
+          " but it's #{raw_hidden}.\n" +
+          inspect
+      end
     end
 
     def self.validate_global_integrity
       if self.find_by_id(-1) != nil
-        raise "-1 is used as the parent POID placeholder of a parent account. " +
-          "Account of POID -1 should not exist."
+        raise "-1 is used as the parent POID placeholder of a parent account." +
+          " Account of POID -1 should not exist."
       end
     end
 
@@ -36,15 +53,12 @@ module FeideeUtils
     }.freeze
 
     IgnoredFields = [
-      "tradingEntityPOID",
-      # TODO: Field type is removed from database_version 73. Not sure about
-      # earlier versions.
-      "type",             # Always 0
+      "tradingEntityPOID", # Foreign key to t_user or maybe t_tradingEntity.
+      "type",             # Always 0, removed since database version 73.
       "usedCount",        # Always 0
       "uuid",             # Always empty.
-      # TODO: code is also removed.
-      "code",             # WTF
-      "clientID",         # WTF
+      "code",             # Always 0, removed since database version 73.
+      "clientID",         # Always equal to poid.
     ].freeze
 
     define_accessors(FieldMappings)
@@ -96,7 +110,9 @@ module FeideeUtils
 
     def children
       arr = []
-      self.class.database.query("SELECT * FROM #{self.class.table_name} WHERE parent = ?", poid) do |result|
+      self.class.database.query(
+        "SELECT * FROM #{self.class.table_name} WHERE parent = ?", poid
+      ) do |result|
         result.each do |raw_row|
           arr << self.class.new(result.columns, result.types, raw_row)
         end
@@ -104,6 +120,10 @@ module FeideeUtils
       arr
     end
 
+    def to_s
+      "#{name} (Account/#{poid})"
+    end
+
     class ModifiedAccount < Record::ModifiedRecord
       define_custom_methods([
         :balance,

data/lib/feidee_utils/account_group.rb

@@ -26,9 +26,9 @@ module FeideeUtils
     }.freeze
 
     IgnoredFields = [
-      "userTradingEntityPOID", # WTF
+      "userTradingEntityPOID", # Foreign key to t_user.
       "_tempIconName",         # Icon name in the app
-      "clientID",              # WTF
+      "clientID",              # Always equal to poid.
     ].freeze
 
     define_accessors(FieldMappings)
@@ -39,6 +39,10 @@ module FeideeUtils
       2 => :claim,
     })
 
+    def to_s
+      "#{name} (AccountGroup/#{poid})"
+    end
+
     # Schema
     # accountGroupPOID long not null
     # name varchar(100) not null

data/lib/feidee_utils/category.rb

@@ -10,13 +10,18 @@ module FeideeUtils
     def validate_integrity
       validate_depth_integrity
       validate_one_level_path_integrity
-      raise "Category usedCount should always be 0, but it's #{field["usedCount"]}.\n" + inspect unless field["usedCount"] == 0
+      unless field["usedCount"] == 0
+        raise "Category usedCount should always be 0, " +
+          "but it's #{field["usedCount"]}.\n" +
+          inspect
+      end
     end
 
     def self.validate_global_integrity
       project_root_code = 2
       if TypeEnum[project_root_code] != :project_root
-        raise "The type code of project root has been changed, please update the code."
+        raise "The type code of project root has been changed," +
+          " please update the code."
       end
 
       rows = self.database.execute <<-SQL
@@ -26,11 +31,13 @@ module FeideeUtils
 
       if rows.length > 1
         poids = rows.map do |row| row[0] end
-        raise "More than one category have type project_root. IDs are #{poids.inspect}."
+        raise "More than one category have type project_root." +
+          " IDs are #{poids.inspect}."
       elsif rows.length == 1
         category_name = rows[0][1]
         if category_name != "projectRoot" and category_name != "root"
-          raise "Category #{category_name} has type project_root. ID: #{rows[0][0]}."
+          raise "Category #{category_name} has type project_root." +
+            " ID: #{rows[0][0]}."
         end
       end
     end
@@ -45,10 +52,10 @@ module FeideeUtils
     }.freeze
 
     IgnoredFields = [
-      "userTradingEntityPOID", # WTF
+      "userTradingEntityPOID", # Foreign key to t_user.
       "_tempIconName",         # Icon name in the app
       "usedCount",             # Always 0.
-      "clientID",              # WTF
+      "clientID",              # Always equal to poid.
     ].freeze
 
     define_accessors(FieldMappings)
@@ -59,6 +66,10 @@ module FeideeUtils
       2 => :project_root, # unkown
     })
 
+    def to_s
+      "#{name} (Category/#{poid})"
+    end
+
     # Schema
     # categoryPOID LONG NOT NULL
     # name varchar(100) NOT NULL

data/lib/feidee_utils/database.rb

@@ -22,12 +22,14 @@ module FeideeUtils
       t_fund_trans
       t_module_stock_holding
       t_module_stock_tran
+      t_tradingEntity
+      t_user
     ).freeze
 
     attr_reader :sqlite_file
-    attr_reader :platform, :sqlite_name, :sqlite_timestamp
+    attr_reader :platform, :ledger_name, :last_modified_at
     attr_reader :missing_tables
-    attr_reader :namespaced
+    attr_reader :ledger
 
     def initialize(private_sqlite, strip = false)
       @sqlite_file = Database.feidee_to_sqlite(private_sqlite)
@@ -37,7 +39,8 @@ module FeideeUtils
       extract_metadata
       drop_unused_tables if strip
 
-      @namespaced = Record.generate_namespaced_record_classes(self)
+      # TODO: make Ledger a first class object.
+      @ledger = Record.generate_namespaced_record_classes(self)
     end
 
     def sqlite_backup(dest_file_path)
@@ -51,8 +54,8 @@ module FeideeUtils
     end
 
     def validate_global_integrity
-      @namespaced.constants.each do |const|
-        @namespaced.const_get(const).validate_global_integrity if const != :Database
+      @ledger.constants.each do |const|
+        @ledger.const_get(const).validate_global_integrity if const != :Database
       end
     end
 
@@ -71,7 +74,10 @@ module FeideeUtils
 
     def drop_unused_tables
       useful_tables = Tables.values + PotentialUsefulTables
-      useful_tables = (useful_tables + useful_tables.map do |x| self.class.trash_table_name(x) end).sort
+      useful_tables += useful_tables.map do |x|
+        self.class.trash_table_name(x)
+      end
+      useful_tables.sort!
 
       # TODO: Record all tables droped.
       (all_tables - useful_tables).each do |table|
@@ -85,14 +91,20 @@ module FeideeUtils
     end
 
     def extract_metadata
-      @platform = self.execute("SELECT platform from #{Tables[:metadata]}")[0][0];
-
-      @sqlite_name = self.get_first_row("SELECT accountBookName FROM #{Tables[:profile]};")[0];
-
-      # This is not recorded in the database, so the lastest lastUpdateTime of all
-      # transactions is chosen.
-      timestamp = self.get_first_row("SELECT max(lastUpdateTime) FROM #{Tables[:transactions]};")[0]
-      @sqlite_timestamp = timestamp == nil ? Time.at(0) : Time.at(timestamp / 1000)
+      @platform = self.execute(
+        "SELECT platform from #{Tables[:metadata]}"
+      )[0][0];
+
+      @ledger_name = self.get_first_row(
+        "SELECT accountBookName FROM #{Tables[:profile]};"
+      )[0];
+
+      # This is not recorded in the database, so the lastest lastUpdateTime of
+      # all transactions is chosen.
+      timestamp = self.get_first_row(
+        "SELECT max(lastUpdateTime) FROM #{Tables[:transactions]};"
+      )[0]
+      @last_modified_at = Time.at((timestamp or 0.0) / 1000)
     end
 
     class << self
@@ -103,13 +115,14 @@ module FeideeUtils
       Header = "SQLite format 3\0".force_encoding("binary")
       FeideeHeader_iOS = "%$^#&!@_@- -!F\xff\0".force_encoding('binary')
       FeideeHeader_Android = ("\0" * 13 + "F\xff\0").force_encoding("binary")
+      AllHeaders = [FeideeHeader_iOS, FeideeHeader_Android, Header]
 
       def feidee_to_sqlite(private_sqlite, sqlite_file = nil)
         # Discard the first a few bytes content.
         private_header = private_sqlite.read(Header.length)
 
-        unless [FeideeHeader_iOS, FeideeHeader_Android, Header].include? private_header
-          raise "Unexpected header #{private_header.inspect} in private sqlite file."
+        unless AllHeaders.include? private_header
+          raise "Unexpected private sqlite header #{private_header.inspect}."
         end
 
         # Write the rest to a tempfile.
@@ -123,7 +136,10 @@ module FeideeUtils
     end
 
     class << self
-      NoDeleteSuffixTables = %w(account category tag tradingEntity transaction transaction_template)
+      NoDeleteSuffixTables = %w(
+        account category tag tradingEntity
+        transaction transaction_template
+      )
 
       def trash_table_name name
         NoDeleteSuffixTables.each do |core_name|

data/lib/feidee_utils/kbf.rb

@@ -9,22 +9,25 @@ module FeideeUtils
   class Kbf
     DatabaseName = 'mymoney.sqlite'
 
-    attr_reader :zipfile, :sqlite_db
+    attr_reader :zipfile, :db
 
     def initialize(input_stream)
-      @zipfile = Zip::File.open_buffer(input_stream) do |zipfile|
+      Zip::File.open_buffer(input_stream) do |zipfile|
         zipfile.each do |entry|
           if entry.name == DatabaseName
             # Each call to get_input_stream will create a new stream
             @original_sqlite_db_entry = entry
-            @sqlite_db = FeideeUtils::Database.new(entry.get_input_stream, true)
+            @db = FeideeUtils::Database.new(entry.get_input_stream, true)
           end
         end
       end
     end
 
     def extract_original_sqlite(dest_file_path = nil)
-      FeideeUtils::Database.feidee_to_sqlite(@original_sqlite_db_entry.get_input_stream, dest_file_path)
+      FeideeUtils::Database.feidee_to_sqlite(
+        @original_sqlite_db_entry.get_input_stream,
+        dest_file_path
+      )
     end
 
     class << self

data/lib/feidee_utils/record/accessors.rb

@@ -12,7 +12,9 @@ module FeideeUtils
       module ClassMethods
         def define_accessors field_mappings
           field_mappings.each do |name, key|
-            raise "Accessor #{name} already exists in #{self.name}." if method_defined? name
+            if method_defined? name
+              raise "Accessor #{name} already exists in #{self.name}."
+            end
             define_method name do field[key] end
           end
         end

data/lib/feidee_utils/record/namespaced.rb

@@ -12,7 +12,8 @@ module FeideeUtils
           @child_classes.add(child_class)
         end
 
-        # To use Record with different databases, generate a set of classes for each db
+        # To use Record with different databases, generate a set of classes for
+        # each db
         def generate_namespaced_record_classes(db)
           @child_classes ||= Set.new
           this = self

data/lib/feidee_utils/record/persistent.rb

@@ -36,13 +36,17 @@ module FeideeUtils
         end
 
         def find_by_id(id)
-          raw_result = database.query("SELECT * FROM #{self.table_name} WHERE #{self.id_field_name} = ?", id)
+          raw_result = database.query(
+            "SELECT * FROM #{self.table_name} WHERE #{self.id_field_name} = ?",
+            id
+          )
 
           raw_row = raw_result.next
           return nil if raw_row == nil
 
           if raw_result.next != nil
-            raise "Getting more than one result with the same ID #{id} in table #{self.table_name}."
+            raise "Getting more than one result with the same ID #{id} " +
+              "in table #{self.table_name}."
           end
 
           self.new(raw_result.columns, raw_result.types, raw_row)

data/lib/feidee_utils/record.rb

@@ -6,18 +6,21 @@ require 'feidee_utils/record/modified_record'
 
 module FeideeUtils
   # The implementation here is wired.
-  # The goal is to create a class hierachy similar to ActiveRecord, where every table is represented by a
-  # subclass of ActiveRecord::Base. Class methods, attribute accessors and almost all other functionalities
-  # are provided by ActiveRecord::Base. For example, Base.all(), Base.find_by_id() are tied to a specific
-  # table in a specific database.
-  # The problem we are solving here is not the same as ActiveRecord. In ActiveRecord, the databases
-  # are static, i.e. they won't be changed at runtime. Meanwhile, in our case, new databases can be created
-  # at runtime, when a new KBF backup file is uploaded. Furthermore, multiple instances of different databases
-  # can co-exist at the same time. To provide the same syntax as ActiveRecord, a standalone "Base" class has
-  # to be created for each database.
-  # In our implementation, when a new database is created, a subclass of Record is created in a new namepsace.
-  # For each subclass of Record, a new subclass is copied to the new namespace, with it's database method
-  # overloaded.
+  # The goal is to create a class hierachy similar to ActiveRecord, where every
+  # table is represented by a subclass of ActiveRecord::Base. Class methods,
+  # attribute accessors and almost all other functionalities are provided by
+  # ActiveRecord::Base. For example, Base.all(), Base.find_by_id() are tied to
+  # a specific table in a specific database.
+  # The problem we are solving here is not the same as ActiveRecord. In
+  # ActiveRecord, the databases are static, i.e. they won't be changed at
+  # runtime. Meanwhile, in our case, new databases can be created at runtime,
+  # when a new KBF backup file is uploaded. Furthermore, multiple instances of
+  # different databases can co-exist at the same time. To provide the same
+  # syntax as ActiveRecord, a standalone "Base" class has to be created for each
+  # database.
+  # In our implementation, when a new database is created, a subclass of Record
+  # is created in a new namepsace.  For each subclass of Record, a new subclass
+  # is copied to the new namespace, with it's database method overloaded.
   class Record
     attr_reader :field, :field_type
 

data/lib/feidee_utils/transaction.rb

@@ -25,30 +25,37 @@ module FeideeUtils
         unless buyer_account_poid != 0 and seller_account_poid != 0
           raise TransferLackBuyerOrSellerException,
             "Both buyer and seller should be set in a transfer. " +
-            "Buyer account POID: #{buyer_account_poid}. Seller account POID: #{seller_account_poid}.\n" +
+            "Buyer account POID: #{buyer_account_poid}. " +
+            "Seller account POID: #{seller_account_poid}.\n" +
             inspect
         end
         unless buyer_category_poid == 0 and seller_category_poid == 0
           raise TransferWithCategoryException,
             "Neither buyer or seller category should be set in a transfer. " +
-            "Buyer category POID: #{buyer_category_poid}. Seller category POID: #{seller_category_poid}.\n" +
+            "Buyer category POID: #{buyer_category_poid}. " +
+            "Seller category POID: #{seller_category_poid}.\n" +
             inspect
         end
       else
         unless (buyer_account_poid == 0) ^ (seller_account_poid == 0)
           raise InconsistentBuyerAndSellerException,
-            "Exactly one of buyer and seller should be set in a non-transfer transaction. " +
-            "Buyer account POID: #{buyer_account_poid}. Seller account POID: #{seller_account_poid}.\n" +
+            "Exactly one of buyer and seller should be set in a non-transfer " +
+            "transaction. " +
+            "Buyer account POID: #{buyer_account_poid}. " +
+            "Seller account POID: #{seller_account_poid}.\n" +
             inspect
         end
 
-        # We could enforce that category is set to the matching party (buyer or seller) of account.
-        # However the implementation could handle all situations, as long as only one of them is set.
-        # Thus no extra check is done here.
+        # We could enforce that category is set to the matching party (buyer or
+        # seller) of account. However the implementation could handle all
+        # situations, as long as only one of them is set. Thus no extra check is
+        # done here.
         unless buyer_category_poid == 0 or seller_category_poid == 0
           raise InconsistentCategoryException,
-            "Only one of buyer and seller category should be set in a non-transfer transaction. "
-            "Buyer category POID: #{buyer_category_poid}. Seller category POID: #{seller_category_poid}.\n" +
+            "Only one of buyer and seller category should be set in a " +
+            "non-transfer transaction. " +
+            "Buyer category POID: #{buyer_category_poid}. " +
+            "Seller category POID: #{seller_category_poid}.\n" +
             inspect
         end
       end
@@ -56,7 +63,8 @@ module FeideeUtils
       unless raw_buyer_deduction == raw_seller_addition
         raise InconsistentAmountException,
           "Buyer and seller should have the same amount set. " +
-          "Buyer deduction: #{buyer_deduction}, seller_addition: #{seller_addition}.\n" +
+          "Buyer deduction: #{buyer_deduction}. "+
+          "Seller_addition: #{seller_addition}.\n" +
         inspect
       end
     end
@@ -78,8 +86,10 @@ module FeideeUtils
         valid = true
         valid &&= transfers[0] != nil
         valid &&= transfers[1] != nil
-        valid &&= transfers[0].buyer_account_poid == transfers[1].buyer_account_poid
-        valid &&= transfers[0].seller_account_poid == transfers[1].seller_account_poid
+        valid &&=
+          transfers[0].buyer_account_poid == transfers[1].buyer_account_poid
+        valid &&=
+          transfers[0].seller_account_poid == transfers[1].seller_account_poid
         raise TransfersNotPaired.new([uuid] + transfers) unless valid
       end
     end
@@ -102,13 +112,13 @@ module FeideeUtils
     define_entity_accessor :seller_account_poid, :account
 
     IgnoredFields = [
-      "creatorTradingEntityPOID",
-      "modifierTradingEntityPOID",
-      "ffrom",                # The signature of the App writting this transaction.
+      "creatorTradingEntityPOID",  # Foreign key to to_user.
+      "modifierTradingEntityPOID", # Foreign key to to_user.
+      "ffrom",                # The signature of the App.
       "photoName",            # To be added
       "photoNeedUpload",      # To be added
-      "relationUnitPOID",     # WTF
-      "clientID",             # WTF
+      "relationUnitPOID",     # Foreign key to t_tradingEntity: Merchant.
+      "clientID",             # Always 0 for ealier versions, or equal to poid.
       "FSourceKey",           # WTF
     ].freeze
 
@@ -190,6 +200,17 @@ module FeideeUtils
       end
     end
 
+    def to_s
+      if is_transfer?
+        "Transfer #{amount.to_f} from #{buyer_account} to #{seller_account}"
+      elsif is_initial_balance?
+        "Balance of #{revised_account} set to #{revised_amount.to_f}"
+      else
+        "Transaction of #{revised_amount.to_f} on #{revised_account} in " +
+          "#{category}"
+      end
+    end
+
     class ModifiedTransaction < ModifiedRecord
       define_custom_methods([
         :created_at,

data/lib/feidee_utils/version.rb

@@ -1,3 +1,3 @@
 module FeideeUtils
-    VERSION = '0.0.4.3'
+    VERSION = '0.0.4.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feidee_utils
 version: !ruby/object:Gem::Version
-  version: 0.0.4.3
+  version: 0.0.4.4
 platform: ruby
 authors:
 - Liqing Muyi