data/stickler.yml lib/stickler/paths.rb @@ -23,6 +23,8 @@ require 'rake/clean' # load up all the project tasks and setup the default task to be the # test:default task. #------------------------------------------------------------------------------- +require 'stickler/paths' +require 'stickler/version' Configuration.for("packaging").files.tasks.each do |tasklib| import tasklib end Rakefile @@ -14,26 +14,36 @@ Stickler::GEM_SPEC = Gem::Specification.new do |spec| spec.description = proj.description spec.platform = Gem::Platform::RUBY + spec.required_rubygems_version = [ ">= 1.2.0" ] + spec.post_install_message = "Run `stickler help` for more information" + + spec.add_runtime_dependency( 'highline', "~> 1.4" ) + spec.add_runtime_dependency( 'logging', "~> 0.9" ) + spec.add_runtime_dependency( 'main', "~> 2.8" ) + + spec.add_development_dependency( 'rake', "~> 0.8" ) + spec.add_development_dependency( 'rspec', "~> 1.1" ) + spec.add_development_dependency( 'configuration', "~> 0.0" ) + pkg = Configuration.for('packaging') spec.files = pkg.files.all spec.executables = pkg.files.bin.collect { |b| File.basename(b) } - - if rdoc = Configuration.for_if_exist('rdoc') then + if rdoc = Configuration.for_if_exist?('rdoc') then spec.has_rdoc = true spec.extra_rdoc_files = pkg.files.rdoc - spec.rdoc_options = rdoc.options + [ "--main" , rdoc.main ] + spec.rdoc_options = rdoc.options + [ "--main" , rdoc.main_page ] else spec.has_rdoc = false end - if test = Configuration.for_if_exist('testing') then + if test = Configuration.for_if_exist?('testing') then spec.test_files = test.files end - if rf = Configuration.for_if_exist('rubyforge') then + if rf = Configuration.for_if_exist?('rubyforge') then spec.rubyforge_project = rf.project end end gemspec.rb @@ -54,20 +54,7 @@ module Stickler $stdout.puts msg end - - # - # recursively descend the directory with the same name as this file and do a - # require 'stickler/path/to/file' - # - def self.require_all_libs_relative_to_me - remove_parent = File.dirname(File.expand_path(__FILE__)) + File::SEPARATOR - descend_dir = File.join(remove_parent,File.basename(__FILE__, ".rb")) - - Dir.glob("#{descend_dir}/**/*.rb").each do |rb| - lib = rb.gsub(remove_parent,'') - require lib - end - end end -Stickler.require_all_libs_relative_to_me +require 'stickler/paths' +require 'stickler/version' lib/stickler.rb @@ -11,12 +11,11 @@ module Stickler # module Configuration - # The root directory of the project is considered to be the parent directory - # of the 'lib' directory. # - # returns:: [String] The full expanded path of the parent directory of 'lib' - # going up the path from the current file. Trailing - # File::SEPARATOR is guaranteed. + # The root directory of the project is considered to be the parent directory + # of the 'lib' directory. returns the full expanded path of the parent + # directory of 'lib' going up the path from the current file. A trailing + # File::SEPARATOR is guaranteed. # def self.root_dir unless @root_dir @@ -27,28 +26,28 @@ module Stickler return @root_dir end - # returns:: [String] The full expanded path of the +config+ directory - # below _root_dir_. All parameters passed in are joined onto the - # result. Trailing File::SEPARATOR is guaranteed if _args_ are - # *not* present. + # + # return the full expanded path of the +config+ directory below +root_dir+. + # All parameters passed in are joined on to the result. a Trailing + # File::SEPARATOR is guaranteed if _args_ are *not* present # def self.config_path(*args) self.sub_path("config", *args) end - # returns:: [String] The full expanded path of the +data+ directory below - # _root_dir_. All parameters passed in are joined onto the - # result. Trailing File::SEPARATOR is guaranteed if - # _*args_ are *not* present. + # + # return the full expanded path of the +data+ directory below +root_dir+. + # All parameters passed in are joined on to the result. a Trailing + # File::SEPARATOR is guaranteed if _args_ are *not* present # def self.data_path(*args) self.sub_path("data", *args) end - - # returns:: [String] The full expanded path of the +lib+ directory below - # _root_dir_. All parameters passed in are joined onto the - # result. Trailing File::SEPARATOR is guaranteed if - # _*args_ are *not* present. + + # + # return the full expanded path of the +lib+ directory below +root_dir+. + # All parameters passed in are joined on to the result. a Trailing + # File::SEPARATOR is guaranteed if _args_ are *not* present # def self.lib_path(*args) self.sub_path("lib", *args) lib/stickler/configuration.rb @@ -14,19 +14,18 @@ module Stickler # is very similar to a GEM_HOME directory. The layout is as follows, this is # all assumed to be under STICKLER_HOME. # - # stickler.rb - the Stickler configuration file for this repository. + # stickler.yml - the Stickler configuration file for this repository. # The existence of this file indicates this is the root # of a stickler repository - # doc/ - Generated RDOC of all the gems - # gems/ - storage of the actual gem files, somewhat similar to GEM_HOME/cache + # gems/ - storage of the actual gem files, somewhat similar to the + # GEM_HOME/cache directory # specifications/ - ruby gemspec files # log/ - directory holding rotating logs files for stickler # dist/ - directory holding the distributable gem index location, # rsync this to your webserver, or serve from it directly. - # - # Additionally, if a repository is instantiated and it is connected to an - # already existing repo directory, a logfile appender is added for a logfile - # in the log directory + # log/ - directory holding the rolling logs of what has gone on + # with the repository. + # # class Repository @@ -41,7 +40,8 @@ module Stickler return cfg end end - # The repository directory + + # The repository directory. the directory containing the stickler.yml file attr_reader :directory def initialize( opts ) @@ -73,13 +73,13 @@ module Stickler end # - # return a handle to the repository configuration found in stickler.rb + # return a handle to the repository configuration found in stickler.yml # def configuration unless @configuration @config_contents = File.read(config_file) begin - @configuration = eval(@config_contents) + @configuration = eval( @config_contents ) @configuration.upstream = [ @configuration.upstream ].flatten rescue => e logger.error "Failure to load configuration #{e}" @@ -93,7 +93,7 @@ module Stickler # The configuration file for the repository # def config_file - @config_file ||= File.join( directory, 'stickler.rb' ) + @config_file ||= File.join( directory, 'stickler.yml' ) end # @@ -209,7 +209,7 @@ module Stickler end unless File.exist?( config_file ) - FileUtils.cp Stickler::Configuration.data_path("stickler.rb"), config_file + FileUtils.cp Stickler::Configuration.data_path( "stickler.yml"), config_file logger.info "copied in default configuration to #{config_file}" end lib/stickler/repository.rb @@ -1,57 +1,39 @@ -#----------------------------------------------------------------------- -# Announcement tasks -# - create a basic email template that can be used to send email to -# rubytalk. -#----------------------------------------------------------------------- -def changes - change_file = File.expand_path(File.join(Stickler::ROOT_DIR,"CHANGES")) - sections = File.read(change_file).split(/^(?===)/) -end - -def last_changeset - changes[1] -end - -def announcement - urls = " #{Stickler::SPEC.homepage}" - subject = "#{Stickler::SPEC.name} #{Stickler::VERSION} Released" - title = "#{Stickler::SPEC.name} version #{Stickler::VERSION} has been released." - body = <<BODY -#{Stickler::SPEC.description.rstrip} - -{{ Changelog for Version #{Stickler::VERSION} }} - -#{last_changeset.rstrip} - -BODY - - return subject, title, body, urls -end +require 'tasks/config' +#------------------------------------------------------------------------------- +# announcement methods +#------------------------------------------------------------------------------- +proj_config = Configuration.for('project') namespace :announce do - desc "create email for ruby-talk" - task :email do - subject, title, body, urls = announcement + desc "create email for ruby-talk" + task :email do + info = Utils.announcement + + File.open("email.txt", "w") do |mail| + mail.puts "From: #{proj_config.author} <#{proj_config.email}>" + mail.puts "To: ruby-talk@ruby-lang.org" + mail.puts "Date: #{Time.now.rfc2822}" + mail.puts "Subject: [ANN] #{info[:subject]}" + mail.puts + mail.puts info[:title] + mail.puts + mail.puts " gem install #{Stickler::GEM_SPEC.name}" + mail.puts + mail.puts info[:urls] + mail.puts + mail.puts info[:description] + mail.puts + mail.puts "{{ Release notes for Version #{Stickler::VERSION} }}" + mail.puts + mail.puts info[:release_notes] + mail.puts + end + puts "Created the following as email.txt:" + puts "-" * 72 + puts File.read("email.txt") + puts "-" * 72 + end + + CLOBBER << "email.txt" +end - File.open("email.txt", "w") do |mail| - mail.puts "From: #{Stickler::SPEC.author} <#{Stickler::SPEC.email}>" - mail.puts "To: ruby-talk@ruby-lang.org" - mail.puts "Date: #{Time.now.rfc2822}" - mail.puts "Subject: [ANN] #{subject}" - mail.puts - mail.puts title - mail.puts - mail.puts urls - mail.puts - mail.puts body - mail.puts - mail.puts urls - end - puts "Created the following as email.txt:" - puts "-" * 72 - puts File.read("email.txt") - puts "-" * 72 - end - - CLOBBER << "email.txt" -end \ No newline at end of file tasks/announce.rake @@ -1,24 +1,21 @@ require 'configuration' require 'rake' -require 'stickler/configuration' -require 'stickler/version' - require 'tasks/utils' #----------------------------------------------------------------------- # General project configuration #----------------------------------------------------------------------- Configuration.for('project') { - name Stickler.to_s.downcase - version Stickler::VERSION - author "Jeremy Hinegardner" - email "jeremy at hinegardner dot org" - homepage "http://copiousfreetime.rubyforge.org/stickler/" + name "FIXME: NAME" + version "FIXME: 0.0.0" + author "FIXME: The Author" + email "FIXME: author@example.com" + homepage "FIXME: http://project.example.com" description Utils.section_of("README", "description") summary description.split(".").first history "HISTORY" - license "LICENSE" + license FileList["LICENSE", "COPYING"] readme "README" } @@ -30,20 +27,21 @@ Configuration.for('packaging') { proj_conf = Configuration.for('project') files { bin FileList["bin/*"] + ext FileList["ext/*.{c,h,rb}"] lib FileList["lib/**/*.rb"] - test FileList["spec/**/*.rb"] + test FileList["spec/**/*.rb", "test/**/*.rb"] data FileList["data/**/*"] tasks FileList["tasks/**/*.r{ake,b}"] - rdoc FileList[proj_conf.history, "COPYING", proj_conf.readme, + rdoc FileList[proj_conf.readme, proj_conf.history, proj_conf.license] + lib - all bin + lib + test + data + rdoc + tasks + all bin + ext + lib + test + data + rdoc + tasks } # ways to package the results formats { tgz true zip true - gem Configuration.exist?('gem') + gem Configuration::Table.has_key?('gem') } } @@ -57,6 +55,7 @@ Configuration.for("gem") { #----------------------------------------------------------------------- # Testing +# - change mode to 'testunit' to use unit testing #----------------------------------------------------------------------- Configuration.for('test') { mode "spec" @@ -74,8 +73,6 @@ Configuration.for('rcov') { rcov_opts %w[ --html ] ruby_opts %w[ ] test_files Configuration.for('packaging').files.test - - # hmm... how to configure remote publishing } #----------------------------------------------------------------------- @@ -83,49 +80,28 @@ Configuration.for('rcov') { #----------------------------------------------------------------------- Configuration.for('rdoc') { files Configuration.for('packaging').files.rdoc - main files.first + main_page files.first title Configuration.for('project').name options %w[ --line-numbers --inline-source ] output_dir "doc" - - # hmm... how to configure remote publishing ... } #----------------------------------------------------------------------- -# Rubyforge +# Extensions #----------------------------------------------------------------------- -Configuration.for('rubyforge') { - project "copiousfreetime" - user "jjh" +Configuration.for('extension') { + configs Configuration.for('packaging').files.ext.find_all { |x| + %w[ mkrf_conf.rb extconf.rb ].include?( File.basename(x) ) + } } - #----------------------------------------------------------------------- -# dump the configuration +# Rubyforge #----------------------------------------------------------------------- -if $0 == __FILE__ then - $: << "../lib" +Configuration.for('rubyforge') { + project "FIXME: rubyforge project" + user "FIXME: username" + host "rubyforge.org" + rdoc_location "#{user}@#{host}:/var/www/gforge-projects/#{project}" +} - def dump_config(config, prefix = "") - (config.methods - Object.methods - ['method_missing']).each do |method| - r = config.send(method) - r = r.to_ary if r.respond_to?(:to_ary) - case r - when Configuration - puts "#{prefix}<#{method.to_s.center(12)}>" - dump_config(r,prefix + " ") - when Array - puts "#{prefix}#{method.to_s.rjust(12)} :" - r.each do |x| - puts "#{prefix}#{"-".rjust(12)} #{x}" - end - else - puts "#{prefix}#{method.to_s.rjust(12)} : #{r.inspect}" - end - end - end - Configuration::Table.keys.sort.each do |config_key| - puts "[#{config_key.center(12)}]" - dump_config(Configuration.for(config_key), " ") - end -end tasks/config.rb @@ -1,15 +1,16 @@ -#----------------------------------------------------------------------- -# Distribution and Packaging -#----------------------------------------------------------------------- require 'tasks/config' -# only do this task if the appropriate section from the configuration exists -if pkg_config= Configuration.for_if_exist("packaging") then +#------------------------------------------------------------------------------- +# 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(Stickler::GEM_SPEC) do |pkg| pkg.need_tar = pkg_config.formats.tgz pkg.need_zip = pkg_config.formats.zip @@ -17,21 +18,21 @@ if pkg_config= Configuration.for_if_exist("packaging") then desc "Install as a gem" task :install => [:clobber, :package] do - sh "sudo gem install -y pkg/#{Stickler::SPEC.full_name}.gem" + sh "sudo gem install pkg/#{Stickler::GEM_SPEC.full_name}.gem" end desc "Uninstall gem" task :uninstall do - sh "sudo gem uninstall -i #{Stickler::SPEC.name} -x" + sh "sudo gem uninstall -x #{Stickler::GEM_SPEC.name}" end desc "dump gemspec" task :gemspec do - puts Stickler::GEM_SPEC + puts Stickler::GEM_SPEC.to_ruby end desc "reinstall gem" task :reinstall => [:uninstall, :repackage, :install] - end + end end tasks/distribution.rake @@ -1,9 +1,10 @@ +require 'tasks/config' + #----------------------------------------------------------------------- # Documentation #----------------------------------------------------------------------- -require 'tasks/config' -if rdoc_config = Configuration.for('rdoc') then +if rdoc_config = Configuration.for_if_exist?('rdoc') then namespace :doc do @@ -15,19 +16,16 @@ if rdoc_config = Configuration.for('rdoc') then rdoc.options = rdoc_config.options rdoc.rdoc_files = rdoc_config.files rdoc.title = rdoc_config.title - rdoc.main = rdoc_config.main - end - - # desc "Deploy the RDoc documentation to #{Stickler::SPEC.remote_rdoc_location}" - # task :deploy => :rerdoc do - # sh "rsync -zav --delete #{Stickler::SPEC.local_rdoc_dir}/ #{Stickler::SPEC.remote_rdoc_location}" - # end - - # if HAVE_HEEL then - # desc "View the RDoc documentation locally" - # task :view => :rdoc do - # sh "heel --root #{Stickler::SPEC.local_rdoc_dir}" - # end - # end - end + 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 + tasks/documentation.rake @@ -1,32 +1,29 @@ + require 'tasks/config' -if spec_config = Configuration.for_if_exist('test') 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 = [ Stickler::Configuration.lib_path, - Stickler::Configuration.root_dir ] - r.spec_files = spec_config.files - r.spec_opts = spec_config.options +#-------------------------------------------------------------------------------- +# 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 - 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 + task :default => :spec + + require 'spec/rake/spectask' + Spec::Rake::SpecTask.new do |r| + r.ruby_opts = spec_config.ruby_opts + r.libs = [ Stickler::Paths.lib_path, + Stickler::Paths.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 - - #if HAVE_HEEL then - #desc "View the code coverage report locally" - #task :coverage => [:spec] do - #sh "heel --root #{Stickler::SPEC.local_coverage_dir}" - #end - #end - end tasks/rspec.rake @@ -1,44 +1,49 @@ -require 'tasks/config' -if rf_conf = Configuration.for_if_exist('rubyforge') then - #----------------------------------------------------------------------- - # Rubyforge additions to the task library - #----------------------------------------------------------------------- - require 'rubyforge' +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') - prof_conf = Configuration.for('project') + proj_conf = Configuration.for('project') namespace :dist do desc "Release files to rubyforge" task :rubyforge => [:clean, :package] do - rubyforge = ::RubyForge.new + rubyforge = RubyForge.new + + config = {} + config["release_notes"] = proj_conf.description + config["release_changes"] = Utils.release_notes_from(proj_conf.history)[Stickler::VERSION] + config["Prefomatted"] = true + + rubyforge.configure # make sure this release doesn't already exist releases = rubyforge.autoconfig['release_ids'] - if releases.has_key?(prof_conf.name) and releases[prof_conf.name][Stickler::VERSION] then + if releases.has_key?(Stickler::GEM_SPEC.name) and releases[Stickler::GEM_SPEC.name][Stickler::VERSION] then abort("Release #{Stickler::VERSION} already exists! Unable to release.") end - config = rubyforge.userconfig - config["release_notes"] = prof_conf.description - config["release_changes"] = Utils.release_notes_from(proj_conf.history)[Stickler::VERSION] - config["Prefomatted"] = true - puts "Uploading to rubyforge..." - files = FileList[File.join("pkg","#{prof_conf.name}-#{Stickler::VERSION}*.*")].to_a + files = FileList[File.join("pkg","#{Stickler::GEM_SPEC.name}-#{Stickler::VERSION}*.*")].to_a rubyforge.login - rubyforge.add_release(rf_conf.project, prof_conf.name, Stickler::VERSION, *files) + rubyforge.add_release(Stickler::GEM_SPEC.rubyforge_project, Stickler::GEM_SPEC.name, Stickler::VERSION, *files) puts "done." end end namespace :announce do - desc "Post news of #{prof_conf.name} to #{rf_conf.project} on rubyforge" + desc "Post news of #{proj_conf.name} to #{rf_conf.project} on rubyforge" task :rubyforge do - subject, title, body, urls = announcement + info = Utils.announcement rubyforge = RubyForge.new + rubyforge.configure rubyforge.login - rubyforge.post_news(rf_conf.project, subject, "#{title}\n\n#{urls}\n\n#{body}") + rubyforge.post_news(rf_conf.project, info[:subject], "#{info[:title]}\n\n#{info[:urls]}\n\n#{info[:release_notes]}") puts "Posted to rubyforge" end tasks/rubyforge.rake @@ -1,4 +1,25 @@ require 'stickler/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 @@ -34,13 +55,26 @@ module Utils def release_notes_from(history_file) releases = {} File.read(history_file).split(/^(?==)/).each do |section| - lines = release.split("\n") + 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 - end # << self -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} #{Stickler::VERSION} Released", + :title => "#{cfg.name} version #{Stickler::VERSION} has been released.", + :urls => "#{cfg.homepage}", + :description => "#{cfg.description.rstrip}", + :release_notes => Utils.release_notes_from(cfg.history)[Stickler::VERSION].rstrip + } + end + end +end # << self tasks/utils.rb data/stickler.rb lib/configuration.rb tasks/site.rake 8de59adc60fdb130b637ecfd098451191748e930 Jeremy Hinegardner jeremy@hinegardner.org http://github.com/copiousfreetime/stickler/commit/67721ed04a0a578b5a5b3a931b190e162492a1c5 67721ed04a0a578b5a5b3a931b190e162492a1c5 2008-09-20T18:07:00-07:00 2008-09-20T18:07:00-07:00 restructure project b24a5996536461241955376a232ccfa857d95d50 Jeremy Hinegardner jeremy@hinegardner.org