pronto-commentator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 565081e14422215f0f4f0f491575d51f726bf6aa
+  data.tar.gz: c7b7dc603202b7747d15def4bfac39a92454d7e1
+SHA512:
+  metadata.gz: 93a8334864aee8f83fe9f56034bfb624081915007598e01a426428e7c2740dddb45507304b3cc3877b5921bdec8c38fd1d83b01ad5e262a44736daef417ae08e
+  data.tar.gz: c043749154e243595636c7d9b27a85318e8aee6c97b394d4f50b486378723b1a18aa1ecb5fe9fa6f09e1485ddd1437f46a11de25406197492ffc43df798af6b5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  rf-stylez: ruby/rubocop.yml

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pronto-commentator.gemspec
+gemspec
+
+gem 'rf-stylez'
+gem 'rspec_junit_formatter'

data/Guardfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  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

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Rainforest QA, Inc.
+
+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,41 @@
+# Pronto Commentator [![Circle CI](https://circleci.com/gh/rainforestapp/pronto-commentator.svg?style=svg)](https://circleci.com/gh/rainforestapp/pronto-commentator)
+
+Pronto Commentator a very simple runner for
+[Pronto](https://github.com/mozuras/pronto) that outputs arbitrary comments
+based on filename matching. It's good for tagging specific people to review
+specific kinds of changes (for instance, tagging your security team if
+auth-related files change), and probably other things as well.
+
+## Configuration
+
+The main configuration file should be located at `.commentator/config.yml` in
+your repo root. Pronto Commentator won't do anything unless the config file is
+present. The configuration is pretty simple: it needs a root `files` key,
+followed by associations of filename patterns to message file names. Here's an
+example:
+
+```yaml
+files:
+  app/lib/auth*.rb:
+    ping_bob.md
+  "doc/chapters/[1-3].txt":
+    ping_real_writers.md
+```
+
+The file names should point to files in the `.commentator` directory. For
+example, `.commentator/ping_bob.md` could look something like this:
+
+```
+@bob looks like someone's trying to change the auth logic again, better take a
+look!
+```
+
+(Files don't have to be Markdown, but if you're using Github it's kinda nice).
+
+File name matching uses
+[Glob syntax](http://ruby-doc.org/core-2.3.0/Dir.html#method-c-glob).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/rainforestapp/pronto-commentator.

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pronto/commentator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pronto/commentator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+require 'pronto'
+require 'yaml'
+
+module Pronto
+  class Commentator < Runner
+    class ConfigError < StandardError; end
+
+    CONFIG_DIR = '.commentator'
+
+    def run
+      return [] unless config && file_patches
+      return ConfigError, "Commentator config does not contain the 'files' key" unless config['files'].is_a? Hash
+
+      file_patches.flat_map do |patch|
+        config.fetch('files').map do |pattern, msg_file|
+          if File.fnmatch? pattern, patch.delta.new_file[:path], File::FNM_PATHNAME
+            new_message patch, msg_file
+          end
+        end.compact
+      end
+    end
+
+    private
+
+    def file_patches
+      @file_patches ||=
+        @patches.select { |patch| patch.additions > 0 }
+        .uniq(&:new_file_full_path)
+    end
+
+    def new_message(patch, msg_file)
+      msg = File.read File.join(CONFIG_DIR, msg_file)
+
+      Message.new(patch.delta.new_file[:path], patch.added_lines.first, :info, msg)
+    rescue Errno::ENOENT
+      raise ConfigError, "#{msg_file} does not exist in the commentator config dir."
+    end
+
+    def repo_path
+      file_patches.first.repo.path
+    end
+
+    def config
+      conf_file = File.join CONFIG_DIR, 'config.yml'
+
+      @config ||= YAML.load(File.read(conf_file))
+    rescue Errno::ENOENT
+      nil
+    end
+  end
+end

data/lib/pronto/commentator/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Pronto
+  module CommentatorVersion
+    VERSION = '0.1.0'
+  end
+end

data/pronto-commentator.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pronto/commentator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pronto-commentator'
+  spec.version       = Pronto::CommentatorVersion::VERSION
+  spec.authors       = ['Emanuel Evans']
+  spec.email         = ['emanuel@rainforestqa.com']
+
+  spec.summary       = 'A simple code review tool for Pronto.'
+  spec.description   = <<-EOS
+    A simple runner for Pronto that adds pre-defined comments based on which files have changed.
+  EOS
+  spec.homepage      = 'https://github.com/rainforestapp/pronto-commentator'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'pronto', '~> 0.6.0'
+
+  spec.add_development_dependency 'bundler', '>= 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'guard-rspec', '~> 4.6.5'
+  spec.add_development_dependency 'awesome_print'
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: pronto-commentator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emanuel Evans
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pronto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.5
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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: "    A simple runner for Pronto that adds pre-defined comments based
+  on which files have changed.\n"
+email:
+- emanuel@rainforestqa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pronto/commentator.rb
+- lib/pronto/commentator/version.rb
+- pronto-commentator.gemspec
+homepage: https://github.com/rainforestapp/pronto-commentator
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A simple code review tool for Pronto.
+test_files: []