errbit_plugin 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eccc791b162fd7dc93f1170175af0ff094838b95
-  data.tar.gz: dc0f6986b2d73726ebe6bed09febfeac3bdb9057
+  metadata.gz: 379974aa8a736ab97c68e86d35a8a4abe74cf078
+  data.tar.gz: 68538a72756d7286cab6603f2fd5ff0eaf853a9e
 SHA512:
-  metadata.gz: 4acc3fef4ec35e35b69e5d1cfb2dbc08516fc9bb80a0c36239fff9d11c56e27977278f8922f6e64a4e8e908992d358c38d2d55c8762d9e7078ce93ad4d130d8e
-  data.tar.gz: 27d7f74a0d6ae77c3cf2d077030938ca11186c264b57c0703b12fcd95362a337ab5a22a36693cc6dfe7547ed12207f0388dadf4efc6e5875f76de5fc437ef203
+  metadata.gz: 0946dc453bf1c7a0eb1ec1091edd135287e7734684fb3291b2e29241739fbaa321adedde1ba71f14b2d29a60c72a90b9d010fbea810475937136616970f7b232
+  data.tar.gz: 8487cad20bfe5f99001a0a3974424b4de1fea6a100336ff344bbe6fc72aa263d8e98c2c6d2dea9448fb4579b31f3484dc9ad9e6d522e87a64fb0cdd473e00b1c

data/README.md

@@ -1,4 +1,4 @@
-# ErrbitPlugin
+# ErrbitPlugin [![Build Status](https://travis-ci.org/errbit/errbit_plugin.svg?branch=master)](https://travis-ci.org/errbit/errbit_plugin)
 ErrbitPlugin provides a set of base classes that you can extend to create
 Errbit plugins.
 
@@ -38,22 +38,38 @@ class MyIssueTracker < ErrbitPlugin::IssueTracker
   # later when we have an instance of this class.
   def self.fields
     {
-      :field_one => {:label => 'Field One'},
-      :field_two => {:label => 'Field Two'}
+      username: {
+        placeholder: "Some placeholder text"
+      },
+      password: {
+        placeholder: "Some more placeholder text"
+      }
+    }
+  end
+
+  # Icons to display during user interactions with this issue tracker. This
+  # method should return a hash of two-tuples, the key names being 'create',
+  # 'goto', and 'inactive'. The two-tuples should contain the icon media type
+  # and the binary icon data.
+  def self.icons
+    @icons ||= {
+      create: [ 'image/png', File.read('./path/to/create.png') ],
+      goto: [ 'image/png', File.read('./path/to/goto.png') ],
+      inactive: [ 'image/png', File.read('./path/to/inactive.png') ],
     }
   end
 
   # If this tracker can be in a configured or non-configured state, you can let
   # errbit know by returning a Boolean here
   def configured?
-    # In this case, we'll say this issue tracker is configured when field_one
+    # In this case, we'll say this issue tracker is configured when username
     # is set
-    !!params['field_one']
+    !!params['username']
   end
 
   # Called to validate user input. Just return a hash of errors if there are
   # any
-  def check_params
+  def errors
     if @params['field_one']
       {}
     else
@@ -77,19 +93,10 @@ class MyIssueTracker < ErrbitPlugin::IssueTracker
   def url
     'http://some-remote-tracker.com'
   end
-
-  # If you return false here, errbit will not show the built-in error comment
-  # interface
-  def comments_allowed?
-    false
-  end
 end
 ```
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Discuss any changes you'd like to make with the authors on the mailing list, or
+by opening a github issue.

data/lib/errbit_plugin.rb

@@ -3,4 +3,3 @@ require "errbit_plugin/registry"
 require "errbit_plugin/issue_tracker"
 require "errbit_plugin/validate_issue_tracker"
 require "errbit_plugin/issue_trackers/none"
-require "errbit_plugin/rails"

data/lib/errbit_plugin/issue_tracker.rb

@@ -1,27 +1,10 @@
 module ErrbitPlugin
+  # abstract class for issue trackers
   class IssueTracker
-    attr_reader :app, :params
+    attr_reader :options
 
-    def initialize(app, params)
-      @app = app
-      @params = params
-    end
-
-    def pretty_hash(hash, nesting = 0)
-      tab_size = 2
-      nesting += 1
-
-      pretty  = "{"
-      sorted_keys = hash.keys.sort
-      sorted_keys.each do |key|
-        val = hash[key].is_a?(Hash) ? pretty_hash(hash[key], nesting) : hash[key].inspect
-        pretty += "\n#{' '*nesting*tab_size}"
-        pretty += "#{key.inspect} => #{val}"
-        pretty += "," unless key == sorted_keys.last
-
-      end
-      nesting -= 1
-      pretty += "\n#{' '*nesting*tab_size}}"
+    def initialize(options)
+      @options = options
     end
   end
 end

data/lib/errbit_plugin/issue_trackers/none.rb

@@ -6,14 +6,24 @@ module ErrbitPlugin
       '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 create_issue; true; end
     def url; ''; end
-    def comments_allowed?; true; end
+    def create_issue(*); true; end
   end
 end
 

data/lib/errbit_plugin/validate_issue_tracker.rb

@@ -7,9 +7,11 @@ module ErrbitPlugin
     attr_reader :errors
 
     def valid?
-      good_inherit? &&
-        implements_instance_methods? &&
-        implements_class_methods?
+      valid_inherit = good_inherit?
+      valid_instance_methods = implements_instance_methods?
+      valid_class_methods = implements_class_methods?
+
+      valid_inherit && valid_instance_methods && valid_class_methods
     end
 
     private
@@ -24,7 +26,7 @@ module ErrbitPlugin
     end
 
     def implements_instance_methods?
-      [:comments_allowed?, :configured?, :errors, :create_issue, :url].all? do |method|
+      impl = [:configured?, :errors, :create_issue, :url].map do |method|
         if instance.respond_to?(method)
           true
         else
@@ -32,10 +34,12 @@ module ErrbitPlugin
           false
         end
       end
+
+      impl.all? { |value| value == true }
     end
 
     def implements_class_methods?
-      [:label, :fields, :note].all? do |method|
+      impl = [:label, :fields, :note, :icons].map do |method|
         if @klass.respond_to?(method)
           true
         else
@@ -43,10 +47,12 @@ module ErrbitPlugin
           false
         end
       end
+
+      impl.all? { |value| value == true }
     end
 
     def instance
-      @instance ||= @klass.new(Object.new, {})
+      @instance ||= @klass.new({})
     end
 
     def add_errors(key, value=nil)

data/lib/errbit_plugin/version.rb

@@ -1,3 +1,3 @@
 module ErrbitPlugin
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/spec/errbit_plugin/validate_issue_tracker_spec.rb

@@ -4,216 +4,216 @@ describe ErrbitPlugin::ValidateIssueTracker do
   describe "#valid?" do
 
     context "with a complete class" do
-      class Foo < ErrbitPlugin::IssueTracker
+      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
-        def comments_allowed?; false; end
       end
 
       it 'valid' do
-        expect(ErrbitPlugin::ValidateIssueTracker.new(Foo).valid?).to be true
+        expect(ErrbitPlugin::ValidateIssueTracker.new(klass).valid?).to be true
       end
     end
 
     context "with class not inherit from ErrbitPlugin::IssueTracker" do
-
-      class Bar
+      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 url; 'http'; end
-        def comments_allowed?; false; end
       end
 
       it 'not valid' do
-        expect(ErrbitPlugin::ValidateIssueTracker.new(Bar).valid?).to be false
+        expect(ErrbitPlugin::ValidateIssueTracker.new(klass).valid?).to be false
       end
 
-      it 'say not implement configured?' do
-        is = ErrbitPlugin::ValidateIssueTracker.new(Bar)
+      it 'says :not_inherited' do
+        is = ErrbitPlugin::ValidateIssueTracker.new(klass)
         is.valid?
         expect(is.errors).to eql [[:not_inherited]]
       end
     end
 
     context "with no label method" do
-      class Baz < ErrbitPlugin::IssueTracker
-        def note; 'foo'; end
-        def fields; ['foo']; end
+      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 url; 'http'; end
-        def comments_allowed?; false; end
       end
 
       it 'not valid' do
-        expect(ErrbitPlugin::ValidateIssueTracker.new(Baz).valid?).to be false
+        expect(ErrbitPlugin::ValidateIssueTracker.new(klass).valid?).to be false
       end
 
       it 'say not implement configured?' do
-        is = ErrbitPlugin::ValidateIssueTracker.new(Baz)
+        is = ErrbitPlugin::ValidateIssueTracker.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 url; 'http'; end
+      end
+
+      it 'not valid' do
+        expect(ErrbitPlugin::ValidateIssueTracker.new(klass).valid?).to be false
+      end
+
+      it 'say not implement configured?' do
+        is = ErrbitPlugin::ValidateIssueTracker.new(klass)
+        is.valid?
+        expect(is.errors).to eql [[:class_method_missing, :icons]]
+      end
+    end
+
     context "without fields method" do
-      class BazFields < ErrbitPlugin::IssueTracker
+      klass = Class.new(ErrbitPlugin::IssueTracker) do
         def self.label; 'foo'; end
-        def note; '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 url; 'http'; end
-        def comments_allowed?; false; end
       end
 
       it 'not valid' do
-        expect(ErrbitPlugin::ValidateIssueTracker.new(BazFields).valid?).to be false
+        expect(ErrbitPlugin::ValidateIssueTracker.new(klass).valid?).to be false
       end
 
       it 'say not implement configured?' do
-        is = ErrbitPlugin::ValidateIssueTracker.new(BazFields)
+        is = ErrbitPlugin::ValidateIssueTracker.new(klass)
         is.valid?
         expect(is.errors).to eql [[:class_method_missing, :fields]]
       end
     end
 
     context "without configured? method" do
-      class BazConfigured < ErrbitPlugin::IssueTracker
-        def label; 'foo'; end
-        def note; 'foo'; end
-        def fields; ['foo']; end
+      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 url; 'http'; end
-        def comments_allowed?; false; end
       end
 
       it 'not valid' do
-        expect(ErrbitPlugin::ValidateIssueTracker.new(BazConfigured).valid?).to be false
+        expect(ErrbitPlugin::ValidateIssueTracker.new(klass).valid?).to be false
       end
 
       it 'say not implement configured?' do
-        is = ErrbitPlugin::ValidateIssueTracker.new(BazConfigured)
+        is = ErrbitPlugin::ValidateIssueTracker.new(klass)
         is.valid?
         expect(is.errors).to eql [[:instance_method_missing, :configured?]]
       end
     end
 
     context "without errors method" do
-      class BazCheckParams < ErrbitPlugin::IssueTracker
-        def label; 'foo'; end
-        def note; 'foo'; end
-        def fields; ['foo']; end
+      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 url; 'http'; end
-        def comments_allowed?; false; end
       end
 
       it 'not valid' do
-        expect(ErrbitPlugin::ValidateIssueTracker.new(BazCheckParams).valid?).to be false
+        expect(ErrbitPlugin::ValidateIssueTracker.new(klass).valid?).to be false
       end
 
       it 'say not implement errors' do
-        is = ErrbitPlugin::ValidateIssueTracker.new(BazCheckParams)
+        is = ErrbitPlugin::ValidateIssueTracker.new(klass)
         is.valid?
         expect(is.errors).to eql [[:instance_method_missing, :errors]]
       end
     end
 
     context "without create_issue method" do
-      class BazCreateIssue < ErrbitPlugin::IssueTracker
-        def label; 'foo'; end
-        def note; 'foo'; end
-        def fields; ['foo']; end
+      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 url; 'http'; end
-        def comments_allowed?; false; end
       end
 
       it 'not valid' do
-        expect(ErrbitPlugin::ValidateIssueTracker.new(BazCreateIssue).valid?).to be false
+        expect(ErrbitPlugin::ValidateIssueTracker.new(klass).valid?).to be false
       end
       it 'say not implement url' do
-        is = ErrbitPlugin::ValidateIssueTracker.new(BazCreateIssue)
+        is = ErrbitPlugin::ValidateIssueTracker.new(klass)
         is.valid?
         expect(is.errors).to eql [[:instance_method_missing, :create_issue]]
       end
     end
 
     context "without url method" do
-      class BazUrl < ErrbitPlugin::IssueTracker
-        def label; 'foo'; end
-        def note; 'foo'; end
-        def fields; ['foo']; end
+      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 comments_allowed?; false; end
       end
 
       it 'not valid' do
-        expect(ErrbitPlugin::ValidateIssueTracker.new(BazUrl).valid?).to be false
+        expect(ErrbitPlugin::ValidateIssueTracker.new(klass).valid?).to be false
       end
 
       it 'say not implement url' do
-        is = ErrbitPlugin::ValidateIssueTracker.new(BazUrl)
+        is = ErrbitPlugin::ValidateIssueTracker.new(klass)
         is.valid?
         expect(is.errors).to eql [[:instance_method_missing, :url]]
       end
     end
 
-    context "without comments_allowed? method" do
-      class BazComment < ErrbitPlugin::IssueTracker
-        def label; 'foo'; end
-        def note; 'foo'; end
-        def fields; ['foo']; end
-        def configured?; true; end
-        def errors; true; end
-        def create_issue; 'http'; end
-        def url; 'foo'; end
-      end
-
-      it 'not valid' do
-        expect(ErrbitPlugin::ValidateIssueTracker.new(BazComment).valid?).to be false
-      end
-
-      it 'say not implement comments_allowed?' do
-        is = ErrbitPlugin::ValidateIssueTracker.new(BazComment)
-        is.valid?
-        expect(is.errors).to eql [[:instance_method_missing, :comments_allowed?]]
-      end
-    end
-
     context "without note method" do
-      class BazNote < ErrbitPlugin::IssueTracker
+      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 url; 'foo'; end
-        def comments_allowed?; false; end
       end
 
       it 'not valid' do
-        expect(ErrbitPlugin::ValidateIssueTracker.new(BazNote).valid?).to be false
+        expect(ErrbitPlugin::ValidateIssueTracker.new(klass).valid?).to be false
       end
 
-      it 'say not implement comments_allowed?' do
-        is = ErrbitPlugin::ValidateIssueTracker.new(BazNote)
+      it 'say not implement note method' do
+        is = ErrbitPlugin::ValidateIssueTracker.new(klass)
         is.valid?
         expect(is.errors).to eql [[:class_method_missing, :note]]
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: errbit_plugin
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Stephen Crosby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-06 00:00:00.000000000 Z
+date: 2015-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,19 +57,17 @@ files:
 - errbit_plugin.gemspec
 - lib/errbit_plugin.rb
 - lib/errbit_plugin/issue_tracker.rb
-- lib/errbit_plugin/issue_trackers/fake.rb
 - lib/errbit_plugin/issue_trackers/none.rb
-- lib/errbit_plugin/rails.rb
 - lib/errbit_plugin/registry.rb
 - lib/errbit_plugin/validate_issue_tracker.rb
 - lib/errbit_plugin/version.rb
 - spec/errbit_plugin/registry_spec.rb
 - spec/errbit_plugin/validate_issue_tracker_spec.rb
 - spec/spec_helper.rb
-- vendor/assets/images/fake_create.png
-- vendor/assets/images/fake_inactive.png
-- vendor/assets/images/none_create.png
-- vendor/assets/images/none_inactive.png
+- static/fake_create.png
+- static/fake_inactive.png
+- static/none_create.png
+- static/none_inactive.png
 homepage: http://github.com/errbit/errbit
 licenses:
 - MIT

data/lib/errbit_plugin/issue_trackers/fake.rb

@@ -1,38 +0,0 @@
-module ErrbitPlugin
-  class FakeIssueTracker < IssueTracker
-    def self.label
-      'fake'
-    end
-
-    def self.note
-      'A fake issue tracker to help in testing purpose'
-    end
-
-    def self.fields
-      {
-        :foo => {:label => 'foo'},
-        :bar => {:label => 'bar'}
-      }
-    end
-
-    def configured?
-      !errors.any?
-    end
-
-    def errors
-      errors = {}
-      errors[:foo] = 'foo is required' unless params[:foo]
-      errors[:bar] = 'bar is required' unless params[:bar]
-
-      errors
-    end
-
-    def create_issue(problem, reported_by=nil); true; end
-
-    def url; ''; end
-
-    def comments_allowed?; false; end
-  end
-end
-
-ErrbitPlugin::Registry.add_issue_tracker(ErrbitPlugin::FakeIssueTracker)

data/lib/errbit_plugin/rails.rb

@@ -1,8 +0,0 @@
-if defined?(Rails)
-  module ErrbitPlugin
-    module Rails
-      class Engine < ::Rails::Engine
-      end
-    end
-  end
-end