gemsmith 9.6.0 → 10.0.0

data/lib/gemsmith/credentials.rb

@@ -26,6 +26,7 @@ module Gemsmith
       [Authenticators::RubyGems, Authenticators::Basic]
     end
 
+    # :reek:DuplicateMethodCall
     def initialize key: self.class.default_key,
                    url: self.class.default_url,
                    shell: Thor::Shell::Basic.new
@@ -49,6 +50,7 @@ module Gemsmith
     end
 
     # rubocop:disable Metrics/AbcSize
+    # :reek:TooManyStatements
     def create
       return if valid?
 
@@ -58,9 +60,10 @@ module Gemsmith
 
       new_credentials = credentials.merge key => authenticator.new(login, password).authorization
 
-      FileUtils.mkdir_p File.dirname self.class.file_path
-      File.open(self.class.file_path, "w") { |file| file << YAML.dump(new_credentials) }
-      FileUtils.chmod(0o600, self.class.file_path)
+      file_path = self.class.file_path
+      FileUtils.mkdir_p File.dirname file_path
+      File.open(file_path, "w") { |file| file << YAML.dump(new_credentials) }
+      FileUtils.chmod(0o600, file_path)
     end
 
     private

data/lib/gemsmith/gem/module_formatter.rb

@@ -8,6 +8,10 @@ module Gemsmith
     class ModuleFormatter
       using Refinements::Strings
 
+      def self.indent length = 0
+        "  " * length
+      end
+
       def initialize namespace
         @namespace = namespace
         @modules = namespace.split "::"
@@ -24,28 +28,22 @@ module Gemsmith
 
       def prefix
         modules.each.with_index.reduce "" do |result, (module_name, index)|
-          result + "#{indentation index}module #{module_name}\n"
+          result + "#{self.class.indent index}module #{module_name}\n"
         end
       end
 
       def body content
-        indent = indentation depth + 1
-
         content.sub(/\A\n/, "").split("\n").reduce "" do |body, line|
           next "#{body}\n" if line.blank?
-          body + "#{indent}#{line.gsub(/^\s{2}/, "")}\n"
+          body + "#{self.class.indent depth + 1}#{line.gsub(/^\s{2}/, "")}\n"
         end
       end
 
       def suffix
         modules.each.with_index.reduce "" do |result, (_, index)|
-          result + "#{indentation depth - index}end\n"
+          result + "#{self.class.indent depth - index}end\n"
         end
       end
-
-      def indentation length
-        "  " * length
-      end
     end
   end
 end

data/lib/gemsmith/gem/requirement.rb

@@ -6,6 +6,7 @@ module Gemsmith
   module Gem
     # Defines a gem requirement. This is a partial, cleaner implementation of the RubyGems
     # `Gem::Requirement` object.
+    # :reek:PrimaDonnaMethod
     class Requirement
       def self.operators
         [">", ">=", "=", "!=", "<", "<=", "~>"]
@@ -43,10 +44,11 @@ module Gemsmith
       private
 
       def validate!
-        return true if self.class.operators.include?(operator)
+        operators = self.class.operators
+        return true if operators.include?(operator)
 
         fail Errors::RequirementOperator,
-             %(Invalid gem requirement operator. Use: #{self.class.operators.join ", "}.)
+             %(Invalid gem requirement operator. Use: #{operators.join ", "}.)
       end
     end
   end

data/lib/gemsmith/gem/specification.rb

@@ -61,6 +61,10 @@ module Gemsmith
         "#{name}-#{version_number}.gem"
       end
 
+      def package_path
+        File.join "pkg", package_file_name
+      end
+
       private
 
       attr_reader :file_path, :spec, :version

data/lib/gemsmith/generators/base.rb

@@ -4,6 +4,8 @@ module Gemsmith
   module Generators
     # Abstract class from which all generators inherit from.
     class Base
+      LIB_ROOT = File.join("%gem_name%", "lib").freeze
+
       def initialize cli, configuration: {}
         @cli = cli
         @configuration = configuration
@@ -21,12 +23,9 @@ module Gemsmith
 
       attr_reader :cli, :configuration
 
-      def lib_root
-        File.join "%gem_name%", "lib"
-      end
-
+      # :reek:UtilityFunction
       def lib_gem_root
-        File.join lib_root, "%gem_path%"
+        File.join LIB_ROOT, "%gem_path%"
       end
 
       def gem_name

data/lib/gemsmith/generators/bundler.rb

@@ -6,7 +6,7 @@ module Gemsmith
     class Bundler < Base
       def run
         Dir.chdir(gem_root) do
-          cli.info "Installing gem dependencies..."
+          cli.say_status :info, "Installing gem dependencies...", :green
           `bundle install`
         end
       end

data/lib/gemsmith/generators/circle_ci.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Gemsmith
+  module Generators
+    # Generates Circle CI support.
+    class CircleCI < Base
+      def run
+        return unless configuration.dig(:generate, :circle_ci)
+        cli.template "%gem_name%/circle.yml.tt", configuration
+      end
+    end
+  end
+end

data/lib/gemsmith/generators/cli.rb

@@ -11,7 +11,7 @@ module Gemsmith
         cli.template "%gem_name%/bin/%gem_name%.tt", configuration
         cli.template "%gem_name%/lib/%gem_path%/cli.rb.tt", configuration
         cli.template "%gem_name%/spec/lib/%gem_path%/cli_spec.rb.tt", configuration
-        cli.chmod "#{configuration.dig :gem, :name}/bin/#{configuration.dig :gem, :name}", 0o755
+        cli.chmod "#{gem_name}/bin/#{gem_name}", 0o755
       end
     end
   end

data/lib/gemsmith/generators/gem.rb

@@ -5,6 +5,7 @@ module Gemsmith
     # Generates default gem support.
     class Gem < Base
       # rubocop:disable Metrics/AbcSize
+      # :reek:TooManyStatements
       def run
         cli.template "%gem_name%/bin/setup.tt", configuration
         cli.template "%gem_name%/Gemfile.tt", configuration

data/lib/gemsmith/generators/git_cop.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Gemsmith
+  module Generators
+    # Generates Git Cop support.
+    class GitCop < Base
+      def run
+        return unless configuration.dig(:generate, :git_cop)
+        cli.uncomment_lines "#{gem_name}/Rakefile", %r(require.+git\/cop.+)
+      end
+    end
+  end
+end

data/lib/gemsmith/generators/pragma.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "pragmater"
 require "pathname"
+require "pragmater"
 
 module Gemsmith
   module Generators
@@ -14,26 +14,29 @@ module Gemsmith
       # rubocop:disable Metrics/MethodLength
       def whitelist
         %W[
-          Gemfile
-          Guardfile
-          Rakefile
-          config.ru
-          bin/#{configuration.dig :gem, :name}
-          bin/rails
-          .gemspec
-          .rake
-          .rb
+          **/*Gemfile
+          **/*Guardfile
+          **/*Rakefile
+          **/*config.ru
+          **/*bin/#{configuration.dig :gem, :name}
+          **/*bin/bundle
+          **/*bin/rails
+          **/*bin/rake
+          **/*bin/setup
+          **/*bin/update
+          **/*bin/yarn
+          **/*.gemspec
+          **/*.rake
+          **/*.rb
         ]
       end
 
       def run
-        whitelisted_files.each { |file| Pragmater::Writer.new(file, self.class.comments).add }
-      end
-
-      private
-
-      def whitelisted_files
-        Pathname.glob(%(#{gem_root}/**/*{#{whitelist.join ","}})).select(&:file?)
+        Pragmater::Runner.new(
+          gem_root,
+          comments: self.class.comments,
+          whitelist: whitelist
+        ).run action: :add
       end
     end
   end

data/lib/gemsmith/generators/rails.rb

@@ -15,7 +15,7 @@ module Gemsmith
       end
 
       def create_engine
-        cli.template "#{lib_root}/%gem_path%/engine.rb.tt", configuration
+        cli.template "#{LIB_ROOT}/%gem_path%/engine.rb.tt", configuration
         cli.run "rails plugin new --skip #{configuration.dig :gem, :name} #{engine_options}"
       end
 
@@ -28,11 +28,6 @@ module Gemsmith
         cli.template "#{generator_root}/upgrade/USAGE.tt", configuration
       end
 
-      def create_travis_gemfiles
-        return unless configuration.dig(:generate, :travis)
-        cli.template "%gem_name%/gemfiles/rails-%rails_version%.x.gemfile.tt", configuration
-      end
-
       def stub_assets
         cli.run %(printf "%s" > "#{gem_name}/app/assets/javascripts/#{gem_path}/application.js")
         cli.run %(printf "%s" > "#{gem_name}/app/assets/stylesheets/#{gem_path}/application.css")
@@ -45,13 +40,13 @@ module Gemsmith
         cli.remove_file "#{gem_name}/README.rdoc", configuration
       end
 
+      # :reek:TooManyStatements
       def run
         return unless configuration.dig(:generate, :rails)
 
         install_rails
         create_engine
         create_generator_files
-        create_travis_gemfiles
         stub_assets
         remove_files
       end
@@ -70,7 +65,7 @@ module Gemsmith
       end
 
       def generator_root
-        "#{lib_root}/generators/%gem_path%"
+        "#{LIB_ROOT}/generators/%gem_path%"
       end
 
       def indentation

data/lib/gemsmith/generators/rake.rb

@@ -30,6 +30,10 @@ module Gemsmith
         configuration.dig(:generate, :rspec) ? "spec" : ""
       end
 
+      def git_cop_task
+        configuration.dig(:generate, :git_cop) ? "git_cop" : ""
+      end
+
       def reek_task
         configuration.dig(:generate, :reek) ? "reek" : ""
       end
@@ -43,7 +47,7 @@ module Gemsmith
       end
 
       def code_quality_tasks
-        [reek_task, rubocop_task, scss_lint_task].compress.join " "
+        [git_cop_task, reek_task, rubocop_task, scss_lint_task].compress.join " "
       end
 
       def code_quality_task

data/lib/gemsmith/helpers/cli.rb

@@ -16,6 +16,8 @@ module Gemsmith
         say "q. Quit.\n\n"
       end
 
+      # :reek:FeatureEnvy
+      # :reek:TooManyStatements
       def pick_gem gems, name
         answer = ask "Enter selection:"
         return if answer == "q"
@@ -25,7 +27,7 @@ module Gemsmith
         if (1..gems.size).cover?(answer)
           Gem::Specification.find name, gems[answer - 1].version.version
         else
-          error "Invalid option: #{answer}"
+          say_status :error, "Invalid option: #{answer}", :red
           nil
         end
       end
@@ -33,10 +35,11 @@ module Gemsmith
       def inspect_gem specification, method
         return unless specification
         Gem::Inspector.new.public_send method, Gem::Specification.new(specification.spec_file)
-      rescue Versionaire::Errors::Conversion => exception
-        error(exception.message)
+      rescue Versionaire::Errors::Conversion => error
+        say_status :error, error.message, :red
       end
 
+      # :reek:TooManyStatements
       def process_gem name, method
         specs = Gem::Specification.find_all name
         spec_count = specs.size
@@ -47,7 +50,7 @@ module Gemsmith
           print_gems specs
           inspect_gem pick_gem(specs, name), method
         else
-          error("Unable to find gem: #{name}.") and ""
+          say_status(:error, "Unable to find gem: #{name}.", :red) and ""
         end
       end
     end

data/lib/gemsmith/identity.rb

@@ -12,15 +12,11 @@ module Gemsmith
     end
 
     def self.version
-      "9.6.0"
+      "10.0.0"
     end
 
     def self.version_label
       "#{label} #{version}"
     end
-
-    def self.file_name
-      ".#{name}rc"
-    end
   end
 end

data/lib/gemsmith/rake/builder.rb

@@ -32,7 +32,7 @@ module Gemsmith
       end
 
       def build gem_spec
-        path = package_path gem_spec
+        path = gem_spec.package_path
 
         if kernel.system("gem build #{gem_spec.name}.gemspec")
           FileUtils.mkdir_p "pkg"
@@ -46,7 +46,7 @@ module Gemsmith
       def install gem_spec
         gem_name = "#{gem_spec.name} #{gem_spec.version_number}"
 
-        if kernel.system("gem install #{package_path gem_spec}")
+        if kernel.system("gem install #{gem_spec.package_path}")
           shell.confirm "Installed: #{gem_name}."
         else
           shell.error "Unable to install: #{gem_name}."
@@ -56,10 +56,6 @@ module Gemsmith
       private
 
       attr_reader :tocer, :shell, :kernel
-
-      def package_path gem_spec
-        File.join "pkg", gem_spec.package_file_name
-      end
     end
   end
 end

data/lib/gemsmith/rake/publisher.rb

@@ -9,12 +9,14 @@ require "gemsmith/cli"
 module Gemsmith
   module Rake
     # Provides gem release functionality. Meant to be wrapped in Rake tasks.
+    # :reek:TooManyInstanceVariables
     class Publisher
       def self.gem_spec_path
         String Dir["#{Dir.pwd}/*.gemspec"].first
       end
 
       # rubocop:disable Metrics/ParameterLists
+      # :reek:LongParameterList
       def initialize gem_spec: Gemsmith::Gem::Specification.new(self.class.gem_spec_path),
                      gem_config: Gemsmith::CLI.configuration.to_h,
                      credentials: Gemsmith::Credentials,
@@ -32,11 +34,10 @@ module Gemsmith
 
       # rubocop:disable Metrics/AbcSize
       def push
-        creds = credentials.new key: gem_spec.allowed_push_key.to_sym,
-                                url: gem_spec.allowed_push_host
+        creds = credentials.new key: gem_spec.allowed_push_key.to_sym, url: gem_host
         creds.create
 
-        options = %(--key "#{translate_key creds.key}" --host "#{gem_spec.allowed_push_host}")
+        options = %(--key "#{translate_key creds.key}" --host "#{gem_host}")
         status = kernel.system %(gem push "pkg/#{gem_spec.package_file_name}" #{options})
         process_push status
       end
@@ -56,16 +57,21 @@ module Gemsmith
 
       attr_reader :gem_spec, :gem_config, :credentials, :publisher, :shell, :kernel
 
+      def gem_host
+        gem_spec.allowed_push_host
+      end
+
       def translate_key key
         key == credentials.default_key ? :rubygems : key
       end
 
       def process_push status
+        package = gem_spec.package_file_name
+
         if status
-          shell.confirm "Pushed #{gem_spec.package_file_name} to #{gem_spec.allowed_push_host}."
+          shell.confirm "Pushed #{package} to #{gem_host}."
         else
-          shell.error "Failed pushing #{gem_spec.package_file_name} to " \
-                      "#{gem_spec.allowed_push_host}. " \
+          shell.error "Failed pushing #{package} to #{gem_host}. " \
                       "Check gemspec and gem credential settings."
         end