eleVAT 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01b6b289ace0072baff51ec1c0752b1860359e72
+  data.tar.gz: 9505ddeeda0424b65a19353243e88b4af2ec4257
+SHA512:
+  metadata.gz: 159cc376f7223e7b3c707c33966cd1c34a83aa6dd7f91aaa3edce997911fd64f1230c5289fd634301da5ea69bd834fcb52ef8ce18b68f18e3d3df2d1144d0fd2
+  data.tar.gz: 2cdec9bb307d8d9f40d609115700018462e44976c108e6de39e0ac214c32b69d6ccfc6ee0bdc05adea791fc4d7f6f3ad170d49b8b26edbb5358185b786a3bd46

data/.byebug_history

@@ -0,0 +1,18 @@
+c
+product.key?(:name)c
+product.key?(:name)
+product.key?(:name, :quantity)
+product.key?([:name, :quantity])
+product
+product.
+c
+product.keys & [:quantity, :name, :net_price, :taxable, :imported, :gross_price, :tax].size == product.keys.size
+c
+product.keys && [:quantity, :name, :net_price, :taxable, :imported, :gross_price, :tax].size == product.keys.size
+product.keys && [:quantity, :name, :net_price, :taxable, :imported, :gross_price, :tax].size == 7
+product.keys && [:quantity, :name, :net_price, :taxable, :imported, :gross_price, :tax]
+product.keys == [:quantity, :name, :net_price, :taxable, :imported, :gross_price, :tax]
+product.class == Hash && product.keys == [:quantity, :name, :net_price, :taxable, :imported, :gross_price, :tax]
+n
+product.keys
+product

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/.byebug_hystory
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Simone
+
+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,79 @@
+# EleVAT
+
+This gem is a simple receipts creator. It allow you to calculate the amount of taxes and the amount of the total price for a list of products.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eleVAT'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eleVAT
+
+## Usage
+
+Configure the tax rates, the rounding precision and the list of tax free items
+
+```ruby
+require 'eleVAT'
+
+EleVAT.configure do |config|
+  # Rate for all the items except for the items included in the tax free item
+  # list
+  config.basic_tax_rate = 10
+  # Rate for the imported items
+  config.import_tax_rate = 5
+  # list of tax free items
+  config.tax_free_items = %w(chocolate chocolates pills book)
+  # Tax amount will be rounded up to the nearest rounding precision value
+  config.rounding_precision = 0.05
+end
+```
+
+Use the `EleVAT::Importer` to import products and the `EleVAT::Recipt` to calculate the amounts.
+```ruby
+# For each product the string pattern have to be '$quantity $name at $net_price'
+importer = Importer.new(
+  '1 imported box of chocolates at 10.00 1 imported bottle of perfume at 47.50'
+)
+data_for_receipt = importer.export_data_for_receipt
+receipt = Receipt.new data_for_receipt
+```
+You can calculate the the amounts using the following `receipt.calculate_total` and `receipt.calculate_taxes` and access the value through `receipt.total_amount`
+and `receipt.taxes`. You can also access the products list `receipt.products`.
+
+If you don't need to use the importer you can create manually the products and add them to the receipt after prepareing them.
+
+```ruby
+product = Product.new(1, 'Chocolate', 2.0, taxable = true, imported = false)
+receipt.add(product.prepare_for_receipt)
+# or
+product_2 = Product.new(1, 'Beer', 5.0).prepare_for_receipt
+product_3 = Product.new(1, 'Lemon', 2.0).prepare_for_receipt
+receipt.add([product_2, product_3])
+```
+
+Use `receipt.to_s` to view the printable receipt.
+
+## TO DO
+
+1. Implement the importer function to precess xls file
+2. Implement the function receipt `to_xls`
+3. Implement the importer function to precess csv file
+4. Implement the function receipt `to_csv`
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/eleVAT/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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "eleVAT"
+
+# 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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/eleVAT.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eleVAT/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "eleVAT"
+  spec.version       = EleVAT::VERSION
+  spec.authors       = ["Simone Romanelli"]
+  spec.email         = ["simone.romanelli.dev@gmail.com"]
+  spec.homepage      = 'https://github.com/simoneromanelli/eleVAT'
+
+  spec.summary          = "eleVAT"
+  spec.description      = "A simple receipts calculator."
+  spec.license          = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "byebug"
+end

data/lib/eleVAT.rb

@@ -0,0 +1,35 @@
+require 'eleVAT/configuration'
+require 'eleVAT/product'
+require 'eleVAT/receipt'
+require 'eleVAT/importer'
+
+module EleVAT
+  def self.configure
+    @config ||= Configuration.new
+    yield(@config) if block_given?
+    @config
+  end
+
+  def self.config
+    @config || configure
+  end
+
+  module CalculatorHelper
+    def self.round(price)
+      precision = 1 / EleVAT.config.rounding_precision
+      (price * precision).ceil / precision
+    end
+
+    def self.percentage(net_price, rate)
+      net_price * rate / 100
+    end
+
+    def self.num_to_currency(n)
+      if n.to_s.split('.').last.size == 1
+        return "#{n}0"
+      else
+        return "#{n}"
+      end
+    end
+  end
+end

data/lib/eleVAT/configuration.rb

@@ -0,0 +1,14 @@
+module EleVAT
+  class Configuration
+    attr_accessor :basic_tax_rate, :import_tax_rate, :rounding_precision,
+                  :tax_free_items, :import_label
+
+    def initialize
+      @basic_tax_rate = 10
+      @import_tax_rate = 5
+      @rounding_precision = 0.05
+      @tax_free_items = %w(chocolate chocolates pills book)
+      @import_label = 'imported'
+    end
+  end
+end

data/lib/eleVAT/importer.rb

@@ -0,0 +1,64 @@
+module EleVAT
+  class Importer
+    attr_accessor :imported_data
+
+    def initialize(input_data)
+      begin
+        if input_data.class == String
+          @imported_data = initialize_string(input_data)
+        elsif input_data.content_type == 'text/csv'
+          @imported_data = initialize_csv(input_data)
+        elsif input_data.content_type == 'application/vnd.ms-excel'
+          @imported_data = initialize_xls(input_data)
+        end
+      rescue
+        raise NotImplementedError, 'Your data import is not precessable yet'
+      end
+    end
+
+    def export_data_for_receipt
+      @imported_data.map { |p| p.prepare_for_receipt }
+    end
+
+    private
+
+    def initialize_string(input_data)
+      products = []
+      tmp_array = input_data.strip.split(/ (?=\d+)/)
+      tmp_array.each_with_index do |product_string, index|
+        next unless index.even?
+        product_array = product_string.split(' ')
+        quantity = product_array.shift.to_i
+        imported = product_string.downcase.include? EleVAT.config.import_label
+        taxable = taxable?(product_array)
+        name = build_name(product_array)
+        net_price = tmp_array[index + 1].to_f
+        products << Product.new(
+          quantity, name, net_price, taxable, imported
+        )
+      end
+      products
+    end
+
+    def build_name(array_name)
+      if (imported = array_name.delete(EleVAT.config.import_label))
+        array_name.unshift(imported)
+      end
+      array_name[0...-1].join(' ')
+    end
+
+    def taxable?(product)
+      (product & EleVAT.config.tax_free_items).empty?
+    end
+
+    def initialize_csv
+      # TO _DO
+      fail NotImplementedError, 'Your data import is not precessable yet'
+    end
+
+    def initialize_xls
+      # TO _DO
+      fail NotImplementedError, 'Your data import is not precessable yet'
+    end
+  end
+end

data/lib/eleVAT/product.rb

@@ -0,0 +1,71 @@
+module EleVAT
+  class Product
+    attr_accessor :quantity, :name, :net_price, :gross_price,
+                  :tax, :imported, :taxable
+
+    def initialize(quantity, name, net_price, taxable = true, imported = false)
+      @quantity = quantity
+      @name = name
+      @net_price = net_price
+      @taxable = taxable
+      @imported = imported
+      @gross_price = nil
+      @tax = nil
+      validate_product
+    end
+
+    def prepare_for_receipt
+      calculate_tax
+      {
+        name: @name,
+        quantity: @quantity,
+        net_price: @net_price,
+        gross_price: @gross_price,
+        tax: @tax,
+        imported: @imported,
+        taxable: @taxable
+      }
+    end
+
+    private
+
+    def calculate_tax
+      tax = 0.0
+      @imported && tax += CalculatorHelper.percentage(
+        @net_price, EleVAT.config.import_tax_rate
+      )
+      @taxable && tax += CalculatorHelper.percentage(
+        @net_price, EleVAT.config.basic_tax_rate
+      )
+      @tax = CalculatorHelper.round(tax) * @quantity
+      gross_price = @tax + @net_price * @quantity
+      @gross_price = gross_price.round 2
+    end
+
+    def validate_product
+      validate_net_price
+      validate_name
+      validate_quantity
+    end
+
+    def validate_net_price
+      net_price_is_a_float = @net_price.class == Float
+      net_price_gt_zero = @net_price > 0.0
+
+      fail ArgumentError, 'Net price must be a float > 0.0' unless
+        net_price_is_a_float && net_price_gt_zero
+    end
+
+    def validate_name
+      name_is_blank = name.nil? || name == ''
+      fail ArgumentError, 'Invalid name' if name_is_blank
+    end
+
+    def validate_quantity
+      quantity_is_gt_zero = quantity > 0
+      quantity_is_int = quantity.class == Fixnum
+      fail ArgumentError, 'Invalid quantity' unless
+        quantity_is_int && quantity_is_gt_zero
+    end
+  end
+end

data/lib/eleVAT/receipt.rb

@@ -0,0 +1,69 @@
+module EleVAT
+  class Receipt
+    attr_accessor :products, :total_amount, :taxes
+
+    def initialize(products = [])
+      @products = products
+      @total_amount = 0.0
+      @taxes = 0.0
+    end
+
+    def add(product)
+      if Receipt.valid_product(product)
+        @products << product
+      elsif product.class == Array && product.all? do |p|
+        p.is_a?(Hash) && Receipt.valid_product(p)
+      end
+        @products = product
+      else
+        fail ArgumentError, 'Parameter must be EleVAT::Product '\
+                            'or an array of Products'
+      end
+    end
+
+    def calculate_total
+      @total_amount =
+        @products.map { |product| product[:gross_price] }.inject(:+).round 2
+    end
+
+    def calculate_taxes
+      @taxes = @products.map { |product| product[:tax] }.inject(:+).round 2
+    end
+
+    def to_s
+      @total_amount == 0.0 && calculate_total
+      @taxes == 0.0 && calculate_taxes
+
+      output = @products.map do |product|
+        "#{product[:quantity]} #{product[:name]}: "\
+        "#{CalculatorHelper.num_to_currency(product[:gross_price])} "
+      end
+      output << ("Sales Taxes: #{CalculatorHelper.num_to_currency(@taxes)} "\
+        "Total: #{CalculatorHelper.num_to_currency(@total_amount)}")
+      output.join
+    end
+
+    def size
+      @products.size
+    end
+
+    def to_xls
+      # TO _DO
+      fail NotImplementedError
+    end
+
+    def to_csv
+      # TO _DO
+      fail NotImplementedError
+    end
+
+    private
+
+    def self.valid_product(product)
+      product.class == Hash && [
+        :quantity, :name, :net_price,
+        :taxable, :imported, :gross_price, :tax
+      ].all? { |s| product.key? s }
+    end
+  end
+end

data/lib/eleVAT/version.rb

@@ -0,0 +1,3 @@
+module EleVAT
+  VERSION = "1.0.1"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: eleVAT
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Simone Romanelli
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: byebug
+  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: A simple receipts calculator.
+email:
+- simone.romanelli.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- eleVAT.gemspec
+- lib/eleVAT.rb
+- lib/eleVAT/configuration.rb
+- lib/eleVAT/importer.rb
+- lib/eleVAT/product.rb
+- lib/eleVAT/receipt.rb
+- lib/eleVAT/version.rb
+homepage: https://github.com/simoneromanelli/eleVAT
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: eleVAT
+test_files: []