rubysmith 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c642fd1a721b8b3255818b19493d421a08edbe62039f64dea424c15397a7474
-  data.tar.gz: cd67f5bed50ab0c79febb6d50f5e2903ee4df094604cf93dc6f0f463f5e64004
+  metadata.gz: f7265bb4446630cf2295f79355fa890b515bc277271b51bdefb0130d35fb3502
+  data.tar.gz: f071cc6e0299ba74bf8515391857e54641c7d7bf9509a2a601059867fa3e69b8
 SHA512:
-  metadata.gz: 42ae38a68784b2570bf5351d7a699e98db2b3edc1262ae4a6dce60690baabe1219587ff97c6cf8ff341381817061faff077d4a32befd8e1cffc82545379f3a72
-  data.tar.gz: 5c2d97efa35f0a9c9bdfb4affc417fbef45af8d17fc9cd4bf3a1546ef4dbd3520736ef53bff67bfb465c836162f5195634b7ce8db2004964cc5b1c3237192350
+  metadata.gz: 7c3f3db7a06f7388fef2df0b4bf4df08d0b0baffd98e3bef05a9b3fc5e1cf3d21037f0cdef2b13b9cb4db0179c64c21ddfbe519fadb7f0003442a0c4b9a62296
+  data.tar.gz: 0d6a18e00d270fc3d520cfd1799c233e95a78340334f27788cb2ca876bd92c448e6c483da57a3312cc6e5735a38d0feec499adfdb2c872f4fb3466c0ae853e6a

data/README.adoc

@@ -56,8 +56,6 @@ toc::[]
 
 == Setup
 
-=== Production
-
 To install, run:
 
 [source,bash]
@@ -65,24 +63,6 @@ To install, run:
 gem install rubysmith
 ----
 
-=== Development
-
-To contribute, run:
-
-[source,bash]
-----
-git clone https://github.com/bkuhlmann/rubysmith.git
-cd rubysmith
-bin/setup
-----
-
-You can also use the IRB console for direct access to all objects:
-
-[source,bash]
-----
-bin/console
-----
-
 == Usage
 
 === Command Line Interface (CLI)
@@ -91,15 +71,12 @@ From the command line, type: `rubysmith --help`
 
 ....
 USAGE:
-  -c, --config ACTION                      Manage gem configuration: edit or view.
-  -b, --build NAME [options]               Build new gem.
   -v, --version                            Show gem version.
   -h, --help                               Show this message.
+  -c, --config ACTION                      Manage gem configuration: edit or view.
+  -b, --build NAME [options]               Build new project.
 
 BUILD OPTIONS:
-      --[no-]bundler-audit                 Add Bundler Audit.
-      --[no-]console                       Add console script.
-      --[no-]documentation                 Add documentation.
       --[no-]git                           Add Git.
       --[no-]git-lint                      Add Git Lint.
       --[no-]guard                         Add Guard.
@@ -109,6 +86,10 @@ BUILD OPTIONS:
       --[no-]rubocop                       Add Rubocop.
       --[no-]setup                         Add setup script.
       --[no-]simple_cov                    Add SimpleCov.
+      --min                                Use minimum/no options.
+      --[no-]bundler-audit                 Add Bundler Audit.
+      --[no-]console                       Add console script.
+      --[no-]documentation                 Add documentation.
 ....
 
 === Building
@@ -122,16 +103,28 @@ rubysmith --build demo
 ----
 
 Running the above will generate a new `demo` Ruby project with all options enabled. Should you wish
-to disable certain options when building projects, you can prefix options with `--no-*`. Example:
+to disable specific options, you can use the `--no-*` prefix. Example:
 
 [source,bash]
 ----
 rubysmith --build demo --no-pry --no-guard
 ----
 
-Should you wish to have certain options enabled/disabled _every time_ you build a new Ruby project,
-then you can edit your global configuration for making these settings permanent (see below for
-details).
+With the above example, both Pry and Guard support would have been disabled when building the `demo`
+project. Taking this a step further, you can also use the `--min` option to generate a project with
+bare minimum of options. Example:
+
+[source,bash]
+----
+rubysmith --build demo --min
+----
+
+The above is essentially the same as building with _all_ options disabled. This is handy in
+situations where you need to quickly script something up for sharing with others yet still want to
+avoid using a Bundler Inline script so gem dependencies are not installed each time the code is run.
+
+To have specific options enabled/disabled _every time_ you build a new Ruby project, you can edit
+your global configuration for making these settings permanent (see below for details).
 
 === Configuration
 
@@ -162,6 +155,7 @@ The default configuration is as follows:
   :git: true
   :git_lint: true
   :guard: true
+  :minimum: false
   :pry: true
   :reek: true
   :rspec: true
@@ -185,6 +179,24 @@ The default configuration is as follows:
 Feel free to take this default configuration, modify, and save as your own custom
 `configuration.yml`.
 
+== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/rubysmith.git
+cd rubysmith
+bin/setup
+----
+
+You can also use the IRB console for direct access to all objects:
+
+[source,bash]
+----
+bin/console
+----
+
 == Tests
 
 To test, run:

data/lib/rubysmith/builders/bundler.rb

@@ -20,8 +20,11 @@ module Rubysmith
       def call
         builder.call(realm.with(template_path: "%project_name%/Gemfile.erb"))
                .render
-               .replace(/"\n\s{2,}/, "\"\n")
+               .replace(/\n\s*group/, "\n\ngroup")
                .replace(/\n\s*gem/, "\n  gem")
+               .replace(/\s{4}\n/, "")
+               .replace("  end", "end")
+               .replace(/\n{1,}\Z/, "\n")
         Dir.chdir(realm.project_root) { runner.start %w[install --quiet] }
         nil
       end

data/lib/rubysmith/builders/rubocop.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 require "rubocop"
-require "stringio"
+require "refinements/ios"
 
 module Rubysmith
   module Builders
     # Builds project skeleton Rubocop code quality support.
     class Rubocop
+      using Refinements::IOs
+
       def self.call realm, builder: Builder
         new(realm, builder: builder).call
       end
@@ -33,10 +35,7 @@ module Rubysmith
       attr_reader :realm, :builder, :runner
 
       def auto_correct
-        backup = $stdout
-        $stdout = StringIO.new
-        runner.run ["--auto-correct", "--format", "quiet", realm.project_root.to_s]
-        $stdout = backup
+        STDOUT.squelch { runner.run ["--auto-correct", realm.project_root.to_s] }
       end
     end
   end

data/lib/rubysmith/cli/defaults.yml

@@ -14,6 +14,7 @@
   :git: true
   :git_lint: true
   :guard: true
+  :minimum: false
   :pry: true
   :reek: true
   :rspec: true

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

@@ -24,6 +24,12 @@ module Rubysmith
 
         attr_reader :client, :options
 
+        def add_minimum
+          client.on "--min", "Use minimum/no options." do |value|
+            options[:build_minimum] = value
+          end
+        end
+
         def add_bundler_audit
           client.on "--[no-]bundler-audit", "Add Bundler Audit." do |value|
             options[:build_bundler_audit] = value

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

@@ -3,27 +3,34 @@
 module Rubysmith
   module CLI
     module Processors
-      # Order is important.
-      BUILDERS = [
-        Builders::Core,
-        Builders::Documentation,
-        Builders::Git::Setup,
-        Builders::Bundler,
-        Builders::Rake,
-        Builders::Console,
-        Builders::Setup,
-        Builders::Guard,
-        Builders::Reek,
-        Builders::RSpec::Context,
-        Builders::RSpec::Helper,
-        Builders::Pragma,
-        Builders::Rubocop,
-        Builders::Git::Commit
-      ].freeze
-
       # Handles the Command Line Interface (CLI) for building of a project skeleton.
       class Build
-        def initialize builders: BUILDERS
+        # Order is important.
+        MINIMUM = [
+          Builders::Core,
+          Builders::Bundler,
+          Builders::Pragma
+        ].freeze
+
+        # Order is important.
+        MAXIMUM = [
+          Builders::Core,
+          Builders::Documentation,
+          Builders::Git::Setup,
+          Builders::Bundler,
+          Builders::Rake,
+          Builders::Console,
+          Builders::Setup,
+          Builders::Guard,
+          Builders::Reek,
+          Builders::RSpec::Context,
+          Builders::RSpec::Helper,
+          Builders::Pragma,
+          Builders::Rubocop,
+          Builders::Git::Commit
+        ].freeze
+
+        def initialize builders: MAXIMUM
           @builders = builders
         end
 

data/lib/rubysmith/cli/shell.rb

@@ -11,7 +11,8 @@ module Rubysmith
 
       PROCESSORS = {
         config: Processors::Config.new,
-        build: Processors::Build.new
+        build_minimum: Processors::Build.new(builders: Processors::Build::MINIMUM),
+        build_maximum: Processors::Build.new
       }.freeze
 
       def initialize parser: Parsers::Assembler.new, processors: PROCESSORS
@@ -22,13 +23,16 @@ module Rubysmith
       def call arguments = []
         parse arguments
 
+        # rubocop:disable Style/MethodCallWithArgsParentheses
         case options
           in config: action, **remainder then config action
-          in build:, **remainder then build options.rekey(build: :project_name).merge now: Time.now
+          in build_minimum: true, **remainder then build(:build_minimum, options)
+          in build:, **remainder then build(:build_maximum, options)
           in version:, **remainder then puts version
           in help:, **remainder then usage
           else usage
         end
+        # rubocop:enable Style/MethodCallWithArgsParentheses
       end
 
       private
@@ -45,8 +49,8 @@ module Rubysmith
         processors.fetch(__method__).call action
       end
 
-      def build settings
-        processors.fetch(__method__).call settings
+      def build kind, settings
+        processors.fetch(kind).call settings.rekey(build: :project_name).merge(now: Time.now)
       end
 
       def options

data/lib/rubysmith/identity.rb

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

data/lib/rubysmith/realm.rb

@@ -16,6 +16,7 @@ module Rubysmith
     now
     documentation_format
     documentation_license
+    build_minimum
     build_bundler_audit
     build_console
     build_documentation

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

@@ -1,33 +1,35 @@
 source "https://rubygems.org"
 
-group :development do
-  <% if realm.build_bundler_audit %>
-    gem "bundler-audit", "~> 0.7"
-  <% end %>
-  <% if realm.build_git && realm.build_git_lint %>
-    gem "git-lint", "~> 1.0"
-  <% end %>
-  <% if realm.build_guard %>
-    gem "guard-rspec", "~> 4.7"
-  <% end %>
-  <% if realm.build_pry %>
-    gem "pry", "~> 0.13"
-    gem "pry-byebug", "~> 3.9"
-  <% end %>
-  gem "rake", "~> 13.0"
-  <% if realm.build_reek %>
-    gem "reek", "~> 6.0"
-  <% end %>
-  <% if realm.build_rspec %>
-    gem "rspec", "~> 3.9"
-  <% end %>
-  <% if realm.build_rubocop %>
-    gem "rubocop", "~> 0.92"
-    gem "rubocop-performance", "~> 1.8"
-    gem "rubocop-rake", "~> 0.5"
-    gem "rubocop-rspec", "~> 1.43"
-  <% end %>
-  <% if realm.build_simple_cov %>
-    gem "simplecov", "~> 0.19"
-  <% end %>
-end
+<% unless realm.build_minimum %>
+  group :development do
+    <% if realm.build_bundler_audit %>
+      gem "bundler-audit", "~> 0.7"
+    <% end %>
+    <% if realm.build_git && realm.build_git_lint %>
+      gem "git-lint", "~> 1.0"
+    <% end %>
+    <% if realm.build_guard %>
+      gem "guard-rspec", "~> 4.7"
+    <% end %>
+    <% if realm.build_pry %>
+      gem "pry", "~> 0.13"
+      gem "pry-byebug", "~> 3.9"
+    <% end %>
+    gem "rake", "~> 13.0"
+    <% if realm.build_reek %>
+      gem "reek", "~> 6.0"
+    <% end %>
+    <% if realm.build_rspec %>
+      gem "rspec", "~> 3.9"
+    <% end %>
+    <% if realm.build_rubocop %>
+      gem "rubocop", "~> 0.92"
+      gem "rubocop-performance", "~> 1.8"
+      gem "rubocop-rake", "~> 0.5"
+      gem "rubocop-rspec", "~> 1.43"
+    <% end %>
+    <% if realm.build_simple_cov %>
+      gem "simplecov", "~> 0.19"
+    <% end %>
+  end
+<% end %>

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

@@ -26,11 +26,11 @@ bin/setup
 <% end %>
 
 == Usage
-<% if realm.build_console %>
 
-=== Console
+== Development
+<% if realm.build_console %>
 
-To use the IRB console to invesitage and/or experiment with all project objects, run:
+You can also use the IRB console for direct access to all objects:
 
 [source,bash]
 ----

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

@@ -20,11 +20,11 @@ To set up the project, run:
 <% end %>
 
 ## Usage
-<% if realm.build_console %>
 
-### Console
+## Development
+<% if realm.build_console %>
 
-To use the IRB console to invesitage and/or experiment with all project objects, run:
+You can also use the IRB console for direct access to all objects:
 
     bin/console
 <% end %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubysmith
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
   QWc=
   -----END CERTIFICATE-----
-date: 2020-10-04 00:00:00.000000000 Z
+date: 2020-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pragmater
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.10'
+        version: '7.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.10'
+        version: '7.11'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement