gemsmith 15.3.0 → 16.1.0

data/lib/gemsmith/generators/cli.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Gemsmith
-  module Generators
-    # Generates Command Line Interface (CLI) support.
-    class CLI < Base
-      def run
-        return unless configuration.dig :generate, :cli
-
-        template "%gem_name%/bin/%gem_name%.tt"
-        template "%gem_name%/lib/%gem_path%/cli.rb.tt"
-        template "%gem_name%/spec/lib/%gem_path%/cli_spec.rb.tt"
-        cli.chmod "#{gem_name}/bin/#{gem_name}", 0o755
-      end
-    end
-  end
-end

data/lib/gemsmith/generators/documentation.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require "tocer"
-
-module Gemsmith
-  module Generators
-    # Generates documentation support.
-    class Documentation < Base
-      def run
-        create_files
-        update_readme
-      end
-
-      private
-
-      def create_files
-        template "%gem_name%/README.md.tt"
-        template "%gem_name%/CONTRIBUTING.md.tt"
-        template "%gem_name%/CODE_OF_CONDUCT.md.tt"
-        template "%gem_name%/LICENSE.md.tt"
-        template "%gem_name%/CHANGES.md.tt"
-      end
-
-      def update_readme
-        gem_root.join("README.md").then { |path| Tocer::Writer.new(path).call }
-      end
-    end
-  end
-end

data/lib/gemsmith/generators/engine.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-module Gemsmith
-  module Generators
-    # Generates Ruby on Rails Engine support.
-    class Engine < Base
-      # :reek:TooManyStatements
-      def run
-        return unless runnable?
-
-        install_rails
-        create_engine
-        create_generator_files
-        stub_assets
-        remove_files
-      end
-
-      private
-
-      def runnable?
-        configuration.dig :generate, :engine
-      end
-
-      def install_rails
-        return if cli.run "command -v rails > /dev/null"
-
-        cli.run "gem install rails" if cli.yes? "Would you like to install Ruby on Rails (y/n)?"
-      end
-
-      def create_engine
-        template "#{LIB_ROOT}/%gem_path%/engine.rb.tt"
-        cli.run "rails plugin new --skip #{configuration.dig :gem, :name} #{engine_options}"
-      end
-
-      def create_generator_files
-        cli.empty_directory "#{generator_root}/templates"
-        template "#{generator_root}/install/install_generator.rb.tt"
-        template "#{generator_root}/install/USAGE.tt"
-        template "#{generator_root}/upgrade/upgrade_generator.rb.tt"
-        template "#{generator_root}/upgrade/USAGE.tt"
-      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")
-      end
-
-      # rubocop:disable Metrics/AbcSize
-      def remove_files
-        cli.remove_file "#{gem_name}/app/helpers/#{gem_path}/application_helper.rb", configuration
-        cli.remove_file "#{gem_name}/lib/#{gem_path}/version.rb", configuration
-        cli.remove_file "#{gem_name}/MIT-LICENSE", configuration
-        cli.remove_file "#{gem_name}/README.rdoc", configuration
-      end
-      # rubocop:enable Metrics/AbcSize
-
-      def engine_options
-        "--skip-git " \
-        "--skip-bundle " \
-        "--skip-keeps " \
-        "--skip-turbolinks " \
-        "--skip-spring " \
-        "--skip-test " \
-        "--mountable " \
-        "--dummy-path=spec/dummy"
-      end
-
-      def generator_root
-        "#{LIB_ROOT}/generators/%gem_path%"
-      end
-
-      def indentation
-        "  " * (configuration.dig(:gem, :path).scan("/").size + 1)
-      end
-    end
-  end
-end

data/lib/gemsmith/generators/gem.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Gemsmith
-  module Generators
-    # Generates default gem support.
-    class Gem < Base
-      def run
-        create_binaries
-        create_skeleton
-      end
-
-      private
-
-      def create_binaries
-        template "%gem_name%/bin/console.tt"
-        template "%gem_name%/bin/setup.tt"
-        cli.chmod "#{gem_name}/bin/console", 0o755
-        cli.chmod "#{gem_name}/bin/setup", 0o755
-      end
-
-      def create_skeleton
-        template "%gem_name%/Gemfile.tt"
-        template "%gem_name%/%gem_name%.gemspec.tt"
-        template "#{LIB_ROOT_GEM}.rb.tt"
-        template "#{LIB_ROOT_GEM}/identity.rb.tt"
-      end
-    end
-  end
-end

data/lib/gemsmith/generators/git.rb

@@ -1,45 +0,0 @@
-# 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
-      end
-
-      def run
-        create_ignore_file
-        create_repository
-      end
-
-      private
-
-      attr_reader :shell
-
-      def create_ignore_file
-        template "%gem_name%/.gitignore.tt"
-      end
-
-      def create_repository
-        create_commit "Added gem skeleton",
-                      "Generated with [#{Identity::LABEL}](#{Identity::URL})\n" \
-                      "#{Identity::VERSION}."
-      end
-
-      def create_commit subject, body
-        gem_root.change_dir do
-          shell.capture3 "git init"
-          shell.capture3 "git add ."
-          shell.capture3 %(git commit --all --no-verify --message "#{subject}" --message "#{body}")
-        end
-      end
-    end
-  end
-end

data/lib/gemsmith/generators/git_hub.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Gemsmith
-  module Generators
-    # Generates GitHub support.
-    class GitHub < Base
-      def run
-        return unless configuration.dig :generate, :git_hub
-
-        template "%gem_name%/.github/ISSUE_TEMPLATE.md.tt"
-        template "%gem_name%/.github/PULL_REQUEST_TEMPLATE.md.tt"
-      end
-    end
-  end
-end

data/lib/gemsmith/generators/git_lint.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Gemsmith
-  module Generators
-    # Generates Git Lint support.
-    class GitLint < Base
-      def run
-        return if configuration.dig :generate, :git_lint
-
-        cli.gsub_file "#{gem_name}/Rakefile", %r(require.+git/lint.+\n), ""
-      end
-    end
-  end
-end

data/lib/gemsmith/generators/guard.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Gemsmith
-  module Generators
-    # Generates Guard support.
-    class Guard < Base
-      def run
-        return unless configuration.dig :generate, :guard
-
-        template "%gem_name%/Guardfile.tt"
-      end
-    end
-  end
-end

data/lib/gemsmith/generators/pragma.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require "pathname"
-require "pragmater"
-
-module Gemsmith
-  module Generators
-    # Formats pragma comments in source files.
-    class Pragma < Base
-      DEFAULT_COMMENTS = ["# frozen_string_literal: true"].freeze
-
-      def run
-        Pragmater::Runner.for(**attributes).call
-      end
-
-      # rubocop:disable Metrics/MethodLength
-      def includes
-        %W[
-          **/*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
-      # rubocop:enable Metrics/MethodLength
-
-      private
-
-      def attributes
-        {
-          action: :insert,
-          root_dir: gem_root,
-          comments: DEFAULT_COMMENTS,
-          includes: includes
-        }
-      end
-    end
-  end
-end

data/lib/gemsmith/generators/rake.rb

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-require "refinements/arrays"
-
-module Gemsmith
-  module Generators
-    # Generates Rake support.
-    class Rake < Base
-      using Refinements::Arrays
-
-      def run
-        template "%gem_name%/Rakefile.tt"
-        append_code_quality_task
-        append_default_task
-      end
-
-      def generate_code_quality_task
-        return "" if code_quality_tasks.empty?
-
-        %(\ndesc "Run code quality checks"\ntask code_quality: %i[#{code_quality_tasks}]\n)
-      end
-
-      def generate_default_task
-        return "" if default_task.empty?
-
-        %(\ntask default: %i[#{default_task}]\n)
-      end
-
-      private
-
-      def rspec_task
-        configuration.dig(:generate, :rspec) ? "spec" : ""
-      end
-
-      def bundler_audit_task
-        configuration.dig(:generate, :bundler_audit) ? "bundle:audit" : ""
-      end
-
-      def git_lint_task
-        configuration.dig(:generate, :git_lint) ? "git_lint" : ""
-      end
-
-      def reek_task
-        configuration.dig(:generate, :reek) ? "reek" : ""
-      end
-
-      def rubocop_task
-        configuration.dig(:generate, :rubocop) ? "rubocop" : ""
-      end
-
-      def code_quality_tasks
-        [
-          bundler_audit_task,
-          git_lint_task,
-          reek_task,
-          rubocop_task
-        ].compress.join " "
-      end
-
-      def code_quality_task
-        code_quality_tasks.empty? ? "" : "code_quality"
-      end
-
-      def default_task
-        [code_quality_task, rspec_task].compress.join " "
-      end
-
-      def append_code_quality_task
-        return if code_quality_task.empty?
-
-        cli.append_to_file "%gem_name%/Rakefile", generate_code_quality_task
-      end
-
-      def append_default_task
-        return if default_task.empty?
-
-        cli.append_to_file "%gem_name%/Rakefile", generate_default_task
-      end
-    end
-  end
-end

data/lib/gemsmith/generators/reek.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Gemsmith
-  module Generators
-    # Generates Reek support.
-    class Reek < Base
-      def run
-        if configuration.dig :generate, :reek
-          template "%gem_name%/.reek.yml.tt"
-        else
-          cli.gsub_file "#{gem_name}/Rakefile", /require.+reek.+\n/, ""
-          cli.gsub_file "#{gem_name}/Rakefile", /Reek.+\n/, ""
-        end
-      end
-    end
-  end
-end

data/lib/gemsmith/generators/rspec.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Gemsmith
-  module Generators
-    # Generates RSpec support.
-    class Rspec < Base
-      def run
-        if configuration.dig :generate, :rspec
-          install_templates
-        else
-          remove_rake_lines
-        end
-      end
-
-      private
-
-      def remove_rake_lines
-        cli.gsub_file "#{gem_name}/Rakefile", /require.+rspec.+\n/, ""
-        cli.gsub_file "#{gem_name}/Rakefile", /RSpec.+\n/, ""
-      end
-
-      def install_templates
-        template "#{rspec_root}/spec_helper.rb.tt"
-        install_rails_helper
-        template "#{rspec_root}/support/shared_contexts/temp_dir.rb.tt"
-      end
-
-      def rspec_root
-        "%gem_name%/spec"
-      end
-
-      def install_rails_helper
-        return unless configuration.dig :generate, :engine
-
-        template "#{rspec_root}/rails_helper.rb.tt"
-      end
-    end
-  end
-end

data/lib/gemsmith/generators/rubocop.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Gemsmith
-  module Generators
-    # Generates Rubocop support.
-    class Rubocop < Base
-      def run
-        if configuration.dig :generate, :rubocop
-          template "%gem_name%/.rubocop.yml.tt"
-          cli.run "cd #{gem_name} && bundle exec rubocop --auto-correct > /dev/null"
-        else
-          cli.gsub_file "#{gem_name}/Rakefile", /require.+rubocop.+\n/, ""
-          cli.gsub_file "#{gem_name}/Rakefile", /RuboCop.+\n/, ""
-        end
-      end
-    end
-  end
-end

data/lib/gemsmith/generators/ruby.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Gemsmith
-  module Generators
-    # Generates Ruby support.
-    class Ruby < Base
-      def run
-        template "%gem_name%/.ruby-version.tt"
-      end
-    end
-  end
-end

data/lib/gemsmith/helpers/cli.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-module Gemsmith
-  module Helpers
-    # Command Line Interface (CLI) helpers for the CLI class.
-    module CLI
-      module_function
-
-      def print_gems gems
-        say "Multiple versions found:\n\n"
-
-        gems.each.with_index do |spec, index|
-          say "#{index + 1}. #{spec.name} #{spec.version.version}"
-        end
-
-        say "q. Quit.\n\n"
-      end
-
-      # :reek:FeatureEnvy
-      # :reek:TooManyStatements
-      def pick_gem gems, name
-        answer = ask "Enter selection:"
-        return if answer == "q"
-
-        answer = answer.to_i
-
-        if (1..gems.size).cover? answer
-          Gem::Specification.find name, gems[answer - 1].version.version
-        else
-          say_status :error, "Invalid option: #{answer}", :red
-          nil
-        end
-      end
-
-      def inspect_gem specification, method
-        return unless specification
-
-        Gem::Inspector.new.public_send method, Gem::Specification.new(specification.spec_file)
-      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
-
-        if spec_count == 1
-          inspect_gem specs.first, method
-        elsif spec_count > 1
-          print_gems specs
-          inspect_gem pick_gem(specs, name), method
-        else
-          say_status :error, "Unable to find gem: #{name}.", :red and ""
-        end
-      end
-    end
-  end
-end

data/lib/gemsmith/helpers/template.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Gemsmith
-  module Helpers
-    # Provides Thor CLI helper methods. These methods are necessary to resolve %% file and folder
-    # variables and render dynamic content within the Thor ERB *templates* structure.
-    module Template
-      def gem_name
-        configuration.dig :gem, :name
-      end
-
-      def gem_path
-        configuration.dig :gem, :path
-      end
-
-      def gem_class
-        configuration.dig :gem, :class
-      end
-
-      def rails_version
-        configuration.dig :versions, :rails
-      end
-
-      def render_namespace &block
-        body = capture(&block) if block
-        concat Gem::ModuleFormatter.new(gem_class).render(body)
-      end
-    end
-  end
-end

data/lib/gemsmith/identity.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Gemsmith
-  # Gem identity information.
-  module Identity
-    NAME = "gemsmith"
-    LABEL = "Gemsmith"
-    VERSION = "15.3.0"
-    VERSION_LABEL = "#{LABEL} #{VERSION}"
-    URL = "https://www.alchemists.io/projects/gemsmith"
-  end
-end

data/lib/gemsmith/rake/builder.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/ui/shell"
-require "refinements/pathnames"
-
-module Gemsmith
-  module Rake
-    # Provides gem build functionality. Meant to be wrapped in Rake tasks.
-    class Builder
-      using Refinements::Pathnames
-
-      def initialize root: Pathname("pkg"), shell: Bundler::UI::Shell.new, kernel: Kernel
-        @root = root
-        @shell = shell
-        @kernel = kernel
-      end
-
-      def clean
-        root.remove_tree
-        shell.confirm "Cleaned gem artifacts."
-      end
-
-      def validate
-        return if `git status --porcelain`.empty?
-
-        shell.error "Build failed: Gem has uncommitted changes."
-        kernel.exit 1
-      end
-
-      def build gem_spec
-        path = gem_spec.package_path
-
-        if kernel.system "gem build #{gem_spec.name}.gemspec"
-          root.make_path
-          Pathname(gem_spec.package_file_name).copy path
-          shell.confirm "Built: #{path}."
-        else
-          shell.error "Unable to build: #{path}."
-        end
-      end
-
-      def install gem_spec
-        gem_name = "#{gem_spec.name} #{gem_spec.version}"
-
-        if kernel.system "gem install #{gem_spec.package_path}"
-          shell.confirm "Installed: #{gem_name}."
-        else
-          shell.error "Unable to install: #{gem_name}."
-        end
-      end
-
-      private
-
-      attr_reader :root, :shell, :kernel
-    end
-  end
-end