linter 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 47d3b18d83733681f1d1a078df013788d1b219d87505e4debff16f6365b508af
+  data.tar.gz: ccada9ab972c0398642a34364ceecf9cf372579903d0be05d1999695a4256886
+SHA512:
+  metadata.gz: 872599e34587d6ce14663671370301e8e7b9696ed74dac59fd1f66f75749e9d358c3be94a36e572f6cad7cbd573a0966ec6aea3ec3b8ba86d265e39763fb84d9
+  data.tar.gz: e51778a4b61bf385af8da0cace90d604c041f5c7bf3bc5c0bd48dcdf6638aee7b527a3d08a9d320933312691d96bf927e6fc3aaa0e3f5db5f4abce259288461f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.gitlab-ci.yml

@@ -0,0 +1,7 @@
+rspec:
+  stage: test
+  only:
+    - merge_requests
+  script:
+    - bundle install
+    - bundle exec rspec

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.6.1

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.2.5
+before_install: gem install bundler -v 1.17.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at lienvandensteen@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+group :development do
+  gem 'pry'
+  gem 'rb-readline' # TODO: fix
+end
+
+# Specify your gem's dependencies in linter.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    linter (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.3)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (10.5.0)
+    rb-readline (0.5.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  linter!
+  pry
+  rake (~> 10.0)
+  rb-readline
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 lien van den steen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# Linter
+
+Inspired by [Gender Decoder](http://gender-decoder.katmatfield.com/) this Gem analyzed a given text for gender associated language.
+
+Currently this Gem only works for English text but open to contributions for other languages.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'linter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install linter
+
+## Usage
+
+```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">
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Linter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/linter/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+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"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/data/gender_association_wordlist.yml

@@ -0,0 +1,106 @@
+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

data/lib/linter.rb

@@ -0,0 +1,10 @@
+require "linter/version"
+require "linter/base_association"
+require "linter/gender_association"
+
+require 'yaml'
+require 'ostruct'
+
+module Linter
+  class Error < StandardError; end
+end

data/lib/linter/base_association.rb

@@ -0,0 +1,19 @@
+module Linter
+  class BaseAssociation
+    private
+
+    def self.word_count(text, word)
+      regex = /\b(#{word}\w*)\b/i
+      matches = text.scan(regex)
+      return {} unless matches.any?
+
+      # Use Enumerable#tally with Ruby 2.7
+      matches
+        .flatten
+        .map { |word| word.downcase }
+        .group_by { |v| v }
+        .map { |k, v| [k, v.size] }
+        .to_h
+    end
+  end
+end

data/lib/linter/gender_association.rb

@@ -0,0 +1,43 @@
+module Linter
+  class GenderAssociation < 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
+
+      wordlists['masculine_coded'].each do |word|
+        result.masculine_coded_word_counts.merge!(word_count(text, word))
+      end
+
+      result.trend = calculate_trend(result)
+      result
+    end
+
+    private
+
+    def self.wordlists
+      @wordlists ||= YAML.load_file('data/gender_association_wordlist.yml')
+    end
+
+    def self.calculate_trend(result)
+      case result.feminine_coded_word_counts.values.sum - result.masculine_coded_word_counts.values.sum
+      when 0
+        'neutral'
+      when 1..3
+        'feminine-coded'
+      when 3..Float::INFINITY
+        'strongly feminine-coded'
+      when -Float::INFINITY..0
+        'strongly masculine-coded'
+      else
+        'masculine-coded'
+      end
+    end
+  end
+end

data/lib/linter/version.rb

@@ -0,0 +1,3 @@
+module Linter
+  VERSION = "0.1.1"
+end

data/linter.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "linter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "linter"
+  spec.version       = Linter::VERSION
+  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"
+
+  # 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["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."
+  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.
+  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.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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 'pry', '~> 0.13'
+  spec.add_dependency 'ostruct'
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: linter
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- lien van den steen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- lienvandensteen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- data/gender_association_wordlist.yml
+- lib/linter.rb
+- lib/linter/base_association.rb
+- lib/linter/gender_association.rb
+- lib/linter/version.rb
+- linter.gemspec
+homepage: https://gitlab.com/lienvdsteen/linter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/lienvdsteen/linter
+  source_code_uri: https://gitlab.com/lienvdsteen/linter
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Library to check a text for gender coded language
+test_files: []