danger-samsao 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17a57df336d68834fbc0789edfd27de8f66ad1b6
-  data.tar.gz: a1465dc66e0437c9659bbe61d4baae682133dc3a
+  metadata.gz: 03220a151b794360af987c44251ffd233e149fa6
+  data.tar.gz: '081d457757e6ca7108968cbdf1c35656222e4b7e'
 SHA512:
-  metadata.gz: 942d127d15303f2a7fcf8fb1df32ba074e5c401e5e23b732646c3b12ca5130ac2ed6fa6a2d3d602614201935a1755186570b467cf17d37813e05b483298606c2
-  data.tar.gz: 7f7b39dc19d1a8fbc998e2afc17191043b16947a61a61636576159b400a78f2a33635d89a1c95856959ae3547b46fe47917bb9851c50afb77a3d9b1cddf6e8dd
+  metadata.gz: 7cce010f0f2cc393b5be15c1e509988724903093eb85fd4128a2c4a53bb566c654dd19e056bb7c309b9c20bb628873c76f13db3a826f5ac9f580253f43996d1c
+  data.tar.gz: 931219f4890eaf3d817b1a29437987ed974c06dd3dcd6075ef8d10bc86a13b3d4c2d793a03e684f62b1b7591f5e74ff20a89926d60a055884664f4612ebe0d26

data/.travis/danger.sh

@@ -0,0 +1,7 @@
+#!/bin/sh -e
+
+if [ "$TRAVIS_PULL_REQUEST" != "false" ]
+then
+  echo 'Danger ...'
+  bundle exec danger
+fi

data/.travis.yml

@@ -1,12 +1,21 @@
 language: ruby
-cache:
-  directories:
-    - bundle
+cache: bundler
 
 rvm:
-  - 2.0
-  - 2.1.3
-  - 2.3.1
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
 
 script:
-    - bundle exec rake spec
+  - .travis/danger.sh
+
+  - echo 'Linting...'
+  - bundle exec rake lint
+
+  - echo 'Test...'
+  - bundle exec rake tests
+
+branches:
+  only:
+    - master
+    - develop

data/CHANGELOG.md

@@ -1,3 +1,55 @@
+## 0.3.0 (August 23, 2017)
+
+### Breaking Changes
+
+ * Renamed the following methods to match the `level` parameter they now optionally receive:
+    * `fail_when_wrong_branching_model` to `check_wrong_branching_model`
+    * `fail_when_non_single_commit_feature` to `check_non_single_commit_feature`
+    * `fail_when_changelog_update_missing` to `check_changelog_update_missing`
+    * `fail_when_merge_commit_detected` to `check_merge_commit_detected`
+    * `warn_when_work_in_progess_pr` to `check_work_in_progess_pr`
+
+#### Features
+
+ * Added `level` parameter to all actions to personnalize the report level 
+   (`:fail`, `:warn`, `:message`) if the check fails. 
+
+ * Added `have_message` and `have_no_message` matchers.
+ 
+ * Added `check_label_pr` action.
+
+ * Added `check_acceptance_criteria` action.
+
+ * Added `check_feature_jira_issue_number` action.
+
+ * Added `check_fix_jira_issue_number` action.
+
+ * Added `contains_jira_issue_number?` helper.
+
+ * Added `jira_project_key?` helper.
+
+ * Added `shorten_sha` helper.
+
+ * Added `truncate` helper.
+
+ *
+
+ *
+
+ *
+
+ *
+
+ *
+
+#### Support
+
+ * Fixed grammatical errors in the `README.md`.
+
+#### Support
+
+ * Open source repository and now using Travis as the build system.
+
 ## 0.2.0 (May 9, 2017)
 
 #### Breaking Changes

data/Dangerfile

@@ -7,13 +7,13 @@ samsao.config do
 end
 
 ## Errors
-samsao.fail_when_changelog_update_missing
-samsao.fail_when_merge_commit_detected
-samsao.fail_when_non_single_commit_feature
-samsao.fail_when_wrong_branching_model
+samsao.check_changelog_update_missing
+samsao.check_merge_commit_detected
+samsao.check_non_single_commit_feature
+samsao.check_wrong_branching_model
 
 ## Warnings
-samsao.warn_when_work_in_progess_pr
+samsao.check_work_in_progess_pr
 
 ## Messages
 unless status_report[:errors].empty?

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-samsao (0.2.0)
+    danger-samsao (0.3.0)
       danger-plugin-api (~> 1.0)
 
 GEM
@@ -134,4 +134,4 @@ DEPENDENCIES
   yard (~> 0.8)
 
 BUNDLED WITH
-   1.14.4
+   1.14.6

data/README.md

@@ -1,4 +1,4 @@
-# Danger Samsao
+# Danger Samsao [![Build Status](https://travis-ci.org/samsao/danger-samsao.svg?branch=develop)](https://travis-ci.org/samsao/danger-samsao)
 
 A Danger plugin bringing Samsao's PR guideline into code.
 
@@ -18,13 +18,13 @@ samsao.config do
 end
 
 ## Errors
-samsao.fail_when_changelog_update_missing
-samsao.fail_when_merge_commit_detected
-samsao.fail_when_non_single_commit_feature
-samsao.fail_when_wrong_branching_model
+samsao.check_changelog_update_missing
+samsao.check_merge_commit_detected
+samsao.check_non_single_commit_feature
+samsao.check_wrong_branching_model
 
 ## Warnings
-samsao.warn_when_work_in_progess_pr
+samsao.check_work_in_progess_pr
 
 ## Messages
 unless status_report[:errors].empty?
@@ -41,20 +41,34 @@ your `Dangerfile` under the `samsao` namespace.
 ### Table of Contents
 
  * [Config](#config)
+   * [Changelogs](#changelogs)
+   * [Jira Project Key](#jira-project-key)
+   * [Project Type](#project-type)
+   * [Sources](#sources)
  * [Actions](#actions)
-   * [samsao.fail_when_changelog_update_missing](#changelog-update-missing)
-   * [samsao.fail_when_merge_commit_detected](#merge-commits-detected)
-   * [samsao.fail_when_non_single_commit_feature](#feature-branch-multiple-commits)
-   * [samsao.fail_when_wrong_branching_model](#branching-model)
-   * [samsao.warn_when_work_in_progess_pr](#when-work-in-progess-pr)
+   * [Report Levels](#report-levels)
+   * [samsao.check_acceptance_criteria](#acceptance-criteria)
+   * [samsao.check_changelog_update_missing](#changelog-update-missing)
+   * [samsao.check_feature_jira_issue_number](#feature-jira-issue-number)
+   * [samsao.check_fix_jira_issue_number](#fix-jira-issue-number) 
+   * [samsao.check_label_pr](#label_pr)
+   * [samsao.check_merge_commit_detected](#merge-commits-detected)
+   * [samsao.check_non_single_commit_feature](#feature-branch-multiple-commits)
+   * [samsao.check_wrong_branching_model](#branching-model)
+   * [samsao.check_work_in_progess_pr](#when-work-in-progess-pr)
  * [Helpers](#helpers)
    * [samsao.changelog_modified?](#changelog-modified)
+   * [samsao.contains_any_jira_issue_number?](#contains-any-jira-issue-number) 
+   * [samsao.contains_single_jira_issue_number?](#contains-single-jira-issue-number)
    * [samsao.feature_branch?](#feature-branch)
    * [samsao.fix_branch?](#fix-branch)
    * [samsao.has_app_changes?](#has-app-changes)
+   * [samsao.jira_project_key?](#has-jira-project-key)
    * [samsao.release_branch?](#release-branch)
+   * [samsao.shorten_sha](#shorten-sha) 
    * [samsao.support_branch?](#support-branch)
    * [samsao.trivial_change?](#trivial-change)
+   * [samsao.truncate](#truncate) 
 
 ### Config
 
@@ -63,7 +77,8 @@ easier. This is done by using the `config` attributes the plugin:
 
 ```
 samsao.config do
-  changelogs 'CHANGELOG.yml'
+  changelogs 'CHANGELOG.md'
+  jira_project_key 'VER'
   project_type :library
   sources 'app/src'
 end
@@ -73,17 +88,30 @@ end
 
 Defaults: `[CHANGELOG.md]`
 
-Enable to change the CHANGELOG file paths looked upon when checking if
-CHANGELOG file has been modified or not.
+Enable to change the CHANGELOG file paths looked upon when checking if CHANGELOG 
+file has been modified or not.
+
+#### Jira Project Key
+
+Defaults: nil
+
+Example: `VER`
+
+This refers to the project key on Jira. This settings affects these actions and helpers:
+
+ * [samsao.check_feature_jira_issue_number](#feature-jira-issue-number)
+ * [samsao.check_fix_jira_issue_number](#fix-jira-issue-number)
+
+See the exact actions or helpers for precise details about implications.
 
 #### Project Type
 
 Defaults: `:application`
 
-Change the kind of project your are currently developing. This settings
-affects these actions and helpers:
+Change the kind of project you are currently developing. This settings affects 
+these actions and helpers:
 
- * [samsao.fail_when_changelog_update_missing](#changelog-update-missing)
+ * [samsao.check_when_changelog_update_missing](#changelog-update-missing)
 
 See the exact actions or helpers for precise details about implications.
 
@@ -91,8 +119,8 @@ See the exact actions or helpers for precise details about implications.
 
 Default: `[]`
 
-Enable to change which paths are considered has being source files of the
-project. Multiple entries can be passed. Accepts multiple entries to be passed:
+Enable to change which paths are considered as being source files of the project. 
+Multiple entries can be passed. Accepts multiple entries to be passed:
 
 ```
 samsao.config do
@@ -106,7 +134,7 @@ Each source entry can be a `Regexp`
 sources /^(common|mobile|web|/src)/
 ```
 
-Or a pure `String`. When a pure string, matches start of git modified files list:
+Or a pure `String`. When a pure string, matches the start of git modified files list:
 
 ```
   sources 'common/src'
@@ -116,18 +144,51 @@ Would match `common/src/a/b.txt` but not `other/common/src/a/b.txt`.
 
 ### Actions
 
-Here all the actions you can call in your own `Dangerfile` and how to
-configure them.
+Here all the actions you can call in your own `Dangerfile` and how to configure them. 
+
+#### Report Levels
+
+Each action as a `level` parameter that can be set to fail, warn or simply write 
+a message if the check fails. Each action also has a default value for the check.
+
+The possible values for `level` are the following:
+ * `:fail`
+ * `:warn`
+ * `:message`
+
+For example since `check_wrong_branching_model` has the default value of `:fail`. 
+If you don't want this check to reject your PR, you can overwrite it by writing :
+
+```
+samsao.check_wrong_branching_model :warn
+```
+
+Note that only a `:fail` will reject the PR.
+
+#### Acceptance Criteria
+
+```
+samsao.check_acceptance_criteria(level = :warn)
+```
+
+Parameters:
+ * `level` |  The [report level](#report-levels) to use when the check does not pass.
+
+Check if it's a feature branch (starts with `feature/`) and if the PR body contains
+the string `acceptance criteria`.
 
 #### Branching Model
 
 ```
-samsao.fail_when_wrong_branching_model
+samsao.check_wrong_branching_model(level = :fail)
 ```
 
-Going to make the PR fails when the branch does not respect the git branching
-model. We follow git flow branching model and failure will occurs if the branch
-name does not start with one of the following prefixes:
+Parameters:
+ * `level` |  The [report level](#report-levels) to use when the check does not pass.
+
+Check if the branch does not respect the git branching model. We follow git flow 
+branching model and if the branch name does not start with one of the following 
+prefixes:
 
  * `fix/`
  * `bugfix/`
@@ -139,47 +200,96 @@ name does not start with one of the following prefixes:
 #### CHANGELOG Update Missing
 
 ```
-samsao.fail_when_changelog_update_missing
+samsao.check_changelog_update_missing(level = :fail)
+```
+
+Parameters:
+ * `level` |  The [report level](#report-levels) to use when the check does not pass.
+
+Check if when a PR is made that is not flagged as a [trivial change](#trivial-change) 
+and the changelog (based on `changelogs` config options) has not been modified.
+
+When the project is of type `:application`, a change made to a [support branch]
+(#support-branch) will pass even if the changelog is not updated.
+
+#### Label PR
+
+```
+samsao.check_label_pr(level = :fail)
 ```
 
-This action reports a failure when a PR is made that is not flagged
-as a [trivial change](#trivial-change) and the changelog (based on
-`changelogs` config options) has not been modified.
+Parameters:
+ * `level` |  The [report level](#report-levels) to use when the check does not pass.
 
-When the project is of type `:application`, a change made to a [support
-branch](#support-branch) will not trigger a failure even if the changelog
-is not updated.
+Check if the PR has at least one label added to it.
 
 #### Feature Branch Multiple Commits
 
 ```
-samsao.fail_when_non_single_commit_feature
+samsao.check_non_single_commit_feature(level = :fail)
 ```
 
-Going to make the PR fails when it's a feature branch (starts with `feature/`)
-and the PR contains more than one commit.
+Parameters:
+ * `level` |  The [report level](#report-levels) to use when the check does not pass.
+
+Check if it's a feature branch (starts with `feature/`) and the PR contains more 
+than one commit.
+
+#### Feature Jira Issue Number
+
+```
+samsao.check_feature_jira_issue_number(level = :fail)
+```
+
+Parameters:
+ * `level` |  The [report level](#report-levels) to use when the check does not pass.
+
+Check if it's a feature branch (starts with `feature/`) and the PR title contains the
+issue number using your configuration's [jira project key](#jira-project-key).
+
+Example : `[VER-123] Adding new screen.`
+
+#### Fix Jira Issue Number
+
+```
+samsao.check_fix_jira_issue_number(level = :warn)
+```
+
+Parameters:
+ * `level` |  The [report level](#report-levels) to use when the check does not pass.
+
+Check if it's a feature branch (starts with `fix/`, `bugfix/` or `hotfix/`.) and if every
+commit message contains any issue number using your configuration's [jira project key](#jira-project-key).
+
+Example : `[VER-123, VER-124, VER-125] Bug fixes.`
 
 #### Merge Commit(s) Detected
 
 ```
-samsao.fail_when_merge_commit_detected
+samsao.check_merge_commit_detected(level = :fail)
 ```
 
-Going to make the PR fails when one or multipl merge commits are detcted.
+Parameters:
+ * `level` |  The [report level](#report-levels) to use when the check does not pass.
+
+Check if one or multiple merge commits are detected.
+
 A merge commit is one created when merging two branches and matching the
 regexp `^Merge branch '<base branch>'` where `<base branch>` is the branch
 the PR is being merged into (usually `develop`).
 
-Use a Git `rebase` to get rid of those commits and correctly sync up with
-`develop` branch.
+Use a Git `rebase` to get rid of those commits and correctly sync up with `develop` branch.
 
 #### Work in Progress PR
 
 ```
-samsao.warn_when_work_in_progess_pr
+samsao.check_work_in_progess_pr(level = :warn)
 ```
 
-Going to mark PR as in warning state when PR title contains the `[WIP]` marker
+Parameters:
+ * `level` |  The [report level](#report-levels) to use when the check does not pass.
+
+Check if the PR title contains the `[WIP]` marker
 
 ### Helpers
 
@@ -189,24 +299,22 @@ Going to mark PR as in warning state when PR title contains the `[WIP]` marker
 samsao.changelog_modified?
 ```
 
-When no arguments are given, returns true if any configured [changelogs](#changelogs) has
-been modified in this commit.
+When no arguments are given, returns true if any configured [changelogs](#changelogs) 
+has been modified in this commit.
 
-When one or more arguments is given, returns true if any given changelog entry file has been
-modified in this commit.
+When one or more arguments are given, returns true if any given changelog entry 
+file has been modified in this commit.
 
-#### Has App Changes?
+#### Contains Jira Issue Number?
 
 ```
-samsao.has_app_changes?
+samsao.contains_jira_issue_number?(input)
 ```
 
-When no arguments are given, returns true if any configured [source files](#sources) has
-been modified in this commit.
+Return true if input contains the issue number using your configuration's
+[jira project key](#jira-project-key). The input could be a PR title or a commit message.
 
-When one or more arguments is given, uses same rules as for [source files](#sources) (see
-section for details) and returns true if any given source entry files has been modified in this
-commit.
+Example : `[VER-123] Adding new screen.` or `[VER-123, VER-124, VER-125] Bug fixes.`
 
 #### Feature Branch?
 
@@ -224,6 +332,27 @@ samsao.fix_branch?
 
 Returns true if the PR branch starts with `fix/`, `bugfix/` or `hotfix/`.
 
+#### Has App Changes?
+
+```
+samsao.has_app_changes?
+```
+
+When no arguments are given, returns true if any configured [source files](#sources) 
+has been modified in this commit.
+
+When one or more arguments are given, uses same rules as for [source files](#sources) 
+(see section for details) and returns true if any given source entry files have 
+been modified in this commit.
+
+#### Has Jira Project Key?
+
+```
+samsao.jira_project_key?
+```
+
+Return true if the config has a [jira project key](#jira-project-key).
+
 #### Release Branch?
 
 ```
@@ -232,6 +361,17 @@ samsao.release_branch?
 
 Returns true if the PR branch starts with `release/`.
 
+#### Shorten Sha
+
+```
+samsao.shorten_sha(sha)
+```
+
+Parameters:
+ * `sha` |  The sha to shorten.
+
+Shorten the git sha to 8 characters mostly for readability.
+
 #### Support Branch?
 
 ```
@@ -248,6 +388,19 @@ samsao.trivial_change?
 
 Returns true if the PR title contains `#trivial`, `#typo` or `#typos`.
 
+#### Truncate
+
+```
+samsao.truncate(input, max = 30)
+```
+
+Parameters:
+ * `input` |  The input to truncate.
+ * `max` |  The max length of the truncated input.
+
+Truncate the input received to the max size passed as a parameter. the default value for
+the max is 30 characters.
+
 ## Development
 
 You must have `Ruby` and `Bundler` installed to develop this project as well
@@ -310,7 +463,7 @@ on the current commit of the current branch (should be the release commit
 made earlier) named `v0.1.0`. And it will finally push the branch & tag to the
 repository as well as building and publishing the gem on RubyGems.
 
-Last thing to do is bumping to next development version. Edit back
+The last thing to do is bumping to next development version. Edit back
 `CHANGELOG.md` so that `## In progress` is the new section header and
 add a bunch of empty lines (around 10, only 2 shown in the example for
 brevity) into single `Features` section (add other sections when updating
@@ -333,7 +486,7 @@ Also edit `lib/samsao/gem_version.rb` so that next development version
 value is used `VERSION = '0.1.1.pre1'.freeze`. The `.pre1` is the lowest
 possible version before the official `0.1.1` one (or higher).
 
-Commit all this changes together in a new commit that has the following
+Commit all these changes together in a new commit that has the following
 message:
 
 ```
@@ -341,5 +494,5 @@ Bumped to next development version
 ```
 
 Finally, create a PR with this branch and open a pull request and merge
-right away (your team mates should known in advance that a release is
+right away (your teammates should know in advance that a release is
 happening and branch merged faster than other ones).

data/Rakefile

@@ -11,7 +11,9 @@ task :check => [:lint, :tests]
 task :lint => [:lint_ruby, :lint_danger]
 
 desc 'Run RuboCop on the lib/specs directory'
-RuboCop::RakeTask.new(:lint_ruby)
+RuboCop::RakeTask.new(:lint_ruby) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb', '*.gemspec', 'Dangerfile', 'Gemfile', 'Guardfile', 'Rakefile']
+end
 
 desc 'Ensure that the plugin passes `danger plugins lint`'
 task :lint_danger do