to_cardinal 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a409fff797b3bf3831c98f88117243c4ddf6d69f
-  data.tar.gz: e8899ed38425c12db26896b70c0ec491b8d86f09
+  metadata.gz: 25caab36cc87fd2583617c4d1fd2a7aed431646f
+  data.tar.gz: d1f5eb949841efb33065650a94b86298f405af04
 SHA512:
-  metadata.gz: 9d1ba97dd38e12aeb605229487b62b8bc255edb69d855751ef20f60c31cc3e36220e509b56ea2ace720db2c8895be66d8af75436feb82c329e26a8e1a03635f7
-  data.tar.gz: 4c8a591b9bc177296174b79551128e00f10558f3e15c9295d1784991707267d113c043e86d0d69e63b7f35e7ce637d1fe7372ac2b63eb191ad6286b87f992fdc
+  metadata.gz: 72f239da2537de7160f90fba0d1621c86107fa1c01e0556035feb7c5a0717507aa8e3644d9bfac4ae7235a7200e9909a4b9d12d996fad3872297f426ca849c04
+  data.tar.gz: cb7867b578188f6274f84bdfe2f0e5fd584fcb47ecf9557e96421114e605957981715d93ac00bf27ad2838e3e81bd61b3ff190e6466d59522f72fa924ca3f922

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# 0.0.2
+
+  * added CHANGELOG
+  * [ENHANCEMENT] returns default value nil
+  * [ENHANCEMENT] added more tests
+  * [ENHANCEMENT] supports conversions from 1 to 100
+  * [ENHANCEMENT] changes super case-when by more programmatic way
+  * [ENHANCEMENT] supports different kind of uses
+
+# 0.0.1
+
+  * initial version

data/README.md

@@ -2,10 +2,11 @@
 
 [![Build Status](https://travis-ci.org/edudepetris/to_cardinal.svg?branch=master)](https://travis-ci.org/edudepetris/to_cardinal)
 [![Coverage Status](https://img.shields.io/coveralls/edudepetris/to_cardinal.svg)](https://coveralls.io/r/edudepetris/to_cardinal)
+[![Gem Version](https://badge.fury.io/rb/to_cardinal.svg)](http://badge.fury.io/rb/to_cardinal)
 
 
 Ruby gem which will allow to convert from ordinal numbers to cardinal numbers.
-
+It only supports ordinals from 1 to 100.
 
 
 ## Installation
@@ -24,15 +25,62 @@ Or install it yourself as:
 
 ## Usage
 
+Please use which ever is most comfortable:
+
+You can use _ToCardinal_ without include it in a class.  
+Just require ```to_cardinal``` into your Ruby code and use ```cardinalize``` method from Module
+
 ```ruby
 require 'to_cardinal'
 
+# some ordinal numbers to cardinals
+ToCardinal.cardinalize 'first'   # => 1
+ToCardinal.cardinalize '1st'     # => 1
+ToCardinal.cardinalize 'fourth'  # => 4
+ToCardinal.cardinalize '4th'     # => 4
+```
+You can include _ToCardinal_ in String Ruby’s core library.  
+Just require ```to_cardinal/core_ext/string``` into your Ruby code and use ```String#to_cardinal``` method.
+
+```ruby
+require 'to_cardinal/core_ext/string'
+
 # some ordinal numbers to cardinals
 'first'.to_cardinal   # => 1
 '1st'.to_cardinal     # => 1
 'fourth'.to_cardinal  # => 4
 '4th'.to_cardinal     # => 4
 
+```
+You can include _ToCardinal_ in a String's sub-class.  
+Just require ```to_cardinal``` into your Ruby code and then ```include``` it in  your _sub-class_
+```ruby
+require 'to_cardinal'
+
+class A < String
+  include ToCardinal
+  ...
+end
+
+# some ordinal numbers to cardinals
+A.new('first').to_cardinal   # => 1
+A.new('1st').to_cardinal     # => 1
+A.new('fourth').to_cardinal  # => 4
+A.new('4th').to_cardinal     # => 4
+
+```
+
+If you are in **Ruby on Rails** and you want to use _ToCardinal_ like ```String#to_cardinal```. You can create an ```initializer``` file like this:
+
+```ruby
+# your_project/config/initializers/to_cardinal.rb
+require 'to_cardinal/core_ext/string'
+
+# And then you use it
+'first'.to_cardinal   # => 1
+'1st'.to_cardinal     # => 1
+'fourth'.to_cardinal  # => 4
+'4th'.to_cardinal     # => 4
 ```
 
 ## Contributing
@@ -42,3 +90,9 @@ require 'to_cardinal'
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## License
+Distributed under the [MIT license](https://github.com/edudepetris/to_cardinal/blob/master/LICENSE.txt)
+
+-------
+First of all, thank ruby community for your help! :punch:

data/lib/to_cardinal.rb

@@ -1,69 +1,2 @@
-require "to_cardinal/version"
-
-module ToCardinal
-
-  class ::String
-    def to_cardinal
-      case self.downcase
-      when 'first', '1st'
-        1
-      when 'second', '2nd'
-        2
-      when 'third', '3rd'
-        3
-      when 'fourth', '4th'
-        4
-      when 'fifth', '5th'
-        5
-      when 'sixth', '6th'
-        6
-      when 'seventh', '7th'
-        7
-      when 'eighth', '8th'
-        8
-      when 'ninth', '9th'
-        9
-      when 'tenth', '10th'
-        10
-      when 'eleventh', '11th'
-        11
-      when 'twelfth', '12th'
-        12
-      when 'thirteenth', '13th'
-        13
-      when 'fourteenth', '14th'
-        14
-      when 'fifteenth', '15th'
-        15
-      when 'sixteenth', '16th'
-        16
-      when 'seventeenth', '17th'
-        17
-      when 'eighteenth', '18th'
-        18
-      when 'nineteenth', '19th'
-        19
-      when 'twentieth', '20th'
-        20
-      when 'thirtieth', '30th'
-        30
-      when 'fortieth', '40th'
-        40
-      when 'fiftieth', '50th'
-        50
-      when 'sixtieth', '60th'
-        60
-      when 'seventieth', '70th'
-        70
-      when 'eightieth', '80th'
-          80
-      when 'ninetieth', '90th'
-        90
-      when 'hundredth', '100th'
-        100
-      else
-        -1
-      end
-    end
-  end
-end
+require 'to_cardinal/version'
+require 'to_cardinal/cardinalize'

data/lib/to_cardinal/cardinalize.rb

@@ -0,0 +1,67 @@
+module ToCardinal
+  EXPLICITS = {
+    'first'         => 1,
+    'second'        => 2,
+    'third'         => 3,
+    'ninth'         => 9,
+    'eleventh'      => 11,
+    'twelfth'       => 12,
+    'twentieth'     => 20,
+    'thirtieth'     => 30,
+    'fortieth'      => 40,
+    'fiftieth'      => 50,
+    'sixtieth'      => 60,
+    'seventieth'    => 70,
+    'eightieth'     => 80,
+    'ninetieth'     => 90,
+    'one hundredth' => 100
+  }
+
+  REGULARS = {
+    'thir'  => 3,
+    'four'  => 4,
+    'fif'   => 5,
+    'six'   => 6,
+    'seven' => 7,
+    'eigh'  => 8,
+    'nine'  => 9,
+    'ten'   => 10
+  }
+
+  TENS = {
+    'twenty'  => 20,
+    'thirty'  => 30,
+    'forty'   => 40,
+    'fifty'   => 50,
+    'sixty'   => 60,
+    'seventy' => 70,
+    'eighty'  => 80,
+    'ninety'  => 90
+  }
+
+  EXPLICIT_MATCHES = Hash[REGULARS.map {|k, v| [k.to_s + 'th', v] }].merge EXPLICITS
+  TENS_MATCH       = /(#{TENS.keys.join '|'})-/
+  ORDINAL          = /^(\d+)(?:st|nd|rd|th)$/
+
+  def self.cardinalize(str)
+    str.downcase!
+
+    ordinal          = str[ORDINAL, 1]
+    explicit_matches = EXPLICIT_MATCHES[str]
+    regular_match    = str[/^(.+)teenth$/, 1]
+
+    return ordinal.to_i if ordinal
+    return explicit_matches if explicit_matches
+    return 10 + REGULARS[regular_match] if regular_match
+
+    if tens = str[TENS_MATCH, 1]
+      sum = TENS[tens]
+      str.sub! "#{tens}-", ''
+      EXPLICIT_MATCHES.has_key?(str) ? sum + EXPLICIT_MATCHES[str] : nil
+    end
+  end
+
+  def to_cardinal
+    ToCardinal.cardinalize self
+  end
+end

data/lib/to_cardinal/core_ext/string.rb

@@ -0,0 +1,7 @@
+require 'to_cardinal'
+
+if String.method_defined? :to_cardinal
+  $stderr.puts " **WARNING: Possible conflict with ToCardinal extension:\ \b
+    String#to_cardinal already exits."
+end
+String.send :include, ToCardinal

data/lib/to_cardinal/version.rb

@@ -1,3 +1,3 @@
 module ToCardinal
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/lib/to_cardinal_spec.rb

@@ -1,19 +1,11 @@
 require 'spec_helper'
 
 describe ToCardinal do
-  cardinals = [
-    1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18,
-    19, 20, 30, 40, 50, 60, 70, 80, 90, 100]
+  Linguistics.use :en
 
-  full_ordinals = %w'
-    first second third fourth fifth sixth seventh eighth ninth
-    tenth eleventh twelfth thirteenth fourteenth fifteenth sixteenth
-    seventeenth eighteenth nineteenth twentieth thirtieth fortieth fiftieth
-    sixtieth seventieth eightieth ninetieth hundredth'
-
-  abbreviation_ordinal = %w'
-    1st 2nd 3rd 4th 5th 6th 7th 8th 9th 10th 11th 12th 13th 14th 15th
-    16th 17th 18th 19th 20th 30th 40th 50th 60th 70th 80th 90th 100th'
+  cardinals            = (1..100).to_a
+  full_ordinals        = cardinals.map { |c| c.en.numwords.en.ordinal }
+  abbreviation_ordinal = cardinals.map { |c| c.en.ordinal }
 
   full_ordinals.each_with_index do |ordinal, index|
     cardinal = cardinals[index]
@@ -31,8 +23,7 @@ describe ToCardinal do
     end
   end
 
-  it 'converts by default to -1' do
-    expect('anything'.to_cardinal).to eq -1
+  it 'converts to nil when it is not an ordinal' do
+    expect('anything'.to_cardinal).to be_nil
   end
-
 end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
-require 'to_cardinal'
 require 'coveralls'
 Coveralls.wear!
-
+require 'to_cardinal'
+require 'to_cardinal/core_ext/string'
+require 'linguistics'

data/to_cardinal.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'to_cardinal/version'
@@ -18,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_development_dependency "linguistics", "2.0.2"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.4"
   spec.add_development_dependency "rspec", "~> 3.1"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: to_cardinal
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - edu depetris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-08 00:00:00.000000000 Z
+date: 2014-12-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: linguistics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -76,11 +90,14 @@ files:
 - ".coveralls.yml"
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/to_cardinal.rb
+- lib/to_cardinal/cardinalize.rb
+- lib/to_cardinal/core_ext/string.rb
 - lib/to_cardinal/version.rb
 - spec/lib/to_cardinal_spec.rb
 - spec/spec_helper.rb