rubysmith 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70dbc101555ee2f755af1202de17dd12c04bd5a427a483a3c2710bcedad4fdb5
-  data.tar.gz: 723ab4a9bee7cb81f5c46e5011704972922ec6c9d30e408b17935369a7034502
+  metadata.gz: e5486da67dbe6ea1ef0ce376a6d4e59c32fa5a84c46b5fec2eef493339e6ca40
+  data.tar.gz: 7fc86c2c1e38733990b2f7236b44b068a9dfaaf38e7b109b923f30e7b548517a
 SHA512:
-  metadata.gz: 4a735f251308fe224894d35cd6ec488fbb48296d2192371b1cefb7f0dfaaa2a4320cfeebcb91954c4ee6238ff35d3f962b9c5f59496d9c49a215bcbd6250c8bb
-  data.tar.gz: caa4eccf46c21ef081e46530ba780776895d9ee42b10fc87f2bcf43dd4e3ed5b99665a22f4eaf2490dafc44c22650ab67cd9507fa5af7c05202caa2d25bd2604
+  metadata.gz: 7d156e06cb6dd5003f35cba343887f6b8d1658a5e7b70085237af5ffed9466352c1cb6667259cdf5523786e078f04dcbc6b1f3e2352dd71d79c90a819b01b258
+  data.tar.gz: 3a10b92f11bf709ee8922fd85698ade151f6c557148110d2c2ba352ea3221fb2dbce5d2702772d5398c3fd54b26aa95e063157be3a8b7e9d5e5a6ba5385fa42e

data/README.adoc

@@ -22,8 +22,9 @@ toc::[]
 * Uses link:https://www.alchemists.io/projects/pragmater[Pragmater] for Ruby source pragma directives.
 * Supports link:https://github.com/amazing-print/amazing_print[Amazing Print].
 * Supports link:https://github.com/rubymem/bundler-leak[Bundler Leak].
+* Supports link:https://www.alchemists.io/projects/caliber[Caliber].
 * Supports link:https://circleci.com[Circle CI].
-* Supports link:https://orcid.org[ORCID Citations].
+* Supports link:https://orcid.org[Citations (ORCID)].
 * Supports console script for local development.
 * Supports link:https://rubygems.org/gems/dead_end[DeadEnd].
 * Supports link:https://github.com/ruby/debug[Debug].
@@ -35,11 +36,9 @@ toc::[]
 * Supports link:https://github.com/troessner/reek[Reek].
 * Supports link:https://www.alchemists.io/projects/refinements[Refinements].
 * Supports link:https://rspec.info[RSpec].
-* Supports link:https://github.com/rubocop-hq/rubocop[Rubocop].
-* Supports link:https://docs.rubocop.org/rubocop-performance[Rubocop Performance].
-* Supports link:https://github.com/rubocop-hq/rubocop-rake[Rubocop Rake].
-* Supports link:https://github.com/rubocop-hq/rubocop-rspec[Rubocop RSpec].
+* Supports setup script for project setup.
 * Supports link:https://github.com/simplecov-ruby/simplecov[SimpleCov].
+* Supports link:https://yardoc.org[YARD].
 * Supports link:https://github.com/fxn/zeitwerk[Zeitwerk].
 * Supports common settings and a structured layout for building projects.
 * Provides common documentation:
@@ -65,6 +64,16 @@ To install, run:
 gem install rubysmith
 ----
 
+== Upgrade
+
+If upgrading from 1.0.0 to 2.0.0, you'll need to make the following changes:
+
+* README badges are no longer injected so you can customize as desired.
+* The `:rubocop:` build configuration has been removed. Use `:caliber:` instead.
+* The `--rubocop` build option has been removed. Use `--caliber` instead.
+* You no longer have to Git ignore RuboCop cached configurations since this is handled by the
+  Caliber gem now.
+
 == Usage
 
 === Command Line Interface (CLI)
@@ -82,6 +91,7 @@ USAGE:
 BUILD OPTIONS:
       --[no-]amazing_print                 Add Amazing Print gem. Default: true.
       --[no-]bundler-leak                  Add Bundler Leak gem. Default: true.
+      --[no-]caliber                       Add Caliber gem. Default: true.
       --[no-]circle_ci                     Add Circle CI configuration and badge. Default: false.
       --[no-]citation                      Add citation documentation. Default: true.
       --[no-]community                     Add community documentation. Default: false.
@@ -102,7 +112,7 @@ BUILD OPTIONS:
       --[no-]reek                          Add Reek gem. Default: true.
       --[no-]refinements                   Add Refinements gem. Default: true.
       --[no-]rspec                         Add RSpec gem. Default: true.
-      --[no-]rubocop                       Add RuboCop gems. Default: true.
+      --[no-]security                      Add security. Default: true.
       --[no-]setup                         Add setup script. Default: true.
       --[no-]simple_cov                    Add SimpleCov gem. Default: true.
       --[no-]versions                      Add version history. Default: true.
@@ -174,11 +184,17 @@ The `--bundler-leak` option allows you to build your project with the
 link:https://github.com/rubymem/bundler-leak[Bundler Leak] gem which helps detect memory leaks in
 your gem dependencies.
 
+==== Caliber
+
+The `--caliber` option allows you to build your project with the
+link:https://www.alchemists.io/projects/caliber[Caliber] gem so you have an immediate working -- and
+high quality -- link:https://docs.rubocop.org/rubocop[RuboCop] configuration. Read the Caliber
+documentation for further customization.
+
 ==== Circle CI
 
 The `--circle_ci` option allows you to build your project with link:https://circleci.com[Circle CI]
-configured so you can get your project building as quickly as possible. This includes a README badge
-and configuration YAML.
+configured so you can get your project building as quickly as possible.
 
 ==== Citation
 
@@ -211,8 +227,8 @@ contribute back to your work.
 ==== DeadEnd
 
 The `--dead_end` option allows you build your project with the
-link:https://github.com/zombocom/dead_end[DeadEnd] for debugging purposes since the DeadEnd gem will
-show you where you are missing `end`'s and closing statements.
+link:https://github.com/zombocom/dead_end[Dead End] gem for debugging purposes since Dead End will
+show you where you are missing closing `end` statements.
 
 ==== Debug
 
@@ -252,7 +268,7 @@ to build a new project with all options enabled without having to pick and choos
 ==== Minimum
 
 The `--min` option allows you to build your project with _all_ options _disabled_. This is a quick
-way to build a new project with the bare minimum of support which is a one step above reaching for
+way to build a new project with the bare minimum of support which is a one step above reaching for a
 Bundler Inline script.
 
 ==== Rake
@@ -280,13 +296,6 @@ Ruby core objects without monkey patching your code.
 The `--rspec` option allows you add the link:https://rspec.info[RSpec] gem to your project for
 defining your project specifications and have a framework for testing your code.
 
-==== Rubocop
-
-The `--rubocop` option allows you to add the link:https://docs.rubocop.org[RuboCop] gem and suite
-of gems to your project for good code quality standards. This the Alchemists style guide, provided
-by the link:https://www.alchemists.io/projects/code_quality[Code Quality] project, is what is used
-by default.
-
 ==== Setup
 
 The `--setup` option allows you to configure you project with automated setup instructions so anyone
@@ -352,6 +361,7 @@ variables. The default configuration is as follows:
 :build:
   :amazing_print: true
   :bundler_leak: true
+  :caliber: true
   :circle_ci: false
   :citation: true
   :community: false
@@ -372,7 +382,6 @@ variables. The default configuration is as follows:
   :reek: true
   :refinements: true
   :rspec: true
-  :rubocop: true
   :security: true
   :setup: true
   :simple_cov: true
@@ -467,7 +476,7 @@ these options are explained in greater detail above.
 
 ==== Citations
 
-This section allows you to configure your link:https://orcid.org[ORCiD]
+This section allows you to configure your link:https://orcid.org[ORCID]
 link:https://citation-file-format.github.io[citation] information used by the research community.
 You should definitely fill this in. Your author information, detailed above, will be used as well.
 
@@ -494,9 +503,7 @@ Follow the above links to learn more about each extension's gem configuration.
 ==== GitHub
 
 Your GitHub user is the handle you setup when creating your GitHub account. This information is used
-for documentation purposes and Circle CI badge association. If you don't define this information,
-Rubysmith will automatically fallback to pulling this information from your Git configuration (i.e.
-`github.user`). If all else fails, then nothing will be used.
+for template and/or URL construction purposes.
 
 ==== License
 
@@ -509,7 +516,7 @@ license are available:
 
 ==== Project
 
-There are two categories within this section: URLs and version. The URLs allow you to link to
+There are two sub-categories within this section: URLs and version. The URLs allow you to link to
 specific documentation related to your project. You'll definitely want to customize these as makes
 sense since these URLs are used for documentation, citations, and general project information. You
 can also use `%project_name%` as a placeholder anywhere in your URL and Rubysmith will ensure your

data/lib/rubysmith/builders/{rubocop.rb → caliber.rb}

@@ -4,8 +4,8 @@ require "refinements/structs"
 
 module Rubysmith
   module Builders
-    # Builds project skeleton with RuboCop code quality support.
-    class Rubocop
+    # Builds project skeleton with Caliber style support.
+    class Caliber
       using Refinements::Structs
 
       def self.call(...) = new(...).call
@@ -16,7 +16,7 @@ module Rubysmith
       end
 
       def call
-        return configuration unless configuration.build_rubocop
+        return configuration unless configuration.build_caliber
 
         builder.call(configuration.merge(template_path: "%project_name%/bin/rubocop.erb"))
                .render

data/lib/rubysmith/builders/core.rb

@@ -33,7 +33,7 @@ module Rubysmith
 
       def indentation = "".indent configuration.project_levels
 
-      def module_name = configuration.project_class.split("::").last
+      def module_name = configuration.project_class
 
       attr_reader :configuration, :builder
     end

data/lib/rubysmith/builders/version.rb

@@ -16,7 +16,9 @@ module Rubysmith
       end
 
       def call
-        builder.call(configuration.merge(template_path: "%project_name%/.ruby-version.erb")).render
+        builder.call(configuration.merge(template_path: "%project_name%/.ruby-version.erb"))
+               .render
+               .append("\n")
         configuration
       end
 

data/lib/rubysmith/cli/actions/build.rb

@@ -25,7 +25,7 @@ module Rubysmith
           Builders::Reek,
           Builders::RSpec::Context,
           Builders::RSpec::Helper,
-          Builders::Rubocop,
+          Builders::Caliber,
           Extensions::Bundler,
           Extensions::Pragmater,
           Extensions::Tocer,

data/lib/rubysmith/cli/parsers/build.rb

@@ -50,6 +50,15 @@ module Rubysmith
           end
         end
 
+        def add_caliber
+          client.on(
+            "--[no-]caliber",
+            "Add Caliber gem. #{default __method__}."
+          ) do |value|
+            configuration.merge! build_caliber: value
+          end
+        end
+
         def add_console
           client.on(
             "--[no-]console",
@@ -230,15 +239,6 @@ module Rubysmith
           end
         end
 
-        def add_rubocop
-          client.on(
-            "--[no-]rubocop",
-            "Add RuboCop gems. #{default __method__}."
-          ) do |value|
-            configuration.merge! build_rubocop: value
-          end
-        end
-
         def add_security
           client.on(
             "--[no-]security",

data/lib/rubysmith/configuration/content.rb

@@ -24,6 +24,7 @@ module Rubysmith
       :author_url,
       :build_amazing_print,
       :build_bundler_leak,
+      :build_caliber,
       :build_circle_ci,
       :build_citation,
       :build_cli,
@@ -45,7 +46,6 @@ module Rubysmith
       :build_reek,
       :build_refinements,
       :build_rspec,
-      :build_rubocop,
       :build_security,
       :build_setup,
       :build_simple_cov,
@@ -111,11 +111,13 @@ module Rubysmith
 
       def license_label_version = [license_label, license_version].compress.join("-")
 
-      def project_class = project_name.camelcase
+      def project_class = project_namespaced_class.split("::").last
+
+      def project_namespaced_class = project_name.camelcase
 
       def project_label = project_name.titleize
 
-      def project_levels = project_class.split("::").size - 1
+      def project_levels = project_namespaced_class.split("::").size - 1
 
       def project_path = project_name.snakecase
 

data/lib/rubysmith/configuration/defaults.yml

@@ -6,6 +6,7 @@
 :build:
   :amazing_print: true
   :bundler_leak: true
+  :caliber: true
   :circle_ci: false
   :citation: true
   :cli: false
@@ -27,7 +28,6 @@
   :reek: true
   :refinements: true
   :rspec: true
-  :rubocop: true
   :security: true
   :setup: true
   :simple_cov: true

data/lib/rubysmith/renderers/erb.rb

@@ -7,7 +7,7 @@ module Rubysmith
     # Renders ERB templates as fully functional files.
     class ERB
       def initialize configuration,
-                     scope: Renderers::Namespace.new(configuration.project_class),
+                     scope: Renderers::Namespace.new(configuration.project_namespaced_class),
                      client: ::ERB
         @configuration = configuration
         @scope = scope

data/lib/rubysmith/templates/%project_name%/.gitignore.erb

@@ -1,7 +1,4 @@
 .bundle
-<% if configuration.build_rubocop %>
-  .rubocop-http*
-<% end %>
 <% if configuration.build_yard %>
   .yardoc
 <% end %>

data/lib/rubysmith/templates/%project_name%/.rubocop.yml.erb

@@ -1,9 +1,2 @@
-inherit_from:
-  - https://raw.githubusercontent.com/bkuhlmann/code_quality/main/configurations/rubocop/ruby.yml
-<% if configuration.build_rake %>
-  - https://raw.githubusercontent.com/bkuhlmann/code_quality/main/configurations/rubocop/rake.yml
-<% end %>
-  - https://raw.githubusercontent.com/bkuhlmann/code_quality/main/configurations/rubocop/performance.yml
-<% if configuration.build_rspec %>
-  - https://raw.githubusercontent.com/bkuhlmann/code_quality/main/configurations/rubocop/rspec.yml
-<% end %>
+inherit_gem:
+  caliber: config/all.yml

data/lib/rubysmith/templates/%project_name%/Gemfile.erb

@@ -3,7 +3,7 @@ ruby File.read(".ruby-version").strip
 source "https://rubygems.org"
 
 <% if configuration.build_refinements %>
-  gem "refinements", "~> 9.1"
+  gem "refinements", "~> 9.2"
 <% end %>
 <% if configuration.build_zeitwerk %>
   gem "zeitwerk", "~> 2.5"
@@ -13,23 +13,18 @@ group :code_quality do
   <% if configuration.build_bundler_leak %>
     gem "bundler-leak", "~> 0.2"
   <% end %>
+  <% if configuration.build_caliber %>
+    gem "caliber", "~> 0.1"
+  <% end %>
   <% if configuration.build_dead_end %>
-    gem "dead_end", "~> 3.0"
+    gem "dead_end", "~> 3.1"
   <% end %>
   <% if configuration.build_git && configuration.build_git_lint %>
-    gem "git-lint", "~> 3.0"
+    gem "git-lint", "~> 3.2"
   <% end %>
   <% if configuration.build_reek %>
     gem "reek", "~> 6.1"
   <% end %>
-  <% if configuration.build_rubocop %>
-    gem "rubocop", "~> 1.25"
-    gem "rubocop-performance", "~> 1.12"
-    gem "rubocop-rake", "~> 0.6"
-  <% end %>
-  <% if configuration.build_rspec && configuration.build_rubocop %>
-    gem "rubocop-rspec", "~> 2.6"
-  <% end %>
   <% if configuration.build_simple_cov %>
     gem "simplecov", "~> 0.21"
   <% end %>
@@ -43,7 +38,7 @@ group :development do
     gem "rake", "~> 13.0"
   <% end %>
   <% if configuration.markdown? %>
-    gem "tocer", "~> 13.0"
+    gem "tocer", "~> 13.2"
   <% end %>
   <% if configuration.build_yard %>
     gem "yard", "~> 0.9"
@@ -55,7 +50,7 @@ group :test do
     gem "guard-rspec", "~> 4.7", require: false
   <% end %>
   <% if configuration.build_rspec %>
-    gem "rspec", "~> 3.10"
+    gem "rspec", "~> 3.11"
   <% end %>
 end
 

data/lib/rubysmith/templates/%project_name%/README.adoc.erb

@@ -4,15 +4,6 @@
 
 = <%= configuration.project_label %>
 
-<% if configuration.build_rubocop %>
-[link=https://www.alchemists.io/projects/code_quality]
-image::https://img.shields.io/badge/code_style-alchemists-brightgreen.svg[Alchemists Style Guide]
-<% end %>
-<% if configuration.build_circle_ci %>
-[link=https://circleci.com/gh/<%= configuration.git_hub_user %>/<%= configuration.project_name %>]
-image::https://circleci.com/gh/<%= configuration.git_hub_user %>/<%= configuration.project_name %>.svg?style=svg[Circle CI Status]
-<% end %>
-
 toc::[]
 
 == Features

data/lib/rubysmith/templates/%project_name%/README.md.erb

@@ -1,12 +1,5 @@
 # <%= configuration.project_label %>
 
-<% if configuration.build_rubocop %>
-[![Alchemists Style Guide](https://img.shields.io/badge/code_style-alchemists-brightgreen.svg)](https://www.alchemists.io/projects/code_quality)
-<% end %>
-<% if configuration.build_circle_ci %>
-[![Circle CI Status](https://circleci.com/gh/<%= configuration.git_hub_user %>/<%= configuration.project_name %>.svg?style=svg)](https://circleci.com/gh/<%= configuration.git_hub_user %>/<%= configuration.project_name %>)
-<% end %>
-
 <!-- Tocer[start]: Auto-generated, don't remove. -->
 <!-- Tocer[finish]: Auto-generated, don't remove. -->
 

data/lib/rubysmith/templates/%project_name%/Rakefile.erb

@@ -12,7 +12,7 @@ require "bundler/setup"
 <% if configuration.build_rspec %>
   require "rspec/core/rake_task"
 <% end %>
-<% if configuration.build_rubocop %>
+<% if configuration.build_caliber %>
   require "rubocop/rake_task"
 <% end %>
 <% if configuration.build_yard %>
@@ -28,7 +28,7 @@ require "bundler/setup"
 <% if configuration.build_rspec %>
   RSpec::Core::RakeTask.new :spec
 <% end %>
-<% if configuration.build_rubocop %>
+<% if configuration.build_caliber %>
   RuboCop::RakeTask.new
 <% end %>
 
@@ -39,6 +39,6 @@ require "bundler/setup"
 <% end %>
 
 desc "Run code quality checks"
-task code_quality: %i[<% if configuration.build_bundler_leak %>bundle:leak<% end %> <% if configuration.build_git && configuration.build_git_lint %>git_lint<% end %> <% if configuration.build_reek %>reek<% end %> <% if configuration.build_rubocop %>rubocop<% end %>]
+task code_quality: %i[<% if configuration.build_bundler_leak %>bundle:leak<% end %> <% if configuration.build_git && configuration.build_git_lint %>git_lint<% end %> <% if configuration.build_reek %>reek<% end %> <% if configuration.build_caliber %>rubocop<% end %>]
 
 task default: %i[code_quality <% if configuration.build_rspec %>spec<% end %>]

data/rubysmith.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "rubysmith"
-  spec.version = "1.3.0"
+  spec.version = "2.0.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://github.com/bkuhlmann/rubysmith"
@@ -27,11 +27,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency "milestoner", "~> 13.0"
   spec.add_dependency "pastel", "~> 0.8"
   spec.add_dependency "pragmater", "~> 10.0"
-  spec.add_dependency "refinements", "~> 9.1"
+  spec.add_dependency "refinements", "~> 9.2"
   spec.add_dependency "rubocop", "~> 1.25"
   spec.add_dependency "runcom", "~> 8.2"
   spec.add_dependency "spek", "~> 0.0"
-  spec.add_dependency "tocer", "~> 13.0"
+  spec.add_dependency "tocer", "~> 13.2"
   spec.add_dependency "zeitwerk", "~> 2.5"
 
   spec.bindir = "exe"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubysmith
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   lkHilIrX69jq8wMPpBhlaw2mRmeSL50Wv5u6xVBvOHhXFSP1crXM95vfLhLyRYod
   W2A=
   -----END CERTIFICATE-----
-date: 2022-02-06 00:00:00.000000000 Z
+date: 2022-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-container
@@ -106,14 +106,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.1'
+        version: '9.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.1'
+        version: '9.2'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -162,14 +162,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.2'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -200,6 +200,7 @@ files:
 - lib/rubysmith.rb
 - lib/rubysmith/builder.rb
 - lib/rubysmith/builders/bundler.rb
+- lib/rubysmith/builders/caliber.rb
 - lib/rubysmith/builders/circle_ci.rb
 - lib/rubysmith/builders/console.rb
 - lib/rubysmith/builders/core.rb
@@ -216,7 +217,6 @@ files:
 - lib/rubysmith/builders/reek.rb
 - lib/rubysmith/builders/rspec/context.rb
 - lib/rubysmith/builders/rspec/helper.rb
-- lib/rubysmith/builders/rubocop.rb
 - lib/rubysmith/builders/setup.rb
 - lib/rubysmith/builders/version.rb
 - lib/rubysmith/cli/actions/build.rb
@@ -297,7 +297,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A command line interface for smithing Ruby projects.