nugem 0.8.0 → 0.8.3

data/lib/nugem/version.rb

@@ -1,3 +1,3 @@
 module Nugem
-  VERSION = '0.8.0'.freeze
+  VERSION = '0.8.3'.freeze
 end

data/lib/nugem.rb

@@ -1,31 +1,16 @@
 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}"
   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
 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 = self.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,34 @@
 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   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.files         = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
-  spec.description   = <<~END_DESC
+  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.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',
+                                    'Gemfile',
+                                    'LICENSE.*',
+                                    'Rakefile',
+                                    '{lib,spec,templates}/**/*',
+                                    'templates/**/.*',
+                                    'templates/**/.*/*',
+                                    '*.gemspec',
+                                    '*.md'
+                                  ]
+  spec.homepage              = 'https://github.com/mslinn/nugem'
+  spec.license               = 'MIT'
+  spec.name                  = 'nugem'
+  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/templates/common/LICENCE.txt.tt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) <%= Time.new.year %> <%= @repository.user_name %>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

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

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

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

@@ -0,0 +1,13 @@
+require 'thor'
+require '<%= @gem_name %>'
+
+module <%= @class_name %>
+  class Cli < Thor
+    include Thor::Actions
+
+    desc "do_something NAME", "<%= @todo %>task description"
+    def do_something(name)
+      puts "<%= @todo %>do something with: #{name}"
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+require_relative 'lib/<%= @gem_name %>/version'
+
+Gem::Specification.new do |spec|
+  <%- if @repository.github? -%>
+  host = 'https://github.com/<%= @repository.user %>/<%= @gem_name %>'
+  <%- else -%>
+  host = 'https://bitbucket.com/<%= @repository.user %>/<%= @gem_name %>'
+  <%- end -%>
+
+  spec.authors               = ['<%= @repository.user_name %>']
+  <%- if @executable -%>
+  spec.bindir                = 'binstub'
+  spec.executables           = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  <%- end -%>
+  spec.description           = <<~END_DESC
+    <%= @todo %>Write a longer description of the gem.
+    Use as many lines as you like.
+  END_DESC
+  spec.email                 = ['<%= @repository.user_email %>']
+  spec.files                 = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
+  spec.homepage              = '<%= @repository.url %>'
+  <%- if @repository.public? -%>
+  spec.license               = 'MIT'
+  <%- end -%>
+  spec.metadata = {
+    'allowed_push_host' => '<%= @repository.gem_server_url %>',
+  <%- unless @repository.private? -%>
+    'bug_tracker_uri'   => "#{host}/issues",
+    'changelog_uri'     => "#{host}/CHANGELOG.md",
+    'homepage_uri'      => spec.homepage,
+    'source_code_uri'   => host,
+  <%- end -%>
+  }
+  spec.name                 = '<%= @gem_name %>'
+  spec.post_install_message = <<~END_MESSAGE
+
+    Thanks for installing #{spec.name}!
+
+  END_MESSAGE
+  spec.require_paths         = ['lib']
+  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'
+  <%- end -%>
+  <%- if @rails -%>
+  spec.add_dependency 'rails', '~> 7.0.5'
+  <%- end -%>
+  <%- if @executable -%>
+  spec.add_dependency 'thor', '~> 1.2.2'
+  <%- 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,4 @@
+--color
+--format documentation
+--order defined
+--require spec_helper

data/templates/common/gem_scaffold/.rubocop.yml.tt

@@ -0,0 +1,80 @@
+require:
+  <%- if @jekyll -%>
+  # - rubocop-jekyll
+  <%- end -%>
+  - rubocop-md
+  - rubocop-performance
+  <%- if @test_framework == 'minitest' -%>
+  - rubocop-minitest
+  <%- end -%>
+  - rubocop-rake
+  <%- if @test_framework == 'rspec' -%>
+  - rubocop-rspec
+  <%- end -%>
+
+AllCops:
+  Exclude:
+    - binstub/**/*
+    - exe/**/*
+    - vendor/**/*
+    - Gemfile*
+  NewCops: enable
+  TargetRubyVersion: 3.1.3
+
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Layout/LineLength:
+  Max: 150
+
+Metrics/AbcSize:
+  Max: 35
+
+Metrics/BlockLength:
+  Exclude:
+    - <%= @gem_name %>.gemspec
+  Max: 30
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Naming/FileName:
+  Exclude:
+    - Rakefile
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+<%- if @test_framework == 'rspec' -%>
+
+RSpec/FilePath:
+  IgnoreMethods: true
+  SpecSuffixOnly: true
+
+RSpec/ExampleLength:
+  Max: 30
+
+RSpec/MultipleExpectations:
+  Max: 15
+<%- end -%>

data/templates/common/gem_scaffold/.shellcheckrc

@@ -0,0 +1,5 @@
+disable=SC1091
+disable=SC2059
+disable=SC2086
+disable=SC2155
+disable=SC2181

data/templates/common/gem_scaffold/.vscode/%gem_name%.json.code-snippets.tt

@@ -0,0 +1,19 @@
+{
+	// Place your workspace snippets here. Each snippet is defined under a snippet name and has a scope, prefix, body and
+	// description. Add comma separated ids of the languages where the snippet is applicable in the scope field. If scope
+	// is left empty or omitted, the snippet gets applied to all languages. The prefix is what is
+	// used to trigger the snippet and the body will be expanded and inserted. Possible variables are:
+	// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders.
+	// Placeholders with the same ids are connected.
+	// Example:
+	// "Print to console": {
+	// 	"scope": "javascript,typescript",
+	// 	"prefix": "log",
+	// 	"body": [
+	// 		"console.log('$1');",
+	// 		"$2"
+	// 	],
+	// 	"description": "Log output to console"
+	// }
+	//
+}

data/templates/common/gem_scaffold/.vscode/extensions.json

@@ -0,0 +1,22 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
+  // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+
+  // List of extensions which should be recommended for users of this workspace.
+  "recommendations": [
+    "DavidAnson.vscode-markdownlint",
+    "devonray.snippet",
+    "KoichiSasada.vscode-rdbg",
+    "misogi.ruby-rubocop",
+    "redhat.vscode-yaml",
+    "shd101wyy.markdown-preview-enhanced",
+    "Shopify.ruby-lsp",
+    "timonwong.shellcheck",
+  ],
+  // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
+  "unwantedRecommendations": [
+    "castwide.solargraph",
+    "rebornix.Ruby",
+    "wingrunr21.vscode-ruby",
+  ]
+}

data/templates/common/gem_scaffold/.vscode/launch.json

@@ -0,0 +1,31 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Run selected Ruby file",
+      "program": "ruby ${file}",
+      "request": "launch",
+      "type": "ruby_lsp"
+    },
+    {
+      "name": "Attach rdebug-ide",
+      "request": "attach",
+      "type": "ruby_lsp",
+    },
+    {
+      "name": "RSpec - active spec file only",
+      "program": "binstub/rspec -I ${workspaceRoot} ${file}",
+      "request": "launch",
+      "type": "ruby_lsp",
+    },
+    {
+      "name": "RSpec - all",
+      "program": "${workspaceRoot}/binstub/rspec -I ${workspaceRoot}",
+      "request": "launch",
+      "type": "ruby_lsp",
+    }
+  ]
+}

data/templates/common/gem_scaffold/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "ruby.rubocop.configFilePath": ".rubocop.yml",
+  "ruby.rubocop.useBundler": true,
+  "ruby.rubocop.executePath": "./binstub/"
+}

data/templates/common/gem_scaffold/CHANGELOG.md.tt

@@ -0,0 +1,5 @@
+# Change Log
+
+## 0.1.0
+
+* Initial release.

data/templates/common/gem_scaffold/Gemfile.tt

@@ -0,0 +1,44 @@
+source 'https://rubygems.org'
+
+# The <%= @gem_name %> gem dependencies are defined in <%= @gem_name %>.gemspec
+gemspec
+
+group :test, :development do
+  gem 'debug', '>= 1.0.0', require: false
+  gem 'gem-release', '>= 2.2.2', require: false
+  <%- if @jekyll -%>
+  gem 'rake', require: false
+  <%- end -%>
+  gem 'rubocop', require: false
+  gem 'rubocop-md', require: false
+  <%- if @minitest -%>
+  gem 'rubocop-minitest', require: false
+  <%- end -%>
+  gem 'rubocop-performance', require: false
+  gem 'rubocop-rake', require: false
+  <%- if @rspec -%>
+  gem 'rubocop-rspec', require: false
+  <%- end -%>
+  <%- if @rails -%>
+  gem 'capybara', '~> 3.39.1', require: false
+  gem 'capybara_minitest_spec', '~> 1.0.7', require: false
+  <%- if @repository.public? -%>
+  gem 'coveralls', require: false
+  <%- end -%>
+  gem 'database_cleaner', '~> 2.0.2', require: false
+  gem 'erb_lint', require: false
+  <%- if @minitest -%>
+  gem 'minitest', '>= 5.18.0', require: false
+  gem 'minitest-reporters', '>= 1.6.0', require: false
+  gem 'minitest-screenshot-reporter', '~> 0.0.6', require: false
+  <%- end -%>
+  gem 'poltergeist', '~> 1.10.1', require: false
+  gem 'quiet_assets'
+  gem 'selenium-webdriver', '~> 4.9.1', require: false
+  gem 'sqlite3'
+  <%- end -%>
+end
+
+group :test do
+  gem 'rspec-match_ignoring_whitespace'
+end

data/templates/common/gem_scaffold/README.md.tt

@@ -0,0 +1,102 @@
+<%- if @repository.public? -%>
+# `<%= gem_name.capitalize %>` [![Gem Version](https://badge.fury.io/rb/<%= gem_name %>.svg)](https://badge.fury.io/rb/<%= gem_name %>)
+<%- else -%>
+# `<%= gem_name.capitalize %>`
+<%- end -%>
+
+<%= @todo %>Description of <%= @class_name %>
+
+
+## Installation
+
+<%- if @jekyll -%>
+Add the following to your Jekyll website's `Gemfile`:
+
+```ruby
+group :jekyll_plugins do
+  gem '<%= @gem_name %>'
+end
+```
+<%- end -%>
+<%- unless @jekyll -%>
+Either add this line to your application&rsquo;s `Gemfile`:
+
+```ruby
+gem '<%= @gem_name %>'
+```
+
+... or add the following to your application&rsquo;s `.gemspec`:
+
+```ruby
+spec.add_dependency '<%= @gem_name %>'
+```
+<%- end -%>
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+
+## Usage
+
+<%= @todo %>Describe how to use this gem
+
+
+## Development
+
+After checking out this git repository, install dependencies by typing:
+
+```shell
+$ bin/setup
+```
+
+You should do the above before running Visual Studio Code.
+
+
+### Run the Tests
+
+```shell
+$ bundle exec rake test
+```
+
+
+### Interactive Session
+
+The following will allow you to experiment:
+
+```shell
+$ bin/console
+```
+
+
+### Local Installation
+
+To install this gem onto your local machine, type:
+
+```shell
+$ bundle exec rake install
+```
+
+
+### To Release A New Version
+
+To create a git tag for the new version, push git commits and tags,
+and push the new version of the gem to <%= @repository.gem_server_url -%>, type:
+
+```shell
+$ bundle exec rake release
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome at <%= @repository.url %>.
+
+
+<%- if @repository.public? -%>
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+<%- end -%>

data/templates/common/gem_scaffold/Rakefile.tt

@@ -0,0 +1,51 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+<%- if @engine -%>
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+<%- end -%>
+desc 'Bump patch version'
+task :patch do
+  system 'gem bump --tag'
+end
+
+desc 'Bump minor version'
+task :minor do
+  system 'gem bump --version minor --tag'
+end
+
+desc 'Bump major version'
+task :major do
+  system 'gem bump --version major --tag'
+end
+
+task publish: [:build] do
+  $VERBOSE = nil
+  load '<%= @gem_name %>/version.rb'
+  <%- if @repository.private? -%>
+  system "gem inabox pkg/<%= @gem_name %>-#{<%= @class_name %>::VERSION}.gem"
+  <%- else -%>
+  system "gem push pkg/<%= @gem_name %>-#{<%= @class_name %>::VERSION}.gem"
+  <%- end -%>
+end
+
+desc 'Bump patch version, create git tag, build the gem and release to geminabox (default)'
+task release_patch: %i[test patch publish]
+
+desc 'Bump minor version, create git tag, build the gem and release to geminabox'
+task release_minor: %i[test minor publish]
+
+desc 'Bump major version, create git tag, build the gem and release to geminabox'
+task release_major: %i[test major publish]
+
+task default: :test