danger-wcc 0.0.2

data/README.md

@@ -0,0 +1,2 @@
+Copyright (c) 2018 Watermark Community Church
+all rights reserved

data/Rakefile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:specs)
+
+task default: :specs
+
+task :spec do
+  Rake::Task['specs'].invoke
+  Rake::Task['rubocop'].invoke
+  Rake::Task['spec_docs'].invoke
+end
+
+desc 'Run RuboCop on the lib/specs directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+end
+
+desc 'Ensure that the plugin passes `danger plugins lint`'
+task :spec_docs do
+  sh 'bundle exec danger plugins lint'
+end

data/danger-wcc.gemspec

@@ -0,0 +1,58 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-wcc'
+  spec.version       = DangerWCC::VERSION
+  spec.authors       = ['Watermark Dev']
+  spec.email         = ['dev@watermark.org']
+  spec.description   = 'A Danger plugin for Watermark Church custom rules.'
+  spec.summary       = 'A Danger plugin for Watermark Church custom rules.'
+  spec.homepage      = 'https://github.com/watermarkchurch/danger-wcc'
+  spec.license       = 'Apache-2.0'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'brakeman'
+  spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
+  spec.add_runtime_dependency 'flay'
+  spec.add_runtime_dependency 'git_diff', '~> 0.3'
+  spec.add_runtime_dependency 'reek'
+
+  # General ruby development
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  # Testing support
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.3.0'
+  spec.add_development_dependency 'webmock', '~> 3.1'
+
+  # Linting code and docs
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'yard'
+
+  # Makes testing easy via `bundle exec guard`
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.3.0'
+
+  # If you want to work on older builds of ruby
+  spec.add_development_dependency 'listen', '3.0.7'
+
+  # This gives you the chance to run a REPL inside your tests
+  # via:
+  #
+  #    require 'pry'
+  #    binding.pry
+  #
+  # This will stop test execution and let you inspect the results
+  spec.add_development_dependency 'pry'
+end

data/lib/danger_plugin.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'wcc/plugin'

data/lib/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DangerWCC
+  VERSION = '0.0.2'
+end

data/lib/wcc/commit_lint.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require_relative 'commit_lint/commit_check'
+require_relative 'commit_lint/subject_cap_check'
+require_relative 'commit_lint/subject_words_check'
+require_relative 'commit_lint/subject_length_check'
+require_relative 'commit_lint/subject_period_check'
+require_relative 'commit_lint/empty_line_check'
+
+class Danger::DangerWCC < Danger::Plugin
+  # Run each commit in the PR through a message linting.
+  #
+  #  Commit lint will check each commit in the PR to ensure the following is
+  #  true:
+  #
+  #  * Commit subject begins with a capital letter (`subject_cap`)
+  #  * Commit subject is more than one word (`subject_word`)
+  #  * Commit subject is no longer than 50 characters (`subject_length`)
+  #  * Commit subject does not end in a period (`subject_period`)
+  #  * Commit subject and body are separated by an empty line (`empty_line`)
+  #
+  #  By default, Commit Lint fails, but you can configure this behavior.
+  #
+  #
+  # @example Lint all commits using defaults
+  #
+  #          commit_lint.check
+  #
+  # @example Warn instead of fail
+  #
+  #          commit_lint.check warn: :all
+  #
+  # @example Disable a particular check
+  #
+  #          commit_lint.check disable: [:subject_period]
+  #
+  # @see danger/danger
+  # @tags commit linting
+  #
+  class CommitLint
+    NOOP_MESSAGE = 'All checks were disabled, nothing to do.'
+
+    def initialize(plugin, config = {})
+      @plugin = plugin
+      @config = config
+    end
+
+    def git
+      @plugin.git
+    end
+
+    def messaging
+      @plugin
+    end
+
+    # Checks the commits with whatever config the user passes.
+    #
+    # Passing in a hash which contain the following keys:
+    #
+    #  * `disable` - array of checks to skip
+    #  * `fail` - array of checks to fail on
+    #  * `warn` - array of checks to warn on
+    #
+    #  The current check types are:
+    #
+    #  * `subject_cap`
+    #  * `subject_word`
+    #  * `subject_length`
+    #  * `subject_period`
+    #  * `empty_line`
+    #
+    #  Note: you can pass :all instead of an array to target all checks.
+    #
+    # @param [Hash] config
+    #
+    # @return [void]
+    #
+    def perform
+      if all_checks_disabled?
+        messaging.warn NOOP_MESSAGE
+      else
+        check_messages
+      end
+    end
+
+    private
+
+    def check_messages
+      messages.each do |message|
+        warning_checkers.each do |klass|
+          check_and_issue(klass, message, 'warn')
+        end
+
+        failing_checkers.each do |klass|
+          check_and_issue(klass, message, 'fail')
+        end
+      end
+    end
+
+    def check_and_issue(klass, message, severity)
+      c = klass.new(message, @config.fetch(klass.type, {}))
+      return unless c.fail?
+
+      messaging.issue([c.message, message[:sha]].join("\n"),
+        severity: severity)
+    end
+
+    def checkers
+      [
+        SubjectCapCheck,
+        SubjectWordsCheck,
+        SubjectLengthCheck,
+        SubjectPeriodCheck,
+        EmptyLineCheck
+      ]
+    end
+
+    def checks
+      checkers.map(&:type)
+    end
+
+    def enabled_checkers
+      checkers.reject { |klass| disabled_checks.include? klass.type }
+    end
+
+    def warning_checkers
+      enabled_checkers.select { |klass| warning_checks.include? klass.type }
+    end
+
+    def failing_checkers
+      enabled_checkers - warning_checkers
+    end
+
+    def all_checks_disabled?
+      @config[:disable] == :all || disabled_checks.count == checkers.count
+    end
+
+    def disabled_checks
+      @config[:disable] || []
+    end
+
+    def warning_checks
+      return checks if @config[:warn] == :all
+      @config[:warn] || []
+    end
+
+    def messages
+      git.commits.map do |commit|
+        (subject, empty_line) = commit.message.split("\n")
+        {
+          subject: subject,
+          empty_line: empty_line,
+          sha: commit.sha
+        }
+      end
+    end
+  end
+end

data/lib/wcc/commit_lint/README.md

@@ -0,0 +1,3 @@
+This folder copied and modified from
+https://github.com/jonallured/danger-commit_lint
+which is licensed under the MIT License

data/lib/wcc/commit_lint/commit_check.rb

@@ -0,0 +1,19 @@
+
+# frozen_string_literal: true
+
+class CommitCheck
+  def self.fail?(message, options)
+    new(message, options || {}).fail?
+  end
+
+  def initialize(message, options = {})
+  end
+
+  def message
+    raise NotImplementedError, 'implement in subclass'
+  end
+
+  def fail?
+    raise NotImplementedError, 'implement in subclass'
+  end
+end

data/lib/wcc/commit_lint/empty_line_check.rb

@@ -0,0 +1,22 @@
+
+# frozen_string_literal: true
+
+class EmptyLineCheck < CommitCheck
+  MESSAGE = 'Please separate subject from body with newline.'
+
+  def self.type
+    :empty_line
+  end
+
+  def initialize(message, _options = {})
+    @empty_line = message[:empty_line]
+  end
+
+  def message
+    MESSAGE
+  end
+
+  def fail?
+    @empty_line && !@empty_line.empty?
+  end
+end

data/lib/wcc/commit_lint/subject_cap_check.rb

@@ -0,0 +1,22 @@
+
+# frozen_string_literal: true
+
+class SubjectCapCheck < CommitCheck
+  MESSAGE = 'Please start subject with capital letter.'
+
+  def self.type
+    :subject_cap
+  end
+
+  def initialize(message, _options = {})
+    @first_character = message[:subject].split('').first
+  end
+
+  def message
+    MESSAGE
+  end
+
+  def fail?
+    @first_character != @first_character.upcase
+  end
+end

data/lib/wcc/commit_lint/subject_length_check.rb

@@ -0,0 +1,28 @@
+
+# frozen_string_literal: true
+
+class SubjectLengthCheck < CommitCheck
+  def self.type
+    :subject_length
+  end
+
+  def initialize(message, options = {})
+    @subject = message[:subject]
+    @max_length = options.fetch(:max, 50)
+    @min_length = options.fetch(:min, 1)
+  end
+
+  def message
+    if @subject.length > @max_length
+      "Please limit commit subject line to #{@max_length} characters."
+    else
+      "Please write a commit subject line of at least #{@min_length} "\
+        'characters.'
+    end
+  end
+
+  def fail?
+    @subject.length > @max_length ||
+      @subject.length < @min_length
+  end
+end

data/lib/wcc/commit_lint/subject_period_check.rb

@@ -0,0 +1,22 @@
+
+# frozen_string_literal: true
+
+class SubjectPeriodCheck < CommitCheck
+  MESSAGE = 'Please remove period from end of commit subject line.'
+
+  def self.type
+    :subject_period
+  end
+
+  def initialize(message, _options = {})
+    @subject = message[:subject]
+  end
+
+  def message
+    MESSAGE
+  end
+
+  def fail?
+    @subject.split('').last == '.'
+  end
+end

data/lib/wcc/commit_lint/subject_words_check.rb

@@ -0,0 +1,22 @@
+
+# frozen_string_literal: true
+
+class SubjectWordsCheck < CommitCheck
+  MESSAGE = 'Please use more than one word.'
+
+  def self.type
+    :subject_words
+  end
+
+  def initialize(message, _options = {})
+    @subject = message[:subject]
+  end
+
+  def message
+    MESSAGE
+  end
+
+  def fail?
+    @subject.split.count < 2
+  end
+end

data/lib/wcc/default.jshintrc

@@ -0,0 +1,5 @@
+{
+  "asi": true,
+  "expr": true,
+  "maxerr": 100
+}

data/lib/wcc/defaults.reek

@@ -0,0 +1,131 @@
+---
+Attribute:
+  enabled: true
+  exclude: []
+BooleanParameter:
+  enabled: true
+  exclude: []
+ClassVariable:
+  enabled: true
+  exclude: []
+ControlParameter:
+  enabled: true
+  exclude: []
+DataClump:
+  enabled: true
+  exclude: []
+  max_copies: 2
+  min_clump_size: 2
+DuplicateMethodCall:
+  enabled: true
+  exclude: []
+  max_calls: 2
+  allow_calls: []
+FeatureEnvy:
+  enabled: true
+  exclude: []
+InstanceVariableAssumption:
+  enabled: true
+  exclude: []
+IrresponsibleModule:
+  enabled: false
+  exclude: []
+LongParameterList:
+  enabled: true
+  exclude: []
+  max_params: 3
+  overrides:
+    initialize:
+      max_params: 5
+LongYieldList:
+  enabled: true
+  exclude: []
+  max_params: 3
+ManualDispatch:
+  enabled: true
+  exclude: []
+ModuleInitialize:
+  enabled: true
+  exclude: []
+NestedIterators:
+  enabled: true
+  exclude: []
+  max_allowed_nesting: 1
+  ignore_iterators:
+  - tap
+NilCheck:
+  enabled: true
+  exclude: []
+PrimaDonnaMethod:
+  enabled: true
+  exclude: []
+RepeatedConditional:
+  enabled: true
+  exclude: []
+  max_ifs: 2
+SubclassedFromCoreClass:
+  enabled: true
+  exclude: []
+Syntax:
+  enabled: true
+  exclude: []
+TooManyConstants:
+  enabled: false
+  exclude: []
+  max_constants: 5
+TooManyInstanceVariables:
+  enabled: false
+  exclude: []
+  max_instance_variables: 5
+TooManyMethods:
+  enabled: false
+  exclude: []
+  max_methods: 15
+TooManyStatements:
+  enabled: false
+  exclude:
+  - initialize
+  max_statements: 40
+UncommunicativeMethodName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeModuleName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  accept: []
+UncommunicativeParameterName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  - !ruby/regexp /^_/
+  accept: []
+UncommunicativeVariableName:
+  enabled: false
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept:
+  - !ruby/regexp /^_$/
+UnusedParameters:
+  enabled: true
+  exclude: []
+UnusedPrivateMethod:
+  enabled: false
+  exclude: []
+UtilityFunction:
+  enabled: true
+  exclude: []
+  public_methods_only: false