text_rank 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1daece496ee8bb075ecc3540d6b8ca64d45c740b1ca34529e094283933d9c97
-  data.tar.gz: bee8ff77c21cffa95d838e91ae09773b290afd4b9c0224415c2d783f63069b1b
+  metadata.gz: 57c44c7be2d14f3fb9d2b76212639c6f5416adedeb32e3c9d39a6b90368680bd
+  data.tar.gz: 829bf430e9cc9dd942bdd753f801fc01d94929f42be09c6504691d47bc7c9f04
 SHA512:
-  metadata.gz: 0e9df6c07d6c8bb94a782b61c7877e7fe2e4dd064645c87a0e636bae2236ffbf92e848426d5d8cb4daa04328a6afc25c0a58de3c14ba316c84bb07caa45801f8
-  data.tar.gz: e7a10407dce5651a05aa208db1136a3c0cc1082c70152b676d3867408cc8107dc8543080e20b8855659b8b58c4fe0063321fc5e8b976933372ff02d6b597ca82
+  metadata.gz: 7bdb293e07cca83ba7665cbe3861360cd3e4b82d64d5cd2167717e509bff6ccf14948436463464a9ab57f92cd97b8e7a918d27d004f3a7c476feb5c55565191f
+  data.tar.gz: 446d28deeca6a972fc9b257b8699a859ec4fc481d6f04f31d02215d79a7251b87cfebeaba7335001e7977e974b72c3e79113c754d1749303dc943b3d59c6d62c

data/.rubocop.yml

@@ -15,6 +15,10 @@ Layout/EmptyLinesAroundModuleBody:
 Layout/ExtraSpacing:
   Enabled: false
 
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
 Layout/LineLength:
   Max: 120
   Enabled: false
@@ -89,6 +93,9 @@ Style/GuardClause:
 Style/HashEachMethods:
   Enabled: true
 
+Style/HashSyntax:
+  Enabled: true
+
 Style/HashTransformKeys:
   Enabled: true
 

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "text_rank"
+require 'bundler/setup'
+require 'text_rank'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "text_rank"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/page_rank.rb

@@ -1,3 +1,5 @@
+require 'set'
+
 ##
 # A module for supporting Ruby implementations of PageRank. Rather than rely on
 # one single implementation, this module allows for multiple implementations that

data/lib/page_rank/base.rb

@@ -19,8 +19,7 @@ module PageRank
     # @return [Float]
     def damping=(damping)
       @damping = damping || 0.85
-      raise ArgumentError.new('Invalid damping factor') if @damping <= 0 || @damping > 1
-      @damping
+      raise ArgumentError, 'Invalid damping factor' if @damping <= 0 || @damping > 1
     end
 
     # Set the tolerance value
@@ -28,8 +27,7 @@ module PageRank
     # @return [Float]
     def tolerance=(tolerance)
       @tolerance = tolerance || 0.0001
-      raise ArgumentError.new('Invalid tolerance factor') if @tolerance < 0 || @tolerance > 1
-      @tolerance
+      raise ArgumentError, 'Invalid tolerance factor' if @tolerance.negative? || @tolerance > 1
     end
 
     # Adds a directed (and optionally weighted) edge to the graph
@@ -46,9 +44,12 @@ module PageRank
     def calculate(max_iterations: -1, **_)
       ranks = initial_ranks
       loop do
-        break if max_iterations == 0
-        ranks, prev_ranks = calculate_step(ranks), ranks
+        break if max_iterations.zero?
+
+        prev_ranks = ranks
+        ranks = calculate_step(ranks)
         break if distance(ranks, prev_ranks) < @tolerance
+
         max_iterations -= 1
       end
       sort_ranks(ranks)
@@ -77,9 +78,9 @@ module PageRank
     end
 
     # Calculate the Euclidean distance from one ranking to the next iteration
-    def distance(v1, v2)
+    def distance(vector1, vector2)
       sum_squares = node_count.times.reduce(0.0) do |sum, i|
-        d = v1[i] - v2[i]
+        d = vector1[i] - vector2[i]
         sum + d * d
       end
       Math.sqrt(sum_squares)

data/lib/page_rank/dense.rb

@@ -32,6 +32,7 @@ module PageRank
     # @return (see Base#add)
     def add(source, dest, weight: 1.0)
       return if source == dest
+
       source_idx = index(source)
       dest_idx = index(dest)
       @out_links[source_idx] ||= []
@@ -72,7 +73,7 @@ module PageRank
 
     def to_matrix
       total_out_weights = @out_links.map do |links|
-        links.compact.reduce(:+) if links
+        links&.compact&.reduce(:+)
       end
       Matrix.build(node_count, node_count) do |dest_idx, source_idx|
         total = total_out_weights[source_idx]

data/lib/page_rank/sparse.rb

@@ -1,5 +1,3 @@
-require 'set'
-
 module PageRank
   ##
   # Implementation of PageRank using a sparse matrix representation of the graph
@@ -33,6 +31,7 @@ module PageRank
     # @return (see Base#add)
     def add(source, dest, weight: 1.0)
       return false if source == dest
+
       @graph[dest] ||= Set.new
       @graph[dest] << source
       @weights[source] ||= Hash.new(0.0)
@@ -53,8 +52,8 @@ module PageRank
     def initial_ranks
       @dangling_nodes = @nodes - @weight_totals.keys
       @normalized_weights = @weights.each_with_object({}) do |(source, values), h|
-        h[source] = values.each_with_object({}) do |(dest, w), h2| 
-          h2[dest] = w / @weight_totals[source]
+        h[source] = values.transform_values do |w|
+          w / @weight_totals[source]
         end
       end
       Hash[@nodes.map { |k| [k, 1.0 / node_count.to_f] }]
@@ -69,7 +68,7 @@ module PageRank
         @dangling_nodes.each do |source|
           sum += ranks[source] / node_count.to_f
         end
-        new_ranks[dest] = @damping * sum + (1 - @damping)/node_count
+        new_ranks[dest] = @damping * sum + (1 - @damping) / node_count
       end
     end
 
@@ -79,8 +78,8 @@ module PageRank
       Hash[ranks.map { |k, v| [k, v / sum] }.sort_by { |_, v| -v }]
     end
 
-    def distance(v1, v2)
-      super(v1.values.to_a, v2.values.to_a)
+    def distance(vector1, vector2)
+      super(vector1.values.to_a, vector2.values.to_a)
     end
 
   end

data/lib/text_rank.rb

@@ -1,4 +1,6 @@
 require 'page_rank'
+require 'set'
+require 'yaml'
 
 ##
 # Provides convenience methods for quickly extracting keywords.
@@ -7,14 +9,15 @@ require 'page_rank'
 ##
 module TextRank
 
-  autoload :CharFilter,       'text_rank/char_filter'
-  autoload :Fingerprint,      'text_rank/fingerprint'
-  autoload :GraphStrategy,    'text_rank/graph_strategy'
-  autoload :KeywordExtractor, 'text_rank/keyword_extractor'
-  autoload :RankFilter,       'text_rank/rank_filter'
-  autoload :TokenFilter,      'text_rank/token_filter'
-  autoload :Tokenizer,        'text_rank/tokenizer'
-  autoload :VERSION,          'text_rank/version'
+  autoload :CharFilter,         'text_rank/char_filter'
+  autoload :Fingerprint,        'text_rank/fingerprint'
+  autoload :FingerprintOverlap, 'text_rank/fingerprint_overlap'
+  autoload :GraphStrategy,      'text_rank/graph_strategy'
+  autoload :KeywordExtractor,   'text_rank/keyword_extractor'
+  autoload :RankFilter,         'text_rank/rank_filter'
+  autoload :TokenFilter,        'text_rank/token_filter'
+  autoload :Tokenizer,          'text_rank/tokenizer'
+  autoload :VERSION,            'text_rank/version'
 
   # A convenience method for quickly extracting keywords from text with default options
   # @param text [String] text from which to extract keywords

data/lib/text_rank/char_filter.rb

@@ -7,7 +7,7 @@ module TextRank
   # converting non-ascii characters to related ascii characters, forcing text to
   # lower case, stripping out HTML, converting English contractions (e.g. "won't")
   # to the non-contracted form ("will not"), and more.
-  # 
+  #
   # Character filters are applied as a chain, so care should be taken to use them
   # in the desired order.
   ##

data/lib/text_rank/char_filter/ascii_folding.rb

@@ -1,13 +1,17 @@
-# coding: utf-8
 module TextRank
   module CharFilter
     ##
     # Characater filter to transform non-ASCII (unicode) characters into ASCII-friendly versions.
     #
+    # rubocop:disable Style/AsciiComments
+    #
     # = Example
     #
     #  AsciiFolding.new.filter!("the Perigordian Abbé then made answer, because a poor beggar of the country of Atrébatie heard some foolish things said")
     #  => "the Perigordian Abbe then made answer, because a poor beggar of the country of Atrebatie heard some foolish things said"
+    #
+    # rubocop:enable Style/AsciiComments
+    #
     ##
     class AsciiFolding
 

data/lib/text_rank/char_filter/strip_possessive.rb

@@ -5,7 +5,7 @@ module TextRank
     #
     # = Example
     #
-    #  StripPosessive.new.filter!("to loathe one’s very being and yet to hold it fast")
+    #  StripPosessive.new.filter!("to loathe one's very being and yet to hold it fast")
     #  => "to loathe one very being and yet to hold it fast"
     ##
     class StripPossessive
@@ -15,7 +15,7 @@ module TextRank
       # @return [String]
       def filter!(text)
         text.gsub!(/([a-z]+)'s\b/) do
-          $1
+          Regexp.last_match(1)
         end
       end
 

data/lib/text_rank/char_filter/undo_contractions.rb

@@ -11,143 +11,7 @@ module TextRank
     class UndoContractions
 
       # List of English contractions to undo
-      CONTRACTIONS = {
-        "ain't"            => "am not",
-        "amn't"            => "am not",
-        "aren't"           => "are not",
-        "can't"            => "can not",
-        "could've"         => "could have",
-        "couldn't"         => "could not",
-        "couldn't've"      => "could not have",
-        "didn't"           => "did not",
-        "doesn't"          => "does not",
-        "don't"            => "do not",
-        "gonna"            => "going to",
-        "hadn't"           => "had not",
-        "hadn't've"        => "had not have",
-        "hasn't"           => "has not",
-        "haven't"          => "have not",
-        "he'd"             => "he had",
-        "he'd've"          => "he would have",
-        "he'll"            => "he shall",
-        "he's"             => "he has",
-        "he'sn't"          => "he has not",
-        "how'd"            => "how did",
-        "how'll"           => "how will",
-        "how's"            => "how has",
-        "i'd"              => "i had",
-        "i'd've"           => "i would have",
-        "i'll"             => "i shall",
-        "i'm"              => "i am",
-        "i've"             => "i have",
-        "i'ven't"          => "i have not",
-        "isn't"            => "is not",
-        "it'd"             => "it had",
-        "it'd've"          => "it would have",
-        "it'll"            => "it shall",
-        "it's"             => "it has",
-        "it'sn't"          => "it has not",
-        "let's"            => "let us",
-        "ma'am"            => "madam",
-        "mightn't"         => "might not",
-        "mightn't've"      => "might not have",
-        "might've"         => "might have",
-        "mustn't"          => "must not",
-        "must've"          => "must have",
-        "needn't"          => "need not",
-        "not've"           => "not have",
-        "o'clock"          => "of the clock",
-        "ol'"              => "old",
-        "oughtn't"         => "ought not",
-        "shan't"           => "shall not",
-        "she'd"            => "she had",
-        "she'd've"         => "she would have",
-        "she'll"           => "she shall",
-        "she's"            => "she has",
-        "she'sn't"         => "she has not",
-        "should've"        => "should have",
-        "shouldn't"        => "should not",
-        "shouldn't've"     => "should not have",
-        "somebody'd"       => "somebody had",
-        "somebody'd've"    => "somebody would have",
-        "somebody'dn't've" => "somebody would not have",
-        "somebody'll"      => "somebody shall",
-        "somebody's"       => "somebody has",
-        "someone'd"        => "someone had",
-        "someone'd've"     => "someone would have",
-        "someone'll"       => "someone shall",
-        "someone's"        => "someone has",
-        "something'd"      => "something had",
-        "something'd've"   => "something would have",
-        "something'll"     => "something shall",
-        "something's"      => "something has",
-        "'sup"             => "what's up",
-        "that'll"          => "that will",
-        "that's"           => "that has",
-        "there'd"          => "there had",
-        "there'd've"       => "there would have",
-        "there're"         => "there are",
-        "there's"          => "there has",
-        "they'd"           => "they had",
-        "they'dn't"        => "they would not",
-        "they'dn't've"     => "they would not have",
-        "they'd've"        => "they would have",
-        "they'd'ven't"     => "they would have not",
-        "they'll"          => "they shall",
-        "they'lln't've"    => "they will not have",
-        "they'll'ven't"    => "they will have not",
-        "they're"          => "they are",
-        "they've"          => "they have",
-        "they'ven't"       => "they have not",
-        "'tis"             => "it is",
-        "'twas"            => "it was",
-        "wanna"            => "want to",
-        "wasn't"           => "was not",
-        "we'd"             => "we had",
-        "we'd've"          => "we would have",
-        "we'dn't've"       => "we would not have",
-        "we'll"            => "we will",
-        "we'lln't've"      => "we will not have",
-        "we're"            => "we are",
-        "we've"            => "we have",
-        "weren't"          => "were not",
-        "what'll"          => "what shall",
-        "what're"          => "what are",
-        "what's"           => "what has",
-        "what've"          => "what have",
-        "when's"           => "when has",
-        "where'd"          => "where did",
-        "where's"          => "where has",
-        "where've"         => "where have",
-        "who'd"            => "who would",
-        "who'd've"         => "who would have",
-        "who'll"           => "who shall",
-        "who're"           => "who are",
-        "who's"            => "who has",
-        "who've"           => "who have",
-        "why'll"           => "why will",
-        "why're"           => "why are",
-        "why's"            => "why has",
-        "won't"            => "will not",
-        "won't've"         => "will not have",
-        "would've"         => "would have",
-        "wouldn't"         => "would not",
-        "wouldn't've"      => "would not have",
-        "y'all"            => "you all",
-        "y'all'd've"       => "you all would have",
-        "y'all'dn't've"    => "you all would not have",
-        "y'all'll"         => "you all will",
-        "y'all'lln't"      => "you all will not",
-        "y'all'll've"      => "you all will have",
-        "y'all'll'ven't"   => "you all will have not",
-        "you'd"            => "you had",
-        "you'd've"         => "you would have",
-        "you'll"           => "you shall",
-        "you're"           => "you are",
-        "you'ren't"        => "you are not",
-        "you've"           => "you have",
-        "you'ven't"        => "you have not",
-      }
+      CONTRACTIONS = YAML.load_file(File.expand_path('undo_contractions.yml', __dir__))
 
       # Perform the filter
       # @param text [String]

data/lib/text_rank/char_filter/undo_contractions.yml

@@ -0,0 +1,135 @@
+ain't:            am not
+amn't:            am not
+aren't:           are not
+can't:            can not
+could've:         could have
+couldn't:         could not
+couldn't've:      could not have
+didn't:           did not
+doesn't:          does not
+don't:            do not
+gonna:            going to
+hadn't:           had not
+hadn't've:        had not have
+hasn't:           has not
+haven't:          have not
+he'd:             he had
+he'd've:          he would have
+he'll:            he shall
+he's:             he has
+he'sn't:          he has not
+how'd:            how did
+how'll:           how will
+how's:            how has
+i'd:              i had
+i'd've:           i would have
+i'll:             i shall
+i'm:              i am
+i've:             i have
+i'ven't:          i have not
+isn't:            is not
+it'd:             it had
+it'd've:          it would have
+it'll:            it shall
+it's:             it has
+it'sn't:          it has not
+let's:            let us
+ma'am:            madam
+mightn't:         might not
+mightn't've:      might not have
+might've:         might have
+mustn't:          must not
+must've:          must have
+needn't:          need not
+not've:           not have
+o'clock:          of the clock
+ol':              old
+oughtn't:         ought not
+shan't:           shall not
+she'd:            she had
+she'd've:         she would have
+she'll:           she shall
+she's:            she has
+she'sn't:         she has not
+should've:        should have
+shouldn't:        should not
+shouldn't've:     should not have
+somebody'd:       somebody had
+somebody'd've:    somebody would have
+somebody'dn't've: somebody would not have
+somebody'll:      somebody shall
+somebody's:       somebody has
+someone'd:        someone had
+someone'd've:     someone would have
+someone'll:       someone shall
+someone's:        someone has
+something'd:      something had
+something'd've:   something would have
+something'll:     something shall
+something's:      something has
+"'sup":           "what's up"
+that'll:          that will
+that's:           that has
+there'd:          there had
+there'd've:       there would have
+there're:         there are
+there's:          there has
+they'd:           they had
+they'dn't:        they would not
+they'dn't've:     they would not have
+they'd've:        they would have
+they'd'ven't:     they would have not
+they'll:          they shall
+they'lln't've:    they will not have
+they'll'ven't:    they will have not
+they're:          they are
+they've:          they have
+they'ven't:       they have not
+"'tis":           it is
+"'twas":          it was
+wanna:            want to
+wasn't:           was not
+we'd:             we had
+we'd've:          we would have
+we'dn't've:       we would not have
+we'll:            we will
+we'lln't've:      we will not have
+we're:            we are
+we've:            we have
+weren't:          were not
+what'll:          what shall
+what're:          what are
+what's:           what has
+what've:          what have
+when's:           when has
+where'd:          where did
+where's:          where has
+where've:         where have
+who'd:            who would
+who'd've:         who would have
+who'll:           who shall
+who're:           who are
+who's:            who has
+who've:           who have
+why'll:           why will
+why're:           why are
+why's:            why has
+won't:            will not
+won't've:         will not have
+would've:         would have
+wouldn't:         would not
+wouldn't've:      would not have
+y'all:            you all
+y'all'd've:       you all would have
+y'all'dn't've:    you all would not have
+y'all'll:         you all will
+y'all'lln't:      you all will not
+y'all'll've:      you all will have
+y'all'll'ven't:   you all will have not
+you'd:            you had
+you'd've:         you would have
+you'll:           you shall
+you're:           you are
+you'ren't:        you are not
+you've:           you have
+you'ven't:        you have not