danger-samsao 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 608978c81f0415647bdf2a56bd87899397eccfca
+  data.tar.gz: 82332e9016b7efe03cee778b5fd43150cc494037
+SHA512:
+  metadata.gz: c80089389404b1c748ba22e14621e77af2ac1f6de1c56b0202b75b35700b58d59def8ee0c4afb6a9ce88bb88bfb9c759388290c78f0b106a423363a9d96ae3ab
+  data.tar.gz: b84adde8c6cb832fcdc00b769ba088a002a37c0237e78bab75ea7bc0a26ef14fa4ab17af8f12b38d195622c6cd4ce91f344d88a9436f6e881b65136059ff9f77

data/.env.example

@@ -0,0 +1 @@
+DANGER_GITHUB_API_TOKEN=

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+.env
+.yardoc
+
+*.gem

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+  TargetRubyVersion: '2.1'
+
+Metrics/BlockLength:
+  Max: 9999
+
+Metrics/LineLength:
+  Max: 120
+
+Style/IndentArray:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/WordArray:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.0
+  - 2.1.3
+  - 2.3.1
+
+script:
+    - bundle exec rake spec

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+## 0.1.0 (May 1, 2017)
+
+ * Added `fail_when_merge_commit_detected` action.
+
+ * Added `warn_when_work_in_progess_pr` action.
+
+ * Added `changelog_modified?` helper.
+
+ * Updated `trivial_change?` helper to support `#typo` in PR title.
+
+ * Added `has_app_changes?` helper.
+
+ * Added `trivial_change?` helper.
+
+ * Added branch helpers:
+    * `fix_branch?`
+    * `feature_branch?`
+    * `release_branch?`
+    * `trivial_branch?`
+
+ * Added `fail_when_changelog_update_missing` action.
+
+ * Added `fail_when_non_single_commit_feature` action.
+
+ * Added `fail_when_wrong_branching_model` action.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in danger-samsao.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,136 @@
+PATH
+  remote: .
+  specs:
+    danger-samsao (0.1.0)
+      danger-plugin-api (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    ast (2.3.0)
+    claide (1.0.1)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.1)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (5.1.1)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (~> 0.9)
+      faraday-http-cache (~> 1.0)
+      git (~> 1)
+      kramdown (~> 1.5)
+      octokit (~> 4.2)
+      terminal-table (~> 1)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
+    diff-lcs (1.3)
+    faraday (0.12.1)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (1.3.1)
+      faraday (~> 0.8)
+    ffi (1.9.18)
+    formatador (0.2.5)
+    git (1.3.0)
+    guard (2.14.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.2.0)
+      guard (~> 2.0)
+      rubocop (~> 0.20)
+    kramdown (1.13.2)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.11)
+    method_source (0.8.2)
+    multipart-post (2.0.0)
+    nap (1.1.0)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.7.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    pry (0.11.0.pre2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+    public_suffix (2.0.5)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    rb-fsevent (0.9.8)
+    rb-inotify (0.9.8)
+      ffi (>= 0.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.48.1)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    ruby_dep (1.5.0)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+    shellany (0.0.1)
+    terminal-table (1.7.3)
+      unicode-display_width (~> 1.1.1)
+    thor (0.19.4)
+    unicode-display_width (1.1.3)
+    yard (0.9.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  danger-samsao!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  guard-rubocop (~> 1.2)
+  pry (~> 0.11.0.pre2)
+  rake (~> 10.0)
+  rspec (~> 3.4)
+  rubocop (~> 0.41)
+  yard (~> 0.8)
+
+BUNDLED WITH
+   1.14.4

data/Guardfile

@@ -0,0 +1,21 @@
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |match| File.dirname(match[0]) }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Samsao Development Inc. <mvachon@samsao.co>
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,230 @@
+# Danger Samsao
+
+A Danger plugin bringing Samsao's PR guideline into code.
+
+## Installation
+
+Simply add `danger-samsao` to your `Gemfile` and configure your `Dangerfile`
+using all the nice goodies.
+
+## Usage
+
+Methods and attributes from this plugin are available in
+your `Dangerfile` under the `samsao` namespace.
+
+### Table of Contents
+
+ * [Config](#config)
+ * [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)
+ * [Helpers](#helpers)
+   * [samsao.changelog_modified?](#changelog-modified-)
+   * [samsao.feature_branch?](#feature-branch-)
+   * [samsao.fix_branch?](#fix-branch-)
+   * [samsao.has_app_changes?](#has-app-changes-)
+   * [samsao.release_branch?](#release-branch-)
+   * [samsao.trivial_branch?](#trivial-branch-)
+   * [samsao.trivial_change?](#trivial-change-)
+
+### Config
+
+Some of the actions of this plugin can be configured by project to make stuff
+easier. This is done by using the `config` attributes the plugin:
+
+```
+samsao.config do
+  changelogs 'CHANGELOG.yml'
+  sources 'app/src'
+end
+```
+
+#### Changelogs
+
+Default: `CHANGELOG.md`
+
+Enable to change the CHANGELOG file paths looked upon when checking if
+CHANGELOG file has been modified or not.
+
+#### Sources
+
+Default: `<Empty>`
+
+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:
+
+```
+samsao.config do
+  sources 'common/src', 'web/src'
+end
+```
+
+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:
+
+```
+  sources 'common/src'
+```
+
+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.
+
+#### Branching Model
+
+```
+samsao.fail_when_wrong_branching_model
+```
+
+Going to make the PR fails when the branch does not respect the git branching
+model.
+
+#### CHANGELOG Update Missing
+
+```
+samsao.fail_when_changelog_update_missing
+```
+
+Going to make the PR fails when it's a feature branch (starts with `feature/`)
+or fix branch (`fix/`) and the CHANGELOG file was not updated.
+
+#### Feature Branch Multiple Commits
+
+```
+samsao.fail_when_non_single_commit_feature
+```
+
+Going to make the PR fails when it's a feature branch (starts with `feature/`)
+and the PR contains more than one commit.
+
+#### Merge Commit(s) Detected
+
+```
+samsao.fail_when_merge_commit_detected
+```
+
+Going to make the PR fails when one or multipl merge commits are detcted.
+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.
+
+#### Work in Progress PR
+
+```
+samsao.warn_when_work_in_progess_pr
+```
+
+Going to mark PR as in warning state when PR title contains the `[WIP]` marker
+
+### Helpers
+
+#### Changelog Modified?
+
+```
+samsao.changelog_modified?
+```
+
+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.
+
+#### 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 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.
+
+#### Feature Branch?
+
+```
+samsao.feature_branch?
+```
+
+Returns true if the PR branch starts with `feature/`.
+
+#### Fix Branch?
+
+```
+samsao.fix_branch?
+```
+
+Returns true if the PR branch starts with `fix/`.
+
+#### Release Branch?
+
+```
+samsao.release_branch?
+```
+
+Returns true if the PR branch starts with `release/`.
+
+#### Trivial Branch?
+
+```
+samsao.trivial_branch?
+```
+
+Returns true if the PR branch starts with `trivial/`.
+
+#### Trivial Change?
+
+```
+samsao.trivial_change?
+```
+
+Returns true if the PR title contains `#trivial` or `#typo` or the branch is a
+trivial branch ([trivial_branch?](#trivial-branch-) helper).
+
+## Development
+
+You must have `Ruby` and `Bundler` installed to develop this project as well
+as a GitHub token (see [Testing](#tests) section below).
+
+1. Clone this repository.
+2. Run `bundle install` to setup dependencies.
+3. Run `bundle exec rake` to run the linters and the tests (See notes below about [testing](#tests)).
+4. Use `bundle exec guard` to automatically have tests run as you make changes.
+5. Make your changes.
+6. Send PR.
+
+### Tests
+
+Prior running test, you need to setup a GitHub API token. Connect to GitHub
+and then go to your profile's settings page. There, go to
+`Developer Settings > Personal access tokens` and click the `Generate new token`
+button. Enter a `Description` for the token something like `Danger Testing` and
+then check the `repo` box (`Full control of private repositories`) then click
+`Generate` at the bottom of the page.
+
+Once you have the token, make it available as an environment variable named
+`DANGER_GITHUB_API_TOKEN`. Preferred way is to use a `.env` file at the root
+of this project. Simply do `cp .env.example .env` and edit the copied `.env`
+and enter the token to the side of `DANGER_GITHUB_API_TOKEN` line.
+
+### Publish
+
+The release process is quite simple. It consists of doing a release commit,
+run a rake task and finally doing a bump to next version commit and push it.