ecriso4217 0.3.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Enrique Comba Riepenhausen
+
+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.rdoc

@@ -0,0 +1,29 @@
+= ISO4217 
+
+(extract from Wikipedia)
+
+ISO 4217 is the international standard describing three-letter codes 
+(also known as the currency code) to define the names of currencies 
+established by the International Organization for Standardization (ISO). 
+The ISO 4217 code list is the established norm in banking and business 
+all over the world for defining different currencies, and in many countries
+the codes for the more common currencies are so well known publicly, that
+exchange rates published in newspapers or posted in banks use only these 
+to define the different currencies, instead of translated currency names 
+or ambiguous currency symbols. ISO 4217 codes are used on airline tickets 
+and international train tickets to remove any ambiguity about the price.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Enrique Comba Riepenhausen. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ecriso4217"
+    gem.summary = %Q{Currencies as described by the ISO 4217 Standard}
+    gem.description = %Q{When dealing with currencies in code you don't need to roll up your
+                         own interpretation of a currency. Now you can just use the ISO 4217
+                         gem to work with them.}
+    gem.email = "ecomba@nexwerk.com"
+    gem.homepage = "http://github.com/ecomba/ecriso4217"
+    gem.authors = ["Enrique Comba Riepenhausen"]
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ecriso4217 #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 1
+:major: 0
+:minor: 3

data/lib/iso4217/currencies.rb

@@ -0,0 +1,21 @@
+module ISO4217
+
+  GENERIC_CURRENCY_SIGN= "U+00a4"
+  DOLLAR_SIGN = "U+0024"
+
+  ALBANIAN_LEKE= Currency.new(:ALL, "U+004cU+0065U+6b", 'Lek')
+  AMERICAN_DOLLAR= Currency.new(:USD, DOLLAR_SIGN, 'US dollar')
+  AFGHANI= Currency.new(:AFN, "U+060b", 'Afghani')
+  ARGENTINA_PESOS= Currency.new(:ARS, "U+0024", 'Argentine peso')
+  ARUBAN_GUILDER= Currency.new(:AWG, "U+0192", 'Aruban guilder')
+  AUSTRALIAN_DOLLAR= Currency.new(:AUD, DOLLAR_SIGN, 'Australian dollar')
+  AZERBAIJANIAN_MANAT= Currency.new(:AZN, "U+043cU+0430U+043d", 'Azerbaijanian manat')
+  BAHAMAS_DOLLAR= Currency.new(:BSD, DOLLAR_SIGN, 'Bahamian dollar')
+  BARBADOS_DOLLAR= Currency.new(:BBD, DOLLAR_SIGN, 'Barbados dollar')
+  BELARUS_RUBLE= Currency.new(:BYR, "U+0070U+002e", 'Belarusian ruble')
+  BELIZE_DOLLAR= Currency.new(:BZD, "U+0042U+005aU+0024", 'Belize dollar')
+
+  EURO= Currency.new(:EUR, "U+20ac", 'euro')
+  GBP= Currency.new(:GBP, "U+00a3", 'Pound sterling')
+
+end

data/lib/iso4217/currency.rb

@@ -0,0 +1,19 @@
+module ISO4217
+  class Currency
+    attr_reader :code, :sign, :name
+
+    def initialize(code, sign, name)
+      @code, @sign, @name = code, utf8(sign), name
+    end
+
+    def to_s
+      "Code: #{@code} | Sign: #{@sign} | Currency: #{@name}"
+    end
+
+    private
+    def utf8(string)
+      string.gsub(/U\+([0-9a-fA-F]{4,4})/u){["#$1".hex ].pack('U*')}
+    end
+  end
+end
+

data/lib/iso4217/iso4217.rb

@@ -0,0 +1,48 @@
+module ISO4217
+
+  COUNTRIES = {
+    :BE => EURO, 
+    :BG => EURO,
+    :CA => Currency.new(:CAD, "CanU+0024", 'Canadian dollar'),
+    :CZ => EURO,
+    :DK => EURO,
+    :DE => EURO,
+    :EE => EURO,
+    :IE => EURO,
+    :EL => EURO,
+    :ES => EURO,
+    :FR => EURO,
+    :GB => GBP, 
+    :IT => EURO,
+    :CY => EURO,
+    :LV => EURO,
+    :LT => EURO,
+    :LU => EURO,
+    :HU => EURO,
+    :MT => EURO,
+    :NL => EURO,
+    :AT => EURO,
+    :PL => EURO,
+    :PT => EURO,
+    :RO => EURO,
+    :SI => EURO,
+    :SK => EURO,
+    :FI => EURO,
+    :SE => EURO,
+    :UK => GBP,
+    :US => AMERICAN_DOLLAR 
+  }
+
+  def currency_for(country_code, default_when_currency_not_found= :NAC)
+    COUNTRIES[country_code] || Currency.new(default_when_currency_not_found, GENERIC_CURRENCY_SIGN, 'unknown')
+  end
+
+  def currency_code_for(country_code, default_when_currency_not_found= :NAC)
+    currency_for(country_code, default_when_currency_not_found).code.to_s
+  end
+
+  def currency_sign_for(country_code, default_when_currency_not_found= :NAC)
+    currency_for(country_code, default_when_currency_not_found).sign
+  end
+end
+

data/lib/iso4217.rb

@@ -0,0 +1,4 @@
+require 'iso4217/currency'
+require 'iso4217/currencies'
+require 'iso4217/iso4217'
+

data/spec/currency_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe ISO4217::Currency do
+
+  context "creation" do
+
+    before(:each) do
+      @currency = ISO4217::Currency.new(:EUR, 'U+20ac', 'euro')
+    end
+
+    it "has a code assigned to it" do
+      @currency.code.should == :EUR
+    end
+
+    it "has a sign" do
+      @currency.sign.should == '€'
+    end
+
+    it "has a name" do
+      @currency.name.should == 'euro'
+    end
+  end
+end

data/spec/iso4217_spec.rb

@@ -0,0 +1,105 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe ISO4217 do
+  
+  include ISO4217 
+
+  EURO_COUNTRIES = [:BE, :BG, :CY, :CZ, :DK, :DE, :EE, :IE, :EL, :ES, :FR, :IT, :LV, :LT, :LU, :HU, 
+                    :MT, :NL, :AT, :PL, :PT, :RO, :SI, :SK, :FI, :SE] 
+
+  context "finding currency codes for known countries" do
+    it "returns the currency euro code of the countries in the euro zone" do
+      EURO_COUNTRIES.each do |country|
+        currency_code_for(country).should == 'EUR'
+      end
+    end
+    
+    it "returns the currency code for the United Kingdom" do
+      currency_code_for(:UK).should == 'GBP'
+      currency_code_for(:GB).should == 'GBP'
+    end
+    
+    it "returns the currency code for United States of America" do
+      currency_code_for(:US).should == 'USD'
+    end
+    
+    it "returns the currency code for Canada" do
+      currency_code_for(:CA).should == 'CAD'
+    end
+  end
+
+  context "finding currency codes or unknown countries" do
+    
+    it "returns 'unknown' if it doesn't know the currency" do
+      currency_code_for(:MARS).should == 'NAC'
+    end
+   
+
+    it "returns the requested default currency code if it doesn't know the currency" do
+      currency_code_for(:MARS, 'GBP').should == 'GBP'
+    end
+  end
+
+  context "prints the sign of known currencies" do
+    it "returns the euro sign for the countries in the euro zone" do
+      EURO_COUNTRIES.each do |country|
+        currency_sign_for(country).should == '€'
+      end
+    end
+
+    it "returns the dollar sign for the American dollar" do
+      currency_sign_for(:US).should == '$'
+    end
+
+    it "returns the canadian dollar sign for canadian dollars" do
+      currency_sign_for(:CA).should == "Can$"
+    end
+  end
+
+  context "prints the sign for unknown currency" do
+    it "returns the generic currency sign for unknown currencies" do
+      currency_sign_for(:MARS).should == "¤"
+    end
+  end
+
+  context "currencies of known countries" do
+    it "returns the currency object for Euro if searching for currencies in the euro zone" do
+      EURO_COUNTRIES.each do |country|
+        currency_for(country).should == ISO4217::EURO
+      end
+    end
+
+    it "returns the currency object for GBP when searching for the currency in Great Britain" do
+      [:GB, :UK].each {|country| currency_for(country).should == ISO4217::GBP}
+    end
+
+    it "returns the currency object for the dollar if searching for the American currency" do
+      currency_for(:US).should == ISO4217::AMERICAN_DOLLAR
+    end
+  end
+
+  context "name of a currency" do
+    it "returns the (human readable) name of the euro" do
+      ISO4217::EURO.name.should == 'euro'
+    end
+
+    it "returns the (human readable) name of the Canadian dollar" do
+      currency_for(:CA).name.should == 'Canadian dollar'
+    end
+
+    it "returns the (human readable) name of the pound sterling" do
+      ISO4217::GBP.name.should == 'Pound sterling'
+    end
+
+    it "returns the (human readable) name of the US dollar" do
+      ISO4217::AMERICAN_DOLLAR.name.should == 'US dollar'
+    end
+  end
+
+  context "printing a curency object" do
+    it "prints the currency object for the EURO" do
+      ISO4217::EURO.to_s.should == "Code: EUR | Sign: € | Currency: euro"
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'iso4217'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: ecriso4217
+version: !ruby/object:Gem::Version 
+  version: 0.3.1
+platform: ruby
+authors: 
+- Enrique Comba Riepenhausen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-08 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: |-
+  When dealing with currencies in code you don't need to roll up your
+                           own interpretation of a currency. Now you can just use the ISO 4217
+                           gem to work with them.
+email: ecomba@nexwerk.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/iso4217.rb
+- lib/iso4217/currencies.rb
+- lib/iso4217/currency.rb
+- lib/iso4217/iso4217.rb
+- spec/currency_spec.rb
+- spec/iso4217_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/ecomba/ecriso4217
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Currencies as described by the ISO 4217 Standard
+test_files: 
+- spec/currency_spec.rb
+- spec/iso4217_spec.rb
+- spec/spec_helper.rb