Skip to content
This repository was archived by the owner on Aug 4, 2024. It is now read-only.

Commit 976380a

Browse files
committed
Revert "Renamed"
This reverts commit 8b49a12.
1 parent f1c59e2 commit 976380a

File tree

20 files changed

+340
-61
lines changed

20 files changed

+340
-61
lines changed

.github/dependabot.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,14 @@ updates:
77
time: "06:00"
88
timezone: America/Los_Angeles
99
open-pull-requests-limit: 10
10+
labels:
11+
- "🏠 Housekeeping"
1012
- package-ecosystem: github-actions
1113
directory: "/"
1214
schedule:
1315
interval: monthly
1416
time: "06:00"
1517
timezone: America/Los_Angeles
1618
open-pull-requests-limit: 10
19+
labels:
20+
- "🏠 Housekeeping"
File renamed without changes.

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Release notes for this project are kept here: https://github.com/Unsupervisedcom/guideance-rails/releases
1+
Release notes for this project are kept here: https://github.com/mattbrictson/gem/releases

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ This Code of Conduct applies within all community spaces, and also applies when
3939

4040
## Enforcement
4141

42-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at noah@unsupervised.com. All complaints will be reviewed and investigated promptly and fairly.
42+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at owner@example.com. All complaints will be reviewed and investigated promptly and fairly.
4343

4444
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
4545

LICENSE.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2023 Noah Horton
3+
Copyright (c) 2023 Example Owner
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,32 @@
1-
# guideance-rails
1+
# gem template
22

3-
[![Gem Version](https://img.shields.io/gem/v/guideance-rails)](https://rubygems.org/gems/guideance-rails)
4-
[![Gem Downloads](https://img.shields.io/gem/dt/guideance-rails)](https://www.ruby-toolbox.com/projects/guideance-rails)
5-
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/Unsupervisedcom/guideance-rails/ci.yml)](https://github.com/Unsupervisedcom/guideance-rails/actions/workflows/ci.yml)
6-
[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/Unsupervisedcom/guideance-rails)](https://codeclimate.com/github/Unsupervisedcom/guideance-rails)
3+
This is a GitHub template for creating Ruby gems. Press [**Use this template**](https://github.com/mattbrictson/gem/generate) to generate a project from this template. In the generated project, run this script to rename the gem to meet your needs:
4+
5+
```
6+
$ ruby rename_template.rb
7+
```
8+
9+
Note that to get the full benefits of the script, you will need the [gh](https://github.com/cli/cli) command installed.
10+
11+
This template is based on `bundle gem` with some notable improvements:
12+
13+
- GitHub Actions configuration
14+
- Minitest, with minitest-reporters for nicely formatted test output
15+
- Rubocop with a good set of configuration
16+
- [release-drafter](https://github.com/apps/release-drafter) GitHub Action for automating release notes
17+
- A `rake bump` task to keep your Ruby and Bundler dependencies up to date
18+
- A nice README with badges ready to go (see below)
19+
20+
---
21+
22+
<!-- END FRONT MATTER -->
23+
24+
# example
25+
26+
[![Gem Version](https://img.shields.io/gem/v/replace_with_gem_name)](https://rubygems.org/gems/replace_with_gem_name)
27+
[![Gem Downloads](https://img.shields.io/gem/dt/replace_with_gem_name)](https://www.ruby-toolbox.com/projects/replace_with_gem_name)
28+
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/mattbrictson/gem/ci.yml)](https://github.com/mattbrictson/gem/actions/workflows/ci.yml)
29+
[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/mattbrictson/gem)](https://codeclimate.com/github/mattbrictson/gem)
730

831
TODO: Description of this gem goes here.
932

@@ -18,16 +41,16 @@ TODO: Description of this gem goes here.
1841
## Quick start
1942

2043
```
21-
$ gem install guideance-rails
44+
$ gem install example
2245
```
2346

2447
```ruby
25-
require "guideance/rails"
48+
require "example"
2649
```
2750

2851
## Support
2952

30-
If you want to report a bug, or have ideas, feedback or questions about the gem, [let me know via GitHub issues](https://github.com/Unsupervisedcom/guideance-rails/issues/new) and I will do my best to provide a helpful answer. Happy hacking!
53+
If you want to report a bug, or have ideas, feedback or questions about the gem, [let me know via GitHub issues](https://github.com/mattbrictson/gem/issues/new) and I will do my best to provide a helpful answer. Happy hacking!
3154

3255
## License
3356

Rakefile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ task default: %i[test rubocop]
1616

1717
Rake::Task["release"].enhance do
1818
puts "Don't forget to publish the release on GitHub!"
19-
system "open https://github.com/Unsupervisedcom/guideance-rails/releases"
19+
system "open https://github.com/mattbrictson/gem/releases"
2020
end
2121

2222
task :disable_overcommit do
@@ -27,13 +27,13 @@ Rake::Task[:build].enhance [:disable_overcommit]
2727

2828
task :verify_gemspec_files do
2929
git_files = `git ls-files -z`.split("\x0")
30-
gemspec_files = Gem::Specification.load("guideance-rails.gemspec").files.sort
30+
gemspec_files = Gem::Specification.load("example.gemspec").files.sort
3131
ignored_by_git = gemspec_files - git_files
3232
next if ignored_by_git.empty?
3333

3434
raise <<~ERROR
3535
36-
The `spec.files` specified in guideance-rails.gemspec include the following files
36+
The `spec.files` specified in example.gemspec include the following files
3737
that are being ignored by git. Did you forget to add them to the repo? If
3838
not, you may need to delete these files or modify the gemspec to ensure
3939
that they are not included in the gem by mistake:
@@ -56,7 +56,7 @@ namespace :bump do
5656
end
5757

5858
task :ruby do
59-
replace_in_file "guideance-rails.gemspec", /ruby_version = .*">= (.*)"/ => RubyVersions.lowest
59+
replace_in_file "example.gemspec", /ruby_version = .*">= (.*)"/ => RubyVersions.lowest
6060
replace_in_file ".rubocop.yml", /TargetRubyVersion: (.*)/ => RubyVersions.lowest
6161
replace_in_file ".github/workflows/ci.yml", /ruby: (\[.+\])/ => RubyVersions.all.inspect
6262
end

bin/console

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env ruby
22

33
require "bundler/setup"
4-
require "guideance/rails"
4+
require "example"
55

66
# You can add fixtures and/or initialization code here to make experimenting
77
# with your gem easier. You can also use a different console, if you like.

example.gemspec

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
require_relative "lib/example/version"
2+
3+
Gem::Specification.new do |spec|
4+
spec.name = "example"
5+
spec.version = Example::VERSION
6+
spec.authors = ["Example Owner"]
7+
spec.email = ["owner@example.com"]
8+
9+
spec.summary = ""
10+
spec.homepage = "https://github.com/mattbrictson/gem"
11+
spec.license = "MIT"
12+
spec.required_ruby_version = ">= 3.0"
13+
14+
spec.metadata = {
15+
"bug_tracker_uri" => "https://github.com/mattbrictson/gem/issues",
16+
"changelog_uri" => "https://github.com/mattbrictson/gem/releases",
17+
"source_code_uri" => "https://github.com/mattbrictson/gem",
18+
"homepage_uri" => spec.homepage,
19+
"rubygems_mfa_required" => "true"
20+
}
21+
22+
# Specify which files should be added to the gem when it is released.
23+
spec.files = Dir.glob(%w[LICENSE.txt README.md {exe,lib}/**/*]).reject { |f| File.directory?(f) }
24+
spec.bindir = "exe"
25+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
26+
spec.require_paths = ["lib"]
27+
end

exe/example

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/usr/bin/env ruby
2+
3+
require "example"
4+
Example::CLI.new.call(ARGV)

0 commit comments

Comments
 (0)