soundwave 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in soundwave.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David Demaree
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# Soundwave
+
+Soundwave is a simple static file generator. Its primary use is for building static web sites, and in that sense it's similar to Tom Preston-Werner's Jekyll. But Soundwave can also bootstrap web application projects, or basically do anything that involves processing data or copying a directory structure lots and lots of times.
+
+## Installation
+
+TODO: This isn't really a Rails plugin, so you wouldn't necessarily put it in a Gemfile.
+
+Add this line to your application's Gemfile:
+
+    gem 'soundwave'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install soundwave
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,28 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require './vendor/source_annotation_extractor'
+
+desc "Enumerate all annotations (use notes:optimize, :fixme, :todo for focus)"
+task :notes do
+  SourceAnnotationExtractor.enumerate "OPTIMIZE|FIXME|TODO", :tag => true
+end
+
+namespace :notes do
+  ["OPTIMIZE", "FIXME", "TODO"].each do |annotation|
+    # desc "Enumerate all #{annotation} annotations"
+    task annotation.downcase.intern do
+      SourceAnnotationExtractor.enumerate annotation
+    end
+  end
+
+  desc "Enumerate a custom annotation, specify with ANNOTATION=CUSTOM"
+  task :custom do
+    SourceAnnotationExtractor.enumerate ENV['ANNOTATION']
+  end
+end

data/bin/soundwave

@@ -0,0 +1,96 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'soundwave'
+
+help = <<HELP
+Soundwave is a static site generator.
+
+soundwave        #=> Builds a Soundwave site in the current directory
+soundwave init   #=> Set up a new Soundwave site in the current directory
+
+HELP
+
+if ARGV.first == "init"
+  ARGV.shift
+  puts "soundwave init not yet implemented"
+  exit(0)
+else
+  # puts "Soundwave #{Soundwave::VERSION}"
+end
+
+options = {}
+
+opts = OptionParser.new do |opts|
+  opts.summary_width = 24
+  opts.banner = help
+
+  # opts.on("-r", "--require LIBRARY", "Require the LIBRARY before doing anything") do |lib|
+  #   require lib
+  # end
+
+  # opts.on("-I DIRECTORY", "--include=DIRECTORY", "Adds the directory to the Sprockets load path") do |directory|
+  #   environment.append_path directory
+  # end
+
+  opts.on("-e", "--exclude [file]", "Skip files/directories named FILE when generating the site") do |file|
+    Soundwave.config.exclude << file
+  end
+
+  opts.on("--version", "Display current version") do
+    puts "Soundwave " + Soundwave::VERSION
+    exit 0
+  end
+
+  opts.on("--watch", "Automatically regenerate when files are changed") do
+    options["watch"] = true
+  end
+end
+
+opts.parse!
+
+# TODO: Move into Soundwave proper and rename
+if File.exists?("./_soundwave.rb")
+  require "./_soundwave.rb"
+end
+
+environment = Soundwave::Environment.new
+
+if options["watch"]
+  require 'fssm'
+  monitor = FSSM::Monitor.new #(:directories => true)
+
+  entries = Dir.chdir(environment.root_dir.expand_path) { Dir.glob("*") }
+  entries = environment.filter_entries(entries)
+  entries.map! { |e| environment.root_dir.join(e) }
+  
+  directories = entries.select { |e| e.directory? }
+  indiv_files = entries - directories
+
+  # Also monitor the data and includes directories
+  directories.push environment.data_dir
+  directories.push environment.root_dir.join("_includes")
+
+  directories.each do |dir_path|
+    monitor.path(dir_path) do
+      update { |base_dir, relative_path|
+        environment.generate_site
+      } 
+    end
+  end
+
+  indiv_files.each do |file_path|
+    monitor.file(file_path) do
+      update { |full_path, relative_dir|
+        environment.generate_site
+      } 
+    end
+  end
+
+  environment.generate_site
+  puts "Now watching for changes in #{environment.root_dir}..."
+  monitor.run
+else
+  environment.generate_site
+  exit(0)
+end

data/lib/soundwave/document.rb

@@ -0,0 +1,34 @@
+module Soundwave
+  class Document
+
+    attr_reader :mtime, :pathname, :logical_path
+
+    def initialize(env, logical_path, absolute_path=nil)
+      @env = env
+      @logical_path = logical_path
+      @pathname = Pathname(absolute_path || env.root_dir.join(logical_path))
+      refresh
+    end
+
+    def output_path
+      @env.output_dir.join(@logical_path)
+    end
+
+    def changed?
+      @mtime != @pathname.stat.mtime
+      true
+    end
+
+    def refresh
+      @mtime = @pathname.stat.mtime
+    end
+
+    def file_attributes
+      @env.attributes_for(self.pathname)
+    end
+
+    def write
+      # Stub: override this in a subclass
+    end
+  end
+end

data/lib/soundwave/environment.rb

@@ -0,0 +1,102 @@
+require 'active_support/callbacks'
+require 'tilt'
+
+module Soundwave
+  class Environment
+    include ActiveSupport::Callbacks
+    define_callbacks :read
+    define_callbacks :generate
+
+    attr_accessor :root_dir, :output_dir, :exclude, :data_dir
+
+    def initialize(root="./")
+      @root_dir     = Pathname(root).expand_path
+      @exclude      = Soundwave.config.exclude
+      @output_dir ||= @root_dir.join("_site")
+      @data_dir   ||= @root_dir.join("_data")
+
+      register_engine ".mustache", Soundwave::MustacheTemplate
+      register_engine ".scss",     Tilt::ScssTemplate
+      register_engine ".erb",      Tilt::ERBTemplate
+    end
+
+    def site_data
+      # TODO: Implement something for getting global/site-level data from _data/_site.(yml|json)
+      {}
+    end
+
+    def pages
+      @pages ||= {}
+    end
+
+    def engines(ext)
+      @engines[ext]
+    end
+
+    def register_engine(ext, engine)
+      @engines ||= {}
+      @engines[ext] = engine
+    end
+
+    def attributes_for(pathname)
+      FileAttributes.new(self, pathname) 
+    end
+
+    def build_page(logical_path, pathname)
+      attrs = attributes_for(pathname)
+
+      if attrs.engines.any?
+        RenderedPage.new(self, logical_path, pathname)
+      else
+        StaticFile.new(self, logical_path, pathname)
+      end
+    end
+
+    def read_directories(dir='')
+      base = File.join(self.root_dir, dir)
+      entries = Dir.chdir(base) { filter_entries(Dir['*']) }
+      entries.each do |entry|
+        absolute_path = File.join(base, entry)
+        relative_path = File.join(dir, entry)
+        logical_path = absolute_path.sub(self.root_dir.to_s, "")
+
+        if File.directory?(absolute_path)
+          read_directories(relative_path)
+        else
+          pathname = Pathname(absolute_path).expand_path
+          attrs = attributes_for(pathname)
+          logical_path = attrs.logical_path
+          pages[logical_path] = build_page(logical_path, pathname)
+        end
+      end
+    end
+
+    def generate
+      run_callbacks(:read) do
+        read_directories
+      end
+      run_callbacks(:generate) do
+        @pages.each do |logical_path, page|
+          puts "#{logical_path} => #{page.output_path}"
+          page.write
+        end
+      end
+    end
+
+    # Deprecated: Alias to #generate for the two extant projects that use this code
+    alias_method :generate_site, :generate
+
+    # Exclude .dotfiles, _underscores, #hashes, ~tildes, paths in @exclude
+    # and symlinks, EXCEPT for .htaccess
+    def filter_entries(entries)
+      entries = entries.reject do |e|
+        unless ['.htaccess'].include?(e)
+          ['.', '_', '#'].include?(e[0..0]) ||
+          e[-1..-1] == '~' ||
+          self.exclude.include?(e) ||
+          File.symlink?(e)
+        end
+      end
+    end
+  end
+end

data/lib/soundwave/file_attributes.rb

@@ -0,0 +1,56 @@
+require 'pathname'
+
+module Soundwave
+  class FileAttributes
+    attr_reader :environment, :pathname
+
+    def initialize(environment, pathname)
+      @environment = environment
+      @pathname = Pathname(pathname)
+    end
+
+    def logical_path
+      if root_path = pathname.expand_path.to_s[environment.root_dir.to_s]
+        path = pathname.to_s.sub("#{root_path}/", '')
+        path = pathname.expand_path.relative_path_from(Pathname.new(root_path)).to_s
+        path = engine_extensions.inject(path) { |p, ext| p.sub(ext, '') }
+        path = "#{path}#{engine_format_extension}" unless format_extension
+        path
+      else
+        raise "File outside paths"
+      end
+    end
+
+    def extensions
+      @extensions ||= @pathname.basename.to_s.scan(/\.[^.]+/)
+    end
+
+    def format_extension
+      extensions.reverse.detect { |ext|
+        # TODO: Environment may need a mime types registry
+        !@environment.engines(ext)
+      }
+    end
+
+    def engine_extensions
+      exts = extensions
+
+      if offset = extensions.index(format_extension)
+        exts = extensions[offset+1..-1]
+      end
+
+      exts.select { |ext| @environment.engines(ext) }
+    end
+
+    def engines
+      engine_extensions.map { |ext| @environment.engines(ext) }
+    end
+
+    private
+
+      def engine_format_extension
+        # TODO: Engines should provide a default extension, this should be engines.first.default_extension
+        ".html"
+      end
+  end
+end

data/lib/soundwave/mustache_template.rb

@@ -0,0 +1,32 @@
+require 'mustache'
+require 'pathname'
+
+module Soundwave
+  # Custom wrapper for Mustache, to enforce Soundwave conventions w/r/t
+  # template and partial naming and provide a Tilt-like interface.
+  class MustacheTemplate < ::Mustache
+
+    # Public: Initializes a new MustacheTemplate
+    #
+    # pathname - Pathname for the template file
+    #
+    # Returns a MustacheTemplate object.
+    def initialize(pathname)
+      @pathname = Pathname(pathname)
+    end
+
+    # Public: Reads the template file from disk and returns its
+    # contents as a String.
+    def template
+      @pathname.read
+    end
+
+    # Public: Reads the partial template with the given name and
+    # returns its contents.
+    def partial(name)
+      # TODO: Make this a teeny bit more robust?
+      name = '_includes/' + name.to_s
+      super
+    end
+  end
+end

data/lib/soundwave/rendered_page.rb

@@ -0,0 +1,69 @@
+require 'mustache'
+
+module Soundwave
+  class RenderedPage < Document
+
+    attr_accessor :data
+    attr_reader :output
+
+    def initialize(env, logical_path, pathname)
+      super
+      @data = {}
+      read_data # is this necessary?
+    end
+    
+    def output_path
+      @env.output_dir.join(logical_path)
+    end
+
+    def mustache
+      MustacheTemplate.new(@pathname)
+    end
+
+    def render
+      read_data
+      result = pathname.read
+      processors.each do |processor|
+        template = processor.new(pathname.to_s) { result }
+        result   = template.render(@data)
+      end
+
+      @output ||= result
+      result
+    end
+    alias_method :to_s, :render
+
+    def write
+      if changed?
+        FileUtils.mkdir_p(output_path.dirname)
+        File.open(output_path, "w") { |f| f.write(self.render()) }
+      end
+    end
+
+  protected
+
+    def processors
+      file_attributes.engines
+    end
+
+    def read_data
+      # Get site data
+      @data = @env.site_data || {}
+
+      basepath = file_attributes.logical_path.sub(/\..+/, '')
+      data_file = @env.data_dir.join(basepath + ".yml")
+
+      if File.exists?(data_file)
+        page_data = YAML.load_file(data_file)
+      else
+        page_data = {}
+      end
+
+      @data.merge!(page_data)
+
+      # TODO: YAML frontmatter?
+
+      @data
+    end
+  end
+end

data/lib/soundwave/static_file.rb

@@ -0,0 +1,10 @@
+module Soundwave
+  class StaticFile < Soundwave::Document
+    def write
+      if changed?
+        FileUtils.mkdir_p(output_path.dirname.to_s)
+        FileUtils.cp(@pathname, output_path)
+      end
+    end
+  end
+end

data/lib/soundwave/utils.rb

@@ -0,0 +1,22 @@
+module Soundwave
+  module Utils
+
+    # Prepends a leading "." to an extension if its missing.
+    #
+    #     normalize_extension("js")
+    #     # => ".js"
+    #
+    #     normalize_extension(".css")
+    #     # => ".css"
+    #
+    def self.normalize_extension(extension)
+      extension = extension.to_s
+      if extension[/^\./]
+        extension
+      else
+        ".#{extension}"
+      end
+    end
+
+  end
+end

data/lib/soundwave/version.rb

@@ -0,0 +1,3 @@
+module Soundwave
+  VERSION = "0.0.1"
+end

data/lib/soundwave.rb

@@ -0,0 +1,17 @@
+require "soundwave/version"
+require "active_support/configurable"
+require "digest/md5"
+
+module Soundwave
+  include ActiveSupport::Configurable
+
+  self.configure do |config|
+    config.exclude = ["bin", "Gemfile", "Gemfile.lock"]
+    config.static_extensions = %w(.jpg .jpeg .png .gif)
+  end
+
+  config_accessor :static_extensions
+end
+
+# Load all submodules
+Dir[File.expand_path("../soundwave/*.rb", __FILE__)].each { |f| require f }

data/soundwave.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/soundwave/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["David Demaree"]
+  gem.email         = ["ddemaree@gmail.com"]
+  gem.description   = %q{A simple static website generator}
+  gem.summary       = %q{A simple static website generator based on Tilt and Mustache}
+  gem.homepage      = "http://github.com/ddemaree/soundwave"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "soundwave"
+  gem.require_paths = ["lib"]
+  gem.version       = Soundwave::VERSION
+
+  gem.executables = ["soundwave"]
+
+  gem.add_runtime_dependency "activesupport", ">= 3.1.0"
+  gem.add_runtime_dependency "mustache"
+  gem.add_runtime_dependency "tilt"
+  gem.add_runtime_dependency "fssm"
+
+  gem.add_development_dependency "bundler"
+  gem.add_development_dependency "rspec", "~> 2.8.0"
+end

data/spec/document_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Soundwave::Document do
+  
+  let(:root_dir)    { File.expand_path("../fixtures/site", __FILE__) }
+  let(:environment) { Soundwave::Environment.new(root_dir) }
+  let(:pathname)    { Pathname(File.join(root_dir, "index.mustache")) }
+  let(:document) { Soundwave::Document.new(environment, "index.html", pathname) }
+
+  describe "change tracking" do
+    it "stores the file's mtime at initialization" do
+      document.mtime.should == pathname.stat.mtime
+    end
+    describe "changed?" do
+      it "compares the current mtime with the cached value" do
+        document
+        sleep 1
+        FileUtils.touch pathname
+        document.should be_changed
+      end
+    end
+    describe "refresh" do
+      it "updates the stored mtime" do
+        document
+        sleep 1
+        FileUtils.touch pathname
+        document.refresh
+        document.should_not be_changed
+      end
+    end
+  end
+
+  describe "output path" do
+    it "is joined on the env's output dir" do
+      document = Soundwave::Document.new(environment, "index.html", pathname)
+      document.output_path.to_s.should == File.join(root_dir, "_site", "index.html")
+    end
+  end
+
+end

data/spec/environment_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+describe Soundwave::Environment do
+  let(:environment) { Soundwave::Environment.new }
+
+  before do
+    FileUtils.cd File.expand_path("../fixtures/site", __FILE__)
+  end
+
+  describe "initialization" do
+    it "creates an environment for the current directory" do
+      env = Soundwave::Environment.new
+      env.root_dir.expand_path.to_s.should == Dir.pwd
+    end
+    it "allows the root directory to be set" do
+      env = Soundwave::Environment.new("/tmp/soundwave")
+      env.root_dir.expand_path.to_s.should == "/tmp/soundwave"
+    end
+  end
+
+  # Indexes the content of the site and stores it as @paths
+  describe "read_directories" do
+    it "indexes pages and static files" do
+      environment.read_directories
+      pages = environment.instance_variable_get("@pages")
+      pages.keys.should have(3).items
+      pages.keys.sort.should == ["about.html", "css/site.css", "index.html"]
+    end
+  end
+
+  describe "filter_entries" do
+    it "filters out _files" do
+      environment.filter_entries(["_file", "a"]).should == ["a"]
+    end
+    it "filters out .files" do
+      environment.filter_entries([".rspec", "a"]).should == ["a"]
+    end
+    it "filters out #files" do
+      environment.filter_entries(["#wtf", "a"]).should == ["a"]
+    end
+    it "filters out files~" do
+      environment.filter_entries(["vimblows~", "~tildesrule", "a"]).should == ["~tildesrule","a"]
+    end
+    it "filters out files listed in #exclude" do
+      old_exclude = environment.exclude
+      environment.stub!(:exclude).and_return(old_exclude + ["Guardfile"])
+      environment.filter_entries(["Guardfile", "a"]).should == ["a"]
+    end
+    it "does not filter out .htaccess" do
+      environment.filter_entries([".htaccess", "a"]).should == [".htaccess", "a"]
+    end
+  end
+
+end

data/spec/file_attributes_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe Soundwave::FileAttributes do
+  let(:root_dir)    { File.expand_path("../fixtures/site", __FILE__) }
+  let(:environment) { Soundwave::Environment.new(root_dir) }
+
+  def attributes_for(pathname)
+    environment.attributes_for(pathname)
+  end
+
+  before do
+    FileUtils.cd(root_dir)
+  end
+
+  describe "logical paths" do
+    it "are relative to the env's root_dir" do
+      attributes_for("about/index.html").logical_path.should == "about/index.html"
+    end
+    it "strip engine extensions" do
+      attributes_for("about.html.mustache").logical_path.should == "about.html"
+    end
+    it "append a default format extension if necessary" do
+      attributes_for("about.mustache").logical_path.should == "about.html"
+    end
+  end
+
+  describe "extensions" do
+    it "gets an array of all extensions" do
+      attributes_for("index.html.mustache").extensions.should == [".html", ".mustache"]
+    end
+    it "gets the format extension" do
+      attributes_for("index.html.mustache").format_extension.should == ".html"
+    end
+    it "gets the engine extension(s)" do
+      attributes_for("index.html.mustache").engine_extensions.should == [".mustache"]
+    end
+    it "allows pathnames with just an engine extension" do
+      attributes_for("about.scss").engine_extensions.should == [".scss"]
+    end
+  end
+end

data/spec/fixtures/site/_data/about.yml

@@ -0,0 +1 @@
+page_title: "About this site"

data/spec/fixtures/site/_data/index.yml

@@ -0,0 +1 @@
+page_title: "Hello World!"

data/spec/fixtures/site/about.mustache.erb

@@ -0,0 +1 @@
+<%= "Title: {{ page_title }}" %>

data/spec/fixtures/site/index.mustache

@@ -0,0 +1,6 @@
+<html>
+  <head><title>{{page_title}}</title></head>
+  <body>
+    <h1>{{page_title}}</h1>
+  </body>
+</html>

data/spec/rendered_page_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Soundwave::RenderedPage do
+  let(:root_dir)    { Pathname(File.expand_path("../fixtures/site", __FILE__)) }
+  let(:environment) { Soundwave::Environment.new(root_dir) }
+
+  let(:pathname) { root_dir.join("index.mustache") }
+  let(:data_pathname) { root_dir.join("_data", "index.yml") }
+  let(:page) { Soundwave::RenderedPage.new(environment, "index.html", pathname) }
+
+  before do
+    FileUtils.cd(root_dir)
+  end
+
+  describe "with data" do
+    it "reads YAML data file on initialization" do
+      page.data.should == {"page_title" => "Hello World!"}
+    end
+    it "sets mtime to data file's mtime if it is later" do
+      pending "Need to add dependency tracking to RenderedPage"
+      FileUtils.touch(pathname)
+      sleep 1
+      FileUtils.touch(data_pathname)
+
+      page.mtime.should == data_pathname.stat.mtime
+    end
+  end
+
+  describe "rendering" do
+    it "renders content with data" do
+      output = page.render
+      output.should == <<-HTML
+<html>
+  <head><title>Hello World!</title></head>
+  <body>
+    <h1>Hello World!</h1>
+  </body>
+</html>
+      HTML
+    end
+    it "can chain multiple engines" do
+      page = Soundwave::RenderedPage.new(environment, "index.html", root_dir.join("about.mustache.erb"))
+      page.data = {"page_title" => "This is page title"}
+      output = page.render
+      output.should == "Title: About this site"
+    end
+  end
+
+end

data/spec/soundwave_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Soundwave do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+# require 'bundler'
+# Bundler.setup
+require 'soundwave'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

data/vendor/source_annotation_extractor.rb

@@ -0,0 +1,102 @@
+# Implements the logic behind the rake tasks for annotations like
+#
+#   rake notes
+#   rake notes:optimize
+#
+# and friends. See <tt>rake -T notes</tt> and <tt>railties/lib/tasks/annotations.rake</tt>.
+#
+# Annotation objects are triplets <tt>:line</tt>, <tt>:tag</tt>, <tt>:text</tt> that
+# represent the line where the annotation lives, its tag, and its text. Note
+# the filename is not stored.
+#
+# Annotations are looked for in comments and modulus whitespace they have to
+# start with the tag optionally followed by a colon. Everything up to the end
+# of the line (or closing ERB comment tag) is considered to be their text.
+class SourceAnnotationExtractor
+  class Annotation < Struct.new(:line, :tag, :text)
+
+    # Returns a representation of the annotation that looks like this:
+    #
+    #   [126] [TODO] This algorithm is simple and clearly correct, make it faster.
+    #
+    # If +options+ has a flag <tt>:tag</tt> the tag is shown as in the example above.
+    # Otherwise the string contains just line and text.
+    def to_s(options={})
+      s = "[%3d] " % line
+      s << "[#{tag}] " if options[:tag]
+      s << text
+    end
+  end
+
+  # Prints all annotations with tag +tag+ under the root directories +app+, +lib+,
+  # and +test+ (recursively). Only filenames with extension +.builder+, +.rb+,
+  # +.rxml+, +.rhtml+, or +.erb+ are taken into account. The +options+
+  # hash is passed to each annotation's +to_s+.
+  #
+  # This class method is the single entry point for the rake tasks.
+  def self.enumerate(tag, options={})
+    extractor = new(tag)
+    extractor.display(extractor.find, options)
+  end
+
+  attr_reader :tag
+
+  def initialize(tag)
+    @tag = tag
+  end
+
+  # Returns a hash that maps filenames under +dirs+ (recursively) to arrays
+  # with their annotations. Only files with annotations are included, and only
+  # those with extension +.builder+, +.rb+, +.rxml+, +.rhtml+, and +.erb+
+  # are taken into account.
+  def find(dirs=%w(app lib test))
+    dirs.inject({}) { |h, dir| h.update(find_in(dir)) }
+  end
+
+  # Returns a hash that maps filenames under +dir+ (recursively) to arrays
+  # with their annotations. Only files with annotations are included, and only
+  # those with extension +.builder+, +.rb+, +.rxml+, +.rhtml+, and +.erb+
+  # are taken into account.
+  def find_in(dir)
+    results = {}
+
+    Dir.glob("#{dir}/*") do |item|
+      next if File.basename(item)[0] == ?.
+
+      if File.directory?(item)
+        results.update(find_in(item))
+      elsif item =~ /\.(builder|(r(?:b|xml|js)))$/
+        results.update(extract_annotations_from(item, /#\s*(#{tag}):?\s*(.*)$/))
+      elsif item =~ /\.(rhtml|erb)$/
+        results.update(extract_annotations_from(item, /<%\s*#\s*(#{tag}):?\s*(.*?)\s*%>/))
+      end
+    end
+
+    results
+  end
+
+  # If +file+ is the filename of a file that contains annotations this method returns
+  # a hash with a single entry that maps +file+ to an array of its annotations.
+  # Otherwise it returns an empty hash.
+  def extract_annotations_from(file, pattern)
+    lineno = 0
+    result = File.readlines(file).inject([]) do |list, line|
+      lineno += 1
+      next list unless line =~ pattern
+      list << Annotation.new(lineno, $1, $2)
+    end
+    result.empty? ? {} : { file => result }
+  end
+
+  # Prints the mapping from filenames to annotations in +results+ ordered by filename.
+  # The +options+ hash is passed to each annotation's +to_s+.
+  def display(results, options={})
+    results.keys.sort.each do |file|
+      puts "#{file}:"
+      results[file].each do |note|
+        puts "  * #{note.to_s(options)}"
+      end
+      puts
+    end
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: soundwave
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Demaree
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70334812682320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70334812682320
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: &70334812681460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70334812681460
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: &70334812680460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70334812680460
+- !ruby/object:Gem::Dependency
+  name: fssm
+  requirement: &70334812679880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70334812679880
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70334812679220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70334812679220
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70334812678060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70334812678060
+description: A simple static website generator
+email:
+- ddemaree@gmail.com
+executables:
+- soundwave
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/soundwave
+- lib/soundwave.rb
+- lib/soundwave/document.rb
+- lib/soundwave/environment.rb
+- lib/soundwave/file_attributes.rb
+- lib/soundwave/mustache_template.rb
+- lib/soundwave/rendered_page.rb
+- lib/soundwave/static_file.rb
+- lib/soundwave/utils.rb
+- lib/soundwave/version.rb
+- soundwave.gemspec
+- spec/document_spec.rb
+- spec/environment_spec.rb
+- spec/file_attributes_spec.rb
+- spec/fixtures/site/_data/about.yml
+- spec/fixtures/site/_data/index.yml
+- spec/fixtures/site/about.mustache.erb
+- spec/fixtures/site/css/site.css.scss
+- spec/fixtures/site/index.mustache
+- spec/rendered_page_spec.rb
+- spec/soundwave_spec.rb
+- spec/spec_helper.rb
+- vendor/source_annotation_extractor.rb
+homepage: http://github.com/ddemaree/soundwave
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: A simple static website generator based on Tilt and Mustache
+test_files:
+- spec/document_spec.rb
+- spec/environment_spec.rb
+- spec/file_attributes_spec.rb
+- spec/fixtures/site/_data/about.yml
+- spec/fixtures/site/_data/index.yml
+- spec/fixtures/site/about.mustache.erb
+- spec/fixtures/site/css/site.css.scss
+- spec/fixtures/site/index.mustache
+- spec/rendered_page_spec.rb
+- spec/soundwave_spec.rb
+- spec/spec_helper.rb