ldgr 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1cdd71b68327e76f3c01194a9a24e5e2c053b310
-  data.tar.gz: 55fb61cbb6400393d965e131165934c015d64d10
+  metadata.gz: 2cf0af91bbd0fc24c82ffcba64fe56010760d6a5
+  data.tar.gz: 25e3a3306bd5b3d53345fa057684b002d7063640
 SHA512:
-  metadata.gz: 2ca3cc59260eb2b85bf97a9a14a9213320c3f66994fb64b1e8b486f264dd9e616d190e2b7827f1ea124c9dac88ccce5215dbe4d0754a2011dce52a51ea2cd570
-  data.tar.gz: e646c0f9cdc2505bd5300b0eccbc4fdc835e83291caa6a04dd897d289a6e196be715315bc5c779614f8ca17f605a4bb6f84188894646defd4aa47d1da4a0b2e2
+  metadata.gz: 51e1bb6a8c4510c348590dc2491585780402cfee9ace93a5b7c12c13d0ec4a39a1b08429d757dfe909dc9923e2741d8fa90b0315485d5781277fb405659fb00f
+  data.tar.gz: 10dac09da6a9406235535eba7b4b114c5d59711ac4e9ce1006b407eb18bf3cbb35c4fc610d033b737278bdec47836c4c291ca47ed71ebee636369f9db2850d93

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+config.rb

data/README.md

@@ -1,6 +1,21 @@
 # Ldgr
 
-Ldgr is a command-line tool for adding, sorting and tagging transactions in your Ledger file.
+Ldgr is a command-line tool for adding, sorting and tagging transactions in your Ledger file. It's rather opinionated in that it requires you to break down your Ledger file into multiple files.
+
+~~~
+~/.config/ledger/
+   -> ledger.dat
+   -> setup.dat
+   -> transactions.dat
+   -> accounts.dat
+   -> commodities.dat
+   -> budgets.dat
+   -> aliases.dat
+~~~
+
+ldgr can't handle all the text manipulation of transactions unless it can expect the text in the file to be just transaction data. This may be addressed in the future, but for now, please ahere to this file structure. I think you'll find it works well. You can use the **include** directive in Ledger files to add everything into the **ledger.dat** file.
+
+For maximum compatibility, `alias ledger="ledger --init-file ~/.config/ledger/ledgerrc"`, where the RC file contains frequently used command-line options.
 
 ## Installation
 
@@ -40,15 +55,17 @@ ldgr sort
 ~~~ruby
 transaction = Ldgr::Transaction.new do |t|
     t.payee = 'Brandon'
-    t.amount = 1000
+    t.amount = '1000'
     t.account = 'Something'
-    t.equity = 'Cash
-    t.date = Date.today + 1'
-    t.effective = Date.today + 10'
+    t.equity = 'Cash'
+    t.date = Date.today + 1
+    t.effective = Date.today + 10
     t.cleared = true
 end
 ~~~
 
+Ledger works with plain text files, so **yes**, the amount attribute should be a string.
+
 ## TODO
 
 Currently, the Ledger file is a constant set to `~/.config/ledger/transactions.dat`. This should probably be customizable, possibly with a `.ldgrrc` in the future. Also, the default currency is Japanese Yen. You can change this the `--currency $` flag on the command line or setting it in the `Transaction.new` block. In the future, this should be set in an rc file.

data/ldgr.gemspec

@@ -35,6 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters"
 
   spec.executables << 'ldgr'
 end

data/lib/ldgr/parser.rb

@@ -5,6 +5,7 @@ require 'optparse'
 require 'optparse/date'
 require 'pathname'
 require 'strscan'
+require 'fileutils'
 
 module Ldgr
   class Parser
@@ -133,5 +134,20 @@ module Ldgr
 
       open_file(ARGV[1])
     end
+
+    def self.setup
+      unless config_exist?
+        %w(transactions.dat accounts.dat budgets.dat aliases.dat commodities.dat setup.dat ledger.dat).each do |file|
+          FileUtils.touch("#{FILEBASE}#{file}")
+        end
+      end
+    end
+
+    def self.config_exist?
+      return false unless Pathname(FILEBASE).exist?
+      true
+    end
+
+    setup
   end
 end

data/lib/ldgr/transaction.rb

@@ -12,7 +12,7 @@ module Ldgr
   #
   # Returns a transaction.
   class Transaction
-    attr_accessor :payee, :amount, :account, :equity, :date, :currency, :cleared
+    attr_accessor :payee, :amount, :account, :equity, :date, :effective, :currency, :cleared
 
     def initialize(&block)
       yield self if block_given?
@@ -21,9 +21,16 @@ module Ldgr
     def to_s
       <<~HERE
       #{date} #{cleared}#{payee}
-      #{account}  #{currency}#{amount}
-      #{equity}
+        #{account}  #{currency}#{amount}
+        #{equity}
       HERE
     end
+
+    def valid?
+      return false if String(payee).empty?
+      return false if String(amount).empty?
+      return false if String(account).empty?
+      true
+    end
   end
 end

data/lib/ldgr/version.rb

@@ -1,3 +1,3 @@
 module Ldgr
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ldgr
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Brandon Pittman
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A command-line tool for managing Ledger transactions.
 email:
 - ldgr@brandonpittman.net