pronto-labelman 0.0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22681cfb1887260e20a097422950d62fe8707e7e
+  data.tar.gz: 7f9559f96e49afbbff8db650b991c1a81a3f3de8
+SHA512:
+  metadata.gz: 6b8f196ecb227b5946d64dbb150ddc54d596fc014dee5cc77ba8fbb2024efd87e18bbda05fe685272803af601acc1a2095a30c90936707b1909ce98e698d78ad
+  data.tar.gz: 819e392b94ce3fae701686a7ddb26de9fc78852502347ab4d56317ebf4eb37450b507c8fe77f371d4c29ee277a16b174139f04ed42a602c4c197b661363d8d17

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2017 Amiel Perez
+
+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,88 @@
+## Pronto-Labelman
+
+![pronto-labelman-icon](https://cloud.githubusercontent.com/assets/5194847/23691790/a88578d0-0405-11e7-9492-0ac8ec32d545.png)
+
+### Pronto runner for automatically adding labels to Github Pull Requests.
+
+### Use Case
+* You want to automate decision-making and addition of labels to Github PR's, e.g., if a PR contains .HTML files, automatically tag it for Design review.
+* You are already using [pronto](https://github.com/mmozuras/pronto) with Github
+
+### How it Works
+Simple, really. It acts as a pronto runner, giving it visibility over the payload of a pull request. It then tries to find classes that are 1. under the namespace `Pronto::LabelmanRules` and 2.) extend the `Pronto::LabelmanRules::Rule` class.
+
+These rule classes, which are to be implemented by users of this gem, will be responsible for inspecting the pull request payload and deciding whether to associate it with a particular label (more on this later).
+
+### Prerequisites
+* Properly-configured `pronto` environment
+
+### Installation
+
+Install the gem
+```
+gem install pronto-labelman
+```
+
+Invoke from pronto. Set `github_pr_label` as formatter (`-f`) and `labelman` as runner (`-r`)
+
+```bash
+pronto run -f github_pr_label -c $BASE_BRANCH_SHA -r labelman
+```
+If you want to specify a temporary path where to look for rules, use the `LABELMAN_RULES` environment variable
+
+```bash
+export LABELMAN_RULES=path/to/custom/pronto/labelman_rules
+pronto run -f github_pr_label -c $BASE_BRANCH_SHA -r labelman
+```
+
+### Creating Rules
+1. Subclass `Pronto::LabelmanRules::Rule`. Make sure your subclass is in the namespace `Pronto::LabelmanRules`
+
+```ruby
+module Pronto
+  module LabelmanRules
+    class MyCustomRule < Rule
+    end
+  end
+end
+```
+
+2. Define a label using the `label` class method. This should match the name of the label that will be applied
+
+```ruby
+module Pronto
+  module LabelmanRules
+    class MyCustomRule < Rule
+      label 'Needs Code Review'
+    end
+  end
+end
+```
+
+3. Implement the `applicable?` method. It should return a boolean signifying whether the label must be applied or not. You have access to the `@patches` attribute, signifying the changes
+
+```ruby
+module Pronto
+  module LabelmanRules
+    class MyCustomRule < Rule
+      label 'Needs Code Review'
+      
+      def applicable?
+        # Apply a label if the patches is not empty.
+        # Simple, dumb rule, yes, but it's just for purposes of illustration
+        true unless @patches.empty?
+      end
+    end
+  end
+end
+```
+
+4. Make sure this class is in the load path or use the `LABELMAN_RULES` environment to tell Labelman where to find it
+
+```
+export LABELMAN_RULES=custom/pronto/labelman_rules
+```
+
+### Todo List
+* Improve "monkey patching"
+* More configuration

data/lib/pronto/formatter/github_pr_label_formatter.rb

@@ -0,0 +1,13 @@
+module Pronto
+  module Formatter
+    class GithubPRLabelFormatter
+      def format(labels, repo, _)
+        build_client(repo).add_labels_to_issue(labels.map(&:name))
+      end
+
+      def build_client(repo)
+        Github.new(repo)
+      end
+    end
+  end
+end

data/lib/pronto/label.rb

@@ -0,0 +1,9 @@
+module Pronto
+  class Label
+    attr_accessor :name
+
+    def initialize(name)
+      @name = name
+    end
+  end
+end

data/lib/pronto/labelman/version.rb

@@ -0,0 +1,5 @@
+module Pronto
+  module LabelmanVersion
+    VERSION = '0.0.2.1'
+  end
+end

data/lib/pronto/labelman.rb

@@ -0,0 +1,56 @@
+require 'pronto/monkey_patches/formatter'
+require 'pronto/monkey_patches/github'
+require 'pronto/label'
+require 'pronto/labelman_rules/rule'
+
+module Pronto
+  class Labelman < Runner
+    def initialize(patches, commit = nil)
+      super
+
+      @rules_load_path = ENV['LABELMAN_RULES']
+      if @rules_load_path
+        p "Using additional rules load path #{File.absolute_path("#{__dir__}/bin")}"
+        require_and_load_rules
+      end
+    end
+
+    def run
+      return [] unless @patches
+      rule_classes = get_all_rule_implems
+      if rule_classes.empty?
+        p "There are no rule implementations found. Additional load path specified: #{@rules_load_path || '<NONE>'}"
+        return []
+      end
+
+      rule_classes.map do |rule_class|
+        p "Applying rule #{rule_class.name}"
+        [rule_class.new(@patches).apply]
+      end.compact
+    end
+
+    private
+
+    def is_frontend_file?(patch)
+      File.extname(patch.new_file_full_path) =~ /\.(s*(c|a)ss|j(s|st\.ejs)|coffee)$/
+    end
+
+    def require_and_load_rules
+      Dir["#{@rules_load_path}/*.rb"].each do |file|
+        require file
+        load file
+      end
+    end
+
+    def get_all_rule_implems
+      ns = Pronto::LabelmanRules
+      ns.constants.map do |c|
+        probable_class = ns.const_get(c)
+        if probable_class.is_a?(Class) &&
+          probable_class != Pronto::LabelmanRules::Rule
+          probable_class
+        end
+      end.compact
+    end
+  end
+end

data/lib/pronto/labelman_rules/rule.rb

@@ -0,0 +1,22 @@
+module Pronto
+  module LabelmanRules
+    class Rule
+      def initialize(patches)
+        @patches = patches
+      end
+
+      def self.label(name)
+        define_method('label_name') { name }
+      end
+
+      def apply
+        Pronto::Label.new(label_name) if applicable?
+      end
+
+      def applicable?
+        # implement me!
+        false
+      end
+    end
+  end
+end

data/lib/pronto/monkey_patches/formatter.rb

@@ -0,0 +1,11 @@
+require 'pronto/formatter/github_pr_label_formatter'
+
+module Pronto
+  module Formatter
+    old_formatters = FORMATTERS
+    remove_const(:FORMATTERS)
+    FORMATTERS = old_formatters.merge(
+      'github_pr_label' => GithubPRLabelFormatter
+    )
+  end
+end

data/lib/pronto/monkey_patches/github.rb

@@ -0,0 +1,7 @@
+module Pronto
+  class Github
+    def add_labels_to_issue(labels)
+      client.add_labels_to_an_issue(slug, pull_id, labels)
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: pronto-labelman
+version: !ruby/object:Gem::Version
+  version: 0.0.2.1
+platform: ruby
+authors:
+- Amiel Perez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-15 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Pronto runner for that labels PRs automatically based on rules
+email: perezamiel@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/pronto/formatter/github_pr_label_formatter.rb
+- lib/pronto/label.rb
+- lib/pronto/labelman.rb
+- lib/pronto/labelman/version.rb
+- lib/pronto/labelman_rules/rule.rb
+- lib/pronto/monkey_patches/formatter.rb
+- lib/pronto/monkey_patches/github.rb
+homepage: http://github.org/amielperez/pronto-labelman
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Pronto runner for that labels PRs automatically based on rules
+test_files: []