lannister 0.0.1.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 26b4d2eea11ee88c67e74ddde6f5bb72ae26774e
+  data.tar.gz: cde821cd33e2f5b39cee02b226653cb04fe2e6f1
+SHA512:
+  metadata.gz: 27338b9a784888d46e516c8fe939d7cb302148ad9b84e6e8d67c00651285a92fa248fe023b21cf7220ac7e3a97a3b084889db2d4640ca5fea56761f293d75e58
+  data.tar.gz: 27a66f736be3273a4fe24b8958ff97f495e0bf52a5cca5ad57d7a69ecdcb84aef74e31a57a04f3543b96b45da249d54612f81ac179f3ba842844cc8fbd9c3bbf

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+#gem 'rails', '~> 4.2.0'
+#gem 'railties'
+#gem 'accounting', path: '../../engines/accounting'
+
+#group :test do
+  #gem 'sqlite3'
+#end
+
+# Specify your gem's dependencies in lannister.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Fabiano Beselga
+
+MIT License
+
+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,48 @@
+# Lannister
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lannister'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lannister
+
+## Usage
+
+Transfer money:
+
+```ruby
+Lannister.transfer_money(source_account_id: 42,
+                        destination_account_id: 22,
+                        amount: 100_000)
+```
+
+Get balance:
+
+```ruby
+Lannister.get_balance(account_id: 42)
+```
+
+## TODO
+
+* print money use case (a.k.a credit)
+* explain about the repository
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/lannister/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lannister.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lannister/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lannister"
+  spec.version       = Lannister::VERSION
+  spec.authors       = ["Fabiano Beselga"]
+  spec.email         = ["fabianobeselga@gmail.com"]
+  spec.summary       = %q{ PoC of an accounting system using Clean Architecture}
+  spec.description   = spec.summary
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "caze"
+end

data/lib/lannister.rb

@@ -0,0 +1,35 @@
+require 'lannister/version'
+
+require 'lannister/entities/transaction'
+require 'lannister/repositories/transaction_repo'
+
+#require 'lannister/use_cases'
+require 'lannister/use_cases/get_balance'
+require 'lannister/use_cases/transfer_money'
+
+# WITH the engine dependency
+#require 'rails/railties'
+#require 'active_record'
+#require 'accounting'
+#require 'accounting/engine'
+#require "#{Accounting::Engine.root}/app/models/accounting/transaction"
+#require "#{Accounting::Engine.root}/app/repositories/accounting/transaction_repo"
+
+require 'caze'
+
+module Lannister
+  include Caze
+  define_use_cases transfer_money: UseCases::TransferMoney,
+                   get_balance:    UseCases::GetBalance
+
+  extend Forwardable
+
+  class << self
+    attr_writer :transaction_repo
+
+    def transaction_repo
+      @transaction_repo ||= Repositories::TransactionRepo.new
+      #@transaction_repo ||= Accounting::TransactionRepo
+    end
+  end
+end

data/lib/lannister/entities/transaction.rb

@@ -0,0 +1,11 @@
+module Lannister
+  module Entities
+    class Transaction
+      attr_accessor :id, :account_id, :amount
+
+      def initialize(attributes = {})
+        @id, @account_id, @amount = attributes.values_at(:id, :account_id, :amount)
+      end
+    end
+  end
+end

data/lib/lannister/repositories/transaction_repo.rb

@@ -0,0 +1,34 @@
+module Lannister
+  module Repositories
+    class TransactionRepo
+      def initialize
+        @rows = {}
+        @id = 0
+      end
+
+      def persist(entity)
+        @id += 1
+        entity.id = @id
+        rows[@id] = entity
+        entity
+      end
+
+      def count
+        rows.length
+      end
+
+      def balance(account_id:)
+        rows.select{ |_, row| row.account_id == account_id }.map{ |_, row| row.amount }.reduce(:+) || 0
+      end
+
+      def delete_all
+        @rows = {}
+        @id = 0
+      end
+
+      private
+
+      attr_reader :rows
+    end
+  end
+end

data/lib/lannister/use_cases.rb

@@ -0,0 +1,7 @@
+require 'lannister/use_cases/get_balance'
+require 'lannister/use_cases/transfer_money'
+
+module Lannister
+  module UseCases
+  end
+end

data/lib/lannister/use_cases/get_balance.rb

@@ -0,0 +1,9 @@
+module Lannister
+  module UseCases
+    class GetBalance
+      def self.get_balance(account_id:)
+        Lannister.transaction_repo.balance(account_id: account_id)
+      end
+    end
+  end
+end

data/lib/lannister/use_cases/transfer_money.rb

@@ -0,0 +1,42 @@
+require 'caze'
+require 'forwardable'
+
+module Lannister
+  module UseCases
+    class TransferMoney
+      include Caze
+      define_entry_point :transfer, as: :execute #, use_transaction: true
+      define_entry_point :transfer, as: :transfer_money #, use_transaction: true
+
+      extend Forwardable
+      def_delegators :Lannister, :get_balance, :transaction_repo
+
+      def initialize(source_account_id:, destination_account_id:, amount:)
+        @source_account_id = source_account_id
+        @destination_account_id = destination_account_id
+        @amount = amount
+      end
+
+      def transfer
+        if get_balance(account_id: source_account_id) >= amount
+          transaction_repo.persist(debit_transaction)
+          transaction_repo.persist(credit_transaction)
+        else
+          false
+        end
+      end
+
+      private
+
+      def debit_transaction
+        Entities::Transaction.new(account_id: source_account_id, amount: - amount)
+      end
+
+      def credit_transaction
+        Entities::Transaction.new(account_id: destination_account_id, amount: amount)
+      end
+
+      attr_reader :source_account_id, :destination_account_id, :amount
+    end
+  end
+end

data/lib/lannister/version.rb

@@ -0,0 +1,3 @@
+module Lannister
+  VERSION = "0.0.1.alpha"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+require 'lannister'
+require 'pry'
+
+# WITH the engine dependency
+#ActiveRecord::Base.establish_connection(database: ":memory:", adapter: "sqlite3")
+#migrations_path = Accounting::Engine.paths['db/migrate'].existent
+#ActiveRecord::Migrator.migrate(migrations_path)
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.before do
+    Lannister.transaction_repo.delete_all
+  end
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/use_cases/get_balance_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+module Lannister
+  module UseCases
+    describe GetBalance do
+      describe '.get_balance' do
+        subject(:get_balance) { described_class.get_balance(account_id: account_id) }
+
+        let(:account_id) { 1 }
+        let(:amount) { 10_000 }
+        let(:transaction) { Entities::Transaction.new(account_id: account_id, amount: amount) }
+
+        context 'when there is only one credit transaction' do
+          before { Lannister.transaction_repo.persist(transaction) }
+
+          it { expect(get_balance).to eq(amount) }
+        end
+
+        context 'when there are two credit transactions' do
+          let(:another_amount) { 2_200 }
+          let(:another_transaction) { Entities::Transaction.new(account_id: account_id, amount: another_amount) }
+          before { [transaction, another_transaction].each { |t| Lannister.transaction_repo.persist(t) } }
+
+          it { expect(get_balance).to eq(amount + another_amount) }
+        end
+
+        context 'when there is a credit and a debit' do
+          let(:debit_amount) { -500 }
+          let(:debit_transaction) { Entities::Transaction.new(account_id: account_id, amount: debit_amount) }
+          before { [transaction, debit_transaction].each { |t| Lannister.transaction_repo.persist(t) } }
+
+          it { expect(get_balance).to eq(amount + debit_amount) }
+        end
+
+        context 'transactions from another accounts' do
+          let(:debit_amount) { -500 }
+          let(:debit_transaction) { Entities::Transaction.new(account_id: 33, amount: debit_amount) }
+          before { [transaction, debit_transaction].each { |t| Lannister.transaction_repo.persist(t) } }
+
+          it 'ignores them' do
+            expect(get_balance).to eq(amount)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/use_cases/transfer_money_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+module Lannister
+  module UseCases
+    describe TransferMoney do
+      describe '.transfer' do
+        subject(:transfer) { described_class.transfer_money(source_account_id: source_account_id,
+                                                            destination_account_id: destination_account_id,
+                                                            amount: amount ) }
+        let(:source_account_id) { 1 }
+        let(:destination_account_id) { 2 }
+        let(:amount) { 1_000 }
+
+        def get_balance(account_id)
+          Lannister.get_balance(account_id: account_id)
+        end
+
+        context 'when there is enough money on the source account' do
+          let(:previous_transaction) { Entities::Transaction.new(account_id: source_account_id,
+                                                               amount: amount) }
+
+          before { Lannister.transaction_repo.persist(previous_transaction) }
+
+          it 'debits the specified amount from source account' do
+            expect{ transfer }.to change{ get_balance(source_account_id) }.by(- amount)
+          end
+
+          it 'credits the specific amount to destination account' do
+            expect{ transfer }.to change{ get_balance(destination_account_id) }.by(amount)
+          end
+        end
+
+        context 'there is not  enough money on source account' do
+          it 'cancels the transfer by responding false' do
+            expect(transfer).to eq(false)
+          end
+
+          it 'does not change the accounts balance' do
+            expect{ transfer }.to_not change{ get_balance(source_account_id) }
+            expect{ transfer }.to_not change{ get_balance(destination_account_id) }
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: lannister
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+platform: ruby
+authors:
+- Fabiano Beselga
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: caze
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: PoC of an accounting system using Clean Architecture
+email:
+- fabianobeselga@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lannister.gemspec
+- lib/lannister.rb
+- lib/lannister/entities/transaction.rb
+- lib/lannister/repositories/transaction_repo.rb
+- lib/lannister/use_cases.rb
+- lib/lannister/use_cases/get_balance.rb
+- lib/lannister/use_cases/transfer_money.rb
+- lib/lannister/version.rb
+- spec/spec_helper.rb
+- spec/use_cases/get_balance_spec.rb
+- spec/use_cases/transfer_money_spec.rb
+homepage: ''
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: PoC of an accounting system using Clean Architecture
+test_files:
+- spec/spec_helper.rb
+- spec/use_cases/get_balance_spec.rb
+- spec/use_cases/transfer_money_spec.rb