farsifu 0.2.2 → 0.3.0

data/Gemfile.lock

@@ -1,25 +1,25 @@
 PATH
   remote: .
   specs:
-    farsifu (0.2.1)
+    farsifu (0.3.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.1.2)
-    rspec (2.1.0)
-      rspec-core (~> 2.1.0)
-      rspec-expectations (~> 2.1.0)
-      rspec-mocks (~> 2.1.0)
-    rspec-core (2.1.0)
-    rspec-expectations (2.1.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.1.0)
+    diff-lcs (1.1.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
+  bundler (~> 1.2.0)
   farsifu!
-  rspec (~> 2.1.0)
+  rspec (~> 2.12.0)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Allen A. Bargi
+Copyright (c) 2009-2013 Allen A. Bargi
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -3,18 +3,22 @@ farsifu is a toolbox for developing ruby applications in Persian (Farsi) languag
 
 ## Features
 * Converting numbers to Persian numbers
-* Spelling numbers in Persian
+* Spelling numbers in Persian (also support ordinal spelling)
 * List of Iran's provinces, cities, counties
 * List of countries in Persian
 
 ## Examples:
+``` ruby
     "1234567890,;".to_farsi   # => "۱۲۳۴۵۶۷۸۹۰،؛"
     "۱۲۳۴۵۶۷۸۹۰،؛".to_english # => "1234567890,;"
     1024.spell_farsi          # => "یک هزار و بیست و چهار"
     -2567023.spell_farsi      # => "منفی دو میلیون و پانصد و شصت و هفت هزار و بیست و سه"
     7.53.spell_farsi          # => "هفت ممیز پنجاه و سه صدم"
     -0.999.spell_farsi        # => "منفی صفر ممیز نهصد و نود و نه هزارم"
-    
+    12.spell_ordinal_farsi    # => "دوازدهم"
+    12.spell_ordinal_farsi(true)    # => "دوازدهمین"
+
+
     Iran::Provinces
     # => returns an array of hashes like below
     # [{:name => "آذربایجان شرقی", :eng_name => "Azerbaijan, East",
@@ -24,11 +28,16 @@ farsifu is a toolbox for developing ruby applications in Persian (Farsi) languag
     Iran::Countries
     # => returns an array of hashes like below
     # [ { :iso2 => 'AI', :fa => 'آنگیل', :en => 'Anguilla' }, ...]
+```
 
 ## Install
     gem install farsifu
 
 ## History
+### 0.3.0 - 28.JAN.2013
+* added farsi ordinal spelling, courtesy of Arash Mousavi
+
+
 ### 0.2.2 - 11.APR.2011
 * added ruby 1.9 compatibility, courtesy of Brian Kaney 
 
@@ -63,4 +72,4 @@ farsifu is a toolbox for developing ruby applications in Persian (Farsi) languag
 
 ## Copyright
 
-Copyright (c) 2010 Allen Bargi. See LICENSE for details.
+Copyright (c) 2009-2013 Allen Bargi. See LICENSE for details.

data/farsifu.gemspec

@@ -19,6 +19,6 @@ Gem::Specification.new do |s|
   s.require_paths             = ["lib"]
   s.extra_rdoc_files          = [ "LICENSE", "README.md"]
   s.rdoc_options              = ["--charset=UTF-8"]
-  s.add_development_dependency(%q<rspec>, ["~> 2.1.0"])
-  s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+  s.add_development_dependency(%q<rspec>, ["~> 2.12.0"])
+  s.add_development_dependency(%q<bundler>, ["~> 1.2.0"])
 end

data/lib/farsifu/version.rb

@@ -1,3 +1,3 @@
 module FarsiFu
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/farsifu.rb

@@ -66,6 +66,25 @@ module FarsiFu
         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
@@ -107,6 +126,14 @@ module FarsiFu
       sign + farsi_number.compact.join(PERSIAN_DIGIT_JOINT).strip
     end
 
+    def make_ordinal_spell(exceptions, suffix)
+      if exceptions.include? self
+        exceptions[self]
+      else
+        (spell_farsi + suffix).gsub(/سه(م|مین)$/) { "سو#{$1}" }
+      end
+    end
+
     end
   end
 

data/spec/farsifu_spec.rb

@@ -3,12 +3,12 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Farsifu" do
-  
+
   before(:all) do
     PERSIAN_CHARS = "۱۲۳۴۵۶۷۸۹۰،؛"
     ENGLISH_CHARS = "1234567890,;"
   end
-  
+
   it "should convert English numbers to Persian numbers" do
     ENGLISH_CHARS.to_farsi.should == PERSIAN_CHARS
   end
@@ -21,13 +21,27 @@ describe "Farsifu" do
     1024.spell_farsi.should == "یک هزار و بیست و چهار"
     -2567023.spell_farsi.should == "منفی دو میلیون و پانصد و شصت و هفت هزار و بیست و سه"
   end
-  
+
   it "should be able to spell positive and negetive floats in Persian" do
     45.5.spell_farsi.should == "چهل و پنج ممیز پنج دهم"
     7.53.spell_farsi.should == "هفت ممیز پنجاه و سه صدم"
-    0.163.spell_farsi.should == "صفر ممیز صد و شصت و سه هزارم"    
+    0.163.spell_farsi.should == "صفر ممیز صد و شصت و سه هزارم"
     -124.1.spell_farsi.should == "منفی صد و بیست و چهار ممیز یک دهم"
     -0.999.spell_farsi.should == "منفی صفر ممیز نهصد و نود و نه هزارم"
   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|
+      k.spell_ordinal_farsi.should == v
+    end
+  end
+
+  it "should be able to show second type of sequentional numbers to persian" do
+    nums = {0 => "صفر",1 => "اولین", 3 => "سومین", 12 => "دوازدهمین", 33 => "سی و سومین", 121=> "صد و بیست و یکمین"}
+    nums.each do |k, v|
+      k.spell_ordinal_farsi(true).should == v
+    end
+  end
+
 end

metadata

@@ -1,71 +1,63 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: farsifu
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 0.3.0
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 2
-  version: 0.2.2
 platform: ruby
-authors: 
+authors:
 - Allen A. Bargi
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-04-11 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 2
-        - 1
-        - 0
-        version: 2.1.0
+      - !ruby/object:Gem::Version
+        version: 2.12.0
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
+      - !ruby/object:Gem::Version
+        version: 1.2.0
   type: :development
-  version_requirements: *id002
-description: a toolbox for developing ruby applications in Persian (Farsi) language, see readme file for features
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: a toolbox for developing ruby applications in Persian (Farsi) language,
+  see readme file for features
 email: allen.bargi@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.md
-files: 
+files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- TODO
 - farsifu.gemspec
 - lib/farsifu.rb
 - lib/farsifu/version.rb
@@ -73,37 +65,30 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/aziz/farsifu
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: farsifu
-rubygems_version: 1.7.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: a toolbox for developing ruby applications in Persian (Farsi) language, see readme file for features
-test_files: 
+summary: a toolbox for developing ruby applications in Persian (Farsi) language, see
+  readme file for features
+test_files:
 - spec/farsifu_spec.rb
 - spec/spec_helper.rb