ledger_gen 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4fba09632d0197e1908966b5bc853020862d019
-  data.tar.gz: 1645c7d8f10015c54875e6931cee1659723e4e20
+  metadata.gz: ef56a31e0eaff2fe2873264e052138e1a751a2fd
+  data.tar.gz: 595843b7a15ed91352a8f35e3069f8be0f6ec9b1
 SHA512:
-  metadata.gz: b35a1a77e119b07dc182847b2dac3b270877110b6ca2d79c049265357379a19c233e4cbf56aea527bec46356b77ec99abd644d03dcd4895f1161cbbaa73514c8
-  data.tar.gz: d90c0935e1310b0143ba0f35b0b3ebbe0eeae7dd0f7aa15e2024927eee8e8dc8c8b8a983aef34ad4c23a57ae32d2c5ce07509256e1050bc76abde60b34fb44e8
+  metadata.gz: b0346e50cac7cff1626d50f6da33380d0409149f7162f1692c48a96537d90e4522bd6942a7c9834175cebdc9d81d196cd13b95fddf093f8be41289778d7a45d2
+  data.tar.gz: 8e2531fa740934717912ec1a9f10ec653f788f8e1d390015423acd132c7c3c31f97a4c08553a3efce28b566ffa550c47c0b396a8bd8504c4cac1484d3c0d5f63

data/README.md

@@ -29,7 +29,6 @@ j = LedgerGen::Journal.build do |journal|
     txn.posting do |post|
       post.account 'Expenses:Utils:Energy'
       post.amount 190.0
-      post.currency '$'
     end
     txn.posting 'Assets:PNC:Checking', -190.0
   end

data/ledger_gen.gemspec

@@ -20,7 +20,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "sorbet-runtime"
+
   spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sorbet"
 end

data/lib/ledger_gen/journal.rb

@@ -1,33 +1,47 @@
+# typed: strict
+
 module LedgerGen
   class Journal
+    extend T::Sig
+
+    sig {returns(String)}
     attr_accessor :date_format
 
-    def self.build
+    sig {params(blk: T.proc.params(arg0: Journal).void).returns(Journal)}
+    def self.build(&blk)
       journal = new
   
-      yield journal
+      blk.call(journal)
 
       return journal
     end
     
+    sig {void}
     def initialize
-      @transactions = []
-      @date_format = '%Y/%m/%d'
+      @transactions = T.let([], T::Array[Transaction])
+      @date_format = T.let('%Y/%m/%d', String)
     end
 
-    def transaction
+    sig {params(blk: T.proc.params(arg0: Transaction).void).void}
+    def transaction(&blk)
       txn = Transaction.new(date_format)
       @transactions << txn
 
       yield txn
     end
 
+    sig {returns(String)}
     def to_s
       @transactions.map(&:to_s).join("\n\n") + "\n"
     end
 
+    sig {params(ledger_options: String).returns(String)}
     def pretty_print(ledger_options='')
-      IO.popen("ledger #{ledger_options} -f - print", mode='r+') do |io|
+      if ledger_options == ''
+        ledger_options = %Q{-y "#{date_format}" --sort=date}
+      end
+
+      IO.popen("ledger #{ledger_options} -f - print", 'r+') do |io|
         io.write to_s
         io.close_write
         io.read

data/lib/ledger_gen/posting.rb

@@ -1,17 +1,31 @@
+# typed: strict
+
 module LedgerGen
   class Posting
+    extend T::Sig
+
+    sig {void}
+    def initialize
+      @account = T.let('', String)
+      @amount = T.let(0, Numeric)
+    end
+
+    sig { params(account: String).returns(String) }
     def account(account)
       @account = account
     end
 
+    sig { params(amount: Numeric).returns(Numeric) }
     def amount(amount)
       @amount = amount
     end
 
+    sig {returns(String)}
     def to_s
       "#{@account}  #{amount_string}"
     end
 
+    sig {returns(String)}
     def amount_string
       if @amount.nil?
         ''

data/lib/ledger_gen/transaction.rb

@@ -1,41 +1,63 @@
+# typed: strict
 module LedgerGen
   class Transaction
-    def initialize(date_format=nil)
-      @date_format = date_format || '%Y/%m/%d'
-      @postings = []
-      @comments = []
+    extend T::Sig
+
+    sig {params(date_format: String).void}
+    def initialize(date_format='%Y/%m/%d')
+      @date_format = T.let(date_format, String)
+      @postings = T.let([], T::Array[Posting])
+      @comments = T.let([], T::Array[String])
+
+      @date = T.let(nil, T.nilable(T.any(Date, DateTime)))
+      @payee = T.let(nil, T.nilable(String))
+      @cleared = T.let(false, T::Boolean)
     end
 
+    sig {params(date: T.any(Date, DateTime)).returns(T.any(Date, DateTime))}
     def date(date)
       @date = date
     end
 
+    sig {params(payee: String).returns(String)}
     def payee(payee)
       @payee = payee
     end
 
+    sig {void}
     def cleared!
       @cleared = true
     end
 
-    def posting(*args)
+    sig do
+      params(
+        account: T.nilable(String), 
+        amount: T.nilable(Float),
+        blk: T.nilable(T.proc.params(arg0: Posting).void)
+      ).void
+    end
+    def posting(account=nil, amount=nil, &blk)
       post = Posting.new
       @postings << post
 
-      if args.length > 0
-        post.account args.shift
-        if args.length > 0
-          post.amount args[0]
+      if account
+        post.account account
+        if amount
+          post.amount amount
         end
-      else
-        yield post
+      end
+
+      if block_given?
+        blk.call(post)
       end
     end
 
+    sig {params(comment: String).void}
     def comment(comment)
       @comments << comment
     end
 
+    sig {returns(String)}
     def to_s
       lines = ["#{date_string}#{cleared_string} #{@payee}"]
 
@@ -52,10 +74,12 @@ module LedgerGen
 
     private
 
+    sig {returns(String)}
     def date_string
-      @date.strftime(@date_format)
+      T.must(@date).strftime(@date_format)
     end
 
+    sig {returns(String)}
     def cleared_string
       @cleared ? ' *' : ''
     end

data/lib/ledger_gen/version.rb

@@ -1,3 +1,4 @@
+# typed: strong
 module LedgerGen
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 end

data/lib/ledger_gen.rb

@@ -1,4 +1,6 @@
+# typed: strong
 require "ledger_gen/version"
+require "sorbet-runtime"
 
 module LedgerGen
   # Your code goes here...

data/sorbet/config

@@ -0,0 +1,2 @@
+--dir
+.