simple_gem 0.0.0

data/CHANGELOG.rdoc

@@ -0,0 +1,8 @@
+= Simple Gem
+
+== Version 0.0.0
+* Supports "gem skeleton" command to create a new gem
+* Supports "rake build" to build a new permanent versioned gemfile
+* Supports "rake build_dev" to build a temporary dev version of a gem
+* Supports "rake tag" to tag the current git repo with the current version number
+

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2012 RevPAR Collective, Inc.
+
+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.rdoc

@@ -0,0 +1,42 @@
+= Simple Gem
+
+Contains tools, libraries, and rake tasks for creating gems.
+
+Attempts to be as lightweight and non-intrusive as possible, minimizing code-gen
+
+== Creating a new gem
+
+=== Synopsis:
+
+ gem skeleton my_gem
+
+Note the output of the command - it will tell you to update the gemspec among a couple other things to get you started.
+
+The new gem may be built and tested out of the box.
+
+== Building a gem
+
+There are two rake tasks--build and build_dev--that let you create either a new permenant versioned build of the gem or a temporary development build.
+
+=== rake build
+
+To build a new permanent version, first update the lib/gem_name/version.rb file appropriately (major, minor, or build version) and/or CHANGELOG if there is one, then commit it and tag it with the new version number (you can do this with "rake tag"). Build the gem using "rake build" which will create a gem file in the gems/ directory. Then simply deploy it to the desired repository (ie. "gem push gems/my_gem-version.gem", or "gem inabox gems/my_gem-version.gem") and install it locally.
+
+Here's a quick synopsis:
+
+ vim lib/gem_name/version.rb  # update version number appropriately
+ vim CHANGELOG                # add change info
+ git add .
+ git commit
+ rake tag
+ git push origin master
+ git push --tags origin
+ rake build
+ gem push gems/gem_name-0.0.0.gem  # alternatively, "gem inabox gems/gem_name-0.0.0.gem"
+ gem install gem_name
+
+Note that once you build and deploy a gem, you shouldn't try to undo it - that should be a released version forever. If you need to fix an error, patch it, increment its build version, and deploy it using these same steps.
+
+=== rake build_dev
+
+At any time, you can run rake build_dev, which will add a patch version to the current version number and build a gem file into the gems_dev folder. Install it with "gem install gems_dev/my_gem-version.gem," and then you can use it in other projects to try it out before permanently versioning it.

data/lib/rubygems/commands/skeleton_command.rb

@@ -0,0 +1,90 @@
+require 'date'
+require 'erb'
+require 'rubygems/command'
+require 'active_support/inflector'
+
+class Gem::Commands::SkeletonCommand < Gem::Command
+
+  def initialize
+    super 'skeleton', 'Create the skeleton for a new gem'
+  end
+
+  def arguments
+    'GEMNAME       name of gem to create a skeleton for'
+  end
+
+  def usage
+    "#{program_name} GEMNAME"
+  end
+
+  def execute
+    gem_name = get_all_gem_names[0]
+    camelized_gem_name = gem_name.camelize
+
+    # make directory for gem
+    if File.exists?(gem_name)
+      raise "#{gem_name} directory already exists"
+    else
+      Dir.mkdir gem_name
+    end
+
+    safe_create_dir(File.join(gem_name, 'lib'))
+    safe_create_dir(File.join(gem_name, 'lib', gem_name))
+    safe_create_dir(File.join(gem_name, 'spec'))
+
+    renderer = TemplateRenderer.new(gem_name)
+    renderer.render('gitignore', '.gitignore')
+    renderer.render('Gemfile', 'Gemfile')
+    renderer.render('README.rdoc', 'README.rdoc')
+    renderer.render('CHANGELOG.rdoc', 'CHANGELOG.rdoc')
+    renderer.render('LICENSE.txt', 'LICENSE.txt')
+    renderer.render('Rakefile', 'Rakefile')
+    renderer.render('lib_base.rb', File.join('lib', "#{gem_name}.rb"))
+    renderer.render('version.rb', File.join('lib', gem_name, 'version.rb'))
+    renderer.render('spec_helper.rb', File.join('spec', 'spec_helper.rb'))
+    renderer.render('gemspec', "#{gem_name}.gemspec")
+
+    puts renderer.render('POST_INSTALL_MESSAGE')
+
+  end
+
+  private
+
+  def safe_create_dir(dir_name)
+    if File.exists?(dir_name)
+      raise "#{dir_name} is not a directory" unless File.directory?(dir_name)
+    else
+      Dir.mkdir dir_name
+    end
+  end
+
+  class TemplateRenderer
+
+    attr_reader :gem_name
+
+    def initialize(gem_name)
+      @gem_name = gem_name
+      @templates_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'templates'))
+    end
+
+    def get_binding
+      binding
+    end
+
+    def render(template, target_file = nil)
+      source_text = File.read("#{File.join(@templates_dir, template)}")
+      source_object = ERB.new(source_text)
+      result = source_object.result(get_binding)
+
+      if target_file
+        File.open(File.join(gem_name, target_file), 'w') do |f|
+          f.write(result)
+        end
+      else
+        result
+      end
+    end
+
+  end
+
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,3 @@
+require 'rubygems/command_manager'
+
+Gem::CommandManager.instance.register_command :skeleton

data/lib/simple_gem/version.rb

@@ -0,0 +1,4 @@
+module SimpleGem
+  VERSION = '0.0.0'
+end
+

data/lib/tasks/simple_gem.rb

@@ -0,0 +1,87 @@
+require 'rspec/core/rake_task'
+
+module SimpleGem
+  class << self
+
+    attr_writer :current_version, :current_gemspec
+
+    def current_version
+      if !@current_version
+        raise 'must define SimpleGem.current_version'
+      end
+      @current_version
+    end
+
+    def current_gemspec
+      if !@current_gemspec
+        raise 'must define SimpleGem.current_gemspec'
+      end
+      @current_gemspec
+    end
+
+    def safe_create_dir(dir_name)
+      if File.exists?(dir_name)
+        raise "#{dir_name} is not a directory" unless File.directory?(dir_name)
+      else
+        Dir.mkdir dir_name
+        puts "* created directory #{dir_name}"
+      end
+    end
+
+    def build_gem(target_dir)
+      print "Do you want to build version #{current_version} (Y/n): "
+      input = STDIN.gets.strip
+    
+      if input.to_s[0,1] == 'Y'
+        safe_create_dir(target_dir)
+        spec = Gem::Specification.load(current_gemspec)
+        spec.version = current_version
+        builder = Gem::Builder.new(spec)
+        gem_file = builder.build
+        target_file = "#{target_dir}/#{gem_file}"
+        File.rename gem_file, target_file
+        puts "Successfully built #{gem_file} into #{target_dir}"
+        [ current_version, target_file ]
+      else
+        raise %q{Aborting... update version file and run "rake build" again.}
+      end
+    end
+    
+    def build_production_gem
+      if !`git status -s`.empty?
+        raise 'There are uncommitted changes in the tree - commit before building'
+      end
+    
+      build_gem 'gems'
+    end
+
+    def tag(version)
+      version ||= current_version
+      `git tag #{version}`
+    end
+
+  end
+end
+
+task :default => [ :spec ]
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Builds a gemfile for production (into gems/)'
+task :build do
+  SimpleGem.build_production_gem
+end
+
+desc 'Builds a gemfile for development (into gems_dev/)'
+task :build_dev do
+  current_version = SimpleGem.current_version
+  SimpleGem.current_version = "#{current_version}.#{Time.now.to_i}"
+  SimpleGem.build_gem 'gems_dev'
+  SimpleGem.current_version = current_version
+end
+
+desc 'Creates a git tag with the given version'
+task :tag, :version do |t, args|
+  SimpleGem.tag(args[:version])
+end
+

data/templates/CHANGELOG.rdoc

@@ -0,0 +1,4 @@
+= <%= @gem_name.titleize %>
+
+== Version 0.0.0
+* Change information here

data/templates/Gemfile

@@ -0,0 +1,10 @@
+source 'http://rubygems.org'
+
+group :rake do
+  gem 'simple_gem', :require => 'tasks/simple_gem'
+end
+
+group :test do
+  gem 'rspec', '~> 2.8'
+end
+

data/templates/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) <%= Date.today.year %> <%= `git config user.name` %>
+
+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/templates/POST_INSTALL_MESSAGE

@@ -0,0 +1,15 @@
+A barebones gem has been created in the <%= @gem_name %> directory.
+
+You should now:
+* Open up README.rdoc and put in a basic description of your gem
+* Open up <%= @gem_name %>.gemspec and fill in the summary, description,
+  authors, and email fields, and add any dependencies
+* Init a git repo (git init), add and commit everything
+* Create a github repo for the gem and push to it
+
+The lib/<%= @gem_name %>.rb file has a note to get you started on
+implementation, and the spec/ folder is ready for tests. They can be run by
+simply executing "rake".
+
+See the README for simple_gem on github for a brief overview of how to
+version, build, and deploy your gem.

data/templates/README.rdoc

@@ -0,0 +1,7 @@
+= <%= @gem_name.titleize %>
+
+Put a description of the gem here.
+
+== Synopsis:
+
+ foo = <%= @gem_name.camelize %>.new

data/templates/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler.require(:rake)
+
+# Configure gem building
+require File.expand_path(File.join(File.dirname(__FILE__), 'lib', '<%= @gem_name %>', 'version'))
+SimpleGem.current_version = <%= @gem_name.camelize %>::VERSION
+SimpleGem.current_gemspec = '<%= @gem_name %>.gemspec'
+

data/templates/gemspec

@@ -0,0 +1,33 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'lib', '<%= @gem_name %>', 'version'))
+
+Gem::Specification.new do |s|
+
+  # definition
+  s.name = %q{<%= @gem_name %>}
+  s.version = <%= @gem_name.camelize %>::VERSION
+
+  # details
+  s.date = %q{<%= Date.today %>}
+  s.summary = %q{Summary of gem here.}
+  s.description = %q{Description of gem here.}
+  s.authors = [ '<%= `git config user.name` %>' ]
+  s.email = %q{<%= `git config user.email` %>}
+  s.homepage = %q{https://github.com/<%= `git config github.user` %>/<%= @gem_name %>}
+  s.require_paths = [ 'lib' ]
+  
+  # documentation
+  s.has_rdoc = true
+  s.extra_rdoc_files = %w( README.rdoc CHANGELOG.rdoc LICENSE.txt )
+  s.rdoc_options = %w( --main README.rdoc )
+
+  # files to include
+  s.files = Dir[ 'lib/**/*.rb', 'README.rdoc', 'CHANGELOG.rdoc', 'LICENSE.txt' ]
+
+  # dependencies
+  # s.add_dependency 'activemodel', '~> 3.0'
+
+  # if binaries
+  # s.bindir = 'bin'
+  # s.executables = [ 'executable' ]
+
+end

data/templates/gitignore

@@ -0,0 +1,3 @@
+/gems
+/gems_dev
+.*.swp

data/templates/lib_base.rb

@@ -0,0 +1,9 @@
+# This file should require or autoload the implementation of this gem
+#
+# Example:
+#
+#  require 'my_gem/my_extension'
+#
+#  module MyGem
+#    autoload :MyClass, 'my_gem/my_class'
+#  end

data/templates/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'bundler'
+Bundler.require(:default, :test)
+
+require '<%= @gem_name %>'
+

data/templates/version.rb

@@ -0,0 +1,3 @@
+module <%= @gem_name.camelize %>
+  VERSION = '0.0.0'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: simple_gem
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- David Dawson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-08 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70112078226820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70112078226820
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70112078226320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *70112078226320
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70112078276800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70112078276800
+description: Contains tools that create gem skeletons, rake tasks that support building
+  and deploying gems, and more.
+email: daws23@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- CHANGELOG.rdoc
+- LICENSE.txt
+files:
+- lib/rubygems/commands/skeleton_command.rb
+- lib/rubygems_plugin.rb
+- lib/simple_gem/version.rb
+- lib/tasks/simple_gem.rb
+- templates/CHANGELOG.rdoc
+- templates/Gemfile
+- templates/gemspec
+- templates/gitignore
+- templates/lib_base.rb
+- templates/LICENSE.txt
+- templates/POST_INSTALL_MESSAGE
+- templates/Rakefile
+- templates/README.rdoc
+- templates/spec_helper.rb
+- templates/version.rb
+- README.rdoc
+- CHANGELOG.rdoc
+- LICENSE.txt
+homepage: https://github.com/daws/simple_gem
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Support tools, libraries, and rake tasks for creating gems.
+test_files: []