coconductor 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b71c775a757f82264c097801280f182591524317178c4e3116d6b6c4f123d086
-  data.tar.gz: 2e3cde6e96c80a419e43f0bafaca5ecb2f263b8d58a93b688d746cdedccac3d6
+  metadata.gz: 03e268467a41069c7e787e1ea18aa23a58f3cf8d438b79defb9d95e416095f8b
+  data.tar.gz: a3730a78e0c79cc1e8b4d2d4bb7b6b636c7d77153e0dfc9d7658d384bddd77b1
 SHA512:
-  metadata.gz: 0c452909e461a7311b4d9022c427319a025a7b9788e0a8d3883e93b530e82ed0ccf5ee90218c49731ac8699e7b3a97e2806a7f881b60bc43ffe31bba9e8d64d7
-  data.tar.gz: 337bc8152131a12b6686640560f5695569bfd0d3a2aa83a30ee59f31eb4a7babe67e0752793ca756366210e37d030a7b4794addf3ed2e86f9a096edd7e100464
+  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'
@@ -24,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'licensee', '~> 9.9', '>= 9.9.4'
-  spec.add_dependency 'thor', '~> 0.18'
+  spec.add_dependency 'thor', '>= 0.18', '< 2.0'
   spec.add_dependency 'toml', '~> 0.2'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
@@ -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
@@ -37,7 +39,7 @@ module Coconductor
           [
             matches['family'], 'version', matches['version'], matches['lang']
           ].compact.join('/')
-        end.compact
+        end.compact.sort
       end
 
       def latest_in_family(family, language: DEFAULT_LANGUAGE)
@@ -50,7 +52,7 @@ module Coconductor
       def families
         @families ||= begin
           families = Dir["#{vendor_dir}/*"].map { |dir| File.basename(dir) }
-          families - ['bundle']
+          (families - ['bundle']).sort
         end
       end
 
@@ -70,17 +72,18 @@ module Coconductor
       /version
       /(?<version>(?<major>\d)/(?<minor>\d)(/(?<patch>\d))?|(longer|shorter))
       /#{Coconductor::ProjectFiles::CodeOfConductFile::FILENAME_REGEX}
-    }ix
-    DEFAULT_LANGUAGE = 'en'.freeze
+    }ix.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
@@ -130,7 +133,7 @@ module Coconductor
     alias body content
 
     def inspect
-      "#<Licensee::CodeOfConduct key=#{key}>"
+      "#<Coconductor::CodeOfConduct key=#{key}>"
     end
 
     def family
@@ -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,7 +1,9 @@
+# frozen_string_literal: true
+
 module Coconductor
   # Represents a fillable field in a code of conduct
   class Field
-    REGEX = /\[(?<name>[A-Z_ ]{2,})[\s:-]*(?<description>.*?)\]/
+    REGEX = /\[(?<name>[A-Z_ ]{2,})[\s:-]*(?<description>.*?)\]/.freeze
 
     # the matchable raw text within the code of conduct including brackets
     attr_reader :raw_text
@@ -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
@@ -40,7 +42,7 @@ module Coconductor
     def initialize(raw_text, name: nil, description: nil)
       @raw_text = raw_text
       @name = name
-      @description = description if description && description != ''
+      @description = description.capitalize if description && description != ''
     end
 
     # The unformatted field name as found in the code of conduct text
@@ -60,9 +62,7 @@ module Coconductor
 
     def description
       @description ||= begin
-        if parts && parts[:description] && parts[:description] != ''
-          return parts[:description]
-        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,8 +19,8 @@ module Coconductor
 
       private
 
-      FIELD_PLACEHOLDER = 'COCONDUCTOR_FIELD_COCONDUCTOR'.freeze
-      FIELD_PLACEHOLDER_REGEX = /coconductor\\ field\\ coconductor/
+      FIELD_PLACEHOLDER = 'COCONDUCTOR_FIELD_COCONDUCTOR'
+      FIELD_PLACEHOLDER_REGEX = /coconductor\\ field\\ coconductor/.freeze
 
       def regex_for(code_of_conduct)
         coc = code_of_conduct.dup

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,17 +1,19 @@
+# frozen_string_literal: true
+
 module Coconductor
   module ProjectFiles
     class CodeOfConductFile < Coconductor::ProjectFiles::ProjectFile
       include Licensee::ContentHelper
 
       EXTENSIONS = %w[md markdown txt].freeze
-      EXT_REGEX = /\.#{Regexp.union(EXTENSIONS)}/i
-      BASENAME_REGEX = /(citizen[_-])?code[_-]of[_-]conduct/i
+      EXT_REGEX = /\.#{Regexp.union(EXTENSIONS)}/i.freeze
+      BASENAME_REGEX = /(citizen[_-])?code[_-]of[_-]conduct/i.freeze
       # LANG_REGEX must contain extension to avoid matching .md as the lang
-      LANG_REGEX = /(\.(?<lang>[a-z]{2}(-[a-z]{2})?)#{EXT_REGEX})?/i
-      FILENAME_REGEX = /#{BASENAME_REGEX}#{LANG_REGEX}#{EXT_REGEX}?/i
+      LANG_REGEX = /(\.(?<lang>[a-z]{2}(-[a-z]{2})?)#{EXT_REGEX})?/i.freeze
+      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