makenew-rbgem 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a0fb3e36ade9a0b62e908ae40b56af6d731b3bce813f575db9e3c8f950ee73db
+  data.tar.gz: aee644785e9d36f95b88a2decd106c582f0c6e74c1cb0a47f60923e98741c511
+SHA512:
+  metadata.gz: 0cb64d4c3b62dd563eafda26be9ed5a132b4c3317453f36c1140a34eae363eafb35e892a6dc8c3b7063c33086085080172a4d8d9f72523748714bfa982dc18b0
+  data.tar.gz: 9b603083d2787498c41715d82667099f9d8e34e1f934671db829e2777048481b551b0d7f630ed133d594ece498138efabf06f0dcb3412dda06dca06caf67c74c

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](https://semver.org/).
+
+## Unreleased

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in makenew-rbgem.gemspec.
+gemspec

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    makenew-rbgem (0.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    gem-release (2.2.2)
+    json (2.6.2)
+    multi_json (1.15.0)
+    parallel (1.22.1)
+    parse_gemspec (1.0.0)
+    parse_gemspec-cli (1.0.0)
+      multi_json
+      parse_gemspec
+      thor
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    rubocop (1.35.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-console (0.9.1)
+      ansi
+      simplecov
+      terminal-table
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    standard (1.16.1)
+      rubocop (= 1.35.1)
+      rubocop-performance (= 1.14.3)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.2.1)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  gem-release (~> 2.2)
+  makenew-rbgem!
+  parse_gemspec-cli (~> 1.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  simplecov (~> 0.21)
+  simplecov-console (~> 0.9)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.3.23

data/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Evan Sosenko
+
+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 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.

data/README.md

@@ -0,0 +1,230 @@
+# Ruby Gem Package Skeleton
+
+[![RubyGems.org](https://img.shields.io/gem/v/makenew-rbgem)](https://rubygems.org/gems/makenew-rbgem)
+[![GitHub Actions](https://github.com/makenew/rbgem/workflows/main/badge.svg)](https://github.com/makenew/rbgem/actions)
+
+Package skeleton for a Ruby gem.
+
+## Description
+
+Bootstrap a new Ruby gem in five minutes or less.
+
+### Features
+
+- [Ruby]'s [gem][RubyGems.org] package structure.
+- Consistent dependency management with [Bundler].
+- Release your ruby gems with ease using [gem release].
+- [Standard] Ruby style guide, linter, and formatter.
+- Productive and fun testing with [RSpec].
+- Code coverage reporting with [SimpleCov].
+- Continuous testing and gem publishing with [GitHub Actions].
+- [Keep a CHANGELOG].
+- Consistent coding with [EditorConfig].
+- Badges from [Shields.io].
+
+[Bundler]: https://bundler.io/
+[EditorConfig]: https://editorconfig.org/
+[GitHub Actions]: https://github.com/features/actions
+[Keep a CHANGELOG]: https://keepachangelog.com/
+[RSpec]: https://rspec.info/
+[RubyGems.org]: https://rubygems.org/
+[Ruby]: https://www.ruby-lang.org/
+[Shields.io]: https://shields.io/
+[SimpleCov]: https://github.com/simplecov-ruby/simplecov
+[Standard]: https://github.com/testdouble/standard
+[gem release]: https://github.com/svenfuchs/gem-release
+
+### Bootstrapping a new project
+
+1. Create an empty (**non-initialized**) repository on GitHub.
+2. Clone the master branch of this repository with
+   ```
+   $ git clone --single-branch git@github.com:makenew/rbgem.git <new-ruby-gem>
+   $ cd <new-ruby-gem>
+   ```
+   Optionally, reset to the latest version with
+   ```
+   $ git reset --hard <version-tag>
+   ```
+3. Run
+   ```
+   $ ./makenew.sh
+   ```
+   This will replace the boilerplate, delete itself,
+   remove the git remote, remove upstream tags,
+   and stage changes for commit.
+4. Create the required GitHub repository secrets.
+5. Review, commit, and push the changes to GitHub with
+   ```
+   $ git diff --cached
+   $ git commit -m "Replace makenew boilerplate"
+   $ git remote add origin git@github.com:<user>/<new-ruby-gem>.git
+   $ git push -u origin master
+   ```
+6. Ensure the GitHub action passes,
+   then publish the initial version of the package with
+   ```
+   $ bundle install
+   $ bundle exec gem bump --sign --push --version patch
+   $ bundle exec gem tag --sign --push
+   ```
+
+### Updating from this skeleton
+
+If you want to pull in future updates from this skeleton,
+you can fetch and merge in changes from this repository.
+
+Add this as a new remote with
+
+```
+$ git remote add upstream git@github.com:makenew/rbgem.git
+```
+
+You can then fetch and merge changes with
+
+```
+$ git fetch --no-tags upstream
+$ git merge upstream/master
+```
+
+#### Changelog for this skeleton
+
+Note that `CHANGELOG.md` is just a template for this skeleton.
+The actual changes for this project are documented in the commit history
+and summarized under [Releases].
+
+[Releases]: https://github.com/makenew/rbgem/releases
+
+## Installation
+
+Add this as a dependency to your project using [Bundler] with
+
+```
+$ bundle add makenew-rbgem
+```
+
+[Bundler]: https://bundler.io/
+
+## Development and Testing
+
+### Quickstart
+
+```
+$ git clone https://github.com/makenew/rbgem.git
+$ cd rbgem
+$ bundle install
+```
+
+Run the command below in a separate terminal window:
+
+```
+$ bundle exec rake
+```
+
+Primary development tasks are defined as [rake] tasks in the `Rakefile`
+and available via `rake`.
+View them with
+
+```
+$ bundle exec rake -T
+```
+
+[rake]: https://ruby.github.io/rake/
+
+### Source code
+
+The [source code] is hosted on GitHub.
+Clone the project with
+
+```
+$ git clone git@github.com:makenew/rbgem.git
+```
+
+[source code]: https://github.com/makenew/rbgem
+
+### Requirements
+
+You will need [Ruby] with [Bundler].
+
+Be sure that all commands run under the correct Ruby version, e.g.,
+if using [rbenv], install the correct version with
+
+```
+$ rbenv install
+```
+
+Install the development dependencies with
+
+```
+$ bundle install
+```
+
+[Bundler]: https://bundler.io/
+[Ruby]: https://www.ruby-lang.org/
+[rbenv]: https://github.com/rbenv/rbenv
+
+### Publishing
+
+Use [gem release] to release a new version.
+
+Publishing may be triggered using on the web
+using a [workflow_dispatch on GitHub Actions].
+
+[gem release]: https://github.com/svenfuchs/gem-release
+[workflow_dispatch on GitHub Actions]: https://github.com/makenew/rbgem/actions?query=workflow%3Aversion
+
+## GitHub Actions
+
+_GitHub Actions should already be configured: this section is for reference only._
+
+The following repository secrets must be set on [GitHub Actions]:
+
+- `RUBYGEMS_API_KEY`: RubyGems.org token for publishing packages.
+
+These must be set manually.
+
+### Secrets for Optional GitHub Actions
+
+The version and format GitHub actions
+require a user with write access to the repository.
+Set these additional secrets to enable the action:
+
+- `GH_USER`: The GitHub user's username.
+- `GH_TOKEN`: A personal access token for the user.
+- `GIT_USER_NAME`: The GitHub user's real name.
+- `GIT_USER_EMAIL`: The GitHub user's email.
+- `GPG_PRIVATE_KEY`: The GitHub user's [GPG private key].
+- `GPG_PASSPHRASE`: The GitHub user's GPG passphrase.
+
+[GitHub Actions]: https://github.com/features/actions
+[GPG private key]: https://github.com/marketplace/actions/import-gpg#prerequisites
+
+## Contributing
+
+Please submit and comment on bug reports and feature requests.
+
+To submit a patch:
+
+1. Fork it (https://github.com/makenew/rbgem/fork).
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Make changes.
+4. Commit your changes (`git commit -am 'Add some feature'`).
+5. Push to the branch (`git push origin my-new-feature`).
+6. Create a new Pull Request.
+
+## License
+
+This Ruby gem is licensed under the MIT license.
+
+## Warranty
+
+This software is provided by the copyright holders and contributors "as is" and
+any express or implied warranties, including, but not limited to, the implied
+warranties of merchantability and fitness for a particular purpose are
+disclaimed. In no event shall the copyright holder or contributors be liable for
+any direct, indirect, incidental, special, exemplary, or consequential damages
+(including, but not limited to, procurement of substitute goods or services;
+loss of use, data, or profits; or business interruption) however caused and on
+any theory of liability, whether in contract, strict liability, or tort
+(including negligence or otherwise) arising in any way out of the use of this
+software, even if advised of the possibility of such damage.

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "standard/rake"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--pattern {spec,lib}/**/*_spec.rb"
+end
+
+task default: %i[lint test]
+
+task test: "spec"
+task lint: "standard"
+task format: "standard:fix"

data/lib/makenew-rbgem/todo.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module MakenewRbgem
+  class Todo
+    def todo
+      "TODO"
+    end
+  end
+end

data/lib/makenew-rbgem/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MakenewRbgem
+  VERSION = "0.0.2"
+end

data/lib/makenew-rbgem.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "makenew-rbgem/version"
+require_relative "makenew-rbgem/todo"
+
+module MakenewRbgem
+  # TODO
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: makenew-rbgem
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Evan Sosenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: parse_gemspec-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: standard
+  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'
+description: Project skeleton for a Ruby gem.
+email: razorx@evansosenko.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/makenew-rbgem.rb
+- lib/makenew-rbgem/todo.rb
+- lib/makenew-rbgem/version.rb
+homepage: https://github.com/makenew/rbgem
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/makenew/rbgem
+  source_code_uri: https://github.com/makenew/rbgem
+  bug_tracker_uri: https://github.com/makenew/rbgem/issues
+  changelog_uri: https://github.com/makenew/rbgem/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Ruby Gem Project Skeleton
+test_files: []