gemsmith 7.7.0 → 8.0.0

data/lib/gemsmith/generators/guard.rb

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

data/lib/gemsmith/generators/pragma.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "pragmater"
+require "pathname"
+
+module Gemsmith
+  module Generators
+    # Formats pragma comments in source files.
+    class Pragma < Base
+      def self.comments
+        ["# frozen_string_literal: true"]
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def whitelist
+        %W[
+          Gemfile
+          Guardfile
+          Rakefile
+          config.ru
+          bin/#{configuration.dig :gem, :name}
+          bin/rails
+          .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(%(#{cli.destination_root}/**/*{#{whitelist.join ","}})).select(&:file?)
+      end
+    end
+  end
+end

data/lib/gemsmith/generators/rails.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Gemsmith
+  module Generators
+    # Generates Ruby on Rails support.
+    class Rails < Base
+      def rails?
+        cli.run "command -v rails > /dev/null"
+      end
+
+      def install_rails
+        return if rails?
+        return unless cli.yes?("Ruby on Rails is not installed. Would you like to install it (y/n)?")
+        cli.run "gem install rails"
+      end
+
+      def create_engine
+        cli.template "#{lib_root}/%gem_path%/engine.rb.tt", configuration
+        cli.run "rails plugin new --skip #{configuration.dig :gem, :name} #{engine_options}"
+      end
+
+      def create_generator_files
+        cli.empty_directory "#{generator_root}/templates"
+        cli.template "#{generator_root}/install/install_generator.rb.tt", configuration
+        cli.template "#{generator_root}/install/USAGE.tt", configuration
+        cli.template "#{generator_root}/upgrade/upgrade_generator.rb.tt", configuration
+        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 add_comments
+        file = "%gem_name%/app/controllers/%gem_path%/application_controller.rb"
+        comment = "#{indentation}# The application controller.\n"
+        cli.insert_into_file file, comment, before: /.+class.+/
+
+        file = "%gem_name%/app/mailers/%gem_path%/application_mailer.rb"
+        comment = "#{indentation}# The application mailer.\n"
+        cli.insert_into_file file, comment, before: /.+class.+/
+
+        file = "%gem_name%/app/models/%gem_path%/application_record.rb"
+        comment = "#{indentation}# The application record.\n"
+        cli.insert_into_file file, comment, before: /.+class.+/
+      end
+
+      def remove_files
+        gem_name = configuration.dig :gem, :name
+        gem_path = configuration.dig :gem, :path
+
+        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
+
+      def run
+        return unless configuration.dig(:generate, :rails)
+
+        install_rails
+        create_engine
+        create_generator_files
+        create_travis_gemfiles
+        add_comments
+        remove_files
+      end
+
+      private
+
+      def engine_options
+        "--skip-bundle --skip-test --skip-keeps --skip-git --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/rake.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Gemsmith
+  module Generators
+    # Generates Rake support.
+    class Rake < Base
+      def run
+        cli.template "%gem_name%/Rakefile.tt", configuration
+        configure_rakefile
+      end
+
+      private
+
+      def rspec_task
+        "spec" if configuration.dig(:generate, :rspec)
+      end
+
+      def reek_task
+        "reek" if configuration.dig(:generate, :reek)
+      end
+
+      def rubocop_task
+        "rubocop" if configuration.dig(:generate, :rubocop)
+      end
+
+      def scss_lint_task
+        "scss_lint" if configuration.dig(:generate, :scss_lint)
+      end
+
+      def default_tasks
+        [rspec_task, reek_task, rubocop_task, scss_lint_task].compact
+      end
+
+      def configure_rakefile
+        return if default_tasks.empty?
+        cli.append_to_file "%gem_name%/Rakefile", %(\ntask default: %w[#{default_tasks.join(" ")}]\n)
+      end
+    end
+  end
+end

data/lib/gemsmith/generators/reek.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Gemsmith
+  module Generators
+    # Generates Reek support.
+    class Reek < Base
+      def run
+        return unless configuration.dig(:generate, :reek)
+        cli.template "%gem_name%/lib/tasks/reek.rake.tt", configuration
+      end
+    end
+  end
+end

data/lib/gemsmith/generators/rspec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Gemsmith
+  module Generators
+    # Generates RSpec support.
+    class Rspec < Base
+      def run
+        return unless configuration.dig(:generate, :rspec)
+
+        cli.template "%gem_name%/lib/tasks/rspec.rake.tt", configuration
+        cli.template "#{rspec_root}/spec_helper.rb.tt", configuration
+        cli.template("#{rspec_root}/rails_helper.rb.tt", configuration) if configuration.dig(:generate, :rails)
+        cli.template "#{rspec_root}/support/shared_contexts/temp_dir.rb.tt", configuration
+      end
+
+      private
+
+      def rspec_root
+        "%gem_name%/spec"
+      end
+    end
+  end
+end

data/lib/gemsmith/generators/rubocop.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Gemsmith
+  module Generators
+    # Generates Rubocop support.
+    class Rubocop < Base
+      def run
+        return unless configuration.dig(:generate, :rubocop)
+
+        cli.template "%gem_name%/.rubocop.yml.tt", configuration
+        cli.template "%gem_name%/lib/tasks/rubocop.rake.tt", configuration
+        cli.run "rubocop --auto-correct > /dev/null"
+      end
+    end
+  end
+end

data/lib/gemsmith/{skeletons/ruby_skeleton.rb → generators/ruby.rb}

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 module Gemsmith
-  module Skeletons
-    # Configures Ruby support.
-    class RubySkeleton < BaseSkeleton
-      def create
-        cli.template "%gem_name%/.ruby-version.tt", configuration.to_h
+  module Generators
+    # Generates Ruby support.
+    class Ruby < Base
+      def run
+        cli.template "%gem_name%/.ruby-version.tt", configuration
       end
     end
   end

data/lib/gemsmith/generators/scss_lint.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Gemsmith
+  module Generators
+    # Generates SCSS Lint support.
+    class SCSSLint < Base
+      def run
+        return unless configuration.dig(:generate, :scss_lint)
+        cli.template "%gem_name%/lib/tasks/scss_lint.rake.tt", configuration
+      end
+    end
+  end
+end

data/lib/gemsmith/generators/travis.rb

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

data/lib/gemsmith/git.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Gemsmith
+  # A thin wrapper to Git.
+  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
+end

data/lib/gemsmith/identity.rb

@@ -12,7 +12,7 @@ module Gemsmith
     end
 
     def self.version
-      "7.7.0"
+      "8.0.0"
     end
 
     def self.version_label

data/lib/gemsmith/rake/builder.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "bundler/ui/shell"
+require "fileutils"
+require "tocer"
+
+module Gemsmith
+  module Rake
+    # Provides gem build functionality. Meant to be wrapped in Rake tasks.
+    class Builder
+      def initialize tocer: Tocer::Writer, shell: Bundler::UI::Shell.new, kernel: Kernel
+        @tocer = tocer
+        @shell = shell
+        @kernel = kernel
+      end
+
+      def doc
+        readme = File.join Dir.pwd, "README.md"
+        tocer.new(readme).write
+        shell.confirm "Updated gem documentation."
+      end
+
+      def clean
+        FileUtils.rm_rf "pkg"
+        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 = package_path gem_spec
+
+        if kernel.system("gem build #{gem_spec.name}.gemspec")
+          FileUtils.mkdir_p "pkg"
+          FileUtils.mv gem_spec.package_file_name, 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_number}"
+
+        if kernel.system("gem install #{package_path gem_spec}")
+          shell.confirm "Installed: #{gem_name}."
+        else
+          shell.error "Unable to install: #{gem_name}."
+        end
+      end
+
+      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/{release.rb → publisher.rb}

@@ -2,22 +2,27 @@
 
 require "milestoner"
 require "gemsmith/credentials"
+require "gemsmith/git"
+require "gemsmith/identity"
 
 module Gemsmith
   module Rake
     # Provides gem release functionality. Meant to be wrapped in Rake tasks.
-    class Release
+    class Publisher
       def self.gem_spec_path
         String Dir["#{Dir.pwd}/*.gemspec"].first
       end
 
-      def initialize gem_spec: Gemsmith::Aids::GemSpec.new(self.class.gem_spec_path),
+      # rubocop:disable Metrics/ParameterLists
+      def initialize gem_spec: Gemsmith::Gem::Specification.new(self.class.gem_spec_path),
+                     gem_config: {},
                      credentials: Gemsmith::Credentials,
                      publisher: Milestoner::Publisher.new,
                      shell: Bundler::UI::Shell.new,
                      kernel: Kernel
 
         @gem_spec = gem_spec
+        @gem_config = gem_config
         @credentials = credentials
         @publisher = publisher
         @shell = shell
@@ -33,16 +38,20 @@ module Gemsmith
         process_push status
       end
 
-      def publish sign: true
-        publisher.publish gem_spec.version_number, sign: sign
+      def publish
+        publisher.publish gem_spec.version_number, sign: signed?
         push
       rescue Milestoner::Errors::Base => error
         shell.error error.message
       end
 
+      def signed?
+        gem_config.dig :publish, :sign
+      end
+
       private
 
-      attr_reader :gem_spec, :credentials, :publisher, :shell, :kernel
+      attr_reader :gem_spec, :gem_config, :credentials, :publisher, :shell, :kernel
 
       def translate_key key
         key == credentials.default_key ? :rubygems : key

data/lib/gemsmith/rake/tasks.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "gemsmith/aids/gem_spec"
+require "gemsmith/gem/specification"
 require "gemsmith/errors/base"
 require "gemsmith/errors/specification"
-require "gemsmith/rake/build"
-require "gemsmith/rake/release"
+require "gemsmith/rake/builder"
+require "gemsmith/rake/publisher"
 
 module Gemsmith
   module Rake
@@ -13,48 +12,61 @@ module Gemsmith
     class Tasks
       include ::Rake::DSL
 
+      def self.default_gem_spec
+        Dir.glob("#{Dir.pwd}/*.gemspec").first
+      end
+
       def self.setup
         new.install
       end
 
-      def initialize
-        @gem_spec = Gemsmith::Aids::GemSpec.new Dir.glob("#{Dir.pwd}/*.gemspec").first
-        @build = Gemsmith::Rake::Build.new
-        @release = Gemsmith::Rake::Release.new
+      def initialize gem_spec: Gem::Specification.new(self.class.default_gem_spec),
+                     builder: Rake::Builder.new,
+                     publisher: Rake::Publisher.new
+        @gem_spec = gem_spec
+        @builder = builder
+        @publisher = publisher
       end
 
       def install
-        ::Rake::Task[:build].enhance [:clean, :doc, :validate]
-        ::Rake::Task[:release].clear
-
         desc "Update README (table of contents)"
         task :doc do
-          build.doc
+          builder.doc
         end
 
         desc "Clean gem artifacts"
         task :clean do
-          build.clean
+          builder.clean
         end
 
         task :validate do
-          build.validate
+          builder.validate
         end
 
-        desc "Build, tag #{gem_spec.version_label} (unsigned), and push #{gem_spec.package_file_name} to RubyGems"
-        task release: :build do
-          release.publish sign: false
+        desc "Build #{gem_spec.package_file_name} package"
+        task build: [:clean, :doc, :validate] do
+          builder.build gem_spec
         end
 
-        desc "Build, tag #{gem_spec.version_label} (signed), and push #{gem_spec.package_file_name} to RubyGems"
+        desc "Install #{gem_spec.package_file_name} package"
+        task install: :build do
+          builder.install gem_spec
+        end
+
+        desc "Build, tag as #{gem_spec.version_label} (#{signed_label}), " \
+             "and push #{gem_spec.package_file_name} to RubyGems"
         task publish: :build do
-          release.publish
+          publisher.publish
         end
       end
 
       private
 
-      attr_reader :gem_spec, :build, :release
+      attr_reader :gem_spec, :builder, :publisher
+
+      def signed_label
+        publisher.signed? ? "signed" : "unsigned"
+      end
     end
   end
 end