linter 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1491108b230614cf20851e598c1011f4c57569e2f1a3b0ca1fbda04d495fa0b0
-  data.tar.gz: ff1f19b671c4226aa09a4ff7269aad26fa0302962107ce7197476518f6bf5868
+  metadata.gz: 5f6c8116c4b1a24d73d27bba7a73c1a0c181d7c7cc33d1ae752b688de68cf9fa
+  data.tar.gz: e2824833060c739d59ae5634e6a61752bc30fa957b186fcfe818dea0f292f995
 SHA512:
-  metadata.gz: 99d9a231422877c17f46e91e9882417ab489389396e4382e7d35547aadced0f87c54e3c78cd40fb58e358c019446fb532dd87345aa4a0ae12ec2a2cb997d4c92
-  data.tar.gz: d6cc2a01478d094a8bf712f0d6447e5ee36d7cc37e505addee6648e4b0dd33c9f7bd567f4dabc61a15c4fb88812d00ded97181e38a0378727fe9286af744bb0a
+  metadata.gz: aceb6c6039b820decb927586cdce44206aff07fc280de67cf9d206a914e2bbc2120bc7166784a46b4d5a8b42d056063e3385f12f4f38c7b7d10dff94196f9c78
+  data.tar.gz: 2ef6e8ecbe3a073501b081f5e8ef43053b64b3af1e086172b95aa09f29fd2ac2f6ab3c6aea6eb380768edaa7812fd5f51173612982cf57dd1f90d97fbbde366a

data/README.md

@@ -30,6 +30,13 @@ text = 'your text here'
 response = Linter.analyze(text)
 ```
 
+If you want to include the checks specifically for job ads as well, run it like this:
+
+```ruby
+text = 'your text here'
+response = Linter.analyze(text, job_ad: true)
+```
+
 You can also use the checks individually:
 
 ```ruby
@@ -47,13 +54,15 @@ Linter::MisusedWords.analyze(text)
 ```
 
 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.
+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.
+
+We've also included a `recommendation` where possible. This is to help guide people what to do with the results from the
+trend.
 
-## CLI Usage -> In development
+## CLI Usage
 
 ```console
-linter example.md
+linter path/to_file/example.md
 #<OpenStruct feminine_coded_word_counts={}, masculine_coded_word_counts={"analytical"=>1}, trend="strongly masculine-coded">
 #<OpenStruct feminine_coded_word_counts={}, masculine_coded_word_counts={"he"=>1}, trend="masculine-coded">
 ```
@@ -74,6 +83,8 @@ We are looking for different types of contributions:
 - support for other languages besides English
 - ...
 
+If you add any checks or words, please also add the sources used to the `sources.yml` file.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/data/recommendations.yml

@@ -0,0 +1,53 @@
+  - type: gender
+    trends:
+      - result: neutral
+        recommendation: |
+          Either you aren't using any gender-coded words or you found a good balance between using gender-coded words.
+          There could still be other factors that make this text less inclusive.
+      - result: masculine-coded
+        recommendation: |
+          You're using more masculine-coded words than feminine coded-words. Try to replace the words listed as masculine-coded.
+          This will result in a more balanced and inclusive text. If this happens to be a job ad, note that according to
+          <a href='http://gender-decoder.katmatfield.com/static/documents/Gaucher-Friesen-Kay-JPSP-Gendered-Wording-in-Job-ads.pdf'>this study</a>
+          it risks putting women off and encourage men to apply.
+      - result: strongly masculine-coded
+        recommendation: |
+          You're using more masculine-coded words than feminine coded-words. Try to replace the words listed as masculine-coded.
+          This will result in a more balanced and inclusive text. If this happens to be a job ad, note that according to
+          <a href='http://gender-decoder.katmatfield.com/static/documents/Gaucher-Friesen-Kay-JPSP-Gendered-Wording-in-Job-ads.pdf'>this study</a>
+          it risks putting women off and encourage men to apply.
+      - result: feminine-coded
+        recommendation: |
+          You're using more feminine coded-words than masculine-coded. You could replace some words however, a feminine-coded text only
+          has a slight effect on the inclusiveness of your text. For example, if this is a job ad, it will encourage women to apply
+          but the effect on men is minimal. See <a href='http://gender-decoder.katmatfield.com/static/documents/Gaucher-Friesen-Kay-JPSP-Gendered-Wording-in-Job-ads.pdf'>this study</a>.
+      - result: strongly feminine-coded
+        recommendation: |
+          You're using more feminine coded-words than masculine-coded. You could replace some words however, a feminine-coded text only
+          has a slight effect on the inclusiveness of your text. For example, if this is a job ad, it will encourage women to apply
+          but the effect on men is minimal. See <a href='http://gender-decoder.katmatfield.com/static/documents/Gaucher-Friesen-Kay-JPSP-Gendered-Wording-in-Job-ads.pdf'>this study</a>.
+  - type: mindset
+    trends:
+      - result: neutral
+        recommendation: |
+          Although it is marked as neutral, it might be good to look into changing the text a little bit. Growth mindset terms imply abilities and
+          talents can be developed. Recruiting content that uses growth mindset language can lead to faster hiring times
+          and more hires being made from underrepresented groups.
+      - result: growth-coded
+        recommendation: |
+          Growth mindset terms imply abilities and talents can be developed. Recruiting content that uses growth mindset language can lead to faster hiring times
+          and more hires being made from underrepresented groups. This text is a great start to make sure you're inclusive on a mindset-level.
+      - result: fixed-coded
+        recommendation: |
+          Fixed-mindset implies that talents and traits are innate and static. Recruiting content that uses growth mindset language can lead to faster hiring times
+          and more hires being made from underrepresented groups. We'd recommend you replace some of the words listed as fixed. You can find some more
+          information in <a href='https://medium.com/textio/growth-mindset-language-41d51c91432'>this medium post</a>.
+      - result: strongly growth-coded
+        recommendation: |
+          Growth mindset terms imply abilities and talents can be developed. Recruiting content that uses growth mindset language can lead to faster hiring times
+          and more hires being made from underrepresented groups. This text is a great start to make sure you're inclusive on a mindset-level.
+      - result: strongly fixed-coded
+        recommendation: |
+          Fixed-mindset implies that talents and traits are innate and static. Recruiting content that uses growth mindset language can lead to faster hiring times
+          and more hires being made from underrepresented groups. We'd recommend you replace some of the words listed as fixed. You can find some more
+          information in <a href='https://medium.com/textio/growth-mindset-language-41d51c91432'>this medium post</a>.

data/data/sources.yml

@@ -0,0 +1,7 @@
+# List any source used here. We will make sure this is listed and credit is given.
+- title: Gender Decoder Tool by Kat Matfield
+  url: http://gender-decoder.katmatfield.com/
+- title: Evidence That Gendered Wording in Job Advertisements Exists and Sustains Gender Inequality
+  url: http://gender-decoder.katmatfield.com/static/documents/Gaucher-Friesen-Kay-JPSP-Gendered-Wording-in-Job-ads.pdf
+- title: Want to hire faster? Write about “learning,” not “brilliance”
+  url: https://medium.com/textio/growth-mindset-language-41d51c91432

data/lib/linter.rb

@@ -25,5 +25,10 @@ module Linter
       response[:mindset_association_analysis] = Linter::MindsetAssociation.analyze(text) if job_ad
       response
     end
+
+    def sources
+      file_path = File.join(__dir__, '../data/sources.yml')
+      YAML.load_file(file_path)
+    end
   end
 end

data/lib/linter/base_association.rb

@@ -14,6 +14,7 @@ module Linter
       end
 
       result.trend = calculate_trend(result)
+      result.recommendation = add_recommendation(result)
       result
     end
 
@@ -34,5 +35,14 @@ module Linter
         .transform_values(&:size)
         .to_h
     end
+
+    def self.recommendation_file
+      file_path = File.join(__dir__, '../../data/recommendations.yml')
+      @recommendation_file ||= YAML.load_file(file_path)
+    end
+
+    def self.add_recommendation(_result)
+      false
+    end
   end
 end

data/lib/linter/gender_association.rb

@@ -25,5 +25,9 @@ module Linter
         'masculine-coded'
       end
     end
+
+    def self.add_recommendation(result)
+      recommendation_file.find { |rec| rec['type'] == 'gender' }&.dig('trends')&.find { |trend| trend['result'] == result.trend }&.dig('recommendation')
+    end
   end
 end

data/lib/linter/mindset_association.rb

@@ -24,5 +24,9 @@ module Linter
         'fixed-coded'
       end
     end
+
+    def self.add_recommendation(result)
+      recommendation_file.find { |rec| rec['type'] == 'mindset' }&.dig('trends')&.find { |trend| trend['result'] == result.trend }&.dig('recommendation')
+    end
   end
 end

data/lib/linter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Linter
-  VERSION = '0.1.11'
+  VERSION = '0.1.12'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linter
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - lien van den steen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,6 +137,8 @@ files:
 - data/mindset_wordlist.yml
 - data/misused_wordlist.yml
 - data/pronoun_association_wordlist.yml
+- data/recommendations.yml
+- data/sources.yml
 - lib/linter.rb
 - lib/linter/base_association.rb
 - lib/linter/cli.rb