ordinalize_full 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7174b3e018cd6b0f1b7b41a7d30fe3994726c81029d6c197e46184a58ed3e690
-  data.tar.gz: d76be4c1a6205e4e5c62e4d32d776281cda48d120bf05d78778ccb3383d78ae8
+  metadata.gz: 1bda61add4fd3128ed94f20453da91e0f6eba3a6d059337fcea89f46c62da5ea
+  data.tar.gz: 6cdd96377f7bf331988ce2582df9f76edf3efb1dea9d30e28cac83e407df5737
 SHA512:
-  metadata.gz: a39b56d13c8026e98a2e08eec3fdc01152d60becd2942b1cb183bf56cf43524d1b5520e75cc9568948d371fc5e376ab61024c54d0ef903aa0a727b0ba0a184e1
-  data.tar.gz: 672aed32b546b3346dd305008493d0665c83595ebb7b22f6ac9f1c20feffff0025928df0103fd8d12283da073e074a3ea8b4274ac60439b34f39add6c1e7222d
+  metadata.gz: dafd8477c203a68bf52c7d2de4efc2b4214472a2481e41a6f03d038d3f744c5c219064ebb81aa1b81c16be7cce9b553c12e4efb41d4a916b801257e2927818f9
+  data.tar.gz: 9c266342468cd4978deaab0eb429e8551ba6d3707b13e0884b8eef872710e9c59fd03d680fab0cd9e1216366ed8dc0d5d53eaa6e8f72352914fb49d94a3a89b9

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+github: infertux
+liberapay: infertux
+patreon: infertux

data/.github/workflows/rubocop.yml

@@ -1,17 +1,26 @@
 name: RuboCop
 
-on: [push, pull_request]
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+  schedule:
+    - cron: "0 0 1 * *" # first day of every month
+
+permissions:
+  contents: read
 
 jobs:
   lint:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.2
-        bundler-cache: true # 'bundle install' and cache
-    - name: Run RuboCop
-      run: bundle exec rubocop --parallel
+      - uses: actions/checkout@v6
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby # latest stable release
+          bundler-cache: true # 'bundle install' and cache
+      - name: Run RuboCop
+        run: bundle exec rubocop --parallel

data/.github/workflows/tests.yml

@@ -1,6 +1,15 @@
 name: Tests
 
-on: [push, pull_request]
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+  schedule:
+    - cron: "0 0 1 * *" # first day of every month
+
+permissions:
+  contents: read
 
 jobs:
   test:
@@ -11,16 +20,17 @@ jobs:
       matrix:
         ruby-version:
           - head
-          - '3.2'
-          - '3.1'
-          - '3.0'
+          - "4.0"
+          - "3.4"
+          - "3.3"
+          - "3.2"
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby ${{ matrix.ruby-version }}
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # 'bundle install' and cache
-    - name: Run tests
-      run: bundle exec rake
+      - uses: actions/checkout@v6
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # 'bundle install' and cache
+      - name: Run tests
+        run: bundle exec rake

data/.rubocop.yml

@@ -1,37 +1,22 @@
-require:
+plugins:
   - rubocop-rake
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.2
   NewCops: enable
 
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
 Metrics:
   Enabled: false
 
 Layout/AccessModifierIndentation:
   EnforcedStyle: outdent
 
-Layout/CaseIndentation:
-  Enabled: false
-
-Layout/EndAlignment:
-  Enabled: false
-
-Layout/EmptyLinesAroundArguments:
-  Enabled: false
-
-Layout/LineLength:
-  Enabled: false
-
 Style/Alias:
   EnforcedStyle: prefer_alias_method
 
-Style/Documentation:
-  Enabled: false
-
 Style/StringLiterals:
   EnforcedStyle: double_quotes
-
-Style/SpecialGlobalVars:
-  Enabled: false

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2023 Cédric Félizard
+Copyright (c) 2014-2026 Cédric Félizard
 
 MIT License
 

data/README.md

@@ -8,9 +8,8 @@ Like Rails' [ordinalize](http://api.rubyonrails.org/classes/ActiveSupport/Inflec
 Features:
 
 - i18n support
-- doesn't monkey-patch
+- doesn't require monkey-patching
 - easy to integrate with Rails but doesn't require Rails
-- less than 50 lines of code
 
 ## Usage
 
@@ -49,6 +48,9 @@ MyIntegerLikeClass.new.ordinalize_in_full #=> "forty second"
 
 ## Limitations
 
-- only works up to 100 (for now)
+- only works up to 100 for non-English languages
 - locales only available in English, French, Italian, Spanish, and Dutch (pull requests welcome!)
 
+## License
+
+`SPDX-License-Identifier: MIT`

data/Rakefile

@@ -10,11 +10,4 @@ end
 require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
-require "cane/rake_task"
-Cane::RakeTask.new do |t|
-  t.no_doc = true
-  t.style_measure = 120
-  t.abc_max = 20
-end
-
-task default: %i[spec rubocop cane]
+task default: %i[spec rubocop]

data/lib/ordinalize_full/locales/en.yml

@@ -1,102 +1,72 @@
 en:
-  ordinalize_full:
-    n_1: first
-    n_2: second
-    n_3: third
-    n_4: fourth
-    n_5: fifth
-    n_6: sixth
-    n_7: seventh
-    n_8: eighth
-    n_9: ninth
-    n_10: tenth
-    n_11: eleventh
-    n_12: twelfth
-    n_13: thirteenth
-    n_14: fourteenth
-    n_15: fifteenth
-    n_16: sixteenth
-    n_17: seventeenth
-    n_18: eighteenth
-    n_19: nineteenth
-    n_20: twentieth
-    n_21: twenty first
-    n_22: twenty second
-    n_23: twenty third
-    n_24: twenty fourth
-    n_25: twenty fifth
-    n_26: twenty sixth
-    n_27: twenty seventh
-    n_28: twenty eighth
-    n_29: twenty ninth
-    n_30: thirtieth
-    n_31: thirty first
-    n_32: thirty second
-    n_33: thirty third
-    n_34: thirty fourth
-    n_35: thirty fifth
-    n_36: thirty sixth
-    n_37: thirty seventh
-    n_38: thirty eighth
-    n_39: thirty ninth
-    n_40: fortieth
-    n_41: forty first
-    n_42: forty second
-    n_43: forty third
-    n_44: forty fourth
-    n_45: forty fifth
-    n_46: forty sixth
-    n_47: forty seventh
-    n_48: forty eighth
-    n_49: forty ninth
-    n_50: fiftieth
-    n_51: fifty first
-    n_52: fifty second
-    n_53: fifty third
-    n_54: fifty fourth
-    n_55: fifty fifth
-    n_56: fifty sixth
-    n_57: fifty seventh
-    n_58: fifty eighth
-    n_59: fifty ninth
-    n_60: sixtieth
-    n_61: sixty first
-    n_62: sixty second
-    n_63: sixty third
-    n_64: sixty fourth
-    n_65: sixty fifth
-    n_66: sixty sixth
-    n_67: sixty seventh
-    n_68: sixty eighth
-    n_69: sixty ninth
-    n_70: seventieth
-    n_71: seventy first
-    n_72: seventy second
-    n_73: seventy third
-    n_74: seventy fourth
-    n_75: seventy fifth
-    n_76: seventy sixth
-    n_77: seventy seventh
-    n_78: seventy eighth
-    n_79: seventy ninth
-    n_80: eightieth
-    n_81: eighty first
-    n_82: eighty second
-    n_83: eighty third
-    n_84: eighty fourth
-    n_85: eighty fifth
-    n_86: eighty sixth
-    n_87: eighty seventh
-    n_88: eighty eighth
-    n_89: eighty ninth
-    n_90: ninetieth
-    n_91: ninety first
-    n_92: ninety second
-    n_93: ninety third
-    n_94: ninety fourth
-    n_95: ninety fifth
-    n_96: ninety sixth
-    n_97: ninety seventh
-    n_98: ninety eighth
-    n_99: ninety ninth
-    n_100: one hundredth
+  long_form:
+    negative: negative
+    simple:
+      ones:
+        n_0: zero
+        n_1: one
+        n_2: two
+        n_3: three
+        n_4: four
+        n_5: five
+        n_6: six
+        n_7: seven
+        n_8: eight
+        n_9: nine
+        n_10: ten
+        n_11: eleven
+        n_12: twelve
+        n_13: thirteen
+        n_14: fourteen
+        n_15: fifteen
+        n_16: sixteen
+        n_17: seventeen
+        n_18: eighteen
+        n_19: nineteen
+      tens:
+        n_2: twenty
+        n_3: thirty
+        n_4: forty
+        n_5: fifty
+        n_6: sixty
+        n_7: seventy
+        n_8: eighty
+        n_9: ninety
+      hundred: hundred
+      larger:
+        n_0: ""
+        n_1: thousand
+        n_2: million
+        n_3: billion
+        n_4: trillion
+    ordinal:
+      ones:
+        n_0: zeroth
+        n_1: first
+        n_2: second
+        n_3: third
+        n_4: fourth
+        n_5: fifth
+        n_6: sixth
+        n_7: seventh
+        n_8: eighth
+        n_9: ninth
+        n_10: tenth
+        n_11: eleventh
+        n_12: twelfth
+        n_13: thirteenth
+        n_14: fourteenth
+        n_15: fifteenth
+        n_16: sixteenth
+        n_17: seventeenth
+        n_18: eigthteenth
+        n_19: nineteenth
+      tens:
+        n_2: twentieth
+        n_3: thirtieth
+        n_4: fortieth
+        n_5: fiftieth
+        n_6: sixtieth
+        n_7: seventieth
+        n_8: eightieth
+        n_9: ninetieth

data/lib/ordinalize_full.rb

@@ -2,6 +2,7 @@
 
 require "i18n"
 
+# Main module
 module OrdinalizeFull
   I18n.load_path += Dir[File.join(__dir__, "ordinalize_full/locales/*.yml")]
 
@@ -35,7 +36,11 @@ module OrdinalizeFull
 
       value
     else
-      I18n.t("ordinalize_full.n_#{self}", throw: true)
+      begin
+        integer_to_long_form_ordinal
+      rescue ArgumentError
+        I18n.t("ordinalize_full.n_#{self}", throw: true)
+      end
     end
   rescue ArgumentError
     raise NotImplementedError, "Unknown locale #{I18n.locale}"
@@ -47,40 +52,106 @@ private
 
   def ordinalize_in_short(gender: :masculine, plurality: :singular)
     abs_number = to_i.abs
-    suffix = case I18n.locale
-    when :en
-      if (11..13).cover?(abs_number % 100)
-        "th"
-      else
-        case abs_number % 10
-        when 1 then "st"
-        when 2 then "nd"
-        when 3 then "rd"
-        else "th"
+    suffix =
+      case I18n.locale
+      when :en
+        if (11..13).cover?(abs_number % 100)
+          "th"
+        else
+          case abs_number % 10
+          when 1 then "st"
+          when 2 then "nd"
+          when 3 then "rd"
+          else "th"
+          end
+        end
+      when :fr
+        self == 1 ? "er" : "ème"
+      when :it
+        "°"
+      when :nl
+        [8, 1, 0].include?(self % 100) || self % 100 > 19 ? "ste" : "de"
+      when :es
+        value = ordinalize_in_full(gender: gender, plurality: plurality)
+
+        if value.end_with?("er")
+          ".ᵉʳ"
+        elsif value.end_with?("a")
+          ".ᵃ"
+        elsif value.end_with?("o")
+          ".ᵒ"
+        elsif value.end_with?("os")
+          ".ᵒˢ"
+        elsif value.end_with?("as")
+          ".ᵃˢ"
         end
       end
-    when :fr
-      self == 1 ? "er" : "ème"
-    when :it
-      "°"
-    when :nl
-      [8, 1, 0].include?(self % 100) || self % 100 > 19 ? "ste" : "de"
-    when :es
-      value = ordinalize_in_full(gender: gender, plurality: plurality)
-
-      if value.end_with?("er")
-        ".ᵉʳ"
-      elsif value.end_with?("a")
-        ".ᵃ"
-      elsif value.end_with?("o")
-        ".ᵒ"
-      elsif value.end_with?("os")
-        ".ᵒˢ"
-      elsif value.end_with?("as")
-        ".ᵃˢ"
+
+    [self, suffix].join
+  end
+
+  # Build the long form of a given number. In this context, it is used for every digit except the last two.
+  # @param number [Integer] - A number to write in long form
+  # @return [String] - The long form of a number
+  def number_to_word(number)
+    if number.zero?
+      I18n.t("long_form.simple.ones.n_0", throw: true)
+    elsif number < 20
+      I18n.t("long_form.simple.ones.n_#{number}", throw: true)
+    elsif number < 100
+      [
+        I18n.t("long_form.simple.tens.n_#{number / 10}", throw: true),
+        (number % 10).zero? ? "" : "-#{I18n.t("long_form.simple.ones.n_#{number % 10}", throw: true)}"
+      ].join
+    elsif number < 1000
+      [
+        I18n.t("long_form.simple.ones.n_#{number / 100}", throw: true),
+        " ",
+        I18n.t("long_form.simple.hundred", throw: true),
+        (number % 100).zero? ? "" : " and #{number_to_word(number % 100)}"
+      ].join
+    else
+      i = 0
+      meow = number
+      while meow >= 1000
+        meow /= 1000
+        i += 1
       end
+      the_one_tenth = number % (10**(3 * i))
+      [
+        number_to_word(meow),
+        " ",
+        i.positive? ? I18n.t("long_form.simple.larger.n_#{i}", throw: true) : "",
+        the_one_tenth.zero? ? "" : " #{number_to_word(the_one_tenth)}"
+      ].join
     end
+  end
 
-    [self, suffix].join
+  # Builds the ordinalized version of a number. Specific to english. Really only the two least significant digits are
+  # ordinalized, and the rest are just in long format
+  # @param number [Integer] - A number to ordinalize in long form
+  # @return [String] - The long form of a number as an ordinal
+  def number_to_ordinal_word(number)
+    if number.zero?
+      I18n.t("long_form.ordinal.ones.n_0", throw: true)
+    elsif number < 20
+      I18n.t("long_form.ordinal.ones.n_#{number}", throw: true)
+    elsif number < 100 && (number % 10).zero?
+      I18n.t("long_form.ordinal.tens.n_#{number / 10}", throw: true)
+    elsif number < 100
+      "#{number_to_word(number - (number % 10))}-#{I18n.t("long_form.ordinal.ones.n_#{number % 10}", throw: true)}"
+    elsif number >= 100 && (number % 100).zero?
+      "#{number_to_word(number - (number % 100))}th"
+    else
+      "#{number_to_word(number - (number % 100))} and #{number_to_ordinal_word(number % 100)}"
+    end
+  end
+
+  # Builds the long form ordinal of an integer
+  # @return [String] - The long form ordinal of an integer (including negative)
+  def integer_to_long_form_ordinal
+    return "#{I18n.t('long_form.negative', throw: true)} #{number_to_ordinal_word(-self)}" if negative?
+
+    number_to_ordinal_word(self)
   end
 end

data/ordinalize_full.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "ordinalize_full"
-  spec.version       = "3.0.0"
+  spec.version       = "4.0.0"
   spec.authors       = ["Cédric Félizard"]
   spec.email         = ["cedric@felizard.fr"]
   spec.summary       = "Turns a number into an ordinal string such as first, second, third or 1st, 2nd, 3rd."
@@ -13,16 +13,15 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/infertux/ordinalize_full"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($/) # rubocop:disable Style/SpecialGlobalVars
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 3.0.0"
+  spec.required_ruby_version = ">= 3.2.0"
 
   spec.add_dependency "i18n", "~> 1.8"
 
   spec.add_development_dependency "bundler", ">= 1.5"
-  spec.add_development_dependency "cane"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3"
   spec.add_development_dependency "rubocop"

data/spec/ordinalize_full_spec.rb

@@ -8,10 +8,18 @@ describe OrdinalizeFull do
       before { I18n.locale = :en }
 
       specify { expect(1.ordinalize_in_full).to eq("first") }
-      specify { expect(42.ordinalize_in_full).to eq("forty second") }
+      specify { expect(42.ordinalize_in_full).to eq("forty-second") }
+      specify { expect(2023.ordinalize_in_full).to eq("two thousand and twenty-third") }
+      specify { expect(2_147_483_647.ordinalize_in_full).to eq("two billion one hundred and forty-seven million four hundred and eighty-three thousand six hundred and forty-seventh") } # rubocop:disable Layout/LineLength
+
+      it "converts any number" do
+        10.times do
+          expect { rand(1_000_000).ordinalize_in_full }.not_to raise_error
+        end
+      end
 
-      it "raises with unknown numbers" do
-        expect { 101.ordinalize_in_full }.to raise_error(NotImplementedError)
+      it "handles negatives too" do
+        expect(-273.ordinalize_in_full).to eq("negative two hundred and seventy-third")
       end
     end
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ordinalize_full
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Cédric Félizard
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -38,20 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: cane
-  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -130,6 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".github/workflows/rubocop.yml"
 - ".github/workflows/tests.yml"
 - ".gitignore"
@@ -152,7 +138,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -160,15 +145,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 4.0.17
 specification_version: 4
 summary: Turns a number into an ordinal string such as first, second, third or 1st,
   2nd, 3rd.