farsifu 0.4.1 → 0.5.0

data/README.md

@@ -2,8 +2,9 @@
 farsifu is a toolbox for developing ruby applications in Persian (Farsi) language.
 
 ## Features
-* Converting numbers to Persian numbers
-* Spelling numbers in Persian (also support ordinal spelling)
+* Converting numbers to and from Persian numbers
+* Spelling numbers in Persian (supports ordinal spelling of numbers in Persian)
+* Converting Persian spelling of numbers back to normal numbers (see examples below)
 * List of Iran's provinces, cities, counties
 * List of countries in Persian
 
@@ -15,7 +16,10 @@ farsifu is a toolbox for developing ruby applications in Persian (Farsi) languag
     -2567023.spell_farsi      # => "منفی دو میلیون و پانصد و شصت و هفت هزار و بیست و سه"
     7.53.spell_farsi          # => "هفت ممیز پنجاه و سه صدم"
     -0.999.spell_farsi        # => "منفی صفر ممیز نهصد و نود و نه هزارم"
+    # Passing false to spell_farsi method will turn off the verbose mode.
+    -0.999.spell_farsi(false) # => "منفی نهصد و نود و نه هزارم"
     12.spell_ordinal_farsi    # => "دوازدهم"
+    # Note the different when you pass true to spell_ordinal_farsi method. 
     12.spell_ordinal_farsi(true)    # => "دوازدهمین"
     "هزار و چهل و پنج".farsi_to_number  # => 1045
 
@@ -35,46 +39,39 @@ farsifu is a toolbox for developing ruby applications in Persian (Farsi) languag
     gem install farsifu
 
 ## Changelog
+### 0.5.0 - 15.FEB.2013
+* [Arash Mousavi](https://github.com/arashm) is now a collaborator. 
+* Passing false to spell_farsi method will turn off the verbose mode.
+* Major internal refactoring. Should not change the external API.
+
 ### 0.4.0 - 4.FEB.2013
-* added `farsi_to_number` to convert farsi spelling of numbers to real numbers , courtesy of [Arash Mousavi](https://github.com/arashm)
+* Added `farsi_to_number` to convert farsi spelling of numbers to real numbers , courtesy of [Arash Mousavi](https://github.com/arashm)
 * Major refactoring and reorganization of the code, courtesy of [Arash Mousavi](https://github.com/arashm)
 
-
 ### 0.3.0 - 28.JAN.2013
-* added farsi ordinal spelling, courtesy of [Arash Mousavi](https://github.com/arashm)
-
+* Added Farsi ordinal spelling, courtesy of [Arash Mousavi](https://github.com/arashm)
 
 ### 0.2.2 - 11.APR.2011
-* added ruby 1.9 compatibility, courtesy of Brian Kaney 
+* Added ruby 1.9 compatibility, courtesy of Brian Kaney 
 
 ### 0.2.1 - 11.JAN.2011
-* updated readme
-* now using rspec 2.4
-* no longer replacing * with ×
+* Updated Readme
+* Updated rspec to 2.4
+* No longer replacing * with ×
 
 ### 0.2 - 2.MAR.2010
-* renamed gem from FarsiFu to farsifu
+* Renamed gem from FarsiFu to farsifu
 * Added a spec suite
 * Migrated the gem to rubygems.org
 * Added Iran Module
 
 ### 0.02 - 10.AUG.2008
-* converted into a gem
-* rdocs added
+* Converted into a gem
+* Added rdocs documentation
 
 ### 0.01 - 07.AUG.2008
-* initial release
-
-
-## Note on Patches/Pull Requests
+* Initial release
 
-* 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
 

data/farsifu.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
   s.name                      = "farsifu"
   s.version                   = FarsiFu::VERSION
   s.platform                  = Gem::Platform::RUBY
-  s.authors                   = ["Allen A. Bargi"]
-  s.email                     = %q{allen.bargi@gmail.com}
+  s.authors                   = ["Allen A. Bargi", "Arash Mousavi"]
+  s.email                     = %q{allen.bargi@gmail.com mousavi.arash@gmail.com}
   s.homepage                  = %q{http://github.com/aziz/farsifu}
   s.summary                   = %q{a toolbox for developing ruby applications in Persian (Farsi) language, see readme file for features}
   s.description               = %q{a toolbox for developing ruby applications in Persian (Farsi) language, see readme file for features}

data/lib/farsifu/constants.rb

@@ -4,16 +4,9 @@ module FarsiFu
   PERSIAN_CHARS = "۱۲۳۴۵۶۷۸۹۰،؛"
   ENGLISH_CHARS = "1234567890,;"
 
-  PERSIAN_DIGIT_JOINT = " و "
-  PERSIAN_DIGIT_SIGN = ["منفی ", "مثبت ", " ممیز "]
-
-  PERSIAN_DIGIT_SPELL = {
-    0          => [ nil ,"یک","دو","سه","چهار","پنج","شش","هفت","هشت","نه", "صفر"] ,
-    1          => [ nil ,"ده","بیست","سی","چهل","پنجاه","شصت","هفتاد","هشتاد","نود"],
-    2          => [ nil ,"صد","دویست","سیصد","چهارصد","پانصد","ششصد","هفتصد","هشتصد","نهصد"],
-    "10..19"   => [ "ده" ,"یازده","دوازده","سیزده","چهارده","پانزده","شانزده","هفده","هجده","نوزده"],
-    "zillion"  => [ nil ,"هزار","میلیون","میلیارد","بیلیون","تریلیون","کوادریلیون","کوینتیلیون","سیکستیلیون","سپتیلیون","اکتیلیون","نونیلیون","دسیلیون"],
-    "decimals" => [ nil, "دهم", "صدم", "هزارم", "ده‌هزارم", "صدهزارم", "میلیونیم", "ده‌میلیونیم","صدمیلیونیم","میلیاردیم"]
+  SIGNS ={
+    "-" => "منفی ",
+    "+" => "مثبت "
   }
 
   EXCEPTIONS = {
@@ -58,10 +51,11 @@ module FarsiFu
     "نهصد"      => 900
   }
 
+  EXCEPTIONS_INVERT = EXCEPTIONS.invert
+
   POWER_OF_TEN = {
-    # based on:
+    # based on: 
     # https://fa.wikipedia.org/wiki/%D9%86%D8%A7%D9%85_%D8%A7%D8%B9%D8%AF%D8%A7%D8%AF_%D8%A8%D8%B2%D8%B1%DA%AF
-    "صفر"           => 0,
     "ده"            => 1,
     "هزار"          => 3,
     "میلیون"        => 6,
@@ -86,4 +80,6 @@ module FarsiFu
     "دسیلیارد"      => 63,
     "گوگول"         => 100
   }
+
+  POWER_OF_TEN_INVERT = POWER_OF_TEN.invert
 end

data/lib/farsifu/num_to_word.rb

@@ -3,8 +3,11 @@
 module FarsiFu
   class NumToWord
 
-    def initialize(number)
-      @number = number
+    def initialize(number, verbose = true)
+      @number  = number.to_s
+      @sign    = check_for_sign
+      @float   = true if number.is_a? Float
+      @verbose = verbose
     end
 
     # Spells a number in Persian
@@ -12,18 +15,12 @@ module FarsiFu
     #
     # Example:
     #   5678.spell_farsi # => "پنج هزار و ششصد و هفتاد و هشت"
+    #   3.22.spell_farsi # => "سه ممیز بیست و دو صدم"
     def spell_farsi
-      # Distigushing the number (float and )
-      if @number.class == Float
-        num_array = @number.to_f.to_s.split(".").first.split(//).reverse
-        dec_array = @number.to_f.to_s.split(".").last.split(//).slice(0..9).compact.reverse
-        dec_copy_b = dec_array.clone ; dec_copy_a = dec_array.clone
-        result = spell(num_array)
-        ( result += PERSIAN_DIGIT_SIGN[2] + spell(dec_array) + " " + PERSIAN_DIGIT_SPELL["decimals"][dec_copy_a.size].to_s )  unless [PERSIAN_DIGIT_SPELL[0][10],""].include? spell(dec_copy_b)
-        return result
+      if @float
+        parse_and_spell_float
       else
-        num_array = @number.to_i.to_s.split(//).reverse
-        return spell(num_array)
+        parse_and_spell_real_number
       end
     end
 
@@ -34,57 +31,96 @@ module FarsiFu
     #   121.spell_ordinal_farsi     # => "صد و بیست و یکم"
     #   2.spell_ordinal_farsi(true) # => "دومین"
     #   2054.spell_ordinal_farsi(true) # => "دو هزار و پنجاه چهارمین"
-    def spell_ordinal_farsi(*args)
-      if args[0]
-        exceptions = {0 => "صفر", 1 => "اولین", 3 => "سومین"}
-        suffix = "مین"
+    def spell_ordinal_farsi(second_type = false)
+      if second_type
+        exceptions = {'0' => "صفر", '1' => "اولین", '3' => "سومین"}
+        suffix     = "مین"
       else
-        exceptions = {0 => "صفر", 1 => "اول", 3 => "سوم"}
-        suffix = "م"
+        exceptions = {'0' => "صفر", '1' => "اول", '3' => "سوم"}
+        suffix     = "م"
       end
 
       make_ordinal_spell(exceptions, suffix)
     end
 
-  private #---------------------------------------------------------
-    def spell(num_array)
-      # Dealing with signs
-      sign_m = num_array.include?("-") ? PERSIAN_DIGIT_SIGN[0] : ""
-      sign_p = num_array.include?("+") ? PERSIAN_DIGIT_SIGN[1] : ""
-      num_array.delete_at(num_array.index("-")) if sign_m.size > 0
-      num_array.delete_at(num_array.index("+")) if sign_p.size > 0
-      sign = sign_m + sign_p
+  private
+    def parse_and_spell_real_number
+      answer = []
+      group_by_power do |power, num|
+        three_digit_spell = spell_three_digits(num, power)
+        answer.concat three_digit_spell
+      end
+      spell = answer.compact.reverse.join(' و ').prepend("#{SIGNS[@sign]}")
+      # verbose false?
+      spell.gsub!(/^(منفی\s|مثبت\s)*یک\sهزار/) {"#{$1}هزار"} unless @verbose
+      spell
+    end
 
-      zillion = 0
-      farsi_number = []
+    def parse_and_spell_float
+      # Seperate floating point
+      float_num         = @number.match(/\./)
+      pre_num, post_num = float_num.pre_match.prepend("#{@sign}"), float_num.post_match
+      # To convert it to دهم, صدم...
+      floating_point_power       = 10 ** post_num.size
 
-      # Dealing with Zero
-      if (num_array.length == 1 && num_array[0] == "0" )
-        farsi_number = [PERSIAN_DIGIT_SPELL[0][10]]
-        num_array = []
+      pre_num_spell              = NumToWord.new(pre_num).spell_farsi
+      pre_num_spell << 'صفر' if pre_num == '0' and @verbose
+      post_num_spell             = NumToWord.new(post_num).spell_farsi
+      floating_point_power_spell = NumToWord.new(floating_point_power, false).spell_ordinal_farsi.gsub(/یک\s*/, '')
+
+      if pre_num != '0' or @verbose
+        "#{pre_num_spell} ممیز #{post_num_spell} #{floating_point_power_spell}"
+      else
+        "#{pre_num_spell if pre_num_spell.size > 0}#{post_num_spell} #{floating_point_power_spell}"
       end
+    end
 
-      while num_array.length > 0 do
-        spelling = []
-        num_array[0..2].each_with_index do |digit,index|
-            spelling[index] = PERSIAN_DIGIT_SPELL[index][digit.to_i]
-            if index == 1 && digit == "1"   # Dealing with 10..19
-               spelling[1] = PERSIAN_DIGIT_SPELL["10..19"][num_array[0].to_i]
-               spelling[0] = nil
-             end
-        end
+    # checks if the first char is `+` or `-` and returns the sign
+    def check_for_sign
+      sign = @number.slice(0).match(/(-|\+)/)
+      if sign
+        # remove the sign from number
+        @number.slice!(0)
+        sign[1]
+      end
+    end
 
-        3.times { num_array.shift if num_array.length > 0 } # Eliminating the first 3 number of the array
-        dig = spelling.reverse.compact.join(PERSIAN_DIGIT_JOINT)
-        if dig.size > 0
-          dig << (" " + PERSIAN_DIGIT_SPELL["zillion"][zillion].to_s)
-          farsi_number.unshift(dig)
-        end
+    # '1234567' #=> {0=>["7", "6", "5"], 3=>["4", "3", "2"], 6=>["1"]}
+    def group_by_power &block
+      power = 0
+      @number.split('').reverse.each_slice(3) do |digit|
+        yield power, digit
+        power += 3
+      end
+    end
 
-        zillion += 1
-      end # End of While
+    # ["7", "6", "5"], 3 #=> ['هفت هزار', 'شصت', 'پانصد']
+    def spell_three_digits(num, power)
+      answer = []
+      yekan = nil
+      num.each_with_index do |n, i|
+        # The 'n' is zero? no need to evaluate
+        next if n == '0'
+        exception_index = n.to_i * (10 ** i)
 
-      sign + farsi_number.compact.join(PERSIAN_DIGIT_JOINT).strip
+        case i
+        when 0
+          # save Yekan to use for 10..19 exceptions
+          yekan = n
+        when 1
+          # If we're in Sadgan and the digit is 1 so it's a number
+          # between 10..19 and it's an exception
+          if n == '1'
+            exception_index = 10 + yekan.to_i
+            answer.clear
+          end
+        end
+        answer << EXCEPTIONS_INVERT[exception_index]
+      end
+      # append power of ten to first number based on `power` passed to function
+      # ["7", "6", "5"], 3 #=> ['هفت هزار', 'شصت', 'پانصد']
+      answer[0] = "#{answer[0]} #{(POWER_OF_TEN_INVERT[power])}".strip if answer.size > 0
+      answer
     end
 
     def make_ordinal_spell(exceptions, suffix)

data/lib/farsifu/punch.rb

@@ -10,12 +10,12 @@ module Convert
 end
 
 module NumToWord
-  def spell_farsi
-    FarsiFu::NumToWord.new(self).spell_farsi
+  def spell_farsi(verbose = true)
+    FarsiFu::NumToWord.new(self, verbose).spell_farsi
   end
 
-  def spell_ordinal_farsi(*args)
-    FarsiFu::NumToWord.new(self).spell_ordinal_farsi(args[0])
+  def spell_ordinal_farsi(second_type = false, verbose = true)
+    FarsiFu::NumToWord.new(self, verbose).spell_ordinal_farsi(second_type)
   end
 end
 
@@ -27,6 +27,7 @@ end
 
 class String
   include Convert
+  include NumToWord
   include WordToNum
 end
 
@@ -34,8 +35,3 @@ class Numeric
   include Convert
   include NumToWord
 end
-
-# Seems that Numeric works for both Float and Integers
-# class Float
-#   include NumToWord
-# end

data/lib/farsifu/version.rb

@@ -1,3 +1,3 @@
 module FarsiFu
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/spec/farsifu_spec.rb

@@ -22,6 +22,7 @@ describe "Farsifu" do
   it "should be able to spell positive and negetive integers in Persian" do
     1024.spell_farsi.should == "یک هزار و بیست و چهار"
     -2567023.spell_farsi.should == "منفی دو میلیون و پانصد و شصت و هفت هزار و بیست و سه"
+    '+2567023'.spell_farsi.should == "مثبت دو میلیون و پانصد و شصت و هفت هزار و بیست و سه"
   end
 
   it "should be able to spell positive and negetive floats in Persian" do
@@ -32,6 +33,13 @@ describe "Farsifu" do
     -0.999.spell_farsi.should == "منفی صفر ممیز نهصد و نود و نه هزارم"
   end
 
+  it "should spell in non-verbose mode" do
+    1204.spell_farsi(false).should eq('هزار و دویست و چهار')
+    -0.2.spell_farsi(false).should eq('منفی دو دهم')
+    # shouldn't affect floats without zero at the beginning
+    1.2.spell_farsi(false).should eq('یک ممیز دو دهم')
+  end
+
   it "should be able to show first type of sequentional numbers to persian" do
     nums = {0 => "صفر",1 => "اول", 3 => "سوم", 12 => "دوازدهم", 33 => "سی و سوم", 121=> "صد و بیست و یکم"}
     nums.each do |k, v|

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: farsifu
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
 - Allen A. Bargi
+- Arash Mousavi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-05 00:00:00.000000000 Z
+date: 2013-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -61,7 +62,7 @@ dependencies:
         version: '0'
 description: a toolbox for developing ruby applications in Persian (Farsi) language,
   see readme file for features
-email: allen.bargi@gmail.com
+email: allen.bargi@gmail.com mousavi.arash@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: