gemsmith 7.7.0 → 8.0.0

data/lib/gemsmith/cli_helpers.rb

@@ -3,18 +3,6 @@
 module Gemsmith
   # Command Line Interface (CLI) helpers for the CLI class.
   module CLIHelpers
-    def gem_name
-      configuration.gem_name
-    end
-
-    def gem_class
-      configuration.gem_class
-    end
-
-    def rails_version
-      configuration.rails_version
-    end
-
     module_function
 
     def print_gems gems
@@ -28,27 +16,28 @@ module Gemsmith
       return if answer == "q"
 
       if (1..gems.size).cover?(answer.to_i)
-        gem_spec.find name, gems[answer.to_i - 1].version.version
+        Gem::Specification.find name, gems[answer.to_i - 1].version.version
       else
         error "Invalid option: #{answer}"
         nil
       end
     end
 
-    def open_gem specification, method
+    def inspect_gem specification, method
       return unless specification
-      spec = gem_spec.new specification.spec_file
-      spec.public_send method
+      Gem::Inspector.new.public_send method, Gem::Specification.new(specification.spec_file)
+    rescue Versionaire::Errors::Conversion => exception
+      error(exception.message)
     end
 
     def process_gem name, method
-      specs = gem_spec.find_all name
+      specs = Gem::Specification.find_all name
 
       if specs.size == 1
-        open_gem specs.first, method
+        inspect_gem specs.first, method
       elsif specs.size > 1
         print_gems specs
-        open_gem pick_gem(specs, name), method
+        inspect_gem pick_gem(specs, name), method
       else
         error("Unable to find gem: #{name}.") and ""
       end

data/lib/gemsmith/credentials.rb

@@ -6,7 +6,7 @@ require "gemsmith/authenticators/ruby_gems"
 require "gemsmith/authenticators/basic"
 
 module Gemsmith
-  # Configures gem credentials for RubyGems and/or alternative servers.
+  # Generates gem credentials for RubyGems and/or alternative servers.
   class Credentials
     attr_reader :key, :url
 
@@ -55,7 +55,7 @@ module Gemsmith
 
       FileUtils.mkdir_p File.dirname self.class.file_path
       File.open(self.class.file_path, "w") { |file| file << YAML.dump(new_credentials) }
-      FileUtils.chmod(0600, self.class.file_path)
+      FileUtils.chmod(0o600, self.class.file_path)
     end
 
     private

data/lib/gemsmith/gem/inspector.rb

@@ -0,0 +1,30 @@
+# 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.capture2 self.class.editor, specification.path
+      end
+
+      def visit specification
+        shell.capture2 "open", specification.homepage_url
+      end
+
+      private
+
+      attr_reader :shell
+    end
+  end
+end

data/lib/gemsmith/gem/module_formatter.rb

@@ -0,0 +1,51 @@
+# 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 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 + "#{indentation 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"
+        end
+      end
+
+      def suffix
+        modules.each.with_index.reduce "" do |result, (_, index)|
+          result + "#{indentation depth - index}end\n"
+        end
+      end
+
+      def indentation length
+        "  " * length
+      end
+    end
+  end
+end

data/lib/gemsmith/gem/requirement.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "versionaire"
 
 module Gemsmith

data/lib/gemsmith/{aids/gem_spec.rb → gem/specification.rb}

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "open3"
+require "versionaire"
 
 module Gemsmith
-  module Aids
+  module Gem
     # A Gem::Specification with additional enhancements.
-    class GemSpec
+    class Specification
       def self.specification
         ::Gem::Specification
       end
@@ -14,10 +14,6 @@ module Gemsmith
         ::Gem::DEFAULT_HOST
       end
 
-      def self.editor
-        ENV.fetch "EDITOR"
-      end
-
       def self.find name, version
         specification.find_by_name name, version
       end
@@ -26,11 +22,19 @@ module Gemsmith
         specification.find_all_by_name name, requirement
       end
 
-      def initialize file_path, shell: Open3
+      def initialize file_path
         @file_path = file_path
-        @shell = shell
         @spec = self.class.specification.load file_path
         validate
+        @version = Versionaire::Version @spec.version.to_s
+      end
+
+      def name
+        spec.name
+      end
+
+      def path
+        spec.full_gem_path
       end
 
       def homepage_url
@@ -45,36 +49,25 @@ module Gemsmith
         spec.metadata.fetch("allowed_push_host") { self.class.default_gem_host }
       end
 
-      def open_gem
-        shell.capture2 self.class.editor, spec.full_gem_path
-        String spec.full_gem_path
-      end
-
-      def open_homepage
-        shell.capture2 "open", homepage_url
-        homepage_url
-      end
-
       def version_number
-        spec.version.version
+        version.to_s
       end
 
       def version_label
-        "v#{version_number}"
+        version.label
       end
 
       def package_file_name
-        "#{spec.name}-#{version_number}.gem"
+        "#{name}-#{version_number}.gem"
       end
 
       private
 
-      attr_reader :file_path, :spec, :shell
+      attr_reader :file_path, :spec, :version
 
       def validate
-        unless spec.is_a?(self.class.specification)
-          fail(Errors::Specification, %(Unknown gem specification: "#{file_path}".))
-        end
+        return if spec.is_a?(self.class.specification)
+        fail(Errors::Specification, %(Unknown gem specification: "#{file_path}".))
       end
     end
   end

data/lib/gemsmith/generators/base.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Gemsmith
+  module Generators
+    # Abstract class from which all generators inherit from.
+    class Base
+      def initialize cli, configuration: {}
+        @cli = cli
+        @configuration = configuration
+      end
+
+      def self.run cli, configuration: {}
+        new(cli, configuration: configuration).run
+      end
+
+      def run
+        fail NotImplementedError, "The method, #run, is not implemented yet."
+      end
+
+      protected
+
+      attr_reader :cli, :configuration
+
+      def lib_root
+        File.join "%gem_name%", "lib"
+      end
+
+      def lib_gem_root
+        File.join lib_root, "%gem_path%"
+      end
+    end
+  end
+end

data/lib/gemsmith/generators/bundler.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Gemsmith
+  module Generators
+    # Generates Bundler support.
+    class Bundler < Base
+      def run
+        Dir.chdir(cli.destination_root) do
+          cli.info "Installing gem dependencies..."
+          `bundle install`
+        end
+      end
+    end
+  end
+end

data/lib/gemsmith/generators/cli.rb

@@ -0,0 +1,17 @@
+# 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)
+
+        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
+      end
+    end
+  end
+end

data/lib/gemsmith/generators/code_climate.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Gemsmith
+  module Generators
+    # Generates Code Climate support.
+    class CodeClimate < Base
+      def run
+        return unless configuration.dig(:generate, :code_climate)
+
+        cli.template "%gem_name%/.codeclimate.yml.tt", configuration
+      end
+    end
+  end
+end

data/lib/gemsmith/generators/documentation.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "tocer"
+
+module Gemsmith
+  module Generators
+    # Generates documentation support.
+    class Documentation < Base
+      def create_files
+        cli.template "%gem_name%/README.md.tt", configuration
+        cli.template "%gem_name%/CONTRIBUTING.md.tt", configuration
+        cli.template "%gem_name%/CODE_OF_CONDUCT.md.tt", configuration
+        cli.template "%gem_name%/LICENSE.md.tt", configuration
+        cli.template "%gem_name%/CHANGES.md.tt", configuration
+      end
+
+      def update_readme
+        file = File.join cli.destination_root, configuration.dig(:gem, :name), "README.md"
+        Tocer::Writer.new(file).write
+      end
+
+      def run
+        create_files
+        update_readme
+      end
+    end
+  end
+end

data/lib/gemsmith/generators/gem.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Gemsmith
+  module Generators
+    # Generates default gem support.
+    class Gem < Base
+      def run
+        cli.template "%gem_name%/bin/setup.tt", configuration
+        cli.template "%gem_name%/Gemfile.tt", configuration
+        cli.template "%gem_name%/%gem_name%.gemspec.tt", configuration
+        cli.template "#{lib_gem_root}.rb.tt", configuration
+        cli.template "#{lib_gem_root}/identity.rb.tt", configuration
+        cli.chmod "#{configuration.dig(:gem, :name)}/bin/setup", 0o755
+      end
+    end
+  end
+end

data/lib/gemsmith/{skeletons/git_skeleton.rb → generators/git.rb}

@@ -1,25 +1,31 @@
 # frozen_string_literal: true
 
 module Gemsmith
-  module Skeletons
-    # Configures Git support.
-    class GitSkeleton < BaseSkeleton
+  module Generators
+    # Generates Git support.
+    class Git < Base
       def create_ignore_file
-        cli.template "%gem_name%/.gitignore.tt", configuration.to_h
+        cli.template "%gem_name%/.gitignore.tt", configuration
       end
 
       def create_repository
-        Dir.chdir(File.join(cli.destination_root, configuration.gem_name)) do
+        Dir.chdir(gem_dir) do
           `git init`
           `git add .`
-          `git commit --all --no-verify --message "Added Gemsmith skeleton."`
+          `git commit --all --no-verify --message "Added Gemsmith files."`
         end
       end
 
-      def create
+      def run
         create_ignore_file
         create_repository
       end
+
+      private
+
+      def gem_dir
+        File.join cli.destination_root, configuration.dig(:gem, :name)
+      end
     end
   end
 end

data/lib/gemsmith/generators/git_hub.rb

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