interests 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9be6b2c88262c28c80dcc15a26d0d5cd851db5e
+  data.tar.gz: 4164f4c6678d69dec248c44f0a0e6bd97448a4a7
+SHA512:
+  metadata.gz: d215cb2d3b8f87afff1a384d218cca84f26a5fa719b7fb8de306436b801e807250d212cf086b96abb8af221e567937bc4fd355e2704fc148c8c086f0e19ff41b
+  data.tar.gz: a0d653ffb6f2d77d82b6e54b80231d2f101a2e283852d5c08832ffcc9c56056e8fc1e217122af1a5621ff973b9dddf5237e08ab007c602f3b4fa4dafd0b1389e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Alek Niemczyk
+
+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,56 @@
+## Interests
+
+[![Gem Version](https://badge.fury.io/rb/interests.svg)](http://badge.fury.io/rb/interests)
+[![Build Status](https://travis-ci.org/logicorg/interests.svg?branch=master)](https://travis-ci.org/logicorg/interests)
+[![Code Climate](https://codeclimate.com/github/logicorg/interests/badges/gpa.svg)](https://codeclimate.com/github/logicorg/interests)
+
+Factory shift methods collection by [RubyLogic, PL](http://rubylogic.eu)
+
+## Installation
+
+Add it to your Gemfile with:
+
+```ruby
+gem 'interests'
+```
+
+Run the bundle command to install it.
+
+Run generator if needed with:
+
+```console
+rails generate interests:config
+```
+
+### Basic usage
+
+Interests gem allows to calculate total interests between two dates
+
+```ruby
+Interests::Calculator.total_interests(1000, Date.new(2014, 1, 1), Date.new(2014, 12, 31))
+````
+
+Moreover the gem provides access to the following extensions.
+
+### Date class exts
+
+```ruby
+Date.new(2014, 1, 1).total_interests_till(1000, Date.new(2014, 12, 31))
+# returns total interests from the 1st of January 2014 till 31st of December of 2014
+
+Date.new(2014, 12, 31).total_interests_from(1000, Date.new(2014, 1, 1))
+# returns total interests from the 1st of January 2014 till 31st of December of 2014
+```
+
+### Fixnum and Float class exts
+
+```ruby
+1000.total_interests(Date.new(2014, 1, 1), Date.new(2014, 12, 31))
+# returns total interests from the 1st of January 2014 till 31st of December of 2014
+
+12.99.total_interests(Date.new(2014, 1, 1), Date.new(2014, 12, 31))
+# returns total interests from the 1st of January 2014 till 31st of December of 2014
+```
+
+## License
+Copyright © 2012 - 2015 Ruby Logic, released under the MIT license

data/Rakefile

@@ -0,0 +1,21 @@
+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    = 'Interests'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task(:default).clear
+task :default => :spec
+
+Bundler::GemHelper.install_tasks
+

data/lib/generators/interests/config_generator.rb

@@ -0,0 +1,20 @@
+module Interests
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base # :nodoc:
+
+      def self.gem_root
+        File.expand_path("../../../..", __FILE__)
+      end
+
+      def self.source_root
+        # Use the templates from the 2.3.x generator
+        File.join(gem_root, 'rails_generators', 'templates')
+      end
+
+      def generate
+        template 'interests.rb', File.join('config', 'initializers', 'interests.rb')
+        template 'interests.yml', File.join('config', 'interests.yml')
+      end
+    end
+  end
+end

data/lib/interests/calculator.rb

@@ -0,0 +1,62 @@
+require 'ostruct'
+
+module Interests
+
+  BEGINNING_OF_COMPUTER_ERA = Date.new(1970, 1, 1)
+
+  class Calculator
+    class << self
+      def config_rates(scope = :default)
+        Interests::Config.send(scope).map{ |cfg| OpenStruct.new(date: Date.parse(cfg[:date]), rate: cfg[:rate]) }
+      end
+
+      def rates(till = Date.today)
+        @rates = []
+        return @rates if config_rates.none? || !starts_in_computers_era?
+
+        prev_rate = nil
+        config_rates.sort!{ |x, y| x.date <=> y.date }
+        ([blank_rate] + config_rates + [blank_rate(till + 1.day, config_rates.last.rate)]).each_with_index do |rate, i|
+          if i > 0
+            from_date = prev_rate.date
+            to_date = rate.date - 1.day
+            days = (to_date - from_date).to_i
+            day_rate = prev_rate.rate.to_f / 365
+            @rates << OpenStruct.new(from_date: from_date, to_date: to_date, days: days, rate: prev_rate.rate, day_rate: day_rate)
+          end
+          prev_rate = rate
+        end
+
+        @rates
+      end
+
+      def interests(amount = 0.0, from_date = BEGINNING_OF_COMPUTER_ERA, to_date = Date.today)
+        rates(to_date).select{ |rate| rate.to_date >= from_date && rate.from_date <= to_date }.map do |rate|
+          date_beg = [from_date + 1.day, rate.from_date].max
+          date_end = [to_date, rate.to_date].min
+          OpenStruct.new(
+            date_beg: date_beg,
+            date_end: date_end,
+            days: (date_beg..date_end).count,
+            day_rate: rate.day_rate,
+            interests: amount * (date_beg..date_end).count * rate.day_rate
+          )
+        end
+      end
+
+      def total_interests(amount = 0.0, from_date = BEGINNING_OF_COMPUTER_ERA, to_date = Date.today)
+        interests(amount, from_date, to_date).map(&:interests).inject(0, :+)
+      end
+
+      private
+
+      def starts_in_computers_era?
+        config_rates.map(&:date).min > BEGINNING_OF_COMPUTER_ERA
+      end
+
+      def blank_rate(date = BEGINNING_OF_COMPUTER_ERA, rate = 0.0)
+        OpenStruct.new(date: date, rate: rate)
+      end
+    end
+  end
+end

data/lib/interests/config.rb

@@ -0,0 +1,73 @@
+module Interests
+  class Config
+    DEFAULT_CONFIG = {
+      default: [
+        { date: '1997-01-01', rate: 0.35 },
+        { date: '1998-04-15', rate: 0.33 },
+        { date: '1999-02-01', rate: 0.24 },
+        { date: '1999-05-15', rate: 0.21 },
+        { date: '2000-11-01', rate: 0.30 },
+        { date: '2001-12-15', rate: 0.20 },
+        { date: '2002-07-25', rate: 0.16 },
+        { date: '2003-02-01', rate: 0.13 },
+        { date: '2003-09-25', rate: 0.1225 },
+        { date: '2005-01-10', rate: 0.135 },
+        { date: '2005-10-15', rate: 0.115 },
+        { date: '2008-12-15', rate: 0.13 },
+        { date: '2014-12-23', rate: 0.08 }
+      ]
+    }
+
+    class << self
+      private
+
+      def config
+        Thread.main[:interests_config] ||= default_config
+      end
+
+      def config=(config)
+        Thread.main[:interests_config] = config
+      end
+
+      def threadsafe_cattr_accessor(name)
+        define_singleton_method name do
+          config[name]
+        end
+        define_singleton_method "#{name}=" do |value|
+          config[name] = value
+        end
+      end
+    end
+
+    threadsafe_cattr_accessor :default
+
+    class << self
+      def load(file)
+        reset
+        data = YAML::load(file.respond_to?(:read) ? file : File.open(file))
+        config = (data['interests'] || {})
+
+        config_vars = %w(default)
+        config_vars.each do |var|
+          send("#{var}=", config[var]) if config[var] && respond_to?("#{var}=")
+        end
+      end
+
+      def default_config
+        deep_dup(DEFAULT_CONFIG)
+      end
+
+      private
+
+      def reset
+        self.config = default_config
+      end
+
+      def deep_dup(object)
+        Marshal.load(Marshal.dump(object))
+      end
+    end
+
+    reset
+  end
+end

data/lib/interests/core_ext/date.rb

@@ -0,0 +1,10 @@
+class Date
+
+  def total_interests_till(amount, to_date)
+    Interests::Calculator.total_interests(amount, self, to_date)
+  end
+
+  def total_interests_from(amount, from_date)
+    Interests::Calculator.total_interests(amount, from_date, self)
+  end
+end

data/lib/interests/core_ext/fixnum.rb

@@ -0,0 +1,6 @@
+class Fixnum
+
+  def total_interests(from_date, to_date)
+    Interests::Calculator.total_interests(self, from_date, to_date)
+  end
+end

data/lib/interests/core_ext/float.rb

@@ -0,0 +1,6 @@
+class Float
+
+  def total_interests(from_date, to_date)
+    Interests::Calculator.total_interests(self, from_date, to_date)
+  end
+end

data/lib/interests/version.rb

@@ -0,0 +1,3 @@
+module Interests
+  VERSION = "0.1.0"
+end

data/lib/interests.rb

@@ -0,0 +1,10 @@
+require 'thread'
+require 'active_support'
+require 'active_support/time'
+require 'yaml'
+
+require 'interests/config'
+require 'interests/calculator'
+require 'interests/core_ext/date'
+require 'interests/core_ext/float'
+require 'interests/core_ext/fixnum'

data/lib/tasks/interests_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :interests do
+#   # Task goes here
+# end

data/rails_generators/interests_config_generator.rb

@@ -0,0 +1,9 @@
+class InterestsConfigGenerator < Rails::Generator::Base
+
+  def manifest
+    record do |m|
+      m.template('interests.rb', "config/initializers/interests.rb")
+      m.template('interests.yml', "config/interests.yml")
+    end
+  end
+end

data/rails_generators/templates/interests.rb

@@ -0,0 +1 @@
+Interests::Config.load("#{Rails.root}/config/interests.yml")

data/rails_generators/templates/interests.yml

@@ -0,0 +1,41 @@
+interests:
+  base:
+    -
+      date: '1997-01-01'
+      rate: 0.35
+    -
+      date: '1998-04-15'
+      rate: 0.33
+    -
+      date: '1999-02-01'
+      rate: 0.24
+    -
+      date: '1999-05-15'
+      rate: 0.21
+    -
+      date: '2000-11-01'
+      rate: 0.30
+    -
+      date: '2001-12-15'
+      rate: 0.20
+    -
+      date: '2002-07-25'
+      rate: 0.16
+    -
+      date: '2003-02-01'
+      rate: 0.13
+    -
+      date: '2003-09-25'
+      rate: 0.1225
+    -
+      date: '2005-01-10'
+      rate: 0.135
+    -
+      date: '2005-10-15'
+      rate: 0.115
+    -
+      date: '2008-12-15'
+      rate: 0.13
+    -
+      date: '2014-12-23'
+      rate: 0.08

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: interests
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alek Niemczyk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: Interests calculator
+email:
+- alek@rubylogic.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/interests/config_generator.rb
+- lib/interests.rb
+- lib/interests/calculator.rb
+- lib/interests/core_ext/fixnum.rb
+- lib/interests/core_ext/date.rb
+- lib/interests/core_ext/float.rb
+- lib/interests/config.rb
+- lib/interests/version.rb
+- lib/tasks/interests_tasks.rake
+- rails_generators/templates/interests.rb
+- rails_generators/templates/interests.yml
+- rails_generators/interests_config_generator.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/logicorg/interests
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Interests calculator
+test_files: []