danger-mcbrain 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9fc65e256688e5324be20fbcb3c18e0ccac02a7d
+  data.tar.gz: 7eba9555ac6808713bf835190677cc4233cacce9
+SHA512:
+  metadata.gz: 79f1328db481008823a07faaefd3a392eae5a8244b32a1975e1a2eef4c8583e1f74da7b5197df31da8ebbd35eb3eea6e2891e41ffb71b5f84fce71ef4f49d3b4
+  data.tar.gz: 68a80c1553a3d8c82a88ad1936ac6672d50375ae740ca7dec0922ef9124c797501cf430ec9806e1cb7dd52dbcf7a22d2b9227d700ff8fc116ff54723e7baf5e4

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+.bundle/
+pkg
+.idea/
+vendor/

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/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,129 @@
+PATH
+  remote: .
+  specs:
+    danger-mcbrain (0.0.1)
+      danger (~> 2.0)
+      redis (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    ast (2.3.0)
+    claide (1.0.0)
+    claide-plugins (0.9.1)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.1)
+    colored (1.2)
+    cork (0.1.0)
+      colored (~> 1.2)
+    danger (2.0.1)
+      claide (~> 1.0)
+      claide-plugins (> 0.9.0)
+      colored (~> 1.2)
+      cork (~> 0.1)
+      faraday (~> 0)
+      faraday-http-cache (~> 1.0)
+      git (~> 1)
+      octokit (~> 4.2)
+      redcarpet (~> 3.3)
+      terminal-table (~> 1)
+    diff-lcs (1.2.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (1.3.0)
+      faraday (~> 0.8)
+    ffi (1.9.14)
+    formatador (0.2.5)
+    git (1.3.0)
+    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)
+    listen (3.0.7)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.0.10)
+    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.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)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    redcarpet (3.3.4)
+    redis (3.3.1)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.2)
+      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.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
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  danger-mcbrain!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  listen (= 3.0.7)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.4)
+  rubocop (~> 0.41)
+  yard (~> 0.8)
+
+BUNDLED WITH
+   1.12.5

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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 David Grandinetti <dbgrandi@yahoo-inc.com>
+
+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,47 @@
+# danger-mcbrain
+
+Give Danger a memory, so she can check your PR today, and then answer questions about it tomorrow. Uses Redis for the persistence.
+
+## Installation
+
+    $ gem install danger-mcbrain
+
+## Usage
+
+    Methods and attributes from this plugin are available in
+    your `Dangerfile` under the `brain` namespace.
+
+    You need to connect Danger's `brain` to a redis instance by
+    calling `brain.connect` somewhere in your `Dangerfile`. You
+    can pass any arguments into `connect` that you would normally
+    pass directly into `Redis.new`. You can read more about that
+    in their [Getting Started](https://github.com/redis/redis-rb#getting-started)
+    guide.
+
+    After you have connected, `brain` acts quite like a regular old
+    Ruby Hash, so you can use the `[]` operator and `[]=` operator to
+    get or set key/value pairs.
+
+    You can set a `namespace` on the `brain` if needed. This can be handy
+    in cases where you want to share a redis instance across multiple projecs
+    or repositories.
+
+    e.g.
+
+    ```ruby
+    brain.namespace = "dbgrandi/danger-prose"
+
+    last_build_time = brain[last_pr + ":build_time"]
+
+    if last_build_time > build_time
+      warn "Your build time is getting longer. #{last_pr}: #{last_build_time} -> #{pr}: #{build_time}"
+    end
+    ```
+
+## Development
+
+1. Clone this repo
+2. Run `bundle install` to setup dependencies.
+3. Run `bundle exec rake spec` to run the tests.
+4. Use `bundle exec guard` to automatically have tests run as you make changes.
+5. Make your changes.

data/Rakefile

@@ -0,0 +1,23 @@
+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-mcbrain.gemspec

@@ -0,0 +1,48 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mcbrain/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-mcbrain'
+  spec.version       = McBrain::VERSION
+  spec.authors       = ['David Grandinetti']
+  spec.email         = ['dbgrandi@yahoo-inc.com']
+  spec.description   = %q{Give Danger some persistent memory.}
+  spec.summary       = %q{Give Danger a redis backed key/value store, so you can extend Danger rules beyond just this PR.}
+  spec.homepage      = 'https://github.com/dbgrandi/danger-mcbrain'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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', '~>2.0'
+  spec.add_runtime_dependency 'redis', '~>3.0'
+
+  # 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'
+
+  # 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'
+
+  # 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 test
+  # 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_mcbrain.rb

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

data/lib/danger_plugin.rb

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

data/lib/mcbrain/gem_version.rb

@@ -0,0 +1,3 @@
+module McBrain
+  VERSION = '0.0.1'.freeze
+end

data/lib/mcbrain/plugin.rb

@@ -0,0 +1,69 @@
+require 'redis'
+
+module Danger
+  # Let's give Danger the ability to remember things in between runs. By
+  # connecting her up to Redis, we have a simple key/value store where
+  # we can keep stats and evaluate over time. This could be useful for
+  # tracking the number of tests, author stats, or whatever else you want
+  # to be able to ask Danger questions about the next time she checks your PR.
+  #
+  # @example Keep track of code coverage trends
+  #
+  #          last_cov = brain[:pr-1923][:code_cov_percent]
+  #          if last_cov > code_cov
+  #            warn "Coverage went from #{last_cov} to #{code_cov}"
+  #          end
+  #          brain[:pr-1924] = { :code_cov_percent => code_cov }
+  #
+  # @see  https://github.com/dbgrandi/danger-mcbrain
+  # @tags persistance
+  #
+  class DangerMcBrain < Plugin
+    def self.instance_name
+      'brain'
+    end
+
+    # An attribute that contains a string that will be used
+    # to prefix keys. If this is not set, a namespace prefix
+    # will be created based on some info from the Dangerfile.
+    # To set a globally available key, set this to "".
+    #
+    # @return [String]
+    attr_accessor :namespace
+
+    # Call from your Dangerfile *before* using DangerBrain to connect to
+    # a redis server. May throw a `Redis::CannotConnectError` if unable
+    # to connect. Any `options` you pass into this will be passed directly
+    # to the `Redis` client.
+    #
+    def connect(options = {})
+      @redis = Redis.new(options)
+      @redis.client.connect
+    end
+
+    # Use to get a value out of DangerBrain. If you have set a namespace
+    # it will be prefixed to your key with a `:`. Returns the value
+    # associated with that key, or nil if it does not exist.
+    #
+    # @return [Object]
+    def [](key)
+      @redis[real_key(key)]
+    end
+
+    # Use to se a value in DangerBrain. If you have set a namespace, it
+    # will be prefixed to your key with a ':'. Returns the value that
+    # was passed in.
+    #
+    # @return [Object]
+    def []=(key, value)
+      @redis[real_key(key)] = value
+    end
+
+    private
+
+    def real_key(key)
+      return key if @namespace.nil? || namespace.empty?
+      @namespace + ':' + key
+    end
+  end
+end

data/spec/mcbrain_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+module Danger
+  describe Danger::DangerMcBrain do
+    it 'should be a plugin' do
+      expect(Danger::DangerMcBrain.new(nil)).to be_a Danger::Plugin
+    end
+
+    #
+    # You should test your custom attributes and methods here
+    #
+    describe 'with Dangerfile' do
+      before do
+        @dangerfile = testing_dangerfile
+        @brain = @dangerfile.brain
+      end
+
+      it 'should default to a nil namespace' do
+        expect(@brain.namespace).to be_nil
+      end
+
+      it 'should not use a namespace when it is nil' do
+        @brain.namespace = ''
+        expect(@brain.send(:real_key, 'asdf')).to eql('asdf')
+      end
+
+      it 'should not use a namespace when it is an empty string' do
+        @brain.namespace = ''
+        expect(@brain.send(:real_key, 'asdf')).to eql('asdf')
+      end
+
+      it 'should use namespace as a prefix when available' do
+        @brain.namespace = 'pants'
+        expect(@brain.send(:real_key, 'asdf')).to eql('pants:asdf')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,59 @@
+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|
+  config.filter_gems_from_backtrace 'bundler'
+  config.color = true
+  config.tty = true
+end
+
+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
+  @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' => '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)
+end

metadata

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification
+name: danger-mcbrain
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Grandinetti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Give Danger some persistent memory.
+email:
+- dbgrandi@yahoo-inc.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-mcbrain.gemspec
+- lib/danger_mcbrain.rb
+- lib/danger_plugin.rb
+- lib/mcbrain/gem_version.rb
+- lib/mcbrain/plugin.rb
+- spec/mcbrain_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dbgrandi/danger-mcbrain
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Give Danger a redis backed key/value store, so you can extend Danger rules
+  beyond just this PR.
+test_files:
+- spec/mcbrain_spec.rb
+- spec/spec_helper.rb