rubysmith 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d1193bec845f74c3b5a092500c1cd97c2e8379658e12407cbf504eac771ff3f
-  data.tar.gz: 2677a9607b478cd405094865ee4c0ce6ace2bd301ef07c9b45fc5457189e6c89
+  metadata.gz: de17a0e1a14656faf3c41d6eb187aaa58acd051e1a320b6e8e42c759c8cfc3e8
+  data.tar.gz: bee0b69eb4affb36042197ac9b7dc0d138b847a229bce03e1a6ac5e53c608192
 SHA512:
-  metadata.gz: c541f76c356d43bc16ea27bd8f4c4b9f09ee0db5849d6ab4d43198b1734a3f7572785deee37d997ef40644ce636688ea573dedc96a9ae0d78ac1b4cb09c10160
-  data.tar.gz: eac33f82f80182dd1dc04f9f1bf20ad93daa1d3c4101087c845ba82b0c7a2ab5d58b3ad95d620a07ad52b7d8e441c9aefcd8059b799f1b0a4c667333faa6143c
+  metadata.gz: 1a548b6f39715b29606ecc3bfe7a9a211b8b5f43c8adf86f68956e4d35cbf678062178106d1932f78a1173a64482b6b0e83962e923700723f18889e082ac9d13
+  data.tar.gz: aeea9f7e1e4e9df57f8c118f5c931cde45a071d4c261d6632e03def688b6aba4d9e408c92a4dd68a875d55b99f39928a000b76706d27fa92fa4dc372b3682941

data/README.adoc

@@ -113,6 +113,7 @@ BUILD OPTIONS:
       --[no-]setup                         Add setup script. Default: true.
       --[no-]simple_cov                    Add SimpleCov gem. Default: true.
       --[no-]versions                      Add version history. Default: true.
+      --[no-]yard                          Add Yard gem. Default: false.
       --[no-]zeitwerk                      Add Zeitwerk gem. Default: true.
 ....
 
@@ -288,7 +289,7 @@ 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
+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.
@@ -309,6 +310,13 @@ analysis of what your quality of code is for the project.
 The `--versions` option allows you add a `VERSIONS` file to your project to provide details about
 all published versions of your project.
 
+==== YARD
+
+The `--yard` option allows you add the link:https://yardoc.org/[YARD] gem to your project so you can
+automate the generation of project documentation. Once your project is built, you can use `rake
+yard` to build documentation into the `doc/yard` folder. This folder is ignored by Git by default.
+Additional customization is possible via the YARD Rake task as found in the `Rakefile`.
+
 ==== Zeitwerk
 
 The `--zeitwerk` option allows you add the link:https://github.com/fxn/zeitwerk[Zeitwerk] gem to
@@ -376,6 +384,7 @@ variables. The default configuration is as follows:
   :setup: true
   :simple_cov: true
   :versions: true
+  :yard: false
   :zeitwerk: true
 :citation:
   :affiliation:
@@ -457,10 +466,9 @@ custom values as desired. The URL is the only value that can't be automatically
 
 ==== Build
 
-All build options can only be  `true` or `false` booleans. Should you want a different configuration
-than what is enabled/disabled by default, you'll want to customize these options as you see fit.
-When changing build options, they will dynamically show up when viewing usage (i.e. `rubysmith
---help`). All of these options are explained in greater detail above.
+All build options accept booleans values only and can be customized as desired. When changing your
+build options, they will dynamically render when display usage (i.e. `rubysmith --help`). All of
+these options are explained in greater detail above.
 
 ==== Citations
 
@@ -490,10 +498,10 @@ Follow the above links to learn more about each extension's gem configuration.
 
 ==== GitHub
 
-Your GitHub user is whatever handle you setup when you 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.
+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.
 
 ==== License
 
@@ -506,7 +514,7 @@ license are available:
 
 ==== Project
 
-There are two many categories within this section: URLs and version. The URLs allow you to link to
+There are two 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/git/ignore.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+
+module Rubysmith
+  module Builders
+    module Git
+      # Builds Git repository directory and file ignore configuration.
+      class Ignore
+        using Refinements::Structs
+
+        def self.call(...) = new(...).call
+
+        def initialize configuration, builder: Builder
+          @configuration = configuration
+          @builder = builder
+        end
+
+        def call
+          return configuration unless configuration.build_git
+
+          builder.call(configuration.merge(template_path: "%project_name%/.gitignore.erb"))
+                 .render
+                 .replace("  ", "")
+
+          configuration
+        end
+
+        private
+
+        attr_reader :configuration, :builder
+      end
+    end
+  end
+end

data/lib/rubysmith/builders/rake.rb

@@ -23,6 +23,7 @@ module Rubysmith
                .replace(/\[\s+/, "[")
                .replace(/\s+\]/, "]")
                .replace("  ", "")
+               .replace("task.", "  task.")
                .replace(/\n+(?=require)/, "\n")
                .replace(/\n{2,}/, "\n\n")
 

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

@@ -13,6 +13,7 @@ module Rubysmith
           Builders::Documentation::License,
           Builders::Documentation::Version,
           Builders::Git::Setup,
+          Builders::Git::Ignore,
           Builders::Bundler,
           Builders::Rake,
           Builders::Console,

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

@@ -266,6 +266,15 @@ module Rubysmith
           end
         end
 
+        def add_yard
+          client.on(
+            "--[no-]yard",
+            "Add Yard gem. #{default __method__}."
+          ) do |value|
+            configuration.merge! build_yard: value
+          end
+        end
+
         def add_zeitwerk
           client.on(
             "--[no-]zeitwerk",

data/lib/rubysmith/configuration/content.rb

@@ -12,9 +12,12 @@ module Rubysmith
     Content = Struct.new(
       :action_build,
       :action_config,
+      :action_edit,
       :action_help,
+      :action_install,
       :action_publish,
       :action_version,
+      :action_view,
       :author_email,
       :author_family_name,
       :author_given_name,
@@ -47,6 +50,7 @@ module Rubysmith
       :build_setup,
       :build_simple_cov,
       :build_versions,
+      :build_yard,
       :build_zeitwerk,
       :citation_affiliation,
       :citation_message,

data/lib/rubysmith/configuration/defaults.yml

@@ -32,6 +32,7 @@
   :setup: true
   :simple_cov: true
   :versions: true
+  :yard: false
   :zeitwerk: true
 :citation:
   :affiliation:

data/lib/rubysmith/identity.rb

@@ -4,7 +4,7 @@ module Rubysmith
   module Identity
     NAME = "rubysmith"
     LABEL = "Rubysmith"
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
     VERSION_LABEL = "#{LABEL} #{VERSION}".freeze
     SUMMARY = "A command line interface for smithing Ruby projects."
   end

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

@@ -0,0 +1,11 @@
+.bundle
+<% if configuration.build_rubocop %>
+  .rubocop-http*
+<% end %>
+<% if configuration.build_yard %>
+  .yardoc
+<% end %>
+<% if configuration.build_yard %>
+  doc/yard
+<% end %>
+tmp

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

@@ -36,12 +36,18 @@ group :code_quality do
 end
 
 group :development do
+  <% if configuration.build_yard && configuration.ascii_doc? %>
+    gem "asciidoctor", "~> 2.0"
+  <% end %>
   <% if configuration.build_rake %>
     gem "rake", "~> 13.0"
   <% end %>
   <% if configuration.markdown? %>
     gem "tocer", "~> 13.0"
   <% end %>
+  <% if configuration.build_yard %>
+    gem "yard", "~> 0.9"
+  <% end %>
 end
 
 group :test do

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

@@ -15,6 +15,9 @@ require "bundler/setup"
 <% if configuration.build_rubocop %>
   require "rubocop/rake_task"
 <% end %>
+<% if configuration.build_yard %>
+  require "yard"
+<% end %>
 
 <% if configuration.build_bundler_leak %>
   Bundler::Plumber::Task.new
@@ -29,6 +32,12 @@ require "bundler/setup"
   RuboCop::RakeTask.new
 <% end %>
 
+<% if configuration.build_yard %>
+  YARD::Rake::YardocTask.new do |task|
+    task.options = ["--title", "<%= configuration.project_label %>", "--output-dir", "doc/yard"]
+  end
+<% 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 %>]
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubysmith
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   lkHilIrX69jq8wMPpBhlaw2mRmeSL50Wv5u6xVBvOHhXFSP1crXM95vfLhLyRYod
   W2A=
   -----END CERTIFICATE-----
-date: 2022-01-01 00:00:00.000000000 Z
+date: 2022-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-container
@@ -194,6 +194,7 @@ files:
 - lib/rubysmith/builders/documentation/readme.rb
 - lib/rubysmith/builders/documentation/version.rb
 - lib/rubysmith/builders/git/commit.rb
+- lib/rubysmith/builders/git/ignore.rb
 - lib/rubysmith/builders/git/setup.rb
 - lib/rubysmith/builders/git_hub.rb
 - lib/rubysmith/builders/guard.rb
@@ -230,6 +231,7 @@ files:
 - lib/rubysmith/templates/%project_name%/.circleci/config.yml.erb
 - lib/rubysmith/templates/%project_name%/.github/ISSUE_TEMPLATE.md.erb
 - lib/rubysmith/templates/%project_name%/.github/PULL_REQUEST_TEMPLATE.md.erb
+- lib/rubysmith/templates/%project_name%/.gitignore.erb
 - lib/rubysmith/templates/%project_name%/.reek.yml.erb
 - lib/rubysmith/templates/%project_name%/.rubocop.yml.erb
 - lib/rubysmith/templates/%project_name%/.ruby-version.erb