bundlegem 1.0.1.pre.rc.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cfe0b3615f641b31c021924c843d79bf38bcde9c437620ff2469166be8a0e79
-  data.tar.gz: 3c530f05af2a8aa4aa89c99fa03590978d33d61b559437b5f9d78a74c52fe594
+  metadata.gz: 59cedb35eb5e27205162bbf4cab34f99d0269f2becdaa7e0544b614bad7510eb
+  data.tar.gz: 79334971e8ac017e651e5aeab129ede8e5be7b8ba4491fdcbed360d9286ce795
 SHA512:
-  metadata.gz: 2d7bb6ae37d62d13d0b4dd4e15fc0d916b39b00e1f9feaf520ceb4fcdf63159d221f648fd547fd63cb28b027c56cfc0bedeb46c60b132ae9d78d9a8d6c6fe9e8
-  data.tar.gz: 27b0d466cba63e6638547dc583645b411536068401658b9a27e106c60faf05fc922d3e3021f0d2158a987bc80f34f7fadad04d75e005ba643d7388c8e8a6d576
+  metadata.gz: c728247b2e279c30b46efebb45d26f52cca5c052286bedc04a55f190b3c88242db8fe4b5e4ae7e22210c67c0fb84d2e80569b43da151d24e0a63b469925d7bfc
+  data.tar.gz: cf6e1c50c39fa472fced36fc8175e716e43d7d61563f3e0efdce4a83ddecdc72733b0a956c9a111e1f1c568285d3e7d8171740af8d2864a7540b94b5a1b2df2a

data/README.md

@@ -57,7 +57,7 @@ EMBEDDED:
 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:
 
@@ -73,12 +73,12 @@ Cloning base project structure into ~/.bundlegem/templates/my_service
 
 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.
 
-## TODO: Did you actually implement this?
+### Categorizing Your Template
 
-Also, you can specify the `category` of the gem by editing the .bundlegem 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:
+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:
 
 
-## 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-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.
 
@@ -92,6 +92,6 @@ Quick Tips:
 - 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
+## 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/changelog

@@ -1,12 +1,16 @@
-** 0.0.x **
-  - Add prompt "Would you care to summarize your gem for documentation purposes? (y/[n])
-  - Add prompt for specifying java package org name
-  - Why have more than one built in template?  Only one is needed for testing, the rest should
-    be pulled from the web and made easily customizable by the users.
-  - Is thor used in this project or not???
-
-Completed on main:
-  - Nothing yet
+** Planned 0.1.x **
+  - TBD
+
+** 0.1.0 **
+  - Feature: Drops .bundlegem file in favor of bundlegem.yml in templates
+  - Feature: Introduces `--to-template` switch to add a `.tt` extension to all files in the current directory
+  - Feature: Enables execution of bootstrap_commands listing in bundlegem.yml
+  - Feature: Cleans out built-in templates in favor of externally managed templates
+  - Bugfix:  Prevents creation of template files that are gitignored
+
+** 1.0.0 **
+  - Feature: Greatly expands the template interpolation values
+  - Bugfix: misc cleanup
 
 ** 0.0.14 **
   - Bugfix:  The project didn't work with ruby 3 due to use of the method `exists?`???

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-raspberry-pi-c.git https://github.com/TheNotary/docker_repo.git https://github.com/TheNotary/template-html-css-js.git https://github.com/TheNotary/template-java-gradle-cli-app https://github.com/TheNotary/template-python-library
+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

data/lib/bundlegem/cli/dir_to_template.rb

@@ -14,9 +14,9 @@ module Bundlegem::Cli::DirToTemplate
     private
 
     def validate_working_directory!
-      # check for the existence of a .bundlegem file which won't ordinarily exist
-      if !File.exist?(".bundlegem")
-        raise "error: .bundlegem file not found in current directory.  Create it or run this command in the folder you thought you were in."
+      # 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."
       end
     end
 

data/lib/bundlegem/cli/gem.rb

@@ -93,13 +93,29 @@ module Bundlegem
       # Bundler.ui.info "Initializing git repo in #{target}"
       Dir.chdir(target) { `git init`; `git add .` }
 
+      if @tconf[:bootstrap_command]
+        puts "Executing bootstrap_command"
+        puts @tconf[:bootstrap_command]
+        `#{@tconf[:bootstrap_command]}`
+      end
+
       puts "\nComplete."
     end
 
     private
 
+    # TODO: Extract these notes to the docs or delete them
+    # The language and purpose configurations of the bundlegem.yml file
+    # can be used to make sure when you create a folder named
+    # `bundlegem -t blah tool-go-ollama-find`, the internal name
+    # that the app has for itself can become simply `ollama-find`, dropping the prefix
+    # which is intended to exist only at the repostory name and shouldn't impact
+    # the package naming... much...
+    #
+    # I didn't document this feature originally so it may not have been fully fleshed out...
     def load_template_configs
       template_config_path = File.join(@template_src, "bundlegem.yml")
+
       if File.exist?(template_config_path)
         t_config = YAML.load_file(template_config_path, symbolize_names: true)
       else
@@ -124,6 +140,7 @@ module Bundlegem
         next if f == "#{@template_src}/." || f == "#{@template_src}/.."
         next unless File.directory? f
         base_path = f[@template_src.length+1..-1]
+        next if ignored_by_git?(@template_src, base_path)
         template_dirs.merge!(base_path => substitute_template_values(base_path))
       end
       template_dirs
@@ -137,13 +154,13 @@ module Bundlegem
     def generate_templates_for_built_in_gems(config)
       # Hmmm... generate dynamically instead?  Yes, overwritten below
       templates = {
-        'Gemfile.tt' => "Gemfile",
+        'Gemfile.tt'   => "Gemfile",
         'changelog.tt' => "changelog",
         'gitignore.tt' => ".gitignore",
         'lib/#{name}.rb.tt' => "lib/#{config[:namespaced_path]}.rb",
         'lib/#{name}/version.rb.tt' => "lib/#{config[:namespaced_path]}/version.rb",
         '#{name}.gemspec.tt' => "#{config[:name]}.gemspec",
-        'Rakefile.tt' => "Rakefile",
+        'Rakefile.tt'  => "Rakefile",
         'README.md.tt' => "README.md",
         'bin/console.tt' => "bin/console"
       }
@@ -181,6 +198,7 @@ module Bundlegem
       templates = {}
       Dir.glob("#{@template_src}/**/*.tt", File::FNM_DOTMATCH).each do |f|
         base_path = f[@template_src.length+1..-1]
+        next if ignored_by_git?(@template_src, base_path)
         templates.merge!( base_path => substitute_template_values(base_path).sub(/\.tt$/, "") )
       end
 
@@ -189,6 +207,11 @@ module Bundlegem
       return templates
     end
 
+    def ignored_by_git?(repo_root, path)
+      stdout, _, status = Open3.capture3("git -C #{repo_root} check-ignore #{Shellwords.escape(path)}")
+      status.success? && !stdout.strip.empty?
+    end
+
     def create_template_directories(template_directories, target)
       template_directories.each do |k,v|
         d = "#{target}/#{v}"

data/lib/bundlegem/configurator.rb

@@ -28,25 +28,22 @@ module Bundlegem
 
     def collect_user_defined_templates
       user_definition_directory = @user_defined_templates_path
-      template_dirs = Dir.entries(user_definition_directory).select do |entry|
+      templates = Dir.entries(user_definition_directory).select do |entry|
         File.directory?(File.join(user_definition_directory, entry)) and !(entry =='.' || entry == '..')
       end
 
       pairs = []
-      template_dirs.each do |dir|
-        # open the dir and read the .bundlegem file to see what class of file it is
-        # If there's no .bundlegem file in there, mark it misc
-
-        begin
-          f = File.read("#{@user_defined_templates_path}/#{dir}/.bundlegem")
-
-          category = parse_out(:category, f)
-        rescue
-          category = "MISC"
+      templates.each do |template_path|
+        # open the template_path and read the bundlegem.yml file to see what class of file it is
+        # If there's no bundlegem.yml file in there, mark it misc
+
+        template_config_path = "#{@user_defined_templates_path}/#{template_path}/bundlegem.yml"
+        if File.exist?(template_config_path)
+          obj = YAML.load_file(template_config_path, symbolize_names: true) || { category: "misc" }
+          category = obj[:category]
         end
 
-        category = "MISC" if category.nil?
-        pairs << {category => dir.sub(/^template-/, "") }
+        pairs << {category => template_path.sub(/^template-/, "") }
       end
       pairs
     end

data/lib/bundlegem/core/dir_to_template.rb

@@ -17,6 +17,8 @@ module Bundlegem::Core::DirToTemplate
 
         new_path = "#{path}.tt"
         File.rename(path, new_path) unless dry_run
+        repopulate_gitignore(path, new_path) unless dry_run
+
         files_changed << "Renamed: #{path} -> #{new_path}"
       end
       files_changed
@@ -24,6 +26,13 @@ module Bundlegem::Core::DirToTemplate
 
     private
 
+    # Hack for putting the gitignore file back if it's been templatized...
+    def repopulate_gitignore(path, new_path)
+      if new_path == "./.gitignore.tt"
+        FileUtils.cp(new_path, path)
+      end
+    end
+
     def conduct_pkg_name_to_template_variable_replacements!(path)
       # TODO: Conduct text replacements:
       #
@@ -33,20 +42,18 @@ module Bundlegem::Core::DirToTemplate
     end
 
     def should_skip?(path)
-      return false if path == "./.gitignore" && !File.exist?("#{path}.tt")
-
       !File.file?(path) ||              # skip directories
         path.end_with?('.tt') ||        # skip if the file is a .tt already
         File.exist?("#{path}.tt") ||    # skip if a .tt variant of this file exists
-        path.start_with?('./.git') ||   # skip the .git directory
+        path.start_with?('./.git/') ||  # skip the .git directory
         ignored_by_git?(path) ||        # skip things that are gitignored
-        path == "./.bundlegem"          # skip the .bundlegem file
+        path == "./bundlegem.yml"          # skip the bundlegem.yml file
     end
 
     def validate_working_directory!
-      # check for the existence of a .bundlegem file which won't ordinarily exist
-      if !File.exist?(".bundlegem")
-        raise "error: .bundlegem file not found in current directory.  Create it or run this command in the folder you thought you were in."
+      # 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."
       end
     end
 

data/lib/bundlegem/strings.rb

@@ -5,17 +5,14 @@ Use bundlegem to start a new project folder based on a predefined template.
 
 Usage Examples:
 
-  # Make a new ruby gem
-  $  bundlegem your_gem_name
+  # Download all my template files (configured in ~/.bundlegem/config)
+  $ bundlegem --install-best-templates
 
   # List available teplates
   $  bundlegem --list
 
   # Create a ruby gem project using the built in service template
-  $ bundlegem your_gem_name -t service
-
-  # Download all my template files (configured in ~/.bundlegem/config)
-  $ bundlegem --install-best-templates
+  $ bundlegem --template service your_gem_name
 
   # Convert the current directory which represents a working project into a
   # template meaning all files will be renamed to *.tt unless a *.tt of that

data/lib/bundlegem/version.rb

@@ -1,3 +1,3 @@
 module Bundlegem
-  VERSION = "1.0.1-rc.1"
+  VERSION = "1.1.0"
 end

data/spec/bundlegem/core/dir_to_template_spec.rb

@@ -10,13 +10,31 @@ module Bundlegem::Core
 
       reset_test_env
       FileUtils.chdir(@dst_dir)
+      @initial_dir = FileUtils.pwd
     end
 
-    it 'is there' do
-      create_user_defined_template(category: "wizardly_tools")
-      files_changed = DirToTemplate.🧙🪄! Find.find('/tmp/temp/.'), dry_run: true
+    after :each do
+      FileUtils.cd(@initial_dir)
+    end
+
+    it 'will rename the expected files and ignore the ones that should be ignored' do
+      template_dir = create_user_defined_template(category: "wizardly_tools")
+
+      gitignored_file = "something.toignore"
+
+      # Setup test template
+      FileUtils.cd(template_dir)
+      FileUtils.touch("#{template_dir}/README.md")
+      FileUtils.touch("#{template_dir}/#{gitignored_file}")
+      File.write("#{template_dir}/.gitignore", gitignored_file)
+      `git init`
+
+      files_changed = DirToTemplate.🧙🪄! Find.find("."), dry_run: true
 
-      expect(files_changed.first).to eq "Renamed: /tmp/temp/./README.md -> /tmp/temp/./README.md.tt"
+      expect(files_changed[0]).to eq "Renamed: ./.gitignore -> ./.gitignore.tt"
+      expect(files_changed[1]).to eq "Renamed: ./README.md -> ./README.md.tt"
+      expect(File).to exist "#{template_dir}/.gitignore"
+      expect(files_changed.count).to eq 2
     end
   end
 end

data/spec/bundlegem_spec.rb

@@ -14,6 +14,8 @@ describe Bundlegem do
     expect(Bundlegem::VERSION).not_to be nil
   end
 
+  # List
+
   it 'creates a config file if needed and lists properly' do
     create_user_defined_template
 
@@ -42,6 +44,8 @@ describe Bundlegem do
     expect(list_output).to include "happy-burger"
   end
 
+  # Generate
+
   # This bulids the default gem template
   it "can generate the default built-in gem fine" do
     options = {"bin"=>false, "ext"=>false, :coc=> false}
@@ -59,7 +63,6 @@ describe Bundlegem do
     expect(File).to exist("#{@dst_dir}/#{gem_name}/ext/tmp_gem/#{gem_name}.c")
   end
 
-
   it "finds the template-test template even if the template- prefix was omitted" do
     options = {"bin"=>false, "ext"=>false, :coc=> false, "template" => "test"}
     gem_name = "tmp_gem"
@@ -69,7 +72,6 @@ describe Bundlegem do
     expect(File).to exist("#{@dst_dir}/#{gem_name}/.vscode/launch.json")
   end
 
-
   it "has a useful dynamically_generate_template_directories method" do
     options = { "bin"=>false, "ext"=>false, :coc=> false, "template" => "test_template" }
     gem_name = "good-dog"
@@ -110,6 +112,37 @@ describe Bundlegem do
     expect(src_dst_map['simple_dir/keep.tt']).to eq 'simple_dir/keep'
   end
 
+  it "won't generate template files that are listed under the gitignore" do
+    template_dir = create_user_defined_template("testing", "template-user-supplied")
+    options = { "bin"=>false, "ext"=>false, :coc=> false, "template" => "template-user-supplied" }
+    gem_name = "good-dog"
+
+    File.write("#{template_dir}/.gitignore", "node_modules/")
+    File.write("#{template_dir}/README.md.tt", "Hello")
+    FileUtils.mkdir("#{template_dir}/node_modules")
+    File.write("#{template_dir}/node_modules/dont_template.rb.tt", "I must not be interpretted")
+    `git init #{template_dir}`
+
+    capture_stdout { Bundlegem.gem(options, gem_name) }
+
+    expect(File).not_to exist "#{@dst_dir}/#{gem_name}/node_modules/dont_template.rb"
+    expect(File).not_to exist "#{@dst_dir}/#{gem_name}/node_modules"
+  end
+
+  it "executes the bootstrap_command if supplied" do
+    template_dir = create_user_defined_template("testing", "template-user-supplied")
+    options = { "bin"=>false, "ext"=>false, :coc=> false, "template" => "template-user-supplied" }
+    gem_name = "good-dog"
+
+    File.write("#{template_dir}/bundlegem.yml", "bootstrap_command: echo hihihi")
+    File.write("#{template_dir}/README.md.tt", "# Readme...")
+    `git init #{template_dir}`
+
+    output = capture_stdout { Bundlegem.gem(options, gem_name) }
+
+    expect(output).to include "hihihi"
+  end
+
   it "has a test proving every interpolation in one file" do
     options = { "bin"=>false, "ext"=>false, :coc=> false, "template" => "test_template" }
     gem_name = "good-dog"

data/spec/spec_helper.rb

@@ -30,7 +30,7 @@ def create_user_defined_template(category = nil, template_name = "empty_template
   FileUtils.mkdir_p new_template_dir
 
   # Writes the category
-  File.open("#{new_template_dir}/.bundlegem", "w+") do |f|
+  File.open("#{new_template_dir}/bundlegem.yml", "w+") do |f|
     f.puts "category: #{category}" unless category.nil?
   end
 

data/spec/template_manager_spec.rb

@@ -8,8 +8,6 @@ module Bundlegem
 
       output = TemplateManager.get_template_src(options)
 
-      # binding.pry
-
       expect(File.basename(output)).to eq "template-test"
     end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: bundlegem
 version: !ruby/object:Gem::Version
-  version: 1.0.1.pre.rc.1
+  version: 1.1.0
 platform: ruby
 authors:
 - TheNotary
 bindir: bin
 cert_chain: []
-date: 2025-05-11 00:00:00.000000000 Z
+date: 2025-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -222,9 +222,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/TheNotary/bundlegem/issues
-  changelog_uri: https://github.com/TheNotary/bundlegem/releases/tag/v1.0.1-rc.1
-  documentation_uri: https://api.rubyonrails.org/v1.0.1-rc.1/
-  source_code_uri: https://github.com/TheNotary/bundlegem/tree/v1.0.1-rc.1
+  changelog_uri: https://github.com/TheNotary/bundlegem/releases/tag/v1.1.0
+  documentation_uri: https://api.rubyonrails.org/v1.1.0/
+  source_code_uri: https://github.com/TheNotary/bundlegem/tree/v1.1.0
 rdoc_options: []
 require_paths:
 - lib