farsifu 0.3.0 → 0.4.0

data/.gitignore

@@ -1,3 +1,4 @@
 pkg/*
 *.gem
 .bundle
+tmp

data/Gemfile.lock

@@ -1,12 +1,29 @@
 PATH
   remote: .
   specs:
-    farsifu (0.3.0)
+    farsifu (0.4.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    coderay (1.0.8)
     diff-lcs (1.1.3)
+    guard (1.6.2)
+      listen (>= 0.6.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      terminal-table (>= 1.4.3)
+      thor (>= 0.14.6)
+    guard-rspec (2.4.0)
+      guard (>= 1.1)
+      rspec (~> 2.11)
+    listen (0.7.2)
+    lumberjack (1.0.2)
+    method_source (0.8.1)
+    pry (0.9.11.4)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
     rspec (2.12.0)
       rspec-core (~> 2.12.0)
       rspec-expectations (~> 2.12.0)
@@ -15,6 +32,9 @@ GEM
     rspec-expectations (2.12.1)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.12.1)
+    slop (3.4.3)
+    terminal-table (1.4.5)
+    thor (0.17.0)
 
 PLATFORMS
   ruby
@@ -22,4 +42,5 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.2.0)
   farsifu!
+  guard-rspec
   rspec (~> 2.12.0)

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/README.md

@@ -17,6 +17,7 @@ farsifu is a toolbox for developing ruby applications in Persian (Farsi) languag
     -0.999.spell_farsi        # => "منفی صفر ممیز نهصد و نود و نه هزارم"
     12.spell_ordinal_farsi    # => "دوازدهم"
     12.spell_ordinal_farsi(true)    # => "دوازدهمین"
+    "هزار و چهل و پنج".farsi_to_number  # => 1045
 
 
     Iran::Provinces
@@ -33,9 +34,14 @@ farsifu is a toolbox for developing ruby applications in Persian (Farsi) languag
 ## Install
     gem install farsifu
 
-## History
+## Changelog
+### 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)
+* 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
+* added farsi ordinal spelling, courtesy of [Arash Mousavi](https://github.com/arashm)
 
 
 ### 0.2.2 - 11.APR.2011

data/farsifu.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |s|
   s.rdoc_options              = ["--charset=UTF-8"]
   s.add_development_dependency(%q<rspec>, ["~> 2.12.0"])
   s.add_development_dependency(%q<bundler>, ["~> 1.2.0"])
+  s.add_development_dependency(%q<guard-rspec>)
 end

data/lib/farsifu/constants.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+
+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, "دهم", "صدم", "هزارم", "ده‌هزارم", "صدهزارم", "میلیونیم", "ده‌میلیونیم","صدمیلیونیم","میلیاردیم"]
+  }
+
+  EXCEPTIONS = {
+    "یک"        => 1,
+    "دو"        => 2,
+    "سه"        => 3,
+    "چهار"      => 4,
+    "پنج"       => 5,
+    "شش"        => 6,
+    "هفت"       => 7,
+    "هشت"       => 8,
+    "نه"        => 9,
+
+    "یازده"     => 11,
+    "دوازده"    => 12,
+    "سیزده"     => 13,
+    "چهارده"    => 14,
+    "پانزده"    => 15,
+    "شانزده"    => 16,
+    "هفده"      => 17,
+    "هجده"      => 18,
+    "نوزده"     => 19,
+
+    "ده"        => 10,
+    "بیست"      => 20,
+    "سی"        => 30,
+    "چهل"       => 40,
+    "پنجاه"     => 50,
+    "شصت"       => 60,
+    "هفتاد"     => 70,
+    "هشتاد"     => 80,
+    "نود"       => 90,
+
+    "صد"        => 100,
+    "دویست"     => 200,
+    "سیصد"      => 300,
+    "چهارصد"    => 400,
+    "پانصد"     => 500,
+    "ششصد"      => 600,
+    "هفتصد"     => 700,
+    "هشتصد"     => 800,
+    "نهصد"      => 900
+  }
+
+  POWER_OF_TEN = {
+    # 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,
+    "میلیارد"       => 9,
+    "بیلیون"        => 12,
+    "بیلیارد"       => 15,
+    "تریلیون"       => 18,
+    "تریلیارد"      => 21,
+    "کادریلیون"     => 24,
+    "کادریلیارد"    => 27,
+    "کوانتینیوم"    => 30,
+    "کوانتینیارد"   => 33,
+    "سکستیلیون"     => 36,
+    "سکستیلیارد"    => 39,
+    "دسیلیون"       => 42,
+    "سپتیلیارد"     => 45,
+    "اکتیلیون"      => 48,
+    "اکتیلیارد"     => 51,
+    "نانیلیون"      => 54,
+    "نانیلیارد"     => 57,
+    "دسیلیون"       => 60,
+    "دسیلیارد"      => 63,
+    "گوگول"         => 100
+  }
+end

data/lib/farsifu/convert.rb

@@ -0,0 +1,35 @@
+module FarsiFu
+  class Convert
+
+    def initialize(number)
+      @number = number
+    end
+
+    # :startdoc:
+
+    # Returns a string which is the equivalent English number of a Persian number (in String)
+    #
+    # Example:
+    #   "۱۲۳".to_english # => "123"
+    def to_english
+      self.to_s.tr(PERSIAN_CHARS,ENGLISH_CHARS)
+    end
+
+    # Returns a string which is the equivalent Persian number of an English number (in String)
+    # accepts instances of String, Integer and Numeric classes (Fixnum,Bignum and floats are accepted)
+    #
+    # alias: to_persian
+    #
+    # Example:
+    #   "123".to_farsi # => "۱۲۳"
+    #   "456".to_persian # => "۴۵۶"
+    #   789.to_farsi # => "۷۸۹"
+    def to_farsi
+      self.to_s.tr(ENGLISH_CHARS,PERSIAN_CHARS)
+    end
+
+    def to_s
+      @number.to_s
+    end
+  end
+end

data/lib/farsifu/num_to_word.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+
+module FarsiFu
+  class NumToWord
+
+    def initialize(number)
+      @number = number
+    end
+
+    # Spells a number in Persian
+    # accpets english numbers (in float,fixnum or string)
+    #
+    # Example:
+    #   5678.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
+      else
+        num_array = @number.to_i.to_s.split(//).reverse
+        return spell(num_array)
+      end
+    end
+
+    # Spells numbers in sequentional format. If pass `true`, it will use the second format
+    #
+    # Example:
+    #   1.spell_ordinal_farsi       # => "اول"
+    #   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 = "مین"
+      else
+        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
+
+      zillion = 0
+      farsi_number = []
+
+      # Dealing with Zero
+      if (num_array.length == 1 && num_array[0] == "0" )
+        farsi_number = [PERSIAN_DIGIT_SPELL[0][10]]
+        num_array = []
+      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
+
+        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
+
+        zillion += 1
+      end # End of While
+
+      sign + farsi_number.compact.join(PERSIAN_DIGIT_JOINT).strip
+    end
+
+    def make_ordinal_spell(exceptions, suffix)
+      if exceptions.include? @number
+        exceptions[@number]
+      else
+        (spell_farsi + suffix).gsub(/سه(م|مین)$/) { "سو#{$1}" }
+      end
+    end
+  end
+end

data/lib/farsifu/punch.rb

@@ -0,0 +1,40 @@
+module Convert
+  def to_farsi
+    FarsiFu::Convert.new(self).to_farsi
+  end
+  alias_method :to_persian, :to_farsi
+
+  def to_english
+    FarsiFu::Convert.new(self).to_english
+  end
+end
+
+module NumToWord
+  def spell_farsi
+    FarsiFu::NumToWord.new(self).spell_farsi
+  end
+
+  def spell_ordinal_farsi(*args)
+    FarsiFu::NumToWord.new(self).spell_ordinal_farsi(args[0])
+  end
+end
+
+module WordToNum
+  def farsi_to_number
+    FarsiFu::WordToNum.new(self).to_number
+  end
+end
+
+class String
+  include Convert
+  include WordToNum
+end
+
+class Numeric
+  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.3.0"
+  VERSION = "0.4.0"
 end

data/lib/farsifu/word_to_num.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+module FarsiFu
+  class WordToNum
+
+    def initialize(number_in_words)
+      @number_in_words = number_in_words
+    end
+
+    # It converts number represented in words to numeral.
+    # Example:
+    #   "صد و بیست و یک".to_number #=> 121
+    def to_number
+      return @number_in_words if !(@number_in_words.is_a? String)
+
+      numbers_array = make_integer_array(@number_in_words)
+
+      memory = 0
+      answer = 0
+      reset = true
+      numbers_array.each do |number|
+        if reset || !(divisible_by_thousand? number)
+          reset = false
+          memory += number
+        else
+          memory *= number
+          answer += memory
+          memory = 0
+          reset = true
+        end
+      end
+      answer += memory
+    end
+
+  private
+    # returns an array of corresponding numbers from string
+    # [1, 1000000, 200, 30, 5, 1000, 400, 30, 3]
+    def make_integer_array(number_in_words)
+      number_in_words = eliminate_and(number_in_words.strip.squeeze(" ")).split(" ")
+      numbers_array = []
+      number_in_words.each do |number|
+        if power_of_ten? number
+          numbers_array << 10 ** POWER_OF_TEN[number]
+        else
+          numbers_array << EXCEPTIONS[number]
+        end
+      end
+      numbers_array
+    end
+
+    # Removes "و" from the string
+    def eliminate_and(number_in_words)
+      number_in_words.gsub(/ و /, " ")
+    end
+
+    # Checkes if the number is power of divisible by thousand(bigger than 1000)
+    def divisible_by_thousand?(number)
+      number % 1000 == 0
+    end
+    
+    # Checks if the number is power of ten
+    def power_of_ten? number
+      POWER_OF_TEN.keys.include? number
+    end
+  end
+end