PostInstall.txt script/console website/template.html.erb @@ -1,3 +1,3 @@ == 0.0.1 2008-05-14 - * Initial release +* Initial release History.txt @@ -1,13 +1,16 @@ History.txt License.txt Manifest.txt +PostInstall.txt README.txt Rakefile config/hoe.rb config/requirements.rb lib/whisper.rb +lib/whisper/account.rb +lib/whisper/message.rb lib/whisper/version.rb -log/debug.log +script/console script/destroy script/generate script/txt2html @@ -21,4 +24,5 @@ website/index.html website/index.txt website/javascripts/rounded_corners_lite.inc.js website/stylesheets/screen.css +website/template.html.erb website/template.rhtml Manifest.txt @@ -7,6 +7,11 @@ GEM_NAME = 'whisper' # what ppl will type to install your gem RUBYFORGE_PROJECT = 'springnote' # The unix name for your project HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org/whisper" DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}" +EXTRA_DEPENDENCIES = [ + 'activesupport', + 'oauth', + 'ruby-hmac' +] # An array of rubygem dependencies [name, version] @config_file = "~/.rubyforge/user-config.yml" @config = nil @@ -28,26 +33,26 @@ Run 'rubyforge setup' to prepare your env for access to Rubyforge end -REV = nil -# UNCOMMENT IF REQUIRED: -# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil +REV = nil +# UNCOMMENT IF REQUIRED: +# REV = YAML.load(`svn info`)['Revision'] VERS = Whisper::VERSION::STRING + (REV ? ".#{REV}" : "") RDOC_OPTS = ['--quiet', '--title', 'whisper documentation', "--opname", "index.html", - "--line-numbers", + "--line-numbers", "--main", "README", "--inline-source"] class Hoe - def extra_deps - @extra_deps.reject! { |x| Array(x).first == 'hoe' } + def extra_deps + @extra_deps.reject! { |x| Array(x).first == 'hoe' } @extra_deps - end + end end # Generate all the Rake tasks # Run 'rake -T' to see list of generated tasks (from gem root directory) -hoe = Hoe.new(GEM_NAME, VERS) do |p| +$hoe = Hoe.new(GEM_NAME, VERS) do |p| p.developer(AUTHOR, EMAIL) p.description = DESCRIPTION p.summary = DESCRIPTION @@ -55,16 +60,16 @@ hoe = Hoe.new(GEM_NAME, VERS) do |p| p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT p.test_globs = ["test/**/test_*.rb"] p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store'] #An array of file patterns to delete on clean. - + # == Optional p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n") - p.extra_deps = %w(oauth ruby-hmac active_support) # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ] - - #p.spec_extras = {} # A hash of extra values to set in the gemspec. - -end + p.extra_deps = EXTRA_DEPENDENCIES + + #p.spec_extras = {} # A hash of extra values to set in the gemspec. + end -CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n") +CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n") PATH = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}" -hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc') -hoe.rsync_args = '-av --delete --ignore-errors' \ No newline at end of file +$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc') +$hoe.rsync_args = '-av --delete --ignore-errors' +$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue "" \ No newline at end of file config/hoe.rb @@ -13,5 +13,3 @@ require 'rubygems' end $:.unshift(File.join(File.dirname(__FILE__), %w[.. lib])) - -require 'whisper' \ No newline at end of file config/requirements.rb @@ -1,8 +1,12 @@ #!/usr/bin/env ruby +GEM_NAME = 'whisper' # what ppl will type to install your gem +RUBYFORGE_PROJECT = 'whisper' + require 'rubygems' begin require 'newgem' + require 'rubyforge' rescue LoadError puts "\n\nGenerating the website requires the newgem RubyGem" puts "Install: gem install newgem\n\n" @@ -11,10 +15,14 @@ end require 'redcloth' require 'syntax/convertors/html' require 'erb' -require File.dirname(__FILE__) + '/../lib/whisper/version.rb' +require File.dirname(__FILE__) + "/../lib/#{GEM_NAME}/version.rb" version = Whisper::VERSION::STRING -download = 'http://rubyforge.org/projects/whisper' +download = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}" + +def rubyforge_project_id + RubyForge.new.autoconfig["group_ids"][RUBYFORGE_PROJECT] +end class Fixnum def ordinal @@ -42,10 +50,9 @@ end if ARGV.length >= 1 src, template = ARGV - template ||= File.join(File.dirname(__FILE__), '/../website/template.rhtml') - + template ||= File.join(File.dirname(__FILE__), '/../website/template.html.erb') else - puts("Usage: #{File.split($0).last} source.txt [template.rhtml] > output.html") + puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > output.html") exit! end @@ -55,7 +62,8 @@ title = nil body = nil File.open(src) do |fsrc| title_text = fsrc.readline - body_text = fsrc.read + body_text_template = fsrc.read + body_text = ERB.new(body_text_template).result(binding) syntax_items = [] body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){ ident = syntax_items.length script/txt2html @@ -27,8 +27,52 @@ h2. How to submit patches Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above. +TODO - pick SVN or Git instructions + The trunk repository is <code>svn://rubyforge.org/var/svn/whisper/trunk</code> for anonymous access. +OOOORRRR + +You can fetch the source from either: + +<% if rubyforge_project_id %> + +* rubyforge: "http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %>":http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %> + +<pre>git clone git://rubyforge.org/whisper.git</pre> + +<% else %> + +* rubyforge: MISSING IN ACTION + +TODO - You can not created a RubyForge project, OR have not run <code>rubyforge config</code> +yet to refresh your local rubyforge data with this projects' id information. + +When you do this, this message will magically disappear! + +Or you can hack website/index.txt and make it all go away!! + +<% end %> + +* github: "http://github.com/GITHUB_USERNAME/whisper/tree/master":http://github.com/GITHUB_USERNAME/whisper/tree/master + +<pre>git clone git://github.com/GITHUB_USERNAME/whisper.git</pre> + + +TODO - add "github_username: username" to ~/.rubyforge/user-config.yml and newgem will reuse it for future projects. + + +* gitorious: "git://gitorious.org/whisper/mainline.git":git://gitorious.org/whisper/mainline.git + +<pre>git clone git://gitorious.org/whisper/mainline.git</pre> + +h3. Build and test instructions + +<pre>cd whisper +rake test +rake install_gem</pre> + + h2. License This code is free to use under the terms of the MIT license. website/index.txt b659960c1176a9ad34534e914787aa038d83bab2 Bryan Kang deepblue@deepblue.local http://github.com/deepblue/whisper/commit/2a1343cf425fbc8e935672ae190d0359e09ce83a 2a1343cf425fbc8e935672ae190d0359e09ce83a 2008-05-13T19:47:51-07:00 2008-05-13T19:47:51-07:00 upgrade newgem(0.23.1) 78b6a638260a9618b3601770adc20b82b780ee91 Bryan Kang deepblue@deepblue.local