string_to_number 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94ccd123e31951522c7960a5140affb629f331e8f862e3f0336c3c15c2c86bcc
-  data.tar.gz: b2d95e4cd38fda267ed0f73399c5af5b5e511d9f9f2baba3e14f349e6da4bf7b
+  metadata.gz: a97e2a69e72adda0aeedace8ab5a9ddae63c1a4741846d6d405a0ef767bdaaaa
+  data.tar.gz: 78553f4c606a717c8bab939e24b18ddd023a8962b902d2fea75b03498b2e3e0a
 SHA512:
-  metadata.gz: 604ed5a2557ceb9813fee18765e0aacc33bdc6fd7a721f5d97568c65995a8e9d5609ff17eb2a44412b381a8ac10822ee602633ad9b5a0e67a984b4de0f33aba4
-  data.tar.gz: bdff30862931f8d0d28d0c15ccf36b70056fe65c3b588c619c9452c7f92a4a732569ac4925e68af88fe67682f49854aa809b7468ee7d81005b44fd33b1c537ba
+  metadata.gz: 1042d45f537afc86b43883d29a3ef03ffd3ddc365a37c85843bd78fa54c4d35178c140e32c025d7406681dc31d77c06b7f7e526e4255fef1629a468a7ddf1958
+  data.tar.gz: 1f6b2b1e8dc6c17bf72d0ce759da2fe31dd9771188ae6087b23774b06e55f9678ee8bcc049c611ff8b0a68d9b99c8b3cb3088e28f342ae1f0d842cd618cf81da

data/.github/workflows/ci.yml

@@ -0,0 +1,83 @@
+name: CI
+
+on:
+  push:
+    branches: [ master, main ]
+  pull_request:
+    branches: [ master, main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1', '3.2', '3.3']
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+
+    - name: Run tests
+      run: bundle exec rake spec
+
+    - name: Run performance tests
+      run: bundle exec rspec spec/performance_spec.rb
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.3'
+        bundler-cache: true
+
+    - name: Install RuboCop
+      run: gem install rubocop
+
+    - name: Run RuboCop
+      run: rubocop --format github
+
+  security:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.3'
+        bundler-cache: true
+
+    - name: Install bundler-audit
+      run: gem install bundler-audit
+
+    - name: Run bundler-audit
+      run: bundle audit --update
+
+  gem-build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.3'
+        bundler-cache: true
+
+    - name: Build gem
+      run: gem build string_to_number.gemspec
+
+    - name: Install gem locally
+      run: gem install string_to_number-*.gem
+
+    - name: Test gem installation
+      run: ruby -e "require 'string_to_number'; puts StringToNumber.in_numbers('vingt et un')"

data/.rubocop.yml

@@ -0,0 +1,110 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'
+    - 'pkg/**/*'
+    - 'tmp/**/*'
+    - 'bin/**/*'
+    - 'spec/fixtures/**/*'
+  SuggestExtensions: false
+
+# Prefer double quotes for strings
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+# Allow longer lines for readability
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - 'spec/**/*'
+
+# Allow longer methods for complex parsing logic
+Metrics/MethodLength:
+  Max: 25
+  Exclude:
+    - 'spec/**/*'
+    - 'benchmark.rb'
+    - 'microbenchmark.rb'
+    - 'performance_comparison.rb'
+    - 'lib/string_to_number/parser.rb'
+    - 'lib/string_to_number/to_number.rb'
+
+# Allow longer classes for main implementation
+Metrics/ClassLength:
+  Max: 250
+
+# Allow longer blocks for test files
+Metrics/BlockLength:
+  Max: 300
+  Exclude:
+    - 'spec/**/*'
+
+# Allow more complex methods in parser
+Metrics/CyclomaticComplexity:
+  Max: 12
+  Exclude:
+    - 'benchmark.rb'
+    - 'microbenchmark.rb'
+    - 'performance_comparison.rb'
+    - 'lib/string_to_number/parser.rb'
+    - 'lib/string_to_number/to_number.rb'
+
+# Allow higher ABC size for parsing methods
+Metrics/AbcSize:
+  Max: 20
+  Exclude:
+    - 'spec/**/*'
+    - 'benchmark.rb'
+    - 'microbenchmark.rb'
+    - 'performance_comparison.rb'
+    - 'lib/string_to_number/parser.rb'
+    - 'lib/string_to_number/to_number.rb'
+
+# Allow higher perceived complexity for performance-critical methods
+Metrics/PerceivedComplexity:
+  Max: 8
+  Exclude:
+    - 'benchmark.rb'
+    - 'microbenchmark.rb'
+    - 'performance_comparison.rb'
+    - 'lib/string_to_number/parser.rb'
+    - 'lib/string_to_number/to_number.rb'
+
+# Allow multiple assignments for performance reasons
+Style/ParallelAssignment:
+  Enabled: false
+
+# Allow guard clauses without else
+Style/GuardClause:
+  Enabled: false
+
+# Documentation requirements
+Style/Documentation:
+  Enabled: false
+
+# Allow frozen string literal comments
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+
+
+# Layout preferences
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: aligned
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: aligned
+
+# Naming conventions
+Naming/PredicatePrefix:
+  ForbiddenPrefixes:
+    - is_
+
+# Allow single line methods
+Style/SingleLineMethods:
+  AllowIfMethodIsEmpty: true
+
+# Gem specific rules
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/Gemfile

@@ -1,4 +1,13 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in string_to_number.gemspec
 gemspec
+
+group :development do
+  gem 'bundler'
+  gem 'rake'
+  gem 'rspec'
+  gem 'rubocop', '~> 1.21'
+end

data/Gemfile.lock

@@ -1,13 +1,25 @@
 PATH
   remote: .
   specs:
-    string_to_number (0.2.0)
+    string_to_number (0.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.3)
     diff-lcs (1.5.0)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
     rake (13.0.6)
+    regexp_parser (2.10.0)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
       rspec-expectations (~> 3.11.0)
@@ -21,6 +33,24 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.1)
+    rubocop (1.77.0)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.45.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.45.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
 
 PLATFORMS
   x86_64-linux
@@ -29,6 +59,7 @@ DEPENDENCIES
   bundler
   rake
   rspec
+  rubocop (~> 1.21)
   string_to_number!
 
 BUNDLED WITH

data/README.md

@@ -1,8 +1,12 @@
-# StringToNumber
-
-[![Gem Version](https://badge.fury.io/rb/string_to_number.svg)](https://badge.fury.io/rb/string_to_number)
-[![Ruby](https://github.com/FabienPiette/string_to_number/workflows/Ruby/badge.svg)](https://github.com/FabienPiette/string_to_number/actions)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+<div align="center">
+  <img src="logo.png" alt="StringToNumber Logo" width="200" height="200">
+  
+  # StringToNumber
+  
+  [![Gem Version](https://badge.fury.io/rb/string_to_number.svg)](https://badge.fury.io/rb/string_to_number)
+  [![Ruby](https://github.com/FabienPiette/string_to_number/workflows/Ruby/badge.svg)](https://github.com/FabienPiette/string_to_number/actions)
+  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+</div>
 
 A high-performance Ruby gem for converting French written numbers into their numeric equivalents. Features intelligent caching, thread-safe operations, and support for complex French number formats.
 

data/Rakefile

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task default: :spec
+task default: %i[rubocop spec]
 
 task :env, [:env] do |_t, _args|
   require 'string_to_number'

data/benchmark.rb

@@ -10,8 +10,8 @@ require 'benchmark'
 class StringToNumberBenchmark
   # Test data organized by complexity
   TEST_CASES = {
-    simple: [
-      'un', 'vingt', 'cent', 'mille'
+    simple: %w[
+      un vingt cent mille
     ],
     medium: [
       'vingt et un', 'deux cent cinquante', 'mille deux cent'
@@ -20,20 +20,20 @@ class StringToNumberBenchmark
       'trois milliards cinq cents millions',
       'soixante-quinze million trois cent quarante six mille sept cent quatre-vingt-dix neuf'
     ],
-    edge_cases: [
-      'VINGT', 'une', 'septante', 'quatre-vingts'
+    edge_cases: %w[
+      VINGT une septante quatre-vingts
     ]
   }.freeze
 
   def self.run_benchmark
-    puts "StringToNumber Performance Benchmark"
-    puts "=" * 50
+    puts 'StringToNumber Performance Benchmark'
+    puts '=' * 50
     puts "Ruby version: #{RUBY_VERSION}"
     puts "Platform: #{RUBY_PLATFORM}"
     puts
 
     # Warm up
-    puts "Warming up..."
+    puts 'Warming up...'
     TEST_CASES.values.flatten.each { |text| StringToNumber.in_numbers(text) }
     puts
 
@@ -41,7 +41,7 @@ class StringToNumberBenchmark
 
     TEST_CASES.each do |category, test_cases|
       puts "#{category.to_s.capitalize} Numbers:"
-      puts "-" * 30
+      puts '-' * 30
 
       results = benchmark_category(test_cases)
       total_results[category] = results
@@ -53,46 +53,44 @@ class StringToNumberBenchmark
       puts
 
       # Show individual case performance for complex numbers
-      if category == :complex
-        puts "Individual case breakdown:"
-        test_cases.each_with_index do |text, index|
-          individual_time = Benchmark.realtime do
-            1000.times { StringToNumber.in_numbers(text) }
-          end
-          avg_ms = (individual_time / 1000) * 1000
-          puts "  #{index + 1}. #{avg_ms.round(4)}ms - '#{text[0..50]}#{text.length > 50 ? '...' : ''}'"
+      next unless category == :complex
+
+      puts 'Individual case breakdown:'
+      test_cases.each_with_index do |text, index|
+        individual_time = Benchmark.realtime do
+          1000.times { StringToNumber.in_numbers(text) }
         end
-        puts
+        avg_ms = (individual_time / 1000) * 1000
+        puts "  #{index + 1}. #{avg_ms.round(4)}ms - '#{text[0..50]}#{'...' if text.length > 50}'"
       end
+      puts
     end
 
     # Summary
-    puts "=" * 50
-    puts "PERFORMANCE SUMMARY"
-    puts "=" * 50
+    puts '=' * 50
+    puts 'PERFORMANCE SUMMARY'
+    puts '=' * 50
 
     total_results.each do |category, results|
       status = case results[:avg_time_ms]
-               when 0..0.1 then "🟢 Excellent"
-               when 0.1..0.5 then "🟡 Good"
-               when 0.5..1.0 then "🟠 Acceptable"
-               else "🔴 Needs optimization"
+               when 0..0.1 then '🟢 Excellent'
+               when 0.1..0.5 then '🟡 Good'
+               when 0.5..1.0 then '🟠 Acceptable'
+               else '🔴 Needs optimization'
                end
-      
+
       puts "#{category.to_s.capitalize.ljust(12)} #{status.ljust(15)} #{results[:avg_time_ms].round(4)}ms avg"
     end
 
     puts
-    puts "Memory efficiency test..."
+    puts 'Memory efficiency test...'
     test_memory_usage
 
     puts
-    puts "Scalability test..."
+    puts 'Scalability test...'
     test_scalability
   end
 
-  private
-
   def self.benchmark_category(test_cases, iterations = 2000)
     total_time = Benchmark.realtime do
       test_cases.each do |text|
@@ -130,7 +128,7 @@ class StringToNumberBenchmark
 
       puts "Object creation: #{object_growth} new objects (#{object_growth > 1000 ? '🔴 High' : '🟢 Low'})"
     else
-      puts "Memory tracking not available on this platform"
+      puts 'Memory tracking not available on this platform'
     end
   end
 
@@ -138,27 +136,32 @@ class StringToNumberBenchmark
     # Test how performance scales with input complexity
     inputs = [
       'un',                                                           # 2 chars
-      'vingt et un',                                                  # 11 chars  
+      'vingt et un',                                                  # 11 chars
       'mille deux cent trente-quatre',                               # 29 chars
       'trois milliards cinq cents millions deux cent mille et une'   # 58 chars
     ]
 
-    puts "Input length vs. performance:"
-    
+    puts 'Input length vs. performance:'
+
     results = inputs.map do |input|
       time = Benchmark.realtime do
         1000.times { StringToNumber.in_numbers(input) }
       end
       avg_ms = (time / 1000) * 1000
-      
+
       { length: input.length, time: avg_ms, input: input }
     end
 
     results.each do |result|
       complexity_ratio = result[:time] / results.first[:time]
-      status = complexity_ratio < 5 ? "🟢" : complexity_ratio < 10 ? "🟡" : "🔴"
-      
-      puts "  #{result[:length].to_s.rjust(2)} chars: #{result[:time].round(4)}ms #{status} (#{complexity_ratio.round(1)}x baseline)"
+      status = if complexity_ratio < 5
+                 '🟢'
+               else
+                 complexity_ratio < 10 ? '🟡' : '🔴'
+               end
+
+      puts "  #{result[:length].to_s.rjust(2)} chars: #{result[:time].round(4)}ms #{status} " \
+           "(#{complexity_ratio.round(1)}x baseline)"
     end
 
     # Check if performance degrades reasonably
@@ -172,6 +175,4 @@ class StringToNumberBenchmark
 end
 
 # Run the benchmark
-if __FILE__ == $0
-  StringToNumberBenchmark.run_benchmark
-end
+StringToNumberBenchmark.run_benchmark if __FILE__ == $PROGRAM_NAME

data/lib/string_to_number/parser.rb

@@ -2,7 +2,7 @@
 
 module StringToNumber
   # High-performance French text to number parser
-  # 
+  #
   # This class provides a clean, optimized implementation that maintains
   # compatibility with the original algorithm while adding significant
   # performance improvements through caching and memoization.
@@ -23,9 +23,9 @@ module StringToNumber
     # Pre-compiled regex patterns for optimal performance
     MULTIPLIER_KEYS = MULTIPLIERS.keys.reject { |k| %w[un dix].include?(k) }
                                  .sort_by(&:length).reverse.freeze
-    MULTIPLIER_PATTERN = /(?<f>.*?)\s?(?<m>#{MULTIPLIER_KEYS.join('|')})/
-    QUATRE_VINGT_PATTERN = /(quatre(-|\s)vingt(s?)((-|\s)dix)?)((-|\s)?)(\w*)/
-    
+    MULTIPLIER_PATTERN = /(?<f>.*?)\s?(?<m>#{MULTIPLIER_KEYS.join('|')})/.freeze
+    QUATRE_VINGT_PATTERN = /(quatre(-|\s)vingt(s?)((-|\s)dix)?)((-|\s)?)(\w*)/.freeze
+
     # Cache configuration
     MAX_CACHE_SIZE = 1000
     private_constant :MAX_CACHE_SIZE
@@ -45,7 +45,7 @@ module StringToNumber
       # @raise [ArgumentError] if text is not a string
       def convert(text)
         validate_input!(text)
-        
+
         normalized = normalize_text(text)
         return 0 if normalized.empty?
 
@@ -56,7 +56,7 @@ module StringToNumber
         # Get or create parser instance and convert
         parser = get_cached_instance(normalized)
         result = parser.parse_optimized(normalized)
-        
+
         # Cache the result
         cache_conversion(normalized, result)
         result
@@ -68,7 +68,7 @@ module StringToNumber
           @conversion_cache.clear
           @cache_access_order.clear
         end
-        
+
         @instance_mutex.synchronize do
           @instance_cache.clear
         end
@@ -115,7 +115,7 @@ module StringToNumber
             oldest = @cache_access_order.shift
             @conversion_cache.delete(oldest)
           end
-          
+
           @conversion_cache[normalized_text] = result
           @cache_access_order.push(normalized_text)
         end
@@ -129,6 +129,7 @@ module StringToNumber
 
       def calculate_hit_ratio
         return 0.0 if @cache_access_order.empty?
+
         @conversion_cache.size.to_f / @cache_access_order.size
       end
     end
@@ -147,7 +148,7 @@ module StringToNumber
     # but with performance optimizations
     def parse_optimized(text)
       return 0 if text.nil? || text.empty?
-      
+
       # Direct lookup (fastest path)
       return WORD_VALUES[text] if WORD_VALUES.key?(text)
 
@@ -162,12 +163,12 @@ module StringToNumber
     # but with performance improvements
     def extract_optimized(sentence, keys, detail: false)
       return 0 if sentence.nil? || sentence.empty?
-      
+
       # Direct lookup
       return WORD_VALUES[sentence] if WORD_VALUES.key?(sentence)
 
       # Main pattern matching using pre-compiled regex
-      if result = MULTIPLIER_PATTERN.match(sentence)
+      if (result = MULTIPLIER_PATTERN.match(sentence))
         # Remove matched portion
         sentence = sentence.gsub(result[0], '') if result[0]
 
@@ -193,19 +194,19 @@ module StringToNumber
           }
         end
 
-        return extract_optimized(sentence, keys) + factor * multiple_of_ten
+        extract_optimized(sentence, keys) + (factor * multiple_of_ten)
 
       # Quatre-vingt special handling
-      elsif m = QUATRE_VINGT_PATTERN.match(sentence)
+      elsif (m = QUATRE_VINGT_PATTERN.match(sentence))
         normalize_str = m[1].tr(' ', '-')
         normalize_str = normalize_str[0...-1] if normalize_str[-1] == 's'
 
         sentence = sentence.gsub(m[0], '')
 
-        return extract_optimized(sentence, keys) +
-               WORD_VALUES[normalize_str] + (WORD_VALUES[m[8]] || 0)
+        extract_optimized(sentence, keys) +
+          WORD_VALUES[normalize_str] + (WORD_VALUES[m[8]] || 0)
       else
-        return match_optimized(sentence)
+        match_optimized(sentence)
       end
     end
 
@@ -213,8 +214,9 @@ module StringToNumber
     def match_optimized(sentence)
       return 0 if sentence.nil?
 
-      sentence.tr('-', ' ').split(' ').reverse.sum do |word|
+      sentence.tr('-', ' ').split.reverse.sum do |word|
         next 0 if word == 'et'
+
         WORD_VALUES[word] || (MULTIPLIERS[word] ? 10 * MULTIPLIERS[word] : 0)
       end
     end
@@ -227,4 +229,4 @@ module StringToNumber
       end
     end
   end
-end
+end