engtagger 0.3.2 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6aa6da6cfb58bffd900843f62675d5895e80428be7295ae056ed73327286233d
-  data.tar.gz: dd412266b905ba4d378521540247a368bc4f73dfa89e8d6e58c220625c46e40d
+  metadata.gz: fe357706e69ed72bec9569babe91cc8531e2c1d0eac71ac8d248bdd74b97ba98
+  data.tar.gz: 02e6bb2ba29ecabf8e5087c5a2dc92ccad57ef3578fbd9c844f93188a4d39ced
 SHA512:
-  metadata.gz: de1aa006ea943270e4dcea78690e8a10551c42819abbf3c27b6d2629d600745124ec5cfa6a6104d3cb4c87dbfc14d09e643e7b2143979dee27485841fd76b0fe
-  data.tar.gz: 3404a699868beb475daee809cc67788a70152c0d5eba045b7d3c007e3b3fccb66ee6bb432832a8e9872cd6d3faf281fab60bf151c01eaf1cf52d6275644012bb
+  metadata.gz: 5e477b0d839e825e8d49135cb6d6c72c21555454d6f722d00b994442cdaaba2b1afa84ab8f22f82f64b9540a0e24914180c59a563830ea11b2a0239921d3e88e
+  data.tar.gz: 49b02532d7ad940b25b19ba59df364fc553373371f7850f068729af3a339773417ad7f8d5e0e58ecc3facc6ef2168ae86bb9f94a46f9a412bf51d7de36fdab1e

data/.rubocop.yml

@@ -0,0 +1,72 @@
+AllCops:
+  NewCops: disable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.6
+
+Documentation:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Security/MarshalLoad:
+  Enabled: false
+
+Style/ClassVars:
+  Enabled: false
+
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+Style/StringConcatenation:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/WordArray:
+  Enabled: false
+
+Style/EvalWithLocation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 400
+
+Metrics/MethodLength:
+  Max: 80
+
+Metrics/BlockLength:
+  Max: 60
+
+Metrics/AbcSize:
+  Max: 60
+
+Metrics/PerceivedComplexity:
+  Max: 60
+
+Metrics/ClassLength:
+  Max: 800
+
+Metrics/CyclomaticComplexity:
+  Max: 60
+
+Metrics/ParameterLists:
+  Max: 8
+
+Metrics/ModuleLength:
+  Max: 200

data/.solargraph.yml

@@ -0,0 +1,22 @@
+---
+include:
+- "**/*.rb"
+exclude:
+- spec/**/*
+- test/**/*
+- vendor/**/*
+- ".bundle/**/*"
+require: []
+domains: []
+reporters:
+- rubocop
+# - require_not_found
+formatter:
+  rubocop:
+    cops: safe
+    except: []
+    only: []
+    extra_args: []
+require_paths: []
+plugins: []
+max_files: 5000

data/Gemfile

@@ -1,3 +1,7 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
 
-gem 'lru_redux'
+source "https://rubygems.org"
+
+gemspec
+
+gem "lru_redux"

data/README.md

@@ -2,7 +2,7 @@
 
 English Part-of-Speech Tagger Library; a Ruby port of Lingua::EN::Tagger
 
-### Description
+## Description
 
 A Ruby port of Perl Lingua::EN::Tagger, a probability based, corpus-trained
 tagger that assigns POS tags to English text based on a lookup dictionary and
@@ -13,64 +13,66 @@ word morphology or can be set to be treated as nouns or other parts of speech.
 The tagger also extracts as many nouns and noun phrases as it can, using a set
 of regular expressions.
 
-### Features
+## Features
 
 * Assigns POS tags to English text
 * Extract noun phrases from tagged text
 * etc.
 
-### Synopsis:
+## Synopsis
 
-    require 'engtagger'
+```ruby
+require 'engtagger'
 
-    # Create a parser object
-    tgr = EngTagger.new
+# Create a parser object
+tgr = EngTagger.new
 
-    # Sample text
-    text = "Alice chased the big fat cat."
+# Sample text
+text = "Alice chased the big fat cat."
 
-    # Add part-of-speech tags to text
-    tagged = tgr.add_tags(text)
+# Add part-of-speech tags to text
+tagged = tgr.add_tags(text)
 
-    #=> "<nnp>Alice</nnp> <vbd>chased</vbd> <det>the</det> <jj>big</jj> <jj>fat</jj><nn>cat</nn> <pp>.</pp>"
+#=> "<nnp>Alice</nnp> <vbd>chased</vbd> <det>the</det> <jj>big</jj> <jj>fat</jj><nn>cat</nn> <pp>.</pp>"
 
-    # Get a list of all nouns and noun phrases with occurrence counts
-    word_list = tgr.get_words(text)
+# Get a list of all nouns and noun phrases with occurrence counts
+word_list = tgr.get_words(text)
 
-    #=> {"Alice"=>1, "cat"=>1, "fat cat"=>1, "big fat cat"=>1}
+#=> {"Alice"=>1, "cat"=>1, "fat cat"=>1, "big fat cat"=>1}
 
-    # Get a readable version of the tagged text
-    readable = tgr.get_readable(text)
+# Get a readable version of the tagged text
+readable = tgr.get_readable(text)
 
-    #=> "Alice/NNP chased/VBD the/DET big/JJ fat/JJ cat/NN ./PP"
+#=> "Alice/NNP chased/VBD the/DET big/JJ fat/JJ cat/NN ./PP"
 
-    # Get all nouns from a tagged output
-    nouns = tgr.get_nouns(tagged)
+# Get all nouns from a tagged output
+nouns = tgr.get_nouns(tagged)
 
-    #=> {"cat"=>1, "Alice"=>1}
+#=> {"cat"=>1, "Alice"=>1}
 
-    # Get all proper nouns
-    proper = tgr.get_proper_nouns(tagged)
+# Get all proper nouns
+proper = tgr.get_proper_nouns(tagged)
 
-    #=> {"Alice"=>1}
+#=> {"Alice"=>1}
 
-    # Get all past tense verbs
-    pt_verbs = tgr.get_past_tense_verbs(tagged)
+# Get all past tense verbs
+pt_verbs = tgr.get_past_tense_verbs(tagged)
 
-    #=> {"chased"=>1}
+#=> {"chased"=>1}
 
-    # Get all the adjectives
-    adj = tgr.get_adjectives(tagged)
+# Get all the adjectives
+adj = tgr.get_adjectives(tagged)
 
-    #=> {"big"=>1, "fat"=>1}
+#=> {"big"=>1, "fat"=>1}
 
-    # Get all noun phrases of any syntactic level
-    # (same as word_list but take a tagged input)
-    nps = tgr.get_noun_phrases(tagged)
+# Get all noun phrases of any syntactic level
+# (same as word_list but take a tagged input)
+nps = tgr.get_noun_phrases(tagged)
 
-    #=> {"Alice"=>1, "cat"=>1, "fat cat"=>1, "big fat cat"=>1}
+#=> {"Alice"=>1, "cat"=>1, "fat cat"=>1, "big fat cat"=>1}
+```
 
-### Tag Set
+## Tag Set
 
 The set of POS tags used here is a modified version of the Penn Treebank tagset. Tags with non-letter characters have been redefined to work better in our data structures. Also, the "Determiner" tag (DET) has been changed from 'DT', in order to avoid confusion with the HTML tag, `<DT>`.
 
@@ -120,26 +122,56 @@ The set of POS tags used here is a modified version of the Penn Treebank tagset.
     LRB     Punctuation, left bracket               (, {, [
     RRB     Punctuation, right bracket              ), }, ]
 
-### Install
+## Installation
 
-    gem install engtagger
+**Recommended Approach (without sudo):**
 
-### Author
+It is recommended to install the `engtagger` gem within your user environment without root privileges. This ensures proper file permissions and avoids potential issues. You can achieve this by using Ruby version managers like `rbenv` or `rvm` to manage your Ruby versions and gemsets.
 
-of this Ruby library
+To install without `sudo`, simply run:
 
-* Yoichiro Hasebe (yohasebe [at] gmail.com)
+```bash
+gem install engtagger
+```
 
-### Contributors
+**Alternative Approach (with sudo):**
+
+If you must use `sudo` for installation, you'll need to adjust file permissions afterward to ensure accessibility.
+
+1. Install the gem with `sudo`:
+
+```bash
+sudo gem install engtagger
+```
+
+2. Grant necessary permissions to your user:
+
+```bash
+sudo chown -R $(whoami) /Library/Ruby/Gems/2.6.0/gems/engtagger-0.4.1
+```
+
+**Note:** The path above assumes you are using Ruby version 2.6.0.  If you are using a different version, you will need to modify the path accordingly.  You can find your Ruby version by running `ruby -v`. 
+
+## Troubleshooting
+
+**Permission Issues:**
+
+If you encounter "cannot load such file" errors after installation, it might be due to incorrect file permissions. Ensure you've followed the instructions for adjusting permissions if you used `sudo` during installation.
+
+## Author
+
+Yoichiro Hasebe (yohasebe [at] gmail.com)
+
+## Contributors
 
 Many thanks to the collaborators listed in the right column of this GitHub page.
 
-### Acknowledgement
+## Acknowledgement
 
 This Ruby library is a direct port of Lingua::EN::Tagger available at CPAN.
 The credit for the crucial part of its algorithm/design therefore goes to
 Aaron Coburn, the author of the original Perl version.
 
-### License
+## License
 
 This library is distributed under the GPL.  Please see the LICENSE file.

data/Rakefile

@@ -1,2 +1,10 @@
-#!/usr/bin/env rake
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/test*.rb"]
+  t.verbose = true
+end

data/engtagger.gemspec

@@ -1,19 +1,22 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/engtagger/version', __FILE__)
+# frozen_string_literal: true
+
+require_relative "lib/engtagger/version"
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Yoichiro Hasebe"]
   gem.email         = ["yohasebe@gmail.com"]
-  gem.summary         = %q{A probability based, corpus-trained English POS tagger}
-  gem.description     = %q{A Ruby port of Perl Lingua::EN::Tagger, a probability based, corpus-trained tagger that assigns POS tags to English text based on a lookup dictionary and a set of probability values.}
-  gem.homepage        = "http://github.com/yohasebe/engtagger"
-
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.summary       = "A probability based, corpus-trained English POS tagger"
+  gem.description   = "A Ruby port of Perl Lingua::EN::Tagger, a probability based, corpus-trained tagger that assigns POS tags to English text based on a lookup dictionary and a set of probability values."
+  gem.homepage      = "http://github.com/yohasebe/engtagger"
+  gem.license       = "GPL"
+  gem.required_ruby_version = Gem::Requirement.new(">= 2.6")
+  gem.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "engtagger"
   gem.require_paths = ["lib"]
   gem.version       = EngTagger::VERSION
-
-  gem.add_runtime_dependency 'lru_redux'
+  gem.add_dependency "lru_redux"
 end