danger-mention 0.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8297f54a5ea709aa67d5c032f4bd4b7c203abe7d
-  data.tar.gz: fa6c8849b61ee0e0a5bbdff94ef06070b3301097
+  metadata.gz: c15c140c232de314f7e29f13171bd5ab11192655
+  data.tar.gz: 422979de0bd74c63f311fce4cfaf3896ccfc9ea4
 SHA512:
-  metadata.gz: c2a807ac485bce802c103cdf982b988ee847941853a8027ce0174bc5680a3047a849120c71965a848a2ccb9b326d4c9c4ba361a9397a1deb5305301009ea2cfc
-  data.tar.gz: e253ef9e4789852d7b642f1c1d3aed67f267519b59119a509d5dfa3bff14e8dc6debfe89466322c40aac848a2fbd4e28071952906940b41999ac9000349f4bd9
+  metadata.gz: 3c626c992aa0d0acf6ddac75978130a123d4d8d50d28e6e8830fe56ae000058d0fcfc4b8b4a08161dc8fff183c4195b14eda833599c1a01965d6d8df5fe0bd16
+  data.tar.gz: 05047aaa830369a1a981bcd08665d187999fa6996438fa1c8be81a7cfea7b90adc2f0200c0914463784f197c8b605d9e3918c294a838b7d8871d2a9de49aad90

data/Gemfile.lock

@@ -1,50 +1,98 @@
 PATH
   remote: .
   specs:
-    danger-mention (0.1)
+    danger-mention (0.4.0)
       danger
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.4.0)
+    ast (2.3.0)
     claide (1.0.0)
-    claide-plugins (0.9.0)
-      cork (~> 0)
-      nap (~> 1.0)
+    claide-plugins (0.9.1)
+      cork
+      nap
       open4 (~> 1.3)
+    coderay (1.1.1)
     colored (1.2)
-    cork (0.1.0)
+    cork (0.2.0)
       colored (~> 1.2)
-    danger (0.10.0)
+    danger (3.0.3)
       claide (~> 1.0)
-      claide-plugins (~> 0.9)
+      claide-plugins (> 0.9.0)
       colored (~> 1.2)
       cork (~> 0.1)
-      faraday (~> 0)
+      faraday (~> 0.9)
       faraday-http-cache (~> 1.0)
       git (~> 1)
+      gitlab (~> 3.7.0)
+      kramdown (~> 1.5)
       octokit (~> 4.2)
-      redcarpet (~> 3.3)
       terminal-table (~> 1)
+      yard (~> 0.9.5)
     diff-lcs (1.2.5)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
-    faraday-http-cache (1.3.0)
+    faraday-http-cache (1.3.1)
       faraday (~> 0.8)
+    ffi (1.9.14)
+    formatador (0.2.5)
     git (1.3.0)
+    gitlab (3.7.0)
+      httparty (~> 0.13.0)
+      terminal-table
+    guard (2.14.0)
+      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)
+    httparty (0.13.7)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.3)
+    kramdown (1.12.0)
+    listen (3.0.7)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.0.10)
+    method_source (0.8.2)
+    multi_xml (0.5.5)
     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.3.0)
       sawyer (~> 0.7.0, >= 0.5.3)
     open4 (1.3.4)
+    parser (2.3.1.2)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rainbow (2.1.0)
     rake (10.5.0)
-    redcarpet (3.3.4)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
+      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.1)
+    rspec-core (3.5.2)
       rspec-support (~> 3.5.0)
     rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -53,10 +101,22 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
+    rubocop (0.42.0)
+      parser (>= 2.3.1.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)
     sawyer (0.7.0)
       addressable (>= 2.3.5, < 2.5)
       faraday (~> 0.8, < 0.10)
+    shellany (0.0.1)
+    slop (3.6.0)
     terminal-table (1.6.0)
+    thor (0.19.1)
+    unicode-display_width (1.1.0)
+    yard (0.9.5)
 
 PLATFORMS
   ruby
@@ -64,8 +124,12 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.3)
   danger-mention!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
   rake (~> 10.0)
   rspec (~> 3.4)
+  rubocop (~> 0.41)
+  yard (~> 0.8)
 
 BUNDLED WITH
    1.11.2

data/Guardfile

@@ -0,0 +1,19 @@
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+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

data/README.md

@@ -4,11 +4,7 @@ A [Danger](https://github.com/danger/danger) plugin to automatically mention pot
 
 ## Installation
 
-Add this line to your Gemfile:
-
-```rb
-gem 'danger-mention'
-```
+    $ gem install danger-mention
 
 ## Usage
 
@@ -21,7 +17,7 @@ mention.run
 Additionally you can set up maximum number of people to ping in the PR message, regexes of ignored files and list of users that will never be mentioned.
 
 ```rb
-mention.run(2, [".*.h"], ["wojteklu"])
+mention.run(2, ["Pods/"], ["wojteklu"])
 ```
 
 ## License

data/Rakefile

@@ -1,5 +1,23 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
-task default: :spec
+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-mention.gemspec

@@ -25,4 +25,12 @@ Gem::Specification.new do |spec|
   # Testing support
   spec.add_development_dependency 'rspec', '~> 3.4'
 
+  # Linting code and docs
+  spec.add_development_dependency 'rubocop', '~> 0.41'
+  spec.add_development_dependency 'yard', '~> 0.8'
+
+  # Makes testing easy via `bundle exec guard`
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+
 end

data/lib/danger_plugin.rb

@@ -7,21 +7,33 @@ module Danger
   # It downloads and parses the blame information of changed files
   # to figure out who may be a good reviewer.
   #
-  # @example Specifying max reviewers.
+  # @example Running plugin with reviewers count specified
   #
-  #          # Find maximum two reviewers without specifying
-  #          # ignored files and users
+  #          # Find maximum two reviewers
   #          mention.run(2, [], [])
   #
+  # @example Running plugin with some files blacklisted
+  #
+  #          # Find reviewers without parsing blame information
+  #          # from files matching to 'Pods/*'
+  #          mention.run(2, ["Pods/*"], [])
+  #
+  # @example Running plugin with some users blacklisted
+  #
+  #          # Find reviewers ignoring users 'wojteklu' and 'danger'
+  #          mention.run(2, [], ["wojteklu", "danger"])
+  #
+  # @tags github, review, mention, blame
+
   class DangerMention < Plugin
 
     # Mention potential reviewers.
     #
-    # @param   Integer max_reviewers
+    # @param   [Integer] max_reviewers
     #          Maximum number of people to ping in the PR message, default is 3.
-    # @param   [String] file_blacklist
+    # @param   [Array<String>] file_blacklist
     #          Regexes of ignored files.
-    # @param   [String] user_blacklist
+    # @param   [Array<String>] user_blacklist
     #          List of users that will never be mentioned.
     # @return  [void]
     #
@@ -48,6 +60,8 @@ module Danger
       end
     end
 
+    private
+
     def select_files(file_blacklist)
       files = Finder.parse(env.scm.diff)
 

data/lib/version.rb

@@ -1,4 +1,4 @@
 module DangerMention
-  VERSION = '0.2'
+  VERSION = '0.4.0'.freeze
   DESCRIPTION = 'Danger plugin to automatically mention potential reviewers on pull requests'
 end

data/spec/danger_plugin_spec.rb

@@ -1,9 +1,11 @@
 require File.expand_path('../spec_helper', __FILE__)
 
 module Danger
+
   describe DangerMention do
     before do
       @mention = testing_dangerfile.mention
+      DangerMention.send(:public, *DangerMention.private_instance_methods)
     end
 
     it 'is a plugin' do

data/spec/spec_helper.rb

@@ -1,30 +1,58 @@
 require 'pathname'
-
 ROOT = Pathname.new(File.expand_path('../../', __FILE__))
 $LOAD_PATH.unshift((ROOT + 'lib').to_s)
 $LOAD_PATH.unshift((ROOT + 'spec').to_s)
 
+require 'bundler/setup'
+require 'pry'
+
+require 'rspec'
+require 'danger'
+
+# Use coloured output, it's the best.
 RSpec.configure do |config|
-  # Use color in STDOUT
+  config.filter_gems_from_backtrace 'bundler'
   config.color = true
+  config.tty = true
 end
 
-require 'danger'
-require 'cork'
 require 'danger_plugin'
 
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it's already been done ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+# rubocop:disable Lint/NestedMethodDefinition
 def testing_ui
-  Cork::Board.new(silent: true)
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, '')
+  end
+  cork
 end
+# rubocop:enable Lint/NestedMethodDefinition
 
+# Example environment (ENV) that would come from
+# running a PR on TravisCI
 def testing_env
   {
     'HAS_JOSH_K_SEAL_OF_APPROVAL' => 'true',
-    'TRAVIS_PULL_REQUEST' => '1',
-    'TRAVIS_REPO_SLUG' => 'test'
+    'TRAVIS_PULL_REQUEST' => '800',
+    'TRAVIS_REPO_SLUG' => 'artsy/eigen',
+    'TRAVIS_COMMIT_RANGE' => '759adcbd0d8f...13c4dc8bb61d',
+    'DANGER_GITHUB_API_TOKEN' => '123sbdq54erfsd3422gdfio'
   }
 end
 
+# A stubbed out Dangerfile for use in tests
 def testing_dangerfile
   env = Danger::EnvironmentManager.new(testing_env)
   Danger::Dangerfile.new(env, testing_ui)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-mention
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 0.4.0
 platform: ruby
 authors:
 - Wojtek Lukaszuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-31 00:00:00.000000000 Z
+date: 2016-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger
@@ -66,6 +66,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
 description: Danger plugin to automatically mention potential reviewers on pull requests.
 email:
 - wojciech.lukaszuk@icloud.com
@@ -76,6 +132,7 @@ files:
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
@@ -105,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Danger plugin to automatically mention potential reviewers on pull requests.