readorder 1.0.0

data/tasks/config.rb

@@ -0,0 +1,107 @@
+require 'configuration'
+
+require 'rake'
+require 'tasks/utils'
+
+#-----------------------------------------------------------------------
+# General project configuration
+#-----------------------------------------------------------------------
+Configuration.for('project') {
+  name          "readorder"
+  version       Readorder::Version.to_s 
+  author        "Jeremy Hinegardner"
+  email         "jeremy@copiousfreetime.org"
+  homepage      "http://copiousfreetime.rubyforge.org/readorder"
+  description   Utils.section_of("README", "description")
+  summary       description.split(".").first
+  history       "HISTORY"
+  license       FileList["LICENSE"]
+  readme        "README"
+}
+
+#-----------------------------------------------------------------------
+# Packaging 
+#-----------------------------------------------------------------------
+Configuration.for('packaging') {
+  # files in the project 
+  proj_conf = Configuration.for('project')
+  files {
+    bin       FileList["bin/*"]
+    ext       FileList["ext/*.{c,h,rb}"]
+    lib       FileList["lib/**/*.rb"]
+    test      FileList["spec/**/*.rb", "test/**/*.rb"]
+    data      FileList["data/**/*"]
+    tasks     FileList["tasks/**/*.r{ake,b}"]
+    rdoc      FileList[proj_conf.readme, proj_conf.history,
+                       proj_conf.license] + lib
+    all       bin + ext + lib + test + data + rdoc + tasks 
+  }
+
+  # ways to package the results
+  formats {
+    tgz true
+    zip true
+    rubygem Configuration::Table.has_key?('rubygem')
+  }
+}
+
+#-----------------------------------------------------------------------
+# Gem packaging
+#-----------------------------------------------------------------------
+Configuration.for("rubygem") {
+  spec "gemspec.rb"
+  Configuration.for('packaging').files.all << spec
+}
+
+#-----------------------------------------------------------------------
+# Testing
+#   - change mode to 'testunit' to use unit testing
+#-----------------------------------------------------------------------
+Configuration.for('test') {
+  mode      "spec"
+  files     Configuration.for("packaging").files.test
+  options   %w[ --format profile --color ]
+  ruby_opts %w[ ]
+}
+
+#-----------------------------------------------------------------------
+# Rcov 
+#-----------------------------------------------------------------------
+Configuration.for('rcov') {
+  output_dir  "coverage"
+  libs        %w[ lib ]
+  rcov_opts   %w[ --html ]
+  ruby_opts   %w[ ]
+  test_files  Configuration.for('packaging').files.test
+}
+
+#-----------------------------------------------------------------------
+# Rdoc 
+#-----------------------------------------------------------------------
+Configuration.for('rdoc') {
+  files       Configuration.for('packaging').files.rdoc
+  main_page   files.first
+  title       Configuration.for('project').name
+  options     %w[ ]
+  output_dir  "doc"
+}
+
+#-----------------------------------------------------------------------
+# Extensions
+#-----------------------------------------------------------------------
+Configuration.for('extension') {
+  configs   Configuration.for('packaging').files.ext.find_all { |x| 
+                %w[ mkrf_conf.rb extconf.rb ].include?( File.basename(x) ) 
+            }
+}
+#-----------------------------------------------------------------------
+# Rubyforge 
+#-----------------------------------------------------------------------
+Configuration.for('rubyforge') {
+  project       "copiousfreetime"
+  user          "jjh"
+  host          "rubyforge.org"
+  rdoc_location "#{user}@#{host}:/var/www/gforge-projects/#{project}/readorder"
+}
+
+

data/tasks/distribution.rake

@@ -0,0 +1,38 @@
+require 'tasks/config'
+
+#-------------------------------------------------------------------------------
+# Distribution and Packaging
+#-------------------------------------------------------------------------------
+if pkg_config = Configuration.for_if_exist?("packaging") then
+
+  require 'gemspec'
+  require 'rake/gempackagetask'
+  require 'rake/contrib/sshpublisher'
+
+  namespace :dist do
+
+    Rake::GemPackageTask.new(Readorder::GEM_SPEC) do |pkg|
+      pkg.need_tar = pkg_config.formats.tgz
+      pkg.need_zip = pkg_config.formats.zip
+    end
+
+    desc "Install as a gem"
+    task :install => [:clobber, :package] do
+      sh "sudo gem install pkg/#{Readorder::GEM_SPEC.full_name}.gem"
+    end
+
+    desc "Uninstall gem"
+    task :uninstall do 
+      sh "sudo gem uninstall -x #{Readorder::GEM_SPEC.name}"
+    end
+
+    desc "dump gemspec"
+    task :gemspec do
+      puts Readorder::GEM_SPEC.to_ruby
+    end
+
+    desc "reinstall gem"
+    task :reinstall => [:uninstall, :repackage, :install]
+
+ end
+end

data/tasks/documentation.rake

@@ -0,0 +1,32 @@
+require 'tasks/config'
+
+#-----------------------------------------------------------------------
+# Documentation
+#-----------------------------------------------------------------------
+
+if rdoc_config = Configuration.for_if_exist?('rdoc') then
+
+  namespace :doc do
+
+    require 'rdoc'
+    require 'rake/rdoctask'
+
+    # generating documentation locally
+    Rake::RDocTask.new do |rdoc|
+      rdoc.rdoc_dir   = rdoc_config.output_dir
+      rdoc.options    = rdoc_config.options
+      rdoc.rdoc_files = rdoc_config.files
+      rdoc.title      = rdoc_config.title
+      rdoc.main       = rdoc_config.main_page
+    end 
+
+    if rubyforge_config = Configuration.for_if_exist?('rubyforge') then
+      desc "Deploy the RDoc documentation to #{rubyforge_config.rdoc_location}"
+      task :deploy => :rerdoc do
+        sh "rsync -zav --delete #{rdoc_config.output_dir}/ #{rubyforge_config.rdoc_location}"
+      end 
+    end 
+
+  end 
+end
+

data/tasks/rspec.rake

@@ -0,0 +1,29 @@
+
+require 'tasks/config'
+
+#--------------------------------------------------------------------------------
+# configuration for running rspec.  This shows up as the test:default task
+#--------------------------------------------------------------------------------
+if spec_config = Configuration.for_if_exist?("test") then
+  if spec_config.mode == "spec" then
+    namespace :test do
+
+      task :default => :spec
+
+      require 'spec/rake/spectask'
+      Spec::Rake::SpecTask.new do |r| 
+        r.ruby_opts   = spec_config.ruby_opts
+        r.libs        = [ Readorder.lib_path, 
+                          Readorder.root_dir ]
+        r.spec_files  = spec_config.files 
+        r.spec_opts   = spec_config.options
+
+        if rcov_config = Configuration.for_if_exist?('rcov') then
+          r.rcov      = true
+          r.rcov_dir  = rcov_config.output_dir
+          r.rcov_opts = rcov_config.rcov_opts
+        end
+      end
+    end
+  end
+end

data/tasks/rubyforge.rake

@@ -0,0 +1,51 @@
+require 'tasks/config'    
+
+#-----------------------------------------------------------------------
+# Rubyforge additions to the task library
+#-----------------------------------------------------------------------
+if rf_conf = Configuration.for_if_exist?("rubyforge") then
+
+  abort("rubyforge gem not installed 'gem install rubyforge'") unless Utils.try_require('rubyforge')
+  
+  proj_conf = Configuration.for('project')
+
+  namespace :dist do
+    desc "Release files to rubyforge"
+    task :rubyforge => [:clean, :package] do
+
+      rubyforge = RubyForge.new
+
+      config = {}
+      config["release_notes"]     = proj_conf.description
+      config["release_changes"]   = Utils.release_notes_from(proj_conf.history)[Readorder::VERSION]
+      config["Prefomatted"]       = true
+
+      rubyforge.configure
+
+      # make sure this release doesn't already exist
+      releases = rubyforge.autoconfig['release_ids']
+      if releases.has_key?(Readorder::GEM_SPEC.name) and releases[Readorder::GEM_SPEC.name][Readorder::VERSION] then
+        abort("Release #{Readorder::VERSION} already exists! Unable to release.")
+      end
+
+      puts "Uploading to rubyforge..."
+      files = FileList[File.join("pkg","#{Readorder::GEM_SPEC.name}-#{Readorder::VERSION}*.*")].to_a
+      rubyforge.login
+      rubyforge.add_release(Readorder::GEM_SPEC.rubyforge_project, Readorder::GEM_SPEC.name, Readorder::VERSION, *files)
+      puts "done."
+    end
+  end
+
+  namespace :announce do
+    desc "Post news of #{proj_conf.name} to #{rf_conf.project} on rubyforge"
+    task :rubyforge do
+      info = Utils.announcement
+      rubyforge = RubyForge.new
+      rubyforge.configure
+      rubyforge.login
+      rubyforge.post_news(rf_conf.project, info[:subject], "#{info[:title]}\n\n#{info[:urls]}\n\n#{info[:release_notes]}")
+      puts "Posted to rubyforge"
+    end
+
+  end
+end

data/tasks/utils.rb

@@ -0,0 +1,80 @@
+require 'readorder/version'
+
+#-------------------------------------------------------------------------------
+# Additions to the Configuration class that are useful
+#-------------------------------------------------------------------------------
+class Configuration
+  class << self
+    def exist?( name )
+      Configuration::Table.has_key?( name )
+    end
+
+    def for_if_exist?( name )
+      if self.exist?( name ) then
+        self.for( name )
+      end
+    end
+  end
+end
+
+#-------------------------------------------------------------------------------
+# some useful utilitiy methods for the tasks
+#-------------------------------------------------------------------------------
+module Utils
+  class << self
+
+    # Try to load the given _library_ using the built-in require, but do not
+    # raise a LoadError if unsuccessful. Returns +true+ if the _library_ was
+    # successfully loaded; returns +false+ otherwise.
+    #
+    def try_require( lib ) 
+      require lib
+      true 
+    rescue LoadError 
+      false 
+    end 
+
+    # partition an rdoc file into sections, and return the text of the section
+    # given.  
+    def section_of(file, section_name) 
+      File.read(file).split(/^(?==)/).each do |section|
+        lines = section.split("\n")
+        return lines[1..-1].join("\n").strip if lines.first =~ /#{section_name}/i
+      end
+      nil
+    end
+
+    # Get an array of all the changes in the application for a particular
+    # release.  This is done by looking in the history file and grabbing the
+    # information for the most recent release.  The history file is assumed to
+    # be in RDoc format and version release are 2nd tier sections separated by
+    # '== Version X.Y.Z'
+    #
+    # returns:: A hash of notes keyed by version number
+    #
+    def release_notes_from(history_file)
+      releases = {}
+      File.read(history_file).split(/^(?==)/).each do |section|
+        lines = section.split("\n")
+        md = %r{Version ((\w+\.)+\w+)}.match(lines.first)
+        next unless md
+        releases[md[1]] = lines[1..-1].join("\n").strip
+      end
+      return releases
+    end
+
+    # return a hash of useful information for the latest release
+    # urls, subject, title, description and latest release notes
+    #
+    def announcement
+      cfg = Configuration.for("project") 
+      { 
+        :subject        => "#{cfg.name} #{Readorder::VERSION} Released",
+        :title          => "#{cfg.name} version #{Readorder::VERSION} has been released.",
+        :urls           => "#{cfg.homepage}",
+        :description    => "#{cfg.description.rstrip}",
+        :release_notes  => Utils.release_notes_from(cfg.history)[Readorder::VERSION].rstrip 
+      }
+    end
+  end
+end # << self

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification 
+name: readorder
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jeremy Hinegardner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-27 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: configuration
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.0.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rbtree
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.2.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: main
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.8.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: logging
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.1.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hitimes
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.8.3
+    version: 
+description: Readorder orders a list of files into a more effective read order.  You would possibly want to use readorder in a case where you know ahead of time that you have a large quantity of files on disc to process.  You can give that list off those files and it will report back to you the order in which you should process them to make most effective use of your disc I/O.  Given a list of filenames, either on the command line or via stdin, readorder will output the filenames in an order that should increase  the I/O throughput when the files corresponding to the filenames are read off of disc.  The output order of the filenames can either be in inode order or physical disc block order.  This is dependent upon operating system support and permission level of the user running readorder.
+email: jeremy@copiousfreetime.org
+executables: 
+- readorder
+extensions: []
+
+extra_rdoc_files: 
+- README
+- HISTORY
+- LICENSE
+- lib/readorder/analyzer.rb
+- lib/readorder/cli.rb
+- lib/readorder/command.rb
+- lib/readorder/commands/analyze.rb
+- lib/readorder/commands/sort.rb
+- lib/readorder/commands/test.rb
+- lib/readorder/datum.rb
+- lib/readorder/filelist.rb
+- lib/readorder/log.rb
+- lib/readorder/paths.rb
+- lib/readorder/runner.rb
+- lib/readorder/version.rb
+- lib/readorder.rb
+files: 
+- bin/readorder
+- lib/readorder/analyzer.rb
+- lib/readorder/cli.rb
+- lib/readorder/command.rb
+- lib/readorder/commands/analyze.rb
+- lib/readorder/commands/sort.rb
+- lib/readorder/commands/test.rb
+- lib/readorder/datum.rb
+- lib/readorder/filelist.rb
+- lib/readorder/log.rb
+- lib/readorder/paths.rb
+- lib/readorder/runner.rb
+- lib/readorder/version.rb
+- lib/readorder.rb
+- spec/analyzer_spec.rb
+- spec/command_spec.rb
+- spec/filelist_spec.rb
+- spec/log_spec.rb
+- spec/paths_spec.rb
+- spec/runner_spec.rb
+- spec/spec_helper.rb
+- spec/version_spec.rb
+- README
+- HISTORY
+- LICENSE
+- tasks/announce.rake
+- tasks/distribution.rake
+- tasks/documentation.rake
+- tasks/rspec.rake
+- tasks/rubyforge.rake
+- tasks/config.rb
+- tasks/utils.rb
+- gemspec.rb
+has_rdoc: true
+homepage: http://readorder.rubyforge.org/
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+- ext
+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: copiousfreetime
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Readorder orders a list of files into a more effective read order
+test_files: []
+