feidee_utils 0.0.3 → 0.0.4.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c3a14270441df833087a0cc1051d6b001cd53f7
-  data.tar.gz: 3bb0fa7c0457ba41ef028248439adeac0f8b4a00
+  metadata.gz: 43eb6ed91615767e2076fba0ec78114408aa35fa
+  data.tar.gz: 848d8d0862d6bacdf426dfcbf8ec885946c0c3c4
 SHA512:
-  metadata.gz: 46c185fc50d1e7479084e99cc9a4f3e613fc1e3650afd3a9308c686d35e051ab48682d50fe5941f891340224d7b0a5b091f0dac4cba004bbc3ad3fc5490ee897
-  data.tar.gz: 0bf48a47d247e0e30ad7c9c50f88872d8d335bcc7b499ed5d3b52480ac90f3e1a632d5119cb2c68944486a81994fac7aa3b0da06320a1a9964201156e59b9954
+  metadata.gz: dbbb122530a60e683227d609b591a0213d6894de9fa4c62082c2e99e3bb22a3ddb281bee6437d522bb761dc86e88b65b3a013d7df41fa6e9abfc4810da752dff
+  data.tar.gz: ccbad9e1153f37397278248659c6e08386f8ced2b9df2609daa459f76055bee7dd7ab08ad08477a2046c9c3d66fd1f85e04299a45b789c7f37b9556dc408158d

data/README.md

@@ -12,6 +12,12 @@ A kbf file is in fact a zip file contains a modified SQLite database and other a
 The first 16 bits of the SQLite database is modified so that it could not be read directly by SQLite.
 The database itself is NOT encrypted. Almost all useful information is in the SQLite database.
 
+Install
+---------
+```bash
+gem install feidee_utils
+```
+
 Usage
 ----------
 A set of ActiveRecord-like classes are provided to access the information in the backup. See the quick example below.
@@ -27,6 +33,19 @@ all_transactions = database.namespaced::Transaction.all
 
 For more examples see ```examples/``` (To be added).
 
+Supported Entities
+-----------------
+
+*  Account
+*  Transaction
+*  AccountGroup
+*  Category
+
+Chinese Characters
+-----------------
+
+The database contains many Chinese characters such as builtin category names. Some of the characters are also included in tests. The gem is developed under OSX so presumably the gem should work fine in Unix-like environments with Unicode/UTF8 or whatever the encoding is.
+
 Why not ActiveRecord
 ----------------
 Sometimes we have to compare the content of two backups and must open them at the same time.

data/Rakefile

@@ -1,9 +1,24 @@
 require 'rake/testtask'
+require 'fileutils'
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
 end
 
+namespace :sync do
+  desc "Sync source file with the main project."
+  task :source do
+    puts "copying source code..."
+    FileUtils.cp_r Dir.glob("lib/*"), "/Users/muyiliqing/Git/cloud-ruby-dev/lib/"
+  end
+  task :scallion do
+    puts "copying source code..."
+    FileUtils.cp_r Dir.glob("lib/*"), "/Users/muyiliqing/Git/scallion/lib/"
+  end
+end
+
 desc "Run tests"
 task :default => :test
+task :deploy => :'sync:source'
+task :scallion => :'sync:scallion'

data/lib/feidee_utils/account.rb

@@ -12,7 +12,7 @@ module FeideeUtils
       raise "Account hidden should be either 0 or 1, but it's #{raw_hidden}.\n" + inspect unless (raw_hidden == 1 or raw_hidden == 0)
     end
 
-    def self.validate_integrity_globally
+    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."

data/lib/feidee_utils/category.rb

@@ -13,7 +13,7 @@ module FeideeUtils
       raise "Category usedCount should always be 0, but it's #{field["usedCount"]}.\n" + inspect unless field["usedCount"] == 0
     end
 
-    def self.validate_integrity_globally
+    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."

data/lib/feidee_utils/database.rb

@@ -50,9 +50,9 @@ module FeideeUtils
       backup_sqlite_db.close
     end
 
-    def validate_integrity_globally
+    def validate_global_integrity
       @namespaced.constants.each do |const|
-        @namespaced.const_get(const).validate_integrity_globally if const != :Database
+        @namespaced.const_get(const).validate_global_integrity if const != :Database
       end
     end
 

data/lib/feidee_utils/record/modified_record.rb

@@ -1,5 +1,6 @@
 module FeideeUtils
   class Record
+    # TODO: Reconsider this class and ship full support to all entities.
     class ModifiedRecord
       attr_reader :poid
       attr_reader :base, :head
@@ -15,10 +16,10 @@ module FeideeUtils
       end
 
       class ValuePair
-        attr_reader :old, :new
-        def initialize(old, new)
-          @old = old
-          @new = new
+        attr_reader :old_value, :new_value
+        def initialize(old_value, new_value)
+          @old = old_value
+          @new = new_value
         end
       end
 

data/lib/feidee_utils/record.rb

@@ -33,7 +33,7 @@ module FeideeUtils
       # Do nothing.
     end
 
-    def self.validate_integrity_globally
+    def self.validate_global_integrity
       # Do nothing.
     end
 

data/lib/feidee_utils/transaction.rb

@@ -64,7 +64,7 @@ module FeideeUtils
     class TransfersNotPaired < Exception
     end
 
-    def self.validate_integrity_globally
+    def self.validate_global_integrity
       uuids_map = all.inject({}) do |uuids, transaction|
         if transaction.is_transfer?
           uuid = transaction.uuid

data/lib/feidee_utils/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feidee_utils
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4.pre.1
 platform: ruby
 authors:
 - Liqing Muyi
@@ -133,12 +133,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Utils to extract useful information from Feidee Mymoney backup.