gemsmith 14.0.2 → 14.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15544c54f549c76478f41c75b5422a3337d5626f3a0ae484a9cb671f47279a38
-  data.tar.gz: 4bd32bd9bc8130c9e483ebfe19df212a342e1ff09340ddbc06dbe95a6ad2bb7e
+  metadata.gz: fec266e5af75d5e73a8406e702430fcbe4e9d007b4206a7f66822801edb6a0ef
+  data.tar.gz: 7f96466a64fe9ea9c0dd29e9ac54e277ff2abd4a08f8c44e186934304285b277
 SHA512:
-  metadata.gz: c0de9ae4ba2ca3509f191e67385c7758d831d7ea7ef71011ed1d1402c5215b048f0c3e6c5e5c40b3513bc4a2e6a4e06c588ef5e39fd8a08ecc2571f7a3d1cf6d
-  data.tar.gz: ddc7e87f1a9ed880dbf68b3763c779ed12f752975b5dacc429c9b26a013d6a0faa393aa921409bda6c7b6d63a41dc766b08131feb6665d0569a437a702da95e3
+  metadata.gz: 5c79e2e4f66f4f6f9c52d6e6ab142a56dbd70871324e5bb1fda2ac96ea36904863021e2ea0800aa90ec4a37ff44e507777c0394837741f671502750325dd2c9a
+  data.tar.gz: 759ec8bd5cd230f47b564ae0b2cafe7e81d345c1d26353614ac4d38ddf3df4995a3cf8b19e28577a7a334b63eb475b3b0cf7ebdca8e831ebf544ac865853d2e4

data/{LICENSE.md → LICENSE.adoc}

@@ -1,4 +1,4 @@
-# Apache License
+= Apache License
 
 Version 2.0, January 2004
 
@@ -6,7 +6,7 @@ http://www.apache.org/licenses
 
 TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-## 1. Definitions
+== 1. Definitions
 
 "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by
 Sections 1 through 9 of this document.
@@ -54,14 +54,14 @@ Contribution."
 "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a
 Contribution has been received by Licensor and subsequently incorporated within the Work.
 
-## 2. Grant of Copyright License
+== 2. Grant of Copyright License
 
 Subject to the terms and conditions of this License, each Contributor hereby grants to You a
 perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to
 reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and
 distribute the Work and such Derivative Works in Source or Object form.
 
-## 3. Grant of Patent License
+== 3. Grant of Patent License
 
 Subject to the terms and conditions of this License, each Contributor hereby grants to You a
 perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
@@ -74,39 +74,38 @@ a Contribution incorporated within the Work constitutes direct or contributory p
 then any patent licenses granted to You under this License for that Work shall terminate as of the
 date such litigation is filed.
 
-## 4. Redistribution
+== 4. Redistribution
 
 You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with
 or without modifications, and in Source or Object form, provided that You meet the following
 conditions:
 
-1. You must give any other recipients of the Work or Derivative Works a copy of this License; and
+. You must give any other recipients of the Work or Derivative Works a copy of this License; and
 
-2. You must cause any modified files to carry prominent notices stating that You changed the
-   files; and
+. You must cause any modified files to carry prominent notices stating that You changed the files;
+  and
 
-3. You must retain, in the Source form of any Derivative Works that You distribute, all copyright,
-   patent, trademark, and attribution notices from the Source form of the Work, excluding those
-   notices that do not pertain to any part of the Derivative Works; and
+. You must retain, in the Source form of any Derivative Works that You distribute, all copyright,
+  patent, trademark, and attribution notices from the Source form of the Work, excluding those
+  notices that do not pertain to any part of the Derivative Works; and
 
-4. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative
-   Works that You distribute must include a readable copy of the attribution notices contained
-   within such NOTICE file, excluding those notices that do not pertain to any part of the
-   Derivative Works, in at least one of the following places: within a NOTICE text file
-   distributed as part of the Derivative Works; within the Source form or documentation, if
-   provided along with the Derivative Works; or, within a display generated by the Derivative
-   Works, if and wherever such third-party notices normally appear. The contents of the NOTICE
-   file are for informational purposes only and do not modify the License. You may add Your own
-   attribution notices within Derivative Works that You distribute, alongside or as an addendum to
-   the NOTICE text from the Work, provided that such additional attribution notices cannot be
-   construed as modifying the License.
+. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works
+  that You distribute must include a readable copy of the attribution notices contained within such
+  NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in
+  at least one of the following places: within a NOTICE text file distributed as part of the
+  Derivative Works; within the Source form or documentation, if provided along with the Derivative
+  Works; or, within a display generated by the Derivative Works, if and wherever such third-party
+  notices normally appear. The contents of the NOTICE file are for informational purposes only and
+  do not modify the License. You may add Your own attribution notices within Derivative Works that
+  You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such
+  additional attribution notices cannot be construed as modifying the License.
 
 You may add Your own copyright statement to Your modifications and may provide additional or
 different license terms and conditions for use, reproduction, or distribution of Your modifications,
 or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of
 the Work otherwise complies with the conditions stated in this License.
 
-## 5. Submission of Contributions
+== 5. Submission of Contributions
 
 Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the
 Work by You to the Licensor shall be under the terms and conditions of this License, without any
@@ -114,13 +113,13 @@ additional terms or conditions. Notwithstanding the above, nothing herein shall
 the terms of any separate license agreement you may have executed with Licensor regarding such
 Contributions.
 
-## 6. Trademarks
+== 6. Trademarks
 
 This License does not grant permission to use the trade names, trademarks, service marks, or product
 names of the Licensor, except as required for reasonable and customary use in describing the origin
 of the Work and reproducing the content of the NOTICE file.
 
-## 7. Disclaimer of Warranty
+== 7. Disclaimer of Warranty
 
 Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each
 Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -129,7 +128,7 @@ TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. Y
 responsible for determining the appropriateness of using or redistributing the Work and assume any
 risks associated with Your exercise of permissions under this License.
 
-## 8. Limitation of Liability
+== 8. Limitation of Liability
 
 In no event and under no legal theory, whether in tort (including negligence), contract, or
 otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or
@@ -139,7 +138,7 @@ License or out of the use or inability to use the Work (including but not limite
 loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial
 damages or losses), even if such Contributor has been advised of the possibility of such damages.
 
-## 9. Accepting Warranty or Additional Liability
+== 9. Accepting Warranty or Additional Liability
 
 While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee
 for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights
@@ -151,11 +150,11 @@ additional liability.
 
 END OF TERMS AND CONDITIONS
 
-Copyright 2011 [Alchemists](https://www.alchemists.io).
+Copyright link:https://www.alchemists.io[Alchemists].
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
-compliance with the License. You may obtain a [copy](http://www.apache.org/licenses/LICENSE-2.0) of
-the License.
+compliance with the License. You may obtain a link:https://www.apache.org/licenses/LICENSE-2.0[copy]
+of the License.
 
 Unless required by applicable law or agreed to in writing, software distributed under the License is
 distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or

data/README.adoc

@@ -0,0 +1,417 @@
+:toc: macro
+:toclevels: 5
+:figure-caption!:
+
+= Gemsmith
+
+[link=http://badge.fury.io/rb/gemsmith]
+image::https://badge.fury.io/rb/gemsmith.svg[Gem Version]
+[link=https://circleci.com/gh/bkuhlmann/gemsmith]
+image::https://circleci.com/gh/bkuhlmann/gemsmith.svg?style=svg[Circle CI Status]
+
+A command line interface for smithing new Ruby gems.
+
+toc::[]
+
+== Features
+
+* Builds a gem skeleton with enhanced Bundler functionality.
+* Uses link:https://www.alchemists.io/projects/refinements[Refinements] Ruby core library enhancements.
+* Uses link:https://www.alchemists.io/projects/versionaire[Versionaire] for semantic versioning.
+* Uses link:https://www.alchemists.io/projects/runcom[Runcom] for resource configuration management.
+* Uses link:https://www.alchemists.io/projects/milestoner[Milestoner] for consistent project/gem versioning.
+* Uses link:https://www.alchemists.io/projects/pragmater[Pragmater] for Ruby source pragma directives.
+* Uses link:https://www.alchemists.io/projects/tocer[Tocer] for README table of contents generation.
+* Supports link:https://github.com/rubysec/bundler-audit[Bundler Audit].
+* Supports link:https://circleci.com[Circle CI].
+* Supports link:https://www.alchemists.io/projects/git-lint[Git Lint].
+* Supports link:https://github.com[GitHub].
+* Supports link:https://github.com/guard/guard[Guard].
+* Supports link:http://pryrepl.org[Pry].
+* Supports link:https://github.com/troessner/reek[Reek].
+* Supports link:https://rspec.info[RSpec].
+* Supports link:https://github.com/rubocop-hq/rubocop[Rubocop].
+* Supports link:https://github.com/rubocop-hq/rubocop-rspec[Rubocop RSpec].
+* Supports link:http://rubyonrails.org[Ruby on Rails].
+* Supports link:https://guides.rubygems.org/security[RubyGems Security].
+* Supports link:https://github.com/colszowka/simplecov[SimpleCov].
+* Supports link:https://github.com/erikhuda/thor[Thor].
+* Supports common settings and a structured layout for building gems.
+* Supports publishing to public or private gem servers.
+* Provides common documentation:
+** README
+** CHANGES
+** CONTRIBUTING
+** CODE OF CONDUCT
+** LICENSE
+* Aids in viewing source code of semantically versioned gems within your favorite editor.
+* Aids in viewing documentation of semantically versioned within your default browser.
+
+== Screencasts
+
+[link=https://www.alchemists.io/screencasts/gemsmith]
+image::https://www.alchemists.io/images/screencasts/gemsmith/cover-original.png[Screencast,role=focal_point]
+
+== Requirements
+
+. A UNIX-based system.
+. link:https://www.ruby-lang.org[Ruby 2.7.x].
+. link:https://rubygems.org[RubyGems].
+. link:https://github.com/bundler/bundler[Bundler].
+
+== Setup
+
+=== Production
+
+To install, run:
+
+[source,bash]
+----
+gem install gemsmith
+----
+
+=== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/gemsmith.git
+cd gemsmith
+bin/setup
+----
+
+You can also use the IRB console for direct access to all objects:
+
+[source,bash]
+----
+bin/console
+----
+
+== Usage
+
+=== Command Line Interface (CLI)
+
+From the command line, type: `gemsmith --help`
+
+....
+gemsmith -c, [--config]        # Manage gem configuration.
+gemsmith -g, [--generate=GEM]  # Generate new gem.
+gemsmith -h, [--help=COMMAND]  # Show this message or get help for a command.
+gemsmith -o, [--open=GEM]      # Open a gem in default editor.
+gemsmith -r, [--read=GEM]      # Open a gem in default browser.
+gemsmith -v, [--version]       # Show gem version.
+....
+
+For more gem generation options, type: `gemsmith --help --generate`
+
+....
+[--bundler-audit], [--no-bundler-audit]  # Add Bundler Audit support.
+                                         # Default: true
+[--circle-ci], [--no-circle-ci]          # Add Circle CI support.
+[--cli], [--no-cli]                      # Add CLI support.
+[--engine], [--no-engine]                # Add Rails Engine support.
+[--git-cop], [--no-git-cop]              # Add Git Cop support. DEPRECATED: Use Git Lint instead.
+[--git-lint], [--no-git-lint]            # Add Git Lint support.
+                                         # Default: true
+[--git-hub], [--no-git-hub]              # Add GitHub support.
+[--guard], [--no-guard]                  # Add Guard support.
+                                         # Default: true
+[--pry], [--no-pry]                      # Add Pry support.
+                                         # Default: true
+[--reek], [--no-reek]                    # Add Reek support.
+                                         # Default: true
+[--rspec], [--no-rspec]                  # Add RSpec support.
+                                         # Default: true
+[--rubocop], [--no-rubocop]              # Add Rubocop support.
+                                         # Default: true
+[--simple-cov], [--no-simple-cov]        # Add SimpleCov support.
+                                         # Default: true
+[--security], [--no-security]            # Add security support.
+....
+
+=== Rake
+
+Once a gem skeleton has been created, the following tasks are available (i.e. `bundle exec rake
+-T`):
+
+....
+rake build                 # Build example-0.1.0.gem package
+rake bundle:audit          # Updates the ruby-advisory-db then runs bundle-audit
+rake clean                 # Clean gem artifacts
+rake code_quality          # Run code quality checks
+rake git_cop               # Run Git Cop
+rake install               # Install example-0.1.0.gem package
+rake publish               # Build, tag as 0.1.0 (unsigned), and push example-0.1.0.gem to RubyGems
+rake reek                  # Check for code smells
+rake rubocop               # Run RuboCop
+rake rubocop:auto_correct  # Auto-correct RuboCop offenses
+rake spec                  # Run RSpec code examples
+rake toc                   # Update Table of Contents (README)
+....
+
+_NOTE: Some tasks might differ depending on what options you enabled/disabled during gem
+generation._
+
+When building/testing your gem locally, a typical workflow is:
+
+. `bundle exec rake install`
+. Test your gem locally.
+. Repeat until satisfied.
+
+When satified with your gem, builds are green, and ready to publish, run:
+
+....
+bundle exec rake publish
+....
+
+=== Configuration
+
+This gem can be configured via a global configuration:
+
+....
+$HOME/.config/gemsmith/configuration.yml
+....
+
+It can also be configured via link:https://www.alchemists.io/projects/xdg[XDG] environment variables.
+
+The default configuration is as follows:
+
+[source,yaml]
+----
+:year: <current year>
+:github_user: "<Git config GitHub user>"
+:gem:
+  :label: "Undefined"
+  :name: "undefined"
+  :path: "undefined"
+  :class: "Undefined"
+  :platform: "Gem::Platform::RUBY"
+  :url: "https://github.com/<author>/<gem name>"
+  :license: "MIT"
+:author:
+  :name: "<Git config user name>"
+  :email: "<Git config user email>"
+  :url: ""
+:organization:
+  :name: ""
+  :url: ""
+:versions:
+  :ruby: "<current Ruby version>"
+  :rails: "5.1"
+:generate:
+  :bundler_audit: true
+  :circle_ci: false
+  :cli: false
+  :engine: false
+  :git_lint: true
+  :git_hub: true
+  :guard: true
+  :pry: true
+  :reek: true
+  :rspec: true
+  :rubocop: true
+  :simple_cov: true
+  :security: false
+:publish:
+  :sign: false
+----
+
+Feel free to take this default configuration, modify, and save as your own custom
+`configuration.yml`.
+
+=== Existing Gems
+
+If you have gems that were not originally crafted by Gemsmith, you can add Gemsmith support to them
+by modifying the following files:
+
+Add the following to your gem's `.gemspec` file:
+
+[source,ruby]
+----
+spec.add_development_dependency "gemsmith"
+----
+
+Replace or add a modified version of the following to your gem's `Rakefile`:
+
+[source,ruby]
+----
+# frozen_string_literal: true
+
+begin
+  require "gemsmith/rake/setup"
+rescue LoadError => error
+  puts error.message
+end
+----
+
+_NOTE: Ensure `require "bundler/gem_tasks"` is removed as Gemsmith replaces Bundler functionality._
+
+With those changes, you can leverage the benefits of Gemsmith within your existing gem.
+
+== Tests
+
+To test, run:
+
+[source,bash]
+----
+bundle exec rake
+----
+
+== Security
+
+=== Git Signing Key
+
+To securely sign your Git tags, install and configure link:https://www.gnupg.org[GPG]:
+
+[source,bash]
+----
+brew install gpg
+gpg --gen-key
+----
+
+When creating your GPG key, choose these settings:
+
+* Key kind: RSA and RSA (default)
+* Key size: 4096
+* Key validity: 0
+* Real Name: `<your name>`
+* Email: `<your email>`
+* Passphrase: `<your passphrase>`
+
+To obtain your key, run the following and take the part after the forward slash:
+
+[source,bash]
+----
+gpg --list-keys | grep pub
+----
+
+Add your key to your global Git configuration in the `[user]` section. Example:
+
+....
+[user]
+  signingkey = <your GPG key>
+....
+
+Now, when publishing your gems with Gemsmith (i.e. `bundle exec rake publish`), signing of your Git
+tag will happen automatically. You will be prompted for the GPG Passphrase each time but that is to
+be expected.
+
+=== Gem Certificates
+
+To create a certificate for your gems, run the following:
+
+[source,bash]
+----
+cd ~/.ssh
+gem cert --build you@example.com
+chmod 600 gem-*.pem
+----
+
+The resulting `.pem` key files can be referenced via the `:private_key:` and `:public_key:` keys
+within the `$HOME/.gemsmithrc` file.
+
+To learn more about gem certificates, read about RubyGems
+link:https://guides.rubygems.org/security[Security].
+
+== Private Gem Servers
+
+By default, the following Rake task will publish your gem to link:https://rubygems.org[RubyGems]:
+
+[source,bash]
+----
+bundle exec rake publish
+----
+
+You can change this behavior by adding metadata to your gemspec that will allow the Rake tasks,
+mentioned above, to publish your gem to an alternate/private gem server instead. This can be done by
+updating your gem specification and RubyGems credentials.
+
+=== Gem Specification Metadata
+
+Add the following metadata to your gemspec:
+
+[source,ruby]
+----
+Gem::Specification.new do |spec|
+  spec.metadata = {
+    "allowed_push_key" => "example_key",
+    "allowed_push_host" => "https://gems.example.com"
+  }
+end
+----
+
+The gemspec metadata keys and values _must_ be strings per the
+link:https://guides.rubygems.org/specification-reference/#metadata[RubyGems Specification]. Each key
+represents the following:
+
+* `allowed_push_key`: Provides a reference (look up) to the key defined the RubyGems credentials
+  file so that sensitive credentials are not used within your gemspec.
+* `allowed_push_host`: Provides the URL of the private gem server to push your gem to.
+
+=== Gem Credentials
+
+With your gem specification metadata established, you are ready to publish your gem to a public or
+private server. If this is your first time publishing a gem and no gem credentials have been
+configured, you'll be prompted for them. Gem credentials are stored in the RubyGems
+`$HOME/.gem/credentials` file. From this point forward, future gem publishing will use your stored
+credentials instead. Multiple credentials can be stored in the `$HOME/.gem/credentials` file.
+Example:
+
+[source,yaml]
+----
+:rubygems_api_key: 2a0b460650e67d9b85a60e183defa376
+:example_key: "Basic dXNlcjpwYXNzd29yZA=="
+----
+
+Should you need to delete a credential (due to a bad login/password for example), you can open the
+`$HOME/.gem/credentials` in your default editor and remove the line(s) you don't need. Upon next
+publish of your gem, you'll be prompted for the missing credentials.
+
+== Promotion
+
+Once your gem is released, let the world know about your accomplishment by posting an update to
+these sites:
+
+* link:http://www.rubyflow.com[RubyFlow]
+* link:https://ruby.libhunt.com[Ruby Library Hunt]
+* link:http://rubydaily.org[RubyDaily]
+* link:https://awesome-ruby.com[Awesome Ruby]
+* link:https://www.ruby-toolbox.com[Ruby Toolbox]
+* link:https://www.ruby-lang.org/en/community[Ruby Community]
+
+== Troubleshooting
+
+When running `bundle exec rake install` or `bundle exec rake publish` with modified, staged, or
+uncommitted Git changes, the rake task will throw an error to this effect. When this occurs, it is
+recommended that you commit your changes or link:https://git-scm.com/docs/git-stash[stash] them
+before proceeding.
+
+== Versioning
+
+Read link:https://semver.org[Semantic Versioning] for details. Briefly, it means:
+
+* Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+* Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
+* Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
+
+== Code of Conduct
+
+Please note that this project is released with a link:CODE_OF_CONDUCT.adoc[CODE OF CONDUCT]. By
+participating in this project you agree to abide by its terms.
+
+== Contributions
+
+Read link:CONTRIBUTING.adoc[CONTRIBUTING] for details.
+
+== License
+
+Read link:LICENSE.adoc[LICENSE] for details.
+
+== History
+
+Read link:CHANGES.adoc[CHANGES] for details.
+
+== Credits
+
+Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].