twobook 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 821400fab063ba0c19515c146c267e7b2fb934a5
+  data.tar.gz: 76a76e0812bfee424e16523da971fbe0c409438c
+SHA512:
+  metadata.gz: 9666b1a26e7eaaf9e10e5d8d893141c40166ceaaab4ce326caa15ef8ef7b98fd9538e3ba5ead40951dba1f1273eb26a1c951174f1d22147e9da145813abf36a3
+  data.tar.gz: 0874b4b4aed90a687f3e2c94270d63cb46134636a3db54b27d226bcd87296898dc383504f974832ba917960af3a2009f744e9e0b89c893e46403a70686d2cda8

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+**/*.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,59 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/LineLength:
+  Max: 120 # ~the width of a github code panel
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 50
+
+Metrics/BlockLength:
+  Exclude:
+    - "Rakefile"
+    - "**/*.rake"
+    - "spec/**/*.rb"
+
+Metrics/ClassLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    inject: 'reduce'
+    find: 'detect'
+    find_all: 'select'
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 45
+Metrics/CyclomaticComplexity:
+  Max: 9
+Metrics/PerceivedComplexity:
+  Max: 10

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Michael Parry
+
+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,37 @@
+# Twobook
+
+Double-entry accounting with superpowers (alpha!)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'twobook'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install twobook
+
+## Usage
+
+TODO
+
+## 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/michael.parry@novicap.com/twobook.
+
+## 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 "twobook"
+
+# 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(__FILE__)

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/lib/twobook/account.rb

@@ -0,0 +1,167 @@
+module Twobook
+  class Account
+    ACCOUNT_TYPES = %i(assets liabilities revenue expenses records)
+
+    attr_reader :name, :balance, :data, :tags, :entries, :ledger
+
+    def initialize(balance: 0, **data)
+      @balance = Twobook.wrap_number(balance)
+      @entries = []
+
+      @data = data
+      @name = define_name
+
+      valid_data = self.class.name_includes + self.class.has
+      data.keys.each do |key|
+        raise "Invalid data #{key} for #{self.class.category}" unless key.in?(valid_data)
+      end
+    end
+
+    def clone
+      c = super
+      c.instance_variable_set(:@entries, @entries.map(&:clone))
+      c.instance_variable_set(:@data, @data.deep_dup)
+      c
+    end
+
+    def <<(other)
+      raise 'Can only append entries to accounts' unless other.is_a?(Entry)
+
+      @entries << other
+      @entries.sort_by!(&:event)
+      @balance = Twobook.wrap_number(@balance + other.amount)
+      update_mutable_data(other.data)
+      self
+    end
+
+    def +(other)
+      clone << other
+    end
+
+    def balance_before_event(event)
+      @entries.reduce(0) do |running_total, entry|
+        return running_total if entry.event >= event
+        running_total + entry.amount
+      end
+    end
+
+    def data_before_event(event)
+      @entries.reduce(@data.slice(*self.class.name_includes)) do |running_total, entry|
+        return running_total if entry.event >= event
+        running_total.merge(entry.data)
+      end
+    end
+
+    def balance_before(time)
+      @entries.reduce(0) do |running_total, entry|
+        return running_total if entry.event.happened_at >= time
+        running_total + entry.amount
+      end
+    end
+
+    def data_before(time)
+      @entries.reduce(@data.slice(*self.class.name_includes)) do |running_total, entry|
+        return running_total if entry.event.happened_at >= time
+        running_total.merge(entry.data)
+      end
+    end
+
+    def update_mutable_data(data)
+      validate_data_mutable(data)
+      @data = @data.merge(data).sort.to_h
+      self
+    end
+
+    def validate_data_mutable(new_data)
+      new_data.keys.each do |k|
+        raise "Attribute #{k} cannot be modified in #{inspect}" if k.in?(self.class.name_includes)
+        raise "Unknown parameter #{k} given to #{inspect}" unless k.in?(self.class.has)
+      end
+    end
+
+    # Account equality is based only on name, which must be unique
+    def ==(other)
+      @name == other.name
+    end
+    alias eql? ==
+
+    def hash
+      @name.hash
+    end
+
+    def inspect
+      inspected_balance = @balance.to_f
+      "<#{self.class.name} @name=#{@name} @balance=#{inspected_balance} entry_count=#{@entries.count}>"
+    end
+
+    def self.category
+      name.underscore.gsub("#{Twobook.configuration.accounting_namespace.underscore}/accounts/", '')
+    end
+
+    def self.from_name(name)
+      category_part = name.split(':').first
+      match = types.detect do |t|
+        t.name =~ /#{category_part.camelize}$/
+      end
+      raise "Bad account name: #{name}" unless match
+      match
+    end
+
+    def self.types
+      Utilities.types(Twobook::Account)
+    end
+
+    def self.tagged?(tag)
+      if tag.is_a?(Array)
+        tag.empty? || tag.all? { |t| tagged?(t) }
+      else
+        tags.include?(tag)
+      end
+    end
+
+    def self.account_type(*args)
+      return @account_type if args.empty?
+      unless args.first.in?(ACCOUNT_TYPES)
+        raise "Invalid account type #{args.first} for #{name}. Valid types: #{ACCOUNT_TYPES}"
+      end
+      @account_type = args.first
+    end
+
+    def self.name_includes(*args)
+      @name_includes ||= []
+      return @name_includes if args.empty?
+      @name_includes += args
+    end
+
+    def self.tags(*args)
+      @tags ||= []
+      return @tags if args.empty?
+      @tags += args
+    end
+
+    def self.has(*args)
+      @has ||= []
+      return @has if args.empty?
+      @has += args
+    end
+
+    def self.description(*args)
+      @description ||= ''
+      return @description if args.empty?
+      @description = args.first
+    end
+
+    private
+
+    def define_name
+      default = self.class.category
+      custom_parts = self.class.name_includes.sort.map do |key|
+        value = @data.dig(key)
+        raise "Cannot initialize #{self.class.name}: needed #{key}" if value.blank?
+        value
+      end
+
+      ([default] + custom_parts).join(':')
+    end
+  end
+end

data/lib/twobook/account_query.rb

@@ -0,0 +1,208 @@
+module Twobook
+  class AccountQuery
+    def after(event)
+      @after = event
+      self
+    end
+
+    def none?
+      false
+    end
+
+    def execute(array)
+      array
+    end
+
+    def and(other)
+      AndQuery.new(self, other)
+    end
+    alias & and
+
+    def or(other)
+      OrQuery.new(self, other)
+    end
+    alias | or
+
+    def where(constraints)
+      WhereQuery.new(self, constraints)
+    end
+
+    def named(constraints)
+      WhereQuery.new(self, constraints).convert_to_name_query
+    end
+
+    def none
+      NoneQuery.new
+    end
+
+    def self.where(constraints)
+      new.where(constraints)
+    end
+
+    def self.named(constraints)
+      new.named(constraints)
+    end
+
+    def self.none
+      new.none
+    end
+
+    class NoneQuery < AccountQuery
+      def execute(_)
+        []
+      end
+
+      def none?
+        true
+      end
+    end
+
+    class WhereQuery < AccountQuery
+      ATTRIBUTE_CONSTRAINTS = %i(ledger name)
+      CLASS_CONSTRAINTS = %i(category account_type)
+
+      def initialize(child_query, original_constraints)
+        constraints = original_constraints.deep_dup
+
+        # Slice up the constraints into types
+        @attribute_constraints = constraints.extract!(*ATTRIBUTE_CONSTRAINTS)
+        @class_constraints = constraints.extract!(*CLASS_CONSTRAINTS)
+
+        # Support category shorthand and check it exists
+        # e.g. "sme/liabilities/payout" instead of Accounting::Accounts::Sme::Liabilities::Payout.name
+        category = @attribute_constraints[:category]
+        if category.present?
+          unless category_name.in?(Twobook::Account.types.map { |t| t.class.category })
+            raise "Invalid category: #{category}"
+          end
+        end
+
+        @balance_constraint = constraints.delete(:balance)
+        @tags_constraint = constraints.delete(:tags)
+        @data_constraints = constraints
+
+        @child_query = child_query
+      end
+
+      def none?
+        @child_query.none?
+      end
+
+      def execute(array)
+        @child_query.execute(array).select do |account|
+          next unless matches_attributes(account)
+          next unless matches_class(account)
+          next unless matches_data(account)
+          next unless matches_balance(account)
+
+          next if @tags_constraint && !account.class.tagged?(@tags_constraint)
+
+          true
+        end
+      end
+
+      def category
+        @class_constraints[:category]
+      end
+
+      def data
+        @data_constraints
+      end
+
+      def convert_to_name_query
+        if @attribute_constraints[:name].present?
+          NameQuery.new(@attribute_constraints[:name])
+        else
+          account = construct_account
+          NameQuery.new(account.name, account: construct_account)
+        end
+      end
+
+      def construct_account
+        klass = Account.types.detect { |t| t.category == category }
+        raise "Can't find matching class for category #{category}" unless klass.present?
+        klass.new(balance: 0, **data)
+      end
+
+      def inspect
+        "<#{self.class.name} @attribute_constraints=#{@attribute_constraints} " \
+          "@class_constraints=#{@class_constraints} " \
+          "@data_constraints=#{@data_constraints} " \
+          "@tags_constraint=#{@tags_constraint || 'nil'}>"
+      end
+
+      private
+
+      def matches_data(account)
+        account_data = account.data.to_a
+        @data_constraints.none? { |pair| !pair.in?(account_data) }
+      end
+
+      def matches_attributes(account)
+        @attribute_constraints.none? { |k, v| account.public_send(k) != v }
+      end
+
+      def matches_class(account)
+        @class_constraints.none? { |k, v| account.class.public_send(k) != v }
+      end
+
+      def matches_balance(account)
+        return true if @balance_constraint.nil?
+        return account.balance.positive? if @balance_constraint == :positive
+        account.balance == @balance_constraint
+      end
+    end
+
+    class NameQuery < AccountQuery
+      attr_reader :name
+
+      def initialize(name, account: nil)
+        @name = name
+        @account = account
+      end
+
+      def construct_account
+        raise 'Could not construct an account from this name query: no data or category' if @account.nil?
+        @account
+      end
+
+      def execute(accounts)
+        accounts.select { |account| account.name == @name }
+      end
+    end
+
+    class AndQuery < AccountQuery
+      attr_reader :first, :second
+
+      def initialize(first, second)
+        @first = first
+        @second = second
+      end
+
+      def execute(array)
+        @first.execute(array) & @second.execute(array)
+      end
+
+      def none?
+        @first.none? || @second.none?
+      end
+    end
+
+    class OrQuery < AccountQuery
+      attr_reader :first, :second
+
+      def initialize(first, second)
+        @first = first
+        @second = second
+      end
+
+      def none?
+        @first.none? && @second.none?
+      end
+
+      def execute(array)
+        @first.execute(array) | @second.execute(array)
+      end
+    end
+  end
+end

data/lib/twobook/agreement.rb

@@ -0,0 +1,79 @@
+module Twobook
+  class Agreement
+    attr_reader :data
+
+    def initialize(data = {})
+      @data = data
+
+      remaining_keys_to_match = self.class.has.deep_dup
+      @data.each do |k, v|
+        raise "Cannot initialize agreement #{inspect}: unexpected parameter #{k}" if remaining_keys_to_match.delete(k).nil?
+        raise "Cannot initialize agreement #{inspect}: #{k} is nil" if v.nil?
+        define_singleton_method k, -> { @data.dig(k) }
+
+        @data[k] = Twobook.wrap_number(v) if v.is_a?(Numeric)
+      end
+
+      if remaining_keys_to_match.any?
+        raise "Cannot initialize agreement #{inspect}: required #{remaining_keys_to_match}"
+      end
+    end
+
+    def handlers_for(event)
+      handler_names = self.class.handles[event.class.event_name]
+
+      if handler_names.nil? || handler_names.none?
+        raise "Missing handler: #{inspect} cannot handle #{event.class.event_name}"
+      end
+
+      handler_names.map do |handler_name|
+        Handler.from_name(handler_name).new(
+          event: event,
+          **@data,
+        )
+      end
+    end
+
+    def inspect
+      "<#{self.class.name} @data=#{@data}>"
+    end
+
+    def self.agreement_name
+      name.underscore.gsub("#{Twobook.configuration.accounting_namespace.underscore}/agreements/", '')
+    end
+
+    def self.handles(event_name = nil, with: nil)
+      @handles ||= {}
+      return @handles if event_name.nil?
+
+      if @handles[event_name].present?
+        raise "Duplicate handler: more than one handler defined for #{event_name} on #{name}"
+      end
+
+      # Check that all names map to valid classes
+      Event.from_name(event_name)
+      handler_names = with.is_a?(Array) ? with : [with]
+      handler_names.each { |handler_name| Handler.from_name(handler_name) }
+
+      @handles[event_name] = handler_names
+    end
+
+    def self.has(*args)
+      @has ||= []
+      return @has if args.empty?
+      @has += args
+    end
+
+    def self.from_name(name)
+      match = types.detect do |t|
+        t.name =~ /#{name.camelize}$/
+      end
+      raise "Bad agreement name: #{name}" unless match
+      match
+    end
+
+    def self.types
+      Utilities.types(self)
+    end
+  end
+end

data/lib/twobook/configuration.rb

@@ -0,0 +1,18 @@
+module Twobook
+  class Configuration
+    attr_accessor :accounting_namespace
+  end
+
+  def self.configuration
+    @configuration
+  end
+
+  def self.configure
+    @configuration ||= Configuration.new
+    yield(@configuration)
+  end
+
+  configure do |config|
+    config.accounting_namespace = 'Accounting'
+  end
+end