gemsmith 5.6.0 → 6.0.0

data/lib/gemsmith/configuration.rb

@@ -0,0 +1,189 @@
+module Gemsmith
+  # Default configuration for gem with support for custom settings.
+  class Configuration
+    attr_reader :gem_name, :gem_class, :file_path
+    attr_writer :gem_platform, :gem_home_url, :gem_license, :gem_private_key, :gem_public_key, :author_name,
+                :author_email, :author_url, :organization_name, :organization_email, :organization_url,
+                :ruby_version, :rails_version, :create_cli, :create_rails, :create_security, :create_pry,
+                :create_guard, :create_rspec, :create_rubocop, :create_code_climate, :create_gemnasium,
+                :create_travis, :create_patreon, :github_user, :year
+
+    def initialize gem_name: "unknown",
+                   gem_class: "Unknown",
+                   git: Aids::Git,
+                   file_path: File.join(ENV["HOME"], Identity.file_name)
+
+      @gem_name = gem_name
+      @gem_class = gem_class
+      @file_path = file_path
+      @git = git
+      @settings = load_settings
+    end
+
+    def gem_platform
+      @gem_platform || settings_group(:gem).fetch(:platform, "Gem::Platform::RUBY")
+    end
+
+    def gem_home_url
+      @gem_home_url || settings_group(:gem).fetch(:home_url, github_gem_url)
+    end
+
+    def gem_license
+      @gem_license || settings_group(:gem).fetch(:license, "MIT")
+    end
+
+    def gem_private_key
+      @gem_private_key || settings_group(:gem).fetch(:private_key, "~/.ssh/gem-private.pem")
+    end
+
+    def gem_public_key
+      @gem_public_key || settings_group(:gem).fetch(:public_key, "~/.ssh/gem-public.pem")
+    end
+
+    def author_name
+      @author_name || settings_group(:author).fetch(:name, git.config_value("user.name"))
+    end
+
+    def author_email
+      @author_email || settings_group(:author).fetch(:email, git.config_value("user.email"))
+    end
+
+    def author_url
+      @author_url || settings_group(:author).fetch(:url, "")
+    end
+
+    def organization_name
+      @organization_name || settings_group(:organization).fetch(:name, "")
+    end
+
+    def organization_url
+      @organization_url || settings_group(:organization).fetch(:url, "")
+    end
+
+    def ruby_version
+      @ruby_version || settings_group(:versions).fetch(:ruby, RUBY_VERSION)
+    end
+
+    def rails_version
+      @rails_version || settings_group(:versions).fetch(:rails, "4.2")
+    end
+
+    def create_cli?
+      parse_boolean @create_cli, :create, :cli, false
+    end
+
+    def create_rails?
+      parse_boolean @create_rails, :create, :rails, false
+    end
+
+    def create_security?
+      parse_boolean @create_security, :create, :security, true
+    end
+
+    def create_pry?
+      parse_boolean @create_pry, :create, :pry, true
+    end
+
+    def create_guard?
+      parse_boolean @create_guard, :create, :guard, true
+    end
+
+    def create_rspec?
+      parse_boolean @create_rspec, :create, :rspec, true
+    end
+
+    def create_rubocop?
+      parse_boolean @create_rubocop, :create, :rubocop, true
+    end
+
+    def create_code_climate?
+      parse_boolean @create_code_climate, :create, :code_climate, true
+    end
+
+    def create_gemnasium?
+      parse_boolean @create_gemnasium, :create, :gemnasium, true
+    end
+
+    def create_travis?
+      parse_boolean @create_travis, :create, :travis, true
+    end
+
+    def create_patreon?
+      parse_boolean @create_patreon, :create, :patreon, true
+    end
+
+    def github_user
+      @github_user || settings.fetch(:github_user, git.config_value("github.user"))
+    end
+
+    def year
+      @year || settings.fetch(:year, Time.now.year)
+    end
+
+    def to_h
+      {
+        year: year,
+        github_user: github_user,
+        gem: {
+          name: gem_name,
+          class: gem_class,
+          platform: gem_platform,
+          home_url: gem_home_url,
+          license: gem_license,
+          private_key: gem_private_key,
+          public_key: gem_public_key
+        },
+        author: {
+          name: author_name,
+          email: author_email,
+          url: author_url
+        },
+        organization: {
+          name: organization_name,
+          url: organization_url
+        },
+        versions: {
+          ruby: ruby_version,
+          rails: rails_version
+        },
+        create: {
+          cli: create_cli?,
+          rails: create_rails?,
+          security: create_security?,
+          pry: create_pry?,
+          guard: create_guard?,
+          rspec: create_rspec?,
+          rubocop: create_rubocop?,
+          code_climate: create_code_climate?,
+          gemnasium: create_gemnasium?,
+          travis: create_travis?,
+          patreon: create_patreon?
+        }
+      }
+    end
+
+    private
+
+    attr_reader :gem_parser, :git, :settings
+
+    def load_settings
+      return {} unless File.exist?(file_path)
+      yaml = YAML.load_file file_path
+      yaml.is_a?(Hash) ? yaml : {}
+    end
+
+    def settings_group key
+      settings.fetch key, {}
+    end
+
+    def parse_boolean variable, group_key, item_key, default_value
+      return variable if [true, false].include?(variable)
+      settings_group(group_key).fetch item_key, default_value
+    end
+
+    def github_gem_url
+      return "" if github_user.nil?
+      "https://github.com/#{github_user}/#{gem_name}"
+    end
+  end
+end

data/lib/gemsmith/identity.rb

@@ -10,11 +10,11 @@ module Gemsmith
     end
 
     def self.version
-      "5.6.0"
+      "6.0.0"
     end
 
     def self.version_label
-      [label, version].join " "
+      "#{label} #{version}"
     end
 
     def self.file_name

data/lib/gemsmith/rake/build.rb

@@ -1,38 +1,36 @@
 require "bundler/ui/shell"
+require "tocer"
 
 module Gemsmith
   module Rake
     # Provides gem build functionality. Meant to be wrapped in Rake tasks.
     class Build
-      def initialize shell: Bundler::UI::Shell.new, kernel: Kernel
-        @shell = shell
+      def initialize tocer: Tocer::Writer, shell: Bundler::UI::Shell, kernel: Kernel
+        @tocer = tocer
+        @shell = shell.new
         @kernel = kernel
       end
 
-      def table_of_contents
-        if kernel.system("command -v doctoc > /dev/null")
-          kernel.system %(doctoc --title "# Table of Contents" README.md)
-        else
-          shell.error error_message
-          kernel.exit 1
-        end
+      def doc
+        readme = File.join Dir.pwd, "README.md"
+        tocer.new(readme).write
+        shell.confirm "Updated gem documentation."
       end
 
-      def clean!
+      def clean
         FileUtils.rm_rf "pkg"
-        shell.info "Gem artifacts cleaned."
+        shell.confirm "Cleaned gem artifacts."
       end
 
-      private
-
-      attr_reader :shell, :kernel
+      def validate
+        return if `git status --porcelain`.empty?
+        shell.error "Build failed: Gem has uncommitted changes."
+        kernel.exit 1
+      end
 
-      def error_message
-        url = "https://github.com/thlorenz/doctoc"
-        command = "npm install --global doctoc"
+      private
 
-        "Unable to update README Table of Contents, please install DocToc (#{url}): #{command}."
-      end
+      attr_reader :tocer, :shell, :kernel
     end
   end
 end

data/lib/gemsmith/rake/tasks.rb

@@ -16,23 +16,25 @@ module Gemsmith
         build = Gemsmith::Rake::Build.new
         release = Gemsmith::Rake::Release.new
 
-        ::Rake::Task[:build].enhance [:clean, "readme:toc"]
+        ::Rake::Task[:build].enhance [:clean, :doc, :validate]
         ::Rake::Task[:release].enhance { ::Rake::Task[:clean].invoke }
 
-        namespace :readme do
-          desc "Update README Table of Contents."
-          task :toc do
-            build.table_of_contents
-          end
+        desc "Update README (table of contents)"
+        task :doc do
+          build.doc
         end
 
-        desc "Clean gem artifacts."
+        desc "Clean gem artifacts"
         task :clean do
-          build.clean!
+          build.clean
+        end
+
+        task :validate do
+          build.validate
         end
 
         desc "Build, tag #{release.version_label} (signed), and push #{release.gem_file_name} to RubyGems"
-        task publish: [:clean, :build, "release:guard_clean"] do
+        task publish: [:build, "release:guard_clean"] do
           release.publish
           ::Rake::Task["release:rubygem_push"].invoke
         end

data/lib/gemsmith/skeletons/base_skeleton.rb

@@ -2,25 +2,22 @@ module Gemsmith
   module Skeletons
     # Abstract class from which all skeletons inherit from.
     class BaseSkeleton
-      def initialize cli
+      def initialize cli, configuration: Configuration.new
         @cli = cli
+        @configuration = configuration
       end
 
-      def self.create cli
-        new(cli).create
-      end
-
-      def enabled?
-        true
+      def self.create cli, configuration: Configuration.new
+        new(cli, configuration: configuration).create
       end
 
       def create
         fail NotImplementedError, "The method, #create, is not implemented yet."
       end
 
-      private
+      protected
 
-      attr_reader :cli
+      attr_reader :cli, :configuration
 
       def lib_root
         "%gem_name%/lib"

data/lib/gemsmith/skeletons/bundler_skeleton.rb

@@ -3,7 +3,7 @@ module Gemsmith
     # Configures Bundler support.
     class BundlerSkeleton < BaseSkeleton
       def create
-        Dir.chdir(File.join(cli.destination_root, cli.gem_name)) do
+        Dir.chdir(File.join(cli.destination_root, configuration.gem_name)) do
           cli.info "Installing gem dependencies..."
           `bundle install`
         end

data/lib/gemsmith/skeletons/cli_skeleton.rb

@@ -2,15 +2,11 @@ module Gemsmith
   module Skeletons
     # Configures Command Line Interface (CLI) support.
     class CLISkeleton < BaseSkeleton
-      def enabled?
-        cli.template_options.key?(:bin) && cli.template_options[:bin]
-      end
-
       def create
-        return unless enabled?
+        return unless configuration.create_cli?
 
-        cli.template "%gem_name%/bin/%gem_name%.tt", cli.template_options
-        cli.template "%gem_name%/lib/%gem_name%/cli.rb.tt", cli.template_options
+        cli.template "%gem_name%/bin/%gem_name%.tt", configuration.to_h
+        cli.template "%gem_name%/lib/%gem_name%/cli.rb.tt", configuration.to_h
       end
     end
   end

data/lib/gemsmith/skeletons/documentation_skeleton.rb

@@ -1,13 +1,25 @@
+require "tocer"
+
 module Gemsmith
   module Skeletons
     # Configures documentation support.
     class DocumentationSkeleton < BaseSkeleton
+      def create_files
+        cli.template "%gem_name%/README.md.tt", configuration.to_h
+        cli.template "%gem_name%/CONTRIBUTING.md.tt", configuration.to_h
+        cli.template "%gem_name%/CODE_OF_CONDUCT.md.tt", configuration.to_h
+        cli.template "%gem_name%/LICENSE.md.tt", configuration.to_h
+        cli.template "%gem_name%/CHANGELOG.md.tt", configuration.to_h
+      end
+
+      def update_readme
+        file = File.join cli.destination_root, configuration.gem_name, "README.md"
+        Tocer::Writer.new(file).write
+      end
+
       def create
-        cli.template "%gem_name%/README.md.tt", cli.template_options
-        cli.template "%gem_name%/CONTRIBUTING.md.tt", cli.template_options
-        cli.template "%gem_name%/CODE_OF_CONDUCT.md.tt", cli.template_options
-        cli.template "%gem_name%/LICENSE.md.tt", cli.template_options
-        cli.template "%gem_name%/CHANGELOG.md.tt", cli.template_options
+        create_files
+        update_readme
       end
     end
   end

data/lib/gemsmith/skeletons/gem_skeleton.rb

@@ -3,10 +3,10 @@ module Gemsmith
     # Configures default gem support.
     class GemSkeleton < BaseSkeleton
       def create
-        cli.template "%gem_name%/Gemfile.tt", cli.template_options
-        cli.template "%gem_name%/%gem_name%.gemspec.tt", cli.template_options
-        cli.template "#{lib_root}/%gem_name%.rb.tt", cli.template_options
-        cli.template "#{lib_root}/%gem_name%/identity.rb.tt", cli.template_options
+        cli.template "%gem_name%/Gemfile.tt", configuration.to_h
+        cli.template "%gem_name%/%gem_name%.gemspec.tt", configuration.to_h
+        cli.template "#{lib_root}/%gem_name%.rb.tt", configuration.to_h
+        cli.template "#{lib_root}/%gem_name%/identity.rb.tt", configuration.to_h
       end
     end
   end

data/lib/gemsmith/skeletons/git_skeleton.rb

@@ -3,11 +3,11 @@ module Gemsmith
     # Configures Git support.
     class GitSkeleton < BaseSkeleton
       def create_ignore_file
-        cli.template "%gem_name%/.gitignore.tt", cli.template_options
+        cli.template "%gem_name%/.gitignore.tt", configuration.to_h
       end
 
       def create_repository
-        Dir.chdir(File.join(cli.destination_root, cli.gem_name)) do
+        Dir.chdir(File.join(cli.destination_root, configuration.gem_name)) do
           `git init`
           `git add .`
           `git commit --all --no-verify --message "Added Gemsmith skeleton."`

data/lib/gemsmith/skeletons/guard_skeleton.rb

@@ -2,13 +2,9 @@ module Gemsmith
   module Skeletons
     # Configures Guard support.
     class GuardSkeleton < BaseSkeleton
-      def enabled?
-        cli.template_options.key?(:guard) && cli.template_options[:guard]
-      end
-
       def create
-        return unless enabled?
-        cli.template "%gem_name%/Guardfile.tt", cli.template_options
+        return unless configuration.create_guard?
+        cli.template "%gem_name%/Guardfile.tt", configuration.to_h
       end
     end
   end

data/lib/gemsmith/skeletons/pry_skeleton.rb

@@ -0,0 +1,11 @@
+module Gemsmith
+  module Skeletons
+    # Configures Pry debugging support.
+    class PrySkeleton < BaseSkeleton
+      def create
+        return unless configuration.create_pry?
+        cli.template "%gem_name%/spec/support/extensions/pry.rb.tt", configuration.to_h
+      end
+    end
+  end
+end