errbit_plugin 0.5.0 → 0.7.0

data/README.md

@@ -1,8 +1,14 @@
-# ErrbitPlugin [![Build Status](https://travis-ci.org/errbit/errbit_plugin.svg?branch=master)](https://travis-ci.org/errbit/errbit_plugin)
+# ErrbitPlugin
+
+[![RSpec](https://github.com/errbit/errbit_plugin/actions/workflows/rspec.yml/badge.svg)](https://github.com/errbit/errbit_plugin/actions/workflows/rspec.yml)
+[![RSpec on JRuby](https://github.com/errbit/errbit_plugin/actions/workflows/jruby.yml/badge.svg)](https://github.com/errbit/errbit_plugin/actions/workflows/jruby.yml)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/standardrb/standard)
+
 ErrbitPlugin provides a set of base classes that you can extend to create
 Errbit plugins.
 
 ## Creating plugins
+
 ErrbitPlugins are Ruby gems that extend the functionality of Errbit. To get
 started, create a Ruby gem and add 'errbit_plugin' as a dependency in your
 gem's gemspec.
@@ -11,16 +17,20 @@ Now you can start adding plugins. At the moment, there is only one kind of
 plugin you can create, and that is the issue tracker.
 
 ### Issue Trackers
+
 An issue tracker plugin is a Ruby class that enables you to link errors within
 errbit to an issue in an external issue tracker like Github. An app within
 errbit can be associated an issue tracker or not. When there is an association,
 errbit users can choose 'create issue' from an error page which will both
 create an issue on the external issue tracker out of the given error and link
-that issue to the errbit error.
+that issue to the errbit error. Likewise, a user can also choose 'close issue'
+to close the issue on the external issue tracker, if your plugin provides a 
+method to do so.
 
 Your issue tracker plugin is responsible for providing the interface defined by
 ErrbitPlugin::IssueTracker. All of the required methods must be implemented and
 the class must extend ErrbitPlugin::IssueTracker. Here's an example:
+
 ```ruby
 class MyIssueTracker < ErrbitPlugin::IssueTracker
 
@@ -42,7 +52,8 @@ class MyIssueTracker < ErrbitPlugin::IssueTracker
         placeholder: "Some placeholder text"
       },
       password: {
-        placeholder: "Some more placeholder text"
+        placeholder: "Some more placeholder text",
+        label: "Passphrase" # a label to use in the UI instead of 'password'
       }
     }
   end
@@ -63,30 +74,53 @@ class MyIssueTracker < ErrbitPlugin::IssueTracker
   # errbit know by returning a Boolean here
   def configured?
     # In this case, we'll say this issue tracker is configured when username
-    # is set
-    !!params['username']
+    # and password are set
+    options[:username].present? && options[:password].present?
   end
 
   # Called to validate user input. Just return a hash of errors if there are
   # any
   def errors
-    if @params['field_one']
+    if options[:username]
       {}
     else
-      { :field_one, 'Field One must be present' }
+      { field_one: 'username must be present' }
     end
   end
 
   # This is where you actually go create the issue on the external issue
-  # tracker. You get access to everything in params, a problem resource and a
-  # user resource (reported_by). Once you've created an external issue, save
-  # its type and url on the problem resource.
-  def create_issue(problem, reported_by = nil)
+  # tracker. You get access to everything in options, an issue title, body and
+  # a user record representing the user who's creating the issue.
+  #
+  # Return a string with a link to the issue
+  def create_issue(title, body, user: {})
     # Create an issue! Then update the problem to link it.
-    problem.update_attributes(
-      :issue_type => 'bug',
-      :issue_link => 'http://some-remote-tracker.com/mynewissue'
-    )
+
+    'http://sometracker.com/my/issue/123'
+  end
+
+  # This method is optional. Errbit will create body text for your issue by
+  # calling render_to_string with some arguments. If you want control over
+  # those arguments, you can specify them here. You can control which file is
+  # rendered and anything else Rails allows you to specify as arguments in
+  # render_to_string.
+  #
+  # If you don't implement this method, Errbit will render a body using a
+  # default template
+  #
+  # @see http://apidock.com/rails/ActionController/Base/render_to_string
+  def render_body_args
+    # In this example, we want to render a special file
+    ['/path/to/some/template', formats: [:rdoc]]
+  end
+
+  # This method is optional, and is where you actually go close the issue on
+  # the external issue tracker. You get access to everything in options, a
+  # string with a link to the issue # and a user resource.
+  #
+  # return true if successful, false otherwise
+  def close_issue(issue_link, user = {})
+    # Close the issue! (Perhaps using the passed in issue_link url to identify it.)
   end
 
   # The URL for your remote issue tracker

data/Rakefile

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"

data/errbit_plugin.gemspec

@@ -1,23 +1,25 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'errbit_plugin/version'
+# frozen_string_literal: true
+
+require_relative "lib/errbit_plugin/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "errbit_plugin"
-  spec.version       = ErrbitPlugin::VERSION
-  spec.authors       = ["Stephen Crosby"]
-  spec.email         = ["stevecrozz@gmail.com"]
-  spec.description   = %q{Base to create an errbit plugin}
-  spec.summary       = %q{Base to create an errbit plugin}
-  spec.homepage      = "http://github.com/errbit/errbit"
-  spec.license       = "MIT"
+  spec.name = "errbit_plugin"
+  spec.version = ErrbitPlugin::VERSION
+  spec.authors = ["Stephen Crosby"]
+  spec.email = ["stevecrozz@gmail.com"]
 
-  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.summary = "Base to create an errbit plugin"
+  spec.description = "Base to create an errbit plugin"
+  spec.homepage = "https://github.com/errbit/errbit_plugin"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 end

data/lib/errbit_plugin/issue_tracker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ErrbitPlugin
   # abstract class for issue trackers
   class IssueTracker

data/lib/errbit_plugin/{validate_issue_tracker.rb → issue_tracker_validator.rb}

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module ErrbitPlugin
-  class ValidateIssueTracker
+  class IssueTrackerValidator
     def initialize(klass)
       @klass = klass
       @errors = []
@@ -17,11 +19,11 @@ module ErrbitPlugin
     private
 
     def good_inherit?
-      unless @klass.ancestors.include?(ErrbitPlugin::IssueTracker)
+      if @klass.ancestors.include?(ErrbitPlugin::IssueTracker)
+        true
+      else
         add_errors(:not_inherited)
         false
-      else
-        true
       end
     end
 
@@ -55,7 +57,7 @@ module ErrbitPlugin
       @instance ||= @klass.new({})
     end
 
-    def add_errors(key, value=nil)
+    def add_errors(key, value = nil)
       @errors << [key, value].compact
     end
   end

data/lib/errbit_plugin/none_issue_tracker.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module ErrbitPlugin
+  class NoneIssueTracker < IssueTracker
+    def self.label
+      "none"
+    end
+
+    def self.note
+      "When no issue tracker has been configured, you will be able to " \
+        "leave comments on errors."
+    end
+
+    def self.fields
+      {}
+    end
+
+    def self.icons
+      @icons ||= {
+        create: ["image/png", read_static_file("none_create.png")],
+        goto: ["image/png", read_static_file("none_create.png")],
+        inactive: ["image/png", read_static_file("none_inactive.png")]
+      }
+    end
+
+    def self.read_static_file(file)
+      File.read(File.expand_path(File.join(
+        File.dirname(__FILE__), "..", "..", "static", file
+      )))
+    end
+
+    ##
+    # The NoneIssueTracker is mark like configured? false because it not valid
+    # like a real IssueTracker
+    def configured?
+      false
+    end
+
+    def errors
+      {}
+    end
+
+    def url
+      ""
+    end
+
+    def create_issue(*)
+      false
+    end
+
+    def close_issue(*)
+      false
+    end
+  end
+end
+
+ErrbitPlugin::Registry.add_issue_tracker(ErrbitPlugin::NoneIssueTracker)

data/lib/errbit_plugin/registry.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module ErrbitPlugin
   class IncompatibilityError < StandardError; end
+
   class AlreadyRegisteredError < StandardError; end
 
   module Registry
@@ -13,12 +16,12 @@ module ErrbitPlugin
           "issue_tracker '#{key}' already registered"
       end
 
-      validate = ValidateIssueTracker.new(klass)
+      validator = IssueTrackerValidator.new(klass)
 
-      if validate.valid?
+      if validator.valid?
         @issue_trackers[key] = klass
       else
-        raise IncompatibilityError.new(validate.errors.join('; '))
+        raise IncompatibilityError.new(validator.errors.join("; "))
       end
     end
 

data/lib/errbit_plugin/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ErrbitPlugin
-  VERSION = "0.5.0"
+  VERSION = "0.7.0"
 end

data/lib/errbit_plugin.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require "errbit_plugin/version"
 require "errbit_plugin/registry"
 require "errbit_plugin/issue_tracker"
-require "errbit_plugin/validate_issue_tracker"
-require "errbit_plugin/issue_trackers/none"
+require "errbit_plugin/issue_tracker_validator"
+require "errbit_plugin/none_issue_tracker"