ledger_gen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 966d3554a058f768f3c3f7e90262b60469c79916
+  data.tar.gz: 0802b4c89af101b6220cb9f9386f38778a368565
+SHA512:
+  metadata.gz: 61b172629664fd9f7ff3961798222b591a236e22eb58f9d3c60961796fa17f99bfd5617bb7e63609e25a4445b7a509c204412df78440b1e694f2054f6989b33d
+  data.tar.gz: 4c660113dfeac9c79e080c8bbce7380f1fc97609689d8a1b9d368e35a89a263293bc13e3571b7338017c6b965961e5e346c4855f7a6c6baab1b3e290d08886e1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.13.7

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at pete@petekeen.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ledger_gen.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Cora Street Press LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# LedgerGen
+
+Generate [Ledger](https://ledger-cli.org) files using a convenient Ruby DSL.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ledger_gen'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ledger_gen
+
+## Usage
+
+```ruby
+j = LedgerGen::Journal.build do |journal|
+  journal.transaction do |txn|
+    txn.cleared!
+    txn.date Date.parse('2017/04/30')
+    txn.payee "DTE Energy"
+    txn.posting do |post|
+      post.account 'Expenses:Utils:Energy'
+      post.amount 190.0
+      post.currency '$'
+    end
+    txn.posting 'Assets:PNC:Checking', -190.0
+  end
+end
+
+puts j.pretty_print # ledger binary required
+puts j.to_s # not pretty, but it works without the binary
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/peterkeen/ledger_gen. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ledger_gen"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ledger_gen.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ledger_gen/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ledger_gen"
+  spec.version       = LedgerGen::VERSION
+  spec.authors       = ["Pete Keen"]
+  spec.email         = ["pete@petekeen.net"]
+
+  spec.summary       = %q{Generate ledger-cli files from Ruby}
+  spec.homepage      = "https://github.com/peterkeen/ledger_gen"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/ledger_gen/journal.rb

@@ -0,0 +1,34 @@
+module LedgerGen
+  class Journal
+    def self.build
+      journal = new
+  
+      yield journal
+
+      return journal
+    end
+    
+    def initialize
+      @transactions = []
+    end
+
+    def transaction
+      txn = Transaction.new
+      @transactions << txn
+
+      yield txn
+    end
+
+    def to_s
+      @transactions.map(&:to_s).join("\n\n") + "\n"
+    end
+
+    def pretty_print
+      IO.popen("ledger -f - print", mode='r+') do |io|
+        io.write to_s
+        io.close_write
+        io.read
+      end
+    end
+  end
+end

data/lib/ledger_gen/posting.rb

@@ -0,0 +1,23 @@
+module LedgerGen
+  class Posting
+    def account(account)
+      @account = account
+    end
+
+    def amount(amount)
+      @amount = amount
+    end
+
+    def to_s
+      "#{@account}  #{amount_string}"
+    end
+
+    def amount_string
+      if @amount.nil?
+        ''
+      else
+        sprintf('$%0.2f', @amount)
+      end
+    end
+  end
+end

data/lib/ledger_gen/transaction.rb

@@ -0,0 +1,62 @@
+module LedgerGen
+  class Transaction
+    def initialize
+      @postings = []
+      @comments = []
+    end
+
+    def date(date)
+      @date = date
+    end
+
+    def payee(payee)
+      @payee = payee
+    end
+
+    def cleared!
+      @cleared = true
+    end
+
+    def posting(*args)
+      post = Posting.new
+      @postings << post
+
+      if args.length > 0
+        post.account args.shift
+        if args.length > 0
+          post.amount args[0]
+        end
+      else
+        yield post
+      end
+    end
+
+    def comment(comment)
+      @comments << comment
+    end
+
+    def to_s
+      lines = ["#{date_string}#{cleared_string} #{@payee}"]
+
+      @comments.each do |comment|
+        lines << "    ; #{comment}"
+      end
+
+      @postings.each do |post|
+        lines << "    " + post.to_s
+      end
+
+      lines.join("\n")
+    end
+
+    private
+
+    def date_string
+      @date.strftime("%Y/%m/%d")
+    end
+
+    def cleared_string
+      @cleared ? ' *' : ''
+    end
+  end
+end

data/lib/ledger_gen/version.rb

@@ -0,0 +1,3 @@
+module LedgerGen
+  VERSION = "0.1.0"
+end

data/lib/ledger_gen.rb

@@ -0,0 +1,9 @@
+require "ledger_gen/version"
+
+module LedgerGen
+  # Your code goes here...
+end
+
+require "ledger_gen/posting"
+require "ledger_gen/transaction"
+require "ledger_gen/journal"

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: ledger_gen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pete Keen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- pete@petekeen.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ledger_gen.gemspec
+- lib/ledger_gen.rb
+- lib/ledger_gen/journal.rb
+- lib/ledger_gen/posting.rb
+- lib/ledger_gen/transaction.rb
+- lib/ledger_gen/version.rb
+homepage: https://github.com/peterkeen/ledger_gen
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Generate ledger-cli files from Ruby
+test_files: []