nugem 0.8.1 → 0.8.3

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   = %w[nugem]
-  spec.files         = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec,templates}/**/*', '*.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/gem_scaffold/%gem_name%.gemspec.tt

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
 
   spec.authors               = ['<%= @repository.user_name %>']
   <%- if @executable -%>
-  spec.bindir                = 'exe'
+  spec.bindir                = 'binstub'
   spec.executables           = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   <%- end -%>
   spec.description           = <<~END_DESC
@@ -41,7 +41,6 @@ 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 -%>
@@ -49,7 +48,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'jekyll', '>= 3.5.0'
   spec.add_dependency 'jekyll_plugin_support', '>= 0.7.0'
   <%- end -%>
-  <%- if @plugin -%>
+  <%- if @rails -%>
   spec.add_dependency 'rails', '~> 7.0.5'
   <%- end -%>
   <%- if @executable -%>

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

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

data/templates/common/gem_scaffold/Gemfile.tt

@@ -3,22 +3,11 @@ source 'https://rubygems.org'
 # The <%= @gem_name %> gem dependencies are defined in <%= @gem_name %>.gemspec
 gemspec
 
-<%- if @jekyll -%>
 group :test, :development do
-  gem 'bundler', '>= 2.4.6', require: false
-  <%- if @repository.public? -%>
-  gem 'coveralls', require: false
-  <%- end -%>
-  gem 'debase', '0.2.5.beta2', require: false
+  gem 'debug', '>= 1.0.0', require: false
   gem 'gem-release', '>= 2.2.2', 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 -%>
+  <%- if @jekyll -%>
   gem 'rake', require: false
-  <%- if @rspec -%>
-  gem 'rspec', require: false
   <%- end -%>
   gem 'rubocop', require: false
   gem 'rubocop-md', require: false
@@ -27,30 +16,29 @@ group :test, :development do
   <%- end -%>
   gem 'rubocop-performance', require: false
   gem 'rubocop-rake', require: false
+  <%- if @rspec -%>
   gem 'rubocop-rspec', require: false
-  gem 'ruby-debug-ide', require: false
-end
-<%- end -%>
-<%- if @plugin -%>
-group :test, :development do
-  gem 'bundler', '>= 2.4.6', 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 'gem-release', '>= 2.2.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 'rubocop', require: false
-  gem 'rubocop-md', require: false
-  gem 'rubocop-performance', require: false
-  gem 'rubocop-rake', require: false
-  <%- if @rspec -%>
-  gem 'rubocop-rspec', require: false
-  <%- end -%>
   gem 'selenium-webdriver', '~> 4.9.1', require: false
   gem 'sqlite3'
+  <%- end -%>
+end
+
+group :test do
+  gem 'rspec-match_ignoring_whitespace'
 end
-<%- end -%>

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

@@ -1,5 +1,3 @@
-# <%= @class_name %>
-
 <%- if @repository.public? -%>
 # `<%= gem_name.capitalize %>` [![Gem Version](https://badge.fury.io/rb/<%= gem_name %>.svg)](https://badge.fury.io/rb/<%= gem_name %>)
 <%- else -%>
@@ -12,21 +10,30 @@
 ## Installation
 
 <%- if @jekyll -%>
-Add this line to your Jekyll website's Gemfile, within the jekyll_plugins group:
+Add the following to your Jekyll website's `Gemfile`:
 
+```ruby
 group :jekyll_plugins do
   gem '<%= @gem_name %>'
 end
+```
 <%- end -%>
 <%- unless @jekyll -%>
-Add this line to your application's Gemfile:
+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
 ```
@@ -39,24 +46,57 @@ $ bundle
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies.
-Then, run `rake test` to run the tests.
-You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+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
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`.
 
-To release a new version, run `bundle exec rake release`,
-which will create a git tag for the version, push git commits and tags,
-and push the `.gem` file to <%= @repository.gem_server_url -%>.
+### 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 on <%= @repository.host %> at <%= @repository.url %>.
+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](http://opensource.org/licenses/MIT).
+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/bin/attach

@@ -31,4 +31,5 @@ bin/build
 set -e
 
 cd "$1" > /dev/null || exit 1
-_bin/debug
+shift
+_bin/debug "$@"

data/templates/common/gem_scaffold/bin/build

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+NAME="$( basename -s .git "$( git remote get-url origin )" )"
+
+gem uninstall "$NAME" -aIx --user-install --force
+
+bundle exec rake install

data/templates/common/gem_scaffold/bin/reset

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+git checkout . # restores project
+git clean -fd  # Nukes untracked files and directories

data/templates/common/gem_scaffold/bin/setup.tt

@@ -10,15 +10,18 @@ done
 DIR=$( cd -P "$( dirname "$SOURCE" )" >/dev/null 2>&1 && pwd )
 cd "$DIR/.." || exit
 
+if [[ $(which apt) ]]; then
+  if [[ ! -f /usr/lib/x86_64-linux-gnu/libyaml.so ]]; then sudo apt install libyaml-dev; fi
+fi
+
 rm -f Gemfile.lock
-bundle
+if [[ -z "$( which bundle )" ]]; then gem install bundler; fi
+BUNDLE_WITH="development" bundle
 
-bundle binstubs debase         --force --path binstub
 <%- if @jekyll -%>
 bundle binstubs jekyll         --force --path binstub
 <%- end -%>
 bundle binstubs rspec-core     --force --path binstub
 bundle binstubs rubocop        --force --path binstub
-bundle binstubs ruby-debug-ide --force --path binstub
 
 # Do any other automated setup that you need to do here

data/templates/common/gem_scaffold/lib/%gem_name%.rb.tt

@@ -10,3 +10,5 @@ require_relative '<%= @gem_name %>/version'
 Dir[File.join(__dir__, '*.rb')].each do |file|
   require file unless file.end_with?('/<%= @gem_name %>.rb')
 end
+
+# Write the code for your gem here

data/templates/common/gem_scaffold/test/test_helper.rb.tt

@@ -3,7 +3,7 @@ require 'coveralls'
 Coveralls.wear!
 <%- end -%>
 
-<%- unless @plugin -%>
+<%- unless @rails -%>
 $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require '<%= @gem_name %>'
 <%- end -%>
@@ -11,7 +11,7 @@ require '<%= @gem_name %>'
 require 'minitest/autorun'
 
 require 'minitest/reporters'
-<%- if @plugin -%>
+<%- if @rails -%>
 require 'minitest/reporters/screenshot_reporter'
 Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new,
                           Minitest::Reporters::JUnitReporter.new,
@@ -23,7 +23,7 @@ Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
 # Filter out Minitest backtrace while allowing backtrace from other libraries to be shown.
 Minitest.backtrace_filter = Minitest::BacktraceFilter.new
 
-<%- if @plugin -%>
+<%- if @rails -%>
 require File.expand_path('../test/dummy/config/environment.rb',  __dir__)
 ActiveRecord::Migrator.migrations_paths = [File.expand_path('../test/dummy/db/migrate', __dir__)]
 <%- if @mountable -%>

data/templates/jekyll/common_scaffold/spec/spec_helper.rb

@@ -30,7 +30,7 @@ class SiteMock
   attr_reader :config
 
   def initialize
-    @config = YAML.safe_load(File.read('../demo/_config.yml'))
+    @config = YAML.safe_load_file(File.read('../demo/_config.yml'))
     @config['env'] = { 'JEKYLL_ENV' => 'development' }
   end
 

data/templates/jekyll/demo/demo/Gemfile.tt

@@ -14,8 +14,9 @@ group :jekyll_plugins do
   gem 'jekyll-tagging'
 end
 
-gem 'debase', '0.2.5.beta2', require: false
-gem 'rspec-core', require: false
-gem 'rubocop', require: false
-gem 'rubocop-rspec', require: false
-gem 'ruby-debug-ide', require: false
+group :test, :development do
+  gem 'debug', '>= 1.0.0', require: false
+  gem 'rspec-core', require: false
+  gem 'rubocop', require: false
+  gem 'rubocop-rspec', require: false
+end

data/templates/jekyll/demo/demo/_bin/debug

@@ -5,7 +5,7 @@
 function help {
   echo "
 $(basename $0) - Run the demo Jekyll website.
-By default the demo Jekyll website runs without restriction under ruby-debug-ide and debase,
+By default the demo Jekyll website runs without restriction under `debug`,
 and listens on 0.0.0.0:1234.
 Options:
   -h  Show this error message

data/templates/rails/plugin_scaffold/.envrc

@@ -0,0 +1 @@
+PATH_add bin