webby 0.1.0 → 0.2.0

data/History.txt

@@ -1,3 +1,10 @@
+== 0.2.0 / 2007-08-28
+
+* Updated rake tasks for website deployment
+* Can use 'heel' and 'launchy' for viewing websites
+* Webby executable can update rake tasks for existing websites
+* Added more rdoc documentation to classes
+
 == 0.1.0 / 2007-08-22
 
 * Birthday!

data/Manifest.txt

@@ -20,9 +20,12 @@ data/content/css/blueprint/lib/typography.css
 data/content/css/blueprint/print.css
 data/content/css/blueprint/screen.css
 data/content/css/site.css
-data/content/index.rhtml
+data/content/index.txt
 data/layouts/default.rhtml
 data/tasks/create.rake
+data/tasks/deploy.rake
+data/tasks/heel.rake
+data/tasks/setup.rb
 data/templates/page.erb
 lib/webby.rb
 lib/webby/auto_builder.rb
@@ -40,5 +43,31 @@ spec/webby/file_spec.rb
 tasks/doc.rake
 tasks/gem.rake
 tasks/manifest.rake
+tasks/rubyforge.rake
 tasks/setup.rb
 tasks/spec.rake
+tasks/website.rake
+website/Rakefile
+website/content/css/blueprint/lib/buttons.css
+website/content/css/blueprint/lib/compressed.css
+website/content/css/blueprint/lib/grid.css
+website/content/css/blueprint/lib/img/baseline-black.png
+website/content/css/blueprint/lib/img/baseline.png
+website/content/css/blueprint/lib/img/grid.png
+website/content/css/blueprint/lib/img/icons/cross.png
+website/content/css/blueprint/lib/img/icons/textfield_key.png
+website/content/css/blueprint/lib/img/icons/tick.png
+website/content/css/blueprint/lib/reset.css
+website/content/css/blueprint/lib/typography.css
+website/content/css/blueprint/print.css
+website/content/css/blueprint/screen.css
+website/content/css/site.css
+website/content/download.txt
+website/content/index.txt
+website/content/tutorial.txt
+website/layouts/default.rhtml
+website/tasks/create.rake
+website/tasks/deploy.rake
+website/tasks/heel.rake
+website/tasks/setup.rb
+website/templates/page.erb

data/Rakefile

@@ -4,6 +4,7 @@ require 'rubygems'
 require 'rake'
 require 'spec'
 require 'webby'
+require 'fileutils'
 load './tasks/setup.rb'
 
 task :default => 'spec:run'
@@ -16,10 +17,13 @@ PROJ.url = 'http://webby.rubyforge.org/'
 PROJ.description = paragraphs_of('README.txt', 3).join("\n\n")
 PROJ.changes = paragraphs_of('History.txt', 0..1).join("\n\n")
 PROJ.rubyforge_name = 'webby'
-
+PROJ.rdoc_dir = 'doc/rdoc'
+PROJ.rdoc_remote_dir = 'rdoc'
 PROJ.version = Webby::VERSION
 
-PROJ.exclude << '^(\.\/|\/)?site'
+PROJ.exclude << '^(\.\/|\/)?website/output'
+PROJ.rdoc_exclude << '^(\.\/|\/)?data'
+PROJ.rdoc_exclude << '^(\.\/|\/)?website'
 
 PROJ.spec_opts << '--color'
 

data/bin/webby

@@ -9,6 +9,6 @@ rescue LoadError
   retry
 end
 
-::Webby::Main.run *ARGV
+::Webby::Main.run ARGV
 
 # EOF

data/data/Rakefile

@@ -1,6 +1,10 @@
 
+require 'webby'
+load 'tasks/setup.rb'
+
 task :default => :build
 
-# import rake tasks
-FileList['tasks/*.rake'].each {|task| import task}
+desc 'depoloy the site to the webserver'
+task :deploy => [:build, 'deploy:rsync']
 
+# EOF

data/data/tasks/create.rake

@@ -2,6 +2,11 @@
 require 'webby'
 
 Rake::WebbyTask.new do |webby|
-  webby.output_dir = 'output'
+  webby.content_dir   = SITE.content_dir
+  webby.output_dir    = SITE.output_dir
+  webby.layout_dir    = SITE.layout_dir
+  webby.template_dir  = SITE.template_dir
+  webby.exclude       = SITE.exclude
+  webby.page_defaults = SITE.page_defaults
 end
 

data/data/tasks/deploy.rake

@@ -0,0 +1,22 @@
+
+require 'rake/contrib/sshpublisher'
+
+namespace :deploy do
+
+  desc 'deploy to the server using rsync'
+  task :rsync do
+    cmd = "rsync #{SITE.rsync_args.join(' ')} "
+    cmd << "#{SITE.output_dir}/ #{SITE.host}:#{SITE.remote_dir}"
+    sh cmd
+  end
+
+  desc 'deploy to the server using ssh'
+  task 'ssh' do
+    Rake::SshDirPublisher.new(
+        SITE.host, SITE.remote_dir, SITE.output_dir
+    ).upload
+  end
+
+end  # deploy
+
+# EOF

data/data/tasks/heel.rake

@@ -0,0 +1,26 @@
+
+if HAVE_HEEL
+
+namespace :heel do
+
+  desc 'start the heel server to view website'
+  task :run do
+    sh "heel --root #{SITE.output_dir} --daemonize"
+  end
+
+  desc 'stop the heel server'
+  task :kill do
+    sh "heel --kill"
+  end
+
+  task :autobuild => :run do
+    at_exit {sh "heel --kill"}
+  end
+
+end
+
+task :autobuild => 'heel:autobuild'
+
+end  # HAVE_HEEL
+
+# EOF

data/data/tasks/setup.rb

@@ -0,0 +1,27 @@
+
+require 'ostruct'
+
+SITE = OpenStruct.new
+
+SITE.content_dir   = 'content'
+SITE.output_dir    = 'output'
+SITE.layout_dir    = 'layouts'
+SITE.template_dir  = 'templates'
+SITE.exclude       = %w[tmp$ bak$ ~$ CVS \.svn]
+  
+SITE.page_defaults = {
+  'extension' => 'html',
+  'layout'    => 'default'
+}
+
+SITE.host       = 'user@hostname.tld'
+SITE.remote_dir = '/not/a/valid/dir'
+SITE.rsync_args = %w(-av --delete)
+
+FileList['tasks/*.rake'].each {|task| import task}
+
+%w(heel).each do |lib|
+  Object.instance_eval {const_set "HAVE_#{lib.upcase}", try_require(lib)}
+end
+
+# EOF

data/lib/webby.rb

@@ -1,8 +1,8 @@
-# $Id: webby.rb 8 2007-08-22 22:32:09Z tim_pease $
+# $Id: webby.rb 19 2007-08-28 22:48:24Z tim_pease $
 
 module Webby
 
-  VERSION = '0.1.0'   # :nodoc:
+  VERSION = '0.2.0'   # :nodoc:
 
   # Path to the Webby package
   PATH = ::File.expand_path(::File.join(::File.dirname(__FILE__), '..'))
@@ -29,36 +29,44 @@ module Webby
   #    Webby.config    => hash
   #
   # Returns the configuration hash for the Webby application.
-  #--
-  # The defaults are defined in the lib/webby/webby_task.rb file
-  #++
+  #
   def self.config
-    @config ||= {}
+    @config ||= {
+      'output_dir'    => 'output',
+      'content_dir'   => 'content',
+      'layout_dir'    => 'layouts',
+      'template_dir'  => 'templates',
+      'exclude'       => %w(tmp$ bak$ ~$ CVS \.svn)
+    }
   end
 
   # call-seq:
   #    Webby.page_defaults    => hash
   #
   # Returns the page defaults hash used for page resource objects.
-  #--
-  # The defaults are defined in the lib/webby/webby_task.rb file
-  #++
+  #
   def self.page_defaults
-    @page_defaults ||= {}
+    @page_defaults ||= {
+      'extension' => 'html',
+      'layout'    => 'default'
+    }
   end
 
 end  # module Webby
 
 
 # call-seq:
-#    try_require( library )
+#    try_require( library )    => true or false
 #
 # Try to laod the given _library_ using the built-in require, but do not
-# raise a LoadError if unsuccessful.
+# 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
 
 

data/lib/webby/builder.rb

@@ -1,4 +1,4 @@
-# $Id: builder.rb 5 2007-08-22 04:25:49Z tim_pease $
+# $Id: builder.rb 16 2007-08-25 19:55:00Z tim_pease $
 
 require 'find'
 require 'fileutils'
@@ -77,8 +77,7 @@ class Builder
       FileUtils.mkdir output_dir
     end
 
-    load_layouts
-    load_content
+    load_files
 
     Resource.pages.each do |page|
       next unless page.dirty? or opts[:rebuild]
@@ -111,13 +110,13 @@ class Builder
 
   private
 
-  # Scan the <code>layouts/</code> folder and create a new Resource object
-  # for each file found there.
+  # Scan the <code>layouts/</code> folder and the <code>content/</code>
+  # folder and create a new Resource object for each file found there.
   #
-  def load_layouts
+  def load_files
     excl = Regexp.new exclude.join('|')
 
-    ::Find.find(layout_dir) do |path|
+    ::Find.find(layout_dir, content_dir) do |path|
       next unless test ?f, path
       next if path =~ excl
       Resource.new path
@@ -141,18 +140,6 @@ class Builder
     end  # each
   end
 
-  # Scan the <code>content/</code> folder and create a new Resource object
-  # for each file found there.
-  #
-  def load_content
-    excl = Regexp.new exclude.join('|')
-    Find.find(content_dir) do |path|
-      next unless test ?f, path
-      next if path =~ excl
-      Resource.new path, ::Webby.page_defaults
-    end
-  end
-
   %w(output_dir layout_dir content_dir exclude).each do |key|
     self.class_eval <<-CODE
       def #{key}( ) ::Webby.config['#{key}'] end

data/lib/webby/main.rb

@@ -1,7 +1,8 @@
-# $Id: main.rb 2 2007-08-20 17:55:30Z tim_pease $
+# $Id: main.rb 20 2007-08-28 23:24:14Z tim_pease $
 
 require 'fileutils'
 require 'find'
+require 'optparse'
 
 module Webby
 
@@ -16,40 +17,97 @@ class Main
   # Directory where the prototype Webby website can be found
   attr_accessor :data
 
+  # Flag used to update an existing website
+  attr_accessor :update
+
   # call-seq:
-  #    Main.run( *args )    => nil
+  #    Main.run( args )    => nil
   #
   # Create a new instance of Main, and run the +webby+ application given the
   # command line _args_.
   #
-  def self.run( *args )
-    self.new.run *args
+  def self.run( args )
+    m = self.new
+    m.parse args
+
+    if m.update then m.update_site
+                else m.create_site end
   end
 
   # call-seq:
-  #    run( *args )    => nil
+  #    parse( args )   => nil
   #
-  # Run the +webby+ application given the command line _args_.
+  # Parse the command line arguments and store the values for later use by
+  # the create_site and update_site methods.
   #
-  def run( *args )
-    abort "Usage: #{$0} /path/to/your/site" unless args.length == 1
-
-    self.site = args.at 0
+  def parse( args )
     self.data = File.join(::Webby::PATH, 'data')
+    self.update = false
+
+    opts = OptionParser.new
+    opts.banner << ' site'
+
+    opts.separator ''
+    opts.on('-u', '--update',
+            'update the rake tasks for the site') {self.update = true}
+
+    opts.separator ''
+    opts.separator 'common options:'
+
+    opts.on_tail( '-h', '--help', 'show this message' ) {puts opts; exit}
+    opts.on_tail( '--version', 'show version' ) do
+      puts "Webby #{::Webby::VERSION}"
+      exit
+    end
+
+    # parse the command line arguments
+    opts.parse! args
+    self.site = args.shift
 
+    if site.nil?
+      puts opts
+      ::Kernel.abort
+    end
+    nil
+  end
+
+  # call-seq:
+  #    create_site    => nil
+  #
+  # Create a new website.
+  #
+  def create_site
     # see if the site already exists
-    abort "#{site} already exists" if test ?e, site
+    abort "'#{site}' already exists" if test ?e, site
 
     # copy over files from the data directory
     files = site_files
 
     files.keys.sort.each do |dir|
       mkdir dir
-      files[dir].each {|file| cp file}
+      files[dir].sort.each {|file| cp file}
     end
     nil
   end
 
+  # call-seq:
+  #    update_site    => nil
+  #
+  # Update the rake tasks for an existing website.
+  #
+  def update_site
+    # ensure the site already exists
+    abort "'#{site}' does not exist" unless test ?d, site
+
+    # copy over files from the data/tasks directory
+    files = site_files
+
+    mkdir 'tasks'
+    files['tasks'].sort.each {|file| cp file}
+
+    nil
+  end
+
   # call-seq:
   #    mkdir( dir )    => nil
   #
@@ -58,8 +116,10 @@ class Main
   #
   def mkdir( dir )
     dir = dir.empty? ? site : ::File.join(site, dir)
-    creating dir
-    FileUtils.mkdir_p dir
+    unless test ?d, dir
+      creating dir
+      FileUtils.mkdir_p dir
+    end
   end
 
   # call-seq:
@@ -72,7 +132,7 @@ class Main
   def cp( file )
     src = ::File.join(data, file)
     dst = ::File.join(site, file)
-    creating dst
+    test(?e, dst) ? updating(dst) : creating(dst)
     FileUtils.cp src, dst
   end
 
@@ -86,6 +146,16 @@ class Main
     puts msg
   end
 
+  # call-seq:
+  #    updating( msg )   => nil
+  #
+  # Prints a "updating _msg_" to the screen.
+  #
+  def updating( msg )
+    print "updating "
+    puts msg
+  end
+
   # call-seq:
   #    abort( msg )   => nil
   #