ookkee 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb4a26de7169c37a1386813145c12defcfd04e2df815eeab1cc6dcd9d37d2ddc
+  data.tar.gz: da78b32b53e588c51d45c55262541dc6cc78867876cb5d2a108d962b1731de52
+SHA512:
+  metadata.gz: 5affb76e53ba7076f4a8ae955e4482703e25e0755b55e7a1c7398a2958fdfc27baa164a95dbbbfdbad24e17ec9ca8ee218af4263a475b55762fdf13f7d205686
+  data.tar.gz: 39062201fc1c2b071820f79fba949a679758db9d085a2208b463c9bc7ab3d3db4e099a8cc63aac916ee8dafccf03bea997dc50403beac394ac20e5ae8da0d6e8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Sen
+
+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,28 @@
+# Ookkee
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ookkee'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install ookkee
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Ookkee'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/ookkee.rb

@@ -0,0 +1,15 @@
+require "ookkee/railtie"
+
+require 'ookkee/model/entry'
+require 'ookkee/model/sheet'
+require 'ookkee/model/account'
+require 'ookkee/builder'
+require 'ookkee/builder_proxy'
+require 'ookkee/factory'
+# require 'ookkee/stack'
+require 'ookkee/repos/entry_repo'
+require 'ookkee/usecase'
+
+module Ookkee
+  # Your code goes here...
+end

data/lib/ookkee/asset.rb

@@ -0,0 +1,4 @@
+module Ookkee
+  class Asset
+  end
+end

data/lib/ookkee/builder.rb

@@ -0,0 +1,58 @@
+module Ookkee
+  class Builder
+    attr_accessor :registry
+
+    def initialize
+      @registry = []
+      @attributes = {}
+    end
+
+    def self.build
+      instance = self.new
+      yield instance
+
+      instance.build_activerecord_objects
+    end
+
+    def title(value)
+      @attributes[:title] = value
+    end
+
+    def transaction_number(value)
+      @attributes[:transaction_number] = value
+    end
+
+    def user(value)
+      @attributes[:user] = value
+    end
+
+    def credit(account, &block)
+      builder_proxy = BuilderProxy.new({builder: self})
+      builder_proxy.credit(account, &block)
+    end
+
+    def debit(account, &block)
+      builder_proxy = BuilderProxy.new({builder: self})
+      builder_proxy.debit(account, &block)
+    end
+
+    def build_activerecord_objects
+      sheet = Sheet.new(
+        title: @attributes[:title],
+        transaction_number: @attributes[:transaction_number],
+        user: @attributes[:user]
+      )
+      registry.each do |element|
+        entry_repo.build_from_factory(sheet, element)
+      end
+
+      sheet
+    end
+
+    private
+
+    def entry_repo
+      @entry_repo ||= EntryRepo.new
+    end
+  end
+end

data/lib/ookkee/builder_proxy.rb

@@ -0,0 +1,27 @@
+module Ookkee
+  class BuilderProxy
+    def initialize(options)
+      @builder = options[:builder]
+    end
+
+    def credit(account)
+      factory = Factory.new
+      yield factory
+      factory.entry_type 'credit'
+      factory.account account
+      factory.sheet_name account.sheet_name
+
+      @builder.registry << factory
+    end
+
+    def debit(account)
+      factory = Factory.new
+      yield factory
+      factory.entry_type 'debit'
+      factory.account account
+      factory.sheet_name account.sheet_name
+
+      @builder.registry << factory
+    end
+  end
+end

data/lib/ookkee/equity.rb

@@ -0,0 +1,4 @@
+module Ookkee
+  class Equity
+  end
+end

data/lib/ookkee/expense.rb

@@ -0,0 +1,4 @@
+module Ookkee
+  class Expense < Sheet
+  end
+end

data/lib/ookkee/factory.rb

@@ -0,0 +1,13 @@
+module Ookkee
+  class Factory < BasicObject
+    def initialize
+      @attributes = {}
+    end
+
+    attr_reader :attributes
+
+    def method_missing(name, *args, &block)
+      @attributes[name] = args[0]
+    end
+  end
+end

data/lib/ookkee/liability.rb

@@ -0,0 +1,4 @@
+module Ookkee
+  class Liability < Sheet
+  end
+end

data/lib/ookkee/model/account.rb

@@ -0,0 +1,12 @@
+module Ookkee
+  class Account < ActiveRecord::Base
+    self.table_name = "ookkee_accounts"
+
+    validates :name, presence: true
+    validates :sheet_name, presence: true, \
+      inclusion: {
+        in: Entry::SHEET_NAMES,
+        message: "%{value} is not a valid account name"
+      }
+  end
+end

data/lib/ookkee/model/entry.rb

@@ -0,0 +1,23 @@
+module Ookkee
+  class Entry < ActiveRecord::Base
+    self.table_name = "ookkee_entries"
+
+    ENTRY_TYPES = %w[credit debit]
+    SHEET_NAMES = %w[assets liabilities equity revenue expenses]
+
+    belongs_to :sheet, class_name: 'Ookkee::Sheet', foreign_key: :sheet_id
+    belongs_to :account, class_name: 'Ookkee::Account', foreign_key: :account_id
+    belongs_to :trackable, polymorphic: true
+
+    validates :entry_type, presence: true, \
+      inclusion: {
+        in: ENTRY_TYPES,
+        message: "%{value} is not a valid entry type"
+      }
+    validates :sheet_name, presence: true, \
+      inclusion: {
+        in: SHEET_NAMES,
+        message: "%{value} is not a valid account name"
+      }
+  end
+end

data/lib/ookkee/model/sheet.rb

@@ -0,0 +1,54 @@
+module Ookkee
+  class Sheet < ActiveRecord::Base
+    self.table_name = "ookkee_sheets"
+
+    has_many :entries, class_name: 'Ookkee::Entry', foreign_key: :sheet_id
+    belongs_to :user, polymorphic: true
+
+    validates :title, presence: true
+    validate :credit_and_debit_must_be_exists
+    validate :ledger_equalities
+
+    Entry::ENTRY_TYPES.each do |type|
+      define_method "#{type}_filter" do |*args|
+        args[0].select { |entry| entry.entry_type == type }
+      end
+    end
+
+    Entry::SHEET_NAMES.each do |name|
+      define_method "#{name}_filter" do |*args|
+        args[0].select { |entry| entry.sheet_name == name }
+      end
+    end
+
+    private
+
+    def credit_and_debit_must_be_exists
+      if credit_filter(entries).count == 0 || debit_filter(entries).count == 0
+        errors.add(:base, "credit and debut must be exists")
+      end
+    end
+
+    def ledger_equalities
+      assets      = ledger_left(assets_filter(entries))
+      expenses    = ledger_left(expenses_filter(entries))
+      liabilities = ledger_right(liabilities_filter(entries))
+      equity      = ledger_right(equity_filter(entries))
+      revenue     = ledger_right(revenue_filter(entries))
+
+      if assets + expenses != liabilities + equity + revenue
+        errors.add(:base, "credits amount must equal to debits amount")
+      end
+    end
+
+    def ledger_left(collection)
+      debits  = debit_filter(collection).inject(0) { |sum, entry| sum + entry.amount }
+      credits = credit_filter(collection).inject(0) { |sum, entry| sum + entry.amount }
+      debits - credits
+    end
+
+    def ledger_right(collection)
+      -1 * ledger_left(collection)
+    end
+  end
+end

data/lib/ookkee/railtie.rb

@@ -0,0 +1,4 @@
+module Ookkee
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/ookkee/repos/entry_repo.rb

@@ -0,0 +1,28 @@
+require 'bigdecimal'
+
+module Ookkee
+  class EntryRepo
+    def build_from_factory(sheet, factory)
+      entry              = sheet.entries.build
+      entry.account      = factory.attributes[:account]
+      entry.trackable    = factory.attributes[:trackable]
+      entry.sheet_name   = factory.attributes[:sheet_name]
+      entry.entry_type   = factory.attributes[:entry_type]
+      entry.amount       = BigDecimal(factory.attributes[:amount] || 0)
+
+      entry
+    end
+
+    def account_entries_with_user(account, user)
+      Ookkee::Entry.joins(:account, :sheet)
+        .where(sheet_name: account.sheet_name)
+        .where('ookkee_accounts.name = ?', account.name)
+        .where('ookkee_sheets.user_id = ? and ookkee_sheets.user_type = ?', user.id, user.class.name)
+        .order('ookkee_entries.created_at DESC')
+    end
+
+    def calculate_account_balance(account, user)
+      account_entries_with_user(account, user).where('entry_type = ?', 'debit').sum(:amount) - entries.where('entry_type = ?', 'credit').sum(:amount)
+    end
+  end
+end

data/lib/ookkee/revenue.rb

@@ -0,0 +1,4 @@
+module Ookkee
+  class Revenue < Sheet
+  end
+end

data/lib/ookkee/usecase.rb

@@ -0,0 +1,13 @@
+module Ookkee
+  class Usecase
+    def self.account_balance_with_user(account, user)
+      repo = EntryRepo.new
+      repo.calculate_account_balance_with_user(account, user)
+    end
+
+    def self.account_entries(account, user)
+      repo = EntryRepo.new
+      repo.account_entries_with_user(account, user)
+    end
+  end
+end

data/lib/ookkee/version.rb

@@ -0,0 +1,3 @@
+module Ookkee
+  VERSION = '0.1.0'
+end

data/lib/tasks/ookkee_tasks.rake

@@ -0,0 +1,6 @@
+# desc "Explaining what the task does"
+namespace :ookkee do
+  task :install do
+
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: ookkee
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Double entry bookkeeping.
+email:
+- sen9ob@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/ookkee.rb
+- lib/ookkee/asset.rb
+- lib/ookkee/builder.rb
+- lib/ookkee/builder_proxy.rb
+- lib/ookkee/equity.rb
+- lib/ookkee/expense.rb
+- lib/ookkee/factory.rb
+- lib/ookkee/liability.rb
+- lib/ookkee/model/account.rb
+- lib/ookkee/model/entry.rb
+- lib/ookkee/model/sheet.rb
+- lib/ookkee/railtie.rb
+- lib/ookkee/repos/account_repo.rb
+- lib/ookkee/repos/entry_repo.rb
+- lib/ookkee/repos/sheet_repo.rb
+- lib/ookkee/revenue.rb
+- lib/ookkee/usecase.rb
+- lib/ookkee/validators/account_validator.rb
+- lib/ookkee/validators/sheet_validator.rb
+- lib/ookkee/version.rb
+- lib/tasks/ookkee_tasks.rake
+homepage: https://github.com/Sen/ookkee
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://RubyGems.org
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Bookeeping
+test_files: []