fund 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8d64c0d8f9edda4df34a6e3b1b715c0ea3599f0
+  data.tar.gz: a4a6016fa529d0a8acfca826449e0d2ecc466a41
+SHA512:
+  metadata.gz: 73ef9fc21371041b50802f502cf8e2f32026595ef9ebab902cba815a034d4c088312e21aab1927e0335cf292f6ee0426b8a49e103c7ee2e3a157a9b42de3a130
+  data.tar.gz: 15e847cafbc24bca153c22648f3069ad1386ab5e019c5266cb57d66e9895a2a7e3cc232df73c9921e1144e264b1758b02a5d31e7e5c49c3dea3106c61bf260c7

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nazarhussain@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/README.md

@@ -0,0 +1,44 @@
+# Fund
+
+[![Build Status](https://travis-ci.org/nazarhussain/fund.svg?branch=master)](https://travis-ci.org/nazarhussain/fund)
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fund`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fund'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fund
+
+## Usage
+
+Create the objects like 
+```ruby
+ Fund.new(100)
+ Fund.new(100, :usd)
+ Fund.new(25.45, :eur)
+```
+For more details see the test [specs](/spec)
+
+## 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/nazarhussain/fund. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

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 "fund"
+
+# 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/exe/fund

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "fund"

data/fund.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fund/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fund"
+  spec.version       = Fund::VERSION
+  spec.authors       = ["Nazar Hussain"]
+  spec.email         = ["nazarhussain@gmail.com"]
+
+  spec.summary       = %q{A gem utilizing ruby power to handle money and currency conversion issues.}
+  spec.description   = %q{If you ever need to build a ruby based app where you need currency conversion. This gem will help you in every aspect.}
+  spec.homepage      = "https://github.com/nazarhussain"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/fund/arithmetic.rb

@@ -0,0 +1,26 @@
+class Fund
+  module Arithmetic
+
+    def +(other)
+      Fund.new(@value + other.convert_to(@currency).value, @currency)
+    end
+
+    def -(other)
+      Fund.new(@value - other.convert_to(@currency).value, @currency)
+    end
+
+    def *(other)
+      raise ArgumentError.new('Fund can\'t be multiplied by funds. It must be Intger or Float.') if other.class == Fund
+
+      @value *= other
+      self
+    end
+
+    def /(other)
+      raise ArgumentError.new('Fund can\'t be multiplied by funds. It must be Intger or Float.') if other.class == Fund
+
+      @value /= other
+      self
+    end
+  end
+end

data/lib/fund/comparision.rb

@@ -0,0 +1,13 @@
+class Fund
+  module Comparision
+
+    # Comparision of of two funds
+    #
+    # @param other [Fund] Compare two funds
+    def <=>(other)
+      raise ArgumentError.new('You can only compare two funds.') if other.class != Fund
+
+      @value <=> other.convert_to(@currency).value
+    end
+  end
+end

data/lib/fund/configuration.rb

@@ -0,0 +1,54 @@
+class Fund
+  # * Module to setup the configuration
+  module Configuration
+    attr_accessor :default_currency, :supported_currencies, :currency_symbols
+    attr_accessor :currency_rates, :round_limit
+
+    class << self
+      # List of configurable keys for {Fund::Client}
+      # @return [Array] of option keys
+      def keys
+        # Reject all setters to get keys of only attributes
+        # Also reject other utility methods for the class
+        @keys ||= Fund::Configuration.public_instance_methods.reject { |method| method =~ /^.*=$/ } -
+                  [:setup, :load_default, :config, :add]
+      end
+    end
+
+    # Set configuration options using a block
+    #
+    # Fund.setup do |config|
+    #   config.supported_currencies = [:usd, :eur]
+    # end
+    # Fund.setup do |config|
+    #   config.add :bit, 'Bit', 113.40
+    # end
+    def setup
+      yield self
+    end
+
+    # Utility method to add a new language in configuration
+    #
+    # @param currency [Symbol] A symbol representing the currency e.g. :usd, :eur
+    # @param symbol [String] A string representation of the currency e.g. $
+    # @param rate [Float] A floating number showing the currency rate with respect to default currency. See [Configuration::Default] for more reference
+    #
+    def add(currency, symbol, rate)
+      @supported_currencies << currency
+      @currency_symbols[currency] = symbol
+      @currency_rates[currency] = rate
+    end
+
+    def load_default
+      Configuration.keys.each do |key|
+        instance_variable_set(:"@#{key}", Fund::Default.options[key])
+      end
+      self
+    end
+
+    def config
+      self
+    end
+  end
+end
+

data/lib/fund/conversion.rb

@@ -0,0 +1,38 @@
+class Fund
+  module Conversion
+
+    # Convert one fund to other currency
+    #
+    # @param other_currency [Symbol, String] Symbol or string representing other currency
+    #
+    # @return [Fund]
+    #
+    def convert_to(other_currency)
+      other_currency = other_currency.to_sym
+
+      Fund.new(@value * conversion_rate_for(other_currency), other_currency)
+    end
+
+    # Get conversion rate for a currency that used to be multiplied in conversion
+    #
+    # @param other_currency [Symbol] symbol representing other currency
+    #
+    # @return [Float]
+    #
+    def conversion_rate_for(other_currency)
+      # If both currencies are same then conversion rate is 1
+      if @currency == other_currency
+        1
+
+      # If rate required for base currency then divide currency rates with 1
+      elsif other_currency == Fund.config.default_currency
+        1.0 / Fund.config.currency_rates[@currency].to_f
+
+      # If rate required for currency other than base then first convert base currency rate
+      # and then multiply with target currency rate
+      else
+        Fund.config.currency_rates[other_currency] * (1.0 / Fund.config.currency_rates[@currency].to_f)
+      end
+    end
+  end
+end

data/lib/fund/default.rb

@@ -0,0 +1,41 @@
+class Fund
+  # * Module to load the default configuration values
+  module Default
+    class << self
+
+      # Configuration options
+      # @return [Hash]
+      def options
+        Hash[Fund::Configuration.keys.map{ |key| [key, send(key)] }]
+      end
+
+      def default_currency
+        :usd
+      end
+
+      # For adding more currencies please check the list at
+      # https://en.wikipedia.org/wiki/Currency_symbol
+      def supported_currencies
+        [:usd, :eur, :pkr]
+      end
+
+      def currency_symbols
+        { usd: '$',
+          eur: '€',
+          pkr: 'Rs'
+        }
+      end
+
+      def currency_rates
+        { usd: 1,
+          eur: 0.91,
+          pkr: 110
+        }
+      end
+
+      def round_limit
+        2
+      end
+    end
+  end
+end

data/lib/fund/version.rb

@@ -0,0 +1,3 @@
+class Fund
+  VERSION = "0.1.0"
+end

data/lib/fund.rb

@@ -0,0 +1,54 @@
+require 'fund/version'
+require 'fund/configuration'
+require 'fund/default'
+require 'fund/conversion'
+require 'fund/arithmetic'
+require 'fund/comparision'
+
+
+# * Main Fund Module
+class Fund
+  extend Configuration
+  include Fund::Conversion
+  include Fund::Arithmetic
+  include Comparable
+  include Fund::Comparision
+
+  attr_reader :value, :currency
+
+  # Default initializer for the fund object
+  #
+  # @param value [BigDecimal] A value representing the fund
+  # @param currency [Symbol, String] A value representing the fund currency
+  #
+  # @return [Fund]
+  #
+  # @example
+  # Fund.new(200)
+  # Fund.new(140.50, 'eur')
+  # Fund.new(1785.4, :pkr)
+  #
+  # @raise
+  # [ArgumentError] if provided currency is not valid
+  #
+  def initialize(value, currency = Fund.config.default_currency)
+    @value = prettify(value)
+    @currency = currency.to_sym
+
+    unless Fund.config.supported_currencies.include? @currency
+      raise ArgumentError.new("Provided currency #{@currency} is not enabled in Fund.config.supported_currencies")
+    end
+  end
+
+  def to_s
+    "#{@value} #{Fund.config.currency_symbols[@currency]}"
+  end
+
+  private
+
+  def prettify(value)
+    value == value.to_i ? value.to_i : value.round(Fund.config.round_limit)
+  end
+end
+
+Fund.load_default

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: fund
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nazar Hussain
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: If you ever need to build a ruby based app where you need currency conversion.
+  This gem will help you in every aspect.
+email:
+- nazarhussain@gmail.com
+executables:
+- fund
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/fund
+- fund.gemspec
+- lib/fund.rb
+- lib/fund/arithmetic.rb
+- lib/fund/comparision.rb
+- lib/fund/configuration.rb
+- lib/fund/conversion.rb
+- lib/fund/default.rb
+- lib/fund/version.rb
+homepage: https://github.com/nazarhussain
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A gem utilizing ruby power to handle money and currency conversion issues.
+test_files: []