coconductor 0.2.0

data/docs/CONTRIBUTING.md

@@ -0,0 +1,85 @@
+# Contributing to Coconductor
+
+Hi there! We're thrilled that you'd like to contribute to Coconductor. Your help is essential for keeping it great.
+
+Coconductor is an open source project supported by the efforts of an entire community and built one contribution at a time by users like you. We'd love for you to get involved. Whatever your level of skill or however much time you can give, your contribution is greatly appreciated. There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, helping other users by commenting on issues, or writing code which can be incorporated into Coconductor itself.
+
+Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
+
+
+
+## How to report a bug
+
+Think you found a bug? Please check [the list of open issues](https://github.com/benbalter/coconductor/issues) to see if your bug has already been reported. If it hasn't please [submit a new issue](https://github.com/benbalter/coconductor/issues/new).
+
+Here are a few tips for writing *great* bug reports:
+
+* Describe the specific problem (e.g., "widget doesn't turn clockwise" versus "getting an error")
+* Include the steps to reproduce the bug, what you expected to happen, and what happened instead
+* Check that you are using the latest version of the project and its dependencies
+* Include what version of the project your using, as well as any relevant dependencies
+* Only include one bug per issue. If you have discovered two bugs, please file two issues
+* Include screenshots or screencasts whenever possible
+* Even if you don't know how to fix the bug, including a failing test may help others track it down
+
+**If you find a security vulnerability, do not open an issue. Please email ben@balter.com instead.**
+
+## How to suggest a feature or enhancement
+
+If you find yourself wishing for a feature that doesn't exist in Coconductor, you are probably not alone. There are bound to be others out there with similar needs. Many of the features that Coconductor has today have been added because our users saw the need.
+
+Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and goals of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible, including describing the problem you're trying to solve.
+
+[Open an issue](https://github.com/benbalter/coconductor/issues/new) which describes the feature you would like to see, why you want it, how it should work, etc.
+
+
+
+## Your first contribution
+
+We'd love for you to contribute to the project. Unsure where to begin contributing to Coconductor? You can start by looking through these "good first issue" and "help wanted" issues:
+
+* [Good first issues](https://github.com/benbalter/coconductor/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) - issues which should only require a few lines of code and a test or two
+* [Help wanted issues](https://github.com/benbalter/coconductor/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) - issues which may be a bit more involved, but are specifically seeking community contributions
+
+*p.s. Feel free to ask for help; everyone is a beginner at first* :smiley_cat:
+
+## How to propose changes
+
+Here's a few general guidelines for proposing changes:
+
+* If you are changing any user-facing functionality, please be sure to update the documentation
+* If you are adding a new behavior or changing an existing behavior, please be sure to update the corresponding test(s)
+* Each pull request should implement **one** feature or bug fix. If you want to add or fix more than one thing, submit more than one pull request
+* Do not commit changes to files that are irrelevant to your feature or bug fix
+* Don't bump the version number in your pull request (it will be bumped prior to release)
+* Write [a good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+
+At a high level, [the process for proposing changes](https://guides.github.com/introduction/flow/) is:
+
+1. [Fork](https://github.com/benbalter/coconductor/fork) and clone the project
+2. Configure and install the dependencies: `script/bootstrap`
+3. Make sure the tests pass on your machine: `script/cibuild`
+4. Create a descriptively named branch: `git checkout -b my-branch-name`
+5. Make your change, add tests and documentation, and make sure the tests still pass
+6. Push to your fork and [submit a pull request](https://github.com/benbalter/coconductor/compare) describing your change
+7. Pat your self on the back and wait for your pull request to be reviewed and merged
+
+**Interesting in submitting your first Pull Request?** It's easy! You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
+
+## Bootstrapping your local development environment
+
+`script/bootstrap`
+
+## Running tests
+
+`script/cibuild`
+
+## Code of conduct
+
+This project is governed by [the Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
+
+## Additional Resources
+
+* [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)
+* [Using Pull Requests](https://help.github.com/articles/using-pull-requests/)
+* [GitHub Help](https://help.github.com)

data/lib/coconductor.rb

@@ -0,0 +1,33 @@
+require 'coconductor/version'
+require 'licensee'
+
+module Coconductor
+  autoload :CodeOfConduct, 'coconductor/code_of_conduct'
+  autoload :Matchers,      'coconductor/matchers'
+  autoload :Projects,      'coconductor/projects'
+  autoload :ProjectFiles,  'coconductor/project_files'
+
+  CONFIDENCE_THRESHOLD = 90
+
+  class << self
+    attr_writer :confidence_threshold
+
+    def codes_of_conduct
+      CodeOfConduct.all
+    end
+
+    def code_of_conduct(path)
+      Coconductor.project(path).code_of_conduct
+    end
+
+    def project(path, **args)
+      Coconductor::Projects::GitProject.new(path, args)
+    rescue Coconductor::Projects::GitProject::InvalidRepository
+      Coconductor::Projects::FSProject.new(path, args)
+    end
+
+    def confidence_threshold
+      @confidence_threshold ||= CONFIDENCE_THRESHOLD
+    end
+  end
+end

data/lib/coconductor/code_of_conduct.rb

@@ -0,0 +1,155 @@
+require 'toml'
+
+module Coconductor
+  class InvalidCodeOfConduct < ArgumentError; end
+  class CodeOfConduct
+    VENDORED_CODES_OF_CONDUCT = %w[
+      citizen-code-of-conduct
+      contributor-covenant
+    ].freeze
+
+    KEY_REGEX = %r{
+      (?<family>#{Regexp.union(VENDORED_CODES_OF_CONDUCT)})
+      /version
+      /(?<major>\d)/(?<minor>\d)(/(?<patch>\d))?
+      /#{Coconductor::ProjectFiles::CodeOfConductFile::FILENAME_REGEX}
+    }ix
+    FIELD_REGEX = /\[(?<name>[A-Z_ ]{2,}).*\]/
+
+    class << self
+      def all
+        @all ||= keys.map { |key| new(key) }
+      end
+
+      def find(key)
+        all.find { |coc| coc.key == key }
+      end
+      alias [] find
+      alias find_by_key find
+
+      def vendor_dir
+        @vendor_dir ||= Pathname.new File.expand_path '../../vendor', __dir__
+      end
+
+      def keys
+        @keys ||= vendored_codes_of_conduct.map do |path|
+          path = Pathname.new(path)
+          key = path.relative_path_from(vendor_dir)
+          matches = KEY_REGEX.match(key.to_path)
+          matches.to_a.compact[1..-1].insert(1, 'version').join('/') if matches
+        end
+      end
+
+      private
+
+      def vendored_codes_of_conduct
+        @vendored_codes_of_conduct ||= begin
+          cocs = "{#{VENDORED_CODES_OF_CONDUCT.join(',')}}"
+          path = File.join vendor_dir, cocs, '**', '*.md'
+          Dir.glob(path)
+        end
+      end
+    end
+
+    attr_reader :key
+    attr_writer :content
+    include Licensee::ContentHelper
+
+    def initialize(key)
+      @key = key
+    end
+
+    def version
+      toml['version']
+    end
+
+    def language
+      @language ||= begin
+        parts = key.split('/')
+        parts.last if parts.last =~ /^[a-z-]{2,5}$/
+      end
+    end
+
+    def name
+      return @name if defined? @name
+      @name = name_without_version.dup
+      @name << " (#{language.upcase})" if language
+      @name << " v#{version}" if version
+      @name
+    end
+
+    def name_without_version
+      @name_without_version ||= begin
+        key.split('/').first.split('-').map(&:capitalize).join(' ')
+      end
+    end
+
+    def content
+      @content ||= parts.last
+    end
+
+    def inspect
+      "#<Licensee::CodeOfConduct key=#{key}>"
+    end
+
+    def family
+      @family ||= key.split('/').first
+    end
+
+    def contributor_covenant?
+      family == 'contributor-covenant'
+    end
+
+    def citizen_code_of_conduct?
+      family == 'citizen-code-of-conduct'
+    end
+
+    def fields
+      content.scan(FIELD_REGEX).flatten
+    end
+
+    private
+
+    def filename
+      if contributor_covenant?
+        filename = 'code-of-conduct'
+      elsif citizen_code_of_conduct?
+        filename = 'citizen_code_of_conduct'
+      end
+
+      filename << '.' + language if language
+      filename << '.md'
+    end
+
+    def path
+      parts = key.split('/')
+      parts.pop if language
+      path = File.join(*parts[0...5], filename)
+      path = File.expand_path path, self.class.vendor_dir
+      Pathname.new(path)
+    end
+
+    # Raw content of code of conduct file, including TOML front matter
+    def raw_content
+      unless File.exist?(path)
+        msg = "'#{key}' is not a valid code of conduct key"
+        raise Coconductor::InvalidCodeOfConduct, msg
+      end
+      @raw_content ||= File.read(path, encoding: 'utf-8')
+    end
+
+    def toml
+      @toml ||= begin
+        if parts.length == 3
+          TOML::Parser.new(parts[1]).parsed
+        else
+          {}
+        end
+      end
+    end
+
+    def parts
+      @parts ||= raw_content.split('+++')
+    end
+  end
+end

data/lib/coconductor/commands/detect.rb

@@ -0,0 +1,63 @@
+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'
+  option :diff, type: :boolean, desc: 'Compare the code of conduct to the closest match'
+  option :code_of_conduct, type: :string, desc: 'The key of the code of conduct to compare (implies --diff)'
+
+  def detect(_path = nil)
+    Coconductor.confidence_threshold = options[:confidence]
+    rows = []
+    rows << if code_of_conduct
+              ['Code of conduct:', code_of_conduct.name]
+            else
+              ['Code of conduct:', set_color('None', :red)]
+            end
+
+    unless code_of_conduct.nil?
+      %i[key family version language].each do |method|
+        value = code_of_conduct.public_send(method)
+        rows << [humanize(method, :method), humanize(value, method)] if value
+      end
+    end
+
+    unless code_of_conduct_file.nil?
+      %i[relative_path confidence matcher content_hash].each do |method|
+        value = code_of_conduct_file.public_send(method)
+        rows << [humanize(method, :method), humanize(value, method)] if value
+      end
+    end
+
+    print_table rows
+
+    return unless code_of_conduct_file && (options[:code_of_conduct] || options[:diff])
+    expected_code_of_conduct = options[:code_of_conduct] || closest_code_of_conduct
+    return unless expected_code_of_conduct
+
+    invoke(:diff, nil,
+           code_of_conduct: expected_code_of_conduct,
+           code_of_conduct_to_diff: code_of_conduct_file)
+  end
+
+  private
+
+  def closest_code_of_conduct
+    return unless code_of_conduct_file
+    matcher = Coconductor::Matchers::Dice.new(code_of_conduct_file)
+    matches = matcher.matches_by_similarity
+    matches.first.first.key unless matches.empty?
+  end
+
+  # Given a string or object, prepares it for output and human consumption
+  def humanize(value, type = nil)
+    case type
+    when :matcher
+      value.class
+    when :confidence
+      Licensee::ContentHelper.format_percent(value)
+    when :method
+      value.to_s.tr('_', ' ').capitalize + ':'
+    else
+      value
+    end
+  end
+end

data/lib/coconductor/commands/diff.rb

@@ -0,0 +1,75 @@
+require 'tmpdir'
+
+class CoconductorCLI < Thor
+  desc 'diff [PATH]', 'Compare the given code of conduct text to a known code of conduct'
+  option :code_of_conduct, type: :string, desc: 'The key of the code of conduct to compare'
+
+  def diff(_path = nil)
+    say "Comparing to #{expected_code_of_conduct.name}:"
+    rows = []
+    left = expected_code_of_conduct.content_normalized(wrap: 80)
+    right = code_of_conduct_to_diff.content_normalized(wrap: 80)
+
+    similarity = expected_code_of_conduct.similarity(code_of_conduct_to_diff)
+    similarity = Licensee::ContentHelper.format_percent(similarity)
+
+    rows << ['Input Length:', code_of_conduct_to_diff.length]
+    rows << ['License length:', expected_code_of_conduct.length]
+    rows << ['Similarity:', similarity]
+    print_table rows
+
+    if left == right
+      say 'Exact match!', :green
+      exit
+    end
+
+    Dir.mktmpdir do |dir|
+      path = File.expand_path 'CODE_OF_CONDUCT', dir
+      Dir.chdir(dir) do
+        `git init`
+        File.write(path, left)
+        `git add CODE_OF_CONDUCT`
+        `git commit -m 'left'`
+        File.write(path, right)
+        say `git diff --word-diff`
+      end
+    end
+  end
+
+  private
+
+  def code_of_conduct_to_diff
+    if options[:code_of_conduct_to_diff]
+      return options[:code_of_conduct_to_diff]
+    end
+
+    @code_of_conduct_to_diff ||= begin
+      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)
+    end
+  end
+
+  def expected_code_of_conduct
+    if options[:code_of_conduct]
+      @expected_code_of_conduct ||= Coconductor::CodeOfConduct.find(
+        options[:code_of_conduct]
+      )
+    end
+    return @expected_code_of_conduct if @expected_code_of_conduct
+
+    if options[:code_of_conduct]
+      error "#{options[:code_of_conduct]} is not a valid code of conduct"
+    else
+      error 'You must provide an expected code of conduct'
+    end
+
+    keys = Coconductor.codes_of_conduct.map(&:key).join(', ')
+    error "Valid codes of conduct: #{keys}"
+    exit 1
+  end
+end

data/lib/coconductor/commands/version.rb

@@ -0,0 +1,6 @@
+class CoconductorCLI < Thor
+  desc 'version', 'Return the Coconductor version'
+  def version
+    say Coconductor::VERSION
+  end
+end

data/lib/coconductor/matchers.rb

@@ -0,0 +1,8 @@
+module Coconductor
+  module Matchers
+    autoload :Dice,       'coconductor/matchers/dice'
+    autoload :Exact,      'coconductor/matchers/exact'
+    autoload :FieldAware, 'coconductor/matchers/field_aware'
+    autoload :Matcher,    'coconductor/matchers/matcher'
+  end
+end

data/lib/coconductor/matchers/dice.rb

@@ -0,0 +1,10 @@
+module Coconductor
+  module Matchers
+    class Dice < Licensee::Matchers::Dice
+      include Coconductor::Matchers::Matcher
+
+      undef_method :licenses_by_similarity
+      undef_method :potential_licenses
+    end
+  end
+end