linter 0.1.4 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08b1ff0198e0f6f389ee13707020581608ac96eadff6cb34a0e47821aa6d03d6'
-  data.tar.gz: b9d3e3b3d42cb76e7df568da374488b0c8047d19cc1985f38a34021e5720fd22
+  metadata.gz: a80c5734dad74a7737293169a71422fc05f45e75662615ee1b135e4efd96332e
+  data.tar.gz: cadc9e3c07b8fde011e5a0688efc9d309082d7a0f587a8d6ef616da25c3bd311
 SHA512:
-  metadata.gz: 1a9e8cc02d838eac96ab0952f009d0281104fd63ee25e8846a76143f56be0d64a8704abb8a08d579b2009fb010f94e7914ef2395457f05861d1d734992cf24e6
-  data.tar.gz: 9b857bd50998ef0e71696c78fe77e89262545c94e02b8f67008a9f87d46887bc6387e08feda977be6f4c1829c05ff1ea5212207b0234217004fee17491735559
+  metadata.gz: b36c820823c1e67f49ce474ad589665d4e98fe4c8256656ede53b203de79137a1749e1c9d5acabf056d923b3c1db02d663bfdb075bf403656eb757d15b9e849e
+  data.tar.gz: 360c60b81bf244368b9a9e5421b641c3bd34d16436b252342aadd64c85eeae39601ccc3d44f0efe03521aa8db23770b5ee4722e75293f78b0a1639993507a9cd

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.4)
+    linter (0.1.9)
       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/README.md

@@ -23,15 +23,34 @@ Or install it yourself as:
 
 ## Usage
 
+If you want to perform all of the inclusiveness checks we currently offer, you can run:
+
+```ruby
+text = 'your text here'
+response = Linter.analyze(text)
+```
+
+You can also use the checks individually:
+
 ```ruby
 text = 'Collaborate closely with the manager. Analytics all the way.'
 Linter::GenderAssociation.analyze(text)
 # #<OpenStruct feminine_coded_word_counts={"collaborate" => 1}, masculine_coded_word_counts={"analytics" => 1}, trend="neutral">
+
 text = 'He was working at the bar.'
 Linter::PronounAssociation.analyze(text)
+#<OpenStruct trend="masculine-coded", feminine_coded_word_counts={}, masculine_coded_word_counts={"he"=>1}>
+
+text = 'You are my spirit animal'
+Linter::MisusedWords.analyze(text)
+#<OpenStruct misused_words=[{"word"=>"spirit animal", "reason"=>"The problem is that spirit animals are an important part of the belief\nsystem of some cultures and refer to a spirit that “helps guide or protect\na person on a journey and whose characteristics that person shares or\nembodies.” Referring to something as your spirit animal is cultural\nappropriation. Avoid using it.\n", "replace_with"=>["kindred spirit", "raison d'etre"]}], trend="">
 ```
 
-## CLI Usage
+You'll notice that the `association` checks do a comparison of the whole text and will determine a _trend_ for your text. When your text uses a lot of
+masculine-coded language, the text will be marked as such. The regular checks (like `MisusedWords`) will return all the misused words, a reason why
+and if possible, we provide some suggestions to replace the word.
+
+## CLI Usage -> In development
 
 ```console
 linter example.md
@@ -47,7 +66,13 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitLab at https://gitlab.com/lienvdsteen/linter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and merge requests are welcome on GitLab at https://gitlab.com/lienvdsteen/linter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+We are looking for different types of contributions:
+- additional checks
+- adding/editing words to the existing wordlists
+- support for other languages besides English
+- ...
 
 ## License
 

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/gender_association_wordlist.yml

@@ -1,106 +1,113 @@
-feminine_coded:
-  - agree
-  - affectionate
-  - child*
-  - cheer
-  - collab
-  - commit
-  - communal
-  - compassion
-  - connect
-  - considerate
-  - cooperat
-  - co-operat
-  - depend
-  - emotiona
-  - empath
-  - feel
-  - flatterable
-  - gentle
-  - honest
-  - interpersonal
-  - interdependen
-  - interpersona
-  - inter-personal
-  - inter-dependen
-  - inter-persona
-  - kind
-  - kinship
-  - loyal
-  - modesty
-  - nag
-  - nurtur
-  - pleasant
-  - polite
-  - quiet*
-  - respon
-  - sensitiv
-  - submissive
-  - support
-  - sympath
-  - tender
-  - together
-  - trust
-  - understand
-  - warm
-  - whin
-  - enthusias
-  - inclusive
-  - yield
-  - share
-  - sharin
+words:
+  feminine_coded:
+    - agree
+    - affectionate
+    - child*
+    - cheer
+    - collab
+    - commit
+    - communal
+    - compassion
+    - connect
+    - considerate
+    - cooperat
+    - co-operat
+    - depend
+    - emotiona
+    - empath
+    - feel
+    - flatterable
+    - gentle
+    - honest
+    - interpersonal
+    - interdependen
+    - interpersona
+    - inter-personal
+    - inter-dependen
+    - inter-persona
+    - kind
+    - kinship
+    - loyal
+    - modesty
+    - nag
+    - nurtur
+    - pleasant
+    - polite
+    - quiet*
+    - respon
+    - sensitiv
+    - submissive
+    - support
+    - sympath
+    - tender
+    - together
+    - trust
+    - understand
+    - warm
+    - whin
+    - enthusias
+    - inclusive
+    - yield
+    - share
+    - sharin
 
-masculine_coded:
-  - active
-  - adventurous
-  - aggress
-  - ambitio
-  - analytics
-  - analy
-  - assert
-  - athlet
-  - autonom
-  - battle
-  - boast
-  - challeng
-  - champion
-  - compet
-  - confident
-  - courag
-  - decid
-  - decision
-  - decisive
-  - defend
-  - determin
-  - domina
-  - dominant
-  - driven
-  - fearless
-  - fight
-  - force
-  - greedy
-  - head-strong
-  - headstrong
-  - hierarch
-  - hostil
-  - impulsive
-  - independen
-  - individual
-  - intellect
-  - lead
-  - logic
-  - objective
-  - opinion
-  - outspoken
-  - persist
-  - principle
-  - reckless
-  - self-confiden
-  - self-relian
-  - self-sufficien
-  - selfconfiden
-  - selfrelian
-  - selfsufficien
-  - stubborn
-  - superior
-  - unreasonab
+  masculine_coded:
+    - active
+    - adventurous
+    - aggress
+    - ambitio
+    - analytics
+    - analy
+    - assert
+    - athlet
+    - autonom
+    - battle
+    - boast
+    - challeng
+    - champion
+    - compet
+    - confident
+    - courag
+    - decid
+    - decision
+    - decisive
+    - defend
+    - determin
+    - domina
+    - dominant
+    - driven
+    - fearless
+    - fight
+    - force
+    - guys
+    - greedy
+    - head-strong
+    - headstrong
+    - hierarch
+    - hostil
+    - impulsive
+    - independen
+    - individual
+    - intellect
+    - lead
+    - logic
+    - manpower
+    - manning
+    - middleman
+    - ninja
+    - objective
+    - opinion
+    - outspoken
+    - persist
+    - principle
+    - reckless
+    - rockstar
+    - self-confiden
+    - self-relian
+    - self-sufficien
+    - selfconfiden
+    - selfrelian
+    - selfsufficien
+    - stubborn
+    - superior
+    - unreasonab

data/data/mindset_wordlist.yml

@@ -0,0 +1,26 @@
+words:
+  growth_coded:
+    - striving
+    - driven
+    - highly motivated
+    - improvement
+    - learn
+    - strive
+    - grow
+    - persevere
+    - determined
+
+  fixed_coded:
+    - est
+    - brightest
+    - smart
+    - performer
+    - intelligent
+    - rockstar
+    - superhero
+    - genius
+    - expert
+    - brilliant
+    - natural
+    - talent
+    - overachieve

data/data/misused_wordlist.yml

@@ -0,0 +1,164 @@
+problematic:
+  - word: spirit animal
+    reason: |
+      The problem is that spirit animals are an important part of the belief
+      system of some cultures and refer to a spirit that “helps guide or protect
+      a person on a journey and whose characteristics that person shares or
+      embodies.” Referring to something as your spirit animal is cultural
+      appropriation. Avoid using it.
+    replace_with:
+      - kindred spirit
+      - raison d'etre
+  - word: sherpa
+    reason: |
+      Unless you mean someone who hails from Tibetan stock and lives in the
+      Nepalese Himalayas serving as a porter on mountain-climbing expeditions,
+      it is not a Sherpa.
+    replace_with:
+      - guide
+      - coach
+  - word: guru
+    reason: |
+      The word guru comes from Buddhist and Hindu religions and refers to a
+      spiritual guide or leader who is held in high esteem. Using the term
+      casually in referring to yourself or someone is disrespectful because it
+      diminishes the importance of the title and its origins.
+    replace_with:
+      - doyen
+      - virtuoso
+      - authority
+      - maestro
+  - word: ninja
+    reason: |
+      The term’s origins refer to “a member of a feudal Japanese society of
+      mercenary agents, highly trained in martial arts and stealth (ninjutsu),
+      who were hired for covert purposes ranging from espionage to sabotage and
+      assassination.” People misuse the term to claim expertise in an area.
+    replace_with:
+      - expert
+      - whiz
+      - ace
+  - word: nazi
+    reason: |
+      It describes people who were members of the National Socialist German
+      Workers’ Party, which controlled Germany from 1933–1945 under Adolf Hitler.
+      Using the term casually, as in grammar Nazi or fun Nazi, makes light of
+      the horrible atrocities they committed.
+    replace_with:
+      - boss
+      - absolutist
+  - word: binge
+    reason: |
+      We throw around terms like binge-watch and cleaning binge all the time
+      when, in fact, the word binge originates from serious eating disorders,
+      including Binge Eating Disorder and bulimia, and should be reserved for
+      discussions about them. Choosing to watch every episode of The Office in a
+      weekend is a choice, whereas bingeing disorders are not a choice and their
+      severity shouldn’t be diminished.
+    replace_with:
+      - indulged
+      - spree
+      - wallowed
+      - satiated
+  - word: scalp
+    reason: |
+      Used as a noun to refer to the top of your head, scalp is fine. It’s when
+      it’s used as a verb that we get into dangerous territory.
+
+      Using it to say someone ripped you off or to infer that you got robbed is
+      making light of what was a very gruesome act involving “a part of [the]
+      integument [of the upper part of the head] with the accompanying hair,
+      severed from the head of an enemy as a sign of victory, as by some North
+      American Indians and others during the colonial and frontier periods in
+      the US.”
+    replace_with:
+      - fleeced
+      - robbed
+      - hustled
+      - pulled a fast one
+  - word: gyp
+    reason: |
+      It comes from the word Gypsy, who are Romani people. There are already
+      plenty of negative associations with the term gypsy, and using gypped to
+      say you got ripped off only perpetuates the negative stereotypes.
+    replace_with:
+      - ripoff
+      - bamboozled
+      - shortchanged
+      - fraud
+  - word: hysterical
+    reason: |
+      If you find something or someone to be hysterical, meaning funny, that’s
+      OK. If you’re calling someone’s actions hysterical because they’re being
+      emotional, then you may want to reconsider.
+
+      Far too often women are dubbed hysterical for being outspoken or showing
+      their feelings, and that wades into problematic, sexist territory due to
+      the history of the term.
+
+      Hysterical’s earliest meaning was “of, relating to, or characterized by
+      hysteria,” and while we now think of hysteria as irrational panic, it was,
+      for centuries, a medical diagnosis. Hysteria comes from the Greek
+      hysterikós, which means “suffering in the womb.”
+
+      So, yeah, the ancient Greeks believed that when a woman was behaving
+      irrationally—or in a way that they considered to be irrational—it was
+      because her uterus was literally wandering around her body causing trouble
+      (Kory Stamper, “What It Really Means To Call A Woman Hysterical“).
+    replace_with:
+      - intense
+      - 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.
+  - word: blacklist
+    reason: |
+      Black is too often used in a negative context (with the opposite being 
+      referred to as white). Please consider using alternatives when they convey 
+      the same meaning.
+    replace_with:
+      - blocklist
+  - word: whitelist
+    reason: |
+      Black & white are often used in contexts where white is the positive item, 
+      and black the negative item. Please consider using alternatives when they 
+      convey the same meaning.
+    replace_with:
+      - allowlist
+  - word: master
+    reason: |
+      Master (in context of master/slave) is often used in computer terminology
+      when leader/follower, or primary/replica are as meaningful and don't have
+      a connotation of slavery.
+    replace_with:
+      - leader
+      - primary
+  - word: slave
+    reason: |
+      Master (in context of master/slave) is often used in computer terminology
+      when leader/follower, or primary/replica are as meaningful and don't have
+      a connotation of slavery.
+    replace_with:
+      - follower
+      - replica

data/data/pronoun_association_wordlist.yml

@@ -1,11 +1,12 @@
-feminine_coded:
-  - she
-  - her
-  - hers
-  - herself
+words:
+  feminine_coded:
+    - she
+    - her
+    - hers
+    - herself
 
-masculine_coded:
-  - he
-  - his
-  - him
-  - himself
+  masculine_coded:
+    - he
+    - his
+    - him
+    - himself

data/lib/linter.rb

@@ -1,19 +1,27 @@
-require_relative "linter/version"
-require_relative "linter/base_association"
-require_relative "linter/gender_association"
-require_relative "linter/pronoun_association"
-require_relative "linter/cli"
+# 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_relative 'linter/mindset_association'
 
 require 'yaml'
 require 'colorize'
-require "ostruct"
+require 'ostruct'
 
 module Linter
   class Error < StandardError; end
 
   class << self
-    def cli_analyze(file_name)
-      Linter::CLI.analyze(file_name)
+    def analyze(text)
+      {
+        gender_association_analysis: Linter::GenderAssociation.analyze(text),
+        pronoun_analysis: Linter::PronounAssociation.analyze(text),
+        misused_words_analysis: Linter::MisusedWords.analyze(text)
+      }
     end
   end
 end

data/lib/linter/base_association.rb

@@ -1,26 +1,22 @@
+# frozen_string_literal: true
+
 module Linter
   class BaseAssociation
     def self.analyze(text)
-      result = OpenStruct.new(
-        feminine_coded_word_counts: {},
-        masculine_coded_word_counts: {},
-        trend: ''
-      )
-
-      wordlists['feminine_coded'].each do |word|
-        result.feminine_coded_word_counts.merge!(word_count(text, word))
-      end
+      result = OpenStruct.new(trend: '')
 
-      wordlists['masculine_coded'].each do |word|
-        result.masculine_coded_word_counts.merge!(word_count(text, word))
+      wordlists.dig('words').each do |key, words|
+        word_count_key = "#{key}_word_counts".to_sym
+        result[word_count_key] = {}
+        words.each do |word|
+          result.send(word_count_key).merge!(word_count(text, word))
+        end
       end
 
       result.trend = calculate_trend(result)
       result
     end
 
-    private
-
     def self.word_count(text, word)
       if self::FULL_WORD
         regex = /\b#{word}\b/i
@@ -33,9 +29,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
@@ -17,7 +19,7 @@ module Linter
         'feminine-coded'
       when 3..Float::INFINITY
         'strongly feminine-coded'
-      when -Float::INFINITY..0
+      when -Float::INFINITY..-3
         'strongly masculine-coded'
       else
         'masculine-coded'

data/lib/linter/mindset_association.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Linter
+  class MindsetAssociation < BaseAssociation
+    USE_FOR_JOB_ADS = true
+    FULL_WORD = false
+
+    def self.wordlists
+      file_path = File.join(__dir__, '../../data/mindset_wordlist.yml')
+      @wordlists ||= YAML.load_file(file_path)
+    end
+
+    def self.calculate_trend(result)
+      case result.growth_coded_word_counts.values.sum - result.fixed_coded_word_counts.values.sum
+      when 0
+        'neutral'
+      when 1..3
+        'growth-coded'
+      when 3..Float::INFINITY
+        'strongly growth-coded'
+      when -Float::INFINITY..-3
+        'strongly fixed-coded'
+      else
+        'fixed-coded'
+      end
+    end
+  end
+end

data/lib/linter/misused_words.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Linter
+  class MisusedWords
+    def self.analyze(text)
+      result = OpenStruct.new(
+        misused_words: [],
+        trend: ''
+      )
+      wordlists.dig('problematic').each do |problematic_word|
+        word = problematic_word['word']
+        regex = /\b#{word}\b/i
+        result.misused_words << problematic_word if text.scan(regex).any?
+      end
+      result
+    end
+
+    private
+
+    def self.wordlists
+      file_path = File.join(__dir__,'../../data/misused_wordlist.yml')
+      @wordlists ||= YAML.load_file(file_path)
+    end
+  end
+end

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.4"
+  VERSION = '0.1.9'
 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.4
+  version: 0.1.9
 platform: ruby
 authors:
 - lien van den steen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-06 00:00:00.000000000 Z
+date: 2020-06-16 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
@@ -102,11 +132,15 @@ files:
 - bin/linter
 - bin/setup
 - data/gender_association_wordlist.yml
+- data/mindset_wordlist.yml
+- data/misused_wordlist.yml
 - data/pronoun_association_wordlist.yml
 - lib/linter.rb
 - lib/linter/base_association.rb
 - lib/linter/cli.rb
 - lib/linter/gender_association.rb
+- lib/linter/mindset_association.rb
+- lib/linter/misused_words.rb
 - lib/linter/pronoun_association.rb
 - lib/linter/version.rb
 - linter.gemspec