danger-samsao 0.1.0

data/Rakefile

@@ -0,0 +1,22 @@
+# rubocop:disable Style/HashSyntax
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+task default: :check
+
+task :check => [:lint, :tests]
+
+task :lint => [:lint_ruby, :lint_danger]
+
+desc 'Run RuboCop on the lib/specs directory'
+RuboCop::RakeTask.new(:lint_ruby)
+
+desc 'Ensure that the plugin passes `danger plugins lint`'
+task :lint_danger do
+  sh 'bundle exec danger plugins lint --warnings-as-errors'
+end
+
+task :test => [:tests]
+RSpec::Core::RakeTask.new(:tests)

data/bitrise.wrapper.yml

@@ -0,0 +1,51 @@
+---
+format_version: 1.4.0
+default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git
+description: |-
+  This wrapper is configure in bitrise.io editor as the script to run. What it
+  does mainly is to simply clone the repository and forward the execution of the
+  workflow to the real build file (bitrise.yml) which is hosted in this repository.
+
+  To work, main workflow here must also be present in bitrise.yml, so main workflows
+  must be kept synchronized between the two.
+
+  Also, any change made to this file must be **manually** added to bitrise.io editor.
+  Simply copy/paste the content of this file into the web editor and press save.
+
+  To test locally using bitrise CLI, while at project root directory, simply do:
+
+    bitrise run <workflow> -c bitrise.wrapper.yml
+
+  See http://devcenter.bitrise.io/tips-and-tricks/use-bitrise-yml-from-repository/
+  for details on the technique.
+
+trigger_map:
+  - push_branch: "develop"
+    workflow: "develop"
+  - pull_request_target_branch: "*"
+    pull_request_source_branch: "*"
+    workflow: "pr"
+
+workflows:
+  _run_from_repo:
+    steps:
+    - activate-ssh-key@3.1.1:
+        title: Activate SSH credentials
+        run_if: '{{getenv "SSH_RSA_PRIVATE_KEY" | ne ""}}'
+    - git-clone@3.4.2:
+        title: Clone repository
+    - script@1.1.3:
+        title: Continue using repository bitrise.yml
+        inputs:
+        - content: |-
+            #!/bin/bash
+            set -ex
+            bitrise run "${BITRISE_TRIGGERED_WORKFLOW_ID}"
+
+  develop:
+    after_run:
+    - _run_from_repo
+
+  pr:
+    after_run:
+    - _run_from_repo

data/bitrise.yml

@@ -0,0 +1,70 @@
+---
+format_version: 1.4.0
+default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git
+
+workflows:
+  # Main Workflows
+
+  develop:
+    before_run:
+    - _setup
+
+    after_run:
+    - _teardown
+
+  pr:
+    before_run:
+    - _setup
+
+    after_run:
+    - _teardown
+
+  # Composite Workflows
+
+  _setup:
+    before_run:
+    - _cache_pull
+    - _prepare
+    - _lint
+    - _test
+
+  _teardown:
+    after_run:
+    - _cache_push
+
+  # Private workflows
+
+  _cache_push:
+    steps:
+    - cache-push@0.9.4:
+        title: Push cache
+        run_if: .IsCI
+        inputs:
+        - cache_paths: |-
+            $HOME/.bundle
+
+  _cache_pull:
+    steps:
+    - cache-pull@0.9.2:
+        title: Pull cache
+
+  _lint:
+    steps:
+    - script@1.1.3:
+        title: Linting
+        inputs:
+        - content: bundle exec rake lint
+
+  _prepare:
+    steps:
+    - script@1.1.3:
+        title: Prepare (installing dependencies)
+        inputs:
+        - content: bundle install
+
+  _test:
+    steps:
+    - script@1.1.3:
+        title: Tests
+        inputs:
+        - content: bundle exec rake tests

data/danger-samsao.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'samsao/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name = 'danger-samsao'
+  spec.version = Samsao::VERSION
+  spec.authors = ['Samsao Development Inc.']
+  spec.email = ['mvachon@samsao.co']
+  spec.description = 'Danger plugin for Samsao PR guidelines.'
+  spec.summary = 'A longer description of danger-samsao.'
+  spec.homepage = 'https://github.com/samsao/danger-samsao'
+  spec.license = 'MIT'
+
+  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 'danger-plugin-api', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.2'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'pry', '~> 0.11.0.pre2'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.41'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'yard', '~> 0.8'
+end

data/lib/danger_plugin.rb

@@ -0,0 +1 @@
+require 'samsao/plugin'

data/lib/danger_samsao.rb

@@ -0,0 +1 @@
+require 'samsao/gem_version'

data/lib/samsao/actions.rb

@@ -0,0 +1,53 @@
+module Samsao
+  # Actions mixin module
+  module Actions
+    # Fails when git branching model is not respected for PR branch name.
+    #
+    # @return [void]
+    def fail_when_wrong_branching_model
+      message = 'Your branch should be prefixed with feature/, fix/, trivial/ or release/!'
+
+      fail message unless respects_branching_model
+    end
+
+    # Fails when a feature branch have than one commit
+    #
+    # @return [void]
+    def fail_when_non_single_commit_feature
+      commit_count = git.commits.size
+      message = "Your feature branch should have a single commit but found #{commit_count}, squash them together!"
+
+      fail message if feature_branch? && commit_count > 1
+    end
+
+    # Fails when CHANGELOG is not updated on feature or fix branches
+    #
+    # @return [void]
+    def fail_when_changelog_update_missing
+      return if trivial_change?
+
+      message = 'You did a fix or a feature without updating CHANGELOG file!'
+
+      fail message unless changelog_modified?
+    end
+
+    # Fails when one or more merge commit is detected.
+    #
+    # @return [void]
+    def fail_when_merge_commit_detected
+      message = 'Some merge commits were detected, you must use rebase to sync with base branch.'
+      merge_commit_detector = /^Merge branch '#{github.branch_for_base}'/
+
+      fail message if git.commits.any? { |commit| commit.message =~ merge_commit_detector }
+    end
+
+    # Fails when CHANGELOG is not updated on feature or fix branches
+    #
+    # @return [void]
+    def warn_when_work_in_progess_pr
+      message = 'Do not merge, PR is a work in progess [WIP]!'
+
+      warn message if github.pr_title.include?('[WIP]')
+    end
+  end
+end

data/lib/samsao/config.rb

@@ -0,0 +1,21 @@
+module Danger
+  # Samsao's config class
+  class SamsaoConfig
+    def initialize
+      @changelogs = ['CHANGELOG.md']
+      @sources = []
+    end
+
+    def changelogs(*entries)
+      return @changelogs if entries.nil? || entries.empty?
+
+      @changelogs = entries
+    end
+
+    def sources(*entries)
+      return @sources if entries.nil? || entries.empty?
+
+      @sources = entries
+    end
+  end
+end

data/lib/samsao/gem_version.rb

@@ -0,0 +1,3 @@
+module Samsao
+  VERSION = '0.1.0'.freeze
+end

data/lib/samsao/helpers.rb

@@ -0,0 +1,79 @@
+# rubocop:disable Style/PredicateName
+
+module Samsao
+  # Helpers mixin module
+  module Helpers
+    # Check if any changelog were modified. When the helper receives nothing,
+    # changelogs defined by the config are used.
+    #
+    # @return [Boolean] True if any changelogs were modified in this commit
+    def changelog_modified?(*changelogs)
+      changelogs = config.changelogs if changelogs.nil? || changelogs.empty?
+
+      changelogs.any? { |changelog| git.modified_files.include?(changelog) }
+    end
+
+    # Return true if the current PR branch is a feature branch
+    #
+    # @return [void]
+    def feature_branch?
+      git_branch.start_with?('feature/')
+    end
+
+    # Return true if the current PR branch is a feature branch
+    #
+    # @return [void]
+    def fix_branch?
+      git_branch.start_with?('fix/')
+    end
+
+    # Return true if the current PR branch is a release branch
+    #
+    # @return [void]
+    def release_branch?
+      git_branch.start_with?('release/')
+    end
+
+    # Return true if the current PR branch is a trivial branch
+    #
+    # @return [void]
+    def trivial_branch?
+      git_branch.start_with?('trivial/')
+    end
+
+    # Return true if the current PR is a trivial change (branch is `trivial_branch?`)
+    # or PR title contains #trivial or #typo markers.
+    #
+    # @return [void]
+    def trivial_change?
+      trivial_branch? || ['#trivial', '#typo'].any? { |modifier| github.pr_title.include?(modifier) }
+    end
+
+    # Return true if any source files are in the git modified files list.
+    #
+    # @return [void]
+    def has_app_changes?(*sources)
+      sources = config.sources if sources.nil? || sources.empty?
+
+      sources.any? do |source|
+        pattern = Samsao::Regexp.from_matcher(source, when_string_pattern_prefix_with: '^')
+
+        modified_file?(pattern)
+      end
+    end
+
+    private
+
+    def git_branch
+      github.branch_for_head
+    end
+
+    def modified_file?(matcher)
+      !git.modified_files.grep(matcher).empty?
+    end
+
+    def respects_branching_model
+      feature_branch? || fix_branch? || release_branch? || trivial_branch?
+    end
+  end
+end

data/lib/samsao/plugin.rb

@@ -0,0 +1,28 @@
+require 'samsao/actions'
+require 'samsao/config'
+require 'samsao/helpers'
+require 'samsao/regexp'
+
+module Danger
+  # Samsao's Danger plugin.
+  #
+  # @example See README.md
+  #
+  # @see samsao/danger-samsao
+  # @tags internal, private, enterprise
+  #
+  class DangerSamsao < Plugin
+    include Samsao::Actions
+    include Samsao::Helpers
+
+    # Enable to configure the plugin configuration object.
+    #
+    # @return [Array<String>] (if no block given)
+    def config(&block)
+      @config = Danger::SamsaoConfig.new if @config.nil?
+      return @config unless block_given?
+
+      @config.instance_eval(&block)
+    end
+  end
+end

data/lib/samsao/regexp.rb

@@ -0,0 +1,29 @@
+module Samsao
+  # Regexp utility methods
+  module Regexp
+    # Turns a source entry input into a Regexp. Uses rules from [from_matcher](#from_matcher)
+    # function and append a `^` to final regexp when the source if a pure String.
+    #
+    # @param matcher The source entry to transform into a Regexp
+    #
+    # @return [Regexp] The source entry as a regexp
+    def self.from_source(source)
+      from_matcher(source, when_string_pattern_prefix_with: '^')
+    end
+
+    # Turns an input into a Regexp. If the input is a String, it turns it
+    # into a Regexp and escape all special characters. If the input is already
+    # a Regexp, it returns it without modification.
+    #
+    # @param matcher The input matcher to transform into a Regexp
+    # @keyword when_string_pattern_prefix_with (Default: '') The prefix that should be added to
+    #               final regexp when the input matcher is a string type
+    #
+    # @return [Regexp] The input as a regexp
+    def self.from_matcher(matcher, when_string_pattern_prefix_with: '')
+      return matcher if matcher.is_a?(::Regexp)
+
+      /#{when_string_pattern_prefix_with}#{::Regexp.quote(matcher)}/
+    end
+  end
+end

data/spec/matchers/have_error.rb

@@ -0,0 +1,25 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :have_error do |expected|
+  match do |actual|
+    actual.status_report[:errors].any? do |error|
+      expected.is_a?(Regexp) ? error =~ matcher : error.start_with?(expected)
+    end
+  end
+
+  failure_message do |actual|
+    message = "expected that #{Danger} would have error '#{expected}'"
+
+    errors = actual.status_report[:errors]
+    if errors.empty?
+      message += ' but there is none'
+      return message
+    end
+
+    actual.status_report[:errors].each do |error|
+      message += "\n * #{error}"
+    end
+
+    message
+  end
+end

data/spec/matchers/have_no_error.rb

@@ -0,0 +1,14 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :have_no_error do
+  match do |actual|
+    actual.status_report[:errors].empty?
+  end
+
+  failure_message do |actual|
+    message = "expected that #{Danger} would have no error but found '#{actual.status_report[:errors].size}'"
+    actual.status_report[:errors].each do |error|
+      message += "\n * #{error}"
+    end
+  end
+end