simple-templater 0.0.1

data/spec/simple-templater/helpers_spec.rb

@@ -0,0 +1,81 @@
+# encoding: utf-8
+
+require_relative "../spec_helper"
+require "simple-templater/helpers"
+
+describe SimpleTemplater::Helpers do
+  it "should works as a mixin but it's methods should be also available as module methods" do
+    # SimpleTemplater::Helpers.shebang
+  end
+
+  describe "#shebang" do
+    include SimpleTemplater::Helpers
+    before(:each) do
+      RubyExts::Platform.stub!(:linux?).and_return(true)
+    end
+
+    it "should generate shebang with path to executable on Linux" do
+      shebang("ruby").should eql("#!ruby")
+    end
+
+    it "should generate shebang with /usr/bin/env on other platforms" do
+      RubyExts::Platform.stub!(:linux?).and_return(false)
+      shebang("ruby").should eql("#!/usr/bin/env ruby")
+    end
+
+    it "should take basename of current Ruby as a default executable" do
+      pending "How to test it?"
+      shebang.should eql("#!/usr/bin/env ruby")
+    end
+
+    it "should handle arguments for given executable" do
+      shebang("ruby", "-w", "--disable-gems").should eql("#!ruby -w --disable-gems")
+    end
+  end
+
+  describe "#plain_shebang" do
+    include SimpleTemplater::Helpers
+    it "should generate shebang with path to executable" do
+      plain_shebang("ruby").should eql("#!ruby")
+    end
+
+    it "should take basename of current Ruby as a default executable" do
+      pending "How to test it?"
+      plain_shebang.should eql("#!/usr/bin/env ruby")
+    end
+
+    it "should handle arguments for given executable" do
+      plain_shebang("ruby", "-w", "--disable-gems").should eql("#!ruby -w --disable-gems")
+    end
+  end
+
+  describe "#env_shebang" do
+    include SimpleTemplater::Helpers
+    it "should generate shebang with /usr/bin/env" do
+      env_shebang("ruby").should eql("#!/usr/bin/env ruby")
+    end
+
+    it "should take basename of current Ruby as a default executable" do
+      pending "How to test it?"
+      env_shebang.should eql("#!/usr/bin/env ruby")
+    end
+
+    it "should handle arguments for given executable" do
+      env_shebang("ruby", "-w", "--disable-gems").should eql("#!/usr/bin/env ruby -w --disable-gems")
+    end
+  end
+
+  describe "#rubypath" do
+    include SimpleTemplater::Helpers
+    it "should be full path to current Ruby" do
+      pending "How to test it?"
+    end
+  end
+
+  describe "#ruby_basename" do
+    include SimpleTemplater::Helpers
+    it "should be basename of current Ruby" do
+      pending "How to test it?"
+    end
+  end
+end

data/spec/simple-templater/hooks/hook_spec.rb

@@ -0,0 +1,100 @@
+# encoding: utf-8
+
+require "ostruct"
+require_relative "../../spec_helper"
+require "rubyexts/capture_io"
+require "simple-templater/hooks/hook"
+
+# factories
+module SimpleTemplater::Hooks
+  class Empty < Hook
+  end
+
+  class Test < Hook
+    def question
+      CLI.yes?("Do you hear me?")
+    end
+
+    def run
+      puts "Done"
+    end
+  end
+end
+
+describe SimpleTemplater::Hooks::Hook do
+  def capture(default = "X\n", &block)
+    @output = STDOUT.capture do
+      @returned = STDIN.capture(default, &block)
+    end
+    OpenStruct.new(returned: @returned, output: @output)
+  end
+
+  include SimpleTemplater::Hooks
+  describe ".find" do
+    it "should be nil if given hook doesn't exist" do
+      Hook.find(:whatever).should be_nil
+    end
+
+    it "should find hook with :test key" do
+      hook = Hook.find(:test).new(Hash.new)
+      hook.should respond_to(:run)
+      hook.should respond_to(:question)
+    end
+  end
+
+  describe ".invoke" do
+    describe "with context from ARGV" do
+      before(:each) do
+        @hook = Test.new(Hash.new)
+        Test.stub!(:new).and_return(@hook)
+      end
+
+      it "should call #run method" do
+        @hook.should_receive(:run)
+        capture { Test.invoke(test: true) }
+      end
+
+      it "should not call #run method if the argument is negative" do
+        pending
+        @hook.should_not_receive(:run)
+        capture { Test.invoke(test: false) }
+      end
+    end
+
+    describe "without context from ARGV" do
+      it "should print question with suggestions how user can respond" do
+        output = capture("y\n") { Test.invoke(Hash.new) }.output
+        regexp = Regexp.new(Regexp.quote("Do you hear me? [Y/n]"))
+        output.should match(regexp)
+      end
+
+      it "should take y as true" do
+        returned = capture("y\n") { Test.invoke(Hash.new) }.returned
+        returned.should be_true
+      end
+
+      it "should take n as false" do
+        returned = capture("n\n") { Test.invoke(Hash.new) }.returned
+        returned.should be_false
+      end
+    end
+  end
+
+  describe "instance methods" do
+    before(:each) do
+      @hook = Hook.find(:empty).new(Hash.new)
+    end
+
+    describe "#key" do
+      it "should be symbol created from snakecased name of class" do
+        @hook.key.should eql(:empty)
+      end
+    end
+
+    describe "#run" do
+      it "should raise NotImplementedError by default" do
+        lambda { @hook.run }.should raise_error(NotImplementedError)
+      end
+    end
+  end
+end

data/spec/simple-templater/hooks/postprocess/git_repository_spec.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require "fileutils"
+require "rubyexts/capture_io"
+require_relative "../../../spec_helper"
+require "simple-templater/hooks/postprocess/git_repository"
+
+describe SimpleTemplater::Hooks::GitRepository do
+  before(:each) do
+    @hook = SimpleTemplater::Hooks::GitRepository.new(Hash.new)
+    @repo = File.join(SPEC_ROOT, "stubs", "repository")
+  end
+
+  after(:each) do
+    FileUtils.rm_r(@repo)
+  end
+
+  it "should create .git directory" do
+    Dir.mkdir(@repo) # we are using fakefs so we don't have to remove it
+    Dir.chdir(@repo) do
+      STDOUT.capture { @hook.run } # don't show output, just do it
+      Dir.exist?(File.join(@repo, ".git")).should be_true
+    end
+  end
+end

data/spec/simple-templater/hooks/postprocess/github_spec.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+require_relative "../../../spec_helper"
+require "simple-templater/hooks/postprocess/github"
+
+describe SimpleTemplater::Hooks::Github do
+  # TODO: coming in version 0.2
+end

data/spec/simple-templater_spec.rb

@@ -0,0 +1,112 @@
+# encoding: utf-8
+
+require "logger"
+require "rubygems"
+require_relative "spec_helper"
+require "simple-templater"
+
+describe SimpleTemplater do
+  before(:each) do
+    Gem.clear_paths
+    Gem.path.push(File.join(SPEC_ROOT, "stubs", "gems"))
+  end
+
+  describe "constants" do
+    it "should provide VERSION string" do
+      SimpleTemplater::VERSION.should match(/^\d+\.\d+\.\d+$/)
+    end
+
+    describe "SimpleTemplater::GeneratorNotFound" do
+      it "should be defined as a constant" do
+        SimpleTemplater.constants.should include(:GeneratorNotFound)
+      end
+
+      it "should be an exception class" do
+        lambda { raise SimpleTemplater::GeneratorNotFound }.should_not raise_error(TypeError)
+      end
+    end
+
+    describe ".scope(scope, &block)" do
+      # TODO
+    end
+
+    describe ".register(name, path)" do
+      # TODO
+    end
+
+    describe ".discover!(scope)" do
+      it "should go through all the gems and find the generators" do
+        SimpleTemplater.scopes.clear
+        SimpleTemplater.discover!(:test)
+        SimpleTemplater.scopes.should have_key(:test)
+      end
+
+      it "should not reset SimpleTemplater.scopes, so I can load local scope when I do local development" do
+        load File.join(SPEC_ROOT, "stubs", "simple-templater.scope")
+        SimpleTemplater.discover!(:test)
+        SimpleTemplater.scopes.should have_key(:local)
+      end
+    end
+
+    describe ".logger" do
+      it "should set default logger" do
+        [:info, :debug, :error, :fatal].each do |method|
+          SimpleTemplater.logger.should respond_to(method)
+        end
+      end
+    end
+  end
+end
+
+describe SimpleTemplater do
+  before(:each) do
+    @templater = SimpleTemplater.new(:test)
+  end
+
+  describe ".new" do
+    it "should set scope" do
+      @templater.scope.should eql(:test)
+    end
+  end
+
+  describe "#generators" do
+    it "should be empty hash if there are no generators" do
+      pending
+      @templater.generators.should be_empty
+      @templater.generators.should be_kind_of(Hash)
+    end
+
+    it "should be hash of {name: path}" do
+      pending "Add generators"
+      @templater.generators.should_not be_empty
+      @templater.generators.each do |name, path|
+        name.should be_kind_of(Symbol)
+        File.directory?(path).should be_true
+      end
+    end
+  end
+
+  describe "#discover!" do
+  end
+
+  describe "#register(name, path)" do
+    it "should raise GeneratorNotFound if path doesn't exist" do
+      -> { @templater.register(:test, "/a/b/c/d/whatever") }.should raise_error(SimpleTemplater::GeneratorNotFound)
+    end
+
+    it "should push values to the generators hash if the path exists" do
+      path = File.join(SPEC_ROOT, "stubs", "test_generator", "stubs", "test")
+      -> { @templater.register(:test, path) }.should change { @templater.generators.length }.by(1)
+    end
+  end
+
+  describe "#find(name)" do
+    it "should return generator with responding name" do
+      @templater.find(:test).should be_kind_of(SimpleTemplater::GeneratorSet)
+    end
+
+    it "should work with a string as well" do
+      @templater.find("test").should be_kind_of(SimpleTemplater::GeneratorSet)
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,5 @@
+--colour
+--format
+progress
+--loadby
+mtime

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+SPEC_ROOT = File.dirname(__FILE__)
+$:.unshift(File.expand_path(File.join(SPEC_ROOT, "..", "lib")))
+
+require "spec" # so you can run ruby spec/rango/whatever_spec.rb
+# require "fakefs" # TODO: makes some troubles with rubyexts
+
+module Spec
+  module Matchers
+    def match(expected)
+      Matcher.new :match, expected do |expected|
+        match do |actual|
+          actual.match(expected)
+        end
+      end
+    end
+  end
+end

data/spec/stubs/gems/gems/test_generator-0.0.1/simple-generator.scope

@@ -0,0 +1,8 @@
+SimpleTemplater.scope(:test) do
+  root = File.dirname(__FILE__)
+  Dir["#{root}/stubs/*"].each do |stub_dir|
+    if File.directory?(stub_dir)
+      SimpleTemplater.register(:test, stub_dir)
+    end
+  end
+end

data/spec/stubs/gems/gems/test_generator-0.0.1/simple-templater.scope

@@ -0,0 +1,8 @@
+SimpleTemplater.scope(:test) do
+  root = File.dirname(__FILE__)
+  Dir["#{root}/stubs/*"].each do |stub_dir|
+    if File.directory?(stub_dir)
+      SimpleTemplater.register(:test, File.basename(stub_dir), File.expand_path(stub_dir))
+    end
+  end
+end

data/spec/stubs/gems/gems/test_generator-0.0.1/stubs/content/%name%1_test.rb.rbt

@@ -0,0 +1 @@
+<%= %>

data/spec/stubs/gems/gems/test_generator-0.0.1/stubs/content/README.textile

@@ -0,0 +1,3 @@
+h1. About
+
+This is just a plain file, nothing there should change.

data/spec/stubs/gems/gems/test_generator-0.0.1/stubs/content/script.rb.rbt

@@ -0,0 +1 @@
+#!

data/spec/stubs/gems/gems/test_generator-0.0.1/stubs/test/content/%name%1_test.rb.rbt

@@ -0,0 +1 @@
+<%= %>

data/spec/stubs/gems/gems/test_generator-0.0.1/stubs/test/content/README.textile

@@ -0,0 +1,3 @@
+h1. About
+
+This is just a plain file, nothing there should change.

data/spec/stubs/gems/gems/test_generator-0.0.1/stubs/test/content/script.rb.rbt

@@ -0,0 +1 @@
+#!

data/spec/stubs/gems/gems/test_generator-0.0.1/test_generator.gemspec

@@ -0,0 +1,19 @@
+#!/usr/bin/env gem1.9 build
+# encoding: utf-8
+
+# Run thor package:gem or gem build simple-templater.gemspec
+# NOTE: we can't use require_relative because when we run gem build, it use eval for executing this file
+Gem::Specification.new do |s|
+  s.name = "test_generator"
+  s.version = "0.0.1"
+  s.authors = ["Jakub Šťastný aka Botanicus"]
+  s.homepage = "http://github.com/botanicus/simple-templater"
+  s.summary = "Just a stub for SimpleTemplater"
+  s.cert_chain = nil
+  s.email = ["knava.bestvinensis", "gmail.com"].join("@")
+  s.has_rdoc = true
+
+  # files
+  s.files = Dir.glob("**/*")
+  s.require_paths = ["lib"]
+end

data/spec/stubs/gems/specifications/test_generator-0.0.1.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{test_generator}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jakub Šťastný aka Botanicus"]
+  s.cert_chain = nil
+  s.date = %q{2009-11-18}
+  s.description = %q{}
+  s.email = %q{knava.bestvinensis@gmail.com}
+  s.files = ["simple-templater.scope", "stubs/test/content/%name%1_test.rb.rbt", "stubs/test/content/%name%_test.rb", "stubs/test/content/README.textile", "stubs/test/content/script.rb.rbt", "test_generator-0.0.1.gem", "test_generator.gemspec"]
+  s.homepage = %q{http://github.com/botanicus/simple-templater}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Just a stub for SimpleTemplater}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/stubs/simple-templater.scope

@@ -0,0 +1,8 @@
+SimpleTemplater.scope(:local) do
+  root = File.dirname(__FILE__)
+  Dir["#{root}/test_generator/stubs/*"].each do |stub_dir|
+    if File.directory?(stub_dir)
+      SimpleTemplater.register(:local, File.basename(stub_dir), File.expand_path(stub_dir))
+    end
+  end
+end

data/spec/stubs/test_generator/simple-templater.scope

@@ -0,0 +1,8 @@
+SimpleTemplater.scope(:test) do
+  root = File.dirname(__FILE__)
+  Dir["#{root}/stubs/*"].each do |stub_dir|
+    if File.directory?(stub_dir)
+      SimpleTemplater.register(:test, File.basename(stub_dir), File.expand_path(stub_dir))
+    end
+  end
+end

data/spec/stubs/test_generator/stubs/test/content/%name%1_test.rb.rbt

@@ -0,0 +1 @@
+<%= %>

data/spec/stubs/test_generator/stubs/test/content/README.textile

@@ -0,0 +1,3 @@
+h1. About
+
+This is just a plain file, nothing there should change.

data/spec/stubs/test_generator/stubs/test/content/script.rb.rbt

@@ -0,0 +1 @@
+#!

data/spec/stubs/test_generator/test_generator.gemspec

@@ -0,0 +1,19 @@
+#!/usr/bin/env gem1.9 build
+# encoding: utf-8
+
+# Run thor package:gem or gem build simple-templater.gemspec
+# NOTE: we can't use require_relative because when we run gem build, it use eval for executing this file
+Gem::Specification.new do |s|
+  s.name = "test_generator"
+  s.version = "0.0.1"
+  s.authors = ["Jakub Šťastný aka Botanicus"]
+  s.homepage = "http://github.com/botanicus/simple-templater"
+  s.summary = "Just a stub for SimpleTemplater"
+  s.cert_chain = nil
+  s.email = ["knava.bestvinensis", "gmail.com"].join("@")
+  s.has_rdoc = true
+
+  # files
+  s.files = Dir.glob("**/*")
+  s.require_paths = ["lib"]
+end

data/stubs/project/content/%name%.gemspec.rbt

@@ -0,0 +1,37 @@
+#!/usr/bin/env gem1.9 build
+# encoding: utf-8
+
+# Run ./<%= @name %>.gemspec or gem build <%= @name %>.gemspec
+# NOTE: we can't use require_relative because when we run gem build, it use eval for executing this file
+require File.join(File.dirname(__FILE__), "lib", "<%= @name %>")
+
+Gem::Specification.new do |s|
+  s.name = "<%= @name %>"
+  s.version = <%= @constant %>::VERSION
+  s.authors = ["<%= @name %>"]
+  s.homepage = "http://github.com/<%= @github_user %>/<%= @github_repository %>"
+  s.summary = "" # TODO: summary
+  s.description = "" # TODO: long description
+  s.cert_chain = nil
+  s.email = # TODO: your mail
+  s.has_rdoc = true
+
+  # files
+  s.files = Dir.glob("**/*") - Dir.glob("pkg/*")
+  s.executables = Dir["bin/*"].map { |script| File.basename(script) }
+  s.default_executable = "<%= @name %>"
+  s.require_paths = ["lib"]
+
+  # Ruby version
+  s.required_ruby_version = ::Gem::Requirement.new(">= 1.9.1")
+
+  # runtime dependencies
+  # s.add_dependency "rubyexts"
+
+  # development dependencies
+  # use gem install rango --development if you want to install them
+  # s.add_development_dependency "simple-templater"
+
+  # RubyForge
+  s.rubyforge_project = "<%= @name %>"
+end

data/stubs/project/content/CHANGELOG

@@ -0,0 +1,2 @@
+= Version 0.0.1
+  * 

data/stubs/project/content/LICENSE.rbt

@@ -0,0 +1,20 @@
+Copyright (c) <%= Time.now.year %> <%= @full_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/stubs/project/content/README.textile.rbt

@@ -0,0 +1,19 @@
+h1. About
+
+# TODO: write what your library is all about
+
+h1. Installation
+
+* Prerelease: @sudo gem install <%= @name %> --development --prerelease@
+* Stable version: @sudo gem install <%= @name %> --development@
+
+h1. Usage
+
+# TODO: write how to use your library
+
+h1. Links
+
+* "Source Code":http://github.com/<%= @github_user %>/<%= @github_repository %>
+* "Wiki":http://wiki.github.com/<%= @github_user %>/<%= @github_repository %>
+* "API Docs":http://rdoc.info/projects/<%= @github_user %>/<%= @github_repository %>
+* "Bug reporting":http://github.com/<%= @github_user %>/<%= @github_repository %>/issues

data/stubs/project/content/Rakefile

@@ -0,0 +1,39 @@
+#!/usr/bin/env rake1.9
+# encoding: utf-8
+
+# http://support.runcoderun.com/faqs/builds/how-do-i-run-rake-with-trace-enabled
+Rake.application.options.trace = true
+
+task :setup => ["submodules:init"]
+
+namespace :submodules do
+  desc "Init submodules"
+  task :init do
+    sh "git submodule init"
+  end
+
+  desc "Update submodules"
+  task :update do
+    Dir["vendor/*"].each do |path|
+      if File.directory?(path) && File.directory?(File.join(path, ".git"))
+        Dir.chdir(path) do
+          puts "=> #{path}"
+          puts %x[git clean -fd]
+          puts %x[git reset --hard]
+          puts %x[git checkout master]
+          puts %x[git fetch]
+          puts %x[git reset origin/master --hard]
+          puts
+        end
+      end
+    end
+  end
+end
+
+desc "Run specs"
+task :default => :setup do
+  rubylib = (ENV["RUBYLIB"] || String.new).split(":")
+  libdirs = Dir["vendor/*/lib"]
+  ENV["RUBYLIB"] = (libdirs + rubylib).join(":")
+  exec "./script/spec --options spec/spec.opts spec"
+end

data/stubs/project/content/bin/%name%.rbt

@@ -0,0 +1,14 @@
+<%= shebang %>
+# encoding: utf-8
+
+base   = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
+libdir = File.expand_path(File.join(File.dirname(base), "..", "lib"))
+
+# because of system installation, there is bin/../lib, but not bin/../lib/<%= @name %>
+if File.directory?(File.join(libdir, "<%= @name %>"))
+  $:.unshift(libdir) unless $:.include?(libdir)
+end
+
+require "<%= @name %>"
+
+# TODO: write the code

data/stubs/project/content/deps.rip

@@ -0,0 +1,5 @@
+#!/usr/bin/env rip install
+
+# Syntax:
+# repository [tag or commit to install]
+# git://github.com/botanicus/rubyexts.git

data/stubs/project/content/lib/%name%.rb.rbt

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module <%= @constant %>
+  VERSION ||= "0.0.1"
+end