nugem 0.8.1 → 0.9.0

data/lib/nugem/cli.rb

@@ -1,6 +1,7 @@
 require 'fileutils'
 require 'rugged'
-require_relative '../nugem'
+require_relative 'git'
+require_relative 'cli/cli_gem'
 
 # Nugem::Cli is a Thor class that is invoked when a user runs a nugem executable.
 # This file defines the common aspects of the Thor class.
@@ -8,32 +9,43 @@ require_relative '../nugem'
 module Nugem
   class Cli < Thor
     include Thor::Actions
-    include Nugem::Git
+
+    # These declarations make the class instance variable values available as an accessor,
+    # which is necessary to name template files that are named '%variable_name%.extension'.
+    # See https://www.rubydoc.info/gems/thor/Thor/Actions#directory-instance_method
+    attr_reader :block_name, :filter_name, :generator_name, :tag_name, :test_framework
+
+    package_name 'Nugem'
+
+    check_unknown_options!
+
+    class_option :out_dir, type: :string, default: 'generated',
+                 desc: 'Output directory for the gem.', aliases: :o
 
     class_option :executable, type: :boolean, default: false,
-      desc: 'Include an executable for the gem.'
+                 desc: 'Include an executable for the gem.', aliases: :e
 
     class_option :host, type: :string, default: 'github',
-      enum: %w[bitbucket github], desc: 'Repository host.'
+                 enum: %w[bitbucket github], desc: 'Repository host.', aliases: :h
 
     class_option :private, type: :boolean, default: false,
-      desc: 'Publish the gem on a private repository.'
+                 desc: 'Publish the gem on a private repository.'
 
     class_option :quiet, type: :boolean, default: true,
-      desc: 'Suppress detailed messages.', group: :runtime
+                 desc: 'Suppress detailed messages.', group: :runtime, aliases: :q
 
     class_option :todos, type: :boolean, default: true,
-      desc: 'Generate TODO: messages in generated code.', group: :runtime
+                 desc: 'Generate TODO: messages in generated code.', group: :runtime, aliases: :t
+
+    class_option :yes, type: :boolean, default: false,
+                 desc: 'Answer yes to all questions.', aliases: :y
 
     # Surround gem_name with percent symbols when using the property to name files
     # within the template directory
     # For example: "generated/%gem_name%"
     attr_accessor :gem_name
 
-    require_relative 'cli/cli_gem'
-    require_relative 'cli/cli_jekyll'
-    require_relative 'cli/cli_rails'
-
+    # Return a non-zero status code on error. See https://github.com/rails/thor/issues/244
     def self.exit_on_failure?
       true
     end
@@ -43,48 +55,57 @@ module Nugem
       File.expand_path '../../templates', __dir__
     end
 
+    def self.test_option(default_value)
+      method_option :test_framework, type: :string, default: default_value,
+        enum: %w[minitest rspec],
+        desc: "Use rspec or minitest for the test framework (default is #{default_value})."
+    end
+
     def self.todo
       'TODO: ' if @todos
     end
 
-    private
-
-    def count_todos(filename)
-      filename_fq = "#{Nugem.dest_root gem_name}/#{filename}"
-      content = File.read filename_fq
-      content.scan('TODO').length
-    end
+    require_relative 'cli/cli_jekyll'
+    require_relative 'cli/cli_rails'
 
-    def initialize_repository(gem_name)
-      Dir.chdir Nugem.dest_root(gem_name) do
-        # say "Working in #{Dir.pwd}", :green
-        run 'chmod +x bin/*'
-        run 'chmod +x exe/*' if @executable
-        create_local_git_repository
-        FileUtils.rm_f 'Gemfile.lock'
-        # say "Running 'bundle install'", :green
-        # run 'bundle', abort_on_failure: false
-        say 'Creating remote repository', :green
-        create_remote_git_repository @repository \
-          if yes? "Do you want to create a repository on #{@repository.host.camel_case} named #{gem_name}? (y/N)"
+    no_tasks do # rubocop:disable Metrics/BlockLength
+      def count_todos(filename)
+        filename_fq = "#{Nugem.dest_root @out_dir, gem_name}/#{filename}"
+        content = File.read filename_fq
+        content.scan('TODO').length
       end
-      say "The #{gem_name} gem was successfully created.", :green
-      report_todos gem_name
-    end
 
-    def report_todos(gem_name)
-      gemspec_todos = count_todos "#{gem_name}.gemspec"
-      readme_todos  = count_todos 'README.md'
-      if readme_todos.zero? && gemspec_todos.zero?
-        say "There are no TODOs. You can run 'bundle install' from within your new gem project now.", :blue
-        return
+      def initialize_repository(gem_name)
+        Dir.chdir Nugem.dest_root(@out_dir, gem_name) do
+          # puts set_color("Working in #{Dir.pwd}", :green)
+          run 'chmod +x bin/*'
+          run 'chmod +x exe/*' if @executable
+          create_local_git_repository
+          FileUtils.rm_f 'Gemfile.lock'
+          # puts set_color("Running 'bundle'", :green)
+          # run 'bundle', abort_on_failure: false
+          create_repo = @yes || yes?(set_color("Do you want to create a repository on #{@repository.host.camel_case} named #{gem_name}? (y/N)",
+                                               :green))
+          create_remote_git_repository @repository if create_repo
+        end
+        puts set_color("The #{gem_name} gem was successfully created.", :green)
+        report_todos gem_name
       end
 
-      msg = 'Please complete'
-      msg << " the #{gemspec_todos} TODOs in #{gem_name}.gemspec" if gemspec_todos.positive?
-      msg << ' and' if gemspec_todos.positive? && readme_todos.positive?
-      msg << " the #{readme_todos} TODOs in README.md." if readme_todos.positive?
-      say msg, :yellow
+      def report_todos(gem_name)
+        gemspec_todos = count_todos "#{gem_name}.gemspec"
+        readme_todos  = count_todos 'README.md'
+        if readme_todos.zero? && gemspec_todos.zero?
+          puts set_color("There are no TODOs. You can run 'bundle' from within your new gem project now.", :blue)
+          return
+        end
+
+        msg = 'Please complete'
+        msg << " the #{gemspec_todos} TODOs in #{gem_name}.gemspec" if gemspec_todos.positive?
+        msg << ' and' if gemspec_todos.positive? && readme_todos.positive?
+        msg << " the #{readme_todos} TODOs in README.md." if readme_todos.positive?
+        puts set_color(msg, :yellow)
+      end
     end
   end
 end

data/lib/nugem/git.rb

@@ -2,79 +2,82 @@ require 'thor'
 require 'yaml'
 
 module Nugem
-  module Git
+  class Cli < Thor
     include Thor::Actions
 
-    def create_local_git_repository
-      say 'Creating the local git repository', :green
-      run 'git init'
-      run 'git add .'
+    no_tasks do # rubocop:disable Metrics/BlockLength
+      def create_local_git_repository
+        puts set_color('Creating the local git repository', :green)
+        run 'git init'
+        run 'git add .'
 
-      # See https://github.com/rails/thor/blob/v1.2.2/lib/thor/actions.rb#L236-L278
-      run "git commit -aqm 'Initial commit'", abort_on_failure: false
-    end
+        # See https://github.com/rails/thor/blob/v1.2.2/lib/thor/actions.rb#L236-L278
+        run "git commit -aqm 'Initial commit'", abort_on_failure: false
+      end
 
-    def github_config
-      gh_hosts_file = Nugem.expand_env('$HOME/.config/gh/hosts.yml')
-      return nil unless File.exist? gh_hosts_file
+      def github_config
+        gh_hosts_file = Nugem.expand_env('$HOME/.config/gh/hosts.yml')
+        return nil unless File.exist? gh_hosts_file
 
-      YAML.safe_load(File.read(gh_hosts_file))
-    end
+        YAML.safe_load_file(gh_hosts_file)
+      end
 
-    def create_remote_git_repository(repository)
-      say "Creating a remote #{repository.host} repository", :green
-      if repository.github?
-        gh_config = github_config
-        token = gh_config&.dig('github.com', 'oauth_token')
+      def create_remote_git_repository(repository)
+        puts set_color("Creating a remote #{repository.host} repository", :green)
+        if repository.github?
+          gh_config = github_config
+          token = gh_config&.dig('github.com', 'oauth_token')
 
-        token ||= ask('What is your Github personal access token', echo: false)
-        run <<~END_CURL
-          curl --request POST \
-            --user '#{repository.user}:#{token}' \
-            https://api.github.com/user/repos \
-            -d '{"name":"#{repository.name}", "private":#{repository.private?}}'
-        END_CURL
-      else # BitBucket
-        password = ask('Please enter your Bitbucket password', echo: false)
-        fork_policy = repository.public? ? 'allow_forks' : 'no_public_forks'
-        run <<~END_BITBUCKET
-          curl --request POST \
-            --user #{repository.user}:#{password} \
-            https://api.bitbucket.org/2.0/repositories/#{repository.user}/#{repository.name} \
-            -d '{"scm":"git", "fork_policy":"#{fork_policy}", "is_private":"#{repository.private?}"}'
-        END_BITBUCKET
+          token ||= ask('What is your Github personal access token', echo: false)
+          curl_command = <<~END_CURL
+            curl --request POST \
+              --user '#{repository.user}:#{token}' \
+              https://api.github.com/user/repos \
+              -d '{"name":"#{repository.name}", "private":#{repository.private?}}'
+          END_CURL
+          run(curl_command, capture: true)
+        else # BitBucket
+          password = ask('Please enter your Bitbucket password', echo: false)
+          fork_policy = repository.public? ? 'allow_forks' : 'no_public_forks'
+          run <<~END_BITBUCKET
+            curl --request POST \
+              --user #{repository.user}:#{password} \
+              https://api.bitbucket.org/2.0/repositories/#{repository.user}/#{repository.name} \
+              -d '{"scm":"git", "fork_policy":"#{fork_policy}", "is_private":"#{repository.private?}"}'
+          END_BITBUCKET
+        end
+        run "git remote add origin #{repository.origin}"
+        puts set_color("Pushing initial commit to remote #{repository.host} repository", :green)
+        run 'git push -u origin master'
       end
-      run "git remote add origin #{repository.origin}"
-      say "Pushing initial commit to remote #{repository.host} repository", :green
-      run 'git push -u origin master'
-    end
 
-    def git_repository_user_name(host)
-      global_config = Rugged::Config.global
-      git_config_key = "nugem.#{host}user"
-      user = global_config[git_config_key]
+      def git_repository_user_name(host)
+        global_config = Rugged::Config.global
+        git_config_key = "nugem.#{host}user"
+        user = global_config[git_config_key]
 
-      gh_config = github_config
-      user ||= gh_config&.dig('github.com', 'user')
+        gh_config = github_config
+        user ||= gh_config&.dig('github.com', 'user')
 
-      user = ask "What is your #{host} user name?" if user.to_s.empty?
-      global_config[git_config_key] = user if user != global_config[git_config_key]
-      user
-    end
+        user = ask "What is your #{host} user name?" if user.to_s.empty?
+        global_config[git_config_key] = user if user != global_config[git_config_key]
+        user
+      end
 
-    def gem_server_url(private_)
-      if private_
-        global_config = Rugged::Config.global
-        git_config_key = 'nugem.gemserver'
-        url = global_config[git_config_key]
+      def gem_server_url(private_)
+        if private_ && Nugem::FEATURE_GEMINABOX
+          global_config = Rugged::Config.global
+          git_config_key = 'nugem.gemserver'
+          url = global_config[git_config_key]
 
-        if url.to_s.empty?
-          url = ask('What is the url of your Geminabox server?')
-          global_config[git_config_key] = url
+          if url.to_s.strip.empty?
+            url = ask('What is the url of your Geminabox server?')
+            global_config[git_config_key] = url unless url.to_s.strip.empty?
+          end
+          url
+        else
+          'https://rubygems.org'
         end
-        url
-      else
-        'https://rubygems.org'
       end
     end
   end

data/lib/nugem/repository.rb

@@ -1,7 +1,7 @@
 # Nugem::Repository contains informations about the git repository and the git user
 module Nugem
   class Repository
-    attr_reader :gem_server_url, :global_config, :host, :name, :private, :user, :user_name, :user_email
+    attr_reader :gem_server_url, :global_config, :host, :name, :out_dir, :private, :user, :user_name, :user_email
 
     Host = Struct.new(:domain, :camel_case, :id, keyword_init: true)
     HOSTS = [
@@ -12,8 +12,9 @@ module Nugem
     def initialize(options)
       @host = HOSTS.find { |host| host.id == options[:host] }
       @private = options[:private]
-      @name = options[:name]
-      @user = options[:user]
+      @name    = options[:name]
+      @user    = options[:user]
+
       @global_config = Rugged::Config.global
       abort 'Git global config not found' if @global_config.nil?
 

data/lib/nugem/version.rb

@@ -1,3 +1,3 @@
 module Nugem
-  VERSION = '0.8.1'.freeze
+  VERSION = '0.9.0'.freeze
 end

data/lib/nugem.rb

@@ -1,31 +1,18 @@
 require 'thor'
-require_relative 'nugem/git'
-require_relative 'nugem/repository'
-require_relative 'nugem/version'
 require_relative 'util'
 
+Signal.trap('INT') { exit }
+
 module Nugem
   # @return Path to the generated gem
-  def self.dest_root(gem_name)
-    File.expand_path "generated/#{gem_name}"
+  def self.dest_root(out_dir, gem_name)
+    File.expand_path "#{out_dir}/#{gem_name}"
   end
 
-  class Cli < Thor
-    include Thor::Actions
-
-    package_name 'Nugem'
-
-    # These declarations make the class instance variable values available as an accessor,
-    # which is necessary to name template files that are named '%variable_name%.extension'.
-    # See https://www.rubydoc.info/gems/thor/Thor/Actions#directory-instance_method
-    attr_reader :block_name, :filter_name, :generator_name, :tag_name, :test_framework
-
-    class << self
-      def test_option(default_value)
-        method_option :test_framework, type: :string, default: default_value,
-          enum: %w[minitest rspec],
-          desc: "Use rspec or minitest for the test framework (default is #{default_value})."
-      end
-    end
-  end
+  FEATURE_GEMINABOX = false
 end
+
+require_relative 'nugem/git'
+require_relative 'nugem/cli'
+require_relative 'nugem/repository'
+require_relative 'nugem/version'

data/lib/util.rb

@@ -8,4 +8,31 @@ module Nugem
       ENV.fetch(Regexp.last_match(1), nil)
     end
   end
+
+  # The following methods are not required at present ... but they might be needed one day, so not deleting yet
+
+  # @param file must be a fully qualified file name
+  # @return Gem::Specification of gem that file points into, or nil if not called from a gem
+  def self.current_spec(file)
+    return nil unless File.file?(file)
+
+    searcher = if Gem::Specification.respond_to?(:find)
+                 Gem::Specification
+               elsif Gem.respond_to?(:searcher)
+                 Gem.searcher.init_gemspecs
+               end
+
+    searcher&.find do |spec|
+      file.start_with? spec.full_gem_path
+    end
+  end
+
+  def self.gem_path(file)
+    spec = current_spec(file)
+    spec&.full_gem_path
+  end
+
+  def self.template_directory
+    File.join gem_path(__FILE__), 'templates'
+  end
 end

data/nugem.gemspec

@@ -1,23 +1,44 @@
 require_relative 'lib/nugem/version'
 
 Gem::Specification.new do |spec|
-  spec.authors       = ['Igor Jancev', 'Mike Slinn']
-  spec.bindir        = 'exe'
-  spec.email         = ['igor@masterybits.com', 'mslinn@mslinn.com']
-  spec.executables   = %w[nugem]
-  spec.files         = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec,templates}/**/*', '*.gemspec', '*.md']
-  spec.description   = <<~END_DESC
+  host = 'https://github.com/mslinn/nugem'
+
+  spec.authors               = ['Igor Jancev', 'Mike Slinn']
+  spec.bindir                = 'exe'
+  spec.description = <<~END_DESC
     Nugem creates a scaffold project for new gems. You can choose between Github and Bitbucket,
     Rubygems or Geminabox, with or without an executable, etc.
   END_DESC
-  spec.homepage      = 'https://github.com/mslinn/nugem'
-  spec.license       = 'MIT'
-  spec.name          = 'nugem'
-  spec.require_paths = ['lib']
+  spec.email                 = ['igor@masterybits.com', 'mslinn@mslinn.com']
+  spec.executables           = %w[nugem]
+  spec.files                 = Dir[
+                                  '.rubocop.yml',
+                                  'Gemfile',
+                                  'LICENSE.*',
+                                  'Rakefile',
+                                  '{lib,spec,templates}/**/*',
+                                  'templates/**/.*',
+                                  'templates/**/.*/*',
+                                  '*.gemspec',
+                                  '*.md'
+                                ]
+  spec.homepage              = 'https://github.com/mslinn/nugem'
+  spec.license               = 'MIT'
+  spec.metadata = {
+    'allowed_push_host' => 'https://rubygems.org',
+    'bug_tracker_uri'   => "#{host}/issues",
+    'changelog_uri'     => "#{host}/CHANGELOG.md",
+    'homepage_uri'      => spec.homepage,
+    'source_code_uri'   => host,
+  }
+  spec.name                  = 'nugem'
+  spec.platform              = Gem::Platform::RUBY
+  spec.require_paths         = ['lib']
   spec.required_ruby_version = '>= 3.1.0'
-  spec.summary       = 'Nugem creates a scaffold project for new gems.'
-  spec.version       = Nugem::VERSION
+  spec.summary               = 'Nugem creates a scaffold project for new gems.'
+  spec.version               = Nugem::VERSION
 
+  spec.add_dependency 'jekyll'
   spec.add_dependency 'rugged'
   spec.add_dependency 'thor'
 end

data/spec/spec_helper.rb

@@ -1,12 +1,9 @@
 require_relative '../lib/nugem'
 
 RSpec.configure do |config|
-  config.filter_run :focus
+  config.filter_run_when_matching focus: true
   # config.order = "random"
-  config.run_all_when_everything_filtered = true
 
   # See https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures
   config.example_status_persistence_file_path = '../spec/status_persistence.txt'
-
-  config.filter_run_when_matching focus: true
 end

data/templates/common/executable_scaffold/exe/%gem_name%.tt

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require '<%= @gem_name %>/cli'
+require_relative '../lib/<%= @gem_name %>'
 
-<%= @class_name %>::Cli.start
+<%= @class_name %>.main

data/templates/common/executable_scaffold/lib/%gem_name%/cli.rb.tt

@@ -1,13 +1,21 @@
-require 'thor'
-require '<%= @gem_name %>'
+require 'colorator'
+require 'fileutils'
+require 'pathname'
 
-module <%= @class_name %>
-  class Cli < Thor
-    include Thor::Actions
+def require_subdirectory(dir)
+  Dir[File.join(dir, '*.rb')].each do |file|
+    require file unless file == __FILE__
+  end
+end
 
-    desc "do_something NAME", "<%= @todo %>task description"
-    def do_something(name)
-      puts "<%= @todo %>do something with: #{name}"
-    end
+require_subdirectory File.realpath(__dir__) # Require all Ruby files in 'lib/', except this file
+Pathname(__dir__).children.select(&:directory?).each do |directory|
+  require_subdirectory directory.to_s
+end
+
+module <%= @class_name %>
+  def self.main
+    @options = parse_options
+    puts "TODO: write main implementation in lib/<%= @class_name %>/cli.rb".yellow
   end
 end

data/templates/common/executable_scaffold/lib/%gem_name%/options.rb.tt

@@ -0,0 +1,31 @@
+require 'colorator'
+require 'optparse'
+
+def help(msg = nil)
+  printf "Error: #{msg}\n\n".yellow unless msg.nil?
+  msg = <<~END_HELP
+    <%= @gem_name %>: Describe this executable.
+
+    Syntax: <%= @gem_name %> [Options]
+
+    Options:
+      -h       Show this help message
+  END_HELP
+  printf msg.cyan
+  exit 1
+end
+
+def parse_options
+  options = { bpm: 120, overwrite: false }
+  OptionParser.new do |parser|
+    parser.program_name = File.basename __FILE__
+    @parser = parser
+
+    # parser.on('-b',      '--bpm BPM', OptionParser::DecimalInteger, 'Specify BPM (default is 120 bpm)')
+    # parser.on('-f',      '--overwrite',                             'Overwrite output MIDI file if present') {% endcomment %}
+    parser.on_tail('-h', '--help',                                  'Show this message') do
+      help
+    end
+  end.order!(into: options)
+  options
+end

data/templates/common/gem_scaffold/%gem_name%.gemspec.tt

@@ -41,18 +41,18 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 3.1.0'
   spec.summary               = '<%= @todo %>Write summary of what the gem is for'
   spec.version               = <%= @class_name %>::VERSION
-
   <%- if @geminabox -%>
   spec.add_dependency 'geminabox', '>= 2.2.1'
   <%- end -%>
   <%- if @jekyll -%>
   spec.add_dependency 'jekyll', '>= 3.5.0'
-  spec.add_dependency 'jekyll_plugin_support', '>= 0.7.0'
+  spec.add_dependency 'jekyll_plugin_support', '>= 1.0.3'
   <%- end -%>
-  <%- if @plugin -%>
+  <%- if @rails -%>
   spec.add_dependency 'rails', '~> 7.0.5'
   <%- end -%>
   <%- if @executable -%>
-  spec.add_dependency 'thor', '~> 1.2.2'
+  spec.add_dependency 'colorator'
+  spec.add_dependency 'optparse'
   <%- end -%>
 end

data/templates/common/gem_scaffold/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_BIN: "binstub"

data/templates/common/gem_scaffold/.gitignore.tt

@@ -0,0 +1,27 @@
+/.bundle/
+/.yardoc
+/binstub/
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/test/coverage/
+/test/reports/
+/doc/
+/pkg/
+/tmp/
+<%- if @rails -%>
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+<%- end -%>
+<%- if @jekyll -%>
+spec/status_persistence.txt
+.jekyll-cache/
+.jekyll-metadata
+_site/
+demo/_site/
+demo/.jekyll-cache/
+demo/.jekyll-metadata
+<%- end -%>

data/templates/common/gem_scaffold/.markdownlint.json

@@ -0,0 +1,8 @@
+{
+  "MD012": false,
+  "MD014": false,
+  "MD013": { "line_length": 120 },
+  "MD024": false,
+  "MD033": false,
+  "MD034": false
+}

data/templates/common/gem_scaffold/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation