gemsmith 15.0.0 → 15.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b93f0906b6ecc3a165d3afd1ff96476cae5796b1aa8a2ae821fbcc4411e79cc
-  data.tar.gz: d5a430092023af8d54bd9f06e1cc8a9524998b247766e4bd35d73aa360d68f87
+  metadata.gz: 651c889805c8d1c0a08a214d6fa464ca66ee6ee8fa07c3ab6898eb017b325542
+  data.tar.gz: 2060034279e140f6706600e40a395c351cf3d6b121b295fda84b47ca17f564a1
 SHA512:
-  metadata.gz: d89d23d15d231c203e3e990347f4345f35f8d2bc1194da76680f17a0a1a6793f659f98eb12dab1c485fcebd9e34dd1878cb11301889dfadbcf0659c0d6f89485
-  data.tar.gz: 434780f815a7740bae28ebb2be05fc5a5a5707c752bc65c23ef82917e63da9e1a049b4f771db6da687a680e881055b39aaa2dec43998cefa5a32711490cebf37
+  metadata.gz: 531b44e972e654f5e5f53137ea5be17cb623df2da9200c572165612ec51368be7749ab4defb9d533a4063683d5d8db9568829ea120d4e1aefcdcc0e4ac28761b
+  data.tar.gz: e96043ee09c39cb908514dd0e047a45606022e592b361569baeaea2111865bbad88884efeff194874e7b9aae1921b0fbd5911362caae0d6f3a92625feaebb88f

data.tar.gz.sig

@@ -1,3 +1,3 @@
-���u6�FV�l�˷���ޢ���\Y�tK��D��ٰdr*	ۺ`йk�&����Q#����
-�.T;�xL	
-lcY	���]�!?���Il�����_��8���ZC���W��@m���
+i&�%sT�Ȕ�(��y\�•�Ф������8M�v�xP6*�M�;��8&�,��`�p���6�#i��^>
+�eK0�u�Ɂ
�
+|�͌=ȮY	�P *�u�"����e�H`�8�tUɃ�w-�f��,�t�+Y)���J�]z��������`�^�+�왕����=F`�s�	���

data/README.adoc

@@ -94,7 +94,6 @@ For more gem generation options, type: `gemsmith --help --generate`
 [--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.

data/bin/gemsmith

@@ -1,9 +1,6 @@
 #! /usr/bin/env ruby
 # frozen_string_literal: true
 
-# TODO: Remove once the Pattern Matching feature is fully supported.
-Warning[:experimental] = false
-
 require "gemsmith"
 require "gemsmith/cli"
 require "gemsmith/identity"

data/lib/gemsmith.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "gemsmith/identity"
-require "gemsmith/git"
 require "gemsmith/credentials"
 require "gemsmith/errors/base"
 require "gemsmith/errors/requirement_conversion"
@@ -19,7 +18,6 @@ require "gemsmith/generators/cli"
 require "gemsmith/generators/documentation"
 require "gemsmith/generators/gem"
 require "gemsmith/generators/git"
-require "gemsmith/generators/git_cop"
 require "gemsmith/generators/git_lint"
 require "gemsmith/generators/git_hub"
 require "gemsmith/generators/guard"

data/lib/gemsmith/cli.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "git_plus"
 require "thor"
 require "thor/actions"
 require "refinements/strings"
@@ -7,6 +8,7 @@ require "refinements/hashes"
 require "runcom"
 require "gemsmith/helpers/cli"
 require "gemsmith/helpers/template"
+require "pathname"
 
 module Gemsmith
   # The Command Line Interface (CLI) for the gem.
@@ -23,27 +25,29 @@ module Gemsmith
 
     # Overwrites Thor's template source root.
     def self.source_root
-      File.expand_path File.join(File.dirname(__FILE__), "templates")
+      Pathname(__dir__).join("templates").freeze
     end
 
     # rubocop:disable Metrics/MethodLength
     def self.configuration
+      repository = GitPlus::Repository.new
+
       Runcom::Config.new "#{Identity::NAME}/configuration.yml",
                          defaults: {
                            year: Time.now.year,
-                           github_user: Git.github_user,
+                           github_user: repository.config_get("github.user"),
                            gem: {
                              label: "Undefined",
                              name: "undefined",
                              path: "undefined",
                              class: "Undefined",
                              platform: "Gem::Platform::RUBY",
-                             url: Git.github_url("undefined"),
+                             url: "",
                              license: "MIT"
                            },
                            author: {
-                             name: Git.config_value("user.name"),
-                             email: Git.config_value("user.email"),
+                             name: repository.config_get("user.name"),
+                             email: repository.config_get("user.email"),
                              url: ""
                            },
                            organization: {
@@ -52,7 +56,7 @@ module Gemsmith
                            },
                            versions: {
                              ruby: RUBY_VERSION,
-                             rails: "5.1"
+                             rails: "6.1"
                            },
                            generate: {
                              bundler_audit: true,
@@ -87,7 +91,6 @@ module Gemsmith
         Generators::Engine,
         Generators::Rspec,
         Generators::BundlerAudit,
-        Generators::GitCop,
         Generators::GitLint,
         Generators::Reek,
         Generators::Guard,
@@ -127,10 +130,6 @@ module Gemsmith
                   desc: "Add Rails Engine support.",
                   type: :boolean,
                   default: configuration.to_h.dig(:generate, :engine)
-    method_option :git_cop,
-                  desc: "Add Git Cop support. DEPRECATED: Use Git Lint instead.",
-                  type: :boolean,
-                  default: false
     method_option :git_lint,
                   desc: "Add Git Lint support.",
                   type: :boolean,
@@ -232,6 +231,8 @@ module Gemsmith
     # :reek:FeatureEnvy
     # rubocop:disable Metrics/MethodLength
     def setup_configuration name:, options: {}
+      repository = GitPlus::Repository.new
+
       @configuration = configuration.to_h.merge(
         gem: {
           label: name.titleize,
@@ -239,7 +240,7 @@ module Gemsmith
           path: name.snakecase,
           class: name.camelcase,
           platform: "Gem::Platform::RUBY",
-          url: Git.github_url(name),
+          url: %(https://github.com/#{repository.config_get "github.user"}/#{name}),
           license: "MIT"
         },
         generate: options.symbolize_keys

data/lib/gemsmith/credentials.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "yaml"
-require "fileutils"
+require "refinements/pathnames"
 require "gemsmith/authenticators/basic"
 require "gemsmith/authenticators/ruby_gems"
 
@@ -11,10 +11,12 @@ module Gemsmith
     DEFAULT_KEY = :rubygems_api_key
     DEFAULT_URL = "https://rubygems.org"
 
+    using Refinements::Pathnames
+
     attr_reader :key, :url
 
     def self.file_path
-      File.join ENV.fetch("HOME"), ".gem", "credentials"
+      Pathname(ENV.fetch("HOME")).join ".gem", "credentials"
     end
 
     def self.authenticators
@@ -52,7 +54,7 @@ module Gemsmith
     attr_reader :credentials, :shell
 
     def exist?
-      File.exist? self.class.file_path
+      self.class.file_path.exist?
     end
 
     def read
@@ -62,11 +64,11 @@ module Gemsmith
     end
 
     def write
-      file_path = self.class.file_path
-
-      FileUtils.mkdir_p File.dirname file_path
-      File.open(file_path, "w") { |file| file << YAML.dump(update) }
-      FileUtils.chmod 0o600, file_path
+      self.class
+          .file_path
+          .tap { |path| path.parent.make_path }
+          .write(YAML.dump(update))
+          .chmod 0o600
     end
 
     def update

data/lib/gemsmith/gem/specification.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "pathname"
 require "versionaire"
 
 module Gemsmith
@@ -26,7 +27,7 @@ module Gemsmith
 
       def initialize file_path
         @file_path = file_path
-        @spec = self.class.specification.load file_path
+        @spec = self.class.specification.load file_path.to_s
         validate
         @version = Versionaire::Version @spec.version.to_s
       end
@@ -56,7 +57,7 @@ module Gemsmith
       end
 
       def package_path
-        File.join "pkg", package_file_name
+        Pathname("pkg").join package_file_name
       end
 
       private

data/lib/gemsmith/generators/base.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require "pathname"
+
 module Gemsmith
   module Generators
     # Abstract class from which all generators inherit from.
     class Base
-      LIB_ROOT = File.join("%gem_name%", "lib").freeze
-      LIB_ROOT_GEM = File.join(LIB_ROOT, "%gem_path%").freeze
+      LIB_ROOT = Pathname("%gem_name%/lib").freeze
+      LIB_ROOT_GEM = LIB_ROOT.join("%gem_path%").freeze
 
       def self.run cli, configuration: {}
         new(cli, configuration: configuration).run
@@ -33,7 +35,7 @@ module Gemsmith
       end
 
       def gem_root
-        File.join cli.destination_root, gem_name
+        Pathname(cli.destination_root).join gem_name
       end
 
       def template path

data/lib/gemsmith/generators/bundler.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
+require "refinements/pathnames"
+
 module Gemsmith
   module Generators
     # Generates Bundler support.
     class Bundler < Base
+      using Refinements::Pathnames
+
       def run
-        Dir.chdir gem_root do
+        gem_root.change_dir do
           cli.say_status :info, "Installing gem dependencies...", :green
           cli.run "bundle install"
         end

data/lib/gemsmith/generators/documentation.rb

@@ -22,8 +22,7 @@ module Gemsmith
       end
 
       def update_readme
-        File.join(gem_root, "README.md")
-            .then { |readme| Tocer::Writer.new(readme).call }
+        gem_root.join("README.md").then { |path| Tocer::Writer.new(path).call }
       end
     end
   end

data/lib/gemsmith/generators/git.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
 require "open3"
+require "refinements/pathnames"
 
 module Gemsmith
   module Generators
     # Generates Git support.
     class Git < Base
+      using Refinements::Pathnames
+
       def initialize cli, configuration: {}, shell: Open3
         super cli, configuration: configuration
         @shell = shell
@@ -31,7 +34,7 @@ module Gemsmith
       end
 
       def create_commit subject, body
-        Dir.chdir gem_root do
+        gem_root.change_dir do
           shell.capture3 "git init"
           shell.capture3 "git add ."
           shell.capture3 %(git commit --all --no-verify --message "#{subject}" --message "#{body}")

data/lib/gemsmith/identity.rb

@@ -5,7 +5,7 @@ module Gemsmith
   module Identity
     NAME = "gemsmith"
     LABEL = "Gemsmith"
-    VERSION = "15.0.0"
+    VERSION = "15.1.0"
     VERSION_LABEL = "#{LABEL} #{VERSION}"
     URL = "https://www.alchemists.io/projects/gemsmith"
   end

data/lib/gemsmith/rake/builder.rb

@@ -1,19 +1,22 @@
 # frozen_string_literal: true
 
 require "bundler/ui/shell"
-require "fileutils"
+require "refinements/pathnames"
 
 module Gemsmith
   module Rake
     # Provides gem build functionality. Meant to be wrapped in Rake tasks.
     class Builder
-      def initialize shell: Bundler::UI::Shell.new, kernel: Kernel
+      using Refinements::Pathnames
+
+      def initialize root: Pathname("pkg"), shell: Bundler::UI::Shell.new, kernel: Kernel
+        @root = root
         @shell = shell
         @kernel = kernel
       end
 
       def clean
-        FileUtils.rm_rf "pkg"
+        root.remove_tree
         shell.confirm "Cleaned gem artifacts."
       end
 
@@ -28,8 +31,8 @@ module Gemsmith
         path = gem_spec.package_path
 
         if kernel.system "gem build #{gem_spec.name}.gemspec"
-          FileUtils.mkdir_p "pkg"
-          FileUtils.mv gem_spec.package_file_name, path
+          root.make_path
+          Pathname(gem_spec.package_file_name).copy path
           shell.confirm "Built: #{path}."
         else
           shell.error "Unable to build: #{path}."
@@ -48,7 +51,7 @@ module Gemsmith
 
       private
 
-      attr_reader :shell, :kernel
+      attr_reader :root, :shell, :kernel
     end
   end
 end

data/lib/gemsmith/rake/publisher.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require "milestoner"
+require "refinements/pathnames"
 require "gemsmith/identity"
 require "gemsmith/credentials"
-require "gemsmith/git"
 require "gemsmith/cli"
 
 module Gemsmith
@@ -11,13 +11,15 @@ module Gemsmith
     # Provides gem release functionality. Meant to be wrapped in Rake tasks.
     # :reek:TooManyInstanceVariables
     class Publisher
+      using Refinements::Pathnames
+
       def self.gem_spec_path
-        String Dir["#{Dir.pwd}/*.gemspec"].first
+        Pathname.pwd.files("*.gemspec").first.to_s
       end
 
       # rubocop:disable Metrics/ParameterLists
       # :reek:LongParameterList
-      def initialize gem_spec: Gemsmith::Gem::Specification.new(self.class.gem_spec_path),
+      def initialize gem_spec: Gemsmith::Gem::Specification.new(self.class.gem_spec_path.to_s),
                      gem_config: Gemsmith::CLI.configuration.to_h,
                      credentials: Gemsmith::Credentials,
                      publisher: Milestoner::Publisher.new,

data/lib/gemsmith/rake/tasks.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "rake"
+require "refinements/pathnames"
 require "tocer/rake/tasks"
 require "gemsmith/gem/specification"
 require "gemsmith/errors/base"
@@ -14,15 +15,17 @@ module Gemsmith
     class Tasks
       include ::Rake::DSL
 
+      using Refinements::Pathnames
+
       def self.default_gem_spec
-        Dir.glob("#{Dir.pwd}/*.gemspec").first
+        Pathname.pwd.files("*.gemspec").first
       end
 
       def self.setup
         new.install
       end
 
-      def initialize gem_spec: Gem::Specification.new(self.class.default_gem_spec),
+      def initialize gem_spec: Gem::Specification.new(self.class.default_gem_spec.to_s),
                      builder: Rake::Builder.new,
                      publisher: Rake::Publisher.new
         @gem_spec = gem_spec

data/lib/gemsmith/templates/%gem_name%/%gem_name%.gemspec.tt

@@ -11,9 +11,10 @@ Gem::Specification.new do |spec|
   spec.license = "MIT"
 
   spec.metadata = {
-    "source_code_uri" => "<%= config.dig(:gem, :url) %>",
+    "bug_tracker_uri" => "<%= config.dig(:gem, :url) %>/issues",
     "changelog_uri" => "<%= config.dig(:gem, :url) %>/blob/master/CHANGES.md",
-    "bug_tracker_uri" => "<%= config.dig(:gem, :url) %>/issues"
+    "documentation_uri" => "<%= config.dig(:gem, :url) %>",
+    "source_code_uri" => "<%= config.dig(:gem, :url) %>"
   }
 
   <%- if config.dig(:generate, :security) -%>

data/lib/gemsmith/templates/%gem_name%/lib/generators/%gem_path%/install/install_generator.rb.tt

@@ -1,7 +1,9 @@
+require "pathname"
+
 <% render_namespace do %>
   # Generator for installing new files.
   class InstallGenerator < Rails::Generators::Base
-    source_root File.join(File.dirname(__FILE__), "..", "templates")
+    source_root Pathname(__dir__).join("../templates")
 
     desc "Installs additional <%= config.dig(:gem, :label) %> resources."
     def install

data/lib/gemsmith/templates/%gem_name%/lib/generators/%gem_path%/upgrade/upgrade_generator.rb.tt

@@ -1,7 +1,7 @@
 <% render_namespace do %>
   # Generator for updating existing files.
   class UpgradeGenerator < Rails::Generators::Base
-    source_root File.join(File.dirname(__FILE__), "..", "templates")
+    source_root Pathname(__dir__).join("../templates")
 
     desc "Upgrades previously installed <%= config.dig(:gem, :label) %> resources."
     def upgrade

data/lib/gemsmith/templates/%gem_name%/spec/lib/%gem_path%/cli_spec.rb.tt

@@ -3,11 +3,14 @@
 require "spec_helper"
 
 RSpec.describe <%= config.dig(:gem, :class) %>::CLI do
+  subject(:cli) { described_class.start command_line }
+
+  include_context "with temporary directory"
+
   let(:options) { [] }
   let(:command_line) { Array(command).concat options }
-  let(:cli) { described_class.start command_line }
 
-  shared_examples_for "a config command", :temp_dir do
+  shared_examples_for "a config command" do
     context "with no options" do
       it "prints help text" do
         result = -> { cli }

data/lib/gemsmith/templates/%gem_name%/spec/support/shared_contexts/temp_dir.rb.tt

@@ -1,4 +1,4 @@
-RSpec.shared_context "with temporary directory", :temp_dir do
+RSpec.shared_context "with temporary directory" do
   let(:temp_dir) { Bundler.root.join "tmp", "rspec" }
 
   around do |example|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemsmith
 version: !ruby/object:Gem::Version
-  version: 15.0.0
+  version: 15.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,8 +28,22 @@ cert_chain:
   2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
   QWc=
   -----END CERTIFICATE-----
-date: 2020-12-30 00:00:00.000000000 Z
+date: 2021-01-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: git_plus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: milestoner
   requirement: !ruby/object:Gem::Requirement
@@ -177,7 +191,6 @@ files:
 - lib/gemsmith/generators/engine.rb
 - lib/gemsmith/generators/gem.rb
 - lib/gemsmith/generators/git.rb
-- lib/gemsmith/generators/git_cop.rb
 - lib/gemsmith/generators/git_hub.rb
 - lib/gemsmith/generators/git_lint.rb
 - lib/gemsmith/generators/guard.rb
@@ -187,7 +200,6 @@ files:
 - lib/gemsmith/generators/rspec.rb
 - lib/gemsmith/generators/rubocop.rb
 - lib/gemsmith/generators/ruby.rb
-- lib/gemsmith/git.rb
 - lib/gemsmith/helpers/cli.rb
 - lib/gemsmith/helpers/template.rb
 - lib/gemsmith/identity.rb

data/lib/gemsmith/generators/git_cop.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Gemsmith
-  module Generators
-    # Generates Git Cop support.
-    class GitCop < Base
-      def run
-        return unless configuration.dig :generate, :git_cop
-
-        warn "[DEPRECATION]: Git Cop is deprecated, use Git Lint instead."
-      end
-    end
-  end
-end

data/lib/gemsmith/git.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Gemsmith
-  # A thin wrapper to Git.
-  # rubocop:disable Style/StaticClass
-  class Git
-    def self.config_value key
-      `git config #{key}`.chomp
-    end
-
-    def self.github_user
-      config_value "github.user"
-    end
-
-    def self.github_url project
-      return "" if github_user.empty?
-
-      "https://github.com/#{github_user}/#{project}"
-    end
-  end
-  # rubocop:enable Style/StaticClass
-end