MIT-LICENSE @@ -1,7 +1,8 @@ -./CHANGELOG -./LICENSE -./Manifest -./README -./Rakefile -./lib/echoe.rb -./test/test_echoe.rb +test/test_echoe.rb +lib/echoe.rb +Rakefile +README +Manifest +MIT-LICENSE +LICENSE +CHANGELOG Manifest @@ -1,98 +1,83 @@ + echoe - http://rubyforge.org/projects/fauna/ - Evan Weaver - -== DESCRIPTION: - -Echoe is a simple packaging tool for working with rubygems. It -generates all the usual tasks for projects including rdoc generation, -testing, packaging, and deployment. - -Tasks Provided: - -* announce - Generate email announcement file and post to rubyforge. -* audit - Run ZenTest against the package -* check_manifest - Verify the manifest -* clean - Clean up all the extras -* debug_gem - Show information about the gem. -* default - Run the default tasks -* docs - Build the docs HTML Files -* email - Generate email announcement file. -* install - Install the package. Uses PREFIX and RUBYLIB -* install_gem - Install the package as a gem -* multi - Run the test suite using multiruby -* package - Build all the packages -* post_news - Post announcement to rubyforge. -* publish_docs - Publish RDoc to RubyForge -* release - Package and upload the release to rubyforge. -* ridocs - Generate ri locally for testing -* test - Run the test suite. Use FILTER to add to the command line. -* test_deps - Show which test files fail when run alone. -* uninstall - Uninstall the package. - -First, see the Rakefile used to distribute Echoe itself. Also see the class rdoc for -help. - -== DIFFERENCES FROM HOE: - -* Removes unnecessary meta-dependency on self in created gems -* Better error reporting -* Can auto-generate the Manifest - -== FEATURES/PROBLEMS: - -* Provides 'echoe' command line tool for quick project directory creation. -* Make making and maintaining Rakefiles fun and easy. -== SYNOPSYS: +Echoe is a simple tool for working with rubygems. - % sow [group] project +== License -or +Copyright 2007 Cloudburst, LLC. See included LICENSE file. - require 'echoe' - - Echoe.new(projectname, version) do |p| - # ... project specific data ... - end +Portions copyright 2006 Ryan Davis, Zen Spider Software, and used with permission. See included MIT-LICENSE file. - # ... project specific tasks ... +== Description -== REQUIREMENTS: +Echoe is a simple tool for working with rubygems. It generates rake tasks for rdoc generation, testing, packaging, and deployment. + +== Requirements * rake -* rubyforge -* rubygems +* <tt>rubyforge</tt> gem +* <tt>highline</tt> gem + +== Installation + + sudo gem install echoe + +== Usage + +Organize your gem according to the usual package structure: + + lib/ + bin/ + ext/ + README + LICENSE + CHANGELOG + Rakefile + +Your <tt>CHANGELOG</tt> should be formatted as follows: + + v2.1. newest change + + v2. older change + + v1.9. oldest change + +etc. + +Your <tt>Rakefile</tt> needs the following minimal contents: + + require "rubygems" + require "echoe" + + Echoe.new("gem_name") + +Not kidding. + +== Available Rake tasks + +Once you have your <tt>Rakefile</tt> set up, you can run the following Rake tasks. -== INSTALL: +Packaging tasks: -* sudo gem install echoe +* <tt>build_manifest</tt> - Build a Manifest list. +* <tt>docs</tt> - Build the documentation. +* <tt>package</tt> - Build all the packages. -== LICENSE: +Testing tasks: -Copyright 2007 Evan Weaver. -Licensed under the Academic Free License 3.0. See LICENSE.txt, included. -The following license also applies to portions of the software: +* <tt>test</tt> - Run the test suite. +* <tt>install</tt> - Install the gem locally. +* <tt>uninstall</tt> - Uninstall the gem. -(The MIT License) +Upload tasks: -Copyright (c) 2006 Ryan Davis, Zen Spider Software +* <tt>publish_docs</tt> - Publish documentation to the web. +* <tt>release</tt> - Package and upload the release to Rubyforge. -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: +Cleaning tasks: -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. +* <tt>clean</tt> - Delete all the generated documentation and packages. +* <tt>redocs</tt> - Force a rebuild of the Rdoc files. +* <tt>repackage</tt> - Force a rebuild of the package files. -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. README @@ -10,6 +10,8 @@ require 'highline/import' gem 'rubyforge', '>= 0.4.0' require 'rubyforge' + + class Echoe rubyprefix = Config::CONFIG['prefix'] @@ -28,13 +30,21 @@ class Echoe FILTER = ENV['FILTER'] # for tests (eg FILTER="-n test_blah") # user-configurable - attr_accessor :author, :changes, :clean_pattern, :description, :email, :extra_deps, :name, :need_tar, :need_tar_gz, :need_zip, :rdoc_pattern, :rubyforge_name, :summary, :test_patterns, :url, :version, :docs_host, :rdoc_template + attr_accessor :author, :changes, :clean_pattern, :description, :email, :extra_deps, :name, :need_tar, :need_tar_gz, :need_zip, :rdoc_pattern, :rubyforge_name, :summary, :test_patterns, :url, :version, :docs_host, :rdoc_template, :manifest_name # best left alone attr_accessor :lib_files, :test_files, :bin_files, :spec def initialize(name, version = nil) + # Defaults + self.name = name + self.rubyforge_name = name.downcase + self.url = "" + self.author = "" + self.email = "" + self.clean_pattern = %w(diff diff.txt email.txt ri *.gem **/*~) + self.test_patterns = ['test/**/test_*.rb'] self.version = if version version @@ -44,25 +54,19 @@ class Echoe raise "No version supplied in Rakefile" end - # Defaults - self.rubyforge_name = name.downcase - self.url = "" - self.author = "" - self.email = "" - self.clean_pattern = %w(diff diff.txt email.txt ri *.gem **/*~) - self.test_patterns = ['test/**/test_*.rb'] - self.changes = if File.exist? "CHANGELOG" open("CHANGELOG").read[/^v([\d\.]+\. .*)/, 1] else "" end - + self.description = "" self.summary = "" - self.rdoc_pattern = /^(\.\/|)(lib|bin|tasks)|README|CHANGELOG|LICENSE|txt$/ + self.rdoc_pattern = /^(lib|bin|tasks)|README|CHANGELOG|LICENSE|txt$/ self.extra_deps = [] - self.need_tar = false + self.manifest_name = "Manifest" + + self.need_tar = false self.need_tar_gz = true self.need_zip = false @@ -72,10 +76,9 @@ class Echoe end def define_tasks - desc 'Run the default tasks' task :default => :test - desc 'Run the test suite. Use FILTER to add to the command line.' + desc 'Run the test suite' task :test do run_tests end @@ -99,11 +102,10 @@ class Echoe s.add_dependency(*dep) end - manifest = File.exist?('Manifest.txt') ? 'Manifest.txt' : 'Manifest' begin - s.files = File.read(manifest).split + s.files = File.read(manifest_name).split rescue Errno::ENOENT - $stderr.puts "Missing Manifest. You can build one with\n$ rake build_manifest" + $stderr.puts "Missing Manifest. You can build one with\n$ rake build_manifest." end s.executables = s.files.grep(/bin/) { |f| File.basename(f) } @@ -120,11 +122,6 @@ class Echoe end - desc 'Show information about the gem.' - task :debug_gem do - puts spec.to_ruby - end - self.lib_files = spec.files.grep(/^lib/) self.bin_files = spec.files.grep(/^bin/) self.test_files = spec.files.grep(/^test/) @@ -135,22 +132,17 @@ class Echoe pkg.need_zip = @need_zip end - desc 'Install the package as a gem' + desc 'Install the gem' task :install => [:clean, :package] do sh "sudo gem install pkg/*.gem" end - desc 'Uninstall the package.' + desc 'Uninstall the gem' task :uninstall do - Dir.chdir RUBYLIB do - rm_f((lib_files + test_files).map { |f| File.basename f }) - end - Dir.chdir File.join(PREFIX, 'bin') do - rm_f bin_files.map { |f| File.basename f } - end + sh "sudo gem uninstall #{name}" end - desc 'Package and upload the release to Rubyforge.' + desc 'Package and upload the release to Rubyforge' task :release => [:clean, :package] do |t| say "\n" @@ -180,27 +172,18 @@ class Echoe begin rf.add_release rubyforge_name, name, version, *files - rescue NoMethodError => boom - # be silent + rescue NoMethodError end end end - ############################################################ - # Doco - Rake::RDocTask.new(:docs) do |rd| rd.main = Dir['*'].detect {|f| f =~ /^readme/i} - rd.options << '-d' if RUBY_PLATFORM !~ /win32/ and `which dot` =~ /\/dot/ rd.options << '--line-numbers' << '--inline-source' rd.rdoc_dir = 'doc' - files = spec.files.grep(rdoc_pattern) - files -= ['Manifest.txt', 'Manifest'] - files.uniq! - - #puts "Rdoc files are:\n#{files.map{|s| ' ' + s + "\n"}}" - + + files = (spec.files.grep(rdoc_pattern) - [manifest_name]).uniq rd.rdoc_files.push *files if rdoc_template @@ -209,16 +192,11 @@ class Echoe rd.template = ENV['RDOC_TEMPLATE'] end - title = name.capitalize if name.downcase == name + title = name.downcase == name ? name.capitalize : name rd.options << "-t #{title}" end - desc "Generate ri locally for testing" - task :ridocs => :clean do - sh %q{ rdoc --ri -o ri . } - end - - desc 'Publish RDoc to RubyForge' + desc "Publish documentation to #{docs_host ? "'#{docs_host}'" : "rubyforge"}" task :publish_docs => [:clean, :docs] do local_dir = 'doc' @@ -245,18 +223,14 @@ class Echoe # you may need ssh keys configured for this to work host, dir = docs_host.split(":") dir.chomp!("/") - sh("ssh #{host} 'rm -rf #{dir}/#{remote_dir_name}'") # XXX too dangerous + sh("ssh #{host} 'rm -rf #{dir}/#{remote_dir_name}'") # XXX too dangerous? sh("scp -qr #{local_dir} #{host}:#{dir}/#{remote_dir_name}") end end - - + task :doc => [:docs] - ############################################################ - # Misc/Maintenance: - - desc 'Clean up all the extras' + desc 'Delete the generated documentation and packages' task :clean => [ :clobber_docs, :clobber_package ] do clean_pattern.each do |pattern| files = Dir[pattern] @@ -264,54 +238,29 @@ class Echoe end end - desc "Verify the manifest" - task :check_manifest => :clean do - f = "Manifest.tmp" - require 'find' - files = [] - Find.find '.' do |path| - next unless File.file? path - next if path =~ /svn|tmp$/ - files << path[2..-1] - end - files = files.sort.join "\n" - File.open f, 'w' do |fp| fp.puts files end - - manifest = "Manifest" - manifest += ".txt" if File.exist? "Manifest.txt" - - system "diff -du #{manifest}.txt #{f}" - rm f - end - - desc "Build a Manifest from your current tree" + desc "Build a Manifest list" task :build_manifest do files = [] - find_files = proc { |dir| - Dir["#{dir}/**"].each do |file| - next if ["#{dir}/pkg", "#{dir}/doc"].include? file - File.directory?(file) ? find_files[file] : files << file + Find.find '.' do |file| + file = file[2..-1] + unless !file or file =~ /^(pkg|doc)|\.svn|CVS|\.bzr/ or File.directory? file + files << file end - } - manifest = File.exist?("./Manifest.txt") ? "./Manifest.txt" : "./Manifest" - find_files['.'] - files = (files << manifest).uniq - File.open(manifest, 'w').puts files + end + files = (files << manifest_name).uniq + File.open(manifest_name, 'w').puts files puts files end - end # end define - - def run_tests(multi=false) # :nodoc: - msg = multi ? :sh : :ruby - cmd = if test ?f, 'test/test_all.rb' then - "#{RUBY_FLAGS} test/test_all.rb #{FILTER}" - else - tests = test_patterns.map { |g| Dir.glob(g) }.flatten << 'test/unit' - tests.map! {|f| %Q(require "#{f}")} - "#{RUBY_FLAGS} -e '#{tests.join("; ")}' #{FILTER}" - end - cmd = "multiruby #{cmd}" if multi - send msg, cmd + end + + def run_tests # :nodoc: + ruby(if File.exist? 'test/test_all.rb' + "#{RUBY_FLAGS} test/test_all.rb #{FILTER}" + else + tests = test_patterns.map { |g| Dir.glob(g) }.flatten << 'test/unit' + tests.map! {|f| %Q(require "#{f}")} + "#{RUBY_FLAGS} -e '#{tests.join("; ")}' #{FILTER}" + end) end end @@ -319,8 +268,3 @@ end class ::Rake::SshDirPublisher # :nodoc: attr_reader :host, :remote_dir, :local_dir end - -if $0 == __FILE__ then - out = `rake -T | egrep -v "redocs|repackage|clobber|trunk"` - puts out.gsub(/\#/, '-').gsub(/^rake /, '# * ') -end lib/echoe.rb 0b2ca4c525b0ba39fc8efe9b6a14eba0e5f374a3 Evan Weaver evan@cloudbur.st http://github.com/fauna/echoe/commit/477de61fbe42e1a70c04b61df47a63bc399daf83 477de61fbe42e1a70c04b61df47a63bc399daf83 2007-08-02T21:33:24-07:00 2007-08-02T21:33:24-07:00 readme 77e601a877a265cef3e8a8190a5a2c377dd9738c Evan Weaver evan@cloudbur.st