echoe 4.3.1 → 4.4

data/CHANGELOG

@@ -1,4 +1,6 @@
-v4.3.1. Don't stop if gemcutter's plugin cannot be loaded, don't define RSpec tasks if RSpec is not present (Flameeyes). Use Dir.tmpdir. 
+v4.4. Use GitHub for default url and documentation hosting.
+
+v4.3.1. Don't stop if gemcutter's plugin cannot be loaded, don't define RSpec tasks if RSpec is not present (Flameeyes). Use Dir.tmpdir.
 
 v4.3. Don't use sudo if the GEM_HOME is local. Support prerelease gem versions.
 

data/Rakefile

@@ -5,8 +5,6 @@ Echoe.new('echoe') do |p|
   p.project = 'fauna'
   p.author = 'Evan Weaver'
   p.summary = 'A Rubygems packaging tool that provides Rake tasks for documentation, extension compiling, testing, and deployment.'
-  p.url = 'http://blog.evanweaver.com/files/doc/fauna/echoe/'
-  p.docs_host = 'blog.evanweaver.com:~/www/bax/public/files/doc/'
   p.runtime_dependencies = ['gemcutter', 'rubyforge']
   p.development_dependencies = []
   p.retain_gemspec = true

data/echoe.gemspec

@@ -2,21 +2,21 @@
 
 Gem::Specification.new do |s|
   s.name = %q{echoe}
-  s.version = "4.3.1"
+  s.version = "4.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Evan Weaver"]
   s.cert_chain = ["/Users/eweaver/p/configuration/gem_certificates/evan_weaver-original-public_cert.pem"]
-  s.date = %q{2010-05-01}
+  s.date = %q{2011-02-22}
   s.description = %q{A Rubygems packaging tool that provides Rake tasks for documentation, extension compiling, testing, and deployment.}
   s.email = %q{}
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "TODO", "lib/echoe.rb", "lib/echoe/extensions.rb", "lib/echoe/platform.rb", "lib/echoe/rubygems.rb"]
   s.files = ["CHANGELOG", "LICENSE", "MIT-LICENSE", "Manifest", "README", "Rakefile", "TODO", "echoe.gemspec", "lib/echoe.rb", "lib/echoe/extensions.rb", "lib/echoe/platform.rb", "lib/echoe/rubygems.rb", "vendor/rake/MIT-LICENSE", "vendor/rake/lib/rake/contrib/compositepublisher.rb", "vendor/rake/lib/rake/contrib/ftptools.rb", "vendor/rake/lib/rake/contrib/publisher.rb", "vendor/rake/lib/rake/contrib/rubyforgepublisher.rb", "vendor/rake/lib/rake/contrib/sshpublisher.rb", "vendor/rake/lib/rake/contrib/sys.rb"]
-  s.homepage = %q{http://blog.evanweaver.com/files/doc/fauna/echoe/}
+  s.homepage = %q{http://fauna.github.com/echoe/}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Echoe", "--main", "README"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{fauna}
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.signing_key = %q{/Users/eweaver/p/configuration/gem_certificates/evan_weaver-original-private_key.pem}
   s.summary = %q{A Rubygems packaging tool that provides Rake tasks for documentation, extension compiling, testing, and deployment.}
 
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<gemcutter>, [">= 0"])
       s.add_runtime_dependency(%q<rubyforge>, [">= 0"])
     else

data/lib/echoe.rb

@@ -14,6 +14,7 @@ rescue LoadError
 end
 require 'rbconfig'
 require 'open-uri'
+require 'tmpdir'
 
 require "#{$HERE}/echoe/extensions"
 
@@ -43,8 +44,6 @@ For example, a simple <tt>Rakefile</tt> might look like this:
   Echoe.new("uncapitalizer") do |p|
     p.author = "Evan Weaver"
     p.summary = "A library that uncapitalizes strings."
-    p.url = "http://www.uncapitalizer.com"
-    p.docs_host = "uncapitalizer.com:~/www/files/doc/"
     p.runtime_dependencies = ["string_tools >=1.4.0"]
   end
 
@@ -96,7 +95,7 @@ Descriptive options:
 * <tt>email</tt> - Your email address.
 * <tt>description</tt> - A more detailed description of the library.
 * <tt>summary</tt> - A shorter description of the library.
-* <tt>url</tt> - A url for the library.
+* <tt>url</tt> - A url for the library. Defaults to generated RDoc on GitHub pages for the project.f
 * <tt>install_message</tt> - A message to display after the gem is installed.
 
 Versioning options:
@@ -142,7 +141,7 @@ Security options:
 Publishing options:
 
 * <tt>project</tt> - The name of the Rubyforge project. Defaults to the name of the gem.
-* <tt>docs_host</tt> - A host and filesystem path to publish the documentation to. Defaults to the Rubyforge project.
+* <tt>docs_host</tt> - A host and filesystem path to publish the documentation to. Defaults to GitHub pages for the project. SSH upload to an accessible static file host also works.
 
 Documentation options:
 
@@ -168,15 +167,14 @@ class Echoe
     self.name = name
     self.project = name.downcase
     self.changelog = "CHANGELOG"
-    self.url = ""
     self.author = ""
     self.email = ""
     self.clean_pattern = ["pkg", "doc", 'build/*', '**/coverage', '**/*.o', '**/*.so', '**/*.a', '**/*.log', "{ext,lib}/*.{bundle,so,obj,pdb,lib,def,exp}", "ext/Makefile", "{ext,lib}/**/*.{bundle,so,obj,pdb,lib,def,exp}", "ext/**/Makefile", "pkg", "*.gem", ".config"]
     self.test_pattern = File.exist?("test/test_all.rb") ? "test/test_all.rb" : ['test/**/test_*.rb', 'test/**/*_test.rb']
     self.spec_pattern = "spec/**/*_spec.rb"
-    
+
     self.ignore_pattern = /^(pkg|doc)|\.svn|CVS|\.bzr|\.DS|\.git/
-    
+
     self.changelog_patterns = {
         :version => [
             /^\s*v([\d\w\.]+)(\.|\s|$)/,
@@ -230,6 +228,11 @@ class Echoe
 
     yield self if block_given?
 
+    self.docs_host ||= "git@github.com:#{self.project}/#{self.project}.github.com"
+    if self.docs_host =~ /git@github.com/
+      self.url ||= "http://#{self.project}.github.com/#{(self.name + '/') if project != name}"
+    end
+
     # legacy compatibility
     self.runtime_dependencies = dependencies if dependencies and runtime_dependencies.empty?
     self.runtime_dependencies = extra_deps if extra_deps and runtime_dependencies.empty?
@@ -287,10 +290,10 @@ class Echoe
     self.summary = description if summary.empty?
     self.clean_pattern = apply_pattern(clean_pattern)
     self.extension_pattern = apply_pattern(extension_pattern, files)
-    
+
     self.ignore_pattern = apply_pattern(ignore_pattern)
     honor_gitignore! if File.exist?(".git")
-    
+
     self.rdoc_pattern = apply_pattern(rdoc_pattern, files) - [manifest_name]
     self.executable_pattern = apply_pattern(executable_pattern, files)
     self.test_pattern = apply_pattern(test_pattern)
@@ -298,22 +301,22 @@ class Echoe
 
     define_tasks
   end
-  
+
 private
   def honor_gitignore!
     self.ignore_pattern += \
-      Dir["**/.gitignore"].inject([]) do |pattern,gitignore| 
+      Dir["**/.gitignore"].inject([]) do |pattern,gitignore|
         pattern.concat \
           File.readlines(gitignore).
             map    { |line| line.strip }.
             reject { |line| "" == line }.
-            map    { |glob| 
+            map    { |glob|
               d = File.dirname(gitignore)
               d == "." ? glob : File.join(d, glob)
             }
       end.flatten.uniq
   end
-  
+
   def apply_pattern(pattern, files = nil)
     files ||= Dir['**/**']
     case pattern
@@ -416,25 +419,25 @@ private
       pkg.need_tar_gz = @need_tar_gz
       pkg.need_zip = @need_zip
     end
-    
+
     desc "Display Echoe's knowledge of your system"
     task :details do
       (self.instance_variables.sort - ['@spec']).each do |var|
         puts "#{var}: #{instance_variable_get(var).inspect}"
       end
     end
-    
+
     desc "Builds the .gemspec"
     task :build_gemspec do
       # Construct the gemspec file, if needed.
       if include_gemspec
-        File.open(gemspec_name, 'w') do |f|          
+        File.open(gemspec_name, 'w') do |f|
           case gemspec_format
           when :yaml
             spec.to_yaml.split("\n").each do |line|
               # Don't publish any information about the private key or certificate chain
               f.puts line unless line =~ /signing_key|cert_chain|\.pem/
-            end          
+            end
           when :ruby
             f.puts spec.to_ruby
           else
@@ -497,7 +500,7 @@ private
       pkg_tar = pkg + ".tgz"
       pkg_tar_gz = pkg + ".tar.gz"
       pkg_zip = pkg + ".zip"
-      
+
       puts "Releasing #{name} v. #{version}  to Gemcutter."
       system("gem push #{pkg_gem.inspect}")
     end
@@ -559,33 +562,43 @@ private
 
     task :doc => [:redocs]
 
-    desc "Publish documentation to #{docs_host ? "'#{docs_host}'" : "rubyforge"}"
+    desc "Publish documentation to the internet."
     task :publish_docs => [:clean, :docs] do
 
-      local_dir = 'doc'
-      remote_dir_name = project
-      remote_dir_name += "/#{name}" if project != name
-
-      unless docs_host
-        config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
-        pub = Rake::SshDirPublisher.new "#{config["username"]}@rubyforge.org",
-          "/var/www/gforge-projects/#{remote_dir_name}",
-          local_dir
-        if project != name then
-          def pub.upload
-            begin
-              super
-            rescue
-              # project directory probably doesn't exist, transfer as a whole
-              cmd = "scp -qr #{local_dir} #{host}:#{remote_dir}"
-              puts "Uploading: #{cmd}"
+      local_dir = File.expand_path('doc')
+
+      if docs_host =~ /git@github.com/
+        Dir.mktmpdir do |dir|
+          Dir.chdir(dir) do
+            puts "Working in: #{dir}"
+            cmd = "git clone #{docs_host}"
+            puts "Cloning existing docs: #{cmd}"
+            system(cmd)
+
+            repository_name = docs_host.split("/").last
+            Dir.chdir(repository_name) do
+              project_dir_name = project
+              project_dir_name += "/#{name}" if project != name
+              Dir.mkdir(name) rescue nil
+
+              cmd = "rm -rf '#{project_dir_name}' && mv #{local_dir} '#{project_dir_name}'"
+              puts("Moving docs into checkout: #{cmd}")
+              system(cmd)
+
+              cmd = "git add '#{project_dir_name}' && git commit -a -m 'Update documentation for #{name} #{version}'"
+              puts "Committing changes: #{cmd}"
+              system(cmd)
+
+              cmd = "git push"
+              puts "Pushing changes: #{cmd}"
               system(cmd)
             end
           end
         end
-        pub.upload
       else
         # you may need ssh keys configured for this to work
+        remote_dir_name = project
+        remote_dir_name += "/#{name}" if project != name
         host, dir = docs_host.split(":")
         dir.chomp!("/")
 
@@ -605,11 +618,11 @@ private
 
       filename = "#{Dir.tmpdir}/#{name}_#{version}_announcement.txt"
 
-      if File.exist?(filename) 
-        puts "Announcement file already exists. Please delete #{filename.inspect} first."        
+      if File.exist?(filename)
+        puts "Announcement file already exists. Please delete #{filename.inspect} first."
         exit(1)
       end
-      
+
       File.open(filename, 'w') do |f|
         f.write "Subject: #{name.capitalize} #{version}\n\n"
         f.write "#{name.capitalize} has been updated to #{version}. #{name.capitalize} is #{summary.uncapitalize}\n\n"

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: echoe
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: false
   segments: 
   - 4
-  - 3
-  - 1
-  version: 4.3.1
+  - 4
+  version: "4.4"
 platform: ruby
 authors: 
 - Evan Weaver
@@ -35,16 +35,18 @@ cert_chain:
   yZ0=
   -----END CERTIFICATE-----
 
-date: 2010-05-01 00:00:00 -07:00
+date: 2011-02-22 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: gemcutter
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -54,9 +56,11 @@ dependencies:
   name: rubyforge
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -98,7 +102,7 @@ files:
 - vendor/rake/lib/rake/contrib/sshpublisher.rb
 - vendor/rake/lib/rake/contrib/sys.rb
 has_rdoc: true
-homepage: http://blog.evanweaver.com/files/doc/fauna/echoe/
+homepage: http://fauna.github.com/echoe/
 licenses: []
 
 post_install_message: 
@@ -112,16 +116,20 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 11
       segments: 
       - 1
       - 2
@@ -129,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: fauna
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A Rubygems packaging tool that provides Rake tasks for documentation, extension compiling, testing, and deployment.