uea-stemmer 0.10.3 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e96f1d5e2badd5deeb28ad322b302a247c61bd67
-  data.tar.gz: d06f6e61a144fccffa861328429e302e124159e1
+SHA256:
+  metadata.gz: e33e3ab687d2232940f67f69bc4ec2cc72e402fd8ddfcc3c69f2c96748978970
+  data.tar.gz: cbafb7985b745a15a9c002560fbad2ae7deae42a2d31ff6416e6985b6f1e9f93
 SHA512:
-  metadata.gz: 5883892f78b597840ef70d3ef6ab99244c0ad9a7984bbeb4aceea34923444560234deb9769593374f35c46bf5f679e69409370b820629b92b608abd4714ba5b1
-  data.tar.gz: 936840304a249685e8ebb265b2db183769988f0927107c0ad85b5f1048801dd90fd4e716171f0a3e229648ec076cf837aba50f7802d40cce951bb2ba402d2fb4
+  metadata.gz: f600e07381586e02a83657a381b4285c0e20005dcd7b3a5e363425dccfffd83ba58105863f918468b1a7807c48d9f88486454f5ae04ef7fd504cf12ca645daee
+  data.tar.gz: 310737fcd31fc0318d44d6a82e81507bf478272629a3170c5c2c76db0f3976b3ad32f04e4b13bbe3a9fa501c4ffd6184526d352c69be9f34c309b9eea9a2ad63

data/README.rdoc

@@ -1,74 +1,100 @@
 = uea-stemmer
 
-Similar to other stemmers, UEA-Lite[https://web.archive.org/web/20120728132949/http://www.uea.ac.uk/cmp/research/graphicsvisionspeech/speech/WordStemming] operates on a set of rules which are used as steps. There are two groups of rules: the first to clean the tokens, and the second to alter suffixes.
+Ruby implementation of the UEA-Lite stemmer for conservative stemming in
+search and indexing workloads. The gem has no runtime dependencies.
 
-The first group of rules first avoids a small list of six frequent problem words. An improvement to the stemmer would be to expand this list by adding other problem words which the second rule set cannot deal with. Second, possessive apostrophes are removed and contractions are expanded. All hyphens are removed and tokens containing digits are left untouched. Strings which are all upper case and digits are left untouched unless there is a lower case terminal 's' (i.e. transforming plural forms of acronyms to singular forms).
+UEA-Lite[https://web.archive.org/web/20120728132949/http://www.uea.ac.uk/cmp/research/graphicsvisionspeech/speech/WordStemming]
+uses a rule set to normalize suffixes while avoiding aggressive stemming.
 
-Proper nouns should not usually be stemmed, except to remove possessives; our implementation will respect PoS tags if they are present. If the text is untagged the stemmer uses the simple heuristic that any capitalized token not preceded by sentence breaking punctuation is a proper noun.
+== Behavior Notes
 
-Many texts, particularly scientific papers, contain sequences of digits, single letters, and other non-word tokens. Our implementation ignores tokens containing digits, single-letter tokens, and tokens with embedded punctuation.
+The stemmer operates on a single token at a time and returns a stemmed token.
 
-The second group of rules contains 139 suffix rules, each testing for a specific type of suffix. The rules are set in a particular order so that the longest suffix applicable is used rather a shorter one which could lead to nonsense words and more words not stemmed entirely to their root form.
+Notable behavior of this implementation:
 
-This is a port to Ruby from the port to Java from the original Perl script by Marie-Claire Jenkins and Dr. Dan J. Smith at the University of East Anglia.
+* possessive apostrophes are removed
+* contractions are expanded by default (for example, <tt>don't</tt> becomes
+  <tt>do not</tt>)
+* tokens beginning with uppercase letters are preserved, and pluralized
+  acronyms ending in a lowercase <tt>s</tt> are singularized
+* pure numbers, and tokens containing hyphens/underscores, are passed through
+  unchanged
+
+This is a port to Ruby from the Java port of the original Perl script by
+Marie-Claire Jenkins and Dr. Dan J. Smith at the University of East Anglia.
 
 == Installation
 
+Requires Ruby 3.1 or newer.
+
 Install the gem:
 
   gem install uea-stemmer
 
-Install the gem from source:
+Install from source:
 
-  git clone git://github.com/ealdent/uea-stemmer.git
+  git clone https://github.com/ealdent/uea-stemmer.git
   cd uea-stemmer
-  rake install
-
-Depending on your setup, you may need to use +sudo+ for either of these methods.
+  gem build uea-stemmer.gemspec
+  gem install ./uea-stemmer-*.gem
 
 == Example Usage
 
-Typical usage:
+Basic usage:
 
-  require 'uea-stemmer'
+  require "uea-stemmer"
   stemmer = UEAStemmer.new
 
-  stemmer.stem('helpers')   # helper
-  stemmer.stem('dying')     # die
-  stemmer.stem('scarred')   # scar
+  stemmer.stem("helpers")   # => "helper"
+  stemmer.stem("dying")     # => "die"
+  stemmer.stem("scarred")   # => "scar"
+
+You can extract the matching rule with +stem_with_rule+:
+
+  result = stemmer.stem_with_rule("invited")
+  result.word      # => "invite"
+  result.rule_num  # => "22.3"
+  result.rule      # => #<UEAStemmer::Rule ...>
+
+Disable contraction expansion:
 
-  'buries'.stem             # bury
-  'bodies'.stem             # body
-  'ordained'.stem           # ordain
+  UEAStemmer.new(nil, nil, skip_contractions: true).stem("don't")
+  # => "don't"
 
-You can also extract the stemmed word along with the rule by using the +stem_with_rule+ method.
+Use the singleton instance:
 
-  stem = stemmer.stem_with_rule('invited')   # Word('invite', Rule #22.3)
-  puts stem.rule  # rule #22.3 (remove -d when the word ends in -ited)
+  DefaultUEAStemmer.instance.stem("running")  # => "run"
 
-== TODO
+== Development
 
-* test handling of POS tags
-* add tests to mimic methodology used in the paper
+This project does not require Bundler or Rake for normal development. Run the
+tests directly:
 
-== Note on Patches/Pull Requests
+  ruby -Itest test/uea_stemmer_test.rb
+
+Build the gem package:
+
+  gem build uea-stemmer.gemspec
+
+GitHub Actions runs the test suite and gem build on supported Ruby versions.
+
+== Contributing
 
 * Fork the project.
 * Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+* Add or update tests.
+* Run +ruby -Itest test/uea_stemmer_test.rb+.
+* Run +gem build uea-stemmer.gemspec+.
+* Send a pull request.
 
 == Relevant Web Pages
 
 * https://web.archive.org/web/20120728132949/http://www.uea.ac.uk/cmp/research/graphicsvisionspeech/speech/WordStemming
-* Stemming[http://en.wikipedia.org/wiki/Stemming]
+* Stemming[https://en.wikipedia.org/wiki/Stemming]
 
 == Copyright
 
 Copyright (c) 2005 by the University of East Anglia and authored by Marie-Claire Jenkins and Dr. Dan J Smith.  This port to Ruby was done by Jason Adams using the port to Java by Richard Churchill.
 
-This project is distributed under the Apache 2.0 License[http://www.apache.org/licenses/LICENSE-2.0]. See LICENSE for details.
-
+This project is distributed under the Apache 2.0
+License[https://www.apache.org/licenses/LICENSE-2.0]. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.10.3
+0.11.0

data/lib/uea-stemmer/rule.rb

@@ -29,7 +29,7 @@ class UEAStemmer
     def initialize(pattern, suffix_size, rule_num)
       @pattern = pattern.dup.freeze
       @suffix_size = suffix_size
-      @rule_num = rule_num
+      @rule_num = rule_num.to_s.freeze
     end
 
     def handle(word)
@@ -45,7 +45,7 @@ class UEAStemmer
     attr_reader :original_pattern
 
     def initialize(pattern, suffix_size, rule_num)
-      super(/^.*#{pattern}$/, suffix_size, rule_num)
+      super(/^.*#{Regexp.escape(pattern)}$/, suffix_size, rule_num)
       @original_pattern = pattern.dup.freeze
     end
 
@@ -105,4 +105,4 @@ class UEAStemmer
       stemmed_word
     end
   end
-end
+end

data/lib/uea-stemmer/string_helpers.rb

@@ -4,6 +4,6 @@ module StringHelpers
   end
 
   def ends_with?(word, suffix)
-    !!(word =~ /#{suffix}$/)
+    word.end_with?(suffix)
   end
-end
+end

data/lib/uea-stemmer/word.rb

@@ -24,12 +24,12 @@ class UEAStemmer
 
     def initialize(word, rule_num, rule = nil)
       @word = word.dup.freeze
-      @rule_num = rule_num
+      @rule_num = rule_num.to_s.freeze
       @rule = rule
     end
 
     def to_s
-      if @rule_num > 0
+      if @rule_num != '0'
         "#{@word} (Rule ##{@rule_num} #{@rule})"
       else
         "#{@word} (No rule)"

data/lib/uea-stemmer.rb

@@ -26,41 +26,46 @@ require 'singleton'
 class UEAStemmer
   include StringHelpers
 
-  attr_accessor :max_acronym_length, :max_word_length
-  attr_reader :rules, :options
+  APOSTROPHE_PATTERN = /['’]/
+  PROBLEM_WORDS = %w[is as this has was during menses].freeze
+  SPECIAL_RULE_COUNT = 4
+
+  attr_reader :max_acronym_length, :max_word_length
 
   def initialize(max_word_length = nil, max_acronym_length = nil, options = {})
     @max_word_length = max_word_length || 'deoxyribonucleicacid'.size
     @max_acronym_length = max_acronym_length || 'CAVASSOO'.size
-    @options = options.dup
+    @options = options.transform_keys(&:to_sym).freeze
 
-    @rules = Array.new
+    @rules = []
     create_rules
   end
 
+  def rules
+    @rules.dup.freeze
+  end
+
+  def options
+    @options
+  end
+
   def stem_with_rule(word)
-    stemmed_word = word.dup;
-    ruleno = 0;
+    stemmed_word = word.dup
 
     if problem_word?(word)
       Word.new(word, 94)
     elsif (word.size > @max_acronym_length && word =~ /^[A-Z]+$/) || (word.size > (@max_acronym_length + 1) && word =~ /^[A-Z]+s$/)
-      Word.new(word, 96)      # added by JMA to catch long acronyms
+      Word.new(word, 96)
     elsif word.size > @max_word_length
       Word.new(word, 95)
-    elsif word.index("'")
-      if word =~ /^.*'[s]$/i
+    elsif word =~ APOSTROPHE_PATTERN
+      if word =~ /^.*['’]s$/i
         stemmed_word = remove_suffix(stemmed_word, 2)
-      elsif word =~ /^.*'$/
+      elsif word =~ /^.*['’]$/
         stemmed_word = remove_suffix(stemmed_word, 1)
       end
 
-      unless options[:skip_contractions]
-        stemmed_word.gsub!(/n't/, ' not')
-        stemmed_word.gsub!(/'ve/, ' have')
-        stemmed_word.gsub!(/'re/, ' are')
-        stemmed_word.gsub!(/'m/, ' am')
-      end
+      stemmed_word = expand_contractions(stemmed_word) unless options[:skip_contractions]
 
       Word.new(stemmed_word, 93)
     else
@@ -74,7 +79,7 @@ class UEAStemmer
   end
 
   def num_rules
-    @rules.map { |r| r.rule_num }.uniq.size + 4    # four rules not covered by the rules array
+    @rules.map { |r| r.rule_num }.uniq.size + SPECIAL_RULE_COUNT
   end
 
   def to_s
@@ -82,7 +87,7 @@ class UEAStemmer
   end
 
   def add_rule(rule)
-    if rule.kind_of?(Rule)
+    if rule.is_a?(Rule)
       @rules << rule.dup.freeze
       true
     else
@@ -94,13 +99,48 @@ class UEAStemmer
 
   def apply_rules(word)
     @rules.each do |rule|
-      stemmed_word, rule_num, tmp_rule = rule.handle(word)
-      return [stemmed_word, rule_num, rule] if stemmed_word && rule_num
+      stemmed_word, rule_num, matched_rule = rule.handle(word)
+      return [stemmed_word, rule_num, matched_rule] if stemmed_word && rule_num
     end
 
     [word, 0, nil]
   end
 
+  def expand_contractions(word)
+    normalized_word = word.tr('’', "'")
+
+    if normalized_word =~ /\Awon't\z/i
+      match_word_case(word, 'will not')
+    elsif normalized_word =~ /\Acan't\z/i
+      match_word_case(word, 'can not')
+    elsif normalized_word =~ /\Ashan't\z/i
+      match_word_case(word, 'shall not')
+    elsif normalized_word =~ /\A(.+)n't\z/i
+      "#{$1}#{match_suffix_case(word, ' not')}"
+    elsif normalized_word =~ /\A(.+)'ve\z/i
+      "#{$1}#{match_suffix_case(word, ' have')}"
+    elsif normalized_word =~ /\A(.+)'re\z/i
+      "#{$1}#{match_suffix_case(word, ' are')}"
+    elsif normalized_word =~ /\A(.+)'m\z/i
+      "#{$1}#{match_suffix_case(word, ' am')}"
+    else
+      word
+    end
+  end
+
+  def match_word_case(original_word, expanded_word)
+    return expanded_word.upcase if original_word == original_word.upcase
+    return expanded_word.sub(/\A[a-z]/) { |letter| letter.upcase } if original_word =~ /\A[A-Z]/
+
+    expanded_word
+  end
+
+  def match_suffix_case(original_word, suffix)
+    return suffix.upcase if original_word == original_word.upcase
+
+    suffix
+  end
+
   def create_rules
     @rules << Rule.new(/^\d+$/, 0, 90.3)
     @rules << Rule.new(/^\w+-\w+$/, 0, 90.2)
@@ -117,8 +157,6 @@ class UEAStemmer
     @rules << EndingRule.new('sis', 0, 4)
     @rules << EndingRule.new('tis', 0, 5)
     @rules << EndingRule.new('ss', 0, 6)
-
-    # plural change - this differs from Perl v1.03
     @rules << EndingRule.new('eed', 0, 7)
     @rules << EndingRule.new('eeds', 1, 7)
 
@@ -157,13 +195,9 @@ class UEAStemmer
     @rules << EndingRule.new('eared', 2, 20.3)
     @rules << EndingRule.new('tored', 2, 20.2)
     @rules << EndingRule.new('ered', 2, 20.1)
-
-    # plural change - this differs from Perl v1.03
     @rules << EndingRule.new('red', 1, 20)
     @rules << EndingRule.new('reds', 2, 20)
     @rules << EndingRule.new('tted', 3, 21)
-
-    # added some rules to handle invited vs. exited
     @rules << EndingRule.new('noted', 1, 22.6)
     @rules << EndingRule.new('leted', 1, 22.5)
     @rules << Rule.new(/^.*[^vm]ited$/, 2, 22.4)
@@ -175,8 +209,6 @@ class UEAStemmer
     @rules << EndingRule.new('anges', 1, 23)
     @rules << EndingRule.new('aining', 3, 24)
     @rules << EndingRule.new('acting', 3, 25)
-
-    # plural change - this differs from Perl v1.03
     @rules << EndingRule.new('tting', 4, 26)
     @rules << EndingRule.new('ttings', 5, 26)
 
@@ -184,9 +216,6 @@ class UEAStemmer
     @rules << EndingRule.new('ssed', 2, 28)
     @rules << EndingRule.new('sed', 1, 29)
     @rules << EndingRule.new('titudes', 1, 30)
-
-    # added some additional rules to handle other vowels and consonants
-    # (added by Jason M. Adams)
     @rules << EndingRule.new('oed', 1, 31.3)
     @rules << EndingRule.new('does', 2, 31.2)
     @rules << EndingRule.new('oes', 1, 31.2)
@@ -212,8 +241,6 @@ class UEAStemmer
     @rules << EndingRule.new('ssing', 3, 37)
     @rules << EndingRule.new('ssings', 4, 37)
     @rules << EndingRule.new('ulting', 3, 38)
-
-    # plural change - this differs from Perl v1.03
     @rules << ConcatenatingEndingRule.new('ving', 3, 39, 'e')
     @rules << ConcatenatingEndingRule.new('vings', 4, 39, 'e')
 
@@ -231,8 +258,6 @@ class UEAStemmer
     @rules << EndingRule.new('rdings', 4, 40.2)
     @rules << EndingRule.new('nding', 3, 40.1)
     @rules << EndingRule.new('ndings', 4, 40.1)
-
-    # plural change - this differs from Perl v1.03
     @rules << ConcatenatingEndingRule.new('ding', 3, 40, 'e')
     @rules << ConcatenatingEndingRule.new('dings', 4, 40, 'e')
 
@@ -255,8 +280,6 @@ class UEAStemmer
     @rules << EndingRule.new('mmings', 5, 44.3)
     @rules << EndingRule.new('rming', 3, 44.2)
     @rules << EndingRule.new('lming', 3, 44.1)
-
-    # plural change - this differs from Perl v1.03
     @rules << ConcatenatingEndingRule.new('ming', 3, 44, 'e')
     @rules << ConcatenatingEndingRule.new('mings', 4, 44, 'e')
 
@@ -273,8 +296,6 @@ class UEAStemmer
     @rules << EndingRule.new('oning', 3, 46.2)
     @rules << EndingRule.new('rning', 3, 46.1)
     @rules << ConcatenatingEndingRule.new('ning', 3, 46, 'e')
-
-    # plural change - this differs from Perl v1.03
     @rules << EndingRule.new('sting', 3, 47)
     @rules << EndingRule.new('stings', 4, 47)
     @rules << EndingRule.new('eting', 3, 48.4)
@@ -287,13 +308,9 @@ class UEAStemmer
     @rules << ConcatenatingEndingRule.new('ting', 3, 48, 'e')
     @rules << ConcatenatingEndingRule.new('tings', 4, 48, 'e')
 
-    @rules << EndingRule.new('ssed', 2, 49)
     @rules << EndingRule.new('les', 1, 50)
     @rules << EndingRule.new('tes', 1, 51)
     @rules << EndingRule.new('zed', 1, 52)
-    @rules << EndingRule.new('lled', 2, 53)
-
-    # plural change - this differs from Perl v1.03
     @rules << ConcatenatingEndingRule.new('iring', 3, 54.4, 'e')
     @rules << ConcatenatingEndingRule.new('irings', 4, 54.4, 'e')
     @rules << ConcatenatingEndingRule.new('uring', 3, 54.3, 'e')
@@ -302,19 +319,15 @@ class UEAStemmer
     @rules << ConcatenatingEndingRule.new('ncings', 4, 54.2, 'e')
 
     @rules << ConcatenatingEndingRule.new('zing', 3, 54.1, 'e')
-
-    # plural change - this differs from Perl v1.03
     @rules << ConcatenatingEndingRule.new('sing', 3, 54, 'e')
     @rules << ConcatenatingEndingRule.new('sings', 4, 54, 'e')
 
     @rules << EndingRule.new('lling', 3, 55)
     @rules << ConcatenatingEndingRule.new('ied', 3, 56, 'y')
     @rules << ConcatenatingEndingRule.new('ating', 3, 57, 'e')
-
-    # plural change - this differs from Perl v1.03
-    @rules << ConcatenatingEndingRule.new('dying', 4, 58.2, 'ie')   # added by JMA
-    @rules << ExhaustiveConcatenatingEndingRule.new('lying', 4, 58.2, 'ie')   # added by JMA    (lying vs flying)
-    @rules << ConcatenatingEndingRule.new('tying', 4, 58.2, 'ie')   # added by JMA
+    @rules << ConcatenatingEndingRule.new('dying', 4, 58.2, 'ie')
+    @rules << ExhaustiveConcatenatingEndingRule.new('lying', 4, 58.2, 'ie')
+    @rules << ConcatenatingEndingRule.new('tying', 4, 58.2, 'ie')
     @rules << EndingRule.new('thing', 0, 58.1)
     @rules << EndingRule.new('things', 1, 58.1)
     @rules << CustomRule.new(/.*\w\wings?$/, 3, 58)
@@ -325,10 +338,9 @@ class UEAStemmer
     @rules << EndingRule.new('aped', 1, 61.3)
     @rules << EndingRule.new('uded', 1, 61.2)
     @rules << EndingRule.new('oded', 1, 61.1)
-    @rules << EndingRule.new('ated', 1, 61)
     @rules << CustomRule.new(/.*\w\weds?$/, 2, 62)
-    @rules << EndingRule.new('des', 1, 63.10) # Fix for words like grades, escapades, abodes
-    @rules << EndingRule.new('res', 1, 63.9) # Fix for words like fires, acres, wires, cares
+    @rules << EndingRule.new('des', 1, '63.10')
+    @rules << EndingRule.new('res', 1, 63.9)
     @rules << EndingRule.new('pes', 1, 63.8)
     @rules << EndingRule.new('mes', 1, 63.7)
     @rules << EndingRule.new('ones', 1, 63.6)
@@ -351,7 +363,7 @@ class UEAStemmer
   end
 
   def problem_word?(word)
-    ['is', 'as', 'this', 'has', 'was', 'during', 'menses'].include?(word)
+    PROBLEM_WORDS.include?(word)
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uea-stemmer
 version: !ruby/object:Gem::Version
-  version: 0.10.3
+  version: 0.11.0
 platform: ruby
 authors:
 - Marie-Claire Jenkins
@@ -11,106 +11,32 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-14 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  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: test-unit
-  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: shoulda
-  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
-    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: awesome_print
-  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'
-description: Port of UEA-Lite Stemmer to Ruby, a conservative stemmer for search and
-  indexing.
-email: jasonmadams@gmail.com
+date: 2026-05-21 00:00:00.000000000 Z
+dependencies: []
+description: Ruby port of the UEA-Lite stemmer, designed to normalize common English
+  suffixes without aggressive stemming.
+email:
+- jasonmadams@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
 files:
-- ".document"
-- ".ruby-gemset"
-- ".ruby-version"
-- Gemfile
-- Gemfile.lock
 - LICENSE
 - README.rdoc
-- Rakefile
 - VERSION
 - lib/uea-stemmer.rb
 - lib/uea-stemmer/rule.rb
 - lib/uea-stemmer/string_helpers.rb
 - lib/uea-stemmer/word.rb
-- test/test_helper.rb
-- test/uea_stemmer_test.rb
-- uea-stemmer.gemspec
-homepage: http://github.com/ealdent/uea-stemmer
-licenses: []
-metadata: {}
+homepage: https://github.com/ealdent/uea-stemmer
+licenses:
+- Apache-2.0
+metadata:
+  bug_tracker_uri: https://github.com/ealdent/uea-stemmer/issues
+  changelog_uri: https://github.com/ealdent/uea-stemmer/releases
+  homepage_uri: https://github.com/ealdent/uea-stemmer
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/ealdent/uea-stemmer
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -119,16 +45,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
-summary: Port of UEA-Lite Stemmer to Ruby, a conservative stemmer for search and indexing.
+summary: Conservative UEA-Lite stemming for search and indexing.
 test_files: []

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/.ruby-gemset

@@ -1 +0,0 @@
-uea-stemmer

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.3.0

data/Gemfile

@@ -1,9 +0,0 @@
-source 'https://rubygems.org'
-
-group :development do
-  gem 'jeweler'
-  gem 'test-unit'
-  gem 'shoulda'
-  gem 'rake'
-  gem 'awesome_print'
-end

data/Gemfile.lock

@@ -1,83 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (5.1.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    addressable (2.4.0)
-    awesome_print (1.8.0)
-    builder (3.2.3)
-    concurrent-ruby (1.0.5)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
-    faraday (0.9.2)
-      multipart-post (>= 1.2, < 3)
-    git (1.3.0)
-    github_api (0.16.0)
-      addressable (~> 2.4.0)
-      descendants_tracker (~> 0.0.4)
-      faraday (~> 0.8, < 0.10)
-      hashie (>= 3.4)
-      mime-types (>= 1.16, < 3.0)
-      oauth2 (~> 1.0)
-    hashie (3.5.6)
-    highline (1.7.8)
-    i18n (0.8.6)
-    jeweler (2.3.7)
-      builder
-      bundler (>= 1)
-      git (>= 1.2.5)
-      github_api (~> 0.16.0)
-      highline (>= 1.6.15)
-      nokogiri (>= 1.5.10)
-      psych (~> 2.2)
-      rake
-      rdoc
-      semver2
-    jwt (1.5.6)
-    mime-types (2.99.3)
-    mini_portile2 (2.2.0)
-    minitest (5.10.3)
-    multi_json (1.12.1)
-    multi_xml (0.6.0)
-    multipart-post (2.0.0)
-    nokogiri (1.8.0)
-      mini_portile2 (~> 2.2.0)
-    oauth2 (1.4.0)
-      faraday (>= 0.8, < 0.13)
-      jwt (~> 1.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-    power_assert (1.0.2)
-    psych (2.2.4)
-    rack (2.0.3)
-    rake (12.0.0)
-    rdoc (5.1.0)
-    semver2 (3.4.2)
-    shoulda (3.5.0)
-      shoulda-context (~> 1.0, >= 1.0.1)
-      shoulda-matchers (>= 1.4.1, < 3.0)
-    shoulda-context (1.2.2)
-    shoulda-matchers (2.8.0)
-      activesupport (>= 3.0.0)
-    test-unit (3.2.5)
-      power_assert
-    thread_safe (0.3.6)
-    tzinfo (1.2.3)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  awesome_print
-  jeweler
-  rake
-  shoulda
-  test-unit
-
-BUNDLED WITH
-   1.15.3

data/Rakefile

@@ -1,40 +0,0 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "uea-stemmer"
-    gem.summary = %Q{Port of UEA-Lite Stemmer to Ruby, a conservative stemmer for search and indexing.}
-    gem.description = %Q{Port of UEA-Lite Stemmer to Ruby, a conservative stemmer for search and indexing.}
-    gem.email = "jasonmadams@gmail.com"
-    gem.homepage = "http://github.com/ealdent/uea-stemmer"
-    gem.authors = ["Marie-Claire Jenkins", "Dan J. Smith", "Richard Churchill", "Jason Adams"]
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
-end
-
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-task :default => :test

data/test/test_helper.rb

@@ -1,10 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'uea-stemmer'
-
-class Test::Unit::TestCase
-end

data/test/uea_stemmer_test.rb

@@ -1,184 +0,0 @@
-require 'test_helper'
-
-class UeaStemmerTest < Test::Unit::TestCase
-  context "A default UEAStemmer instance" do
-    setup do
-      @stemmer = UEAStemmer.new
-    end
-
-    should "have max word and max acronym sizes equivalent to deoxyribonucleicacid and CAVASSOO respectively" do
-      assert @stemmer.max_word_length == 'deoxyribonucleicacid'.size
-      assert @stemmer.max_acronym_length == 'CAVASSOO'.size
-    end
-
-    should "allow setting options" do
-      @stemmer.options[:test] = true
-      assert @stemmer.options[:test]
-    end
-
-    context "stem method" do
-      should "stem words as Strings" do
-        assert @stemmer.stem('word').is_a?(String)
-      end
-
-      should "stem base words to just the base word" do
-        assert_equal @stemmer.stem('man'), 'man'
-        assert_equal @stemmer.stem('happiness'), 'happiness'
-      end
-
-      should "stem theses as thesis but not bases as basis" do
-        assert_equal @stemmer.stem('theses'), 'thesis'
-        assert_not_equal @stemmer.stem('bases'), 'basis'
-      end
-
-      should "stem preterite words ending in -ed without the -ed" do
-        assert_equal @stemmer.stem('ordained'), 'ordain'
-        assert_equal @stemmer.stem('killed'), 'kill'
-        assert_equal @stemmer.stem('liked'), 'like'
-        assert_equal @stemmer.stem('helped'), 'help'
-        assert_equal @stemmer.stem('scarred'), 'scar'
-        assert_equal @stemmer.stem('invited'), 'invite'
-        assert_equal @stemmer.stem('exited'), 'exit'
-        assert_equal @stemmer.stem('exited'), 'exit'
-        assert_equal @stemmer.stem('debited'), 'debit'
-        assert_equal @stemmer.stem('smited'), 'smite'
-      end
-
-      should "stem progressive verbs and gerunds without the -ing" do
-        assert_equal @stemmer.stem('running'), 'run'
-        assert_equal @stemmer.stem('settings'), 'set'
-        assert_equal @stemmer.stem('timing'), 'time'
-        assert_equal @stemmer.stem('dying'), 'die'
-        assert_equal @stemmer.stem('harping'), 'harp'
-        assert_equal @stemmer.stem('charring'), 'char'
-      end
-
-      should "not stem false progressive verbs such as 'sing'" do
-        assert_equal @stemmer.stem('ring'),  'ring'
-        assert_equal @stemmer.stem('sing'),  'sing'
-        assert_equal @stemmer.stem('ring'),  'ring'
-        assert_equal @stemmer.stem('bring'), 'bring'
-        assert_equal @stemmer.stem('fling'), 'fling'
-      end
-
-      should "stem various plural nouns and 3rd-pres verbs without the -s/-es" do
-        assert_equal @stemmer.stem('changes'), 'change'
-        assert_equal @stemmer.stem('deaths'), 'death'
-        assert_equal @stemmer.stem('shadows'), 'shadow'
-        assert_equal @stemmer.stem('flies'), 'fly'
-        assert_equal @stemmer.stem('things'), 'thing'
-        assert_equal @stemmer.stem('nothings'), 'nothing'   # as in 'sweet nothings'
-        assert_equal @stemmer.stem('witches'), 'witch'
-        assert_equal @stemmer.stem('makes'), 'make'
-        assert_equal @stemmer.stem('smokes'), 'smoke'
-        assert_equal @stemmer.stem('does'), 'do'
-      end
-
-      should "stem various words with -des suffix" do
-        assert_equal @stemmer.stem('abodes'), 'abode'
-        assert_equal @stemmer.stem('escapades'), 'escapade'
-        assert_equal @stemmer.stem('crusades'), 'crusade'
-        assert_equal @stemmer.stem('grades'), 'grade'
-      end
-
-      should "stem various words with -res suffix" do
-        assert_equal @stemmer.stem('wires'), 'wire'
-        assert_equal @stemmer.stem('acres'), 'acre'
-        assert_equal @stemmer.stem('fires'), 'fire'
-        assert_equal @stemmer.stem('cares'), 'care'
-      end
-
-      should "stem acronyms when pluralized otherwise they should be left alone" do
-        assert_equal @stemmer.stem('USA'), 'USA'
-        assert_equal @stemmer.stem('FLOSS'), 'FLOSS'
-        assert_equal @stemmer.stem('MREs'), 'MRE'
-        assert_equal @stemmer.stem('USAED'), 'USAED'
-      end
-    end
-
-    context "stem_with_rule method" do
-      should "return a Word instance" do
-        assert @stemmer.stem_with_rule('witches').is_a?(UEAStemmer::Word)
-      end
-
-      should "return a rule and the stemmed form" do
-        word = @stemmer.stem_with_rule('witches')
-        assert !word.rule.nil?
-        assert !word.word.nil?
-      end
-    end
-
-    context "other functionality" do
-      should "return the number of rules the stemmer is currently using" do
-        assert @stemmer.num_rules.is_a?(Numeric)
-      end
-    end
-  end
-
-  context "A modified UEAStemmer instance" do
-    setup do
-      @stemmer = UEAStemmer.new(5, 3)     # max word length = 5, max acronym length = 3
-    end
-
-    should "have modified max word and max acronym sizes" do
-      assert @stemmer.max_word_length == 5
-      assert @stemmer.max_acronym_length == 3
-    end
-
-    should "reject a longer word with rule 95" do
-      word = @stemmer.stem_with_rule('deoxyribonucleicacid')
-      assert_equal word.rule_num, 95
-    end
-
-    should "reject a longer acronym with rule 96" do
-      word = @stemmer.stem_with_rule('CAVASSOO')
-      assert_equal word.rule_num, 96
-    end
-  end
-
-  context "A Word instance" do
-    setup do
-      @word = UEAStemmer::Word.new('helpers', 68, UEAStemmer::EndingRule.new('s', 1, 68)) # sample word
-      @stemmer = UEAStemmer.new
-    end
-
-    should "return the rule used to derive the stem" do
-      assert @word.rule.kind_of?(UEAStemmer::Rule)
-    end
-
-    should "return the number of the rule used to derive the stem" do
-      assert @word.rule_num.kind_of?(Numeric)
-    end
-
-    should "return the stemmed word as a String" do
-      assert @word.word.kind_of?(String)
-    end
-  end
-
-  context "A Rule instance" do
-    setup do
-      @rule = UEAStemmer::Rule.new(/.*s$/i, 1, 555)
-    end
-
-    should "return the rule number" do
-      assert @rule.rule_num.kind_of?(Numeric)
-    end
-
-    should "return the pattern being matched" do
-      assert @rule.pattern.kind_of?(String) || @rule.pattern.kind_of?(Regexp)
-    end
-
-    should "return the size of the suffix that is being removed" do
-      assert @rule.suffix_size.kind_of?(Numeric)
-    end
-
-    should "return a stemmed word, a rule number, and a rule on a successful match" do
-      word, rule_num, tmp_rule = @rule.handle('helps')
-      assert word.is_a?(String) && rule_num.is_a?(Numeric) && tmp_rule.is_a?(UEAStemmer::Rule)
-    end
-
-    should "return nil when match is unsuccessful" do
-      assert @rule.handle('help').nil?
-    end
-  end
-end

data/uea-stemmer.gemspec

@@ -1,60 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: uea-stemmer 0.10.2 ruby lib
-
-Gem::Specification.new do |s|
-  s.name = "uea-stemmer"
-  s.version = "0.10.2"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Marie-Claire Jenkins", "Dan J. Smith", "Richard Churchill", "Jason Adams"]
-  s.date = "2017-08-14"
-  s.description = "Port of UEA-Lite Stemmer to Ruby, a conservative stemmer for search and indexing."
-  s.email = "jasonmadams@gmail.com"
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-    "LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "lib/uea-stemmer.rb",
-    "lib/uea-stemmer/rule.rb",
-    "lib/uea-stemmer/string_helpers.rb",
-    "lib/uea-stemmer/word.rb",
-    "test/test_helper.rb",
-    "test/uea_stemmer_test.rb",
-    "uea-stemmer.gemspec"
-  ]
-  s.homepage = "http://github.com/ealdent/uea-stemmer"
-  s.rubygems_version = "2.4.8"
-  s.summary = "Port of UEA-Lite Stemmer to Ruby, a conservative stemmer for search and indexing."
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<uea-stemmer>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
-      s.add_development_dependency(%q<test-unit>, [">= 0"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-    else
-      s.add_dependency(%q<uea-stemmer>, [">= 0"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
-      s.add_dependency(%q<test-unit>, [">= 0"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<uea-stemmer>, [">= 0"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
-    s.add_dependency(%q<test-unit>, [">= 0"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
-  end
-end
-