technicalpickles-jeweler 0.3.2 → 0.3.3

data/Rakefile

@@ -17,6 +17,7 @@ begin
     s.authors = ["Josh Nichols", "Dan Croak"]
     s.bindir = 'bin'
     s.files =  FileList["[A-Z]*", "{bin,generators,lib,test}/**/*"]
+    s.add_dependency 'schacon-git'
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-patch: 2
+patch: 3
 major: 0
 minor: 3

data/lib/jeweler/generator.rb

@@ -2,13 +2,29 @@ require 'git'
 require 'erb'
 
 class Jeweler
+  class NoGitUserName < StandardError
+  end
+  class NoGitUserEmail < StandardError
+  end
+  
+  class FileInTheWay < StandardError
+  end
+  
+  class NoRemoteGiven < StandardError
+  end
+    
   class Generator
     attr_accessor :target_dir, :user_name, :user_email, :github_repo_name, :github_remote, :github_url, :github_username, :lib_dir
 
     def initialize(github_remote, dir = nil)
-
+      if github_remote.nil?
+        raise NoRemoteGiven
+      end
+      
       self.github_remote = github_remote
+      
       check_user_git_config()
+      
       determine_github_stuff()
 
       self.target_dir = dir || self.github_repo_name
@@ -16,23 +32,22 @@ class Jeweler
     end
 
     def check_user_git_config
-      lib = Git::Lib.new(nil, nil)
-      config = lib.parse_config '~/.gitconfig'
+      config = read_git_config
       unless config.has_key? 'user.name'
-        puts %Q{No user.name set in ~/.gitconfig. Set it with: git config --global user.name 'Your Name Here'}
-        exit 1
+        raise NoGitUserName, %Q{No user.name set in ~/.gitconfig. Set it with: git config --global user.name 'Your Name Here'}
       end
       unless config.has_key? 'user.email'
-        puts %Q{No user.name set in ~/.gitconfig. Set it with: git config --global user.name 'Your Name Here'}
-        exit 1
+        raise NoGitUserEmail, %Q{No user.name set in ~/.gitconfig. Set it with: git config --global user.name 'Your Name Here'}
       end
-      @user_name = config['user.name'].gsub('"', '')
-      @user_email = config['user.email'].gsub('"', '')
+
+      @user_name = config['user.name']
+      @user_email = config['user.email']
     end
 
     def determine_github_stuff
-      self.github_url = self.github_remote.gsub(/^git@github\.com:/, 'http://github.com/').gsub(/\.git$/, '/tree')
+      self.github_url = self.github_remote.gsub(/^git@github\.com:/, 'http://github.com/').gsub(/\.git$/, '')
       self.github_repo_name = self.github_remote.match(/\/(.*)\.git$/)[1]
+      self.github_username = self.github_remote.match(%r{git@github\.com:(.*)/})[1]
     end
 
     def run
@@ -50,9 +65,11 @@ class Jeweler
 
       license = template('LICENSE')
       File.open(File.join(target_dir, 'LICENSE'), 'w') {|file| file.write(license.result(binding))}
+      
+      readme = template('README')
+      File.open(File.join(target_dir, 'README'), 'w') {|file| file.write(readme.result(binding))}
 
       FileUtils.touch File.join(lib_dir, "#{github_repo_name}.rb")
-
     end
 
     def template(file)
@@ -75,5 +92,11 @@ class Jeweler
       end
       Dir.chdir(saved_pwd)
     end
+    
+  protected
+    def read_git_config
+      lib = Git::Lib.new(nil, nil)
+      config = lib.parse_config '~/.gitconfig'
+    end
   end
 end

data/test/jeweler_generator_test.rb

@@ -0,0 +1,185 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class JewelerTest < Test::Unit::TestCase
+  
+  def setup
+    @github_remote = 'git@github.com:technicalpickles/the-perfect-gem.git'
+  end
+  
+  context "given a nil github remote" do
+    setup do
+      @block = lambda { Jeweler::Generator.new(nil) }
+    end
+
+    should "raise an error" do
+      assert_raise Jeweler::NoRemoteGiven do
+        @block.call
+      end
+    end
+  end
+  
+  context "without git user's name set" do
+    setup do
+      Jeweler::Generator.any_instance.stubs(:read_git_config).returns({'user.email' => 'bar@example.com'})
+    end
+    
+    context "instantiating new generator" do
+      setup do
+        @block = lambda { Jeweler::Generator.new('git@github.com:technicalpickles/the-perfect-gem.git')}
+      end
+
+      should "raise no git user name exception" do
+        assert_raise Jeweler::NoGitUserName do
+          @block.call
+        end
+      end
+    end
+  end
+  
+  context "without git user's email set" do
+    setup do
+      Jeweler::Generator.any_instance.stubs(:read_git_config).returns({'user.name' => 'foo'})
+    end
+
+    context "instantiating new generator" do
+      setup do
+        @block = lambda { Jeweler::Generator.new('git@github.com:technicalpickles/the-perfect-gem.git')}
+      end
+
+      should "raise no git user name exception" do
+        assert_raise Jeweler::NoGitUserEmail do
+          @block.call
+        end
+      end
+    end
+  end
+  
+  context "with valid git user configuration" do
+    setup do
+      Jeweler::Generator.any_instance.stubs(:read_git_config).returns({'user.name' => 'foo', 'user.email' => 'bar@example.com'})
+    end
+    
+    context "for a repository 'git@github.com:technicalpickles/the-perfect-gem.git'" do
+      setup do
+        @generator = Jeweler::Generator.new('git@github.com:technicalpickles/the-perfect-gem.git')
+      end
+      
+      should "assign 'foo' to user's name" do
+        assert_equal 'foo', @generator.user_name
+      end
+      
+      should "assign 'bar@example.com to user's email" do
+        assert_equal 'bar@example.com', @generator.user_email
+      end
+
+      should "assign github remote" do
+        assert_equal 'git@github.com:technicalpickles/the-perfect-gem.git', @generator.github_remote
+      end
+      
+      should "determine github username as technicalpickles" do
+        assert_equal 'technicalpickles', @generator.github_username
+      end
+      
+      should "determine github repository name as the-perfect-gem" do
+        assert_equal 'the-perfect-gem', @generator.github_repo_name
+      end
+      
+      should "determine github url as http://github.com/technicalpickles/the-perfect-gem" do
+        assert_equal 'http://github.com/technicalpickles/the-perfect-gem', @generator.github_url
+      end
+      
+      should "determine target directory as the same as the github repository name" do
+        assert_equal @generator.github_repo_name, @generator.target_dir
+      end
+      
+      should "determine lib directory as being inside the target directory" do
+        assert_equal File.join(@generator.target_dir, 'lib'), @generator.lib_dir
+      end
+    end
+    
+    
+    context "and cleaned out tmp directory" do
+      setup do
+        @tmp_dir = File.join(File.dirname(__FILE__), 'tmp')
+        FileUtils.rm_rf(@tmp_dir)
+        
+        assert ! File.exists?(@tmp_dir)
+      end
+
+      teardown do
+        FileUtils.rm_rf(@tmp_dir)
+      end
+      
+      context "for a repository 'git@github.com:technicalpickles/the-perfect-gem.git' and working directory 'tmp'" do
+        setup do
+          @generator = Jeweler::Generator.new('git@github.com:technicalpickles/the-perfect-gem.git', @tmp_dir)
+        end
+
+        should "use tmp for target directory" do
+          assert_equal @tmp_dir, @generator.target_dir
+        end
+        
+        context "running" do
+          setup do
+            @generator.run
+          end
+
+          should 'create target directory' do
+            assert File.exists?(@tmp_dir)
+          end
+          
+          should "create lib directory" do
+            assert File.exists?(File.join(@tmp_dir, 'lib'))
+            assert File.directory?(File.join(@tmp_dir, 'lib'))
+          end
+          
+          should "create LICENSE" do
+            assert File.exists?(File.join(@tmp_dir, 'LICENSE'))
+            assert File.file?(File.join(@tmp_dir, 'LICENSE'))
+          end
+          
+          should "create README" do
+            assert File.exists?(File.join(@tmp_dir, 'README'))
+            assert File.file?(File.join(@tmp_dir, 'README'))
+          end
+          
+          should "create lib/the-perfect-gem.rb" do
+            assert File.exists?(File.join(@tmp_dir, 'lib', 'the-perfect-gem.rb'))
+            assert File.file?(File.join(@tmp_dir, 'lib', 'the-perfect-gem.rb'))
+          end
+          
+          context "LICENSE" do
+            setup do
+              @content = File.read((File.join(@tmp_dir, 'LICENSE')))
+            end
+
+            should "include copyright for this year with user's name" do
+              assert_match 'Copyright (c) 2008 foo', @content
+            end
+          end
+          
+          context "Rakefile" do
+            setup do
+              @content = File.read((File.join(@tmp_dir, 'Rakefile')))
+            end
+            
+            should "include repo's name as the gem's name" do
+              assert_match 's.name = "the-perfect-gem"', @content
+            end
+            
+            should "include the user's email as the gem's email" do
+              assert_match 's.email = "bar@example.com"', @content
+            end
+            
+            should "include the github repo's url as the gem's url" do
+              assert_match 's.homepage = "http://github.com/technicalpickles/the-perfect-gem"', @content
+            end
+          end
+          
+        end
+          
+      end
+    end
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: technicalpickles-jeweler
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors: 
 - Josh Nichols
@@ -10,10 +10,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-24 00:00:00 -07:00
+date: 2008-10-25 00:00:00 -07:00
 default_executable: jeweler
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: schacon-git
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: Simple and opinionated helper for creating Rubygem projects on GitHub
 email: josh@technicalpickles.com
 executables: 
@@ -44,6 +52,7 @@ files:
 - test/fixtures
 - test/fixtures/bar
 - test/fixtures/bar/VERSION.yml
+- test/jeweler_generator_test.rb
 - test/jeweler_test.rb
 - test/test_helper.rb
 has_rdoc: false