errbit_plugin 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0da88b0c10182c8a6cdcd9027d600a3149dc2e29
-  data.tar.gz: 0ebd3654aff4015119a467f1db58967f3f5c70b4
+SHA256:
+  metadata.gz: c5d3bdf7d5dc59bf8a59721802488f859c956892cb1763f7d2958be6aa753a8f
+  data.tar.gz: 34bf05aba892110c124d2aea3d6e8807c36c21fe14037a7f1a61e6e48aa936aa
 SHA512:
-  metadata.gz: 67de6652286cec7dc1f78c2496235a2f10460786e7327c0900b66bef4d394d567d216de034df19757a0c7892e06547a51b655424350742b36a2bd0a249423a52
-  data.tar.gz: c33bc5ac88fe5707687e63c8ee7aaba80c90a361d0d6e9bdba064cbf26c1cde1e9862ab3b6ec9a570ca763dfc2fda0f876a6aa93043b67f5c6ca113d07f003e7
+  metadata.gz: c5a36c6b08ae920dc2b13515ed1fa7d69ed44a3e1edbdb766954da0b728b3bd4f9ddb184fa078fe8d481ed31b66d138b62253ab6126b49864eafb6dd0c28500d
+  data.tar.gz: caa502d7596676de1641139734549b612f3b391e381bfcb9d7ca3638c0b2196c506ab68445625400162e6c3ea314558873bfb38564176b3aa4ab0ea93d15055f

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+--order random

data/.rubocop.yml

@@ -0,0 +1,377 @@
+plugins:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-disable_syntax
+
+AllCops:
+  TargetRubyVersion: 4.0
+  NewCops: enable
+
+# We use standard as a linter and formatter instead Rubocop.
+# Also, we are explicitly disable all rubocop rules what
+# already enabled in standard. And standard-performance.
+
+# Standard rules. Style:
+
+# Enforced by standard. Disable.
+Style/StringLiterals:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/HashSyntax:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/NestedParenthesizedCalls:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/RedundantRegexpArgument:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/RedundantBegin:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/SuperWithArgsParentheses:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/Encoding:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/NumericLiteralPrefix:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/RedundantParentheses:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/EmptyMethod:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/SingleLineMethods:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/SafeNavigation:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/RescueStandardError:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/RedundantSelf:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/TernaryParentheses:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/RedundantLineContinuation:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/SlicingWithRange:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/MultilineIfModifier:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/RedundantCondition:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/RedundantInterpolation:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/OrAssignment:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/ConditionalAssignment:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/ItAssignment:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/EachWithObject:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/GlobalStdStream:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+# Disabled as in standard.
+Style/HashAsLastArrayItem:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Style/Alias:
+  Enabled: false
+
+# Standard rules. Layout:
+
+# Enforced by standard. Disable.
+Layout/HashAlignment:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/FirstArrayElementIndentation:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/SpaceInsideStringInterpolation:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/DotPosition:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/ExtraSpacing:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/ArgumentAlignment:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/AccessModifierIndentation:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/IndentationWidth:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/ElseAlignment:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/EndAlignment:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/MultilineHashBraceLayout:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/EmptyLineBetweenDefs:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/MultilineArrayBraceLayout:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/EmptyLineAfterMagicComment:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/ArrayAlignment:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/AssignmentIndentation:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/ClosingParenthesisIndentation:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/LineLength:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Layout/CaseIndentation:
+  Enabled: false
+
+# Standard rules. Lint:
+
+# Enforced by standard. Disable.
+Lint/ImplicitStringConcatenation:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Lint/TripleQuotes:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Lint/IneffectiveAccessModifier:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Lint/SymbolConversion:
+  Enabled: false
+
+# Enforced by rubocop and standard
+Lint/CopDirectiveSyntax:
+  Enabled: true
+
+# Enforced by standard. Disable.
+Lint/DuplicateMethods:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
+
+# Enforced by standard. Disable.
+Lint/UselessTimes:
+  Enabled: false
+
+# Standard-performance rules.
+
+# Enforced by standard-performance. Disable.
+Performance/Detect:
+  Enabled: false
+
+# Enforced by standard-performance. Disable.
+Performance/StringIdentifierArgument:
+  Enabled: false
+
+# Enforced by standard-performance. Disable.
+Performance/RegexpMatch:
+  Enabled: false
+
+# Always enable rubocop Security:
+
+# Enforced by rubocop and standard
+Security/JSONLoad:
+  Enabled: true
+
+# Our rubocop rules
+
+# Bundler rules.
+
+Bundler/OrderedGems:
+  Enabled: false
+
+# Gemspec rules
+
+Gemspec/OrderedDependencies:
+  Enabled: false
+
+# Style rules
+
+# Don't allow %i[foo bar baz]
+Style/SymbolArray:
+  Enabled: true
+  EnforcedStyle: brackets
+
+# Don't allow %w[foo bar baz]
+Style/WordArray:
+  Enabled: true
+  EnforcedStyle: brackets
+
+# Disable warnings like "Missing top-level documentation comment for"
+Style/Documentation:
+  Enabled: false
+
+# Disable as in standard.
+Style/ArgumentsForwarding:
+  Enabled: false
+
+# RSpec rules
+
+# Prefer eq over be.
+RSpec/BeEq:
+  Enabled: false
+
+# Prefer eq over eql.
+RSpec/BeEql:
+  Enabled: false
+
+# We prefer to use `expect` over `allow`.
+RSpec/StubbedMock:
+  Enabled: false
+
+# We prefer multiple before blocks in tests.
+RSpec/ScatteredSetup:
+  Enabled: false
+
+# We use `expect` in before hooks.
+RSpec/ExpectInHook:
+  Enabled: false
+
+# We use item_1, item_2, etc. Disable.
+RSpec/IndexedLet:
+  Enabled: false
+
+# We don't use named subject's
+RSpec/NamedSubject:
+  Enabled: false
+
+# Ignore example length
+RSpec/ExampleLength:
+  Enabled: false
+
+# Ignore maximum example group nesting
+RSpec/NestedGroups:
+  Enabled: false
+
+# Ignore subject after let declarations
+RSpec/LeadingSubject:
+  Enabled: false
+
+# Naming rules:
+
+# Disable anonymous block forwarding.
+Naming/BlockForwarding:
+  Enabled: true
+  EnforcedStyle: explicit
+
+# Enable and exclude specific files.
+Naming/FileName:
+  Enabled: true
+
+# Disabled syntax:
+
+# Disable shorthand hash syntax like: ({ x:, y: })
+# Disable % style literals
+Style/DisableSyntax:
+  DisableSyntax:
+    - shorthand_hash_syntax
+    - percent_literals

data/.ruby-version

@@ -0,0 +1 @@
+4.0.5

data/.standard.yml

@@ -0,0 +1 @@
+ruby_version: 4.0

data/README.md

@@ -1,42 +1,49 @@
-# 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)
+[![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
+
+Errbit plugins 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.
 
 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. 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.
+Errbit to an issue in an external issue tracker like GitHub. An app within
+Errbit can be associated with 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. 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:
+`ErrbitPlugin::IssueTracker`. All the required methods must be implemented and
+the class must extend `ErrbitPlugin::IssueTracker`. Here's an example:
+
 ```ruby
 class MyIssueTracker < ErrbitPlugin::IssueTracker
 
-  # A unique label for your tracker plugin used internally by errbit
+  # A unique label for your tracker plugin used internally by Errbit
   def self.label
-    'my-tracker'
+    "my-tracker"
   end
 
   def self.note
-    'a note about this tracker that users will see'
+    "a note about this tracker that users will see"
   end
 
   # Form fields that will be presented to the administrator when setting up
-  # or editing the errbit app. The values we collect will be availble for use
+  # or editing the Errbit app. The values we collect will be available for use
   # later when we have an instance of this class.
   def self.fields
     {
@@ -56,14 +63,14 @@ class MyIssueTracker < ErrbitPlugin::IssueTracker
   # 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') ],
+      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
+  # Errbit know by returning a Boolean here
   def configured?
     # In this case, we'll say this issue tracker is configured when username
     # and password are set
@@ -76,7 +83,7 @@ class MyIssueTracker < ErrbitPlugin::IssueTracker
     if options[:username]
       {}
     else
-      { field_one: 'username must be present' }
+      { field_one: "username must be present" }
     end
   end
 
@@ -88,7 +95,7 @@ class MyIssueTracker < ErrbitPlugin::IssueTracker
   def create_issue(title, body, user: {})
     # Create an issue! Then update the problem to link it.
 
-    'http://sometracker.com/my/issue/123'
+    "https://sometracker.com/my/issue/123"
   end
 
   # This method is optional. Errbit will create body text for your issue by
@@ -100,10 +107,10 @@ class MyIssueTracker < ErrbitPlugin::IssueTracker
   # 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
+  # @see https://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]]
+    ["/path/to/some/template", formats: [:rdoc]]
   end
 
   # This method is optional, and is where you actually go close the issue on
@@ -117,14 +124,12 @@ class MyIssueTracker < ErrbitPlugin::IssueTracker
 
   # The URL for your remote issue tracker
   def url
-    'http://some-remote-tracker.com'
+    "https://some-remote-tracker.com"
   end
 end
 ```
 
-
-
 ## Contributing
 
 Discuss any changes you'd like to make with the authors on the mailing list, or
-by opening a github issue.
+by opening a GitHub issue.

data/Rakefile

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

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
 
@@ -35,7 +37,7 @@ module ErrbitPlugin
         end
       end
 
-      impl.all? { |value| value == true }
+      impl.all?(true)
     end
 
     def implements_class_methods?
@@ -48,14 +50,14 @@ module ErrbitPlugin
         end
       end
 
-      impl.all? { |value| value == true }
+      impl.all?(true)
     end
 
     def instance
       @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(*) # rubocop:disable Naming/PredicateMethod
+      false
+    end
+
+    def close_issue(*) # rubocop:disable Naming/PredicateMethod
+      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
@@ -8,17 +11,17 @@ module ErrbitPlugin
     def self.add_issue_tracker(klass)
       key = klass.label
 
-      if issue_trackers.has_key?(key)
+      if issue_trackers.key?(key)
         raise AlreadyRegisteredError,
           "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.8.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"

metadata

@@ -1,43 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: errbit_plugin
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Stephen Crosby
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-26 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
 description: Base to create an errbit plugin
 email:
 - stevecrozz@gmail.com
@@ -45,34 +16,32 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
-- ".gitignore"
-- ".travis.yml"
-- Gemfile
-- Guardfile
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".standard.yml"
 - LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
-- errbit_plugin.gemspec
 - lib/errbit_plugin.rb
 - lib/errbit_plugin/issue_tracker.rb
-- lib/errbit_plugin/issue_trackers/none.rb
+- lib/errbit_plugin/issue_tracker_validator.rb
+- lib/errbit_plugin/none_issue_tracker.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
 - static/fake_create.png
 - static/fake_inactive.png
 - static/none_create.png
 - static/none_inactive.png
-homepage: http://github.com/errbit/errbit
+homepage: https://github.com/errbit/errbit_plugin
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/errbit/errbit_plugin
+  source_code_uri: https://github.com/errbit/errbit_plugin
+  bug_tracker_uri: https://github.com/errbit/errbit_plugin/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -80,20 +49,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 4.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 4.0.13
 specification_version: 4
 summary: Base to create an errbit plugin
-test_files:
-- spec/errbit_plugin/registry_spec.rb
-- spec/errbit_plugin/validate_issue_tracker_spec.rb
-- spec/spec_helper.rb
-has_rdoc: 
+test_files: []

data/.coveralls.yml

@@ -1,2 +0,0 @@
-service_name: travis-pro
-repo_token: gNB8KeAdYQKNW2YC4uut6Zh2ToBnPyMqB

data/.gitignore

@@ -1,23 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.ruby-version
-
-# YARD artifacts
-.yardoc
-_yardoc
-doc/

data/.travis.yml

@@ -1,15 +0,0 @@
-language: ruby
-env:
-    - COVERAGE=true
-before_install:
-  - gem install bundler
-script: bundle exec rspec spec
-rvm:
-  - 2.1
-  - 2.2
-  - 2.3.0
-  - rbx-2
-  - ruby-head
-matrix:
-  allow_failures:
-    - rvm: ruby-head

data/Gemfile

@@ -1,9 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in errbit_plugin.gemspec
-gemspec
-
-gem 'rspec'
-gem 'guard'
-gem 'guard-rspec'
-gem 'coveralls', :require => false

data/Guardfile

@@ -1,8 +0,0 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard 'rspec' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-end

data/errbit_plugin.gemspec

@@ -1,23 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require '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.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.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-end

data/lib/errbit_plugin/issue_trackers/none.rb

@@ -1,31 +0,0 @@
-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/spec/errbit_plugin/registry_spec.rb

@@ -1,66 +0,0 @@
-require 'spec_helper'
-
-describe ErrbitPlugin::Registry do
-  before do
-    ErrbitPlugin::Registry.clear_issue_trackers
-  end
-
-  let(:tracker) {
-    tracker = Class.new(ErrbitPlugin::IssueTracker) do
-      def self.label
-        'something'
-      end
-    end
-    tracker
-  }
-
-  describe ".add_issue_tracker" do
-    context "with issue_tracker class valid" do
-      before do
-        allow(ErrbitPlugin::ValidateIssueTracker)
-          .to receive(:new)
-          .with(tracker)
-          .and_return(double(:valid? => true, :message => ''))
-      end
-      it 'add new issue_tracker plugin' do
-        ErrbitPlugin::Registry.add_issue_tracker(tracker)
-        expect(ErrbitPlugin::Registry.issue_trackers).to eq({
-          'something' => tracker
-        })
-      end
-      context "with already issue_tracker with this key" do
-        it 'raise ErrbitPlugin::AlreadyRegisteredError' do
-          ErrbitPlugin::Registry.add_issue_tracker(tracker)
-          expect {
-            ErrbitPlugin::Registry.add_issue_tracker(tracker)
-          }.to raise_error(ErrbitPlugin::AlreadyRegisteredError)
-        end
-      end
-    end
-
-    context "with an IssueTracker not valid" do
-      it 'raise an IncompatibilityError' do
-        allow(ErrbitPlugin::ValidateIssueTracker)
-          .to receive(:new)
-          .with(tracker)
-          .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)
-          .to receive(:new)
-          .with(tracker)
-          .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')
-        end
-      end
-    end
-  end
-end

data/spec/errbit_plugin/validate_issue_tracker_spec.rb

@@ -1,255 +0,0 @@
-require 'spec_helper'
-
-describe ErrbitPlugin::ValidateIssueTracker 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::ValidateIssueTracker.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::ValidateIssueTracker.new(klass).valid?).to be false
-      end
-
-      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
-      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::ValidateIssueTracker.new(klass).valid?).to be false
-      end
-
-      it 'say not implement label method' do
-        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 close_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 icons method' do
-        is = ErrbitPlugin::ValidateIssueTracker.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::ValidateIssueTracker.new(klass).valid?).to be false
-      end
-
-      it 'say not implement fields method' do
-        is = ErrbitPlugin::ValidateIssueTracker.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::ValidateIssueTracker.new(klass).valid?).to be false
-      end
-
-      it 'say not implement configured? method' do
-        is = ErrbitPlugin::ValidateIssueTracker.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::ValidateIssueTracker.new(klass).valid?).to be false
-      end
-
-      it 'say not implement errors method' do
-        is = ErrbitPlugin::ValidateIssueTracker.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::ValidateIssueTracker.new(klass).valid?).to be false
-      end
-      it 'say not implement create_issue method' do
-        is = ErrbitPlugin::ValidateIssueTracker.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::ValidateIssueTracker.new(klass).valid?).to be true
-      end
-      it 'not say not implement close_issue method' do
-        is = ErrbitPlugin::ValidateIssueTracker.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::ValidateIssueTracker.new(klass).valid?).to be false
-      end
-
-      it 'say not implement url method' do
-        is = ErrbitPlugin::ValidateIssueTracker.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::ValidateIssueTracker.new(klass).valid?).to be false
-      end
-
-      it 'say not implement note method' do
-        is = ErrbitPlugin::ValidateIssueTracker.new(klass)
-        is.valid?
-        expect(is.errors).to eql [[:class_method_missing, :note]]
-      end
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,26 +0,0 @@
-if ENV['COVERAGE']
-  require 'simplecov'
-  if ENV['CI']
-    require 'coveralls'
-    Coveralls.wear!
-    SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-      SimpleCov::Formatter::HTMLFormatter,
-      Coveralls::SimpleCov::Formatter
-    ]
-  end
-
-  SimpleCov.start
-end
-
-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'
-end