transactions 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1fb2dde0117abbbd982a133959573444cb4b0fd
-  data.tar.gz: 27fbf80ef838f35511f3a9337ac7746c159b811f
+  metadata.gz: 33eda3b0328f7e73b955157f5e6546a02318dd39
+  data.tar.gz: b5517d7c6f82f774478fed0b3201233221836ac4
 SHA512:
-  metadata.gz: dfc5cc11724b32935bfb1b63936404109f9d384a3936dd28ab899e32ac0e11d55e51ef58491dfe9312d83ba62fcf6eb921bbd2f4d7091655e83c4e2d8b80d33c
-  data.tar.gz: e7d1c09de955ccde03a27024783c3eb9e5bd3ea7e6e4a875712da422ad03cd9ef30724ae6aa934d8b2437318762e242d326b9aa39b832ebb55b809c03c3298dc
+  metadata.gz: e48557d6ce160b64d8222d6697aa2a431c3ff38aa5f867e96020b05d042d978852f5108eb3b9a9097227a4a61e4cace27caf57db60dec9b9dfe06bd1814d6a90
+  data.tar.gz: 862a28891b7a1a138714d0ca2a391718f19286ee9744c29ec8927395fe7187e10409980bb9630a3aca82ec576e765fb11c606c114971f88248caa202bcdb5204

data/CHANGELOG.md

@@ -1,11 +1,15 @@
+## version 0.1.1 (2013-06-28)
+* refactored transaction parser
+* added some tomdocs to code
+* included test directory in gem pkg
+
+
 ## version 0.1.0 (2013-06-27)
----
-* Initial Release
-* Added additional unit tests
-* Authored README.md
+* initial Release
+* added additional unit tests
+* authored README.md
 
 
 ## version 0.0.0 (2013-06-26)
----
-* Happy Birthday!
+* happy birthday!
 

data/README.md

@@ -21,7 +21,7 @@ on your system. Note that RubyGems is included with Ruby since version 1.9.
 The best way to install transactions is via RubyGems. At the terminal prompt, run
 the following command:
 
-`gem install transactions`
+    gem install transactions
 
 
 ## Additional Information
@@ -227,14 +227,16 @@ Limit by date
 How to get your work merged into the project?
 
 * Fork the project.
-* Clone your fork ( git clone git@github.com:<username>/transactions.git ).
-* Create a topic branch for your change ( git checkout -b my_new_feature ).
+* Clone your fork ( `git clone git@github.com:<username>/transactions.git` ).
+* Create a topic branch for your change ( `git checkout -b my_new_feature` ).
 * Hack away, add tests. Not necessarily in that order.
-* Make sure everything still passes by running rake.
+* Make sure everything still passes by running `ruby test_transactions.rb`
+  from within the test directory (tests need to be run in the same directory
+  as the included **ledger.yaml** file).
 * If necessary, rebase your commits into logical chunks, without errors.
-* Push the branch up ( git push origin my_new_feature ).
+* Push the branch up ( `git push origin my_new_feature` ).
 * Create a pull request against randyschneck/transactions and describe what
-  your change does and the why you think it should be merged.
+  your change does and/or why you think it should be merged.
 
 
 ## Credits

data/bin/transactions

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$:.unshift File.join(File.dirname(__FILE__), "..", "lib")  # For use/testing when not installed
+$:.unshift File.join(File.dirname(__FILE__), *%w{ .. lib })
 
 require 'transactions'
 

data/lib/transactions.rb

@@ -1,5 +1,3 @@
-$:.unshift File.dirname(__FILE__) # For use/testing when not installed
-
 # stdlib
 require 'yaml'
 require 'optparse'

data/lib/transactions/main.rb

@@ -1,5 +1,15 @@
 module Transaction
 
+  # Public: Initializes a Transaction::Parser object. A 'ledger.yaml' file must
+  # exist in the current working directory.
+  #
+  # Examples
+  #
+  #   require 'transactions'
+  #   # read the ledger.yaml file into a Transaction::Parser object
+  #   t = Transaction::Parser.new
+  #
+  # Returns nothing
   class Parser
 
     def initialize

data/lib/transactions/options.rb

@@ -6,6 +6,9 @@ module Transaction
       @options = {}
     end
 
+    # Internal: Parses options for transactions from the command line.
+    #
+    # Returns nothing.
     def options
       OptionParser.new do |opts|
 
@@ -68,6 +71,10 @@ module Transaction
     end
 
 
+    # Internal: Prints help for commands that are stored in ARGV[0]. Used in
+    # help menu.
+    #
+    # Returns nothing.
     def commands_help
       <<-COMMANDHELP
 

data/lib/transactions/parser.rb

@@ -1,5 +1,25 @@
 module Transaction
 
+  # Public: This is the actual parser for generating financial reports.
+  #
+  # cmd - A String for the command to run through parser. Must be 'balance',
+  #       'register', or 'print'.
+  #
+  # Examples
+  #
+  #   require 'transactions'
+  #   t = Transaction::Parser.new
+  #   ARGV[0] == ""  # The function requires ARGV[0] even if it's empty
+  #   t.parse 'balance'
+  #   t.parse 'register'
+  #   t.parse 'print'
+  #   ARGV[1] = 'checking'
+  #   t.parse 'register'
+  #   ARGV[1] = 'income'
+  #   ARGV[2] = 'expenses'
+  #   t.parse 'balance'
+  #
+  # Returns Hash containing accounts and totals if cmd is 'balance'
   def parse(cmd)
 
     @accounts = {}
@@ -19,38 +39,19 @@ module Transaction
 
     def transaction_register(x, k, v, running_total)
       if v.is_a? Numeric
-        if @options[:wide]  # for printing 132 columns wide
-          t = "%10s %-44s %-44s %15.2f %15.2f"
-          puts sprintf(t, x['date'], x['transaction'][0..42],
-                       k[0..42], v, running_total)
-        else  # for printing 78 columns wide (default)
-          t = "%10s %-20s %-24s %10.2f %10.2f"
-          puts sprintf(t, x['date'], x['transaction'][0..18],
-                       k[0..22], v, running_total)
-        end
+        t = "%10s %-44.42s %-44.42s %15.2f %15.2f" if @options[:wide]
+        t = "%10s %-20.18s %-24.22s %10.2f %10.2f" unless @options[:wide]
+        puts sprintf(t, x['date'], x['transaction'], k, v, running_total)
       end
     end
 
     def transaction_command(cmd, x, k, v)
       ARGV.map! { |z| z.downcase }
-      if ARGV[1..-1].any? { |arg| k.downcase.include? arg }
-        @running_total += v if v.is_a? Numeric
-        if cmd == 'print'
-          transaction_print(x)
-        elsif cmd == 'balance'
-          transaction_balance(k, v)
-        elsif cmd == 'register'
-          transaction_register(x, k, v, @running_total)
-        end
-      elsif !ARGV[1]
+      if ARGV[1..-1].any? { |arg| k.downcase.include? arg } || !ARGV[1]
         @running_total += v if v.is_a? Numeric
-        if cmd == 'print'
-          transaction_print(x)
-        elsif cmd == 'balance'
-          transaction_balance(k, v)
-        elsif cmd == 'register'
-          transaction_register(x, k, v, @running_total)
-        end
+        transaction_print(x) if cmd == 'print'
+        transaction_balance(k, v) if cmd == 'balance'
+        transaction_register(x, k, v, @running_total) if cmd == 'register'
       end
     end
 
@@ -154,9 +155,9 @@ module Transaction
           end
         end
       end
+      @accounts
     end
 
-
   end
 end
 

data/lib/transactions/version.rb

@@ -1,4 +1,4 @@
 module Transaction
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end
 

data/test/ledger.yaml

@@ -0,0 +1,58 @@
+# This is a sample ledger file
+# this line and the one above are comments that will be ignored
+# during processing! Comments can also be placed at the end of
+# a line (see below for examples).
+
+- date:                             2013/01/01
+  transaction:                      Opening Balances
+  Assets:Checking:                  251.0
+  Assets:Savings:                   5005.3
+  Assets:IRA:                       22510.92
+  Liabilities:CreditCard:           -931.32
+  Liabilities:Salliemae:            -10189.05
+  Equity:OpeningBalances:           -16646.85
+
+- date:                             2013/01/07
+  transaction:                      Trader Joe's
+  Expenses:Food:Groceries:          58.77
+  Assets:Checking:                  -58.77
+
+- date:                             2013/01/09
+  transaction:                      Student Loan Payment
+  Liabilities:Salliemae:            103.3
+  Expenses:Interest:StudentLoan:    15.04
+  Assets:Checking:                  -118.34
+
+- date:                             2013/02/11
+  transaction:                      Deposit Paycheck
+  Assets:Checking:                  1242.87
+  Income:JobName:                   -1242.87
+
+- date:                             2013/02/11
+  transaction:                      Visa Payment
+  Expenses:Interest:CreditCard:     10.0
+  Liabilities:CreditCard:           130.0
+  Assets:Checking:                  -140.0
+
+- date:                             2013/02/25
+  transaction:                      PG&E
+  Expenses:Utilities:Electric:      75
+  Assets:Checking:                  -75
+
+- date:                             2013/02/25
+  transaction:                      Verizon  # Switch to Virgin Mobile
+  Expenses:Phone:                   55.72
+  Assets:Checking:                  -55.72
+
+- date:                             2013/02/26
+  transaction:                      Ike's Lair  # good sandwich
+  Expenses:Food:Dining:             22.31
+  Assets:Checking:                  -22.31
+
+# a transaction requires only one space as a separator but can also be
+# aligned as above. The choice is yours!
+
+- date: 2013/02/26
+  transaction: Money Transfer
+  Assets:Savings: 494.7
+  Assets:Checking: -494.7

data/test/test_transactions.rb

@@ -0,0 +1,36 @@
+$:.unshift File.join(File.dirname(__FILE__), *%w{ .. lib })
+
+require "test/unit"
+require "../lib/transactions"
+
+class TestTransactions < Test::Unit::TestCase
+
+  def test_options  # make sure options are initiated
+    test_options = Transaction::Options.new.options
+    assert_equal(test_options, {})
+    test_options[:file] = 'test'
+    assert_equal(test_options, {:file=>'test'})
+  end
+
+  def test_balances  # make sure accounts balance in test "ledger.yaml"
+    ARGV[0] = ""
+    accounts = Transaction::Parser.new.parse("balance")
+    accounts.each do |x|
+      assert_equal(529.03, x[1].round(2)) if x[0] == "Assets:Checking"
+      assert_equal(22510.92, x[1].round(2)) if x[0] == "Assets:IRA"
+      assert_equal(5500.00, x[1].round(2)) if x[0] == "Assets:Savings"
+      assert_equal(-16646.85, x[1].round(2)) if x[0] == "Equity:OpeningBalances"
+      assert_equal(22.31, x[1].round(2)) if x[0] == "Expenses:Food:Dining"
+      assert_equal(58.77, x[1].round(2)) if x[0] == "Expenses:Food:Groceries"
+      assert_equal(10.00, x[1].round(2)) if x[0] == "Expenses:Interest:CreditCard"
+      assert_equal(15.04, x[1].round(2)) if x[0] == "Expenses:Interest:StudentLoan"
+      assert_equal(55.72, x[1].round(2)) if x[0] == "Expenses:Phone"
+      assert_equal(75.00, x[1].round(2)) if x[0] == "Expenses:Utilities:Electric"
+      assert_equal(-1242.87, x[1].round(2)) if x[0] == "Income:JobName"
+      assert_equal(-801.32, x[1].round(2)) if x[0] == "Liabilities:CreditCard"
+      assert_equal(-10085.75, x[1].round(2)) if x[0] == "Liabilities:Salliemae"
+    end
+  end
+
+end
+

data/transactions.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'transactions/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'transactions'
+  s.version       = Transaction::VERSION
+
+  s.summary       = "A bookkeeping application to help manage your finances."
+  s.description   = <<-EOF
+    A small but powerful command line application to help manage finances.
+    Transactions are entered into a text file using yaml and reports are
+    generated by parsing this data.
+  EOF
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_path  = 'lib'
+  s.require_paths = %w[lib]
+  s.executables   = ["transactions"]
+
+  s.authors       = ["Randy Schneck"]
+  s.email         = 'rasch@computercrayons.com'
+  s.homepage      = 'https://github.com/randyschneck/transactions'
+  s.license       = 'MIT'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transactions
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Randy Schneck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-27 00:00:00.000000000 Z
+date: 2013-06-29 00:00:00.000000000 Z
 dependencies: []
 description: |2
       A small but powerful command line application to help manage finances.
@@ -20,15 +20,18 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
 - bin/transactions
+- lib/transactions.rb
 - lib/transactions/main.rb
 - lib/transactions/options.rb
 - lib/transactions/parser.rb
 - lib/transactions/version.rb
-- lib/transactions.rb
-- LICENSE.md
-- README.md
-- CHANGELOG.md
+- test/ledger.yaml
+- test/test_transactions.rb
+- transactions.gemspec
 homepage: https://github.com/randyschneck/transactions
 licenses:
 - MIT
@@ -49,8 +52,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: A bookkeeping application to help manage your finances.
-test_files: []
+test_files:
+- test/ledger.yaml
+- test/test_transactions.rb