text_rank 1.2.4 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57c44c7be2d14f3fb9d2b76212639c6f5416adedeb32e3c9d39a6b90368680bd
-  data.tar.gz: 829bf430e9cc9dd942bdd753f801fc01d94929f42be09c6504691d47bc7c9f04
+  metadata.gz: 249809a9542815b7df91ccbf44c09c71c27056c8ffd433f01c07950aafee4900
+  data.tar.gz: 6d59f46f79abe151ff5b2a35f1965849d773bc4da853c25f5bde8bb5584239b4
 SHA512:
-  metadata.gz: 7bdb293e07cca83ba7665cbe3861360cd3e4b82d64d5cd2167717e509bff6ccf14948436463464a9ab57f92cd97b8e7a918d27d004f3a7c476feb5c55565191f
-  data.tar.gz: 446d28deeca6a972fc9b257b8699a859ec4fc481d6f04f31d02215d79a7251b87cfebeaba7335001e7977e974b72c3e79113c754d1749303dc943b3d59c6d62c
+  metadata.gz: bbd0aa099bde48e809246ecb2c08e6491c477fdf69c68556e6171ed6aff6541f56aeef99416d077cd68875e22c33af3b99b454659179aa8e515bf50ddf9636a4
+  data.tar.gz: 109825e24f9c030dd693202bb37f74cf7f6f096b8c53f0aed5978acac11f19d9dd3382adacf6d7dd419844c730f36468c4cf954fbff4a3dad0c22adef57eb627

data/.codeclimate.yml

@@ -1,22 +1,32 @@
 ---
 engines:
+  cppcheck:
+    enabled: true
+    check: all
+    inline-suppr: true
+    language: c
   duplication:
     enabled: true
     config:
       languages:
+      - c
       - ruby
     checks:
       Similar code:
         enabled: false
   fixme:
     enabled: true
+  flog:
+    enabled: true
+    config:
+      score_threshold: 20.0
   rubocop:
     enabled: true
     exclude_fingerprints:
     - 4218049e28199ed950d3cd721df86dce
     - c8179d0de3a9df18a2c45750d3f8647e
     - 03f6eee11d86507da564695007106721
-    channel: rubocop-0-85
+    channel: rubocop-1-23-0
 ratings:
   paths:
   - "**.rb"

data/.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Compile native extensions
+      run: bundle exec rake clobber compile
+    - name: Run tests
+      run: bundle exec rake spec
+    - name: Rubocop
+      run: bundle exec rubocop
+    - name: cppcheck
+      uses: deep5050/cppcheck-action@main
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN}}
+        enable: all
+        exclude_check: ./vendor
+        force_language: c
+        inline_suppression: enable
+        other_options: --suppress=missingIncludeSystem
+    - name: Send coverage to Code Climate
+      uses: paambaati/codeclimate-action@v3.0.0
+      env:
+        CC_TEST_REPORTER_ID: 6ab030bf370ffc2abbf0ba4d70a1c8d9649f6fd1426f48f6d43d5c9eb15f187f
+      with:
+        coverageLocations: ${{github.workspace}}/coverage/coverage.json:simplecov
+        coverageCommand: bundle exec rake coverage

data/.gitignore

@@ -8,3 +8,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+
+*.bundle
+*.so

data/.rubocop.yml

@@ -1,142 +1,202 @@
 AllCops:
   Exclude:
-    - text_rank.gemspec
-    - Rakefile
-
+  - ext/**/*
+  - tmp/**/*
+  - vendor/**/*
+Gemspec/DateAssignment:
+  Enabled: true
+Gemspec/RequireMFA:
+  Enabled: true
 Layout/EmptyLinesAroundAttributeAccessor:
   Enabled: true
-
 Layout/EmptyLinesAroundClassBody:
   EnforcedStyle: empty_lines_except_namespace
-
 Layout/EmptyLinesAroundModuleBody:
   EnforcedStyle: empty_lines_except_namespace
-
 Layout/ExtraSpacing:
   Enabled: false
-
 Layout/HashAlignment:
   EnforcedHashRocketStyle: table
   EnforcedColonStyle: table
-
+Layout/LineEndStringConcatenationIndentation:
+  Enabled: true
 Layout/LineLength:
   Max: 120
   Enabled: false
-
 Layout/SpaceAroundMethodCallOperator:
   Enabled: true
-
+Layout/SpaceBeforeBrackets:
+  Enabled: true
+Lint/AmbiguousAssignment:
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: true
+Lint/AmbiguousRange:
+  Enabled: true
+Lint/DeprecatedConstants:
+  Enabled: true
 Lint/DeprecatedOpenSSLConstant:
   Enabled: true
-
+Lint/DuplicateBranch:
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+Lint/EmptyBlock:
+  Enabled: true
+Lint/EmptyClass:
+  Enabled: true
+Lint/EmptyInPattern:
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler:
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock:
+  Enabled: true
 Lint/MixedRegexpCaptureTypes:
   Enabled: true
-
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+Lint/NumberedParameterAssignment:
+  Enabled: true
+Lint/OrAssignmentToConstant:
+  Enabled: true
 Lint/RaiseException:
   Enabled: true
-
+Lint/RedundantDirGlobSort:
+  Enabled: true
+Lint/RequireRelativeSelfPath:
+  Enabled: true
 Lint/StructNewOverride:
   Enabled: true
-
+Lint/SymbolConversion:
+  Enabled: true
+Lint/ToEnumArguments:
+  Enabled: true
+Lint/TripleQuotes:
+  Enabled: true
+Lint/UnexpectedBlockArity:
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+Lint/UselessRuby2Keywords:
+  Enabled: true
 Metrics/AbcSize:
   Max: 50
   Enabled: false
-
 Metrics/BlockLength:
   Max: 50
   Enabled: false
-
 Metrics/ClassLength:
   Max: 50
   Enabled: false
-
 Metrics/CyclomaticComplexity:
   Max: 30
   Enabled: false
-
 Metrics/MethodLength:
   Max: 20
   Enabled: false
-
 Metrics/ModuleLength:
   Max: 1000
   Enabled: false
-
 Metrics/PerceivedComplexity:
   Max: 30
   Enabled: false
-
+Naming/BlockForwarding:
+  Enabled: true
+Security/IoMethods:
+  Enabled: true
 Security/MarshalLoad:
   Enabled: false
-
 Style/AndOr:
   Enabled: false
-
+Style/ArgumentsForwarding:
+  Enabled: true
 Style/CaseEquality:
   Enabled: false
-
+Style/CollectionCompact:
+  Enabled: true
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
 Style/Documentation:
   Enabled: false
-
 Style/DoubleNegation:
   Enabled: false
-
+Style/EndlessMethod:
+  Enabled: true
 Style/ExponentialNotation:
   Enabled: true
-
+Style/FileRead:
+  Enabled: true
+Style/FileWrite:
+  Enabled: true
 Style/FrozenStringLiteralComment:
   Enabled: false
-
 Style/GuardClause:
   Enabled: false
-
+Style/HashConversion:
+  Enabled: true
 Style/HashEachMethods:
   Enabled: true
-
+Style/HashExcept:
+  Enabled: true
 Style/HashSyntax:
   Enabled: true
-
 Style/HashTransformKeys:
   Enabled: true
-
 Style/HashTransformValues:
   Enabled: true
-
 Style/IfUnlessModifier:
   Enabled: false
-
+Style/IfWithBooleanLiteralBranches:
+  Enabled: true
+Style/InPatternThen:
+  Enabled: true
+Style/MapToHash:
+  Enabled: true
 Style/MultilineBlockChain:
   Enabled: false
-
 Style/MultilineIfModifier:
   Enabled: false
-
+Style/MultilineInPatternThen:
+  Enabled: true
 Style/MutableConstant:
   Enabled: false
-
+Style/NegatedIfElseCondition:
+  Enabled: true
+Style/NilLambda:
+  Enabled: true
+Style/NumberedParameters:
+  Enabled: true
+Style/NumberedParametersLimit:
+  Enabled: true
+Style/OpenStructUse:
+  Enabled: true
+Style/QuotedSymbols:
+  Enabled: true
+Style/RedundantArgument:
+  Enabled: true
 Style/RedundantRegexpCharacterClass:
   Enabled: true
-
 Style/RedundantRegexpEscape:
   Enabled: true
-
+Style/RedundantSelfAssignmentBranch:
+  Enabled: true
 Style/RescueModifier:
   Enabled: false
-
 Style/RescueStandardError:
   Enabled: false
-
+Style/SelectByRegexp:
+  Enabled: true
 Style/SlicingWithRange:
   Enabled: true
-
+Style/StringChars:
+  Enabled: true
+Style/SwapValues:
+  Enabled: true
 Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: comma
-
 Style/TrailingCommaInArrayLiteral:
   EnforcedStyleForMultiline: consistent_comma
-
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: consistent_comma
-
 Style/ZeroLengthPredicate:
   Enabled: false

data/.ruby-version

@@ -1 +1 @@
-ruby-2.5.1
+ruby-3.0.3

data/.yardopts

@@ -0,0 +1,6 @@
+--readme README.md
+--title 'TextRank Documentation'
+--charset utf-8
+--markup-provider=redcarpet
+--markup markdown
+'lib/**/*.rb' - '*.md'

data/CODE_OF_CONDUCT.md

@@ -1,49 +1,133 @@
-# Contributor Code of Conduct
 
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
+# Contributor Covenant Code of Conduct
 
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
+## Our Pledge
 
-Examples of unacceptable behavior by participants include:
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
 
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
 
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
 
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
+## Scope
 
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at david@bloomfire.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/README.md

@@ -8,9 +8,10 @@
 ## Status
 
 [![Gem Version](https://badge.fury.io/rb/text_rank.svg)](https://badge.fury.io/rb/text_rank)
-[![Travis Build Status](https://travis-ci.org/david-mccullars/text_rank.svg?branch=master)](https://travis-ci.org/david-mccullars/text_rank)
+[![Build Status](https://github.com/david-mccullars/text_rank/workflows/CI/badge.svg)](https://github.com/david-mccullars/text_rank/actions?workflow=CI)
 [![Code Climate](https://codeclimate.com/github/david-mccullars/text_rank/badges/gpa.svg)](https://codeclimate.com/github/david-mccullars/text_rank)
 [![Test Coverage](https://codeclimate.com/github/david-mccullars/text_rank/badges/coverage.svg)](https://codeclimate.com/github/david-mccullars/text_rank/coverage)
+[![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
 
 
 ## Description
@@ -45,7 +46,7 @@ gem install text_rank
 
 ## Requirements
 
-* Ruby 2.1.2 or higher
+* Ruby 3.0.0 or higher
 * [engtagger](https://github.com/yohasebe/engtagger) gem is optional but
 required for `TextRank::TokenFilter::PartOfSpeech`
 * [nokogiri](https://github.com/sparklemotion/nokogiri) gem is optional but
@@ -82,7 +83,7 @@ extractor = TextRank::KeywordExtractor.new(
   damping:    0.85,     # The probability of following the graph vs. randomly choosing a new node
   tolerance:  0.0001,   # The desired accuracy of the results
   char_filters: [...],  # A list of filters to be applied prior to tokenization
-  tokenizer: ...,       # A class or tokenizer instance to perform tokenization
+  tokenizers: [...],    # A list of tokenizers to perform tokenization
   token_filters: [...], # A list of filters to be applied to each token after tokenization
   graph_strategy: ...,  # A class or strategy instance for producing a graph from tokens
   rank_filters: [...],  # A list of filters to be applied to the keyword ranks after keyword extraction

data/Rakefile

@@ -1,12 +1,14 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rake/extensiontask'
+require 'rspec/core/rake_task'
+require 'yard'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
-require 'rdoc/task'
-RDoc::Task.new do |rdoc|
-  rdoc.main = "README.md"
-  rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
+YARD::Rake::YardocTask.new
+
+Rake::ExtensionTask.new('text_rank') do |ext|
+  ext.lib_dir = 'lib/text_rank'
 end

data/ext/text_rank/extconf.rb

@@ -0,0 +1,3 @@
+require "mkmf"
+
+create_makefile('text_rank/text_rank')