danger-clubhouse 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef1035b0495aaba41c126c302c14cd336884189c
+  data.tar.gz: 79378bbb8e1aea86a0b13684f865321db471398f
+SHA512:
+  metadata.gz: fc9871612ff18e7e07bd881332a2c3838072b3f72712b55890ad1128cc447de9be5411ddd04fb19f4ecf000c49537b9d59d19f0a34d952ea7bb8fd4a45978d76
+  data.tar.gz: eb89b5aab6c59eef97449e10489af8ce82996b830b9651692334625d57b26d7ab966e2775de403f410456b93087a0035b6e9064ab308aff9ecff96c01ed8bb6c

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+pkg
+.idea/
+Gemfile.lock
+.yardoc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=documentation

data/.rubocop.yml

@@ -0,0 +1,7 @@
+AllCops:
+  Include:
+    - Rakefile
+  Exclude:
+    - vendor/**/*
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,44 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-11-21 18:59:46 -0500 using RuboCop version 0.43.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 19
+
+# Offense count: 40
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 254
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 14
+
+# Offense count: 1
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/changelog/plugin.rb'
+
+# Offense count: 3
+Style/DoubleNegation:
+  Exclude:
+    - 'lib/changelog/changelog_file.rb'
+
+# Offense count: 2
+# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist.
+# NamePrefix: is_, has_, have_
+# NamePrefixBlacklist: is_, has_, have_
+# NameWhitelist: is_a?
+Style/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/changelog/plugin.rb'

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.3.1
+
+before_script:
+    - bundle exec danger
+
+script:
+    - bundle exec rake spec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

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 Teng Siong Ong <siong1987@gmail.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,31 @@
+# danger-clubhouse
+
+A pull request plugin to [danger.systems](http://danger.systems) that
+links to stories from [Clubhouse](https://app.clubhouse.io).
+
+## Installation
+
+Add `danger-clubhouse` to your Gemfile.
+
+```
+gem 'danger-clubhouse'
+```
+
+## Usage
+
+### clubhouse.organization
+
+Set the orgazination name for Clubhouse.
+
+### clubhouse.link_stories!
+
+Find stories in the format of chXXX from commits and branch name and
+link to them.
+
+![](images/have_you_updated_changelog.png)
+
+## Copyright
+
+Copyright (c) Teng Siong Ong, 2016
+
+MIT License, see [LICENSE](LICENSE.txt) for details.

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: [:rubocop, :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-clubhouse.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clubhouse/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-clubhouse'
+  spec.version       = Clubhouse::VERSION
+  spec.authors       = ['siong1987']
+  spec.email         = ['siong1987@gmail.com']
+  spec.description   = 'A danger.systems plugin that links to your clubhouse stories.'
+  spec.summary       = 'A danger.systems plugin that links to your clubhouse stories.'
+  spec.homepage      = 'https://github.com/siong1987/danger-clubhouse'
+  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 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rubocop', '~> 0.41'
+  spec.add_development_dependency 'yard', '~> 0.8'
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'listen', '3.0.7'
+  spec.add_development_dependency 'pry', '~> 0.10'
+end

data/lib/clubhouse/gem_version.rb

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

data/lib/clubhouse/plugin.rb

@@ -0,0 +1,80 @@
+module Danger
+  # This is your plugin class. Any attributes or methods you expose here will
+  # be available from within your Dangerfile.
+  #
+  # To be published on the Danger plugins site, you will need to have
+  # the public interface documented. Danger uses [YARD](http://yardoc.org/)
+  # for generating documentation from your plugin source, and you can verify
+  # by running `danger plugins lint` or `bundle exec rake spec`.
+  #
+  # You should replace these comments with a public description of your library.
+  #
+  # @example Ensure people are well warned about merging on Mondays
+  #
+  #          my_plugin.warn_on_mondays
+  #
+  # @see  Teng Siong Ong/danger-clubhouse
+  # @tags monday, weekends, time, rattata
+  #
+  # This plugin will detect stories from clubhouse and link to them.
+  #
+  # @example Customize the clubhouse organization and check for stories to link to them.
+  #
+  #          clubhouse.organization = 'organization'
+  #          clubhouse.link_stories!
+  #
+  # @see  siong1987/danger-clubhouse
+  # @tags clubhouse
+  class DangerClubhouse < Plugin
+    # The clubhouse organization name, you must set this!
+    #
+    # @return   [String]
+    attr_accessor :organization
+
+    # Check the branch and commit messages to find clubhouse stories to link to.
+    #
+    # @return [void]
+    def link_stories!
+      clubhouse_story_ids = []
+
+      # Check for the branch
+      if (story_id = find_story_id(github.branch_for_head))
+        clubhouse_story_ids << story_id
+      end
+
+      # Check all the commit messages
+      messages.each do |message|
+        if (story_id = find_story_id(message))
+          clubhouse_story_ids << story_id
+        end
+      end
+
+      post!(clubhouse_story_ids) unless clubhouse_story_ids.empty?
+    end
+
+    # Find clubhouse story id in the body
+    #
+    # @return [String, nil]
+    def find_story_id(body)
+      if (match = body.match(/ch(\d+)/))
+        return match[1]
+      end
+
+      nil
+    end
+
+    private
+
+    def post!(story_ids)
+      message = "### Clubhouse stories\n\n"
+      story_ids.each do |id|
+        message << "* [https://app.clubhouse.io/#{organization}/stories/#{id}](https://app.clubhouse.io/#{organization}/stories/#{id}) \n"
+      end
+      markdown message
+    end
+
+    def messages
+      git.commits.map(&:message)
+    end
+  end
+end

data/lib/danger_clubhouse.rb

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

data/lib/danger_plugin.rb

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

data/spec/clubhouse_spec.rb

@@ -0,0 +1,107 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+module Danger
+  describe Danger::DangerClubhouse do
+    it 'should be a plugin' do
+      expect(Danger::DangerClubhouse.new(nil)).to be_a Danger::Plugin
+    end
+
+    #
+    # You should test your custom attributes and methods here
+    #
+    describe 'with Dangerfile' do
+      let(:dangerfile) { testing_dangerfile }
+      let(:clubhouse) do
+        dangerfile.clubhouse.organization = 'organization'
+        dangerfile.clubhouse
+      end
+      let(:status_report) { clubhouse.status_report }
+
+      context 'link_stories!' do
+        let(:branch) { 'new_branch' }
+        let(:body) { 'new body' }
+
+        subject do
+          clubhouse.link_stories!
+        end
+
+        before do
+          commit = double(:commit, message: body)
+          allow(clubhouse.git).to receive(:commits).and_return([commit])
+
+          allow(clubhouse.github).to receive(:branch_for_head).and_return(branch)
+        end
+
+        context 'in commit' do
+          context 'with story id' do
+            let(:body) { 'This is cool [ch345]' }
+
+            it 'links the story' do
+              subject
+
+              expect(status_report[:markdowns].map(&:message)).to eq [
+                "### Clubhouse stories\n\n* [https://app.clubhouse.io/organization/stories/345](https://app.clubhouse.io/organization/stories/345) \n"
+              ]
+            end
+          end
+
+          context 'without story id' do
+            let(:body) { 'This is cool' }
+
+            it 'links to no stories' do
+              subject
+
+              expect(status_report[:markdowns].map(&:message)).to eq []
+            end
+          end
+        end
+
+        context 'in branch' do
+          context 'with story id' do
+            let(:branch) { 'siong/ch345/cool-fix' }
+
+            it 'links the story' do
+              subject
+
+              expect(status_report[:markdowns].map(&:message)).to eq [
+                "### Clubhouse stories\n\n* [https://app.clubhouse.io/organization/stories/345](https://app.clubhouse.io/organization/stories/345) \n"
+              ]
+            end
+          end
+
+          context 'without story id' do
+            let(:branch) { 'siong/cool-fix' }
+
+            it 'links to no stories' do
+              subject
+
+              expect(status_report[:markdowns].map(&:message)).to eq []
+            end
+          end
+        end
+      end
+
+      context 'find_story_id' do
+        subject do
+          clubhouse.find_story_id(body)
+        end
+
+        context 'with proper story id in body' do
+          let(:body) { 'This is cool [ch345]' }
+
+          it 'finds the story id' do
+            expect(subject).to eq('345')
+          end
+        end
+
+        context 'without story id in body' do
+          let(:body) { 'This is cool' }
+
+          it 'returns nil' do
+            expect(subject).to eq(nil)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+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'
+
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace 'bundler'
+  config.color = true
+  config.tty = true
+end
+
+require 'danger_plugin'
+
+def testing_ui
+  Cork::Board.new(silent: true)
+end
+
+def testing_env
+  {
+    'HAS_JOSH_K_SEAL_OF_APPROVAL' => 'true',
+    'TRAVIS_PULL_REQUEST' => '800',
+    'TRAVIS_REPO_SLUG' => 'siong1987/danger-clubhouse',
+    '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,203 @@
+--- !ruby/object:Gem::Specification
+name: danger-clubhouse
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- siong1987
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: A danger.systems plugin that links to your clubhouse stories.
+email:
+- siong1987@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-clubhouse.gemspec
+- lib/clubhouse/gem_version.rb
+- lib/clubhouse/plugin.rb
+- lib/danger_clubhouse.rb
+- lib/danger_plugin.rb
+- spec/clubhouse_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/siong1987/danger-clubhouse
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A danger.systems plugin that links to your clubhouse stories.
+test_files:
+- spec/clubhouse_spec.rb
+- spec/spec_helper.rb