coconductor 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ee61b32a0da6ae5579a75cd3b779173aff62ade67bda32a9c4ea8ec0e00bdb8
+  data.tar.gz: 1cf3bc17142ea6391af0e7187ccbdc74c0fe861c5c1c4aeea41419589ed36940
+SHA512:
+  metadata.gz: 50806e9b4da9c93fb9fba54c244d6885a6a83ce095f8e452b66d36c40e977fc2a8bfefbea1d0bc369fee52c7695ff3f734d4eb371310dd4e9ab757ad4c828eab
+  data.tar.gz: cdb29b720102a2654045e188d3d2c30bdd6f0d3f408d26b9a63adeaf6c5ac19f77edf5e432c192c6e1081a7fc61de3c6e11365e251abe81ca9a7faf8127406ec

data/.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# Require @benbalter's :+1: for changes to the .github repo-config files
+# mainly due to https://github.com/probot/settings privilege escalation
+.github/* @benbalter

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+### Describe the bug
+
+A clear and concise description of what the bug is.
+
+### Steps to reproduce the behavior
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+### Expected behavior
+
+A clear and concise description of what you expected to happen.
+
+### Screenshots
+
+If applicable, add screenshots to help explain your problem.
+
+### Additional context
+
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,21 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+### Is your feature request related to a problem? Please describe the problem you're trying to solve.
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+### Describe the solution you'd like
+
+A clear and concise description of what you want to happen.
+
+### Describe alternatives you've considered
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+### Additional context
+
+Add any other context or screenshots about the feature request here.

data/.github/config.yml

@@ -0,0 +1,23 @@
+# Behaviorbot config. See https://github.com/behaviorbot/ for more information.
+# Note: Please Don't edit this file directly.
+# Edit https://github.com/benbalter/shared-community-files instead.
+
+# Configuration for update-docs - https://github.com/behaviorbot/update-docs
+updateDocsComment: "Thanks for the pull request! If you are making any changes to the user-facing functionality, please be sure to update the documentation in the `README` or `docs/` folder alongside your change. :heart:"
+
+# Configuration for request-info - https://github.com/behaviorbot/request-info
+requestInfoReplyComment: Thanks for this. Do you mind providing a bit more information about what problem you're trying to solve?
+requestInfoLabelToAdd: more-information-needed
+
+# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
+#newIssueWelcomeComment: >
+#  Welcome!
+
+# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
+newPRWelcomeComment: Welcome! Congrats on your first pull request to Coconductor. If you haven't already, please be sure to check out [the contributing guidelines](https://github.com/benbalter/coconductor/blob/master/docs/CONTRIBUTING.md).
+
+# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
+firstPRMergeComment: "Congrats on getting your first pull request to Coconductor merged! Without amazing humans like you submitting pull requests, we couldn’t run this project. You rock! :tada:<br /><br />If you're interested in tackling another bug or feature, take a look at [the open issues](https://github.com/benbalter/coconductor/issues), especially those [labeled `help wanted`](https://github.com/benbalter/coconductor/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)."
+
+# Bug workaround
+contact_links: []

data/.github/no-response.yml

@@ -0,0 +1,15 @@
+# Configuration for probot-no-response - https://github.com/probot/no-response
+# Note: Please Don't edit this file directly.
+# Edit https://github.com/benbalter/shared-community-files instead.
+
+# Number of days of inactivity before an Issue is closed for lack of response
+daysUntilClose: 14
+# Label requiring a response
+responseRequiredLabel: more-information-needed
+# Comment to post when closing an Issue for lack of response. Set to `false` to disable
+closeComment: >
+  This issue has been automatically closed because there has been no response
+  to our request for more information from the original author. With only the
+  information that is currently in the issue, we don't have enough information
+  to take action. Please reach out if you have or find the answers we need so
+  that we can investigate further.

data/.github/release-drafter.yml

@@ -0,0 +1,4 @@
+template: |
+  ## What's Changed
+
+  $CHANGES

data/.github/settings.yml

@@ -0,0 +1,33 @@
+# Repository settings set via https://github.com/probot/settings
+# Note: Please Don't edit this file directly.
+# Edit https://github.com/benbalter/shared-community-files instead.
+
+repository:
+  has_issues: true
+  has_wiki: false
+  has_projects: false
+  has_downloads: false
+
+labels:
+  - name: help wanted
+    oldname: help-wanted
+    color: 0e8a16
+  - name: more-information-needed
+    color: d93f0b
+  - name: bug
+    color: b60205
+  - name: feature
+    color: 1d76db
+  - name: good first issue
+    color: "5319e7"
+
+# Not currently implemented by probot/settings, but manually implemented in script/deploy
+branch_protection:
+  restrictions: null
+  enforce_admins: false
+  required_status_checks:
+    strict: true
+    contexts:
+      - "continuous-integration/travis-ci"
+  required_pull_request_reviews:
+    require_code_owner_reviews: true

data/.github/stale.yml

@@ -0,0 +1,29 @@
+# Configuration for probot-stale - https://github.com/probot/stale
+# Note: Please Don't edit this file directly.
+# Edit https://github.com/benbalter/shared-community-files instead.
+
+# Number of days of inactivity before an Issue or Pull Request becomes stale
+daysUntilStale: 60
+
+# Number of days of inactivity before a stale Issue or Pull Request is closed
+daysUntilClose: 7
+
+# Issues or Pull Requests with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+
+# Label to use when marking as stale
+staleLabel: wontfix
+
+# Comment to post when marking as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+
+# Comment to post when closing a stale Issue or Pull Request. Set to `false` to disable
+closeComment: false
+
+# Limit to only `issues` or `pulls`
+# only: issues

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,32 @@
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/LineLength:
+  Exclude:
+    - lib/coconductor/project_files.rb
+    - lib/coconductor/commands/*
+
+Metrics/ClassLength:
+  Exclude:
+    - lib/coconductor/code_of_conduct.rb
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - lib/coconductor/commands/*
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - lib/coconductor/commands/*
+
+Metrics/AbcSize:
+  Exclude:
+    - lib/coconductor/commands/*
+
+Metrics/MethodLength:
+  Exclude:
+    - lib/coconductor/commands/*
+  

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+script: "script/cibuild"
+sudo: false
+cache: bundler

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ben Balter
+
+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,76 @@
+# Coconductor
+
+[![Build Status](https://travis-ci.org/benbalter/coconductor.svg?branch=master)](https://travis-ci.org/benbalter/coconductor) [![Gem Version](https://badge.fury.io/rb/coconductor.svg)](http://badge.fury.io/rb/coconductor)
+
+A (work-in-progress) Code of Conduct detector based off [Licensee](https://github.com/benbalter/licensee).
+
+## Installation
+
+`gem install coconductor` or add `gem 'coconductor'` to your project's Gemfile and `bundle install`
+
+## Usage
+
+### Ruby
+
+```ruby
+path = 'path/to/some/project'
+code_of_conduct = Coconductor.code_of_conduct(path)
+
+code_of_conduct.key
+=> "contributor-covenant/version/1/4"
+
+code_of_conduct.family
+=> "contributor-covenant"
+
+code_of_conduct.version
+=> 1.4
+
+# lower-level access
+
+project = Coconductor.project(path)
+
+project.code_of_conduct.key
+=> "contributor-covenant/version/1/4"
+
+project.code_of_conduct_file.filename
+=> "CODE_OF_CONDUCT.txt"
+
+project.code_of_conduct_file.matcher
+=> Coconductor::Matchers::Dice
+
+project.code_of_conduct_file.confidence
+=> 98.9648033126294
+```
+
+### Command line
+
+```
+coconductor detect [PATH]   # Detect the code of conduct of the given project
+coconductor diff [PATH]     # Compare the given code of conduct text to a known code of conduct
+coconductor help [COMMAND]  # Describe available commands or one specific command
+coconductor version         # Return the Coconductor version
+```
+
+#### Example output
+
+```
+Code of conduct:  Contributor Covenant v1.4
+Key:              contributor-covenant/version/1/4
+Family:           contributor-covenant
+Version:          1.4
+Path:             docs/CODE_OF_CONDUCT.md
+Confidence:       98.96%
+Matcher:          Coconductor::Matchers::Dice
+Content hash:     627827ddda36b5c42b3a00418d3d7d5b16e5088a
+```
+
+### Codes of Conduct detected
+
+* Contributor Covenant (all official languages and versions)
+* Citizen Code of Conduct (all versions)
+
+### Matching strategy
+
+* Exact match (after normalization)
+* Field aware exact match (e.g., ignoring fields intended to be filled in)
+* [Sørensen–Dice coefficient](https://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient)

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/coconductor

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/coconductor'
+require 'thor'
+
+class CoconductorCLI < Thor
+  package_name 'Coconductor'
+  default_task :detect
+
+  private
+
+  def path
+    args.first || Dir.pwd
+  end
+
+  def project
+    @project ||= Coconductor.project(path)
+  end
+
+  def code_of_conduct
+    project.code_of_conduct
+  end
+
+  def code_of_conduct_file
+    project.code_of_conduct_file
+  end
+end
+
+commands_dir = File.expand_path '../lib/coconductor/commands/', __dir__
+Dir["#{commands_dir}/*.rb"].each { |c| require(c) }
+
+CoconductorCLI.start(ARGV)

data/coconductor.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'coconductor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'coconductor'
+  spec.version       = Coconductor::VERSION
+  spec.authors       = ['Ben Balter']
+  spec.email         = ['ben.balter@github.com']
+
+  spec.summary       = <<-SUMMARY
+   work-in-progress code of conduct detector based off Licensee
+  SUMMARY
+  spec.homepage      = 'https://github.com/benbalter/coconductor'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'licensee', '~> 9.9', '>= 9.9.3'
+  spec.add_dependency 'thor', '~> 0.20'
+  spec.add_dependency 'toml', '~> 0.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.50'
+end

data/docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# 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, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, 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 ben@balter.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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org