papla 0.0.1 → 0.0.2

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+### 0.0.2 (2011-01-09)
+
+* display decimal part of floats as cents/100
+
+### 0.0.1 (2011-01-03)
+
+* initial release
+* support converting numbers from 0 up to 999 999 999 to Polish words

data/README.md

@@ -1,19 +1,55 @@
-# Papla
+# Papla [![Build Status](https://secure.travis-ci.org/exviva/papla.png)](http://travis-ci.org/exviva/papla)
 
 Papla is a Ruby gem that allows you to convert numbers into Polish words (e.g. `153` into `"sto pięćdziesiąt trzy"`), including the decimal part as cents and currency symbol. Its primary use case are invoices, where the total amount has to be displayed as words at the bottom line.
 
-## Basic examples
+## Installation
+
+To install Papla, run
+
+    gem install papla
+
+or add
+
+```ruby
+gem 'papla'
+```
+
+to your `Gemfile`.
+
+## Usage
+
+### Basic examples
 
 ```ruby
-Papla[158] # => 'Sto pięćdziesiąt'
-Papla[1_234] # => 'Tysiąc dwieście trzydzieści cztery'
-Papla[987_654_321] # => 'Dziewięćset osiemdziesiąt siedem milionów sześćset pięćdziesiąt cztery tysiące trzysta dwadzieścia jeden'
+Papla[158] # => "Sto pięćdziesiąt osiem"
+Papla[1_234] # => "Tysiąc dwieście trzydzieści cztery"
+Papla[987_654_321] # => "Dziewięćset osiemdziesiąt siedem milionów sześćset pięćdziesiąt cztery tysiące trzysta dwadzieścia jeden"
 ```
 
-## Cents and currency
+### Cents and currency
+
+#### Cents
+
+When given a `Float`, Papla will assume that the decimal part represents cents.
+It will then round the number using `Float#round` to two decimal places,
+and append the number of cents divided by hundred to the resulting string.
+
+Example:
+
+```ruby
+Papla[1.0] # => "Jeden 00/100"
+Papla[87.654321] # => "Osiemdziesiąt siedem 65/100"
+Papla[2.999] # => "Trzy 00/100"
+```
+
+#### Currency
 
 This feature is planned for future releases.
 
-## Integration with Money, I18n and Rails
+### Integration with Money, I18n and Rails
 
 This feature is planned for future releases.
+
+## Documentation
+
+Documentation is available at [RubyDoc.info](http://rubydoc.info/github/exviva/papla/master/frames).

data/Rakefile

@@ -1 +1,8 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.ruby_opts = '-w'
+end
+
+task default: :spec

data/lib/papla.rb

@@ -2,15 +2,50 @@
 require "papla/version"
 
 module Papla
+  # Converts a number to Polish words, capitalizing
+  # the first letter of the whole phrase.
+  #
+  # Currently numbers from 0 up to 999 999 999
+  # are supported. If you pass a bigger number,
+  # an <tt>ArgumentError</tt> is raised.
+  #
+  # To convert a number, simply call:
+  #
+  #   Papla[your_number]
+  #
+  # Examples:
+  #
+  #   Papla[0] # => "Zero"
+  #   Papla[22] # => "Dwadzieścia dwa"
+  #   Papla[150] # => "Sto pięćdziesiąt"
+  #   Papla[999] # => "Dziewięćset dziewięćdziesiąt dziewięć"
+  #   Papla[12345] # => "Dwanaście tysięcy trzysta czterdzieści pięć"
+  #   Papla[1_000_001] # => "Jeden milion jeden"
+  #
+  # When given a <tt>Float</tt>, Papla will assume that
+  # the decimal part represents cents. It will then
+  # round the number using <tt>Float#round</tt> to
+  # two decimal places, and append the number
+  # of cents divided by hundred to the resulting string.
+  #
+  # Example:
+  #
+  #   Papla[1.0] # => "Jeden 00/100"
+  #   Papla[87.654321] # => "Osiemdziesiąt siedem 65/100"
+  #   Papla[2.999] # => "Trzy 00/100"
+  #
+  # @param [Fixnum] number the number to convert
+  # @return [String] the phrase in Polish
   def self.[](number)
     validate!(number)
-    if number.zero?
-      ZERO
-    else
-      groups = group(number)
-      groups_as_words = convert_groups(groups)
-      groups_as_words.flatten.join(' ')
-    end.capitalize
+    number = prepare(number)
+    basic_number = number.to_i
+    basic_phrase = build_basic_phrase(basic_number)
+
+    case number
+    when Float; append_cents(basic_phrase, number)
+    else basic_phrase
+    end
   end
 
   private
@@ -40,6 +75,23 @@ module Papla
     ['miliardów', 'miliard', 'miliardy'].freeze
   ].freeze
 
+  def self.prepare(number)
+    case number
+    when Float; number.round(2)
+    else number
+    end
+  end
+
+  def self.build_basic_phrase(basic_number)
+    if basic_number.zero?
+      ZERO
+    else
+      groups = group(basic_number)
+      groups_as_words = convert_groups(groups)
+      groups_as_words.flatten.join(' ')
+    end.capitalize
+  end
+
   def self.group(number)
     groups = []
 
@@ -104,4 +156,9 @@ module Papla
     max = 999_999_999
     raise ArgumentError, "#{number} is too big, only numbers up to #{max} are supported" if number > max
   end
+
+  def self.append_cents(basic_phrase, number)
+    cents = 100 * (number - number.to_i)
+    "%s %02d/100" % [basic_phrase, cents]
+  end
 end

data/lib/papla/version.rb

@@ -1,3 +1,3 @@
 module Papla
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/papla.gemspec

@@ -1,4 +1,4 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 $:.push File.expand_path("../lib", __FILE__)
 require "papla/version"
 
@@ -18,7 +18,6 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
-  s.add_development_dependency 'rspec', '>= 2.8.0.rc2'
-  # s.add_runtime_dependency "rest-client"
+  s.add_development_dependency 'rspec', '>= 2.8.0'
+  s.add_development_dependency 'rake'
 end

data/spec/papla_spec.rb

@@ -211,6 +211,20 @@ describe Papla do
   end
 
   it 'does not support billions' do
-    proc { subject[1_000_000_000] }.should raise_error(ArgumentError)
+    expect { subject[1_000_000_000] }.to raise_error(ArgumentError)
+  end
+
+  describe 'floats' do
+    it 'appends the decimal part as cents' do
+      subject[1.23].should eq('Jeden 23/100')
+    end
+
+    it 'displays two decimal digits' do
+      subject[2.0].should eq('Dwa 00/100')
+    end
+
+    it 'rounds to two decimal places' do
+      subject[3.456].should eq('Trzy 46/100')
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: papla
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,19 +9,30 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-03 00:00:00.000000000 Z
+date: 2012-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &19504300 !ruby/object:Gem::Requirement
+  requirement: &9069800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.8.0.rc2
+        version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *19504300
+  version_requirements: *9069800
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &9069220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *9069220
 description: Papla is a Ruby gem that allows you to convert numbers into Polish words
   (e.g. 153 into "sto pięćdziesiąt trzy"), including the decimal part as cents and
   currency symbol. Its primary use case are invoices, where the total amount has to
@@ -35,6 +46,8 @@ files:
 - .gitignore
 - .rspec
 - .rvmrc
+- .travis.yml
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile