woody 0.3.3 → 0.3.4

data/README.md

@@ -1,6 +1,8 @@
 # Woody
 
-Podcast static site generator
+**Woody is a static podcast site generator.**
+
+Drop your mp3s in a folder, set some metadata and deploy a full podcast site to Amazon S3.
 
 ## Installation
 
@@ -9,11 +11,33 @@ To install, run this:
     $ gem install woody
     
 ## To Do List/Roadmap
-[Here, on trello](https://trello.com/board/woody-to-do-list/50c7903cc0e26dc906001fd6)
+We've got a [Roadmap](https://trello.com/board/woody-to-do-list/50c7903cc0e26dc906001fd6) up and running on Trello where you can suggest features, report bugs and track the project's progress.
 
 ## Usage
 
-TODO: Write usage instructions here
+Install the gem (see above) and create a new project with
+
+    $ woody new projectname
+
+Woody will generate a new project with the name given. Open up the project folder and edit the **woody-config.yml** to your liking.
+
+Dump some mp3s into the **/content** folder and run
+
+    $ woody compile
+   
+Woody will index the mp3s and prompt you for metadata. You can change this data by editing the **metadata.yml** file in the **/content/** directory.
+
+After this, Woody will generate a full HTML site in the output folder. You can upload this to your host manually or use
+
+    $ woody deploy
+   
+to deploy your Woody site on to Amazon S3 (be sure to enter your AWS credentials correctly into the configuration file.)
+
+**SCREENCAST COMING SOON!**
+
+## About Woody
+
+Woody was developed by David Robertson and David Hewitson as a hosting solution for [an online sitcom](http://spaceferries.com). We decided to release it for free for a laugh.
 
 ## Contributing
 

data/lib/woody/compiler.rb

@@ -10,9 +10,9 @@ module Woody
 		
   		# instantiate the metadata hash so shit doesn't explode in our faces
   		# WEIRD SHIT: used .empty? here before but fails if used on hash seemingly
-		if meta == false
-			meta = Hash.new 
-		end
+      if meta == false
+        meta = Hash.new
+      end
 
       episodes     = Array.new
       filesfound   = Array.new
@@ -76,7 +76,7 @@ module Woody
           ep = Erubis::Eruby.new(File.read('templates/episode.html'))
           ep.result(config: $config, episodes: episodes, episode: episode)
         end
-        write_output_file(episode.path) {|f| f.write(episode_compiled) }
+        write_output_file(episode.path!) {|f| f.write(episode_compiled) }
       end
 
       # Copy over iTunes.png

data/lib/woody/deployer.rb

@@ -28,11 +28,13 @@ module Woody
     # @param [Array] touchedfiles specifies the S3 objects to keep
     def self.purge_bucket
       bucket = AWS::S3::Bucket.find $bucketname
-      bucket.objects.each do |object|
-        prefix = $config['s3']['prefix']
-        if prefix.nil?
+      prefix = $config['s3']['prefix']
+      if prefix.nil?
+        bucket.objects.each do |object|
           object.delete unless @@touchedfiles.include? object.key
-        else
+        end
+      else
+        bucket.objects.each do |object|
           if object.key.start_with? prefix # If using a prefix, don't delete anything outside of that 'subdirectory'
             object.delete unless @@touchedfiles.include? object.key
           end

data/lib/woody/episode.rb

@@ -32,28 +32,43 @@ module Woody
 
     # @return the episode's page URL where possible, otherwise false
     def url
-      return "#{$config['urlbase']}#{path}" unless path == false
+      return "#{$config['urlbase']}#{path!}" unless path! == false
       return false
     end
 
-    # @return the episode's page path where possible, otherwise false
-    def path(leader=true)
+    # @return the episode's page path! where possible, otherwise false. Does not take prefix in to account.
+    def path!(leader=true)
       return "#{leader ? "/" : ""}episode/#{@compiledname[0..-5]}.html" unless @compiledname.nil?
       return false
     end
 
+    # @return the episode's page path! where possible, otherwise false. Includes the site prefix if enabled.
+    def path(leader=true)
+      prefix = $config['s3']['prefix']
+      return "#{leader ? "/" : ""}#{prefix.nil? ? "" : prefix + "/" }episode/#{@compiledname[0..-5]}.html" unless @compiledname.nil?
+      return false
+    end
+
     # @return the episode's media file URL where possible, otherwise false
     def file_url
-      return "#{$config['urlbase']}#{file_path}" unless file_path == false
+      return "#{$config['urlbase']}#{file_path!}" unless file_path! == false
       return false
     end
 
-    # @return the episode's media file path where possible, otherwise false
-    def file_path(leader=true)
+    # @return the episode's media file path! where possible, otherwise false. Does not take prefix in to account.
+    def file_path!(leader=true)
       return "#{leader ? "/" : ""}assets/mp3/#{@compiledname}" unless @compiledname.nil?
       return false
     end
 
+    # @return the episode's media file path! where possible, otherwise false. Includes site prefix if enabled.
+    def file_path(leader=true)
+      prefix = $config['s3']['prefix']
+      return "#{leader ? "/" : ""}#{prefix.nil? ? "" : prefix + "/" }assets/mp3/#{@compiledname}" unless @compiledname.nil?
+      return false
+    end
+
+
     # @return [String] a comma separated list of tags, or nil if no tags
     def keywords
       @tags.join ', ' unless @tags.nil? or @tags.empty?

data/lib/woody/version.rb

@@ -1,4 +1,4 @@
 module Woody
   # Specifies Woody gem version
-  VERSION = "0.3.3"
+  VERSION = "0.3.4"
 end

data/lib/woody.rb

@@ -31,7 +31,19 @@ module Woody
       puts "This doesn't look like a valid Woody site directory!"
       exit!
     end
-    
+
+    # Strip trailing slash from urlbase, if present.
+    if $config['urlbase'].end_with? "/"
+      $config['urlbase'] = $config['urlbase'][0..-2]
+    end
+
+    if $config['distributiontype'] == "s3"
+      prefix = $config['s3']['prefix']
+      unless prefix.nil?
+        $config['urlbase'] = $config['urlbase'] + "/" + prefix
+      end
+    end
+
     options = { 
       :access_key_id     => $config['s3']['accesskey']['id'], 
       :secret_access_key => $config['s3']['accesskey']['secret']

data/templates/layout.html

@@ -6,7 +6,7 @@
     <link rel="stylesheet" type="text/css" href="/assets/stylesheet.css" />
   </head>
   <body>
-    <h1><%= link_to $config['title'], "/" %></h1>
+    <h1><%= link_to $config['title'], $config['urlbase'] %></h1>
     <h2><%= $config['subtitle'] %></h2>
     <hr />
     <%= yield %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: woody
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
   prerelease: 
 platform: ruby
 authors: