skullet 0.0.0 → 0.0.1

data/Rakefile.rb

@@ -0,0 +1,12 @@
+desc "same as rake specs"
+task :default => [:specs]
+
+desc "same as rake specs:all"
+task :specs => [:"specs:all"]
+namespace :specs do
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new "all" do |t|
+    t.pattern = "spec/**/*_spec.rb"
+    t.rspec_opts = ['--color', '--format documentation', '--require spec_helper']
+  end
+end

data/Readme.md

@@ -0,0 +1,54 @@
+skullet
+=======
+
+#What is this?
+A (one more) Ruby project skeleton generator, creates the initial dir
+structure.
+
+#Why is this?
+ * a scratch your own itch gem
+
+I don't wanna look for the dir structure and the basic spec files
+every time I need to create a new project, so I decided to automate it.
+
+#How is this?
+You install the gem:
+
+    gem install skullet
+
+##Usage
+If you want to create a project named full_of_awesome, you can use the
+skullet executable:
+
+    skullet full_of_awesome
+
+The current default dir structure is the follow:
+
+    full_of_awesome/
+      -bin/
+        full_of_awesome
+      -lib/
+        full_of_awesome/
+        full_of_awesome.rb
+      -spec/
+        full_of_awesome/
+        spec_helper.rb
+      .gitignore
+      .rvmrc
+      Gemfile
+      Rakefile.rb
+
+###Rakefile.rb
+The rake tasks created within the Rakefile.rb are listed below:
+
+```
+$ rake -T
+rake default    # same as rake specs
+rake specs      # same as rake specs:all
+rake specs:all  # Run RSpec code examples
+```
+
+###TODO:
+ * add -g parameter to create the git repo after the dir structure
+ * add -b parameter to install bundler and run `bundle install`
+ * add rdoc to this gem

data/bin/skullet

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+lib = File.expand_path("../../lib", __FILE__)
+$:.unshift lib unless $:.include?(lib)
+require 'skullet'
+
+cli = Skullet::CLI.new
+cli.run

data/lib/skullet.rb

@@ -0,0 +1,8 @@
+require 'skullet/string_extensions'
+require 'skullet/generator'
+require 'skullet/cli'
+
+module Skullet
+  VERSION = "0.0.1"
+  NAME = "skullet"
+end

data/lib/skullet/base_files/Gemfile.rb

@@ -0,0 +1,5 @@
+source :rubygems
+
+group :test do
+  gem "rspec"
+end

data/lib/skullet/base_files/Rakefile.rb

@@ -0,0 +1,12 @@
+desc "same as rake specs"
+task :default => [:specs]
+
+desc "same as rake specs:all"
+task :specs => [:"specs:all"]
+namespace :specs do
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new "all" do |t|
+    t.pattern = "spec/**/*_spec.rb"
+    t.rspec_opts = ['--color', '--format documentation', '--require spec_helper']
+  end
+end

data/lib/skullet/base_files/executable.rb

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+lib = File.expand_path("../../lib", __FILE__)
+$:.unshift lib unless $:.include?(lib)

data/lib/skullet/base_files/project_file.erb

@@ -0,0 +1,4 @@
+module <%= project_name.camelize %>
+  VERSION = "0.0.0"
+  NAME = "<%= project_name %>"
+end

data/lib/skullet/base_files/spec_helper.erb

@@ -0,0 +1,3 @@
+$:.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+
+require '<%= project_name %>'

data/lib/skullet/cli.rb

@@ -0,0 +1,58 @@
+require 'optparse'
+
+module Skullet
+
+  class CLI
+    def initialize(output=STDOUT)
+      @out = output
+    end
+
+    def run(args=ARGV)
+      options = parse(args)
+      generator = args[0] && Generator.new(args[0])
+      process(options, generator)
+    end
+
+    private
+    def parse(args)
+      options = {}
+
+      @parser ||= OptionParser.new do |args|
+        args.banner = banner
+
+        args.on("-v", "--version", "print the version") do
+          options[:version] = true
+        end
+
+        args.on("-h", "--help", "print this help") do
+          options[:help] = true
+        end
+      end
+
+      @parser.parse!(args)
+
+      options
+    end
+
+    def banner
+      banner = "Usage: #{Skullet::NAME} PROJECT [OPTION]...\n"
+      banner << "Generate a Ruby project skeleton"
+    end
+
+    def version
+      "#{Skullet::NAME} version #{Skullet::VERSION}"
+    end
+
+    def exit_with(msg, code)
+      @out.puts(msg)
+      exit(code)
+    end
+
+    def process(options, generator)
+      exit_with(version, 0) if options[:version]
+      exit_with(@parser.help, 0) if options[:help]
+
+      generator && generator.make_project
+    end
+  end# CLI
+end

data/lib/skullet/generator.rb

@@ -0,0 +1,98 @@
+require 'fileutils'
+require 'erb'
+
+module Skullet
+
+  class Generator
+
+    def initialize(project)
+      @project = project
+
+      @base_files_path = File.join(File.expand_path("../", __FILE__), "base_files")
+      @project_dir = @project.dup
+    end
+
+    def make_root_dir
+      mkdir
+    end
+
+    def make_rake_file
+      copy("Rakefile.rb", "Rakefile.rb")
+    end
+
+    def make_bin_dir
+      mkdir("bin")
+      executable = copy("executable.rb", File.join("bin", @project))
+      system("chmod +x #{executable}")
+    end
+
+    def make_spec_dir
+      spec_dir = mkdir(File.join("spec", @project))
+      file_from_template(File.join("spec", "spec_helper.rb"), "spec_helper.erb")
+    end
+
+    def make_git_repo
+      file(".gitignore", ".rvmrc")
+    end
+
+    def make_rvm
+      ruby_version = %x(ruby -v).split(" ")[1]
+      if ruby_version.include? "p"
+        with_patch = ruby_version.split "p"
+        ruby_version = "#{with_patch[0]}-p#{with_patch[1]}"
+      end
+      file(".rvmrc", "rvm #{ruby_version}@#{@project} --create")
+    end
+
+    def make_lib_dir
+      project_lib_dir = mkdir(File.join("lib", @project))
+      file_from_template(File.join("lib", "#{@project}.rb"), "project_file.erb")
+    end
+
+    def make_bundle
+      copy("Gemfile.rb", "Gemfile")
+    end
+
+    def make_project
+      make_root_dir
+      make_bin_dir
+      make_lib_dir
+      make_spec_dir
+      make_git_repo
+      make_rvm
+      make_bundle
+      make_rake_file
+    end
+
+    private
+    def path_to(file_or_dir)
+      File.join @project_dir, file_or_dir
+    end
+
+    def file_from_template(file, template_file)
+      erb_file = File.join(@base_files_path, template_file)
+      tpl = ERB.new(IO.read(erb_file))
+      project = @project.dup
+      project.class.send(:include, Skullet::StringExtensions)
+      bind = Object.new.instance_eval { project_name = project; binding }
+      file(file, tpl.result(bind))
+    end
+
+    def mkdir(subdir=nil)
+      new_dir = path_to(subdir || "")
+      FileUtils.mkdir_p(new_dir)
+      new_dir
+    end
+
+    def copy(base_file, dest_file)
+      from = File.join @base_files_path, base_file
+      to = path_to(dest_file)
+      FileUtils.cp(from, to)
+      to
+    end
+
+    def file(file, content)
+      File.open(path_to(file), "w+") { |f| f.write(content) }
+    end
+  end# Generator
+end# Skullet

data/lib/skullet/string_extensions.rb

@@ -0,0 +1,19 @@
+module Skullet
+  module StringExtensions
+
+    def camelize
+      camelize_feature(self)
+    end
+
+    private
+    # the next one is brought to you by rails...
+    # File activesupport/lib/active_support/inflector/methods.rb, line 28
+    def camelize_feature(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.to_s[0].chr.downcase + camelize(lower_case_and_underscored_word)[1..-1]
+      end
+    end
+  end# StringExtensions
+end# Skullet

data/skullet.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name        = "skullet"
+  s.version     = "0.0.1"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ricardo Valeriano"]
+  s.email       = ["ricardo.valeriano@gmail.com"]
+  s.homepage    = "http://github.com/ricardovaleriano/gemusta"
+  s.summary     = "A (one more) Ruby project skeleton generator, creates the initial dir structure."
+  s.description = "You don't have look for the dir structure, the basic spec files, a basic .rmvrc file and such everytime you need to create a new Ruby project, automate it!"
+
+  s.required_rubygems_version = ">= 0"
+
+  s.add_development_dependency "rspec"
+
+	s.require_path = 'lib'
+	
+  s.files         = ["Rakefile.rb", "Readme.md", "bin/skullet", "lib/skullet.rb", "lib/skullet/base_files/Gemfile.rb", "lib/skullet/base_files/Rakefile.rb", "lib/skullet/base_files/executable.rb", "lib/skullet/base_files/project_file.erb", "lib/skullet/base_files/spec_helper.erb", "lib/skullet/cli.rb", "lib/skullet/generator.rb", "lib/skullet/string_extensions.rb", "skullet.gemspec", "spec/skullet/cli_spec.rb", "spec/skullet/generator_spec.rb", "spec/skullet_spec.rb", "spec/spec_helper.rb"]
+  s.test_files    = ["spec/skullet/cli_spec.rb", "spec/skullet/generator_spec.rb", "spec/skullet_spec.rb", "spec/spec_helper.rb"]
+
+	
+  s.executables  = ["skullet"]
+	
+end

data/spec/skullet/cli_spec.rb

@@ -0,0 +1,43 @@
+module Skullet
+
+  describe CLI do
+
+    let(:output) {
+      o = Object.new { attr_reader :messages }
+      o.instance_eval {
+        def puts(msg)
+          (@output ||= []) << msg
+        end
+
+        def current
+          (@output ||= []).last
+        end
+      }
+      o
+    }
+
+    let(:cli) { CLI.new(output) }
+
+    def exec
+      begin
+        yield if block_given?
+      rescue SystemExit => e
+        return e.status
+      end
+    end
+
+    context "command line args" do
+
+      it "-v, shows the version" do
+        string = "#{Skullet::NAME} version #{Skullet::VERSION}"
+        output.should_receive(:puts).with(string)
+        exec { cli.run(["-v"]) }
+      end
+
+      it "-h, shows help" do
+        exec { cli.run(["-h"]) }
+        output.current.should include("Usage: #{Skullet::NAME} PROJECT [OPTION]...")
+      end
+    end# command line args
+  end# CLI
+end

data/spec/skullet/generator_spec.rb

@@ -0,0 +1,162 @@
+module Skullet
+
+  describe Generator do
+    let(:project_name) {
+      name = "full_of_awesome"
+      name.class.send(:include, Skullet::StringExtensions)
+      name
+    }
+    let(:generator) { Generator.new(project_name) }
+
+    before(:all) { FileUtils.rm_rf project_name }
+
+    context "project dir" do
+
+      it "creates the project dir" do
+        generator.make_root_dir
+        Dir.exists?(project_name).should be_true
+      end
+
+      context "git" do
+        before(:all) { generator.make_git_repo }
+
+        it "creates a .gitignore file" do
+          File.exists?("#{project_name}/.gitignore").should be_true
+        end
+
+        it "ignores the .rvmrc file" do
+          IO.read("#{project_name}/.gitignore").should include ".rvmrc"
+        end
+      end# git
+
+      context "rvm" do
+        before(:all) { generator.make_rvm }
+        let(:rvmrc) { IO.read(File.join(project_name, ".rvmrc")) }
+
+        it "creates the .rvmrc file" do
+          File.exists?("#{project_name}/.rvmrc").should be_true
+        end
+
+        it "uses current ruby, a gemset named after the project and the option --create" do
+          version = %x(ruby -v).split(" ")[1]
+          if version.include? "p"
+            with_patch = version.split "p"
+            version = "#{with_patch[0]}-p#{with_patch[1]}"
+          end
+          rvmrc.should == "rvm #{version}@#{project_name} --create"
+        end
+      end# rvm
+
+      context "Gemfile" do
+        before(:all) { generator.make_bundle }
+
+        it "creates a Gemfile" do
+          File.exists?("#{project_name}/Gemfile").should be_true
+        end
+
+        it "includes rspec on Gemfile" do
+          IO.read("#{project_name}/Gemfile").should include "gem \"rspec\""
+        end
+      end# Gemfile
+
+      context "Rakefile.rb" do
+        let(:rakefile) { "#{project_name}/Rakefile.rb" }
+
+        it "creates the file" do
+          generator.make_rake_file
+          File.exists?(rakefile).should be_true
+        end
+
+        context "tasks" do
+          require 'rake'
+
+          before(:all) do
+            require "./#{rakefile}"
+          end
+
+          it "enables :default" do
+            Rake::Task.task_defined?(:default).should be_true
+          end
+
+          it "enables :specs" do
+            Rake::Task.task_defined?(:specs).should be_true
+          end
+
+          it "enables specs:all" do
+            Rake::Task.task_defined?(:"specs:all").should be_true
+          end
+        end# tasks
+      end# rake file
+
+      context "bin dir" do
+        before :all do
+          generator.make_bin_dir
+        end
+
+        it "creates the bin dir" do
+          Dir.exists?("#{project_name}/bin").should be_true
+        end
+
+        it "creates the file" do
+          File.exists?("#{project_name}/bin/#{project_name}").should be_true
+        end
+
+        it "should be executable" do
+          File.executable?("#{project_name}/bin/#{project_name}").should be_true
+        end
+      end# bin dir
+
+      context "lib dir" do
+        before :all do
+          generator.make_lib_dir
+        end
+
+        it "creates de lib dir" do
+          Dir.exists?("#{project_name}/lib").should be_true
+        end
+
+        it "creates the project dir" do
+          Dir.exists?("#{project_name}/lib/#{project_name}").should be_true
+        end
+
+        context "project file" do
+
+          it "creates the file" do
+            File.exists?("#{project_name}/lib/#{project_name}.rb").should be_true
+          end
+
+          it "creates the module for the project" do
+            require "./#{project_name}/lib/#{project_name}.rb"
+            Object.const_defined?(project_name.camelize).should be_true
+          end
+
+          it "defines a version constant within the module" do
+            m = Object.const_get(project_name.camelize)
+            m::VERSION.should == "0.0.0"
+          end
+        end# project file
+      end# lib dir
+
+      context "spec dir" do
+        before :all do
+          generator.make_spec_dir
+        end
+
+        it "generate a spec dir" do
+          Dir.exists?("#{project_name}/spec").should be_true
+        end
+
+        it "generates a subdir on spec with the project name" do
+          Dir.exists?("#{project_name}/spec/#{project_name}").should be_true
+        end
+
+        it "creates the spec_helper.rb file" do
+          File.exists?("#{project_name}/spec/spec_helper.rb").should be_true
+        end
+      end # spec dir
+    end# project dir
+
+    after(:all) { FileUtils.rm_rf project_name }
+
+  end # Generator
+end

data/spec/skullet_spec.rb

@@ -0,0 +1,91 @@
+module Skullet
+
+  describe "happy path, project creation using the executable" do
+
+    let(:executable) { File.expand_path("../../bin/skullet", __FILE__) }
+    let(:temp) do
+      temp = File.expand_path("../temp", __FILE__)
+      FileUtils.mkdir_p(temp)
+      temp
+    end
+    let(:project) { "project_test" }
+    let(:project_dir) { File.join(temp, project) }
+
+    before(:all) do
+      @current_path = Dir.pwd
+      FileUtils.chdir(temp)
+    end
+
+    it "-v, shows the version" do
+      %x(#{executable} -v).should include(Skullet::VERSION)
+    end
+
+    context "basic project structure" do
+      before(:all) do
+        system "#{executable} #{project}"
+      end
+
+      it "creates the project dir" do
+        Dir.exists?(project_dir).should be_true
+      end
+
+      it "creates the bin dir" do
+        Dir.exists?(File.join(project_dir, "bin")).should be_true
+      end
+
+      it "creates the executable" do
+        bin = File.join(project_dir, "bin")
+        File.exists?(File.join(bin, project)).should be_true
+      end
+
+      it "creates the lib dir" do
+        Dir.exists?(File.join(project_dir, "lib")).should be_true
+      end
+
+      it "creates the project dir" do
+        lib = File.join(project_dir, "lib")
+        Dir.exists?(File.join(lib, "#{project}")).should be_true
+      end
+
+      it "creates the project file" do
+        lib = File.join(project_dir, "lib")
+        File.exists?(File.join(lib, "#{project}.rb")).should be_true
+      end
+
+      it "creates the spec dir" do
+        Dir.exists?(File.join(project_dir, "spec")).should be_true
+      end
+
+      it "creates the application spec dir" do
+        spec = File.join(project_dir, "spec")
+        Dir.exists?(File.join(spec, project)).should be_true
+      end
+
+      it "creates the spec helper file" do
+        spec = File.join(project_dir, "spec")
+        File.exists?(File.join(spec, "spec_helper.rb")).should be_true
+      end
+
+      it "creates the .gitignore" do
+        File.exists?(File.join(project_dir, ".gitignore")).should be_true
+      end
+
+      it "creates the .rvmrc" do
+        File.exists?(File.join(project_dir, ".rvmrc")).should be_true
+      end
+
+      it "creates the Gemfile" do
+        File.exists?(File.join(project_dir, "Gemfile")).should be_true
+      end
+
+      it "creates the Rakefile.rb" do
+        File.exists?(File.join(project_dir, "Rakefile.rb")).should be_true
+      end
+    end# basic project structure
+
+    after(:all) do
+      FileUtils.chdir(@current_path)
+      FileUtils.rm_rf(temp)
+    end
+  end# happy path
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$:.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+
+require 'skullet'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skullet
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,16 +9,46 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-14 00:00:00.000000000Z
-dependencies: []
-description: Just a simple and light Ruby app Skeleton generator
+date: 2012-01-16 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70231419247320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70231419247320
+description: You don't have look for the dir structure, the basic spec files, a basic
+  .rmvrc file and such everytime you need to create a new Ruby project, automate it!
 email:
 - ricardo.valeriano@gmail.com
-executables: []
+executables:
+- skullet
 extensions: []
 extra_rdoc_files: []
-files: []
-homepage: http://github.com/ricardovaleriano/skullet
+files:
+- Rakefile.rb
+- Readme.md
+- bin/skullet
+- lib/skullet.rb
+- lib/skullet/base_files/Gemfile.rb
+- lib/skullet/base_files/Rakefile.rb
+- lib/skullet/base_files/executable.rb
+- lib/skullet/base_files/project_file.erb
+- lib/skullet/base_files/spec_helper.erb
+- lib/skullet/cli.rb
+- lib/skullet/generator.rb
+- lib/skullet/string_extensions.rb
+- skullet.gemspec
+- spec/skullet/cli_spec.rb
+- spec/skullet/generator_spec.rb
+- spec/skullet_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ricardovaleriano/gemusta
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -41,5 +71,9 @@ rubyforge_project:
 rubygems_version: 1.8.13
 signing_key: 
 specification_version: 3
-summary: Ruby project skeleton generator
-test_files: []
+summary: A (one more) Ruby project skeleton generator, creates the initial dir structure.
+test_files:
+- spec/skullet/cli_spec.rb
+- spec/skullet/generator_spec.rb
+- spec/skullet_spec.rb
+- spec/spec_helper.rb