linter 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ceb622ab960b3b1acc543c89e7547c308a279a26dbe4093c305184932559e801
-  data.tar.gz: a000bbffd2abb54812bd1762bca8985121f5d0b7c9736ff07b4d7184ce58ebf3
+  metadata.gz: 891a38caa1685cee1fe11e2006c807c23b8e112028ad552007898138673ee683
+  data.tar.gz: 3d68d364d06b5d2a6bc832c5c94cfb2a84f563dafcb649d22544ec04af74abf0
 SHA512:
-  metadata.gz: 89b07c343065872b75590dfc757718550c8114522229f9aa9ad21f3ff0d1b48a68de49f2903da78e5d6a72d832ad4af139c089e58d53719cbdbc8f9c32b68255
-  data.tar.gz: 9db243a571e737dd07b08939360807f7172eb9e050cd2f05f196cd21961e4af7587728fde8a3917a6f2f416eaceb7334e32b427db9b5e145dbb9bec73fa2ecf7
+  metadata.gz: fb351872595a77331720b17af03161e5e1bc2ab4e0cb726e2d078992d8aedd588cbda4141b223a22e7d69e6c9b614cafa625029a4ee054394c4cbf7b208f30a7
+  data.tar.gz: 9981d44b3f7ab665a60570a1921ba1eb81f461e0475b49fca66d2f5549b1a85c2ee4f28cd20eeb61158fb6fd367e3b36613c2aacf1ec2352fdcbcbcb17d287bd

data/.gitlab-ci.yml

@@ -5,3 +5,14 @@ rspec:
   script:
     - bundle install
     - bundle exec rspec
+
+rubocop:
+  stage: test
+  only:
+    - merge_requests
+  script:
+    - bundle install
+    - bundle exec rubocop
+
+include:
+  template: Dependency-Scanning.gitlab-ci.yml

data/.rubocop.yml

@@ -0,0 +1,70 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-rspec
+AllCops:
+  TargetRubyVersion: 2.6
+  # Cop names are displayed in offense messages by default. Change behavior
+  # by overriding DisplayCopNames, or by giving the `--no-display-cop-names`
+  # option.
+  DisplayCopNames: true
+  # Style guide URLs are not displayed in offense messages by default. Change
+  # behavior by overriding DisplayStyleGuide, or by giving the
+  # -S/--display-style-guide option.
+  DisplayStyleGuide: false
+  # Exclude some GitLab files
+  Exclude:
+    - '.gitlab/**/*'
+
+Style/NumericLiteralPrefix:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Layout/LineLength:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+RSpec/FilePath:
+  Enabled: false
+Metrics/AbcSize:
+  Max: 60
+Metrics/MethodLength:
+  Max: 30
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Max: 2
+RSpec/NestedGroups:
+  Max: 5
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Layout/SpaceInsideBlockBraces:
+  Enabled: false
+Style/SlicingWithRange:
+  Enabled: true
+Style/ConditionalAssignment:
+  EnforcedStyle: assign_inside_condition
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true

data/.rubocop_todo.yml

@@ -0,0 +1,60 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-06-06 22:58:53 +0200 using RuboCop version 0.85.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, AllowBeforeTrailingComments, ForceEqualSignAlignment.
+Layout/ExtraSpacing:
+  Exclude:
+    - 'linter.gemspec'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Layout/SpaceAfterComma:
+  Exclude:
+    - 'lib/linter/gender_association.rb'
+    - 'lib/linter/misused_words.rb'
+    - 'lib/linter/pronoun_association.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator.
+# SupportedStylesForExponentOperator: space, no_space
+Layout/SpaceAroundOperators:
+  Exclude:
+    - 'linter.gemspec'
+
+# Offense count: 4
+Lint/IneffectiveAccessModifier:
+  Exclude:
+    - 'lib/linter/gender_association.rb'
+    - 'lib/linter/misused_words.rb'
+    - 'lib/linter/pronoun_association.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: ContextCreatingMethods, MethodCreatingMethods.
+Lint/UselessAccessModifier:
+  Exclude:
+    - 'lib/linter/gender_association.rb'
+    - 'lib/linter/misused_words.rb'
+    - 'lib/linter/pronoun_association.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/ExpandPathArguments:
+  Exclude:
+    - 'linter.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'linter.gemspec'

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
 
 group :development do
   gem 'pry'

data/Gemfile.lock

@@ -1,21 +1,28 @@
 PATH
   remote: .
   specs:
-    linter (0.1.5)
+    linter (0.1.6)
       colorize (~> 0.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
     coderay (1.1.3)
     colorize (0.8.1)
     diff-lcs (1.3)
     method_source (1.0.0)
+    parallel (1.19.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    rainbow (3.0.0)
     rake (10.5.0)
     rb-readline (0.5.5)
+    regexp_parser (1.7.0)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -29,6 +36,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
+    rubocop (0.85.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    rubocop-rspec (1.39.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -40,6 +62,8 @@ DEPENDENCIES
   rake (~> 10.0)
   rb-readline
   rspec (~> 3.0)
+  rubocop (~> 0.85)
+  rubocop-rspec (~> 1.39)
 
 BUNDLED WITH
    1.17.2

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,15 +1,16 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "linter"
+require 'bundler/setup'
+require 'linter'
 require 'pry'
 
 # 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.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
+# require 'pry'
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bin/linter

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
- require_relative "../lib/linter"
+# frozen_string_literal: true
+
+require_relative '../lib/linter'
 
 Linter::CLI.analyze(ARGV[0])

data/data/misused_wordlist.yml

@@ -110,3 +110,25 @@ problematic:
       - impassioned
       - piercing
       - vehement
+  - word: lame
+    reason: |
+      "Lame" was originally used in reference to people with reduced mobility
+      due to physical disability. The word is now tossed around everywhere to
+      mean "uncool" and "unappealing." Disability rights activists have long
+      called for the word to phase out. We have a responsibility to respect that.
+    replace_with:
+      - old hat
+      - hackneyed
+      - stodgy
+      - jejune
+      - pedestrian
+      - humdrum
+  - word: retarded
+    reason: |
+      The term "mental retardation" is a stale, clinical term once used to label
+      what we now call intellectual disabilities. Using the term to mean "stupid"
+      devalues those with intellectual disabilities, which should make you
+      question your word choice.
+    replace_with:
+      - If you are using it as a descriptor for a person with an intellectual disability in a context where such a descriptor is necessary, you could replace it with a term that does not have the same derogatory connotation, or the name of the actual disability if relevant.
+      - If you are using it to insult someone (e.g. "You're such a retard") then don't.

data/lib/linter.rb

@@ -1,13 +1,15 @@
-require_relative "linter/version"
-require_relative "linter/base_association"
-require_relative "linter/gender_association"
-require_relative "linter/pronoun_association"
-require_relative "linter/cli"
-require_relative "linter/misused_words"
+# frozen_string_literal: true
+
+require_relative 'linter/version'
+require_relative 'linter/base_association'
+require_relative 'linter/gender_association'
+require_relative 'linter/pronoun_association'
+require_relative 'linter/cli'
+require_relative 'linter/misused_words'
 
 require 'yaml'
 require 'colorize'
-require "ostruct"
+require 'ostruct'
 
 module Linter
   class Error < StandardError; end

data/lib/linter/base_association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Linter
   class BaseAssociation
     def self.analyze(text)
@@ -19,8 +21,6 @@ module Linter
       result
     end
 
-    private
-
     def self.word_count(text, word)
       if self::FULL_WORD
         regex = /\b#{word}\b/i
@@ -33,9 +33,9 @@ module Linter
       # Use Enumerable#tally with Ruby 2.7
       matches
         .flatten
-        .map { |word| word.downcase }
+        .map(&:downcase)
         .group_by { |v| v }
-        .map { |k, v| [k, v.size] }
+        .transform_values(&:size)
         .to_h
     end
   end

data/lib/linter/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Linter
   class CLI
     def self.analyze(file_name)

data/lib/linter/gender_association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Linter
   class GenderAssociation < BaseAssociation
     FULL_WORD = false

data/lib/linter/misused_words.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Linter
   class MisusedWords
     def self.analyze(text)

data/lib/linter/pronoun_association.rb

@@ -1,18 +1,22 @@
+# frozen_string_literal: true
+
 module Linter
   class PronounAssociation < BaseAssociation
     FULL_WORD = true
 
-    private
-
     def self.wordlists
       file_path = File.join(__dir__,'../../data/pronoun_association_wordlist.yml')
       @wordlists ||= YAML.load_file(file_path)
     end
 
+    private
+
     def self.calculate_trend(result)
       return 'masculine-coded' if result.masculine_coded_word_counts.values.sum.positive?
+
       return 'feminine-coded' if result.feminine_coded_word_counts.values.sum.positive?
-      return 'neutral'
+
+      'neutral'
     end
   end
 end

data/lib/linter/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Linter
-  VERSION = "0.1.5"
+  VERSION = '0.1.6'
 end

data/linter.gemspec

@@ -1,44 +1,47 @@
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "linter/version"
+require 'linter/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "linter"
+  spec.name          = 'linter'
   spec.version       = Linter::VERSION
-  spec.authors       = ["lien van den steen"]
-  spec.email         = ["lienvandensteen@gmail.com"]
+  spec.authors       = ['lien van den steen']
+  spec.email         = ['lienvandensteen@gmail.com']
 
   spec.summary       = 'Library to check a text for gender coded language'
   # spec.description   = %q{TODO: Write a longer description or delete this line.}
-  spec.homepage      = "https://gitlab.com/lienvdsteen/linter"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://gitlab.com/lienvdsteen/linter'
+  spec.license       = 'MIT'
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the "allowed_push_host"
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+    # spec.metadata["allowed_push_host"] = "TODO: Set to "http://mygemserver.com"
 
-    spec.metadata["homepage_uri"] = 'https://gitlab.com/lienvdsteen/linter'
-    spec.metadata["source_code_uri"] = "https://gitlab.com/lienvdsteen/linter"
-    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+    spec.metadata['homepage_uri'] = 'https://gitlab.com/lienvdsteen/linter'
+    spec.metadata['source_code_uri'] = 'https://gitlab.com/lienvdsteen/linter'
+    # spec.metadata['changelog_uri'] = 'TODO: Put your gem's CHANGELOG.md URL here.'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  # Use expand_path(__dir__) instead of expand_path('..', __FILE__).
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 1.17'
   spec.add_development_dependency 'pry', '~> 0.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.85'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.39'
 
   spec.add_dependency('colorize', '~> 0.8')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linter
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - lien van den steen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-06 00:00:00.000000000 Z
+date: 2020-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +67,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.85'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.85'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.39'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.39'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -90,6 +118,8 @@ files:
 - ".gitignore"
 - ".gitlab-ci.yml"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md