coconductor 0.9.4 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbbb70318d737ae7b1b3c083df9d727c6c0d883dcfad17079863fe5d7b42f340
-  data.tar.gz: 5ca1215d51c01601b711f62467fa25378f387c3e1678f06ff1079fdcef62ca4b
+  metadata.gz: 03e268467a41069c7e787e1ea18aa23a58f3cf8d438b79defb9d95e416095f8b
+  data.tar.gz: a3730a78e0c79cc1e8b4d2d4bb7b6b636c7d77153e0dfc9d7658d384bddd77b1
 SHA512:
-  metadata.gz: 7f877bfc3feda10ee9ca44ddf15257d9d1367b90867256b81d434275fdca89f593e89f7e4c4e89d225d34e30f5f019ca94f778ca7a8ef244136d8a313c74f6a6
-  data.tar.gz: 58fa309a441dbb0c97cbc28d44d650f368b17da34639f4b878cac8935b15e31f393a244759b08a7021b0884935571db19a112a84de1aebd8a9e07e235bf68776
+  metadata.gz: 80ece2e69625918a459678cf3fc27df8695a33039b68a5bc077e03570ab5ec85501cf8f2b840659d913356aa38fdb56565446a7dedef5df4e2709c46c5ef6876
+  data.tar.gz: ce605883c10f7179ad46f52f34b359d8f3b1d106a4016faf56ec56b5455ea911ce9c60b542bd660b4e7cbff5d53122dd09908eecc6054221d65070b1964d2767

data/.github/funding.yml

@@ -0,0 +1 @@
+patreon: benbalter

data/.rubocop.yml

@@ -1,3 +1,12 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+
 Style/Documentation:
   Enabled: false
 
@@ -6,7 +15,7 @@ Metrics/BlockLength:
     - spec/**/*
     - coconductor.gemspec
 
-Metrics/LineLength:
+Layout/LineLength:
   Exclude:
     - lib/coconductor/project_files.rb
     - lib/coconductor/commands/*

data/.rubocop_todo.yml

@@ -0,0 +1,91 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-09-01 14:38:06 UTC using RuboCop version 0.90.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
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'coconductor.gemspec'
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 11
+
+# Offense count: 21
+# Configuration parameters: Prefixes.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/coconductor/code_of_conduct_spec.rb'
+    - 'spec/coconductor/field_spec.rb'
+    - 'spec/coconductor/matchers/dice_spec.rb'
+    - 'spec/coconductor/matchers/field_aware_spec.rb'
+    - 'spec/coconductor/project_files/code_of_conduct_file_spec.rb'
+    - 'spec/coconductor/project_files/project_file_spec.rb'
+    - 'spec/coconductor/project_spec.rb'
+    - 'spec/coconductor_spec.rb'
+    - 'spec/integration_spec.rb'
+
+# Offense count: 3
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/coconductor/bin_spec.rb'
+    - 'spec/integration_spec.rb'
+    - 'spec/vendored_coc_spec.rb'
+
+# Offense count: 3
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/coconductor/code_of_conduct_spec.rb'
+
+# Offense count: 19
+RSpec/MultipleExpectations:
+  Max: 4
+
+# Offense count: 10
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 8
+
+# Offense count: 71
+# Configuration parameters: IgnoreSharedExamples.
+RSpec/NamedSubject:
+  Exclude:
+    - 'spec/coconductor/code_of_conduct_spec.rb'
+    - 'spec/coconductor/field_spec.rb'
+    - 'spec/coconductor/matchers/dice_spec.rb'
+    - 'spec/coconductor/matchers/exact_spec.rb'
+    - 'spec/coconductor/matchers/matcher_spec.rb'
+    - 'spec/coconductor/project_files/project_file_spec.rb'
+    - 'spec/coconductor/project_spec.rb'
+    - 'spec/coconductor_spec.rb'
+    - 'spec/integration_spec.rb'
+
+# Offense count: 7
+RSpec/NestedGroups:
+  Max: 4
+
+# Offense count: 2
+RSpec/RepeatedDescription:
+  Exclude:
+    - 'spec/coconductor/code_of_conduct_spec.rb'
+
+# Offense count: 9
+RSpec/ScatteredSetup:
+  Exclude:
+    - 'spec/coconductor/project_files/project_file_spec.rb'
+    - 'spec/coconductor/project_spec.rb'
+    - 'spec/integration_spec.rb'
+
+# Offense count: 5
+RSpec/SubjectStub:
+  Exclude:
+    - 'spec/coconductor/project_files/project_file_spec.rb'

data/Gemfile

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

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bin/coconductor

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require_relative '../lib/coconductor'
 require 'thor'
@@ -38,6 +39,6 @@ class CoconductorCLI < Thor
 end
 
 commands_dir = File.expand_path '../lib/coconductor/commands/', __dir__
-Dir["#{commands_dir}/*.rb"].each { |c| require(c) }
+Dir["#{commands_dir}/*.rb"].sort.each { |c| require(c) }
 
 CoconductorCLI.start(ARGV)

data/coconductor.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'coconductor/version'
@@ -32,6 +34,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'reverse_markdown', '~> 1.1'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.50'
+  spec.add_development_dependency('rubocop-performance', '~> 1.5')
+  spec.add_development_dependency('rubocop-rspec', '~> 1.36')
   spec.add_development_dependency 'twitter-text', '< 2.0'
   spec.add_development_dependency 'webmock', '~> 3.1'
   spec.add_development_dependency 'wikicloth', '~> 0.8'

data/docs/SECURITY.md

@@ -0,0 +1,3 @@
+# Security Policy
+
+To report a security vulnerability, please email [ben@balter.com](mailto:ben@balter.com).

data/lib/coconductor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative './coconductor/version'
 require 'licensee'
 
@@ -9,7 +11,7 @@ module Coconductor
   autoload :ProjectFiles,  'coconductor/project_files'
   autoload :Vendorer,      'coconductor/vendorer'
 
-  CONFIDENCE_THRESHOLD = 90
+  CONFIDENCE_THRESHOLD = 85
 
   class << self
     attr_writer :confidence_threshold
@@ -23,7 +25,7 @@ module Coconductor
     end
 
     def project(path, **args)
-      if path =~ %r{\Ahttps://github.com}
+      if %r{\Ahttps://github.com}.match?(path)
         Coconductor::Projects::GitHubProject.new(path, args)
       else
         Coconductor::Projects::GitProject.new(path, args)

data/lib/coconductor/code_of_conduct.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'toml'
 
 module Coconductor
@@ -71,16 +73,17 @@ module Coconductor
       /(?<version>(?<major>\d)/(?<minor>\d)(/(?<patch>\d))?|(longer|shorter))
       /#{Coconductor::ProjectFiles::CodeOfConductFile::FILENAME_REGEX}
     }ix.freeze
-    DEFAULT_LANGUAGE = 'en'.freeze
+    DEFAULT_LANGUAGE = 'en'
 
     attr_reader :key
     attr_writer :content
+
     include Licensee::ContentHelper
 
     # Define dynamic predicate helpers to determine if a code of conduct is a
     # member of a given family, e.g., code_of_conduct.contributor_covenant?
     CodeOfConduct.families.each do |f|
-      define_method(f.tr('-', '_') + '?') { family == f }
+      define_method("#{f.tr('-', '_')}?") { family == f }
     end
 
     def initialize(key)
@@ -96,7 +99,7 @@ module Coconductor
         parts = key.split('/')
         if pseudo?
           nil
-        elsif parts.last =~ /^[a-z-]{2,5}$/
+        elsif /^[a-z-]{2,5}$/.match?(parts.last)
           parts.last
         else
           DEFAULT_LANGUAGE
@@ -177,16 +180,18 @@ module Coconductor
     private
 
     def filename
-      filename = if contributor_covenant?
+      filename = if contributor_covenant? && key.include?('/version/1/')
                    'code-of-conduct'
+                 elsif contributor_covenant? && key.include?('/version/2/')
+                   'code_of_conduct'
                  elsif citizen_code_of_conduct?
                    'citizen_code_of_conduct'
                  else
                    'CODE_OF_CONDUCT'
                  end
 
-      filename << '.' + language unless default_language?
-      filename << '.md'
+      filename += ".#{language}" unless default_language?
+      "#{filename}.md"
     end
 
     def filepath

data/lib/coconductor/commands/detect.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class CoconductorCLI < Thor
   desc 'detect [PATH]', 'Detect the code of conduct of the given project', default: Dir.pwd
   option :confidence, type: :numeric, default: Coconductor.confidence_threshold, desc: 'Confidence threshold'
@@ -57,7 +59,7 @@ class CoconductorCLI < Thor
     when :confidence
       Licensee::ContentHelper.format_percent(value)
     when :method
-      value.to_s.tr('_', ' ').capitalize + ':'
+      "#{value.to_s.tr('_', ' ').capitalize}:"
     else
       value
     end

data/lib/coconductor/commands/diff.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'tmpdir'
 
 class CoconductorCLI < Thor
@@ -39,20 +41,18 @@ class CoconductorCLI < Thor
   private
 
   def code_of_conduct_to_diff
-    if options[:code_of_conduct_to_diff]
-      return options[:code_of_conduct_to_diff]
-    end
+    return options[:code_of_conduct_to_diff] if options[:code_of_conduct_to_diff]
 
     return project.code_of_conduct_file if remote?
 
     @code_of_conduct_to_diff ||= begin
-      if STDIN.tty?
+      if $stdin.tty?
         error 'You must pipe the file contents to the command via STDIN'
         exit 1
       end
 
       filename = 'CODE_OF_CONDUCT.txt'
-      Coconductor::ProjectFiles::CodeOfConductFile.new(STDIN.read, filename)
+      Coconductor::ProjectFiles::CodeOfConductFile.new($stdin.read, filename)
     end
   end
 

data/lib/coconductor/commands/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class CoconductorCLI < Thor
   desc 'version', 'Return the Coconductor version'
   def version

data/lib/coconductor/field.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Coconductor
   # Represents a fillable field in a code of conduct
   class Field
@@ -18,7 +20,7 @@ module Coconductor
       # Returns an array of Fields for the given code of conduct
       def from_code_of_conduct(code_of_conduct)
         matches = []
-        return [] unless code_of_conduct && code_of_conduct.content
+        return [] unless code_of_conduct&.content
 
         code_of_conduct.content.scan(REGEX) do |_m|
           matches << Regexp.last_match
@@ -60,9 +62,7 @@ module Coconductor
 
     def description
       @description ||= begin
-        if parts && parts[:description] && parts[:description] != ''
-          return parts[:description].capitalize
-        end
+        return parts[:description].capitalize if parts && parts[:description] && parts[:description] != ''
 
         DESCRIPTIONS[key]
       end

data/lib/coconductor/matchers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Coconductor
   module Matchers
     autoload :Dice,       'coconductor/matchers/dice'

data/lib/coconductor/matchers/dice.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Coconductor
   module Matchers
     class Dice < Licensee::Matchers::Dice

data/lib/coconductor/matchers/exact.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Coconductor
   module Matchers
     class Exact < Licensee::Matchers::Exact

data/lib/coconductor/matchers/field_aware.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Coconductor
   module Matchers
     class FieldAware < Licensee::Matchers::Exact
@@ -17,7 +19,7 @@ module Coconductor
 
       private
 
-      FIELD_PLACEHOLDER = 'COCONDUCTOR_FIELD_COCONDUCTOR'.freeze
+      FIELD_PLACEHOLDER = 'COCONDUCTOR_FIELD_COCONDUCTOR'
       FIELD_PLACEHOLDER_REGEX = /coconductor\\ field\\ coconductor/.freeze
 
       def regex_for(code_of_conduct)

data/lib/coconductor/matchers/matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Coconductor
   module Matchers
     module Matcher

data/lib/coconductor/project_files.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Coconductor
   module ProjectFiles
     autoload :ProjectFile, 'coconductor/project_files/project_file'

data/lib/coconductor/project_files/code_of_conduct_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Coconductor
   module ProjectFiles
     class CodeOfConductFile < Coconductor::ProjectFiles::ProjectFile
@@ -11,7 +13,7 @@ module Coconductor
       FILENAME_REGEX = /#{BASENAME_REGEX}#{LANG_REGEX}#{EXT_REGEX}?/i.freeze
 
       def self.name_score(filename)
-        filename =~ /\A#{FILENAME_REGEX}/ ? 1.0 : 0.0
+        /\A#{FILENAME_REGEX}/.match?(filename) ? 1.0 : 0.0
       end
 
       def possible_matchers

data/lib/coconductor/project_files/project_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Coconductor
   module ProjectFiles
     class ProjectFile < Licensee::ProjectFiles::ProjectFile

data/lib/coconductor/projects.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Coconductor
   module Projects
     autoload :Project, 'coconductor/projects/project'

data/lib/coconductor/projects/fs_project.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Coconductor
   module Projects
     class FSProject < Licensee::Projects::FSProject

data/lib/coconductor/projects/git_project.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Coconductor
   module Projects
     class GitProject < Licensee::Projects::GitProject

data/lib/coconductor/projects/github_project.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 autoload :Octokit, 'octokit'
 
 module Coconductor

data/lib/coconductor/projects/project.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Coconductor
   module Projects
     module Project
       DIRS = ['./', './docs/', './.github/'].freeze
 
       def code_of_conduct
-        code_of_conduct_file.code_of_conduct if code_of_conduct_file
+        code_of_conduct_file&.code_of_conduct
       end
 
       def code_of_conduct_file