errbit_plugin 0.5.0 → 0.7.0

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

data/spec/errbit_plugin/registry_spec.rb

@@ -1,6 +1,8 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe ErrbitPlugin::Registry do
+require "spec_helper"
+
+RSpec.describe ErrbitPlugin::Registry do
   before do
     ErrbitPlugin::Registry.clear_issue_trackers
   end
@@ -8,7 +10,7 @@ describe ErrbitPlugin::Registry do
   let(:tracker) {
     tracker = Class.new(ErrbitPlugin::IssueTracker) do
       def self.label
-        'something'
+        "something"
       end
     end
     tracker
@@ -17,19 +19,19 @@ describe ErrbitPlugin::Registry do
   describe ".add_issue_tracker" do
     context "with issue_tracker class valid" do
       before do
-        allow(ErrbitPlugin::ValidateIssueTracker)
+        allow(ErrbitPlugin::IssueTrackerValidator)
           .to receive(:new)
           .with(tracker)
-          .and_return(double(:valid? => true, :message => ''))
+          .and_return(double(valid?: true, message: ""))
       end
-      it 'add new issue_tracker plugin' do
+      it "add new issue_tracker plugin" do
         ErrbitPlugin::Registry.add_issue_tracker(tracker)
         expect(ErrbitPlugin::Registry.issue_trackers).to eq({
-          'something' => tracker
+          "something" => tracker
         })
       end
       context "with already issue_tracker with this key" do
-        it 'raise ErrbitPlugin::AlreadyRegisteredError' do
+        it "raise ErrbitPlugin::AlreadyRegisteredError" do
           ErrbitPlugin::Registry.add_issue_tracker(tracker)
           expect {
             ErrbitPlugin::Registry.add_issue_tracker(tracker)
@@ -39,26 +41,26 @@ describe ErrbitPlugin::Registry do
     end
 
     context "with an IssueTracker not valid" do
-      it 'raise an IncompatibilityError' do
-        allow(ErrbitPlugin::ValidateIssueTracker)
+      it "raise an IncompatibilityError" do
+        allow(ErrbitPlugin::IssueTrackerValidator)
           .to receive(:new)
           .with(tracker)
-          .and_return(double(:valid? => false, :message => 'foo', :errors => []))
+          .and_return(double(valid?: false, message: "foo", errors: []))
         expect {
           ErrbitPlugin::Registry.add_issue_tracker(tracker)
         }.to raise_error(ErrbitPlugin::IncompatibilityError)
       end
 
-      it 'puts the errors in the exception message' do
-        allow(ErrbitPlugin::ValidateIssueTracker)
+      it "puts the errors in the exception message" do
+        allow(ErrbitPlugin::IssueTrackerValidator)
           .to receive(:new)
           .with(tracker)
-          .and_return(double(:valid? => false, :message => 'foo', :errors => ['one', 'two']))
+          .and_return(double(valid?: false, message: "foo", errors: ["one", "two"]))
 
         begin
           ErrbitPlugin::Registry.add_issue_tracker(tracker)
         rescue ErrbitPlugin::IncompatibilityError => e
-          expect(e.message).to eq('one; two')
+          expect(e.message).to eq("one; two")
         end
       end
     end

data/spec/spec_helper.rb

@@ -1,26 +1,25 @@
-if ENV['COVERAGE']
-  require 'simplecov'
-  if ENV['CI']
-    require 'coveralls'
-    Coveralls.wear!
-    SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-      SimpleCov::Formatter::HTMLFormatter,
-      Coveralls::SimpleCov::Formatter
-    ]
-  end
+# frozen_string_literal: true
+
+require "simplecov"
+
+SimpleCov.start do
+  enable_coverage :branch
+
+  primary_coverage :branch
 
-  SimpleCov.start
+  add_filter "spec/"
 end
 
-require 'errbit_plugin'
+require "errbit_plugin"
 
 RSpec.configure do |config|
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = 'random'
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
 end