gemsmith 21.7.0 → 21.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 640d17bff5a491317535eddaa974bdb07a64ed346d160706a22dc61704f79346
-  data.tar.gz: aae0e3c20ccba22dd0c7a82e5e765b92f067d6d6b1427c361a5c1ad0d534b012
+  metadata.gz: c3b27c0e32cbffc4cce574fa8fa1ba16afbd6e04d77e1bc86e41d631afd69429
+  data.tar.gz: 671c7adebf43e417a764e86bb4d9322b560e6b7825999cb6fe87bc3cda06709d
 SHA512:
-  metadata.gz: 9be8c650172ac7fdaf478eb6e8468f394bc3a43c7a6cf93f62e040cc92d6e5b8823f339f7a82bbefc8bbe84745a8ad8475b589f21552976116a7af90d414a65d
-  data.tar.gz: be0e134585b8a77faeb8c109b0c23779a4b5154ca3a7c3efcab772582c9583a6f0c77422339919aa97d414da042bdae24b77e0f9274bb95fd22fe7ec8f7c147b
+  metadata.gz: 6c44e884b4f7cb1f15c4a864c0c5f9f06b794ceeda21a38322344d41d17a5e3bacde3815164f1e0ebd2d66519e40abde2af0514eeedf03eee7e6977cbd430eaa
+  data.tar.gz: e6b6e9c6f456a5701de8460b1f93b5f9ee93008557456a9e0f443b971c07902584bb46850829e7df507f15bb0fd6ae88f1233079700bd5afeedaf2846260a2e4

data/gemsmith.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "gemsmith"
-  spec.version = "21.7.0"
+  spec.version = "21.8.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/gemsmith"
@@ -28,11 +28,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency "core", "~> 1.0"
   spec.add_dependency "dry-monads", "~> 1.6"
   spec.add_dependency "dry-schema", "~> 1.13"
-  spec.add_dependency "etcher", "~> 1.3"
+  spec.add_dependency "etcher", "~> 1.5"
   spec.add_dependency "infusible", "~> 3.5"
-  spec.add_dependency "milestoner", "~> 17.7"
+  spec.add_dependency "milestoner", "~> 17.8"
   spec.add_dependency "refinements", "~> 12.1"
-  spec.add_dependency "rubysmith", "~> 6.7"
+  spec.add_dependency "rubysmith", "~> 6.8"
   spec.add_dependency "runcom", "~> 11.0"
   spec.add_dependency "sod", "~> 0.8"
   spec.add_dependency "spek", "~> 3.0"

data/lib/gemsmith/builders/bundler.rb

@@ -5,16 +5,9 @@ require "refinements/struct"
 module Gemsmith
   module Builders
     # Builds project skeleton with Gemfile configuration.
-    class Bundler
+    class Bundler < Rubysmith::Builders::Abstract
       using Refinements::Struct
 
-      def self.call(...) = new(...).call
-
-      def initialize configuration, builder: Rubysmith::Builder
-        @configuration = configuration
-        @builder = builder
-      end
-
       def call
         builder.call(configuration.merge(template_path: "%project_name%/Gemfile.erb"))
                .insert_after("source", "\ngemspec\n")
@@ -25,10 +18,6 @@ module Gemsmith
 
         configuration
       end
-
-      private
-
-      attr_reader :configuration, :builder
     end
   end
 end

data/lib/gemsmith/builders/circle_ci.rb

@@ -5,16 +5,9 @@ require "refinements/struct"
 module Gemsmith
   module Builders
     # Builds project skeleton Circle CI configuration.
-    class CircleCI
+    class CircleCI < Rubysmith::Builders::Abstract
       using Refinements::Struct
 
-      def self.call(...) = new(...).call
-
-      def initialize configuration, builder: Rubysmith::Builder
-        @configuration = configuration
-        @builder = builder
-      end
-
       def call
         return configuration unless configuration.build_circle_ci
 
@@ -27,8 +20,6 @@ module Gemsmith
 
       private
 
-      attr_reader :configuration, :builder
-
       def project_name = configuration.project_name
     end
   end

data/lib/gemsmith/builders/cli.rb

@@ -5,16 +5,9 @@ require "refinements/struct"
 module Gemsmith
   module Builders
     # Builds project skeleton CLI templates.
-    class CLI
+    class CLI < Rubysmith::Builders::Abstract
       using Refinements::Struct
 
-      def self.call(...) = new(...).call
-
-      def initialize configuration, builder: Rubysmith::Builder
-        @configuration = configuration
-        @builder = builder
-      end
-
       def call
         return configuration unless configuration.build_cli
 
@@ -24,8 +17,6 @@ module Gemsmith
 
       private
 
-      attr_reader :configuration, :builder
-
       def render = private_methods.sort.grep(/render_/).each { |method| __send__ method }
 
       def render_exe

data/lib/gemsmith/builders/documentation/readme.rb

@@ -6,20 +6,15 @@ module Gemsmith
   module Builders
     module Documentation
       # Builds project skeleton README documentation.
-      class Readme
+      class Readme < Rubysmith::Builders::Documentation::Readme
         using Refinements::Struct
 
-        def self.call(...) = new(...).call
-
-        def initialize configuration, builder: Rubysmith::Builder
-          @configuration = configuration
-          @builder = builder
-        end
-
         def call
           return configuration unless configuration.build_readme
 
+          super
           builder.call(configuration.merge(template_path: "%project_name%/README.#{kind}.erb"))
+                 .replace(/Setup.+Usage/m, setup)
                  .replace("Rubysmith", "Gemsmith")
                  .replace("rubysmith", "gemsmith")
 
@@ -28,9 +23,118 @@ module Gemsmith
 
         private
 
-        attr_reader :configuration, :builder
+        def setup = kind == "adoc" ? ascii_setup : markdown_setup
+
+        def ascii_setup = configuration.build_security ? ascii_secure : ascii_insecure
+
+        def ascii_secure
+          project_name = configuration.project_name
+
+          <<~CONTENT.strip
+            Setup
+
+            To install _with_ security, run:
+
+            [source,bash]
+            ----
+            # 💡 Skip this line if you already have the public certificate installed.
+            gem cert --add <(curl --compressed --location #{configuration.organization_url}/gems.pem)
+            gem install #{project_name} --trust-policy HighSecurity
+            ----
+
+            To install _without_ security, run:
+
+            [source,bash]
+            ----
+            gem install #{project_name}
+            ----
+
+            #{ascii_common}
+          CONTENT
+        end
+
+        def ascii_insecure
+          <<~CONTENT.strip
+            Setup
+
+            To install, run:
+
+            [source,bash]
+            ----
+            gem install #{configuration.project_name}
+            ----
+
+            #{ascii_common}
+          CONTENT
+        end
+
+        def ascii_common
+          <<~CONTENT.strip
+            You can also add the gem directly to your project:
+
+            [source,bash]
+            ----
+            bundle add #{configuration.project_name}
+            ----
+
+            Once the gem is installed, you only need to require it:
+
+            [source,ruby]
+            ----
+            require "#{configuration.project_path}"
+            ----
 
-        def kind = configuration.documentation_format
+            == Usage
+          CONTENT
+        end
+
+        def markdown_setup = configuration.build_security ? markdown_secure : markdown_insecure
+
+        def markdown_secure
+          project_name = configuration.project_name
+
+          <<~CONTENT.strip
+            Setup
+
+            To install _with_ security, run:
+
+                # 💡 Skip this line if you already have the public certificate installed.
+                gem cert --add <(curl --compressed --location #{configuration.organization_url}/gems.pem)
+                gem install #{project_name} --trust-policy HighSecurity
+
+            To install _without_ security, run:
+
+                gem install #{project_name}
+
+            #{markdown_common}
+          CONTENT
+        end
+
+        def markdown_insecure
+          <<~CONTENT.strip
+            Setup
+
+            To install, run:
+
+                gem install #{configuration.project_name}
+
+            #{markdown_common}
+          CONTENT
+        end
+
+        def markdown_common
+          <<~CONTENT.strip
+            You can also add the gem directly to your project:
+
+                bundle add #{configuration.project_name}
+
+            Once the gem is installed, you only need to require it:
+
+                require "#{configuration.project_path}"
+
+            ## Usage
+          CONTENT
+        end
       end
     end
   end

data/lib/gemsmith/builders/git/ignore.rb

@@ -6,31 +6,22 @@ module Gemsmith
   module Builders
     module Git
       # Builds project skeleton Git ignore.
-      class Ignore
+      class Ignore < Rubysmith::Builders::Abstract
         using Refinements::Struct
 
-        def self.call(...) = new(...).call
-
-        def initialize configuration, builder: Rubysmith::Builder
-          @configuration = configuration
-          @builder = builder
-        end
-
         def call
           return configuration unless configuration.build_git
 
           builder.call(configuration.merge(template_path: "%project_name%/.gitignore.erb"))
                  .touch
                  .prepend("*.gem\n")
-                 .insert_before("tmp\n", "Gemfile.lock\n")
-                 .insert_before("tmp\n", "pkg\n")
+                 .insert_before "tmp\n", <<~CONTENT
+                   Gemfile.lock
+                   pkg
+                 CONTENT
 
           configuration
         end
-
-        private
-
-        attr_reader :configuration, :builder
       end
     end
   end

data/lib/gemsmith/builders/rspec/helper.rb

@@ -6,16 +6,9 @@ module Gemsmith
   module Builders
     module RSpec
       # Builds RSpec spec helper for project skeleton.
-      class Helper
+      class Helper < Rubysmith::Builders::Abstract
         using Refinements::Struct
 
-        def self.call(...) = new(...).call
-
-        def initialize configuration, builder: Rubysmith::Builder
-          @configuration = configuration
-          @builder = builder
-        end
-
         def call
           return configuration unless configuration.build_rspec && configuration.build_cli
 
@@ -24,10 +17,6 @@ module Gemsmith
                  .replace("%r(^/spec/)", "%r((.+/container\\.rb|^/spec/))")
           configuration
         end
-
-        private
-
-        attr_reader :configuration, :builder
       end
     end
   end

data/lib/gemsmith/builders/specification.rb

@@ -5,16 +5,9 @@ require "refinements/struct"
 module Gemsmith
   module Builders
     # Builds project skeleton gem specification for use by RubyGems.
-    class Specification
+    class Specification < Rubysmith::Builders::Abstract
       using Refinements::Struct
 
-      def self.call(...) = new(...).call
-
-      def initialize configuration, builder: Rubysmith::Builder
-        @configuration = configuration
-        @builder = builder
-      end
-
       def call
         config = configuration.merge template_path: "%project_name%/%project_name%.gemspec.erb"
 
@@ -28,10 +21,6 @@ module Gemsmith
 
         configuration
       end
-
-      private
-
-      attr_reader :configuration, :builder
     end
   end
 end

data/lib/gemsmith/container.rb

@@ -22,7 +22,6 @@ module Gemsmith
                                       model: Rubysmith::Configuration::Model
 
       registry.add_loader(Etcher::Loaders::YAML.new(self[:defaults_path]))
-              .add_transformer(Rubysmith::Configuration::Transformers::CurrentTime)
               .add_transformer(Rubysmith::Configuration::Transformers::GitHubUser.new)
               .add_transformer(Rubysmith::Configuration::Transformers::GitEmail.new)
               .add_transformer(Rubysmith::Configuration::Transformers::GitUser.new)
@@ -33,6 +32,7 @@ module Gemsmith
                 )
               )
               .add_transformer(Rubysmith::Configuration::Transformers::TargetRoot)
+              .add_transformer(Etcher::Transformers::Time.new)
     end
 
     register(:specification) { Spek::Loader.call "#{__dir__}/../../gemsmith.gemspec" }

data/lib/gemsmith/templates/%project_name%/%project_name%.gemspec.erb

@@ -45,7 +45,7 @@ Gem::Specification.new do |spec|
     spec.add_dependency "dry-monads", "~> 1.6"
   <% end %>
   <% if configuration.build_cli %>
-    spec.add_dependency "etcher", "~> 1.3"
+    spec.add_dependency "etcher", "~> 1.5"
   <% end %>
   <% if configuration.build_cli %>
     spec.add_dependency "infusible", "~> 3.5"

data/lib/gemsmith/tools/pusher.rb

@@ -28,13 +28,13 @@ module Gemsmith
 
       # :reek:TooManyStatements
       def one_time_password
-        return [] if check_yubikey.failure?
+        return Core::EMPTY_ARRAY if check_yubikey.failure?
 
         executor.capture3(check_yubikey.success, "oath", "accounts", "code", "--single", "RubyGems")
                 .then { |stdout, _stderr, status| status.success? ? ["--otp", stdout.chomp] : [] }
       rescue Errno::ENOENT => error
         logger.debug { "Unable to obtain YubiKey One-Time Password. #{error}." }
-        []
+        Core::EMPTY_ARRAY
       end
 
       def check_yubikey

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemsmith
 version: !ruby/object:Gem::Version
-  version: 21.7.0
+  version: 21.8.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2024-05-16 00:00:00.000000000 Z
+date: 2024-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cogger
@@ -113,14 +113,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: infusible
   requirement: !ruby/object:Gem::Requirement
@@ -141,14 +141,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '17.7'
+        version: '17.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '17.7'
+        version: '17.8'
 - !ruby/object:Gem::Dependency
   name: refinements
   requirement: !ruby/object:Gem::Requirement
@@ -169,14 +169,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.7'
+        version: '6.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.7'
+        version: '6.8'
 - !ruby/object:Gem::Dependency
   name: runcom
   requirement: !ruby/object:Gem::Requirement