bundlegem 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d9582c9d97b6654a46d274e6d463dd81b9a6b61418b0930f01ac4174ec87848
-  data.tar.gz: f1f2f668bed8f34a4e1fcb019ad928a6c6b80dee1b7f03c1591f4c2213268efb
+  metadata.gz: 75ed9eaea5c4e2c9cba58d155ec1323b3756d38f8d2d0c67382d8113f7868183
+  data.tar.gz: 4b7641e480e6817f9a376fdbc18115276444fec3cd67ed754cf1c1486b9ebc55
 SHA512:
-  metadata.gz: 25afe26124dd631077f2d897bf7a537df2a337297ae5ac3efcf37cbe3c54783762e4d301262a4d4e5a9303e53440410b2bf0a6a8046d467947fea10331cd17b1
-  data.tar.gz: c62f5d22ea1fb68338339d131c9609ba400ca65df3a239f9fc7af21f8c639110333789c632693bcc99952e06fc03a68e9000c175b09bc6ed5d4edaf1f18105b4
+  metadata.gz: 907e4dc05d6d5933420125dcc6336669052cbc45bf0b64fc0509f4f6798b9b800b39c81498c46baf898b26da3ce041368b9aee7bfe729f40889555ed1e65e2e0
+  data.tar.gz: d298e506be31ce5122a0b9d737fe35655d9e91f53babb689080236cfea28571a9b6a6833c66aac2d270673410f9c61fed50f6a0ee0c2c3a8361a18df04403e32

data/README.md

@@ -59,36 +59,49 @@ git config --global user.name YOUR_GH_NAME
 git config --global user.repo-domain github.com
 ```
 
-#### 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:
+###### Overview
+- Define the project in a repo as you normally would
+- Commit the project once it's building/ testing the way you'd like
+- Add a `bundlegem.yml` file to the template to make it available for use
+- Run `bundlegem --to-template` which adds a `.tt` suffix to the files
+- Add any template variables to the project. See: `bundlegem --cheat-sheet`
+- Use the template to kick off a new project, `bundlegem -t my-template first-test`
+
+To create your own template, just create a new project using the technologies you'd like.  Place this project in `~/.bundlegem/templates/my-template`.  Once it's done, it's a good idea to create a git commit.  Then run something to the effect...
 
 ```
-$  bundlegem --newtemplate
-Specify a name for your gem template:  my_service
-Specify description:
-Specify template tag name [MISC]:
-Cloning base project structure into ~/.bundlegem/templates/my_service
-...
-  Complete!
-```
+$  echo "category: frontend"    > bundlegem.yml
+$  echo "purpose: frontend"    >> bundlegem.yml
+$  echo "language: javascript" >> bundlegem.yml
 
-You can now get to work making changes to the my_service gem.  All you need to know is that any file that ends in .tt in that folder will be copied into new projects when you create a new project based on that template, however the .tt extension will obviously be stripped out of the resulting file name.
+$  bundlegem --to-template
+```
 
-### Categorizing Your Template
+Change the bundlegem.yml contents to what makes sense for your template.  The `--to-template` command will add a `.tt` to the end of all the files in the project.  To keep you and I safe, it will only run if there is a `bundlegem.yml` file in the current directory.
 
-Also, you can specify the `category` of the gem by editing the bundlegem.yml file in each template's root.  Categories are just used for organizing the output when you run `bundlegem --list`.  Here, I'll show you an example:
+#### Categorizing Your Template
 
+You can specify the `category` of the gem by editing the `bundlegem.yml` file in each template's root.  Categories are just used for organizing the output when you run `bundlegem --list`.  Here's an [example](https://github.com/TheNotary/template-html-css-js/blob/main/bundlegem.yml).
 
-### Customizing Your Own Templates
+#### Customizing Your Own Templates
 
 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.
+You'll get a good idea as to the possibilities by inspecting the various templates I've opensourced under my github org, e.g. [template-ruby-cli-gem](https://github.com/TheNotary/template-ruby-cli-gem).  
+
+To pull up a list of available variables, run this command
+
+```
+$  bundlegem --cheat-sheet
+```
+
+If you would find additional variables handy, set me up with a PR and assuming it seems widely helpful, I'll merge it right as soon as I can.   The implementation for the variables is largely found in [gem.rb](https://github.com/TheNotary/bundlegem/blob/main/lib/bundlegem/cli/gem.rb#L59).
 
-Quick Tips:
+#### Quick Tips Regarding Project Templates
 
 - Files ending with a `.tt` extension will by written to new projects
+- Running `bundlegem --cheat-sheet` will list off available template variables
 - 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.
+- Example: within a `.tt` file, use `<%=config[:namespaced_path]%>` to have that reinterpreted as just the file name with underscores

data/bin/bundlegem

@@ -20,6 +20,11 @@ parser = OptionParser.new do |opts|
     exit
   end
 
+  opts.on("-c", "--cheat-sheet", "Show list of variables available in templates") do
+    puts Bundlegem.cheat_sheet
+    exit
+  end
+
   opts.on("-v", "--version", "Show version") do
     puts Bundlegem.version
     exit
@@ -35,7 +40,7 @@ parser = OptionParser.new do |opts|
     exit
   end
 
-  opts.on("--help", "Show help") do
+  opts.on(nil, "--help", "Show help") do
     puts opts
     puts Bundlegem::HELP_MSG
     exit
@@ -45,7 +50,7 @@ end
 parser.parse!
 
 if ARGV.empty?
-  puts "Error: you need to specify a name for the project being created\n\n"
+  puts parser
   puts Bundlegem::HELP_MSG
   exit 1
 end

data/lib/bundlegem/cli/cheat_sheet.rb

@@ -0,0 +1,14 @@
+
+
+module Bundlegem::CLI
+  module CheatSheet
+    class << self
+
+      def go
+        gem_root = File.expand_path("../../../..", __FILE__)
+        File.read("#{gem_root}/spec/data/variable_manifest_test.rb").lines[3..-1].join
+      end
+
+    end
+  end
+end

data/lib/bundlegem/cli/cli.rb

@@ -1 +1,2 @@
 require 'bundlegem/cli/dir_to_template'
+require 'bundlegem/cli/cheat_sheet'

data/lib/bundlegem/cli/gem.rb

@@ -52,6 +52,8 @@ module Bundlegem::CLI
       # git_repo_url = https://provider.com/user/name
       git_repo_url = "https://#{git_repo_domain}/#{git_user_name}/#{name}"
 
+      image_path = "#{git_user_name}/#{name}".downcase
+
       config = {
         :name             => name,
         :title            => title,
@@ -70,6 +72,7 @@ module Bundlegem::CLI
         :git_repo_domain  => git_repo_domain,
         :git_repo_url     => git_repo_url,
         :git_repo_path    => git_repo_path,
+        :image_path       => image_path,
         :template         => @options[:template],
         :test             => @options[:test],
         :ext              => @options[:ext],

data/lib/bundlegem/templates/test_template/#{name}.rb.tt

@@ -18,3 +18,4 @@ config[:email]:            <%= config[:email] %>
 config[:git_repo_domain]:  <%= config[:git_repo_domain] %>
 config[:git_repo_url]:     <%= config[:git_repo_url] %>
 config[:git_repo_path]:    <%= config[:git_repo_path] %>
+config[:image_path]:       <%= config[:image_path] %>

data/lib/bundlegem/version.rb

@@ -1,3 +1,3 @@
 module Bundlegem
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

data/lib/bundlegem.rb

@@ -17,6 +17,10 @@ module Bundlegem
       Bundlegem::VERSION
     end
 
+    def cheat_sheet
+      CLI::CheatSheet.go
+    end
+
     # lists available templates
     def list
       configurator = Configurator.new

data/spec/bundlegem_spec.rb

@@ -14,6 +14,14 @@ describe Bundlegem do
     expect(Bundlegem::VERSION).not_to be nil
   end
 
+  it 'has a cheat sheet it will share' do
+    output = Bundlegem.cheat_sheet
+
+    expect(output).to include("config[:name]:             good-dog")
+    expect(output).to include("config[:screamcase_name]:  GOOD_DOG")
+    expect(output).to include("config[:image_path]:       test/good-dog")
+  end
+
   # List
 
   it 'gives the user a helpful output when there are no templates installed' do

data/spec/data/variable_manifest_test.rb

@@ -18,3 +18,4 @@ config[:email]:            you@example.com
 config[:git_repo_domain]:  github.com
 config[:git_repo_url]:     https://github.com/Test/good-dog
 config[:git_repo_path]:    github.com/test/good-dog
+config[:image_path]:       test/good-dog

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: bundlegem
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - TheNotary
 bindir: bin
 cert_chain: []
-date: 2025-08-11 00:00:00.000000000 Z
+date: 2025-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,6 +85,7 @@ files:
 - changelog
 - config/config
 - lib/bundlegem.rb
+- lib/bundlegem/cli/cheat_sheet.rb
 - lib/bundlegem/cli/cli.rb
 - lib/bundlegem/cli/dir_to_template.rb
 - lib/bundlegem/cli/gem.rb
@@ -116,9 +117,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/TheNotary/bundlegem/issues
-  changelog_uri: https://github.com/TheNotary/bundlegem/releases/tag/v1.2.0
-  documentation_uri: https://api.rubyonrails.org/v1.2.0/
-  source_code_uri: https://github.com/TheNotary/bundlegem/tree/v1.2.0
+  changelog_uri: https://github.com/TheNotary/bundlegem/releases/tag/v1.2.1
+  documentation_uri: https://api.rubyonrails.org/v1.2.1/
+  source_code_uri: https://github.com/TheNotary/bundlegem/tree/v1.2.1
 rdoc_options: []
 require_paths:
 - lib