bundlegem 0.1.1 → 1.0.1.pre.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca33941473a43a89745d74fba7d815ceae364f0f7514d8d63db538c3178cde54
-  data.tar.gz: 5032d292e973052403c142088e5e358718e22e819b94af74e39f238a2daf9b28
+  metadata.gz: 4cfe0b3615f641b31c021924c843d79bf38bcde9c437620ff2469166be8a0e79
+  data.tar.gz: 3c530f05af2a8aa4aa89c99fa03590978d33d61b559437b5f9d78a74c52fe594
 SHA512:
-  metadata.gz: ba17e06fe7f97d46af8cbe3e8212d2094eb3bfbc925f546ae3598425c0a3185b1f99295b7e25dd6899c2ce1e412389a326e001798bf423a08a639707c8928e7a
-  data.tar.gz: 89a207b4241e8ad8fd89e8b6bcc81489daece88e3dc14dc0325a960792f231a0d40ca6c6aeaf042912e0c6b3eeb9b1c98cacd416ae6b0d0c757b4fdfcc0f7b73
+  metadata.gz: 2d7bb6ae37d62d13d0b4dd4e15fc0d916b39b00e1f9feaf520ceb4fcdf63159d221f648fd547fd63cb28b027c56cfc0bedeb46c60b132ae9d78d9a8d6c6fe9e8
+  data.tar.gz: 27b0d466cba63e6638547dc583645b411536068401658b9a27e106c60faf05fc922d3e3021f0d2158a987bc80f34f7fadad04d75e005ba643d7388c8e8a6d576

data/README.md

@@ -1,33 +1,45 @@
 # BundleGem: A Gem Project Generator with User Defined Templates
-
-Note: Alot 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 so tried to keep the code as similar to their project as possible, but ultimately discovered that they don't want to grow this 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). Also it's a profoundly common dependency meaning every change is high stakes.
+[![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!
 
-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 typs 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.
+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.
 
-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' aproach to gem creation is different from the addative approach that other gem genorators 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.
 
-The most benificial aspect of this gem is that it allows users to specify exactly how they want their 'default starting gem' to look like, rather than rely on what someone else thought their default starting gem should look like.
 
-### Installation and usage
+### Installation
 
 First install it:
 ```
 gem install bundlegem
 ```
 
-Then create a new template for a gem class you expect to use more than once:
+### Configuration
+
+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:
+
 ```
-$  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!
+[user]
+  email = me@example.com
+  name = Me
+  repo-domain = github.com
 ```
-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.  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:
+
+
+### Usage
+
+These commands will create a new gem named `project_name` in `/tmp/project_name`:
+
+```
+$  cd /tmp
+$  bundlegem project_name -t arduino
+```
+
+
+### List Available Templates
 
 ```
 $  bundlegem --list
@@ -40,26 +52,46 @@ MISC:
 
 EMBEDDED:
   arduino
-
 ```
 
-You'll now find a project skeleton in ~/.bundlegem/templates/my_service that you can customize to your liking.
+You'll find a project skeleton in ~/.bundlegem/templates/my_service that you can customize to your liking.
+
 
+### Create Your Own Template
+
+You can create a new template for a project class you expect to use more than once:
 
-Finally, create a new gem using your new gem template:
 ```
-$  cd /tmp
-$  bundlegem project_name -t my_service
+$  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!
 ```
 
+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?
+
+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:
+
+
 ## 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.
 
-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/newgem).  Some quick tips follow:
+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.
+
+Quick Tips:
 
 - Files ending with a `.tt` extension will by written to new projects
 - 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/bin/bundlegem

@@ -28,14 +28,13 @@ if ARGV[0] == "--version" or ARGV[0] == "-v"
   exit 0
 end
 
-if ARGV[0] == "--newtemplate"
-  puts "Sorry, I haven't been implemented, I don't have a lot of free time atm :("
+if ARGV[0] == "--install-best-templates"
+  Bundlegem.install_best_templates
   exit 0
-  Bundlegem.newtemplate(ARGV)
 end
 
-if ARGV[0] == "--install-best-templates"
-  Bundlegem.install_best_templates
+if ARGV[0] == "--to-template"
+  Bundlegem.dir_to_template
   exit 0
 end
 

data/changelog

@@ -1,12 +1,11 @@
 ** 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
-  - CMD:  --newtemplate to start new template
-    - I'll need to write a basic starter template that is educational
   - 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 Master:
+Completed on main:
   - Nothing yet
 
 ** 0.0.14 **
@@ -21,24 +20,16 @@ Completed on Master:
   - Feature:  java project template added to best templates
   - Feature:  python project template added to best templates
 
-
-
 ** 0.0.11 **
   - Bugfix: config[:bundler_version] was listing the version of bundlegem not bundler
 
-
-
 ** 0.0.10 **
   - Feature: tweaks built-in templates
 
-
-
 ** 0.0.9 **
   - Bugfix:  there were misconfigurations with the Rakefiles for cli_gems and c_ect gems that were corrected
   - Feature: `--version` option added
 
-
-
 ** 0.0.8 **
 
   - Bugfix: fixes bug where git clone was attempted even when the a clone
@@ -49,8 +40,6 @@ Completed on Master:
     --install-best-templates
   - Bugfix:  fixes bug where require pry was left in
 
-
-
 ** 0.0.7 **
 
   - Feature:  Ability to load templates from github via --install-best-templates
@@ -64,8 +53,6 @@ Completed on Master:
   - Bugfix: cli_gem and c_ext_gem now show up in the list
   - Bugfix: cli_gem and c_ext_gem had typos fixed
 
-
-
 ** 0.0.6 **
     - Feature:  List now indicates default template
     - CORE:  Created TemplateManager for working with templates
@@ -73,8 +60,6 @@ Completed on Master:
       change directory into a test area for creating new gems.
     - BUG:  newgem template didn't have a dot in .gitignore.tt
 
-
-
 ** 0.0.5 **
   - Bug in 0.0.3 that broke building template gems fixed
     * Template Directories part of code was being skipped for built in templates, but not all of it
@@ -82,26 +67,21 @@ Completed on Master:
   - Added integration test just to make sure the built-in templates can be generated without problems
   - Cleaned up internal API and how the binary works
 
-
 ** 0.0.4 **
   - Tell the user what files are being created
   - Created config['git_repo_url'] variable to be used in templates
 
-
 ** 0.0.3 **
     - CMD:  --list to list templates (with descriptions)
     - Raise error when project name already exists, do not overwrite!
     - Raises error if none of the files in the template directory end in .tt
     - Create even empty folders
 
-
 ** 0.0.2 **
     - Added default gem template 'service'
     - Better syntax of bundlegem gem_name -t template_name
     - CMD:  --help to display a help message
 
-
 ** 0.0.1 **
   - Very basic prototype that allows you to specify templates in
     ~/.bundlegem/templates
-

data/config/config

@@ -1,4 +1,4 @@
 # Comments made to this file will not be preserved
 ---
-default_template: newgem
-best_templates: https://github.com/TheNotary/arduino.git https://github.com/TheNotary/raspberry_pi_c.git https://github.com/TheNotary/docker_repo.git https://github.com/TheNotary/simple_frontend.git https://github.com/tymeart/node_cli https://github.com/TheNotary/java-cli-app https://github.com/TheNotary/java-gradle-cli-app https://github.com/TheNotary/python_library
+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

data/lib/bundlegem/cli/cli.rb

@@ -0,0 +1,5 @@
+# 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

@@ -0,0 +1,24 @@
+require 'find'
+
+
+module Bundlegem::Cli::DirToTemplate
+  class << self
+
+    def go
+      validate_working_directory!
+      file_enumerator = Find.find('.')
+
+      Bundlegem::Core::DirToTemplate.🧙🪄! file_enumerator
+    end
+
+    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."
+      end
+    end
+
+  end
+end

data/lib/bundlegem/cli/gem.rb

@@ -1,4 +1,5 @@
 require 'pathname'
+require 'yaml'
 
 module Bundlegem
   class CLI::Gem
@@ -10,29 +11,57 @@ module Bundlegem
 
       @name = @gem_name
       @target = Pathname.pwd.join(gem_name)
+      @template_src = TemplateManager.get_template_src(options)
+
+      @tconf = load_template_configs
 
       validate_ext_name if options[:ext]
     end
 
     def build_interpolation_config
+      pascal_name = name.tr('-', '_').split('_').map(&:capitalize).join
+      unprefixed_name = name.sub(/^#{@tconf[:prefix]}/, '')
       underscored_name = name.tr('-', '_')
-      namespaced_path = name.tr('-', '/')
       constant_name = name.split('_').map{|p| p[0..0].upcase + p[1..-1] unless p.empty?}.join
       constant_name = constant_name.split('-').map{|q| q[0..0].upcase + q[1..-1] }.join('::') if constant_name =~ /-/
       constant_array = constant_name.split('::')
       git_user_name = `git config user.name`.chomp
       git_user_email = `git config user.email`.chomp
 
+      # domain = provider.com
+      git_repo_domain = `git config user.repo-domain`.chomp
+
+      if git_repo_domain.empty?
+        git_repo_domain = "github.com"
+      end
+
+      if git_user_name.empty?
+        raise "git config user.name didn't return a value.  Please double check your username configurations in ~/.gitconfig"
+      else
+        # path = provider.com/user/name
+        git_repo_path = "#{git_repo_domain}/#{git_user_name}/#{name}".downcase # downcasing for languages like go that are creative
+      end
+
+      # url = https://provider.com/user/name
+      git_repo_url = "https://#{git_repo_domain}/#{git_user_name}/#{name}"
+
       config = {
         :name             => name,
+        :unprefixed_name  => unprefixed_name,
+        :unprefixed_pascal=> unprefixed_name.tr('-', '_').split('_').map(&:capitalize).join,
         :underscored_name => underscored_name,
-        :namespaced_path  => namespaced_path,
+        :pascal_name      => pascal_name,
+        :camel_name       => pascal_name.sub(/^./, &:downcase),
+        :screamcase_name  => name.tr('-', '_').upcase,
+        :namespaced_path  => name.tr('-', '/'),
         :makefile_path    => "#{underscored_name}/#{underscored_name}",
         :constant_name    => constant_name,
         :constant_array   => constant_array,
         :author           => git_user_name.empty? ? "TODO: Write your name" : git_user_name,
         :email            => git_user_email.empty? ? "TODO: Write your email address" : git_user_email,
-        :git_repo_url     => git_user_name.empty? ? "TODO: set your git username so link to repo is automatic" : "https://github.com/#{git_user_name}/#{underscored_name}",
+        :git_repo_domain  => git_repo_domain,
+        :git_repo_url     => git_repo_url,
+        :git_repo_path    => git_repo_path,
         :template         => options[:template],
         :test             => options[:test],
         :ext              => options[:ext],
@@ -52,7 +81,7 @@ module Bundlegem
 
       template_src = match_template_src
       template_directories = dynamically_generate_template_directories
-      templates = dynamically_generate_templates
+      templates = dynamically_generate_templates_files
 
       puts "Creating new project folder '#{name}'\n\n"
       create_template_directories(template_directories, target)
@@ -64,27 +93,38 @@ module Bundlegem
       # Bundler.ui.info "Initializing git repo in #{target}"
       Dir.chdir(target) { `git init`; `git add .` }
 
-      # Disabled thanks to removal of thor, might not be helpful...
-      #if options[:edit]
-      #  # Open gemspec in editor
-      #
-      #  # thor.run("#{options["edit"]} \"#{target.join("#{name}.gemspec")}\"")
-      #end
-
       puts "\nComplete."
     end
 
     private
 
+    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
+        t_config = {
+          purpose: "tool",
+          language: "go"
+        }
+      end
+
+      if t_config[:prefix].nil?
+        t_config[:prefix] = t_config[:purpose] ? "#{t_config[:purpose]}-" : ""
+        t_config[:prefix] += t_config[:language] ? "#{t_config[:language]}-" : ""
+      end
+
+      t_config
+    end
+
     # Returns a hash of source directory names and their destination mappings
     def dynamically_generate_template_directories
-      template_src = TemplateManager.get_template_src(options)
-
       template_dirs = {}
-      Dir.glob("#{template_src}/**/*").each do |f|
+      Dir.glob("#{@template_src}/**/*", File::FNM_DOTMATCH).each do |f|
+        next if f == "#{@template_src}/." || f == "#{@template_src}/.."
         next unless File.directory? f
-        base_path = f[template_src.length+1..-1]
-        template_dirs.merge!(base_path => base_path.gsub('#{name}', "#{name}") )
+        base_path = f[@template_src.length+1..-1]
+        template_dirs.merge!(base_path => substitute_template_values(base_path))
       end
       template_dirs
     end
@@ -108,7 +148,6 @@ module Bundlegem
         'bin/console.tt' => "bin/console"
       }
 
-
       prompt_coc!(templates)
       prompt_mit!(templates, config)
       prompt_test_framework!(templates, config)
@@ -125,19 +164,24 @@ module Bundlegem
       templates
     end
 
+    # Applies every possible substitution within config to the fs_obj_name
+    def substitute_template_values(fs_obj_name)
+      config.keys.inject(fs_obj_name) do |accu, key|
+        if config[key].class == String
+          accu.gsub(/\#\{#{key.to_s}\}/, config[key])
+        else
+          accu
+        end
+      end
+    end
+
     # Figures out the translation between all the .tt file to their
     # destination names
-    def dynamically_generate_templates
-      template_src = TemplateManager.get_template_src(options)
-
+    def dynamically_generate_templates_files
       templates = {}
-      Dir.glob("#{template_src}/**/{*,.*}.tt").each do |f|
-        base_path = f[template_src.length+1..-1]
-        templates.merge!(base_path => base_path
-                   .gsub(/\.tt$/, "")
-                   .gsub('#{name}', "#{name}")
-                   .gsub('#{underscored_name}', config[:underscored_name])
-        )
+      Dir.glob("#{@template_src}/**/*.tt", File::FNM_DOTMATCH).each do |f|
+        base_path = f[@template_src.length+1..-1]
+        templates.merge!( base_path => substitute_template_values(base_path).sub(/\.tt$/, "") )
       end
 
       raise_no_files_in_template_error! if templates.empty?
@@ -164,12 +208,10 @@ module Bundlegem
       end
     end
 
-
     def resolve_name(name)
       Pathname.pwd.join(name).basename.to_s
     end
 
-
     def validate_ext_name
       return unless gem_name.index('-')
 
@@ -180,7 +222,6 @@ module Bundlegem
       exit 1
     end
 
-
     def bundler_dependency_version
       v = Gem::Version.new(Bundler::VERSION)
       req = v.segments[0..1]
@@ -189,9 +230,6 @@ module Bundlegem
     end
 
 
-
-
-
     #
     # EDIT:  Reworked from Thor to not rely on Thor (or do so much unneeded stuff)
     #
@@ -247,7 +285,7 @@ but no files within it ended in .tt.  Did you forget to rename the extensions of
 Exiting...
       HEREDOC
       puts err_no_files_in_template
-      exit
+      raise
     end
 
     def raise_project_with_that_name_already_exists!
@@ -258,14 +296,14 @@ Can't make project.  Either delete that folder or choose a new project name
 Exiting...
       HEREDOC
       puts err_project_with_that_name_exists
-      exit
+      raise
     end
 
     def raise_template_not_found!
       err_missing_template = "Could not find template folder '#{options["template"]}' in `~/.bundle/templates/`. Please check to make sure your desired template exists."
       puts err_missing_template
       Bundler.ui.error err_missing_template
-      exit 1
+      raise
     end
 
 
@@ -357,10 +395,10 @@ Exiting...
     def ensure_safe_gem_name(name, constant_array)
       if name =~ /^\d/
         Bundler.ui.error "Invalid gem name #{name} Please give a name which does not start with numbers."
-        exit 1
+        raise
       elsif Object.const_defined?(constant_array.first)
         Bundler.ui.error "Invalid gem name #{name} constant #{constant_array.join("::")} is already in use. Please choose another gem name."
-        exit 1
+        raise
       end
     end
 

data/lib/bundlegem/cli.rb

@@ -113,7 +113,7 @@ module Bundlegem
     method_option :mit, :type => :boolean, :desc => "Generate an MIT license file"
     method_option :test, :type => :string, :lazy_default => 'rspec', :aliases => '-t', :banner => "rspec",
       :desc => "Generate a test directory for your library, either rspec or minitest. Set a default with `bundle config gem.test rspec`."
-    method_option :template, :type => :string, :lazy_default => "newgem", :aliases => '-u', :banner => "default", :desc => "Generate a gem based on the user's predefined template."
+    method_option :template, :type => :string, :lazy_default => "cli_gem", :aliases => '-u', :banner => "default", :desc => "Generate a gem based on the user's predefined template."
     def gem(name)
       # options = {"bin"=>false, "ext"=>false}
       # name = "gem_name"

data/lib/bundlegem/configurator.rb

@@ -4,7 +4,7 @@ require 'yaml'
 module Bundlegem
 
   class Configurator
-    attr_accessor :user_defined_templates, :user_downloaded_templates, :config_file_data
+    attr_accessor :config_file_data
 
     def initialize
       @config_directory_root = "#{ENV['HOME']}/.bundlegem"
@@ -13,9 +13,6 @@ module Bundlegem
 
       create_config_file_if_needed!
 
-      @user_defined_templates = get_user_defined_templates
-      @user_downloaded_templates = get_user_downloaded_templates
-
       # load configurations from config file
       @config_file_data = YAML.load_file @config_file
     end
@@ -29,16 +26,7 @@ module Bundlegem
       File.write(@config_file, "# Comments made to this file will not be preserved\n#{YAML.dump(@config_file_data)}")
     end
 
-    def built_in_templates
-
-    end
-
-    # not implemented yet
-    def get_user_downloaded_templates
-      []
-    end
-
-    def get_user_defined_templates
+    def collect_user_defined_templates
       user_definition_directory = @user_defined_templates_path
       template_dirs = Dir.entries(user_definition_directory).select do |entry|
         File.directory?(File.join(user_definition_directory, entry)) and !(entry =='.' || entry == '..')
@@ -51,20 +39,23 @@ module Bundlegem
 
         begin
           f = File.read("#{@user_defined_templates_path}/#{dir}/.bundlegem")
-          /category:\s*([\w\s]*$)/ =~ f
 
-          category = $1.chomp
+          category = parse_out(:category, f)
         rescue
           category = "MISC"
         end
 
         category = "MISC" if category.nil?
-
-        pairs << {category => dir }
+        pairs << {category => dir.sub(/^template-/, "") }
       end
       pairs
     end
 
+    def parse_out(key, config_txt)
+      /#{key.to_s}:\s*([\w\s]*$)/ =~ config_txt
+      $1.chomp
+    end
+
     def create_config_file_if_needed!
       FileUtils.mkdir_p @user_defined_templates_path
       FileUtils.cp("#{SOURCE_ROOT}/config/config", @config_file) unless File.exist? @config_file

data/lib/bundlegem/core/core.rb

@@ -0,0 +1,9 @@
+# This is the core logic for the app.  CLI stuff should eventually get pulled
+# out so the app is neat and the way I do CLI stuff lately.
+module Bundlegem::Core
+end
+
+# I saw someone on the internet do requires this way so am giving it a spin :)
+# It's a little odd, right?  I'm not sure I like it yet but lets me go to
+# town on namespaces and `class << self` definitions if I want...
+require 'bundlegem/core/dir_to_template'

data/lib/bundlegem/core/dir_to_template.rb

@@ -0,0 +1,59 @@
+require 'find'
+require 'open3'
+require 'shellwords'
+
+
+module Bundlegem::Core::DirToTemplate
+  class << self
+
+    # Takes in a file_enumerator such as Find.find('.') and
+    # renames all the files
+    def 🧙🪄! file_enumerator, template_name: "asdf-pkg", dry_run: false
+      files_changed = []
+      file_enumerator.each do |path|
+        next if should_skip?(path)
+
+        conduct_pkg_name_to_template_variable_replacements!(path)
+
+        new_path = "#{path}.tt"
+        File.rename(path, new_path) unless dry_run
+        files_changed << "Renamed: #{path} -> #{new_path}"
+      end
+      files_changed
+    end
+
+    private
+
+    def conduct_pkg_name_to_template_variable_replacements!(path)
+      # TODO: Conduct text replacements:
+      #
+      #   'asdf-pkg' -> '<%=config[:name]%>'
+      #   'asdf_pkg' -> '<%=config[:underscored_name]%>'
+      #   'ASDF_PKG' -> '<%=config[:screamcase_name]%>'
+    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
+        ignored_by_git?(path) ||        # skip things that are gitignored
+        path == "./.bundlegem"          # skip the .bundlegem 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."
+      end
+    end
+
+    def ignored_by_git?(path)
+      stdout, _, status = Open3.capture3("git check-ignore #{Shellwords.escape(path)}")
+      status.success? && !stdout.strip.empty?
+    end
+
+  end
+end