paisa 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bc752f25537cef88838ce041e8347cfd6e86bae3
-  data.tar.gz: 8b538f7c3086861411be83a19880f8e84caa4c11
+SHA256:
+  metadata.gz: bb609acdf81fbd52d8c95b642f1d519509c7cd3a9e15c67d021a117af8dd3309
+  data.tar.gz: e541890f38dd6d9fe7ce17ee57d783c44ef953a74d0b11af4920f481a7b01f5e
 SHA512:
-  metadata.gz: 53e6e6eeae0cbaa5a8528253269c9dbfc31a77d51b6e7df0864c5e80e45e69408e150bfd9de5027a35ef9ec4818bdadd712134e671181b1771f5518790566823
-  data.tar.gz: 3007bbe43dab87b1a923627c0a6b17f04ccf1842b7aaf9781218c5461ac4d614634f97af90a0f7082981c920c4915d9e96c97a7fd0956e6f510c740f0746693e
+  metadata.gz: 01a60662b1531db871b56c9b7b025324456acc66c90c131e60e5d5792b995200b44a85aa559c006fd6d26e634fc5119c09c78d516c14965865dda3520011b54a
+  data.tar.gz: c1cd1d08599c7fc45944042db35e221ec559f5660284c6b87e77e8dbbb35c518e982d8ed2bdf510455d729f9f9af9d1f5b4601c2a9b11d59f2857378fc5e4c85

data/.gitignore

@@ -9,3 +9,5 @@
 /tmp/
 *.gem
 /test/reports
+.idea/
+.ruby-version

data/README.md

@@ -1,8 +1,6 @@
-# Paisa [![CircleCI](https://circleci.com/gh/sudhirj/paisa.svg?style=svg)](https://circleci.com/gh/sudhirj/paisa)
+# Paisa
 
-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/paisa`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Having trouble figuring out where to put the commas in Indian money? Are you being lazy and defaulting to hundreds of thousands and millions instead of lakhs and crores? Default no more! `Paisa` is here to save you.
 
 ## Installation
 
@@ -22,7 +20,24 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```
+
+// Format paise - if you have your money in Rupees, multiply by 100 to get the number of paise.
+Paisa.format(12345) // "123.45"
+Paisa.format(12345678) // "1,23,456.78"
+Paisa.format(12345678987) // "12,34,56,789.87"
+Paisa.format(10000) // "100"
+
+// Use formatWithSymbol to get Paisa to add the official Rupee symbol for you
+Paisa.format_with_sym(12345678) // "₹1,23,456.78"
+Paisa.format_with_sym(10000) // "₹100"
+
+// Pass an optional second parameter to force decimal precision to be set. 
+Paisa.format(12345678987, precision: 0) // "12,34,56,789" 
+Paisa.format(10000, precision: 2) // "100.00"
+Paisa.format_with_sym(10000, precision: 2) // "₹100.00"
+
+```
 
 ## Development
 
@@ -32,7 +47,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/paisa. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/paisa.rb. 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.
 
 
 ## License

data/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version: 2.3.0

data/lib/paisa.rb

@@ -1,20 +1,94 @@
+# frozen_string_literal: true
+
 require 'paisa/version'
 
 module Paisa
+  SYMBOL = '₹'.freeze
+  ONES = {
+    1 => 'one', 2 => 'two', 3 => 'three', 4 => 'four', 5 => 'five',
+    6 => 'six', 7 => 'seven', 8 => 'eight', 9 => 'nine', 0 => nil
+  }.freeze
+
+  def self.tens_hash(tens_name)
+    Hash.new do |_, k|
+      [tens_name, ONES[k]].compact.join(' ')
+    end
+  end
+
+  private_class_method :tens_hash
+
+  TENS = {
+    1 => {
+      1 => 'eleven', 2 => 'twelve', 3 => 'thirteen', 4 => 'fourteen', 5 => 'fifteen',
+      6 => 'sixteen', 7 => 'seventeen', 8 => 'eighteen', 9 => 'nineteen', 0 => 'ten'
+    },
+    2 => tens_hash('twenty'),
+    3 => tens_hash('thirty'),
+    4 => tens_hash('forty'),
+    5 => tens_hash('fifty'),
+    6 => tens_hash('sixty'),
+    7 => tens_hash('seventy'),
+    8 => tens_hash('eighty'),
+    9 => tens_hash('ninety'),
+    0 => ONES
+  }.freeze
+
   def self.format(paise, precision: 2)
-    little_endian = paise.to_s.reverse.chars
-    paise = little_endian.shift(2).reverse
-    hundreds = little_endian.shift(3).reverse
-    others = little_endian.each_slice(2).map(&:reverse).map(&:join)
-    rupees = [others.reverse, hundreds.join].flatten.compact.join(',').rjust(1, '0')
-    [rupees, paise.join.rjust(2, '0').slice(0, precision)].reject(&:empty?).join('.')
+    rupee_parts, paise_part = parse(paise)
+    [
+      rupee_parts.join(',').rjust(1, '0'),
+      paise_part.rjust(2, '0').slice(0, precision)
+    ].reject(&:empty?).join('.')
   end
 
   def self.format_with_sym(paise, precision: 2)
-    [symbol, format(paise, precision: precision)].join
+    [SYMBOL, format(paise, precision: precision)].join
   end
 
-  def self.symbol
-    '₹'
+  def self.words(paise)
+    rupee_parts, paise_part = parse(paise)
+    rupee_text_parts = rupee_parts.reverse.each_with_object([]) do |section, memo|
+      label = ['', ' thousand', ' lakh', ' crore'][memo.size]
+      memo << if section.to_i.zero?
+                nil
+              else
+                [to_words(section), label].join
+              end
+    end
+    text = []
+    text << [rupee_text_parts.to_a.compact.reverse.join(', '), 'rupees'].join(' ') unless rupee_text_parts.empty?
+    text << [to_words(paise_part), 'paise'].join(' ') unless paise_part.to_i.zero?
+    text.join(', ')
   end
+
+  def self.parse(paise)
+    little_endian = paise.to_s.reverse.chars
+    paise_part = little_endian.shift(2).reverse.join
+    rupee_parts = []
+    cycle = [3, 2, 2].cycle
+    until little_endian.empty?
+      rupee_parts.unshift(little_endian.shift(cycle.next).reverse.join)
+    end
+    [rupee_parts, paise_part]
+  end
+  private_class_method :parse
+
+  def self.to_words(section)
+    digits = section.chars.map(&:to_i)
+    case digits.size
+    when 1
+      ONES.dig(*digits)
+    when 2
+      TENS.dig(*digits)
+    when 3
+      parts = []
+      parts << [ONES[digits[0]], 'hundred'].join(' ')
+      parts << TENS.dig(*digits.slice(1, 2)) unless digits.slice(1, 2).all?(&:zero?)
+      parts.join(' and ')
+    else
+      # do nothing
+    end
+  end
+
+  private_class_method :to_words
 end

data/lib/paisa/version.rb

@@ -1,3 +1,3 @@
 module Paisa
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/paisa.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rubocop'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paisa
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Sudhir Jonathan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-25 00:00:00.000000000 Z
+date: 2019-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: India specifc formatting for currecies stored in Paise
 email:
 - sudhir.j@gmail.com
@@ -68,6 +82,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- circle.yml
 - lib/paisa.rb
 - lib/paisa/version.rb
 - paisa.gemspec
@@ -91,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: India specifc formatting for currecies stored in Paise