gem_init 0.0.1

data/Gemfile.default

@@ -0,0 +1,3 @@
+source :rubygems
+
+gem "gem_init", :path => File.expand_path("..", __FILE__)

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Norman Clarke
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# Gem Init
+
+This is the code I use to set up a new Ruby Gem.
+
+Github and Rubygems.org make it ridiculously easy to share your code using Gems.
+Sometimes I have something small and useful I'd like to make a gem, but I'm too
+lazy to set up all the packaging boilerplate, and I prefer not to introduce
+tools like Jewler or Hoe just to manage a gemspec, which is a trivially easy
+file to maintain. Setting up a new gem is boring, so I spent a couple hours
+putting this together as a reusable gem. If you like it, please feel free to use
+it for whatever purpose you choose. Bug fixes, and patches are of course
+welcome.
+
+## Using it:
+
+    gem install gem_init
+    gem_init hello_world
+
+A brief summary of some of the quirkiness is below:
+
+## Your name, email and Github user name
+
+These are read from your `~/.gitconfig` if available and used to populate some
+basic info in the gemspec.
+
+## MIT-LICENSE
+
+This is the license I almost always use for my open source work, so it's the
+default.
+
+## Gemfile.default
+
+I prefer not to check my Gemfiles into git, because I usually tweak it a lot
+when testing against lots of different versions of my dependencies. So I usually
+just add a Gemfile.default with something that should work, and copy that to
+Gemfile before working.
+
+The only thing added by default to the Gemfile is your generated library itself,
+which is an easy way to avoid messing around with the `LOAD_PATH` in your test
+setup.
+
+I am assuming Bundler version 1.0.x, which you can currently get by doing
+
+    gem install bundler --pre
+
+But by the time you're reading this, it may already be the current stable
+release.
+
+## test_helper.rb
+
+This just adds a `test` method to the `Module` class, so you can write
+declarative tests:
+
+    test "something should do something" do
+      assert_equal foo, bar
+    end
+
+Having this as a class method in `Module` means you can write your unit tests in
+either modules or classes. Being able to group related tests in modules and give
+them declarative names for me is "good enough" to make up for Test::Unit's
+ugliness, and I like the fact that it's just plain old Ruby.
+
+I tend to do this rather than use a bigger test framework, because it introduces
+less dependencies and makes it very easy for people to just check out my gem and
+run my tests with the minimum of effort.
+
+## *.gemspec
+
+Rather than manually specifying everything, I just pull the files I want to add
+to the gem out of the list of files added to Git. This works fine most of the
+time, with the only caveat being that you need to have your stuff in Git before
+building your gem, or using the directory as a gem via Bundler.
+
+## Rakefile
+
+This adds a soft dependency on [Yard](http://yardoc.org/); the task is added only if you
+have it installed.
+
+Otherwise, by default a `gem` method is added to package your gem, and a `clean`
+method is there to tidy up your repository.
+
+## .gitignore
+
+By default, I ignore Gemfile, Gemfile.lock, pkg and doc directories. Obviously
+you can and should change this to whatever makes sense for you.
+
+## README.md
+
+I like to use Markdown for my README files, as it plays nicely with Yard.

data/Rakefile

@@ -0,0 +1,29 @@
+require "rake"
+require "rake/testtask"
+require "rake/gempackagetask"
+require "rake/clean"
+
+task :default => :test
+
+CLEAN << "pkg" << "doc" << "coverage" << ".yardoc"
+Rake::GemPackageTask.new(eval(File.read("gem_init.gemspec"))) { |pkg| }
+Rake::TestTask.new(:test) { |t| t.pattern = "test/**/*_test.rb" }
+
+begin
+  require "yard"
+  YARD::Rake::YardocTask.new do |t|
+    t.options = ["--output-dir=doc"]
+  end
+rescue LoadError
+end
+
+begin
+  require "rcov/rcovtask"
+  Rcov::RcovTask.new do |r|
+    r.test_files = FileList["test/**/*_test.rb"]
+    r.verbose = true
+    r.rcov_opts << "--exclude gems/*"
+  end
+rescue LoadError
+end
+

data/bin/gem_init

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "rubygems"
+require "gem_init"
+GemInit::App.new(ARGV[0]).main

data/gem_init.gemspec

@@ -0,0 +1,17 @@
+require File.expand_path("../lib/gem_init/version", __FILE__)
+
+spec = Gem::Specification.new do |s|
+  s.name              = "gem_init"
+  s.rubyforge_project = "[none]"
+  s.version           = GemInit::Version::STRING
+  s.authors           = "Norman Clarke"
+  s.email             = "norman@njclarke.com"
+  s.homepage          = "http://github.com/norman/gem_init"
+  s.summary           = "My new gem boilerplate."
+  s.description       = "This is the code I use to set up a new Ruby Gem."
+  s.platform          = Gem::Platform::RUBY
+  s.has_rdoc          = true
+  s.test_files        = Dir.glob "test/**/*_test.rb"
+  s.files             = `git ls-files`.split("\n").reject {|f| f =~ /^\./}
+  s.executables       = ["gem_init"]
+end

data/lib/gem_init.rb

@@ -0,0 +1,2 @@
+require "gem_init/app"
+require "gem_init/version"

data/lib/gem_init/app.rb

@@ -0,0 +1,116 @@
+require "fileutils"
+require "shellwords"
+require "erb"
+
+module GemInit
+  class App
+    include FileUtils
+
+    attr :gem_name
+    attr :module_name
+    attr :templates
+
+    DEFAULT_GIT_CONFIG = {
+      :user => {
+        :name  => "YOUR NAME",
+        :email => "YOUR EMAIL",
+      },
+      :github => {
+        :name => "your_github_user_name"
+      }
+    }
+
+    def initialize(gem_name)
+      @gem_name  = gem_name.downcase
+      @templates = File.expand_path("../templates",  __FILE__)
+    end
+
+    def main
+      if File.exists?(gem_name)
+        raise "Directory '#{gem_name}' already exists, bailing out."
+      end
+      mkdir_p module_lib_dir
+      mkdir_p test_dir
+      write_template(lib_dir, "module.rb", "#{gem_name}.rb")
+      write_template(module_lib_dir, "version.rb")
+      write_template(test_dir, "test_helper.rb")
+      write_template(test_dir, "module_test.rb", "#{gem_name}_test.rb")
+      write_template(gem_name, "gemspec", "#{gem_name}.gemspec")
+      write_template(gem_name, "Gemfile.default")
+      write_template(gem_name, "Gemfile.default", "Gemfile")
+      write_template(gem_name, "Rakefile")
+      write_template(gem_name, "MIT-LICENSE")
+      write_template(gem_name, "README.md")
+      write_template(gem_name, "gitignore", ".gitignore")
+      `git init #{gem_name.shellescape}`
+    end
+
+    def author
+      @author ||= git_config[:user][:name]
+    end
+
+    def email
+      @email ||= git_config[:user][:email]
+    end
+
+    def github_user
+      @github_user ||= git_config[:github][:user]
+    end
+
+    private
+
+    def git_config
+      @git_config ||= read_git_config || DEFAULT_GIT_CONFIG
+    end
+
+    def read_git_config
+      begin
+        config = {}
+        key = nil
+        File.read(File.expand_path("~/.gitconfig")).split("\n").each do |line|
+          if line =~ /\A\s?+\[([\w]*)\]\s?+\z/
+            key = $1.strip.to_sym
+            config[key] = {}
+          elsif line =~ /\A\s?+(.*)\s?+=\s?+(.*)\s?+\Z/
+            config[key][$1.strip.to_sym] = $2
+          end
+        end
+        # Be a tad paranoid and make it harder to accidentally reveal this
+        config[:github][:token] = nil
+        config
+      rescue Errno::ENOENT
+        warn "Could not read your ~/.gitconfig, using silly defaults."
+      end
+    end
+
+    def module_name
+      @module_name ||= gem_name.gsub(/\b[\w]|_[\w]/) {|s| s.upcase}.gsub("_", "")
+    end
+
+    def lib_dir
+      @lib_dir = File.join(gem_name, "lib")
+    end
+
+    def module_lib_dir
+      @module_lib_dir = File.join(lib_dir, gem_name)
+    end
+
+    def test_dir
+      @test_dir = File.join(gem_name, "test")
+    end
+
+    def write_template(dir, template_name, output_name = nil)
+      output_name ||= template_name
+      File.open(File.join(dir, output_name), "w") do |file|
+        file.write(read_template(template_name))
+      end
+    end
+
+    def read_template(file_name)
+      file = File.join(templates, "#{file_name}.erb")
+      File.open(file, "r") do |f|
+        ERB.new(f.read).result(binding)
+      end
+    end
+  end
+end

data/lib/gem_init/templates/Gemfile.default.erb

@@ -0,0 +1,3 @@
+source :rubygems
+
+gem "<%= gem_name %>", :path => File.expand_path("..", __FILE__)

data/lib/gem_init/templates/MIT-LICENSE.erb

@@ -0,0 +1,18 @@
+Copyright (c) <%= Time.now.year %> <%= author %>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/gem_init/templates/README.md.erb

@@ -0,0 +1,30 @@
+# <%= module_name %>
+
+## Installation
+
+    gem install <%= gem_name %>
+
+## Author
+
+    <%= author %> (<%= email %>)
+
+## License
+
+Copyright (c) <%= Time.now.year %> <%= author %>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/gem_init/templates/Rakefile.erb

@@ -0,0 +1,18 @@
+require "rake"
+require "rake/testtask"
+require "rake/gempackagetask"
+require "rake/clean"
+
+task :default => :test
+
+CLEAN << "pkg" << "doc" << "coverage" << ".yardoc"
+Rake::GemPackageTask.new(eval(File.read("<%= @gem_name %>.gemspec"))) { |pkg| }
+Rake::TestTask.new(:test) { |t| t.pattern = "test/**/*_test.rb" }
+
+begin
+  require "yard"
+  YARD::Rake::YardocTask.new do |t|
+    t.options = ["--output-dir=doc"]
+  end
+rescue LoadError
+end

data/lib/gem_init/templates/gemspec.erb

@@ -0,0 +1,16 @@
+require File.expand_path("../lib/<%= gem_name %>/version", __FILE__)
+
+spec = Gem::Specification.new do |s|
+  s.name              = "<%= gem_name %>"
+  s.rubyforge_project = "[none]"
+  s.version           = <%= @module_name %>::Version::STRING
+  s.authors           = "<%= author %>"
+  s.email             = "<%= email %>"
+  s.homepage          = "http://github.com/<%= github_user %>/<%= gem_name %>"
+  s.summary           = ""
+  s.description       = ""
+  s.platform         = Gem::Platform::RUBY
+  s.has_rdoc         = true
+  s.test_files       = Dir.glob "test/**/*_test.rb"
+  s.files            = `git ls-files`.split("\n").reject {|f| f =~ /^\./}
+end

data/lib/gem_init/templates/gitignore.erb

@@ -0,0 +1,5 @@
+.DS_Store
+Gemfile
+Gemfile.lock
+doc
+pkg

data/lib/gem_init/templates/module.rb.erb

@@ -0,0 +1 @@
+require "<%= gem_name %>/version"

data/lib/gem_init/templates/module_test.rb.erb

@@ -0,0 +1,7 @@
+require File.expand_path("../test_helper", __FILE__)
+
+class <%= module_name %>Test < Test::Unit::TestCase
+  test "should have a version number" do
+    assert_not_nil <%= module_name %>::Version::STRING
+  end
+end

data/lib/gem_init/templates/test_helper.rb.erb

@@ -0,0 +1,11 @@
+require "rubygems"
+require "bundler/setup"
+require "test/unit"
+require "<%= gem_name %>"
+
+# Allow declarative test definitions inside modules.
+class Module
+  def test(name, &block)
+    define_method("test_#{name.gsub(/[^a-z0-9]/i, "_")}".to_sym, &block)
+  end
+end

data/lib/gem_init/templates/version.rb.erb

@@ -0,0 +1,9 @@
+module <%= module_name %>
+  module Version
+    MAJOR  = 0
+    MINOR  = 0
+    TINY   = 1
+    BUILD  = nil
+    STRING = [MAJOR, MINOR, TINY, BUILD].compact.join('.')
+  end
+end

data/lib/gem_init/version.rb

@@ -0,0 +1,9 @@
+module GemInit
+  module Version
+    MAJOR  = 0
+    MINOR  = 0
+    TINY   = 1
+    BUILD  = nil
+    STRING = [MAJOR, MINOR, TINY, BUILD].compact.join('.')
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: gem_init
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Norman Clarke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-16 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: This is the code I use to set up a new Ruby Gem.
+email: norman@njclarke.com
+executables: 
+- gem_init
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile.default
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/gem_init
+- gem_init.gemspec
+- lib/gem_init.rb
+- lib/gem_init/app.rb
+- lib/gem_init/templates/Gemfile.default.erb
+- lib/gem_init/templates/MIT-LICENSE.erb
+- lib/gem_init/templates/README.md.erb
+- lib/gem_init/templates/Rakefile.erb
+- lib/gem_init/templates/gemspec.erb
+- lib/gem_init/templates/gitignore.erb
+- lib/gem_init/templates/module.rb.erb
+- lib/gem_init/templates/module_test.rb.erb
+- lib/gem_init/templates/test_helper.rb.erb
+- lib/gem_init/templates/version.rb.erb
+- lib/gem_init/version.rb
+has_rdoc: true
+homepage: http://github.com/norman/gem_init
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: "[none]"
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: My new gem boilerplate.
+test_files: []
+