libledger 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a389bd843cbd1fe00130adbd228914fc2be6e8bc
-  data.tar.gz: 7736b6c5b3d80730f46f3e852cbdada4312691db
+  metadata.gz: 88e563136240529f727ae98f888e3b81caa4720b
+  data.tar.gz: 3a4eae174f0515427d6fdc3197357b964198e3c2
 SHA512:
-  metadata.gz: 5017dbc9256136b0af509801457a91d8156865ecfd1743c1b6e75b7392e4be630afb6c62e6248db4d7bdc5d7591959fe1417f1e4b87e8e6f8aafcabdbf098fce
-  data.tar.gz: 1c14be5f9762e5d5c7fbb526ae2e900684f864a07110cd93da30f02c2338037cc9cfce848952e6fd15d94a5a3143a3b299f3442505fcba87ce47164ca2a29445
+  metadata.gz: f8f994d6113d6c16d605cfa1047d646cd839bdcaafcb1bb9f4d3fbff5d315d1a738fbcbb98e665a2ae9b0984bf44a2c281df24c049df51417e5af134bb498690
+  data.tar.gz: 6d95d946a03703961735f0363ca6d41b689bf8c8c9a23cfd59b217b46e2c4dc196d2a29317608d3edb606a1f0a1b941a2fca338e84e0a440c4aa84292bb79e7a

data/.circle-ruby

@@ -0,0 +1,4 @@
+2.4.0
+2.3.3
+2.2.6
+2.1.10

data/README.md

@@ -3,15 +3,45 @@ libledger
 
 [![Gem Version](https://img.shields.io/gem/v/libledger.svg)](https://rubygems.org/gems/libledger)
 [![Dependency Status](https://img.shields.io/gemnasium/akerl/libledger.svg)](https://gemnasium.com/akerl/libledger)
-[![Build Status](https://img.shields.io/circleci/project/akerl/libledger.svg)](https://circleci.com/gh/akerl/libledger)
+[![Build Status](https://img.shields.io/circleci/project/akerl/libledger/master.svg)](https://circleci.com/gh/akerl/libledger)
 [![Coverage Status](https://img.shields.io/codecov/c/github/akerl/libledger.svg)](https://codecov.io/github/akerl/libledger)
-[![Code Quality](https://img.shields.io/codacy/.svg)](https://www.codacy.com/app/akerl/libledger)
+[![Code Quality](https://img.shields.io/codacy/e5360f4242b64246b2a70022616c9bea.svg)](https://www.codacy.com/app/akerl/libledger)
 [![MIT Licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://tldrlegal.com/license/mit-license)
 
 Library for interacting with [Ledger](http://www.ledger-cli.org/) files.
 
 ## Usage
 
+libledger provides Ledger::Entry, which is a transaction, and Ledger::Journal, a list of transactions.
+
+To create a new entry:
+
+```
+require 'libledger'
+require 'date'
+
+entry = Ledger::Entry.new(
+  name: 'Delicious Chipotle Burrito',
+  state: :cleared,
+  date: Date.today,
+  actions: [
+    { name: 'Expenses:Burritos', amount: '$6.89' },
+    { name: 'Assets:visa' }
+  ]
+)
+
+# This will print the entry in ledger format
+puts entry
+```
+
+To read an entry, call `Ledger::Entry.from_lines(lines)`. `lines` should be an array of strings, which are the lines of a ledger journal for that transaction.
+
+To read a full journal, use `Ledger::Journal.from_file(file)`, where file should be a path to the journal file. If you have multiple files, `Ledger::Journal.from_files(files)` accepts an array of paths.
+
+To create a journal, use `Ledger::Journal.new(entries: array_of_entries)`.
+
+The output of `.to_s` on a Journal (which is called if you do `puts my_journal` is the ledger text file format for its transactions.
+
 ## Installation
 
     gem install libledger

data/circle.yml

@@ -1,12 +1,7 @@
 dependencies:
   override:
-    - 'rvm-exec 1.9.3-p551 bundle install'
-    - 'rvm-exec 2.0.0-p645 bundle install'
-    - 'rvm-exec 2.1.6 bundle install'
-    - 'rvm-exec 2.2.2 bundle install'
+  - 'for i in $(cat .circle-ruby) ; do rvm-exec $i gem update --system --no-doc || exit 1 ; done'
+  - 'for i in $(cat .circle-ruby) ; do rvm-exec $i bundle install || exit 1 ; done'
 test:
   override:
-    - 'rvm-exec 1.9.3-p551 bundle exec rake'
-    - 'rvm-exec 2.0.0-p645 bundle exec rake'
-    - 'rvm-exec 2.1.6 bundle exec rake'
-    - 'rvm-exec 2.2.2 bundle exec rake'
+  - 'for i in $(cat .circle-ruby) ; do rvm-exec $i bundle exec rake || exit 1 ; done'

data/lib/libledger/entry.rb

@@ -4,6 +4,11 @@ module Ledger
   ENTRY_SUBJECT_LINE_REGEX = %r{^(\d+/\d+/\d+) (?:([*!]) )?(.*)$}
   ENTRY_ACTION_LINE_REGEX = /^\s+(\w+[^(  )\t]*)(?:\s+(.*))?$/
 
+  STATE_MAPPING = {
+    cleared: '*',
+    pending: '!'
+  }.freeze
+
   ##
   # Declaration for entry object
   class Entry
@@ -19,16 +24,12 @@ module Ledger
       @state ||= @data[:state]
     end
 
-    def state_as_symbol
-      return @state_as_symbol if @state_as_symbol
-      @state = case state
-               when '*'
-                 :cleared
-               when '!'
-                 :pending
-               else
-                 raise "Unexpected state on #{name}: #{state}"
-               end
+    def state_sym
+      @state_sym ||= state.is_a?(Symbol) ? state : STATE_MAPPING.invert[state]
+    end
+
+    def state_str
+      @state_str ||= state.is_a?(Symbol) ? STATE_MAPPING[state] : state
     end
 
     def date
@@ -48,7 +49,7 @@ module Ledger
     private
 
     def subject_line
-      "#{date.strftime('%Y/%m/%d')} #{state} #{name}\n"
+      "#{date.strftime('%Y/%m/%d')} #{state_str} #{name}\n"
     end
 
     def action_lines

data/libledger.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'libledger'
-  s.version     = '0.0.1'
+  s.version     = '0.0.2'
   s.date        = Time.now.strftime('%Y-%m-%d')
 
   s.summary     = 'Library for interacting with Ledger files'
@@ -13,9 +13,9 @@ Gem::Specification.new do |s|
   s.files       = `git ls-files`.split
   s.test_files  = `git ls-files spec/*`.split
 
-  s.add_development_dependency 'rubocop', '~> 0.39.0'
-  s.add_development_dependency 'rake', '~> 11.1.0'
+  s.add_development_dependency 'rubocop', '~> 0.47.0'
+  s.add_development_dependency 'rake', '~> 12.0.0'
   s.add_development_dependency 'codecov', '~> 0.1.1'
-  s.add_development_dependency 'rspec', '~> 3.4.0'
-  s.add_development_dependency 'fuubar', '~> 2.0.0'
+  s.add_development_dependency 'rspec', '~> 3.5.0'
+  s.add_development_dependency 'fuubar', '~> 2.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libledger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Les Aker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-25 00:00:00.000000000 Z
+date: 2017-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.39.0
+        version: 0.47.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.39.0
+        version: 0.47.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 11.1.0
+        version: 12.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 11.1.0
+        version: 12.0.0
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -58,34 +58,35 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.2.0
 description: Library for interacting with Ledger files
 email: me@lesaker.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circle-ruby"
 - ".gitignore"
 - ".prospectus"
 - ".rspec"
@@ -121,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Library for interacting with Ledger files