technicalpickles-jeweler 0.0.0

data/README.markdown

@@ -0,0 +1,95 @@
+# Create a directory and git repo
+
+    $ mkdir jeweler
+    $ git init
+
+# Create a Rakefile:
+
+    require 'rake'
+    require 'jeweler'
+
+    Jeweler.gemspec = Gem::Specification.new do |s|
+      s.name = "jeweler"
+      s.summary = "Simple and opinionated helper for creating Rubygem projects on GitHub"
+      s.email = "josh@technicalpickles.com"
+      s.homepage = "http://github.com/technicalpickles/jeweler"
+      s.description = "Simple and opinionated helper for creating Rubygem projects on GitHub"
+      s.authors = ["Josh Nichols"]
+      s.files = FileList["[A-Z]*"]
+    end
+    
+Note, we don't include 'date', or 'version'. Jeweler takes care of that.
+
+Jeweler assumes you'll have either a class or module similar to your spec's name. This value gets camelized, so...
+
+Good:
+
+ * safety\_valve -> SafetyValve
+ * clearance -> Clearance
+
+Bad:
+
+ * shoulda-generator -> Shoulda-generator (not valid!)
+ * ruby-debug -> Ruby-debug (not valid!)
+
+We're opinionated and lazy.
+
+# Create a version file
+
+Stick it in `lib/(spec_name_here)/version.rb`, and start it out at some version, like 0.0.0:
+
+    class Jeweler
+      module Version
+        MAJOR = 0
+        MINOR = 0
+        PATCH = 0
+      end
+    end
+
+OR
+
+    module Jeweler
+      module Version
+        MAJOR = 0
+        MINOR = 0
+        PATCH = 0
+      end
+    end
+
+Which you use depends on how you want to organize your gem. If you have a top-level class, like Jeweler, use the first. If you have a top level module, like Clearance, use the latter.
+
+# Generate the first gemspec
+
+    $ rake gemspec
+
+# Commit it
+
+    $ git add .
+    $ git commit -a -m "First commit yo"
+    
+# Make a github repository
+
+Wander to http://github.com/repositories/new and follow the instructions to get it pushed
+
+# Enable Rubygem building on the repository
+
+Go to your project's edit page and check the 'RubyGem' box.
+
+# Go do something awesome
+
+I'll let you figure that out
+
+# Bump the version
+
+You have a few rake tasks for automating the version bumping:
+
+    $ rake version:bump:patch
+    $ rake version:bump:minor
+    $ rake version:bump:major
+    
+This will automatically regenerate your gemspec.
+
+Just commit and push it afterwards:
+
+    $ git commit -a -m "Version bump yo"
+    $ git push origin master

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rake'
+require 'rake/testtask'
+
+$:.unshift('lib')
+require 'jeweler'
+
+Jeweler.gemspec = Gem::Specification.new do |s|
+  s.name = "jeweler"
+  s.summary = "Simple and opinionated helper for creating Rubygem projects on GitHub"
+  s.email = "josh@technicalpickles.com"
+  s.homepage = "http://github.com/technicalpickles/jeweler"
+  s.description = "Simple and opinionated helper for creating Rubygem projects on GitHub"
+  s.authors = ["Josh Nichols"]
+  s.files = FileList["[A-Z]*", "{generators,lib,test}/**/*"]
+end

data/lib/jeweler/tasks.rb

@@ -0,0 +1,34 @@
+desc "Generate a gemspec file for GitHub"
+task :gemspec do
+  Jeweler.write_gemspec
+end
+
+desc "Displays the current version"
+task :version do
+  puts Jeweler.version
+end
+
+namespace :version do
+  namespace :bump do
+    desc "Bump the gemspec a major version."
+    task :major do
+      major = Jeweler.major_version + 1
+      Jeweler.bump_version(major, 0, 0)
+      Jeweler.write_gemspec
+    end
+    
+    desc "Bump the gemspec a minor version."
+    task :minor do
+      minor = Jeweler.minor_version + 1
+      Jeweler.bump_version(Jeweler.major_version, minor, 0)
+      Jeweler.write_gemspec
+    end
+    
+    desc "Bump the gemspec a patch version."
+    task :patch do
+      patch = Jeweler.patch_version + 1
+      Jeweler.bump_version(Jeweler.major_version, Jeweler.minor_version, patch)
+      Jeweler.write_gemspec
+    end
+  end
+end

data/lib/jeweler/version.rb

@@ -0,0 +1,7 @@
+class Jeweler
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 0
+  end
+end

data/lib/jeweler.rb

@@ -0,0 +1,114 @@
+require 'date'
+
+class Jeweler
+  def self.gemspec=(gemspec)
+    @@gemspec = gemspec
+    require version_module_path
+    @@gemspec.version = version
+  end
+  
+  def self.major_version
+    version_module.const_get(:MAJOR)
+  end
+  
+  def self.minor_version
+    version_module.const_get(:MINOR)
+  end
+  
+  def self.patch_version
+    version_module.const_get(:PATCH)
+  end
+  
+  def self.version
+    "#{major_version}.#{minor_version}.#{patch_version}"
+  end
+  
+  def self.date
+    date = DateTime.now
+    "#{date.year}-#{date.month}-#{date.day}"
+  end
+    
+  def self.bump_version(major, minor, patch)
+    main_module_or_class = constantize(main_module_name)
+    keyword = case main_module_or_class.class
+    when Class
+      'class'
+    when Module
+      'module'
+    else
+      raise "Uh, main_module_name should be a class or module, but was a #{main_module_or_class.class}"
+    end
+    
+    File.open(version_module_path, 'w') do |file|
+      file.write <<-END
+#{keyword} #{main_module_name}
+  module Version
+    MAJOR = #{major}
+    MINOR = #{minor}
+    PATCH = #{patch}
+  end
+end
+      END
+    end
+    @@gemspec.version = "#{major}.#{minor}.#{patch}"
+  end
+  
+  def self.write_gemspec
+    @@gemspec.date = self.date
+    File.open(gemspec_path, 'w') do |f|
+      f.write @@gemspec.to_ruby
+    end
+  end
+  
+  private
+  
+  def self.gemspec_path
+    "#{@@gemspec.name}.gemspec"
+  end
+  
+  def self.version_module_path
+    "lib/#{@@gemspec.name}/version.rb"
+  end
+  
+  def self.version_module
+    constantize("#{main_module_name}::Version")
+  end
+  
+  def self.main_module_name
+    camelize(@@gemspec.name)
+  end
+  
+  if Module.method(:const_get).arity == 1
+    def self.constantize(camel_cased_word)
+      names = camel_cased_word.split('::')
+      names.shift if names.empty? || names.first.empty?
+
+      constant = Object
+      names.each do |name|
+        constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+      end
+      constant
+    end
+  else
+    def self.constantize(camel_cased_word) #:nodoc:
+      names = camel_cased_word.split('::')
+      names.shift if names.empty? || names.first.empty?
+
+      constant = Object
+      names.each do |name|
+        constant = constant.const_get(name, false) || constant.const_missing(name)
+      end
+      constant
+    end
+  end
+  
+  def self.camelize(lower_case_and_underscored_word, first_letter_in_uppercase = true)
+    if first_letter_in_uppercase
+      lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+    else
+      lower_case_and_underscored_word.first.downcase + camelize(lower_case_and_underscored_word)[1..-1]
+    end
+  end
+end
+
+require 'jeweler/tasks'

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: technicalpickles-jeweler
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Josh Nichols
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-11 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Simple and opinionated helper for creating Rubygem projects on GitHub
+email: josh@technicalpickles.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- README.markdown
+- lib/jeweler
+- lib/jeweler/tasks.rb
+- lib/jeweler/version.rb
+- lib/jeweler.rb
+has_rdoc: false
+homepage: http://github.com/technicalpickles/jeweler
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Simple and opinionated helper for creating Rubygem projects on GitHub
+test_files: []
+