bundlegem 1.1.1 → 1.2.0.pre.rc.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de640bbb2cb851cc3c73aa4a0b80bddcede13cabd78a731f1785b49a2b8fa43e
-  data.tar.gz: a464309f3d3dc39e2a1bef0355101e716988916bdc26c578b132c66adf05212c
+  metadata.gz: 9d3396aa291659923937258c81aefb04741601ccc6dce52f5863617fa6309dfb
+  data.tar.gz: 136b3cc175a67d535bf51a2c501e216f30e55aca1b6cbd4ea19a6917a7e7f123
 SHA512:
-  metadata.gz: b818b04951a5873203fe489ea0f9f0cd85e62f3d10f7cf0799af7f3d5467de144ab13baac6b8ad635f1f2bc197e182dceab5c1db72dd0fa3e595fa3bdb31a2b0
-  data.tar.gz: 9baab7152083f5ab0456a08524a763505b7d944d97acfabaf58707af6b28a944a70eda871ecd150fcf209bef41a4cb64aac178de626f19038abb8b63801cf584
+  metadata.gz: 38537a96e14f9ad0793d5758011cf41666667ee7674b0ab8f4cff559a9405a4959fcf9c44effa1c3473d318f86c53a18cc20b355dfdcc3e674255aa0fbfebec4
+  data.tar.gz: b662bfcd7fb5a56e75e7e7834da3b0f91accdcd734e5b2f1ad689ea3b35140e5beadce725089b6460abb2b17b75c92933fd53e1af477f85e63835e6db9a3951d

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in bundlegem.gemspec
 gemspec

data/README.md

@@ -1,33 +1,33 @@
 # BundleGem: A Gem Project Generator with User Defined Templates
 [![Gem Version](https://badge.fury.io/rb/bundlegem.svg)](https://badge.fury.io/rb/bundlegem)
 
-The goal of the project is to allow users to define templates in the most native form to all technologist: Directory Structures, short commands, and helpful commands which make the gem's usage completely visible!
+BundleGem allow users to define project templates in the most native form to all technologist: Directory Structures, short commands, and helpful commands that make the tool's usage completely visible!
 
-The benefits of using this repo to create gems rather than bundler is that you can choose to create 'classes' of gems.  By classes, I mean that there are different types of 'gems', there are basic library gems, that are just code and can only be used from other code, there are command line application gems, those are gems that are run on the command line and include a binary file, and there are also web interface gems, those are gems which spin up a simple web interface and request that the user connect to it's server on what ever port it has spun up on.  Depending on your field of specialty, you may be able to imagine other classes of gems that will aid you in your work.
-
-All of these 'classes of gems' as I refer to them, start out with a different code base, consistent with all other gems of the same class.  This 'class based' approach to gem creation is different from the adaptive approach that other gem generators are based on.
-
-The most beneficial aspect of this gem is that it allows you to specify exactly how you want your 'default starting gem' to look, rather than rely on what someone else thought would be generally helpful.
+Programming often involves a lot of boilerplate and configuration "boot strapping" before you can get going actually writing any code.  To automate this aspect of creating new projects and microservices, bundlegem allows you to run a simple command `bundlegem -t my-c-embedded-template project-name` and it will clone a template you've made with exact specifications, update the names of files and references within the files to match your project name, run any commands specified in your template.  What once would have been a 5-10 minute distraction of remembering and implementing all those little patterns, testing dependencies, and pipeline definitions now happens immediately with a single command.
 
+The most beneficial aspect of BundleGem is that it allows you to specify exactly how you want your 'default starting project' to look, rather than rely on what someone else thought would be generally helpful.
 
 ### Installation
 
-First install it:
 ```
 gem install bundlegem
+bundlegem --install-public-templates
 ```
 
-### Configuration
+#### List Available Templates
 
-Configuration comes from your gitconfig.  At the user level, this is set at `~/.gitconfig`.  These are the recommended minimal configurations to get the default templates to work ok:
-
-```
-[user]
-  email = me@example.com
-  name = Me
-  repo-domain = github.com
 ```
+$  bundlegem -l
+PREDEFINED:
+  default - A basic ruby gem
+  service - A gem that allows installation as a service to run as a daemon
+
+MISC:
+  my_service -
 
+EMBEDDED:
+  arduino
+```
 
 ### Usage
 
@@ -35,29 +35,23 @@ These commands will create a new gem named `project_name` in `/tmp/project_name`
 
 ```
 $  cd /tmp
-$  bundlegem project_name -t arduino
+$  bundlegem -t arduino project_name
 ```
 
+You'll find a project skeleton in ~/.bundlegem/templates/my_service that you can customize to your liking.
 
-### List Available Templates
-
-```
-$  bundlegem --list
-PREDEFINED:
-  default - A basic ruby gem
-  service - A gem that allows installation as a service to run as a daemon
+### Configuration
 
-MISC:
-  my_service -
+Configuration is optional and comes from your gitconfig file.  At the user level, this is set at `~/.gitconfig`.  These are the recommended minimal configurations to get the default templates to work ok:
 
-EMBEDDED:
-  arduino
+```
+[user]
+  email = me@example.com
+  name = Me
+  repo-domain = github.com
 ```
 
-You'll find a project skeleton in ~/.bundlegem/templates/my_service that you can customize to your liking.
-
-
-## Create Your Own Template
+#### Create Your Own Template
 
 You can create a new template for a project class you expect to use more than once:
 
@@ -80,7 +74,7 @@ Also, you can specify the `category` of the gem by editing the bundlegem.yml fil
 
 ### Customizing Your Own Templates
 
-Place your own templates in `~/.bunglegem/templates`.  You can populate it with examples by running `bundlegem --install-best-templates` which will effectively clone down a few sample git repos into the templates folder for you such as [Go-Cli](https://github.com/TheNotary/go-cli) for instance.
+Place your own templates in `~/.bunglegem/templates`.  You can populate it with examples by running `bundlegem --install-public-templates` which will effectively clone down a few sample git repos into the templates folder for you such as [Go-cli](https://github.com/TheNotary/template-go-cli) for instance.
 
 You'll get a good idea as to the possibilities by inspecting the files in [templates](https://github.com/TheNotary/bundlegem/tree/master/lib/bundlegem/templates/cli_gem).  Check out the [reference](/spec/data/variable_manifest_test.rb) test file to see what kind of interpolations are possible.
 
@@ -90,8 +84,3 @@ Quick Tips:
 - File **names** containing `#{name}` will have that symbol replaced by the project name defined on the CLI
 - Within files, use `<%=config[:namespaced_path]%>` to have that reinterpreted as just the file name with underscores
 - Have a look [under the hood](https://github.com/TheNotary/bundlegem/blob/master/lib/bundlegem/cli/gem.rb#L30-L43) to see other options and the context where the ERB.new takes place.
-
-
-## Gem Backstory
-
-A lot of the code here was extracted from Bundler's `bundle gem` command, so credits to the Bundler folks.  Originally I planned to make the new features accessible to the Bundler team and went out of my way to keep the code as similar to their project as possible, but ultimately realized two thing.  First they don't want to grow the project creation feature because good tools should do a single thing very well (manage dependencies), not many things (manage dependencies and also do random other helpful stuff).  And second Bundler is a profoundly common dependency meaning every change is enormously high stakes.

data/Rakefile

@@ -22,7 +22,7 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_opts = %w(-fd -c)
 end
 
-# this is for running tests that you've marked current... eg: it 'should work', :current => true do
+# this is for running tests that you've marked current... eg: it 'should work', current:  true do
 RSpec::Core::RakeTask.new(:current) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
   spec.rspec_opts = ['--tag current']
@@ -34,7 +34,5 @@ RSpec::Core::RakeTask.new(:c) do |spec|
   spec.rspec_opts = ['--tag current']
 end
 
-task :default => :spec
-task :test => :spec
-
-
+task default:  :spec
+task test:  :spec

data/bin/bundlegem

@@ -1,57 +1,62 @@
 #!/usr/bin/env ruby
 
-# Exit cleanly from an early interrupt
-Signal.trap("INT") { exit 1 }
+require 'optparse'
 require 'bundler'
 require 'bundlegem'
-# require 'bundlergem/friendly_errors'
 
 
-if ARGV.length < 1
-  puts "Error: you need to specify a name for the project being created\n\n"
-  puts Bundlegem::HELP_MSG
-  exit 1
-end
+Signal.trap("INT") { exit 1 }
+options = { bin: false, ext: false, coc: false }
 
-if ARGV[0] == "--help"
-  puts Bundlegem::HELP_MSG
-  exit 0
-end
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} [options] GEM_NAME"
 
-if ARGV[0] == "--list" or ARGV[0] == "-l"
-  puts Bundlegem.list
-  exit 0
-end
+  opts.on("-t", "--template TEMPLATE", "Specify a template") do |template|
+    options[:template] = template
+  end
 
-if ARGV[0] == "--version" or ARGV[0] == "-v"
-  puts Bundlegem.version
-  exit 0
-end
+  opts.on("-l", "--list", "List available templates") do
+    puts Bundlegem.list
+    exit
+  end
+
+  opts.on("-v", "--version", "Show version") do
+    puts Bundlegem.version
+    exit
+  end
 
-if ARGV[0] == "--install-best-templates"
-  Bundlegem.install_best_templates
-  exit 0
+  opts.on("--install-public-templates", "Install public templates") do
+    Bundlegem.install_public_templates
+    exit
+  end
+
+  opts.on("--to-template", "Convert directory to template") do
+    Bundlegem.dir_to_template
+    exit
+  end
+
+  opts.on("--help", "Show help") do
+    puts opts
+    puts Bundlegem::HELP_MSG
+    exit
+  end
 end
 
-if ARGV[0] == "--to-template"
-  Bundlegem.dir_to_template
-  exit 0
+parser.parse!
+
+if ARGV.empty?
+  puts "Error: you need to specify a name for the project being created\n\n"
+  puts Bundlegem::HELP_MSG
+  exit 1
 end
 
-options = {"bin"=>false, "ext"=>false, :coc=> false}
-gem_name = ""
-skip_i = -99
-
-# Loop over CLI parameters
-ARGV.each_with_index do |arg, i|
-  next if skip_i == i
-  if arg == "-t" or arg == "--template" # the item after this specifies the template to use
-    options.merge!({"template" => ARGV[i+1]})
-    skip_i = i+1
-    next
-  elsif !(arg =~ /^-/) # this must be what they want as the gem_name
-    gem_name = arg
-  end
+if ARGV.length > 1
+  puts "Error: there were unrecognized parameters specified in command"
+  puts Bundlegem::HELP_MSG
+  exit 1
 end
 
+
+# fyi parser.parse! splices options out of ARGV, so gem_name doesn't need to be specified first
+gem_name = ARGV.first
 Bundlegem.gem(options, gem_name)

data/bundlegem.gemspec

@@ -11,28 +11,22 @@ Gem::Specification.new do |s|
   s.authors       = ["TheNotary"]
   s.email         = ["no@mail.plz"]
   s.summary       = %q{This gem makes more gems!}
-  s.description   = %q{ This is a gem for making more gems!  I KNOW!  ISN'T THAT LIKE WISHING FOR MORE WISHES!}
+  s.description   = %q{ This is a gem for making more gems!  I know!  It's like asking a genie for more wishes but it actually works!}
   s.homepage      = "https://github.com/thenotary/bundlegem"
   s.license       = "MIT"
 
-  s.metadata = {
-    "bug_tracker_uri"   => "https://github.com/TheNotary/bundlegem/issues",
-    "changelog_uri"     => "https://github.com/TheNotary/bundlegem/releases/tag/v#{version}",
-    "documentation_uri" => "https://api.rubyonrails.org/v#{version}/",
-    "source_code_uri"   => "https://github.com/TheNotary/bundlegem/tree/v#{version}",
-  }
+  s.metadata["bug_tracker_uri"] = "https://github.com/TheNotary/bundlegem/issues"
+  s.metadata["changelog_uri"] = "https://github.com/TheNotary/bundlegem/releases/tag/v#{version}"
+  s.metadata["documentation_uri"] = "https://api.rubyonrails.org/v#{version}/"
+  s.metadata["source_code_uri"] = "https://github.com/TheNotary/bundlegem/tree/v#{version}"
 
   s.files         = `git ls-files -z`.split("\x0")
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
 
-  s.add_dependency "thor", "0.19.1"
   s.add_dependency "bundler", "~> 2.5"
-  s.add_dependency "ostruct"
-  s.add_dependency "reline"
 
-  #s.add_development_dependency "bundler"#, "~> 1.8"
   s.add_development_dependency "rake", "~> 13.2"
   s.add_development_dependency "rspec"
   s.add_development_dependency "pry"

data/changelog

@@ -1,5 +1,16 @@
-** Planned 0.1.x **
+** Planned 0.2.x **
   - TBD
+
+** 0.2.0 **
+  - Feature: improves stdout feedback to enhance UX
+  - Feature: hides stack trace when user is simply missing a bundlegem.yml file
+  - Feature: allows interpolation of template variables within bootstrap_command
+  - Feature: adds a 'config[:title]' variable
+  - Bugfix: fixes issue where .git and it's subfolders were being created from the source template repo which wasted time
+  - Bugfix: fixes a performance issue where shelling out to git check-ignored was being performed many times within high frequency loops
+  - Bugfix: fixes bug where not specifying the category of a template apparently causes the list function to crash
+  - Bugfix: Cleans out dependencies that are no longer used
+  - Bugfix: Cleaned out tons of dead code and addressed tech debt I've been putting off since 1.8.5
   - Bugfix: Changes working directory before running bootstrap_commands
 
 ** 0.1.0 **
@@ -42,12 +53,12 @@
   - Bugfix: fixes bug where I thought I was using something cool like figaro
     but was not
   - Bugfix: fixes bug where configuration wasn't loaded before running
-    --install-best-templates
+    --install-public-templates
   - Bugfix:  fixes bug where require pry was left in
 
 ** 0.0.7 **
 
-  - Feature:  Ability to load templates from github via --install-best-templates
+  - Feature:  Ability to load templates from github via --install-public-templates
   - Feature:  Make each user defined gem have a subfolder that is the exact
     project structure, so the readme for the gem can exist without fear of it
     being copied into new projects

data/config/config

@@ -1,4 +1,4 @@
 # Comments made to this file will not be preserved
 ---
 default_template: cli_gem
-best_templates: https://github.com/TheNotary/template-ruby-cli-gem https://github.com/TheNotary/template-arduino.git https://github.com/TheNotary/template-docker-repo.git https://github.com/TheNotary/template-html-css-js.git https://github.com/TheNotary/template-java-gradle-cli-app
+public_templates: https://github.com/TheNotary/template-ruby-cli-gem https://github.com/TheNotary/template-arduino.git https://github.com/TheNotary/template-docker-repo.git https://github.com/TheNotary/template-html-css-js.git https://github.com/TheNotary/template-java-gradle-cli-app

data/lib/bundlegem/cli/cli.rb

@@ -1,5 +1 @@
-# The namespace CLI is taken by the legacy code :(
-module Bundlegem::Cli
-end
-
 require 'bundlegem/cli/dir_to_template'

data/lib/bundlegem/cli/dir_to_template.rb

@@ -1,24 +1,36 @@
 require 'find'
 
 
-module Bundlegem::Cli::DirToTemplate
-  class << self
+module Bundlegem::CLI
+  module DirToTemplate
+    class << self
 
-    def go
-      validate_working_directory!
-      file_enumerator = Find.find('.')
+      # returns the list of templates currently available as a well formatted string
+      def go
+        validate_working_directory!
+        file_enumerator = Find.find('.')
 
-      Bundlegem::Core::DirToTemplate.🧙🪄! file_enumerator
-    end
+        output = Bundlegem::Core::DirToTemplate.🧙🪄! file_enumerator
 
-    private
+        if output.empty?
+          output = "You have no templates.  You can install the public example templates with\n"
+          output += "the below command\n\n"
+          output += "bundlegem --install-public-templates"
+        end
 
-    def validate_working_directory!
-      # check for the existence of a bundlegem.yml file which won't ordinarily exist
-      if !File.exist?("bundlegem.yml")
-        raise "error: bundlegem.yml file not found in current directory.  Create it or run this command in the folder you thought you were in."
+        output
       end
-    end
 
+      private
+
+      def validate_working_directory!
+        # check for the existence of a bundlegem.yml file which won't ordinarily exist
+        if !File.exist?("bundlegem.yml")
+          puts "error: bundlegem.yml file not found in current directory.  Create it or run this command in the folder you thought you were in."
+          exit 1
+        end
+      end
+
+    end
   end
 end