gemsmith 15.4.0 → 16.2.0

data/lib/gemsmith/cli.rb

@@ -1,259 +0,0 @@
-# frozen_string_literal: true
-
-require "git_plus"
-require "thor"
-require "thor/actions"
-require "refinements/strings"
-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.
-  # rubocop:disable Metrics/ClassLength
-  class CLI < Thor
-    include Thor::Actions
-    include Helpers::CLI
-    include Helpers::Template
-
-    using Refinements::Strings
-    using Refinements::Hashes
-
-    package_name Identity::VERSION_LABEL
-
-    # Overwrites Thor's template source root.
-    def self.source_root
-      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: repository.config_get("github.user"),
-                           gem: {
-                             label: "Undefined",
-                             name: "undefined",
-                             path: "undefined",
-                             class: "Undefined",
-                             platform: "Gem::Platform::RUBY",
-                             url: "",
-                             license: "MIT"
-                           },
-                           author: {
-                             name: repository.config_get("user.name"),
-                             email: repository.config_get("user.email"),
-                             url: ""
-                           },
-                           organization: {
-                             name: "",
-                             url: ""
-                           },
-                           versions: {
-                             ruby: RUBY_VERSION,
-                             rails: "6.1"
-                           },
-                           generate: {
-                             bundler_audit: true,
-                             circle_ci: false,
-                             cli: false,
-                             git_lint: true,
-                             git_hub: false,
-                             guard: true,
-                             pry: true,
-                             engine: false,
-                             reek: true,
-                             rspec: true,
-                             rubocop: true,
-                             simple_cov: true,
-                             security: false
-                           },
-                           publish: {
-                             sign: false
-                           }
-                         }
-    end
-    # rubocop:enable Metrics/MethodLength
-
-    # rubocop:disable Metrics/MethodLength
-    def self.generators
-      [
-        Generators::Gem,
-        Generators::Documentation,
-        Generators::Rake,
-        Generators::CLI,
-        Generators::Ruby,
-        Generators::Engine,
-        Generators::Rspec,
-        Generators::BundlerAudit,
-        Generators::GitLint,
-        Generators::Reek,
-        Generators::Guard,
-        Generators::CircleCI,
-        Generators::Bundler,
-        Generators::GitHub,
-        Generators::Pragma,
-        Generators::Rubocop,
-        Generators::Git
-      ]
-    end
-    # rubocop:enable Metrics/MethodLength
-
-    # Initialize.
-    def initialize args = [], options = {}, config = {}
-      super args, options, config
-      @configuration = self.class.configuration
-    rescue Runcom::Errors::Base => error
-      abort error.message
-    end
-
-    desc "-g, [--generate=GEM]", "Generate new gem."
-    map %w[-g --generate] => :generate
-    method_option :bundler_audit,
-                  desc: "Add Bundler Audit support.",
-                  type: :boolean,
-                  default: configuration.to_h.dig(:generate, :bundler_audit)
-    method_option :circle_ci,
-                  desc: "Add Circle CI support.",
-                  type: :boolean,
-                  default: configuration.to_h.dig(:generate, :circle_ci)
-    method_option :cli,
-                  desc: "Add CLI support.",
-                  type: :boolean,
-                  default: configuration.to_h.dig(:generate, :cli)
-    method_option :engine,
-                  desc: "Add Rails Engine support.",
-                  type: :boolean,
-                  default: configuration.to_h.dig(:generate, :engine)
-    method_option :git_lint,
-                  desc: "Add Git Lint support.",
-                  type: :boolean,
-                  default: configuration.to_h.dig(:generate, :git_lint)
-    method_option :git_hub,
-                  desc: "Add GitHub support.",
-                  type: :boolean,
-                  default: configuration.to_h.dig(:generate, :git_hub)
-    method_option :guard,
-                  desc: "Add Guard support.",
-                  type: :boolean,
-                  default: configuration.to_h.dig(:generate, :guard)
-    method_option :pry,
-                  desc: "Add Pry support.",
-                  type: :boolean,
-                  default: configuration.to_h.dig(:generate, :pry)
-    method_option :reek,
-                  desc: "Add Reek support.",
-                  type: :boolean,
-                  default: configuration.to_h.dig(:generate, :reek)
-    method_option :rspec,
-                  desc: "Add RSpec support.",
-                  type: :boolean,
-                  default: configuration.to_h.dig(:generate, :rspec)
-    method_option :rubocop,
-                  desc: "Add Rubocop support.",
-                  type: :boolean,
-                  default: configuration.to_h.dig(:generate, :rubocop)
-    method_option :simple_cov,
-                  desc: "Add SimpleCov support.",
-                  type: :boolean,
-                  default: configuration.to_h.dig(:generate, :simple_cov)
-    method_option :security,
-                  desc: "Add security support.",
-                  type: :boolean,
-                  default: configuration.to_h.dig(:generate, :security)
-    # :reek:TooManyStatements
-    def generate name
-      print_cli_and_rails_engine_option_error && return if options.cli? && options.engine?
-
-      say_status :info, "Generating gem...", :green
-
-      setup_configuration name: name, options: options.to_h
-      self.class.generators.each { |generator| generator.run self, configuration: configuration }
-
-      say_status :info, "Gem generation finished.", :green
-    end
-
-    desc "-o, [--open=GEM]", "Open a gem in default editor."
-    map %w[-o --open] => :open
-    def open name
-      process_gem name, "edit"
-    end
-
-    desc "-r, [--read=GEM]", "Open a gem in default browser."
-    map %w[-r --read] => :read
-    def read name
-      say_status :error, "Gem home page is not defined.", :red unless process_gem name, "visit"
-    end
-
-    desc "-c, [--config]", "Manage gem configuration."
-    map %w[-c --config] => :config
-    method_option :edit,
-                  aliases: "-e",
-                  desc: "Edit gem configuration.",
-                  type: :boolean,
-                  default: false
-    method_option :info,
-                  aliases: "-i",
-                  desc: "Print gem configuration.",
-                  type: :boolean,
-                  default: false
-    def config
-      path = configuration.current
-
-      if options.edit? then `#{ENV["EDITOR"]} #{path}`
-      elsif options.info?
-        path ? say(path) : say("Configuration doesn't exist.")
-      else help :config
-      end
-    end
-
-    desc "-v, [--version]", "Show gem version."
-    map %w[-v --version] => :version
-    def version
-      say Identity::VERSION_LABEL
-    end
-
-    desc "-h, [--help=COMMAND]", "Show this message or get help for a command."
-    map %w[-h --help] => :help
-    def help task = nil
-      say and super
-    end
-
-    private
-
-    attr_reader :configuration
-
-    # :reek:FeatureEnvy
-    # rubocop:disable Metrics/MethodLength
-    def setup_configuration name:, options: {}
-      repository = GitPlus::Repository.new
-
-      @configuration = configuration.to_h.merge(
-        gem: {
-          label: name.titleize,
-          name: name,
-          path: name.snakecase,
-          class: name.camelcase,
-          platform: "Gem::Platform::RUBY",
-          url: %(https://github.com/#{repository.config_get "github.user"}/#{name}),
-          license: "MIT"
-        },
-        generate: options.symbolize_keys
-      )
-    end
-    # rubocop:enable Metrics/MethodLength
-
-    def print_cli_and_rails_engine_option_error
-      say_status :error,
-                 "Generating a gem with CLI and Rails Engine functionality is not allowed. " \
-                 "Build separate gems for improved separation of concerns and design.",
-                 :red
-    end
-  end
-  # rubocop:enable Metrics/ClassLength
-end

data/lib/gemsmith/credentials.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-require "yaml"
-require "refinements/pathnames"
-require "gemsmith/authenticators/basic"
-require "gemsmith/authenticators/ruby_gems"
-
-module Gemsmith
-  # Generates gem credentials for RubyGems and/or alternative servers.
-  class Credentials
-    DEFAULT_KEY = :rubygems_api_key
-    DEFAULT_URL = "https://rubygems.org"
-
-    using Refinements::Pathnames
-
-    attr_reader :key, :url
-
-    def self.file_path
-      Pathname(ENV.fetch("HOME")).join ".gem", "credentials"
-    end
-
-    def self.authenticators
-      [Authenticators::RubyGems, Authenticators::Basic]
-    end
-
-    def initialize key: DEFAULT_KEY, url: DEFAULT_URL, shell: Thor::Shell::Basic.new
-      @key = key
-      @url = url
-      @shell = shell
-      @credentials = read
-    end
-
-    def authenticator
-      self.class
-          .authenticators
-          .find { |auth| auth.url.include? url }
-          .then { |selected| selected || Authenticators::Basic }
-    end
-
-    def value
-      String credentials[key]
-    end
-
-    def valid?
-      exist? && !String(credentials[key]).empty?
-    end
-
-    def create
-      write unless valid?
-    end
-
-    private
-
-    attr_reader :credentials, :shell
-
-    def exist?
-      self.class.file_path.exist?
-    end
-
-    def read
-      Hash YAML.load_file(self.class.file_path)
-    rescue StandardError
-      {}
-    end
-
-    def write
-      self.class
-          .file_path
-          .tap { |path| path.parent.make_path }
-          .write(YAML.dump(update))
-          .chmod 0o600
-    end
-
-    def update
-      login = shell.ask %(What is your "#{url}" login?)
-      password = shell.ask %(What is your "#{url}" password?), echo: false
-      shell.say
-
-      credentials.merge key => authenticator.new(login, password).authorization
-    end
-  end
-end

data/lib/gemsmith/errors/base.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Gemsmith
-  module Errors
-    # The base error class for all gem related errors.
-    class Base < StandardError
-    end
-  end
-end

data/lib/gemsmith/errors/requirement_conversion.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Gemsmith
-  module Errors
-    # Thrown when attempting to convert (cast) a primitive to a gem requirement.
-    class RequirementConversion < Base
-    end
-  end
-end

data/lib/gemsmith/errors/requirement_operator.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Gemsmith
-  module Errors
-    # Error class for gem requirement operator errors.
-    class RequirementOperator < Base
-    end
-  end
-end

data/lib/gemsmith/errors/specification.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Gemsmith
-  module Errors
-    # The error class for gem specification errors.
-    class Specification < Base
-    end
-  end
-end

data/lib/gemsmith/gem/inspector.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require "open3"
-
-module Gemsmith
-  module Gem
-    # Provides the ability to investigate a gem in greater detail.
-    class Inspector
-      def self.editor
-        ENV.fetch "EDITOR"
-      end
-
-      def initialize shell: Open3
-        @shell = shell
-      end
-
-      def edit specification
-        shell.capture3 self.class.editor, specification.path
-      end
-
-      def visit specification
-        shell.capture3 "open", specification.homepage_url
-      end
-
-      private
-
-      attr_reader :shell
-    end
-  end
-end

data/lib/gemsmith/gem/module_formatter.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-require "refinements/strings"
-
-module Gemsmith
-  module Gem
-    # Formats single or multiple modules with correct, two-space indentation for templates.
-    class ModuleFormatter
-      using Refinements::Strings
-
-      def self.indent length = 0
-        "  " * length
-      end
-
-      def initialize namespace
-        @namespace = namespace
-        @modules = namespace.split "::"
-        @depth = namespace.scan("::").length
-      end
-
-      def render content
-        "#{prefix}#{body content}#{suffix.chomp}"
-      end
-
-      private
-
-      attr_reader :namespace, :modules, :depth
-
-      def prefix
-        modules.each.with_index.reduce "" do |result, (module_name, index)|
-          result + "#{self.class.indent index}module #{module_name}\n"
-        end
-      end
-
-      def body content
-        content.lstrip.split("\n").reduce "" do |body, line|
-          next "#{body}\n" if line.blank?
-
-          body + "#{self.class.indent depth + 1}#{line.gsub(/^\s{2}/, "")}\n"
-        end
-      end
-
-      def suffix
-        modules.each.with_index.reduce "" do |result, (_, index)|
-          result + "#{self.class.indent depth - index}end\n"
-        end
-      end
-    end
-  end
-end

data/lib/gemsmith/gem/requirement.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-require "versionaire"
-
-module Gemsmith
-  module Gem
-    # Defines a gem requirement. This is a partial, cleaner implementation of the RubyGems
-    # `Gem::Requirement` object.
-    # :reek:MissingSafeMethod
-    class Requirement
-      def self.operators
-        [">", ">=", "=", "!=", "<", "<=", "~>"]
-      end
-
-      def self.version_segments version
-        String(version).split(Versionaire::Version.delimiter).map(&:to_i)
-      end
-
-      def self.for object
-        case object
-          when String
-            operator, version = object.split
-            new operator: operator, raw_version: version
-          else
-            fail Errors::RequirementConversion,
-                 %(Invalid string conversion. Use: "<operator> <version>".)
-        end
-      end
-
-      attr_reader :operator, :raw_version, :version_segments, :version
-
-      def initialize operator: ">=", raw_version: "0"
-        @operator = operator
-        @raw_version = raw_version
-        @version_segments = self.class.version_segments raw_version
-        @version = Versionaire::Version version_segments
-        validate!
-      end
-
-      def to_s
-        "#{operator} #{version}"
-      end
-
-      private
-
-      def validate!
-        operators = self.class.operators
-        return true if operators.include? operator
-
-        fail Errors::RequirementOperator,
-             %(Invalid gem requirement operator. Use: #{operators.join ", "}.)
-      end
-    end
-  end
-end

data/lib/gemsmith/gem/specification.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-require "pathname"
-require "versionaire"
-
-module Gemsmith
-  module Gem
-    # A Gem::Specification with additional enhancements.
-    class Specification
-      def self.specification
-        ::Gem::Specification
-      end
-
-      def self.default_gem_host
-        ::Gem::DEFAULT_HOST
-      end
-
-      def self.find name, version
-        specification.find_by_name name, version
-      end
-
-      def self.find_all name, requirement: Gem::Requirement.new.to_s
-        specification.find_all_by_name name, requirement
-      end
-
-      attr_reader :version
-
-      def initialize file_path
-        @file_path = file_path
-        @spec = self.class.specification.load file_path.to_s
-        validate
-        @version = Versionaire::Version @spec.version.to_s
-      end
-
-      def name
-        spec.name
-      end
-
-      def path
-        spec.full_gem_path
-      end
-
-      def homepage_url
-        String spec.homepage
-      end
-
-      def allowed_push_key
-        spec.metadata.fetch "allowed_push_key", "rubygems_api_key"
-      end
-
-      def allowed_push_host
-        spec.metadata.fetch "allowed_push_host", self.class.default_gem_host
-      end
-
-      def package_file_name
-        "#{name}-#{version}.gem"
-      end
-
-      def package_path
-        Pathname("pkg").join package_file_name
-      end
-
-      private
-
-      attr_reader :file_path, :spec
-
-      def validate
-        return if spec.is_a? self.class.specification
-
-        fail Errors::Specification, %(Unknown gem specification: "#{file_path}".)
-      end
-    end
-  end
-end

data/lib/gemsmith/generators/base.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-require "pathname"
-
-module Gemsmith
-  module Generators
-    # Abstract class from which all generators inherit from.
-    class Base
-      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
-      end
-
-      def initialize cli, configuration: {}
-        @cli = cli
-        @configuration = configuration
-      end
-
-      def run
-        fail NotImplementedError, "The method, #run, is not implemented yet."
-      end
-
-      protected
-
-      attr_reader :cli, :configuration
-
-      def gem_name
-        configuration.dig :gem, :name
-      end
-
-      def gem_path
-        configuration.dig :gem, :path
-      end
-
-      def gem_root
-        Pathname(cli.destination_root).join gem_name
-      end
-
-      def template path
-        cli.template path, configuration
-      end
-    end
-  end
-end

data/lib/gemsmith/generators/bundler.rb

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

data/lib/gemsmith/generators/bundler_audit.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Gemsmith
-  module Generators
-    # Generates Bundler Audit support.
-    class BundlerAudit < Base
-      def run
-        return if configuration.dig :generate, :bundler_audit
-
-        cli.gsub_file "#{gem_name}/Rakefile", %r(require.+bundler/audit.+\n), ""
-        cli.gsub_file "#{gem_name}/Rakefile", /Bundler::Audit.+\n/, ""
-      end
-    end
-  end
-end

data/lib/gemsmith/generators/circle_ci.rb

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