Skip to content

Commit

Permalink
Rename to errbit-ng-plugin (#2)
Browse files Browse the repository at this point in the history
* Update LICENSE

* Update LICENSE

* Update gemspec authors and email

* Update LICENSE

* LICENSE -> LICENSE.txt

* Update Contributing and add License

* Update example

* Remove coveralls gem

* Remove .coveralls.yml config

* Update LICENSE.txt

* Update Rakefile

* Rename: errbit_plugin -> errbit-ng-plugin

* Add standard config

* frozen_string_literal -> true

* Add rspec config

* Cleanup

* frozen_string_literal -> true

* Rename lib/errbit_plugin/issue_trackers/none.rb -> lib/errbit_plugin/none_issue_tracker.rb

* Update rspec configuration

* Cleanup

* Cleanup

* Add .rspec_status to .gitignore

* Update .gitignore

* Add simplecov gem

* Fix

* Enable simpecov

* Add simplecov-cobertura

* Configure CI

* Refactoring

* Add codecov coverage

* Cleanup

* Cleanup

* Cleanup

* Fix

* Cleanup

* Ruby 3.4
  • Loading branch information
biow0lf authored Jan 31, 2025
1 parent 82e6dbf commit 70dc14a
Show file tree
Hide file tree
Showing 25 changed files with 204 additions and 165 deletions.
2 changes: 0 additions & 2 deletions .coveralls.yml

This file was deleted.

3 changes: 3 additions & 0 deletions .github/workflows/jruby.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ on:
- cron: "0 21 * * 6"

env:
CI: "yes"
JRUBY_OPTS: "--debug"

jobs:
Expand Down Expand Up @@ -39,3 +40,5 @@ jobs:
bundler: latest
bundler-cache: true
- run: bundle exec rspec
- name: Upload coverage to Codecov
uses: codecov/codecov-action@13ce06bfc6bbe3ecf90edbbf1bc32fe5978ca1d3 # v5.3.1
7 changes: 6 additions & 1 deletion .github/workflows/rspec.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,17 @@ on:
schedule:
- cron: "0 21 * * 6"

env:
CI: "yes"

jobs:
rspec:
runs-on: ubuntu-24.04
timeout-minutes: 10
strategy:
fail-fast: false
matrix:
ruby: ["3.1", "3.2", "3.3"]
ruby: ["3.1", "3.2", "3.3", "3.4"]

steps:
- name: Harden Runner
Expand All @@ -36,3 +39,5 @@ jobs:
bundler: latest
bundler-cache: true
- run: bundle exec rspec
- name: Upload coverage to Codecov
uses: codecov/codecov-action@13ce06bfc6bbe3ecf90edbbf1bc32fe5978ca1d3 # v5.3.1
28 changes: 12 additions & 16 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,17 +1,13 @@
*.gem
*.rbc
.bundle
.config
.yardoc
InstalledFiles
_yardoc
coverage
doc/
lib/bundler/man
pkg
rdoc
spec/reports
test/tmp
test/version_tmp
tmp
/.bundle/
/.yardoc
/_yardoc/
/coverage/
/doc/
/pkg/
/spec/reports/
/tmp/

# rspec failure tracking
.rspec_status

.idea/
3 changes: 3 additions & 0 deletions .rspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
--format documentation
--color
--require spec_helper
1 change: 1 addition & 0 deletions .standard.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ruby_version: 3.1
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Changelog

## main

* Rename `errbit_plugin` to `errbit-ng-plugin`
8 changes: 6 additions & 2 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# frozen_string_literal: true

source "https://rubygems.org"

# Specify your gem's dependencies in errbit_plugin.gemspec
# Specify your gem's dependencies in errbit-ng-plugin.gemspec
gemspec

gem "rake"
gem "rspec"
gem "coveralls", require: false
gem "standard"
gem "simplecov"
gem "simplecov-cobertura", require: false
35 changes: 13 additions & 22 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,19 +1,12 @@
PATH
remote: .
specs:
errbit_plugin (0.6.0)
errbit-ng-plugin (0.1.0)

GEM
remote: https://rubygems.org/
specs:
ast (2.4.2)
bigdecimal (3.1.9)
coveralls (0.8.23)
json (>= 1.8, < 3)
simplecov (~> 0.16.1)
term-ansicolor (~> 1.3)
thor (>= 0.19.4, < 2.0)
tins (~> 1.6)
diff-lcs (1.5.1)
docile (1.4.1)
json (2.9.1)
Expand All @@ -27,6 +20,7 @@ GEM
rainbow (3.1.1)
rake (13.2.1)
regexp_parser (2.10.0)
rexml (3.4.0)
rspec (3.13.0)
rspec-core (~> 3.13.0)
rspec-expectations (~> 3.13.0)
Expand Down Expand Up @@ -56,11 +50,15 @@ GEM
rubocop (>= 1.48.1, < 2.0)
rubocop-ast (>= 1.31.1, < 2.0)
ruby-progressbar (1.13.0)
simplecov (0.16.1)
simplecov (0.22.0)
docile (~> 1.1)
json (>= 1.8, < 3)
simplecov-html (~> 0.10.0)
simplecov-html (0.10.2)
simplecov-html (~> 0.11)
simplecov_json_formatter (~> 0.1)
simplecov-cobertura (2.1.0)
rexml
simplecov (~> 0.19)
simplecov-html (0.13.1)
simplecov_json_formatter (0.1.4)
standard (1.44.0)
language_server-protocol (~> 3.17.0.2)
lint_roller (~> 1.0)
Expand All @@ -73,13 +71,6 @@ GEM
standard-performance (1.6.0)
lint_roller (~> 1.1)
rubocop-performance (~> 1.23.0)
sync (0.5.0)
term-ansicolor (1.11.2)
tins (~> 1.0)
thor (1.3.2)
tins (1.38.0)
bigdecimal
sync
unicode-display_width (3.1.4)
unicode-emoji (~> 4.0, >= 4.0.4)
unicode-emoji (4.0.4)
Expand All @@ -98,11 +89,11 @@ PLATFORMS
x86_64-linux-musl

DEPENDENCIES
bundler
coveralls
errbit_plugin!
errbit-ng-plugin!
rake
rspec
simplecov
simplecov-cobertura
standard

BUNDLED WITH
Expand Down
20 changes: 0 additions & 20 deletions LICENSE

This file was deleted.

37 changes: 19 additions & 18 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
Copyright (c) 2013 Cyril Mougel
The MIT License (MIT)

MIT License
Copyright (c) 2013 Errbit
Copyright (c) 2013 Cyril Mougel
Copyright (c) 2025 Errbit-NG Team

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,13 @@ 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
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
Expand All @@ -60,9 +59,9 @@ 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

Expand All @@ -80,7 +79,7 @@ class MyIssueTracker < ErrbitPlugin::IssueTracker
if options[:username]
{}
else
{ field_one: 'username must be present' }
{field_one: "username must be present"}
end
end

Expand All @@ -92,7 +91,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
Expand All @@ -107,7 +106,7 @@ class MyIssueTracker < ErrbitPlugin::IssueTracker
# @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]]
["/path/to/some/template", formats: [:rdoc]]
end

# This method is optional, and is where you actually go close the issue on
Expand All @@ -121,12 +120,15 @@ 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.
Bug reports and pull requests are welcome on GitHub at https://github.com/errbit-ng/errbit-ng-plugin.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
7 changes: 7 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -1 +1,8 @@
# frozen_string_literal: true

require "bundler/gem_tasks"
require "rspec/core/rake_task"

RSpec::Core::RakeTask.new(:spec)

task default: :spec
37 changes: 37 additions & 0 deletions errbit-ng-plugin.gemspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# frozen_string_literal: true

require_relative "lib/errbit_plugin/version"

Gem::Specification.new do |spec|
spec.name = "errbit-ng-plugin"
spec.version = ErrbitPlugin::VERSION
spec.authors = ["Ihor Zubkov"]
spec.email = ["[email protected]"]

spec.summary = "Base to create an Errbit-NG plugins"
spec.description = "Base to create an Errbit-NG plugins"
spec.homepage = "https://github.com/errbit-ng/errbit-ng-plugin"
spec.license = "MIT"

spec.required_ruby_version = ">= 3.1.0"

spec.metadata["rubygems_mfa_required"] = "true"
spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"
spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
spec.metadata["documentation_uri"] = "#{spec.homepage}/blob/main/README.md"
spec.metadata["homepage_uri"] = spec.homepage
spec.metadata["source_code_uri"] = spec.homepage

# Specify which files should be added to the gem when it is released.
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
gemspec = File.basename(__FILE__)
spec.files = IO.popen(%w[git ls-files -z], chdir: __dir__, err: IO::NULL) do |ls|
ls.readlines("\x0", chomp: true).reject do |f|
(f == gemspec) ||
f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
end
end
spec.bindir = "exe"
spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
spec.require_paths = ["lib"]
end
21 changes: 0 additions & 21 deletions errbit_plugin.gemspec

This file was deleted.

3 changes: 3 additions & 0 deletions lib/errbit-ng-plugin.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# frozen_string_literal: true

require_relative "errbit_plugin"
4 changes: 3 additions & 1 deletion lib/errbit_plugin.rb
Original file line number Diff line number Diff line change
@@ -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/none_issue_tracker"
Loading

0 comments on commit 70dc14a

Please sign in to comment.