ballista 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 98d859e7cd342d957cb3a859d1c0dbad9d0e9b3e
-  data.tar.gz: ce880f15be9b6b97d1dfb2f0366bd72b941cd45d
+SHA256:
+  metadata.gz: 908c4d0abe9c14c6d26198e78b7e4bf02cf701079bb2adad1a903d7787cd7ddf
+  data.tar.gz: c1e953583fe7f32b7102bfe4f3924d74a9394fb51f08c8e8855141890a1ad391
 SHA512:
-  metadata.gz: c19d72ea5c1387012e4630c8410e076acb5cc7327a0e4121434dec4f42a9d78c1d903f21e67567560edb8fd9a115b2b8012894528bc7df02f278f3f410d9359d
-  data.tar.gz: 0f34f5fc4284b40dd31c664787c7baaf773bd27129b4e3c93af9c4287089c7a39ee0f561cef466cba3ef4321711153c945962cc987ed057a858c280c52568079
+  metadata.gz: 8378709556a8a7661640a639584679aaa2d241760738ffa2340e9fd67bc78a349c446cc8eac1bed3b191df4d7315d3f650fde1f7dc97b9b6f31bdd803d2a4603
+  data.tar.gz: c4b2cb1ca8e1597fa8e241229501cd81aad6c926acf80ff47408b26b6e3b7ec9f858d176b837b77a75ea407978c3fb2ea3c5433f039256e5950cbeac0a86c3ef

data/.circle-ruby

@@ -0,0 +1,4 @@
+2.6.1
+2.5.3
+2.4.5
+2.3.8

data/.prospectus

@@ -1,11 +1,11 @@
+my_slug = 'akerl/ballista'
+
+Prospectus.extra_dep('file', 'prospectus_travis')
+Prospectus.extra_dep('file', 'prospectus_gems')
+
 item do
-  expected do
-    static
-    set 'green'
-  end
+  noop
 
-  actual do
-    gemnasium
-    slug 'akerl/ballista'
-  end
+  extend ProspectusGems::Gemspec.new
+  extend ProspectusTravis::Build.new(my_slug)
 end

data/.rubocop.yml

@@ -1,2 +1,2 @@
-Encoding:
-    Enabled: false
+inherit_gem:
+  goodcop: .rubocop.yml

data/.travis.yml

@@ -0,0 +1,10 @@
+dist: xenial
+install:
+- for i in $(cat .circle-ruby) ; do rvm install $i || exit 1 ; done
+- for i in $(cat .circle-ruby) ; do rvm-exec $i bundle install || exit 1 ; done
+script:
+- for i in $(cat .circle-ruby) ; do rvm-exec $i bundle exec rake || exit 1 ; done
+notifications:
+  email: false
+  slack:
+    secure: BrYLyxYCfTN/nK4VrKkXh9HxqIu2Vtz1L4TbW8AtHPsCxOMj650yuwmZncgq06DYQWW8v1Sch/KcXTTmOJvN4ebW3oVRfLCPzBzheHij5EPLkAo8uR8703iHZfJtGLGsx7Dc7x2Ohgtv+aHtK89RHp0ZR9hIUwC6Z3PJP6W0u9N/p3Cq4sum+QnANIhW/wjJt9koTGRp80NN6e70siB64OrpzOGCIm1cLBa9m2Oqc0pM/NcBI6IFYFAlbJmOHnvm1/QS8KVW361soUbVGBEr0FtlNNcy4k0bY5TUiciSe2kAM/F72uumumkvztNEKZpYibP/7UxoTGzyX2GEysJJxkDnmquUh01Uzfc0VbAA7bnkL/YmXHLMu/u3Vqq2DbjymFPyYSFtjznw05SXQNVcqJ7IGkb1//5XiEc5YH8g5qjU7ma7eZdZe7Rd81gZ8ePIzrjXhq+7lX3pLY/GpLMcJs2XQlHTatSZ5BjBZcpEjfBTVb7uD5G/6afKXm5l+6M8uB16zMjnxtFfi/11mLLjScaE9h4SiCtiAG0E58pHlbBbrmBkqlxc7PmXTS5wGIg6qRzsU9SrJeKSPv8UnN7bcndA9JdoCKTRDELremtbPDpehAkaX5mi/5Uw+/FQ4Qx19S+WToMMRaGcvzzyDf13twKIgrZMTBvJHw1Qyhiu7Gk=

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
 gemspec
-

data/README.md

@@ -2,8 +2,7 @@ ballista
 =========
 
 [![Gem Version](https://img.shields.io/gem/v/ballista.svg)](https://rubygems.org/gems/ballista)
-[![Dependency Status](https://img.shields.io/gemnasium/akerl/ballista.svg)](https://gemnasium.com/akerl/ballista)
-[![Build Status](https://img.shields.io/circleci/project/akerl/ballista.svg)](https://circleci.com/gh/akerl/ballista)
+[![Build Status](https://img.shields.io/travis/com/akerl/ballista.svg)](https://travis-ci.com/akerl/ballista)
 [![Coverage Status](https://img.shields.io/codecov/c/github/akerl/ballista.svg)](https://codecov.io/github/akerl/ballista)
 [![Code Quality](https://img.shields.io/codacy/c9caebd934f04ca699d1f02fac6dcf22.svg)](https://www.codacy.com/app/akerl/ballista)
 [![MIT Licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://tldrlegal.com/license/mit-license)
@@ -12,6 +11,37 @@ Helper for projecting based on [Ledger](http://www.ledger-cli.org/) format.
 
 ## Usage
 
+To make a new Projection object, use `Ballista.new(entries: my_config)`. my_config should be a hash of projection entries, like this:
+
+```
+- name: Pay Check
+  when:
+  - 15
+  - 30
+  actions:
+    Expenses:Taxes:federal_income: $729.26
+    Expenses:Taxes:va_income: $215.14
+    Expenses:Taxes:social_security: $299.46
+    Expenses:Taxes:medicare: $70.04
+    Assets:Checking:simple: $2739.10
+    Assets:401K:Trad:work: $772.00
+    Income:Salary:work: $-4825.00
+- name: Automatic transfer to Savings
+  when: 2
+  actions:
+    Assets:Savings:ally: $1000.00
+    Assets:Checking:simple: null
+- name: Rent
+  when: 2
+  actions:
+    Expenses:Bills:rent: $2800.00
+    Assets:Checking:simple: null
+```
+
+To do a projection, call `.project(start_dt, end_dt)` on your created object. The dates should be Ruby Date objects.
+
+The returned object will be a Ledger journal, courtesy of [libledger](https://github.com/akerl/libledger). As such, you can inspect the .entries as well as use .to_s or puts to print it in ledger text file format.
+
 ## Installation
 
     gem install ballista

data/Rakefile

@@ -7,8 +7,7 @@ RSpec::Core::RakeTask.new(:spec)
 
 desc 'Run Rubocop on the gem'
 RuboCop::RakeTask.new(:rubocop) do |task|
-  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb', 'bin/*']
   task.fail_on_error = true
 end
 
-task default: [:spec, :rubocop, :build, :install]
+task default: %i[spec rubocop build install]

data/ballista.gemspec

@@ -1,13 +1,15 @@
-$:.unshift File.expand_path('../lib/', __FILE__)
+require 'English'
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
 require 'ballista/version'
 
 Gem::Specification.new do |s|
   s.name        = 'ballista'
   s.version     = Ballista::VERSION
   s.date        = Time.now.strftime('%Y-%m-%d')
+  s.required_ruby_version = '>= 2.5.0'
 
   s.summary     = 'Projection tool for Ledger format'
-  s.description = "Projection tool for Ledger format"
+  s.description = 'Projection tool for Ledger format'
   s.authors     = ['Les Aker']
   s.email       = 'me@lesaker.org'
   s.homepage    = 'https://github.com/akerl/ballista'
@@ -17,13 +19,12 @@ Gem::Specification.new do |s|
   s.test_files  = `git ls-files spec/*`.split
   s.executables = ['ballista']
 
-  s.add_dependency 'libledger', '~> 0.0.1'
-  s.add_dependency 'mercenary', '~> 0.3.4'
-  s.add_dependency 'cymbal', '~> 1.0.0'
+  s.add_dependency 'cymbal', '~> 2.0.0'
+  s.add_dependency 'libledger', '~> 0.0.8'
+  s.add_dependency 'mercenary', '~> 0.4.0'
 
-  s.add_development_dependency 'rubocop', '~> 0.39.0'
-  s.add_development_dependency 'rake', '~> 11.1.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 'codecov', '~> 0.5.1'
+  s.add_development_dependency 'goodcop', '~> 0.9.3'
+  s.add_development_dependency 'rake', '~> 13.0.3'
+  s.add_development_dependency 'rspec', '~> 3.10.0'
 end

data/bin/ballista

@@ -4,9 +4,28 @@ require 'ballista'
 require 'yaml'
 require 'mercenary'
 require 'cymbal'
+require 'date'
 
 def parse_config(file)
-  Cymbal.symbolize(YAML.load(File.read(file)))
+  Cymbal.symbolize(YAML.safe_load(File.read(file)))
+end
+
+def count_months(months)
+  return unless months
+  start_dt = Date.today + 1
+  end_dt = start_dt >> months.to_i
+  [start_dt, end_dt]
+end
+
+def parse_start_end(start_dt, end_dt)
+  return unless start_dt || end_dt
+  raise('Must specify start and end together') unless start_dt && end_dt
+  [Date.parse(start_dt), Date.parse(end_dt)]
+end
+
+def parse_range(months, start_dt, end_dt)
+  raise('Cannot specify months *and* start/end') if months && (start_dt || end_dt)
+  count_months(months) || parse_start_end(start_dt, end_dt) || count_months(12)
 end
 
 Mercenary.program(:ballista) do |p|
@@ -16,13 +35,17 @@ Mercenary.program(:ballista) do |p|
 
   p.option :output, '-o FILE', '--output FILE', 'Output file for ledger'
   p.option :months, '-m INT', '--months INT', 'How far ahead to project'
+  p.option :start, '-s DATE', '--start DATE', 'When to start the projection'
+  p.option :end, '-e DATE', '--end DATE', 'When to end the projection'
 
   p.action do |_, options|
     config_file = ARGV.shift
     puts p unless config_file
     config = parse_config(config_file)
-    months = options[:months] || 12
-    projection = Ballista.new(entries: config).project(months)
+
+    start_dt, end_dt = parse_range(*options.values_at(:months, :start, :end))
+
+    projection = Ballista.new(entries: config).project(start_dt, end_dt)
     if options[:output]
       File.open(options[:output], 'w') { |fh| fh << projection.to_s }
     else

data/lib/ballista.rb

@@ -13,3 +13,4 @@ end
 
 require 'ballista/version'
 require 'ballista/projection'
+require 'ballista/frequencies'

data/lib/ballista/frequencies.rb

@@ -0,0 +1,18 @@
+require 'ballista/frequencies/base'
+require 'ballista/frequencies/monthly'
+require 'ballista/frequencies/weekly'
+require 'ballista/frequencies/biweekly'
+
+module Ballista
+  ##
+  # Base module for Frequency of actions
+  module Frequencies
+    class << self
+      FREQUENCIES = {
+        monthly: Monthly,
+        weekly: Weekly,
+        biweekly: Biweekly
+      }.freeze
+    end
+  end
+end

data/lib/ballista/frequencies/base.rb

@@ -0,0 +1,21 @@
+require 'date'
+
+module Ballista
+  module Frequencies
+    ##
+    # Base class for frequency subclasses
+    class Base
+      def initialize(action, start, stop)
+        @name = action[:name]
+        @start = action[:starts] ? Date.parse(action[:starts]) : start
+        @stop = action[:stops] ? Date.parse(action[:stops]) : stop
+        @amount = action[:amount].to_i
+        @when = action[:when]
+      end
+
+      def entry(date)
+        [date, @name, @amount]
+      end
+    end
+  end
+end

data/lib/ballista/frequencies/biweekly.rb

@@ -0,0 +1,11 @@
+module Ballista
+  module Frequencies
+    ##
+    # Biweekly actions
+    class Biweekly < Weekly
+      def step
+        14
+      end
+    end
+  end
+end

data/lib/ballista/frequencies/monthly.rb

@@ -0,0 +1,27 @@
+module Ballista
+  module Frequencies
+    ##
+    # Monthly actions
+    class Monthly < Base
+      def initialize(*_)
+        super
+        @when = [@when] unless @when.is_a? Array
+      end
+
+      def log
+        @when.flat_map do |date|
+          pointer = Date.new(Date.today.year, 1, date)
+          get_dates([], pointer, 0)
+        end
+      end
+
+      def get_dates(log, pointer, counter)
+        date = pointer >> counter
+        return log if date > @stop
+        return get_dates(log, pointer, counter + 1) if date < @start
+        log << entry(date)
+        get_dates(log, pointer, counter + 1)
+      end
+    end
+  end
+end

data/lib/ballista/frequencies/weekly.rb

@@ -0,0 +1,23 @@
+module Ballista
+  module Frequencies
+    ##
+    # Weekly actions
+    class Weekly < Base
+      def log
+        pointer = Date.parse(@when)
+        get_dates([], pointer)
+      end
+
+      def get_dates(log, pointer)
+        return log if pointer > @stop
+        return get_dates(log, pointer + step) if pointer < @start
+        log << entry(pointer)
+        get_dates(log, pointer + step)
+      end
+
+      def step
+        7
+      end
+    end
+  end
+end

data/lib/ballista/projection.rb

@@ -9,10 +9,8 @@ module Ballista
       @entries = params[:entries]
     end
 
-    def project(months)
-      start = Date.today + 1
-      finish = start >> months
-      entries = start.upto(finish).map { |date| parse_day(date) }
+    def project(start_dt, end_dt)
+      entries = start_dt.upto(end_dt).map { |date| parse_day(date) }
       Ledger.new(entries: entries.flatten)
     end
 
@@ -29,7 +27,7 @@ module Ballista
     def out_of_bounds?(entry, date)
       if entry[:starts] && Date.parse(entry[:starts]) > date
         true
-      elsif entry[:ends] && Date.parse(entry[:ends]) < date
+      elsif entry[:ends] && Date.parse(entry[:ends]) < date # rubocop:disable Lint/DuplicateBranch
         true
       else
         false
@@ -41,7 +39,7 @@ module Ballista
         calendar[fake_day].map do |entry|
           next if out_of_bounds?(entry, date)
           build_entry(entry, date)
-        end
+        end.compact
       end
     end
 

data/lib/ballista/version.rb

@@ -1,5 +1,5 @@
 ##
 # Set the version (needed for Mercenary -v)
 module Ballista
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.1.0'.freeze
 end

metadata

@@ -1,127 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: ballista
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Les Aker
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-04-25 00:00:00.000000000 Z
+date: 2021-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: libledger
+  name: cymbal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: mercenary
+  name: libledger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.4
+        version: 0.0.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.4
+        version: 0.0.8
 - !ruby/object:Gem::Dependency
-  name: cymbal
+  name: mercenary
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.39.0
+        version: 0.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.39.0
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: goodcop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 11.1.0
+        version: 0.9.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 11.1.0
+        version: 0.9.3
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 13.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 13.0.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.4.0
-- !ruby/object:Gem::Dependency
-  name: fuubar
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.10.0
 description: Projection tool for Ledger format
 email: me@lesaker.org
 executables:
@@ -129,18 +115,24 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circle-ruby"
 - ".gitignore"
 - ".prospectus"
 - ".rspec"
 - ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - ballista.gemspec
 - bin/ballista
-- circle.yml
 - lib/ballista.rb
+- lib/ballista/frequencies.rb
+- lib/ballista/frequencies/base.rb
+- lib/ballista/frequencies/biweekly.rb
+- lib/ballista/frequencies/monthly.rb
+- lib/ballista/frequencies/weekly.rb
 - lib/ballista/projection.rb
 - lib/ballista/version.rb
 - spec/ballista_spec.rb
@@ -149,7 +141,7 @@ homepage: https://github.com/akerl/ballista
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -157,16 +149,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Projection tool for Ledger format
 test_files:

data/circle.yml

@@ -1,12 +0,0 @@
-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'
-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'