bundlegem 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c08c0682db8e699b13f7f117349b7c7da714ede
-  data.tar.gz: 5c15178fe7fb6594e6fead96bedc15c63b6f978e
+  metadata.gz: 045563549ab767462d8d41dad72cc7c1b9c36134
+  data.tar.gz: 2a392ed207841bf8bd6d9e886269c1e8cb7c4d96
 SHA512:
-  metadata.gz: 5dcd12a40000b95ade8a289fbcceb95e1798f2709cb5fa25510d0e1a26d439ea4df72a04857b7fc9f5a5c857c14f7b9abeaeee80f05c7c198eeb6cd5fc204bc9
-  data.tar.gz: 02a40f796bac379663fb5580c995acb5f9709011c38fff1e94ecc715165fd70ee61159f7279f911d40e3b21f370ac6cfce548daf108b6e77e68610fbc376fd60
+  metadata.gz: 5fcea6513756acc90fddb3fbfd55e0a57783eda99ef981c58dc796e5328e53f83134ca9176435a3e7a5674fed5a55543a3f8580bac0abd90a63f13580da95323
+  data.tar.gz: 8774029ff42caa8f7a4b1e7c34a3eff21f1134ddac23639c0d6edee7ef980efe7c4c51f807813d30d71c470d7966a355511b1ec487274ae9507332d5db35e790

data/Rakefile

@@ -1,8 +1,40 @@
+require 'rake'
+
 require 'bundler'
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+desc "Run unit specs"
+RSpec::Core::RakeTask.new(:unit) do |t|
+  t.rspec_opts = %w(-fd -c)
+  t.pattern = "./spec/unit/**/*_spec.rb"
+end
+
+desc "Run integration specs that are very high level"
+RSpec::Core::RakeTask.new(:integration) do |t|
+  t.rspec_opts = %w(-fd -c)
+  t.pattern = "./spec/integration/**/*_spec.rb"
+end
 
-RSpec::Core::RakeTask.new(:spec)
+desc "Run all specs"
+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
+RSpec::Core::RakeTask.new(:current) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--tag current']
+end
+
+# alias for current
+RSpec::Core::RakeTask.new(:c) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--tag current']
+end
 
 task :default => :spec
+task :test => :spec
+
 

data/bin/bundlegem

@@ -35,6 +35,7 @@ end
 if ARGV[0] == "--newtemplate"
   puts "Sorry, I haven't been implemented, I don't have a lot of free time atm :("
   exit 0
+  Bundlegem.newtemplate(ARGV)
 end
 
 

data/changelog

@@ -1,19 +1,43 @@
 ** 0.0.x **
-	- Default templates: 
-		* CLI file system app, 
-		* CLI with web client
-	- Restore the original UI that was in bundler
-	- Ability to load templates from github
-	  - Track a list of additional web templates in this repo
-	  - Allow for it to be listed
-	  - Hint the user to cd into ~/.bundlegem/gem_templates and clone any they choose
-	- CMD:  --newtemplate to start new template
-	- 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?  ...add prompt
-  - Cleaning:  Make create_gem build a string instead of puts so
-	  output can be squelched for testing
+    - 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
+    - Feature:  Gem's display names are based on what's specified in their
+    respective root .bundlegem
+    - newgem template: fix Rake file and test organization
+    - Default templates: 
+        * CLI file system app, 
+        * CLI with web client
+    - Restore the original UI that was in bundler
+    - Feature:  Ability to load templates from github
+    - Track a list of additional web templates in this repo
+      - Allow for it to be listed
+      - Hint the user to cd into ~/.bundlegem/gem_templates and clone any they choose
+  
+    
+    - Behavior: gems in the ~/.bundlegem/gem_templates folder take precidence over
+      built in gems?  ...add prompt
+    - Cleaning:  Make create_gem build a string instead of puts so
+      output can be squelched for testing
+    - CMD:  --templateize-current-directory to make the current directory into a
+      new template
+    - CORE:  refactor the built-in gems so they look pretty (templates/newgem/lib/#{name}.rb.tt)
+            * Need to implement partials that are stored inside the gem
+
+    - CMD:  --newtemplate to start new template
+    - CMD:  --default to set a gem_template as the default one (list should indicate this)
+	- list doesn't display these becasue lib/bundlegem.rb:15
+    - Built-in Template:  cli_gem
+    - Built-in Template:  c_ext_gem
+
+
+** 0.0.6 **
+    - Feature:  List now indicates default template
+    - CORE:  Created TemplateManager for working with templates
+    - BUG:  Accidentally tracked in a test gem project and fixed tests to not
+      change directory into a test area for creating new gems.
+    - BUG:  newgem template didn't have a dot in .gitignore.tt
+    
 
 
 ** 0.0.5 **
@@ -22,7 +46,7 @@
   - Bug where sub directories were not being explicitly created
   - 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
@@ -30,16 +54,16 @@
 
 
 ** 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
+    - 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
+    - Added default gem template 'service'
+    - Better syntax of bundlegem gem_name -t template_name
+    - CMD:  --help to display a help message
 
 
 ** 0.0.1 **

data/config/config

@@ -0,0 +1,4 @@
+# Comments made to this file will not be preserved
+---
+default_template: newgem
+

data/lib/bundlegem/cli/gem.rb

@@ -16,8 +16,6 @@ module Bundlegem
     end
 
     def run
-      # Bundler.ui.confirm "Creating gem '#{name}'..."
-      
       raise_project_with_that_name_already_exists! if File.exists?(target)
 
       underscored_name = name.tr('-', '_')
@@ -45,75 +43,12 @@ module Bundlegem
         :bundler_version  => bundler_dependency_version
       }
       ensure_safe_gem_name(name, constant_array)
-
-      # Hmmm... generate dynamically instead?  Yes, overwritten below
-      templates = {
-        'Gemfile.tt' => "Gemfile",
-        'changelog.tt' => "changelog",
-        'gitignore.tt' => ".gitignore",
-        'lib/#{name}.rb.tt' => "lib/#{namespaced_path}.rb",
-        'lib/#{name}/version.rb.tt' => "lib/#{namespaced_path}/version.rb",
-        '#{name}.gemspec.tt' => "#{name}.gemspec",
-        'Rakefile.tt' => "Rakefile",
-        'README.md.tt' => "README.md",
-        'bin/console.tt' => "bin/console"
-      }
-
-
-      if ask_and_set(:coc, "Do you want to include a code of conduct in gems you generate?",
-          "Codes of conduct can increase contributions to your project by contributors who " \
-          "prefer collaborative, safe spaces. You can read more about the code of conduct at " \
-          "contributor-covenant.org. Having a code of conduct means agreeing to the responsibility " \
-          "of enforcing it, so be sure that you are prepared to do that. For suggestions about " \
-          "how to enforce codes of conduct, see bit.ly/coc-enforcement."
-        )
-        templates.merge!("CODE_OF_CONDUCT.md.tt" => "CODE_OF_CONDUCT.md")
-      end
-      
-
-      if ask_and_set(:mit, "Do you want to license your code permissively under the MIT license?",
-          "This means that any other developer or company will be legally allowed to use your code " \
-          "for free as long as they admit you created it. You can read more about the MIT license " \
-          "at choosealicense.com/licenses/mit."
-        )
-        config[:mit] = true
-        templates.merge!("LICENSE.txt.tt" => "LICENSE.txt")
-      end
-
-      if test_framework = ask_and_set_test_framework
-        templates.merge!(".travis.yml.tt" => ".travis.yml")
-
-        case test_framework
-        when 'rspec'
-          templates.merge!(
-            "rspec.tt" => ".rspec",
-            "spec/spec_helper.rb.tt" => "spec/spec_helper.rb",
-            'spec/#{name}_spec.rb.tt' => "spec/#{namespaced_path}_spec.rb"
-          )
-        when 'minitest'
-          templates.merge!(
-            "test/minitest_helper.rb.tt" => "test/minitest_helper.rb",
-            "test/test_newgem.rb.tt" => "test/test_#{namespaced_path}.rb"
-          )
-        end
-      end
-
-      templates.merge!("exe/newgem.tt" => "exe/#{name}") if options[:bin]
-
-      if options[:ext]
-        templates.merge!(
-          "ext/newgem/extconf.rb.tt" => "ext/#{name}/extconf.rb",
-          "ext/newgem/newgem.h.tt" => "ext/#{name}/#{underscored_name}.h",
-          "ext/newgem/newgem.c.tt" => "ext/#{name}/#{underscored_name}.c"
-        )
-      end
-      
-      puts "Creating new project folder\n\n"
       
       template_src = match_template_src
       template_directories = dynamically_generate_template_directories
-      templates = dynamically_generate_templates || templates
+      templates = dynamically_generate_templates(config)
       
+      puts "Creating new project folder '#{name}'\n\n"
       create_template_directories(template_directories, target)
       
       templates.each do |src, dst|
@@ -139,7 +74,7 @@ module Bundlegem
     def dynamically_generate_template_directories
       # return nil if options["template"].nil?
 
-      template_src = get_template_src
+      template_src = TemplateManager.get_template_src(options)
       
       template_dirs = {}
       Dir.glob("#{template_src}/**/*").each do |f|
@@ -150,22 +85,61 @@ module Bundlegem
       template_dirs
     end
 
-    def dynamically_generate_templates 
-      return nil if options["template"].nil?
+    # This function should be eliminated over time so that other methods conform to the
+    # new algo for generating templates automatically.
+    # Really, this function generates a template_src to template_dst naming 
+    # structure so that a later method can copy all the template files from the
+    # source and rename them properly
+    def generate_templates_for_built_in_gems(config)
+      # Hmmm... generate dynamically instead?  Yes, overwritten below
+      templates = {
+        '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",
+        'README.md.tt' => "README.md",
+        'bin/console.tt' => "bin/console"
+      }
 
-      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?
+      prompt_coc!(templates)
+      prompt_mit!(templates, config)
+      prompt_test_framework!(templates, config)
 
+      templates.merge!("exe/newgem.tt" => "exe/#{config[:name]}") if config[:bin]
+
+      if config[:ext]
+        templates.merge!(
+          "ext/newgem/extconf.rb.tt" => "ext/#{config[:name]}/extconf.rb",
+          "ext/newgem/newgem.h.tt" => "ext/#{config[:name]}/#{config[:underscored_name]}.h",
+          "ext/newgem/newgem.c.tt" => "ext/#{config[:name]}/#{config[:underscored_name]}.c"
+        )
+      end
       templates
     end
     
+    # Figures out the translation between all the .tt file to their 
+    # destination names
+    def dynamically_generate_templates(config)
+      #if options["template"].nil? # if it's doing some of the built in template
+      #  return generate_templates_for_built_in_gems(config)
+      #else
+        template_src = TemplateManager.get_template_src(options)
+        
+        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?
+  
+        return templates
+      #end
+    end
+    
     def create_template_directories(template_directories, target)
       template_directories.each do |k,v|
         d = "#{target}/#{v}"
@@ -174,51 +148,23 @@ module Bundlegem
       end
     end
 
+    # returns the full path of the template source
     def match_template_src
-      template_src = get_template_src
+      template_src = TemplateManager.get_template_src(options)
       
-      if template_exists_within_repo?(template_src) or File.exists?(template_src)
+      if File.exists?(template_src)
         return template_src    # 'newgem' refers to the built in template that comes with the gem
       else
         raise_template_not_found! # else message the user that the template could not be found
       end
     end
-
-    def get_template_src
-      template_name = options["template"].nil? ? "newgem" : options["template"]
-      
-      if template_exists_within_repo?(template_name)
-        gem_template_location = get_internal_template_location
-      else
-        gem_template_location = File.expand_path("~/.bundlegem/gem_templates")
-      end
-      template_src = "#{gem_template_location}/#{template_name}"
-    end
     
-    def template_exists_within_repo?(template_name)
-      file_in_source?(template_name)
-    end
     
-    def get_internal_template_location
-      File.expand_path("#{File.dirname(__FILE__)}/../templates")
-    end
-
     def resolve_name(name)
       Pathname.pwd.join(name).basename.to_s
     end
 
-    def ask_and_set(key, header, message)
-      choice = options[key]  # || Bundler.settings["gem.#{key}"]
-
-      if choice.nil?
-        Bundler.ui.confirm header
-        choice = (Bundler.ui.ask("#{message} y/(n):") =~ /y|yes/)
-        Bundler.settings.set_global("gem.#{key}", choice)
-      end
-
-      choice
-    end
-
+    
     def validate_ext_name
       return unless gem_name.index('-')
 
@@ -229,27 +175,7 @@ module Bundlegem
       exit 1
     end
 
-    def ask_and_set_test_framework
-      test_framework = options[:test] || Bundler.settings["gem.test"]
-
-      if test_framework.nil?
-        Bundler.ui.confirm "Do you want to generate tests with your gem?"
-        result = Bundler.ui.ask "Type 'rspec' or 'minitest' to generate those test files now and " \
-          "in the future. rspec/minitest/(none):"
-        if result =~ /rspec|minitest/
-          test_framework = result
-        else
-          test_framework = false
-        end
-      end
-
-      if Bundler.settings["gem.test"].nil?
-        Bundler.settings.set_global("gem.test", test_framework)
-      end
-
-      test_framework
-    end
-
+    
     def bundler_dependency_version
       v = Gem::Version.new(Bundler::VERSION)
       req = v.segments[0..1]
@@ -257,15 +183,7 @@ module Bundlegem
       req.join(".")
     end
 
-    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
-      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
-      end
-    end
+    
     
     
     
@@ -291,7 +209,7 @@ module Bundlegem
       config = args.last.is_a?(Hash) ? args.pop : {}
       destination = args.first || source.sub(/#{TEMPLATE_EXTNAME}$/, "")
 
-      source  = File.expand_path(find_in_source_paths(source.to_s))
+      source  = File.expand_path(TemplateManager.find_in_source_paths(source.to_s))
       context = instance_eval("binding")
       
       make_file(destination, config) do
@@ -302,19 +220,7 @@ module Bundlegem
 
     end
     
-    #
-    # EDIT:  Reworked from Thor to not rely on Thor (or do so much unneeded stuff)
-    #
-    def find_in_source_paths(target)
-      src_in_source_path = "#{File.dirname(__FILE__)}/../templates/#{target}"
-      return src_in_source_path if File.exists?(src_in_source_path)
-      target # failed, hopefully full path to a user specified gem template file
-    end
     
-    def file_in_source?(target)
-      src_in_source_path = "#{File.dirname(__FILE__)}/../templates/#{target}"
-      File.exists?(src_in_source_path)
-    end
     
     #
     # EDIT:  Reworked from Thor to not rely on Thor (or do so much unneeded stuff)
@@ -349,6 +255,102 @@ module Bundlegem
       Bundler.ui.error err_missing_template
       exit 1
     end
+    
+    
+    ############# STUFF THAT SHOULD BE REMOVED DOWN THE ROAD
+    
+    # This asks the user if they want to setup rspec or test...
+    # It's not class based, it's additive based... Plus bundlegem does this already
+    def ask_and_set_test_framework
+      test_framework = options[:test] || Bundler.settings["gem.test"]
+
+      if test_framework.nil?
+        Bundler.ui.confirm "Do you want to generate tests with your gem?"
+        result = Bundler.ui.ask "Type 'rspec' or 'minitest' to generate those test files now and " \
+          "in the future. rspec/minitest/(none):"
+        if result =~ /rspec|minitest/
+          test_framework = result
+        else
+          test_framework = false
+        end
+      end
+
+      if Bundler.settings["gem.test"].nil?
+        Bundler.settings.set_global("gem.test", test_framework)
+      end
+
+      test_framework
+    end
+    
+    def ask_and_set(key, header, message)
+      choice = options[key]  # || Bundler.settings["gem.#{key}"]
+
+      if choice.nil?
+        Bundler.ui.confirm header
+        choice = (Bundler.ui.ask("#{message} y/(n):") =~ /y|yes/)
+        Bundler.settings.set_global("gem.#{key}", choice)
+      end
+
+      choice
+    end
+    
+    def prompt_coc!(templates)
+      if ask_and_set(:coc, "Do you want to include a code of conduct in gems you generate?",
+          "Codes of conduct can increase contributions to your project by contributors who " \
+          "prefer collaborative, safe spaces. You can read more about the code of conduct at " \
+          "contributor-covenant.org. Having a code of conduct means agreeing to the responsibility " \
+          "of enforcing it, so be sure that you are prepared to do that. For suggestions about " \
+          "how to enforce codes of conduct, see bit.ly/coc-enforcement."
+        )
+        templates.merge!("CODE_OF_CONDUCT.md.tt" => "CODE_OF_CONDUCT.md")
+      end
+    end
+    
+    def prompt_mit!(templates, config)
+      if ask_and_set(:mit, "Do you want to license your code permissively under the MIT license?",
+          "This means that any other developer or company will be legally allowed to use your code " \
+          "for free as long as they admit you created it. You can read more about the MIT license " \
+          "at choosealicense.com/licenses/mit."
+        )
+        config[:mit] = true
+        templates.merge!("LICENSE.txt.tt" => "LICENSE.txt")
+      end
+    end
+    
+    def prompt_test_framework!(templates, config)
+      namespaced_path = config[:namespaced_path]
+      if test_framework = ask_and_set_test_framework
+        templates.merge!(".travis.yml.tt" => ".travis.yml")
+
+        case test_framework
+        when 'rspec'
+          templates.merge!(
+            "rspec.tt" => ".rspec",
+            "spec/spec_helper.rb.tt" => "spec/spec_helper.rb",
+            'spec/#{name}_spec.rb.tt' => "spec/#{namespaced_path}_spec.rb"
+          )
+        when 'minitest'
+          templates.merge!(
+            "test/minitest_helper.rb.tt" => "test/minitest_helper.rb",
+            "test/test_newgem.rb.tt" => "test/test_#{namespaced_path}.rb"
+          )
+        end
+      end
+    end
+    
+    # This checks to see that the gem_name is a valid ruby gem name and will 'work'
+    # and won't overlap with a bundlegem constant apparently...
+    #
+    # TODO:  This should be defined within the template itself in some way possibly, may have security implications
+    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
+      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
+      end
+    end
 
   end
 end

data/lib/bundlegem/configurator.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'yaml'
 
 module Bundlegem
   
@@ -13,11 +14,23 @@ 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 if needed...
-      # perhaps it would contain a list of remote templates specified by the user
+      # load configurations from config file
+      @c = YAML.load_file @config_file
+    end
+    
+    def default_template
+      @c["default_template"]
+    end
+    
+    def default_template=(val)
+      @c["default_template"] = val
+      File.write(@config_file, "# Comments made to this file will not be preserved\n#{YAML.dump(@c)}")
+    end
+    
+    def built_in_templates
+      
     end
     
     # not implemented yet
@@ -54,7 +67,11 @@ module Bundlegem
     
     def create_config_file_if_needed!
       FileUtils.mkdir_p @user_defined_templates_path
-      FileUtils.touch @config_file
+      FileUtils.cp("#{SOcreate_new_templateURCE_ROOT}/config/config", @config_file) unless File.exists? @config_file
+    end
+    
+    def create_new_template(template_name)
+      puts "i'm still a stub"
     end
     
   end

data/lib/bundlegem/template_manager.rb

@@ -0,0 +1,59 @@
+require 'fileutils'
+
+module Bundlegem
+  
+  # This class handles the logic for finding templates
+  # in the user's dir, the gem's builtin templates 
+  # (and on the web some day)
+  class TemplateManager
+    
+    class << self
+      
+      def create_new_template(template_name)
+        
+      end
+      
+      
+      def get_default_template_name
+        "newgem"
+      end
+      
+      def get_template_src(options)
+        template_name = options["template"].nil? ? get_default_template_name : options["template"]
+        
+        if template_exists_within_repo?(template_name)
+          gem_template_location = get_internal_template_location
+        else
+          gem_template_location = File.expand_path("~/.bundlegem/gem_templates")
+        end
+        template_src = "#{gem_template_location}/#{template_name}"
+      end
+      
+      
+      def get_internal_template_location
+        File.expand_path("#{File.dirname(__FILE__)}/templates")
+      end
+      
+      def template_exists_within_repo?(template_name)
+        TemplateManager.file_in_source?(template_name)
+      end
+      
+      #
+      # EDIT:  Reworked from Thor to not rely on Thor (or do so much unneeded stuff)
+      #
+      def find_in_source_paths(target)
+        src_in_source_path = "#{File.dirname(__FILE__)}/templates/#{target}"
+        return src_in_source_path if File.exists?(src_in_source_path)
+        target # failed, hopefully full path to a user specified gem template file
+      end
+      
+      # Get's path to 'target' from within the gem's "templates" folder 
+      # within the gem's source
+      def file_in_source?(target)
+        src_in_source_path = "#{File.dirname(__FILE__)}/templates/#{target}"
+        File.exists?(src_in_source_path)
+      end
+      
+    end
+  end
+end