gemstone 0.1

data/Changelog.md

@@ -0,0 +1,4 @@
+# Gemstone: Changelog
+
+## v0.1
+First version

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Raul Murciano <raul@murciano.net>
+
+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,54 @@
+# GemStone
+
+Generates a skeleton to start coding your next ruby gem.
+
+## Usage
+
+    gemstone
+    
+    > Hi, I'll need some data about your next ruby gem, please answer all questions:
+    
+    > gem name?
+    zombie
+    
+    > gem author?
+    Raul Murciano
+    
+    > author email?
+    raul@murciano.net
+    
+    > gem summary? (be brief)
+    Resurrects dead bodies
+    
+    > summary?
+    Braaains, braaaaains...
+    
+    > homepage URL?
+    http://github.com/raul/zombie
+    
+    > will include an executable? (y/n)
+    y
+
+The following files will be generated:
+
+- `bin/your_gem`: an executable ruby script will be generated if you answered `y` to the `will include an executable?` question
+- `Changelog.md`: update it before releasing each new version
+- `Gemfile`: help to manage dependencies, will rely in your `.gemspec` file
+- `your_gem.gemspec`: all the relevant data about your new gem goes here
+- `lib/your_gem.rb`: grow your awesome code here
+- `LICENSE`: MIT license FTW
+- `Rakefile`: will run your tests by default
+- `README.md`: please always document your gems so it will make them easier to use
+- `test/test_helper.rb`: will load `MiniTest` and your gem code to bootstrap your tests
+- `test/your_gem_test.rb`: sample test
+
+
+## Opinions
+
+I prefer a light approach for testing so I use MiniTest (contributions to add RSpec suppport are welcome, but should be tested themselves with MiniTest).
+
+## License
+See the LICENSE file included in the distribution.
+
+## Copyright
+Copyright (C) 2011 Raul Murciano <raul@murciano.net>.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake'
+require 'rake/testtask'
+
+task :default => [:test]
+
+desc 'Run tests'
+Rake::TestTask.new('test') do |t|
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+  t.warning = true
+end

data/lib/gemstone.rb

@@ -0,0 +1,106 @@
+require 'erb'
+require 'fileutils'
+
+module GemStone
+  
+  VERSION = '0.1'
+  
+  class MissingOption < Exception; end
+
+  class CLI
+
+    def self.ask_options
+      options = {}
+      while options.empty? do
+        puts "Hi, I'll need some data about your next ruby gem, please answer all questions"
+        questions = [
+                      [:name        , 'gem name?'], 
+                      [:author      , 'gem author?'], 
+                      [:email       , 'author email?'], 
+                      [:summary     , 'gem summary? (be brief)'], 
+                      [:description , 'gem description? (not so brief)'], 
+                      [:homepage    , 'gem homepage URL?'], 
+                      [:executable  , 'will the gem include an executable? (y/n)'] 
+                    ]
+
+        questions.each do |option, question|
+          puts question
+          options[option] = gets.chomp
+        end
+        options[:executable] = options[:executable].downcase.include?('y')
+      
+        begin
+          OptionsValidator.validate!(options)
+        rescue MissingOption => e
+          puts "Please answer all questions."
+          options = {}
+        end
+      end
+      options
+    end
+    
+  end
+  
+  class OptionsValidator
+    
+    REQUIRED_OPTIONS = [:name, :author, :email, :description, :summary, :homepage, :executable]
+    
+    def self.validate!(options)
+      REQUIRED_OPTIONS.each do |option|
+        raise MissingOption, "'#{option}' option required" unless present?(options[option])
+      end
+    end
+
+    def self.present?(value)
+      !value.nil? && !value.to_s.strip.empty?
+    end
+    
+  end
+  
+  class Generator
+  
+    def initialize(options = nil)
+      cli_mode = options.nil?
+      options ||= CLI.ask_options
+      @options = options
+      OptionsValidator.validate!(@options)
+      @options[:gem_file_name] = underscore(@options[:name])
+      @options[:gem_class_name] = classify(@options[:name])
+      @options[:gem_path] ||= "./#{options[:gem_file_name]}"
+      %w{ README.md Changelog.md Gemfile RakeFile LICENSE test/test_helper.rb }.each{ |path| render_file path }
+      render_file 'sample.gemspec', "#{@options[:gem_file_name]}.gemspec"
+      render_file 'test/sample_test.rb', "test/#{@options[:gem_file_name]}_test.rb"
+      render_file 'lib/sample.rb', "lib/#{@options[:gem_file_name]}.rb"
+      if @options[:executable]
+        render_file('bin/sample', "bin/#{@options[:gem_file_name]}")
+        exec_path = result_path "bin/#{@options[:gem_file_name]}"
+        `chmod +x #{exec_path}`
+      end
+      puts "Your gem is ready at #{@options[:gem_path]}, start coding!" if cli_mode
+    end
+  
+    # 'My gem' => 'my_gem'
+    def underscore(gem_name)
+      gem_name.strip.downcase.gsub(' ', '_')
+    end
+  
+    # 'My gem' => 'MyGem'
+    def classify(gem_name)
+      gem_name.strip.split.map{ |word| word.capitalize}.join.gsub(' ', '')
+    end
+    
+    def render_file(path, result_file_path = path)
+      source_path = File.join 'template', path
+      result_file_path = result_path(result_file_path)
+      FileUtils.mkdir_p File.dirname(result_file_path)
+      result = ERB.new(File.read(source_path)).result(binding)
+      File.open(result_file_path, 'w') {|f| f.write(result) }
+    end
+  
+    def result_path(source_path)
+      File.join @options[:gem_path], source_path
+    end
+  
+  end
+  
+end

data/test/options_test.rb

@@ -0,0 +1,30 @@
+require './test/test_helper'
+
+class OptionsTest < GemStoneTest
+  
+  def setup
+    @valid_options = {
+      :name => 'My gem',
+      :author => 'Raul Murciano',
+      :email => 'raul@murciano.net',
+      :homepage => 'http://github.com/raul/my_gem',
+      :description => 'A short description goes here',
+      :summary => 'Lorem ipsum and so on',
+      :executable => true
+    }
+  end
+  
+  def test_version
+    assert_equal '0.1', GemStone::VERSION
+  end
+  
+  def test_required_options_are_checked
+    GemStone::OptionsValidator::REQUIRED_OPTIONS.each do |option|
+      @valid_options.delete(option)
+      assert_raises GemStone::MissingOption do
+        GemStone::Generator.new @valid_options
+      end
+    end
+  end
+
+end

data/test/results_test.rb

@@ -0,0 +1,249 @@
+require './test/test_helper'
+
+class ResultsTest < GemStoneTest
+
+  def setup
+    reset_sandbox
+    @valid_options = {
+      :name => 'My gem',
+      :author => 'Raul Murciano',
+      :email => 'raul@murciano.net',
+      :homepage => 'http://github.com/raul/my_gem',
+      :description => 'A short description goes here',
+      :summary => 'Lorem ipsum and so on',
+      :executable => true,
+      :gem_path => './test/sandbox'
+    }
+    GemStone::Generator.new @valid_options
+  end
+
+
+  ## Changelog.md
+  
+  def test_creates_changelog
+    assert_file_created 'Changelog.md'
+  end
+  
+  def test_changelog_includes_gem_name_in_title
+    assert_file_includes 'Changelog.md', '# My gem changelog'
+  end
+  
+  def test_changelog_includes_v_0_1
+    assert_file_includes 'Changelog.md', '## v0.1'
+  end
+
+  
+  ## Gemfile
+  
+  def test_creates_gemfile
+    assert_file_created 'Gemfile'
+  end
+  
+  def test_gemfile_remains_identical
+    assert_file_equals_template 'Gemfile'
+  end
+
+  
+  # my_gem.gemspec
+  
+  def test_creates_gemspec
+    assert_file_created 'my_gem.gemspec'
+  end
+  
+  def test_gemspec_requires_lib
+    assert_file_includes 'my_gem.gemspec', 'require File.expand_path("./lib/my_gem")'
+  end
+  
+  def test_gemspec_includes_name
+    assert_file_includes 'my_gem.gemspec', 's.name        = "My gem"'
+  end
+
+  def test_gemspec_includes_authors
+    assert_file_includes 'my_gem.gemspec', 's.authors     = ["Raul Murciano"]'
+  end
+
+  def test_gemspec_includes_email
+    assert_file_includes 'my_gem.gemspec', 's.email       = ["raul@murciano.net"]'
+  end
+
+  def test_gemspec_includes_version
+    assert_file_includes 'my_gem.gemspec', 's.version     = MyGem::VERSION'
+  end
+  
+  def test_gemspec_includes_platform
+    assert_file_includes 'my_gem.gemspec', 's.platform    = Gem::Platform::RUBY'
+  end
+
+  def test_gemspec_includes_rubyforge_project
+    assert_file_includes 'my_gem.gemspec', 's.rubyforge_project         = "my_gem"'
+  end
+
+  def test_gemspec_includes_summary
+    assert_file_includes 'my_gem.gemspec', 's.summary     = "Lorem ipsum and so on"'
+  end
+
+  def test_gemspec_includes_homepage
+    assert_file_includes 'my_gem.gemspec', 's.homepage    = "http://github.com/raul/my_gem"'
+  end
+
+  def test_gemspec_includes_description
+    assert_file_includes 'my_gem.gemspec', 's.description = "A short description goes here"'
+  end
+
+
+  ## README.md
+
+  def test_creates_readme
+    assert_file_created 'README.md'
+  end
+  
+  def test_readme_includes_gem_name_as_title
+    assert_file_includes 'README.md', '# My gem'
+  end
+
+  def test_readme_includes_dummy_doc
+    assert_file_includes 'README.md', 'This documentation needs more love from Raul Murciano'
+  end
+
+  def test_readme_includes_copyright
+    assert_file_includes 'README.md', "Copyright (C) #{Time.now.year} Raul Murciano <raul@murciano.net>"
+  end
+
+  def test_readme_mentions_license
+    assert_file_includes 'README.md', 'See the LICENSE file included in the distribution.'
+  end
+   
+  
+  ## lib/my_gem.rb
+
+  def test_creates_lib_file
+    assert_file_created 'lib/my_gem.rb'
+  end
+  
+  def test_lib_file_includes_class
+    assert_file_includes 'lib/my_gem.rb', 'class MyGem'
+  end
+  
+  def test_lib_file_includes_version
+    assert_file_includes 'lib/my_gem.rb', "VERSION = '0.1'"
+  end
+
+  
+  ## LICENSE
+  
+  def test_creates_license
+    assert_file_created 'LICENSE'
+  end
+
+  def test_license_includes_author
+    assert_file_includes 'LICENSE', 'Raul Murciano'
+  end
+
+  def test_license_includes_email
+    assert_file_includes 'LICENSE', 'raul@murciano.net'
+  end
+  
+  
+  ## Rakefile
+  
+  def test_creates_rakefile
+    assert_file_created 'Rakefile'
+  end
+  
+  def test_rakefile_remains_identical
+    assert_file_equals_template 'Rakefile'
+  end
+
+
+  ## test/test_helper.rb
+  
+  def test_creates_test_helper
+    assert_file_created 'test/test_helper.rb'
+  end
+  
+  def test_test_helper_requires_rubygems
+    assert_file_includes 'test/test_helper.rb', "require 'rubygems'"
+  end
+
+  def test_test_helper_requires_minitest
+    assert_file_includes 'test/test_helper.rb', "require 'minitest/autorun'"
+  end
+
+  def test_test_helper_requires_gem_lib
+    assert_file_includes 'test/test_helper.rb', "require './lib/my_gem'"
+  end
+  
+  
+  ## test/my_gem_test.rb
+  
+  def test_creates_test_file
+    assert_file_created 'test/my_gem_test.rb'
+  end
+  
+  def test_test_file_requires_test_helper
+    assert_file_includes 'test/my_gem_test.rb', "require './test/test_helper'"
+  end
+  
+  def test_test_file_includes_test_class
+    assert_file_includes 'test/my_gem_test.rb', 'class MyGemTest < MiniTest::Unit::TestCase'
+  end
+  
+
+  ## bin/my_gem
+  
+  def test_doesnt_create_executable_if_not_selected
+    @valid_options[:executable] = false
+    reset_sandbox
+    GemStone::Generator.new @valid_options
+    assert_file_not_created 'bin/my_gem'
+  end
+
+  def test_creates_executable_if_selected
+    assert_file_created 'bin/my_gem'
+  end
+  
+  def test_executable_includes_ruby_shebang
+    assert_file_includes 'bin/my_gem', "#!/usr/bin/env ruby"
+  end
+  
+  def test_executable_includes_dummy_code
+    assert_file_includes 'bin/my_gem', 'puts "This executable needs more love from Raul Murciano"'
+  end
+  
+  def test_executable_is_executable
+    assert_executable_file 'bin/my_gem'
+  end
+  
+  
+  
+  protected
+  
+  ## test helpers
+    
+  def assert_file_includes(file_path, content)
+    path = sandboxed_path file_path
+    assert File.file?(path) && File.read(path).include?(content), "String '#{content}' not found in #{path}"
+  end
+  
+  def assert_file_created(file_path)
+    path = sandboxed_path file_path
+    assert File.file?(path), "#{path} file not found"
+  end
+
+  def assert_file_not_created(file_path)
+    path = sandboxed_path file_path
+    assert !File.file?(path), "#{path} file found, and should not exist"
+  end
+  
+  def assert_file_equals_template(file_path)
+    templates_path = './template'
+    template_path = File.join templates_path, file_path
+    assert FileUtils.compare_file(template_path, sandboxed_path(file_path))
+  end
+  
+  def assert_executable_file(file_path)
+    path = sandboxed_path file_path
+    assert `ls -la #{path}`.include?('-rwxr-xr-x'), "#{file_path} is not executable"
+  end
+  
+end

data/test/sandbox/Changelog.md

@@ -0,0 +1,3 @@
+# My gem changelog
+
+## v0.1

data/test/sandbox/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/test/sandbox/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Raul Murciano raul@murciano.net 
+
+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/test/sandbox/README.md

@@ -0,0 +1,9 @@
+# My gem
+
+This documentation needs more love from Raul Murciano
+
+## License
+See the LICENSE file included in the distribution.
+
+## Copyright
+Copyright (C) 2011 Raul Murciano <raul@murciano.net>.

data/test/sandbox/RakeFile

@@ -0,0 +1,11 @@
+require 'rake'
+require 'rake/testtask'
+
+task :default => [:test]
+
+desc 'Run tests'
+Rake::TestTask.new('test') do |t|
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+  t.warning = true
+end

data/test/sandbox/bin/my_gem

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+puts "This executable needs more love from Raul Murciano"

data/test/sandbox/lib/my_gem.rb

@@ -0,0 +1,5 @@
+class MyGem
+  
+  VERSION = '0.1'
+  
+end

data/test/sandbox/my_gem.gemspec

@@ -0,0 +1,22 @@
+$:.unshift Dir.pwd
+require File.expand_path("./lib/my_gem")
+
+Gem::Specification.new do |s|
+  s.name        = "My gem"
+  s.version     = MyGem::VERSION
+  s.authors     = ["Raul Murciano"]
+  s.email       = ["raul@murciano.net"]
+  s.homepage    = "http://github.com/raul/my_gem"
+  s.summary     = "Lorem ipsum and so on"
+  s.description = "A short description goes here"
+
+  # s.executables = ["newgem"]
+  s.files             = Dir["{lib,test}/**/*", "[A-Z]*", "init.rb"] - ["Gemfile.lock"]
+  s.require_path      = 'lib'
+
+  # s.add_dependency "another_gem", "0.1"
+  s.add_development_dependency 'minitest', '>2.0'
+  
+  s.rubyforge_project         = "my_gem"
+  s.platform    = Gem::Platform::RUBY
+end

data/test/sandbox/test/my_gem_test.rb

@@ -0,0 +1,9 @@
+require './test/test_helper'
+
+class MyGemTest < MiniTest::Unit::TestCase
+
+  def test_version
+    assert_equal '0.1', MyGem::VERSION
+  end
+    
+end

data/test/sandbox/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'minitest/autorun'
+require './lib/my_gem'

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'minitest/autorun'
+require 'fileutils'
+require './lib/gemstone'
+
+class GemStoneTest < MiniTest::Unit::TestCase
+
+  SANDBOX_PATH = './test/sandbox'
+  
+  ## Helpers
+  
+  def sandboxed_path(file_path)
+    sandboxed_path = File.join SANDBOX_PATH, file_path
+  end
+  
+  def reset_sandbox
+    FileUtils.rm_rf SANDBOX_PATH
+    FileUtils.mkdir SANDBOX_PATH
+  end
+
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: gemstone
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Raul Murciano
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-08 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id001
+description: A new gem generator. Nothing more, nothing less.
+email: 
+- raul@murciano.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/gemstone.rb
+- test/options_test.rb
+- test/results_test.rb
+- test/sandbox/bin/my_gem
+- test/sandbox/Changelog.md
+- test/sandbox/Gemfile
+- test/sandbox/lib/my_gem.rb
+- test/sandbox/LICENSE
+- test/sandbox/my_gem.gemspec
+- test/sandbox/RakeFile
+- test/sandbox/README.md
+- test/sandbox/test/my_gem_test.rb
+- test/sandbox/test/test_helper.rb
+- test/test_helper.rb
+- Changelog.md
+- Gemfile
+- LICENSE
+- Rakefile
+- README.md
+has_rdoc: true
+homepage: http://github.com/raul/gemstone
+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: 
+      - 1
+      - 3
+      - 4
+      version: 1.3.4
+requirements: []
+
+rubyforge_project: gemstone
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Generates a skeleton to start coding your next ruby gem
+test_files: []
+