wtnabe-shlauncher 0.0.1

data/ChangeLog

@@ -0,0 +1,4 @@
+== 0.0.1 / 2009-08-27
+
+* initial release
+

data/README.doc

@@ -0,0 +1,62 @@
+
+= Shlauncher - A shell script launcher
+
+Scaffold your custom launcher. Launch from your shell script ( and also Ruby script ) collection.
+
+== Installation
+
+=== Archive Installation
+
+ rake install
+
+=== Gem Installation
+
+ gem install wtnabe-shlauncher
+
+== Features/Problems
+
+* scaffold launcher  ( by `tractor' command )
+* collect scripts in script/ directory and list up as task
+* exec all tasks in some scope
+* generate gem
+
+== Synopsis
+
+Scaffold your launcher.
+
+ $ tractor LAUNCHER_NAME
+
+Put your script into script/ directory and make executable.
+
+ $ cd LAUNCHER_NAME
+ $ ./bin/LAUNCHER_NAME
+ $ echo '# script sample' > script/sample
+ $ chmod a+x script/sample
+
+Run your launcher.
+
+ $ ./bin/LAUNCHER_NAME
+
+ LAUNCHER_NAME sample  # script sample
+
+Generate gem from your launcher.
+
+ $ rake gem
+ $ ls pkg
+
+ LAUNCHER_NAME-0.0.1.gem 
+
+== Thanks
+
+`Cutagem' inspires and be helpful to this product.
+
+* http://github.com/genki/cutagem/tree/master
+* http://cutagem.rubyforge.org/
+
+Thank you, cho45 and genki !
+
+== Copyright
+
+Author::    wtnabe <wtnabe@gmail.com>
+Copyright:: Copyright (c) 2009 wtnabe
+License::   Two-claused BSD

data/Rakefile

@@ -0,0 +1,147 @@
+# -*- mode: ruby -*-
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rake/contrib/sshpublisher'
+require 'fileutils'
+require 'lib/tractor'
+require 'template/lib/shlauncher'
+include FileUtils
+
+NAME              = "shlauncher"
+AUTHOR            = "wtnabe"
+EMAIL             = "wtnabe@gmail.com"
+DESCRIPTION       = "A shell script launcher"
+RUBYFORGE_PROJECT = ""
+HOMEPATH          = ""
+BIN_FILES         = %w( tractor )
+
+VERS              = Shlauncher_Tractor::VERSION
+REV = File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = [
+	'--title', "#{NAME} documentation",
+	"--charset", "utf-8",
+	"--opname", "index.html",
+	"--line-numbers",
+	"--main", "README.doc",
+	"--inline-source",
+]
+
+task :default => [:test]
+task :package => [:clean]
+
+Rake::TestTask.new("test") do |t|
+	t.libs   << "test"
+	t.pattern = "test/**/*_test.rb"
+	t.verbose = true
+end
+
+spec = Gem::Specification.new do |s|
+	s.name              = NAME
+	s.version           = VERS
+	s.platform          = Gem::Platform::RUBY
+	s.has_rdoc          = true
+	s.extra_rdoc_files  = ["README.doc", "ChangeLog"]
+	s.rdoc_options     += RDOC_OPTS + ['--exclude', '^(examples|extras)/']
+	s.summary           = "Scaffold your custom launcher. Launch from your shell script ( and also Ruby script ) collection."
+	s.description       = DESCRIPTION
+	s.author            = AUTHOR
+	s.email             = EMAIL
+	s.homepage          = HOMEPATH
+	s.executables       = BIN_FILES
+	s.rubyforge_project = RUBYFORGE_PROJECT
+	s.bindir            = "bin"
+	s.require_path      = "lib"
+	#s.autorequire       = ""
+	s.test_files        = Dir["test/*_test.rb"]
+
+	s.add_dependency('rake', '>= 0')
+	#s.required_ruby_version = '>= 1.8.2'
+
+	s.files = %w(README.doc ChangeLog Rakefile) +
+		Dir.glob("{bin,doc,test,lib,templates,generator,extras,website,script}/**/*") + 
+		Dir.glob("ext/**/*.{h,c,rb}") +
+		Dir.glob("examples/**/*.rb") +
+		Dir.glob("tools/*.rb") +
+		Dir.glob("rails/*.rb")
+
+	s.extensions = FileList["ext/**/extconf.rb"].to_a
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+	p.need_tar = true
+	p.gem_spec = spec
+end
+
+task :install do
+	name = "#{NAME}-#{VERS}.gem"
+	sh %{rake package}
+	sh %{sudo gem install pkg/#{name}}
+end
+
+task :uninstall => [:clean] do
+	sh %{sudo gem uninstall #{NAME}}
+end
+
+
+Rake::RDocTask.new do |rdoc|
+	rdoc.rdoc_dir = 'html'
+	rdoc.options += RDOC_OPTS
+	rdoc.template = "resh"
+	#rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+	if ENV['DOC_FILES']
+		rdoc.rdoc_files.include(ENV['DOC_FILES'].split(/,\s*/))
+	else
+		rdoc.rdoc_files.include('README.doc', 'ChangeLog')
+		rdoc.rdoc_files.include('lib/**/*.rb')
+		rdoc.rdoc_files.include('ext/**/*.c')
+	end
+end
+
+desc "Publish to RubyForge"
+task :rubyforge => [:rdoc, :package] do
+	require 'rubyforge'
+	Rake::RubyForgePublisher.new(RUBYFORGE_PROJECT, 'watanabe').upload
+end
+
+desc 'Package and upload the release to rubyforge.'
+task :release => [:clean, :package] do |t|
+	v = ENV["VERSION"] or abort "Must supply VERSION=x.y.z"
+	abort "Versions don't match #{v} vs #{VERS}" unless v == VERS
+	pkg = "pkg/#{NAME}-#{VERS}"
+
+	require 'rubyforge'
+	rf = RubyForge.new.configure
+	puts "Logging in"
+	rf.login
+
+	c = rf.userconfig
+#	c["release_notes"] = description if description
+#	c["release_changes"] = changes if changes
+	c["preformatted"] = true
+
+	files = [
+		"#{pkg}.tgz",
+		"#{pkg}.gem"
+	].compact
+
+	puts "Releasing #{NAME} v. #{VERS}"
+	rf.add_release RUBYFORGE_PROJECT, NAME, VERS, *files
+end
+
+desc 'Show information about the gem.'
+task :debug_gem do
+	puts spec.to_ruby
+end
+
+desc 'Update gem spec'
+task :gemspec do
+  open("#{NAME}.gemspec", 'w').write spec.to_ruby
+end

data/bin/shlauncher_test

@@ -0,0 +1,20 @@
+#! /usr/bin/env rake -f
+# -*- mode: ruby; coding: utf-8 -*-
+
+require File.dirname( __FILE__ ) + '/../template/lib/shlauncher'
+
+launcher = Shlauncher.new( File.dirname( __FILE__ ) + '/../test/script' )
+
+launcher.tasks.each { |t|
+  desc launcher.desc( t )
+  task t do
+    launcher.launch( t )
+  end
+}
+
+task :default do
+  app = Rake.application
+  app.name = File.basename( __FILE__ )
+  app.options.show_task_pattern = Regexp.new('')
+  app.display_tasks_and_comments
+end

data/bin/tractor

@@ -0,0 +1,5 @@
+#! /usr/bin/env ruby
+
+require File.dirname( __FILE__ ) + '/../lib/tractor'
+
+Shlauncher_Tractor.new(ARGV).run

data/lib/tractor.rb

@@ -0,0 +1,87 @@
+# -*- mode: ruby; coding: utf-8 -*-
+
+require 'optparse'
+require 'fileutils'
+require 'erb'
+
+class Shlauncher_Tractor
+  VERSION = "0.0.1"
+
+  include FileUtils::Verbose
+
+  def initialize( argv )
+    @argv        = argv
+    @launcher    = nil
+    @email       = nil
+    @author      = nil
+    @description = nil
+  end
+  attr_reader :launcher, :email, :author, :description
+
+  def run
+    @launcher = parse_args
+    if ( File.exist?( launcher_dir ) )
+      puts "'#{launcher}' directory already existed."
+    else
+      deploy_template
+      rewrite_template
+    end
+  end
+
+  def launcher_dir
+    return File.join( Dir.pwd, launcher )
+  end
+
+  def deploy_template
+    cp_r( File.expand_path( File.dirname( __FILE__ ) + '/../template/' ),
+          launcher_dir )
+    Dir.chdir( launcher_dir ) {
+      mkdir( 'script' )
+      mv( 'bin/shlauncher', "bin/#{launcher}" )
+    }
+  end
+
+  def rewrite_template
+    Dir.chdir( launcher_dir ) {
+      %w( Rakefile Changelog README ).each { |file|
+        open( file, 'r+' ) { |f|
+          erb = ERB.new( f.read )
+          f.rewind
+          f.truncate( 0 )
+          f.puts erb.result( binding )
+        }
+        puts "rewrited #{file}"
+      }
+    }
+  end
+
+  def parse_args
+    app = File.basename( $0 )
+    opt = OptionParser.new { |parser|
+      parser.version = VERSION
+      parser.banner  =<<EOD
+#{app} #{VERSION}
+
+Usage: #{app} LAUNCHER_NAME
+EOD
+      parser.on( '-e', '--email ADDR' ) { |email|
+        @email = email
+      }
+      parser.on( '-a', '--author NAME' ) { |author|
+        @author = author
+      }
+      parser.on( '-d', '--description DESC' ) { |desc|
+        @description = desc
+      }
+    }
+
+    rest_args = opt.parse!( @argv )
+    if ( rest_args.size > 0 )
+      return rest_args.first
+    else
+      puts opt.help
+      exit
+    end
+  end
+
+end

data/test/script/example

@@ -0,0 +1,12 @@
+#! /bin/sh
+# -*- mode: sh -*-
+
+#
+# just example
+# 
+# Usage: example
+#
+
+echo "foo"
+
+# thx

data/test/script/foo/bar

@@ -0,0 +1,5 @@
+#! /bin/sh
+
+# desc is here
+
+echo "bar"

data/test/script/foo/baz

@@ -0,0 +1,5 @@
+#! /bin/sh
+
+# null script
+
+echo "baz"

data/test/shlauncher_test.rb

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+
+require "test/unit"
+require File.dirname(__FILE__) + '/../template/lib/shlauncher'
+
+class ShlauncherTest < Test::Unit::TestCase
+  def setup
+    @obj = Shlauncher.new( File.dirname( __FILE__ ) + '/script' )
+  end
+
+  def test_tasks
+    assert( @obj.tasks == %w( example foo foo:bar foo:baz ) )
+  end
+
+  def test_commands_ignored
+    assert( %w( example~ example.bak ) )
+  end
+
+  def test_desc
+    assert( @obj.desc( 'example' ) == 'just example, Usage: example' )
+  end
+
+  def test_command_path
+    assert( @obj.command_path( 'abc' ) == 'abc' )
+    assert( @obj.command_path( 'foo:bar' ) == 'foo/bar' )
+    assert( @obj.command_path( 'foo/bar' ) == 'foo/bar' )
+  end
+
+  def test_task
+    assert( @obj.task( 'abc' ) == 'abc' )
+    assert( @obj.task( 'foo/bar' ) == 'foo:bar' )
+    assert( @obj.task( 'foo//bar' ) == 'foo::bar' )
+    assert( @obj.task( 'foo:bar' ) == 'foo:bar' )
+  end
+
+  def test_script_path
+    assert( @obj.script_path == File.expand_path( File.dirname( __FILE__ ) ) + '/script' )
+  end
+
+  def test_shebang_or_localvar_line?
+    assert( @obj.shebang_or_localvar_line?( '#! /bin/sh' ) )
+    assert( @obj.shebang_or_localvar_line?( '# -*- mode: ruby -*-' ) )
+    assert( @obj.shebang_or_localvar_line?( '# -*- coding: utf-8 -*-' ) )
+    assert( !@obj.shebang_or_localvar_line?( 'abc' ) )
+    assert( !@obj.shebang_or_localvar_line?( '# regular comment' ) )
+  end
+
+  def test_empty_line?
+    assert( @obj.empty_line?( '' ) )
+    assert( @obj.empty_line?( ' ' ) )
+    assert( !@obj.empty_line?( '#' ) )
+  end
+
+  def test_not_comment_line?
+    assert( @obj.not_comment_line?( 'abc' ) )
+    assert( !@obj.not_comment_line?( '  #  ' ) )
+    assert( !@obj.not_comment_line?( '#   ' ) )
+  end
+end

data/test/tractor_test.rb

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+
+require "test/unit"
+require File.dirname(__FILE__) + '/../lib/tractor'
+
+class Shlauncher_TractorTest < Test::Unit::TestCase
+  def test_Shlauncher_Tractor
+    assert( true )
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: wtnabe-shlauncher
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- wtnabe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-27 00:00:00 -07:00
+default_executable: tractor
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A shell script launcher
+email: wtnabe@gmail.com
+executables: 
+- tractor
+extensions: []
+
+extra_rdoc_files: 
+- README.doc
+- ChangeLog
+files: 
+- README.doc
+- ChangeLog
+- Rakefile
+- bin/shlauncher_test
+- bin/tractor
+- test/script
+- test/script/example
+- test/script/foo
+- test/script/foo/bar
+- test/script/foo/baz
+- test/script/README
+- test/shlauncher_test.rb
+- test/tractor_test.rb
+- lib/tractor.rb
+has_rdoc: false
+homepage: ""
+post_install_message: 
+rdoc_options: 
+- --title
+- shlauncher documentation
+- --charset
+- utf-8
+- --opname
+- index.html
+- --line-numbers
+- --main
+- README.doc
+- --inline-source
+- --exclude
+- ^(examples|extras)/
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: ""
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Scaffold your custom launcher. Launch from your shell script ( and also Ruby script ) collection.
+test_files: 
+- test/shlauncher_test.rb
+- test/tractor_test.rb