bundlegem 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43a7ecbc5c9caf18ef4fd7dfd978a173d9b6aecb
-  data.tar.gz: 03d52dc639b8a2c2fa3ee266810911a808f5da2a
+  metadata.gz: dbdb68afebfbeb334228842740af8526fa5504cc
+  data.tar.gz: 42d17ac31d85fa50bdcfef6c5a1bbef3b864546a
 SHA512:
-  metadata.gz: 60ecbdf011e4fea8998857e06b49af05f66ed26d301c651766680056bf6b96fc1f8d5fa61ac062465658ee8ef910594e9b74347c611fc56fb838960baa490316
-  data.tar.gz: 3c830a24a7fd96398cd6093e4d215598aa87adcd843fe4d89f66e4a10f365a793bbfb0697b12d38786039ffd546710718bbf5ecb40043e6a046ee61a46c46a1c
+  metadata.gz: 66bc0d28dfe1a4ec6515e2bfbf9e9a7c82f273b3e8d6fbbfa73f35adb083c6b26f974b6d603b9754d8bbca55e3bfe7bdd8f47e5dd13fcf7945ea66d5c88c202a
+  data.tar.gz: 570a2bf84fac4530e10884ecef11008d6555e8a7b3736f6128c37d90d28144380254488c9741168209a97500d5c0b15381c6358853e06b0c1168b0660c8b3f10

data/README.md

@@ -1,13 +1,12 @@
+# BundleGem: A Gem Project Generator with User Defined Templates
 
-# BundleGem: a gem project genorator with user defined templates
+I've more or less taken the code out of Bundler's `bundle gem` command, expanded on it and made it available as this repos (so credits to Bundler team).
 
-I've more or less taken the code out of Bundler's `bundle gem` command, expanded on it and made it available as this repos.
+The goal to the project is to allow users to define templates in the most native form for all technologist: Directory Structures, short command, 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.  
+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.  
 
-All of these 'classes of gems' as I refer to them, start out with a different code base, consistent with all other gems of there class.  
-This 'class based' aproach to gem creation is different from the addative approach that other gem genorators 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 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.  
 
@@ -18,13 +17,30 @@ First install it:
 gem install bundlegem
 ```
 
-Then create a new project structure:
+Then create a new template for a gem class you expect to use more than once:
 ```
-$  bundlegem template new
+$  bundlegem --newtemplate
 Specify a name for your gem template:  my_service
-Cloning base project structure into ~/.bundlegem/templates/my_service
+Specify description:  
+Specify template tag name [MISC]:  
+Cloning base project structure into ~/.bundlegem/gem_templates/my_service
 ...
-Complete!
+  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.  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:
+
+```
+$  bundlegem --list
+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
+
 ```
 
 You'll now find a project skeleton in ~/.bundlegem/templates/my_service that you can customize to your liking.  

data/bin/bundlegem

@@ -29,6 +29,11 @@ if ARGV[0] == "--help"
   exit 0
 end
 
+if ARGV[0] == "--list" or ARGV[0] == "-l"
+  puts Bundlegem.list
+  exit 0  
+end
+
 if ARGV[0] == "--newtemplate"
   puts "Sorry, I haven't been implemented, I don't have a lot of free time atm :("
   exit 0

data/changelog

@@ -4,11 +4,21 @@
 		* CLI with web client
 	- Restore the original UI that was in bundler
 	- Ability to load templates from github
-	- CMD:  --list to list templates (with descriptions)
 	- CMD:  --newtemplate to start new template
-	- Behavior: gems in the ~/.bundlegem/templates folder take precidence over
-	built in gems
+	- CMD:  --templateize-current-directory to make the current directory into a
+	  new template
+	- Behavior: gems in the ~/.bundlegem/gem_templates folder take precidence over
+	  built in gems?
+  - Tell the user what files are being created
+
+
+** 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
@@ -17,5 +27,5 @@
 
 ** 0.0.1 **
   - Very basic prototype that allows you to specify templates in
-~/.bundlegem/templates
+    ~/.bundlegem/templates
 

data/lib/bundlegem/cli/gem.rb

@@ -18,6 +18,8 @@ module Bundlegem
 
     def run
       # Bundler.ui.confirm "Creating gem '#{name}'..."
+      
+      raise_project_with_that_name_already_exists! if File.exists?(target)
 
       underscored_name = name.tr('-', '_')
       namespaced_path = name.tr('-', '/')
@@ -107,11 +109,15 @@ module Bundlegem
       end
       
       template_src = match_template_src
+      template_directories = dynamically_generate_template_directories
       templates = dynamically_generate_templates || templates
       
+      create_template_directories(template_directories, target)
+      
       templates.each do |src, dst|
         template("#{template_src}/#{src}", target.join(dst), config)
       end
+      
 
       # Bundler.ui.info "Initializing git repo in #{target}"
       Dir.chdir(target) { `git init`; `git add .` }
@@ -123,31 +129,51 @@ module Bundlegem
     end
 
     private
+    
+    def dynamically_generate_template_directories
+      return nil if options["template"].nil?
+
+      template_src = get_template_src
+      
+      template_dirs = {}
+      Dir.glob("#{template_src}/**").each do |f|
+        next unless File.directory? f
+        base_path = f[template_src.length+1..-1]
+        template_dirs.merge!(base_path => base_path.gsub('#{name}', "#{name}") )
+      end
+      template_dirs
+    end
 
     def dynamically_generate_templates 
       return nil if options["template"].nil?
 
       template_src = get_template_src
-
+      
       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}") )
       end
+      
+      raise_no_files_in_template_error! if templates.empty?
 
       templates
     end
+    
+    def create_template_directories(template_directories, target)
+      template_directories.each do |k,v|
+        FileUtils.mkdir_p("#{target}/#{v}")
+      end
+    end
 
     def match_template_src
       template_src = get_template_src
       
-      return template_src if template_exists_within_repo?(template_src) or File.exists?(template_src)   # 'newgem' refers to the built in template that comes with the gem
-      
-      # else message the user that the template could not be found
-      err_missing_template = "Could not find template folder #{options["template"]} in `~/.bundle/gem_templates/`. Please check to make sure your desired template exists."
-      puts err_missing_template
-      Bundler.ui.error err_missing_template
-      exit 1
+      if template_exists_within_repo?(template_src) or File.exists?(template_src)
+        return template_src    # 'newgem' refers to the built in template that comes with the gem
+      else
+        raise_templet_not_found! # else message the user that the template could not be found
+      end
     end
 
     def get_template_src
@@ -156,7 +182,7 @@ module Bundlegem
       if template_exists_within_repo?(template_name)  # if template_exists_within_repo?(template_name)
         gem_template_location = get_internal_template_location
       else
-        gem_template_location = File.expand_path("~/.bundle/gem_templates")
+        gem_template_location = File.expand_path("~/.bundlegem/gem_templates")
       end
       template_src = "#{gem_template_location}/#{template_name}"
     end
@@ -289,6 +315,31 @@ module Bundlegem
       FileUtils.mkdir_p(File.dirname(destination))
       File.open(destination, "wb") { |f| f.write block.call }
     end
+    
+    
+    
+    def raise_no_files_in_template_error!
+      puts "Ooops, the template was found for '#{options['template']}' in ~/.bundlegem/gem_templates, "
+      puts "but no files within it ended in .tt.  Did you forget to rename the extensions of your files?"
+      puts
+      puts "Exiting..."
+      exit
+    end
+    
+    def raise_project_with_that_name_already_exists!
+      puts "Ooops, a project with the name #{target} already exists."
+      puts "Can't make project.  Either delete that folder or choose a new project name"
+      puts
+      puts "Exiting..."
+      exit
+    end
+    
+    def raise_templet_not_found!
+      err_missing_template = "Could not find template folder '#{options["template"]}' in `~/.bundle/gem_templates/`. Please check to make sure your desired template exists."
+      puts err_missing_template
+      Bundler.ui.error err_missing_template
+      exit 1
+    end
 
   end
 end

data/lib/bundlegem/configurator.rb

@@ -0,0 +1,62 @@
+require 'fileutils'
+
+module Bundlegem
+  
+  class Configurator
+    attr_accessor :user_defined_templates, :user_downloaded_templates
+    
+    def initialize
+      @config_directory_root = "#{ENV['HOME']}/.bundlegem"
+      @config_file = "#{@config_directory_root}/config"
+      @user_defined_templates_path = "#{@config_directory_root}/gem_templates"
+      
+      create_config_file_if_needed!
+      
+      @user_defined_templates = get_user_defined_templates
+      
+      @user_downloaded_templates = get_user_downloaded_templates
+      
+      # load configurations from config file if needed...
+      # perhaps it would contain a list of remote templates specified by the user
+    end
+    
+    # not implemented yet
+    def get_user_downloaded_templates
+      []
+    end
+
+    def get_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 == '..') 
+      end
+      binding.pry
+      
+      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:\s*([\w\s]*$)/ =~ f
+          
+          category = $1.chomp
+        rescue
+          category = "MISC"
+        end
+        
+        category = "MISC" if category.nil?
+        
+        pairs << {category => dir }
+      end
+      pairs
+    end
+    
+    def create_config_file_if_needed!
+      FileUtils.mkdir_p @user_defined_templates_path
+      FileUtils.touch @config_file
+    end
+    
+  end
+end

data/lib/bundlegem/version.rb

@@ -1,3 +1,3 @@
 module Bundlegem
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/bundlegem.rb

@@ -1,12 +1,66 @@
 require "bundlegem/version"
-
-
-
+require 'bundlegem/configurator'
 
 module Bundlegem
-  # Your code goes here...
   
   class << self
+    
+    # lists available templates
+    def list
+      configurator = Configurator.new
+      # search through builtin
+      available_templates = [ { "predefined" => "newgem" }, 
+                              { "predefined" => "service" }]
+      
+      # search through user downloaded
+      available_templates += configurator.user_downloaded_templates
+      
+      # search through user defined
+      available_templates += configurator.user_defined_templates
+
+      available_templates = group_hashes_by_key(available_templates)
+      output_string = convert_grouped_hashes_to_output(available_templates)
+      
+      output_string
+    end
+    
+    # input:  [ { "predefined" => "default" }, 
+    #           { "MISC" => "my_thing" },
+    #           { "prdefined" => "service" }
+    #         ]
+    #
+    # output: [ { "predefined" => ["default", "service"] }, 
+    #           { "MISC" => ["my_thing"] }
+    #         ]     
+    #
+    def group_hashes_by_key(available_templates)
+      h = {}
+      available_templates.each do |hash|
+        k = hash.first.first
+        v = hash.first.last
+        h[k] = [] unless h.has_key?(k)
+        h[k] << v
+      end
+      h
+    end
+    
+    # input:  [ { "predefined" => ["default", "service"] }, 
+    #           { "MISC" => ["my_thing"] }
+    #         ]  
+    def convert_grouped_hashes_to_output(available_templates)
+      s = ""
+      available_templates.each do |hash|
+        k = hash.first.upcase
+        a = hash.last
+        s << " #{k}:\n"
+        a.each do |el|
+          s << "   #{el}\n"
+        end
+        s << "\n"
+      end
+      s
+    end
+    
     def which(executable)
       if File.file?(executable) && File.executable?(executable)
         executable

data/spec/bundlegem_spec.rb

@@ -1,13 +1,34 @@
 require 'spec_helper'
 
 describe Bundlegem do
+  
+  before :each do
+    clear_templates
+  end
+  
   it 'has a version number' do
     expect(Bundlegem::VERSION).not_to be nil
   end
 
   it 'does something useful' do
     require 'bundlegem/cli'
-    binding.pry
+  end
 
+  it 'creates a config file if needed and lists properly' do
+    create_user_defined_template
+    
+    list_output = Bundlegem.list
+    
+    expect(list_output).to eq " PREDEFINED:\n   newgem\n   service\n\n MISC:\n   empty_template\n\n"
+    expect(File.exists?("#{ENV['HOME']}/.bundlegem")).to be true
+  end
+  
+  it "lists with good categories" do
+    create_user_defined_template("ARDUINO")
+    
+    list_output = Bundlegem.list
+    
+    binding.pry
   end
+  
 end

data/spec/spec_helper.rb

@@ -1,4 +1,23 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'bundlegem'
-
+require 'fileutils'
 require 'pry'
+
+# Mock our home directory
+ENV['HOME'] = "/tmp/bundlegem_mock_home"  
+
+
+def create_user_defined_template(category = nil)
+  template_root = "/tmp/bundlegem_mock_home/.bundlegem/gem_templates/empty_template"
+  FileUtils.mkdir_p template_root
+  
+  File.open("#{template_root}/.bundlegem", "w+") do |f|
+    f.puts "category: #{category}" unless category.nil?
+  end
+  
+end
+
+
+def clear_templates
+  FileUtils.rm_rf "/tmp/bundlegem_mock_home/.bundlegem"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bundlegem
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - TheNotary
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2015-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -101,6 +101,7 @@ files:
 - lib/bundlegem.rb
 - lib/bundlegem/cli.rb
 - lib/bundlegem/cli/gem.rb
+- lib/bundlegem/configurator.rb
 - lib/bundlegem/friendly_errors.rb
 - lib/bundlegem/templates/Executable
 - lib/bundlegem/templates/Executable.standalone