ldgr 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd1b9f7d89658b02753509fe2c2b768627ad4fa8
-  data.tar.gz: 5978628789242f582e8830f30f24fcca9e59d3e2
+  metadata.gz: 5a5adf1070c9805e0c5f9b7795a5053e68605190
+  data.tar.gz: 17af8d0b4619d9c529d8417d063b7a9e791a5bd3
 SHA512:
-  metadata.gz: e255ab170b8b1ef33fd2ab0639befe62455ab602651b7838b9eb00fb8477343e2b04c49c677ba8693805eee80955df478f537a50b52b2abdde6b808268d8a771
-  data.tar.gz: 5d75bc6a48e72a46b1794034357c35e9bf01cab8f9aa5851b901f709d90c306f34938a86b1961ea86d92371e667202d4a06c34fe384023a3a48dfca68022dd7b
+  metadata.gz: e381ee9ba9d38eb313165aabc7bbbf2cedf3413b5b9af52f85be3634ffa4079d7e3f7e96d02ae7373b4db7fbb049c892760052b93cb34bfd183f92509b03d8f8
+  data.tar.gz: d7764d3aa17416fdd1400067457c32fe2e0992e07c64e34694f75bf64791849494558f9bc09dd502b5384d63d71ffbff2185fb99310eb51bb5f88cb8db93b149

data/.gitignore

@@ -1,3 +1,4 @@
+CODE_OF_CONDUCT.md
 /.bundle/
 /.yardoc
 /Gemfile.lock

data/bin/ldgr

@@ -2,4 +2,5 @@
 
 require 'ldgr'
 
-Ldgr::Parser.parse
+parser = Ldgr::Parser.new
+parser.parse

data/lib/ldgr/parser.rb

@@ -10,19 +10,82 @@ require 'fileutils'
 require 'yaml'
 
 module Ldgr
+  # Parses configuration options.
+  #
+  #
+  # Examples
+  #
+  #   Ldgr::Parser.parse
+  #   # => some file action
+  #
+  # Returns nothing on success.
   class Parser
     FILEBASE = Dir.home + '/.config/ledger/'
-    FILE = FILEBASE + 'transactions.dat'
     VERSION = Ldgr::VERSION
     PROGRAM_NAME = 'ldgr'
     MATCH = /(?=(\n\d\d\d\d-\d\d-\d\d)(=\d\d\d\d-\d\d-\d\d)*)|\z/
     OTHER_MATCH = /(?=(\d\d\d\d-\d\d-\d\d)(=\d\d\d\d-\d\d-\d\d)*)/
-    COMMANDS = %w(add sort tag clear open)
-    SETUP_FILES = %w(transactions.dat accounts.dat budgets.dat aliases.dat commodities.dat setup.dat ledger.dat ldgr.yaml)
-    CONFIG_FILE = Pathname(FILEBASE + 'ldgr.yaml')
-    LDGR_DEFAULTS = { currency: '$', equity: 'Cash' }.to_h
 
-    def self.parse
+    attr_accessor :transactions_file, :config
+
+    # Public: Creates a new Parser object
+    #
+    # config  - A hash of config options
+    #
+    # Examples
+    #
+    #   new(config: {currency: '¥'})
+    #   # => <ParserObject>
+    #
+    # Returns a Parser object.
+    def initialize(config: {})
+      @transactions_file = defaults.fetch(:transactions_file)
+      @config = defaults.merge(user_config).merge(config)
+    end
+
+    # Public: User-specified config options
+    #
+    # Examples
+    #
+    #   user_config
+    #   # => {all the config options from the user's YAML file}
+    #
+    # Returns a hash of user-specified config options.
+    def user_config
+      path = Pathname(FILEBASE + 'ldgr.yaml')
+      YAML.load_file(path).to_h
+    end
+
+    # Public: available commands
+    #
+    # Examples
+    #
+    #   commands
+    #
+    # Returns an array of command names.
+    def commands
+      %w(add sort tag clear open)
+    end
+
+    # Public: expected setup files
+    #
+    # Examples
+    #
+    #   setup_files
+    #
+    # Returns an array of file names.
+    def self.setup_files
+      %w(transactions.dat accounts.dat budgets.dat aliases.dat commodities.dat setup.dat ledger.dat ldgr.yaml)
+    end
+
+    # Public: Kicks off the CLI
+    #
+    # Examples
+    #
+    #   parse
+    #
+    # Returns nothing.
+    def parse
       cli = OptionParser.new do |o|
         o.banner = "Usage #{PROGRAM_NAME} [add|sort|tag|clear|open]"
         o.program_name = PROGRAM_NAME
@@ -39,37 +102,50 @@ module Ldgr
         o.define '-p', '--payee=PAYEE', String, 'the payee of the transaction'
       end
 
-      config = defaults
       command = String(cli.parse(ARGV, into: config)[0])
-      binding.irb
-      send(command, config) if COMMANDS.include? command
+      send(command) if commands.include? command
     end
 
-    def self.add(config)
+    # Public: Adds a transaction to the transactions_file.
+    #
+    # Examples
+    #
+    #   add
+    #
+    # Returns nothing.
+    def add
       error_policy = ->(key) { fail "You need to provide a value for #{key.to_s}." }
 
       transaction = Transaction.new do |t|
-        date = String(config.fetch(:date) { Date.today } )
-        effective = String(config.fetch(:effective) { Date.today })
+        date = String(config.fetch(:date) { |key| error_policy.call(key) })
+        effective = String(config.fetch(:effective) { |key| error_policy.call(key) })
 
         t.payee    = config.fetch(:payee) { |key| error_policy.call(key) }
         t.account  = config.fetch(:account) { |key| error_policy.call(key) }
         t.amount   = config.fetch(:amount) { |key| error_policy.call(key) }
-        t.currency = config.fetch(:currency) { defaults.fetch('currency') { '$' } }
-        t.equity   = config.fetch(:equity) { defaults.fetch('equity') { 'Cash' } }
+        t.currency = config.fetch(:currency) { config.fetch(:currency) }
+        t.equity   = config.fetch(:equity) { config.fetch(:equity) }
         t.cleared  = config[:cleared] ? '* ' : ''
         t.date     = date == effective ? date : date << '=' << effective
       end
 
-      File.open(FILE, 'a') { |file| file.puts transaction }
+      File.open(transactions_file, 'a') { |file| file.puts transaction }
     end
 
-    def self.clear(config)
+    # Public: Runs through all uncleared transactions that are passed
+    # their effective date and offers to clear them.
+    #
+    # Examples
+    #
+    #   clear
+    #
+    # Returns nothing.
+    def clear
       output = ''
       pattern = /((^\d{,4}-\d{,2}-\d{,2})(=\d{,4}-\d{,2}-\d{,2})?) ([^\*]+)/
       count = 0
 
-      File.open(FILE, 'r') do |transactions|
+      File.open(transactions_file, 'r') do |transactions|
         transactions.each_line do |transaction|
           match = pattern.match(transaction)
           if match && match[3]
@@ -90,16 +166,23 @@ module Ldgr
           output << transaction
         end
       end
-      IO.write(FILE, output)
+      IO.write(transactions_file, output)
     end
 
-    def self.tag(config)
+    # Public: Runs through all transactions with only Expenses set as the account and lets you enter an account name.
+    #
+    # Examples
+    #
+    #   tag
+    #
+    # Returns nothing.
+    def tag
       output = ''
       pattern = /(^\s+Expenses[^:])\s*(¥.+)/
       count = 0
       previous = ''
 
-      File.open(FILE, 'r') do |transactions|
+      File.open(transactions_file, 'r') do |transactions|
         transactions.each_line do |transaction|
           match = pattern.match(transaction)
           if match
@@ -112,11 +195,18 @@ module Ldgr
           output << transaction
         end
       end
-      IO.write(FILE, output)
+      IO.write(transactions_file, output)
     end
 
-    def self.sort(config)
-      text = File.read(FILE).gsub(/\n+|\r+/, "\n").squeeze("\n").strip
+    # Public: Sorts all transactions by date.
+    #
+    # Examples
+    #
+    #   sort
+    #
+    # Returns nothing.
+    def sort
+      text = File.read(transactions_file).gsub(/\n+|\r+/, "\n").squeeze("\n").strip
       scanner = StringScanner.new(text)
       results = []
 
@@ -125,13 +215,21 @@ module Ldgr
         scanner.skip_until(OTHER_MATCH)
       end
 
-      File.open(FILE, 'w') do |file|
+      File.open(transactions_file, 'w') do |file|
         file.puts results.sort
       end
     end
 
-    def self.open(_)
-      def self.open_file(file_to_open)
+    # Public: Opens a settings file from ~/.config/ledger
+    #
+    # Examples
+    #
+    #   open accounts
+    #   # => accounts file opens in $EDITOR
+    #
+    # Returns nothing.
+    def open
+      def open_file(file_to_open)
         checked_file = "#{FILEBASE}#{file_to_open}.dat"
         raise "#{checked_file} doesn't exist." unless Pathname(checked_file).exist?
         system(ENV['EDITOR'], checked_file)
@@ -140,20 +238,41 @@ module Ldgr
       open_file(ARGV[1])
     end
 
-    def self.defaults(config_file=CONFIG_FILE)
-      LDGR_DEFAULTS.merge(YAML.load_file(config_file).to_h)
+    # Public: ldgr's default configuration options
+    #
+    # Examples
+    #
+    #   defaults
+    #   # => {all the configuration options}
+    #
+    # Returns a hash of default configuration options.
+    def defaults
+      {
+        currency: '$',
+        equity: 'Cash',
+        effective: Date.today,
+        date: Date.today,
+        cleared: false,
+        transactions_file: FILEBASE + 'transactions.dat'
+      }
     end
 
+    # Private: Prepares users' file system for ldgr.
+    #
+    # Returns nothing.
     def self.setup
       unless config_exist?
         FileUtils.mkdir_p(FILEBASE)
-        SETUP_FILES.each do |file|
+        setup_files.each do |file|
           FileUtils.touch("#{FILEBASE}#{file}")
         end
       end
     end
 
-    def self.config_exist?(setup_files=SETUP_FILES)
+    # Private: Checks if user already has setup files created.
+    #
+    # Returns nothing.
+    def self.config_exist?
      setup_files.each do |file|
         return false unless Pathname("#{FILEBASE}#{file}").exist?
       end

data/lib/ldgr/version.rb

@@ -1,3 +1,3 @@
 module Ldgr
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ldgr
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Brandon Pittman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-07 00:00:00.000000000 Z
+date: 2017-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -90,7 +90,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
-- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# 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 brandon@brandonpittman.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/