errbit_plugin 0.6.0 → 0.7.0

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.6.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"

data/spec/errbit_plugin/issue_tracker_validator_spec.rb

@@ -0,0 +1,517 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe ErrbitPlugin::IssueTrackerValidator do
+  describe "#valid?" do
+    context "with a complete class" do
+      klass = Class.new(ErrbitPlugin::IssueTracker) do
+        def self.label
+          "foo"
+        end
+
+        def self.note
+          "foo"
+        end
+
+        def self.fields
+          ["foo"]
+        end
+
+        def self.icons
+          {}
+        end
+
+        def configured?
+          true
+        end
+
+        def errors
+          true
+        end
+
+        def create_issue
+          "http"
+        end
+
+        def close_issue
+          "http"
+        end
+
+        def url
+          "http"
+        end
+      end
+
+      it "valid" do
+        expect(ErrbitPlugin::IssueTrackerValidator.new(klass).valid?).to be true
+      end
+    end
+
+    context "with class not inherit from ErrbitPlugin::IssueTracker" do
+      klass = Class.new do
+        def self.label
+          "foo"
+        end
+
+        def self.note
+          "foo"
+        end
+
+        def self.fields
+          ["foo"]
+        end
+
+        def self.icons
+          {}
+        end
+
+        def initialize(params)
+        end
+
+        def configured?
+          true
+        end
+
+        def errors
+          true
+        end
+
+        def create_issue
+          "http"
+        end
+
+        def close_issue
+          "http"
+        end
+
+        def url
+          "http"
+        end
+      end
+
+      it "not valid" do
+        expect(ErrbitPlugin::IssueTrackerValidator.new(klass).valid?).to be false
+      end
+
+      it "says :not_inherited" do
+        is = ErrbitPlugin::IssueTrackerValidator.new(klass)
+        is.valid?
+        expect(is.errors).to eql [[:not_inherited]]
+      end
+    end
+
+    context "with no label method" do
+      klass = Class.new(ErrbitPlugin::IssueTracker) do
+        def self.note
+          "foo"
+        end
+
+        def self.fields
+          ["foo"]
+        end
+
+        def self.icons
+          {}
+        end
+
+        def configured?
+          true
+        end
+
+        def errors
+          true
+        end
+
+        def create_issue
+          "http"
+        end
+
+        def close_issue
+          "http"
+        end
+
+        def url
+          "http"
+        end
+      end
+
+      it "not valid" do
+        expect(ErrbitPlugin::IssueTrackerValidator.new(klass).valid?).to be false
+      end
+
+      it "say not implement label method" do
+        is = ErrbitPlugin::IssueTrackerValidator.new(klass)
+        is.valid?
+        expect(is.errors).to eql [[:class_method_missing, :label]]
+      end
+    end
+
+    context "with no icons method" do
+      klass = Class.new(ErrbitPlugin::IssueTracker) do
+        def self.note
+          "foo"
+        end
+
+        def self.fields
+          ["foo"]
+        end
+
+        def self.label
+          "alabel"
+        end
+
+        def configured?
+          true
+        end
+
+        def errors
+          true
+        end
+
+        def create_issue
+          "http"
+        end
+
+        def close_issue
+          "http"
+        end
+
+        def url
+          "http"
+        end
+      end
+
+      it "not valid" do
+        expect(ErrbitPlugin::IssueTrackerValidator.new(klass).valid?).to be false
+      end
+
+      it "say not implement icons method" do
+        is = ErrbitPlugin::IssueTrackerValidator.new(klass)
+        is.valid?
+        expect(is.errors).to eql [[:class_method_missing, :icons]]
+      end
+    end
+
+    context "without fields method" do
+      klass = Class.new(ErrbitPlugin::IssueTracker) do
+        def self.label
+          "foo"
+        end
+
+        def self.note
+          "foo"
+        end
+
+        def self.icons
+          {}
+        end
+
+        def configured?
+          true
+        end
+
+        def errors
+          true
+        end
+
+        def create_issue
+          "http"
+        end
+
+        def close_issue
+          "http"
+        end
+
+        def url
+          "http"
+        end
+      end
+
+      it "not valid" do
+        expect(ErrbitPlugin::IssueTrackerValidator.new(klass).valid?).to be false
+      end
+
+      it "say not implement fields method" do
+        is = ErrbitPlugin::IssueTrackerValidator.new(klass)
+        is.valid?
+        expect(is.errors).to eql [[:class_method_missing, :fields]]
+      end
+    end
+
+    context "without configured? method" do
+      klass = Class.new(ErrbitPlugin::IssueTracker) do
+        def self.label
+          "foo"
+        end
+
+        def self.note
+          "foo"
+        end
+
+        def self.fields
+          ["foo"]
+        end
+
+        def self.icons
+          {}
+        end
+
+        def errors
+          true
+        end
+
+        def create_issue
+          "http"
+        end
+
+        def close_issue
+          "http"
+        end
+
+        def url
+          "http"
+        end
+      end
+
+      it "not valid" do
+        expect(ErrbitPlugin::IssueTrackerValidator.new(klass).valid?).to be false
+      end
+
+      it "say not implement configured? method" do
+        is = ErrbitPlugin::IssueTrackerValidator.new(klass)
+        is.valid?
+        expect(is.errors).to eql [[:instance_method_missing, :configured?]]
+      end
+    end
+
+    context "without errors method" do
+      klass = Class.new(ErrbitPlugin::IssueTracker) do
+        def self.label
+          "foo"
+        end
+
+        def self.note
+          "foo"
+        end
+
+        def self.fields
+          ["foo"]
+        end
+
+        def self.icons
+          {}
+        end
+
+        def configured?
+          true
+        end
+
+        def create_issue
+          "http"
+        end
+
+        def close_issue
+          "http"
+        end
+
+        def url
+          "http"
+        end
+      end
+
+      it "not valid" do
+        expect(ErrbitPlugin::IssueTrackerValidator.new(klass).valid?).to be false
+      end
+
+      it "say not implement errors method" do
+        is = ErrbitPlugin::IssueTrackerValidator.new(klass)
+        is.valid?
+        expect(is.errors).to eql [[:instance_method_missing, :errors]]
+      end
+    end
+
+    context "without create_issue method" do
+      klass = Class.new(ErrbitPlugin::IssueTracker) do
+        def self.label
+          "foo"
+        end
+
+        def self.note
+          "foo"
+        end
+
+        def self.fields
+          ["foo"]
+        end
+
+        def self.icons
+          {}
+        end
+
+        def configured?
+          true
+        end
+
+        def errors
+          true
+        end
+
+        def close_issue
+          "http"
+        end
+
+        def url
+          "http"
+        end
+      end
+
+      it "not valid" do
+        expect(ErrbitPlugin::IssueTrackerValidator.new(klass).valid?).to be false
+      end
+      it "say not implement create_issue method" do
+        is = ErrbitPlugin::IssueTrackerValidator.new(klass)
+        is.valid?
+        expect(is.errors).to eql [[:instance_method_missing, :create_issue]]
+      end
+    end
+
+    context "without close_issue method" do
+      # this is an optional method
+      klass = Class.new(ErrbitPlugin::IssueTracker) do
+        def self.label
+          "foo"
+        end
+
+        def self.note
+          "foo"
+        end
+
+        def self.fields
+          ["foo"]
+        end
+
+        def self.icons
+          {}
+        end
+
+        def configured?
+          true
+        end
+
+        def errors
+          true
+        end
+
+        def create_issue
+          "http"
+        end
+
+        def url
+          "http"
+        end
+      end
+
+      it "is valid" do
+        expect(ErrbitPlugin::IssueTrackerValidator.new(klass).valid?).to be true
+      end
+      it "not say not implement close_issue method" do
+        is = ErrbitPlugin::IssueTrackerValidator.new(klass)
+        is.valid?
+        expect(is.errors).not_to eql [[:instance_method_missing, :close_issue]]
+      end
+    end
+
+    context "without url method" do
+      klass = Class.new(ErrbitPlugin::IssueTracker) do
+        def self.label
+          "foo"
+        end
+
+        def self.note
+          "foo"
+        end
+
+        def self.fields
+          ["foo"]
+        end
+
+        def self.icons
+          {}
+        end
+
+        def configured?
+          true
+        end
+
+        def errors
+          true
+        end
+
+        def create_issue
+          "http"
+        end
+
+        def close_issue
+          "http"
+        end
+      end
+
+      it "not valid" do
+        expect(ErrbitPlugin::IssueTrackerValidator.new(klass).valid?).to be false
+      end
+
+      it "say not implement url method" do
+        is = ErrbitPlugin::IssueTrackerValidator.new(klass)
+        is.valid?
+        expect(is.errors).to eql [[:instance_method_missing, :url]]
+      end
+    end
+
+    context "without note method" do
+      klass = Class.new(ErrbitPlugin::IssueTracker) do
+        def self.label
+          "foo"
+        end
+
+        def self.fields
+          ["foo"]
+        end
+
+        def self.icons
+          {}
+        end
+
+        def configured?
+          true
+        end
+
+        def errors
+          true
+        end
+
+        def create_issue
+          "http"
+        end
+
+        def close_issue
+          "http"
+        end
+
+        def url
+          "foo"
+        end
+      end
+
+      it "not valid" do
+        expect(ErrbitPlugin::IssueTrackerValidator.new(klass).valid?).to be false
+      end
+
+      it "say not implement note method" do
+        is = ErrbitPlugin::IssueTrackerValidator.new(klass)
+        is.valid?
+        expect(is.errors).to eql [[:class_method_missing, :note]]
+      end
+    end
+  end
+end

data/spec/errbit_plugin/none_issue_tracker_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe ErrbitPlugin::NoneIssueTracker do
+  let(:options) { {} }
+
+  subject { described_class.new(options) }
+
+  it { expect(subject).to be_an(ErrbitPlugin::IssueTracker) }
+
+  it { expect(subject.configured?).to eq(false) }
+
+  it { expect(subject.errors).to eq({}) }
+
+  it { expect(subject.url).to eq("") }
+
+  it { expect(subject.create_issue).to eq(false) }
+
+  it { expect(subject.close_issue).to eq(false) }
+
+  it { expect(described_class.label).to eq("none") }
+
+  it { expect(described_class.note).to start_with("When no issue tracker") }
+
+  it { expect(described_class.fields).to eq({}) }
+
+  it { expect(described_class.icons).not_to be_empty }
+
+  # TODO: .read_static_file
+end