homeostasis 0.0.9 → 0.0.10

data/README.md

@@ -1,8 +1,8 @@
 Description
 ===========
 
-Stasis plugin for asset stamping, blogs, front-matter yaml, and trailing
-slashes.
+Stasis plugin for asset stamping, blogs, front-matter yaml, sitemaps, and
+trailing slashes.
 
 Installation
 ============
@@ -35,13 +35,16 @@ You'll end up with something like this:
     styles.sha1.css
 
 Generated files in the `public` directory will go through a global search and
-replace.
+replace.  By default, it'll only do this on `html`, `css`, and `js` files.
+You can configure this:
+
+    Homeostasis::Asset.replace_matcher = /.(html|css|js)$/i
 
 You can set the regex for asset matching in your controller:
 
     Homeostasis::Asset.matcher = /myregex$/i
 
-You can even concat your assets into a single file:
+You can also configure concatenation of multiple assets into a single file:
 
     Homeostasis::Asset.concat 'all.js', %w(jquery.js mine.js)
     Homeostasis::Asset.concat 'all.css', %w(reset.css mine.css)
@@ -106,6 +109,14 @@ cross-page access.
 Note that `:path` is automatically assigned if left blank.  Its value will be
 the public path to the page.
 
+Sitemap
+=======
+
+A sitemap will automatically be generated in `public/sitemap.xml`.  You'll need
+to set the root URL for this to happen:
+
+    Homeostasis.root 'http://example.com'
+
 Trailing Slash
 ==============
 
@@ -125,6 +136,14 @@ You'll get:
 This works well with an `htaccess` file that automatically appends trailing
 slashes to URLs.
 
+TODO
+====
+
+* use Dir.glob with relative paths
+* add tests/coverage
+* RSS generation
+* sitemap generation
+
 License
 =======
 

data/lib/homeostasis.rb

@@ -1,10 +1,284 @@
+require 'rubygems'
+require 'stasis'
+require 'digest/sha1'
+require 'yaml'
+
 module Homeostasis
-  VERSION = '0.0.9'
+  VERSION = '0.0.10'
+
+  class Asset < Stasis::Plugin
+    before_all :before_all
+    after_all  :after_all
+
+    def initialize(stasis)
+      @stasis = stasis
+      @@matcher = /\.(jpg|png|gif|css|js)/i
+      @@replace_matcher = /\.(html|css|js)/i
+      @@mapping = {}
+      @@concats = {}
+      @@orig_concats = {}
+    end
+
+    def before_all
+      # build mapping of relative filenames => destination
+      @stasis.paths.each do |path|
+        next if ignore?(path)
+        relative = path[(@stasis.root.length+1)..-1]
+        ext = Tilt.mappings.keys.find { |ext| File.extname(path)[1..-1] == ext }
+        dest = (ext && File.extname(relative) == ".#{ext}") ?
+          relative[0..-1*ext.length-2] :
+          relative
+        @@mapping[relative] = dest
+      end
+
+      # build orig_concats of destination => [original filenames,]
+      inverted = @@mapping.invert
+      @@concats.each do |dest, files|
+        @@orig_concats[dest] = files.map do |file|
+          raise "Asset not found #{file}" if !inverted.has_key?(file)
+          File.join(@stasis.root, inverted[file])
+        end
+      end
+    end
+
+    def after_all
+      assets = {}
+      strip_dest = (@stasis.destination.length + 1)..-1
+      strip_root = (@stasis.root.length + 1)..-1
+
+      # concatenate files with stamps
+      @@orig_concats.each do |concatted, files|
+        full_concatted = self.class.stamped(
+          File.join(@stasis.destination, concatted),
+          self.class.version(files))
+        content = files.map do |full_orig|
+          orig = full_orig[(@stasis.root.length+1)..-1]
+          full_dest = File.join(@stasis.destination, @@mapping[orig])
+          raise "File not found #{full_dest}" if !File.exists?(full_dest)
+          contents = File.read(full_dest)
+          @@mapping.delete(orig)
+          File.delete(full_dest)
+          contents
+        end.join("\n")
+        File.open(full_concatted, 'w') { |f| f.print(content) }
+        assets[concatted] = full_concatted[strip_dest]
+      end
+
+      # stamp files that don't require concatentation
+      @@mapping.each do |orig, dest|
+        next if dest !~ @@matcher
+        full_orig = File.join(@stasis.root, orig)
+        full_dest = File.join(@stasis.destination, dest)
+        versioned = self.class.stamped(full_dest, self.class.version(full_orig))
+        File.rename(full_dest, versioned)
+        assets[full_dest[strip_dest]] = versioned[strip_dest]
+      end
+
+      # read contents of each file, search/replace assets with stamps
+      Dir.glob("#{@stasis.destination[strip_root]}/**/*").each do |file|
+        next if file !~ @@replace_matcher || File.directory?(file)
+        contents = File.read(file)
+        assets.each do |old, new|
+          old = Regexp.escape(old)
+          contents.gsub!(/([^a-zA-Z0-9\.\-_])#{old}/, "\\1#{new}")
+          contents.gsub!(/^#{old}/, new)
+        end
+        File.open(file, 'w') { |f| f.print(contents) }
+      end
+    end
+
+    def self.stamped(path, version)
+      path = path.split('.')
+      path.insert(path.length > 1 ? -2 : -1, version)
+      path.join('.')
+    end
+
+    def self.version(paths)
+      paths = [paths] if !paths.is_a?(Array)
+      versions = paths.map do |path|
+        log = `git log -n1 #{path} 2> /dev/null`.split("\n")
+        log.length > 1 ? log[0].split(' ').last : '0'
+      end
+      versions.size == 1 ?
+        versions[0] :
+        Digest::SHA1.hexdigest(versions.join('.'))
+    end
+
+    def self.matcher=(regex)
+      @@matcher = regex
+    end
+
+    def self.replace_matcher=(regex)
+      @@replace_matcher = regex
+    end
+
+    def self.concat(dest, files)
+      @@concats[dest] = files
+    end
+
+    private
+    def ignore?(path)
+      @ignore_paths ||= @stasis.plugins.
+        find { |plugin| plugin.class == Stasis::Ignore }.
+        instance_variable_get(:@ignore)
+
+      matches = _match_key?(@ignore_paths, path)
+      matches.each do |group|
+        group.each do |group_path|
+          return true if _within?(group_path)
+        end
+      end
+      false
+    end
+  end
+
+  class Front < Stasis::Plugin
+    before_all    :before_all
+    action_method :front
+    action_method :front_site
+
+    def initialize(stasis)
+      @stasis = stasis
+      @@front_site = {}
+      @@matchers = {
+        'erb'  => /<%#/,
+        'haml' => /-#/,
+        'html' => /<!--/,
+        'md'   => /<!--/
+      }
+    end
+
+    def before_all
+      @stasis.paths.each do |path|
+        next if path !~ /\.(#{@@matchers.keys.join('|')})$/
+        next if (contents = File.read(path)) !~ @@matchers[File.extname(path)[1..-1]]
+
+        lines, data, index = contents.split("\n"), "", 1
+        while index < lines.size
+          break if lines[index] !~ /^  /
+          data += lines[index] + "\n"
+          index += 1
+        end
+
+        relative = path[(@stasis.root.length+1)..-1]
+        ext = Tilt.mappings.keys.find { |ext| File.extname(path)[1..-1] == ext }
+        dest = trailify((ext && File.extname(relative) == ".#{ext}") ?
+          relative[0..-1*ext.length-2] :
+          relative)
+        
+        begin
+          yaml = YAML.load(data)
+          yaml[:path] = dest
+          @@front_site[front_key(path)] = yaml if yaml.is_a?(Hash)
+        rescue Psych::SyntaxError => error
+          @@front_site[front_key(path)] = {:path => dest}
+        end
+      end
+    end
+
+    def front
+      @@front_site[front_key(@stasis.path)] || {}
+    end
+
+    def front_site
+      @@front_site
+    end
+
+    def self._front_site # for other plugins
+      @@front_site
+    end
+
+    def self.matchers=(ext)
+      @@matchers = ext
+    end
+
+    private
+    def front_key(filename)
+      filename.sub(@stasis.root, '')[1..-1]
+    end
+
+    def trailify(filename)
+      @trail_included ||= @stasis.plugins.any? { |plugin| plugin.is_a?(Homeostasis::Trail) }
+      if filename == 'index.html'
+        '/'
+      elsif File.basename(filename) == 'index.html'
+        "/#{File.dirname(filename)}/"
+      elsif @trail_included
+        "/#{filename.sub(/\.html$/, '/')}"
+      else
+        "/#{filename}"
+      end
+    end
+  end
+
+  class Trail < Stasis::Plugin
+    after_all :after_all
+
+    def initialize(stasis)
+      @stasis = stasis
+    end
+
+    def after_all
+      dest = @stasis.destination[(@stasis.root.length + 1)..-1]
+      Dir.glob("#{dest}/**/*.html").each do |filename|
+        next if filename =~ /\/index\.html$/
+        dir = "#{filename.sub(/\.html$/, '')}/"
+        FileUtils.mkdir_p(dir)
+        File.rename(filename, "#{dir}index.html")
+      end
+    end
+  end
+
+  class Blog < Stasis::Plugin
+    DATE_REGEX = /^(\d{4}-\d{2}-\d{2})-/
+    before_all    :before_all
+    after_all     :after_all
+    action_method :blog_posts
+
+    def initialize(stasis)
+      @stasis = stasis
+      @@directory = nil
+      @@posts = []
+    end
+
+    def self.directory(directory)
+      @@directory = directory
+    end
+
+    def before_all
+      return if @@directory.nil?
+      front_site = Homeostasis::Front._front_site
+      Dir.glob("#{File.join(@stasis.root, @@directory)}/*").each do |filename|
+        next if File.basename(filename) !~ DATE_REGEX
+        date = $1
+        post = front_site[filename.sub(@stasis.root, '')[1..-1]] || {}
+        post[:date] = Date.parse(date)
+        post[:path] = post[:path].sub("/#{@@directory}/#{date}-", "/#{@@directory}/")
+        @@posts << post
+      end
+      @@posts = @@posts.sort_by { |post| post[:date] }.reverse
+    end
+
+    def after_all
+      return if @@directory.nil?
+      Dir.glob("#{File.join(@stasis.destination, @@directory)}/*").each do |filename|
+        next if (base = File.basename(filename)) !~ DATE_REGEX
+        FileUtils.mv(
+          filename,
+          File.join(File.dirname(filename), base.sub(DATE_REGEX, '')))
+      end
+    end
+
+    def blog_posts
+      raise 'Homeostasis::Blog#directory never set' if @@directory.nil?
+      @@posts
+    end
+  end
 end
 
-if !ENV['HOMEOSTASIS_BUILD']
-  require File.join(File.dirname(__FILE__), 'homeostasis', 'asset')
-  require File.join(File.dirname(__FILE__), 'homeostasis', 'front')
-  require File.join(File.dirname(__FILE__), 'homeostasis', 'trail')
-  require File.join(File.dirname(__FILE__), 'homeostasis', 'blog')
+if !ENV['HOMEOSTASIS_UNREGISTER']
+  Stasis.register(Homeostasis::Asset)
+  Stasis.register(Homeostasis::Front)
+  Stasis.register(Homeostasis::Trail)
+  Stasis.register(Homeostasis::Blog)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: homeostasis
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-03 00:00:00.000000000 Z
+date: 2012-08-06 00:00:00.000000000 Z
 dependencies: []
 description: Provides asset stamping using git revisions, environments, and a few
   view helpers.
@@ -21,10 +21,6 @@ extra_rdoc_files: []
 files:
 - LICENSE.md
 - README.md
-- lib/homeostasis/trail.rb
-- lib/homeostasis/blog.rb
-- lib/homeostasis/front.rb
-- lib/homeostasis/asset.rb
 - lib/homeostasis.rb
 homepage: https://github.com/hughbien/homeostasis
 licenses: []

data/lib/homeostasis/asset.rb

@@ -1,133 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', 'homeostasis')
-require 'digest/sha1'
-
-class Homeostasis::Asset < Stasis::Plugin
-  before_all :before_all
-  after_all  :after_all
-
-  def initialize(stasis)
-    @stasis = stasis
-    @@matcher = /\.(jpg|png|gif|css|js)/i
-    @@mapping = {}
-    @@concats = {}
-    @@concats_pre = {}
-  end
-
-  def before_all
-    @stasis.paths.each do |path|
-      next if ignore?(path)
-      relative = path[(@stasis.root.length+1)..-1]
-      ext = Tilt.mappings.keys.find { |ext| File.extname(path)[1..-1] == ext }
-      dest = (ext && File.extname(relative) == ".#{ext}") ?
-        relative[0..-1*ext.length-2] :
-        relative
-      @@mapping[relative] = dest
-    end
-    imapping = @@mapping.invert
-    @@concats_pre.each do |dest, files|
-      full_origs = files.map do |file|
-        orig = imapping[file]
-        raise "Asset not found #{file}" if orig.nil?
-        File.join(@stasis.root, imapping[file])
-      end
-      @@concats[dest] = full_origs
-    end
-  end
-
-  def after_all
-    asset_paths = {}
-    @@concats.each do |concatted, files|
-      version = self.class.version(files)
-      full_concatted = File.join(@stasis.destination, concatted)
-      full_concatted = self.class.stamped(full_concatted, version)
-      content = files.map do |full_orig|
-        orig = full_orig[(@stasis.root.length+1)..-1]
-        full_dest = File.join(@stasis.destination, @@mapping[orig])
-        raise "File not found #{full_dest}" if !File.exists?(full_dest)
-        file_contents = File.read(full_dest)
-        @@mapping.delete(orig)
-        File.delete(full_dest)
-        file_contents
-      end.join("\n")
-      File.open(full_concatted, 'w') {|f| f.print(content)}
-      asset_paths[concatted] = full_concatted[(@stasis.destination.length+1)..-1]
-    end
-    @@mapping.each do |orig, dest|
-      next if dest !~ @@matcher
-      full_orig = File.join(@stasis.root, orig)
-      full_dest = File.join(@stasis.destination, dest)
-      versioned = self.class.stamped(full_dest, self.class.version(full_orig))
-      File.rename(full_dest, versioned)
-
-      relative_dest = full_dest[(@stasis.destination.length+1)..-1]
-      relative_versioned = versioned[(@stasis.destination.length+1)..-1]
-      asset_paths[relative_dest] = relative_versioned
-    end
-    (@@mapping.values + asset_paths.values).each do |dest|
-      filename = File.join(@stasis.destination, dest)
-      next if !File.exist?(filename)
-      contents = File.read(filename)
-      begin
-        asset_paths.each do |old, new|
-          contents.gsub!(/([^a-zA-Z0-9\.\-_])#{Regexp.escape(old)}/, "\\1#{new}")
-          contents.gsub!(/^#{Regexp.escape(old)}/, new)
-        end
-        File.open(filename, 'w') {|f| f.print(contents)}
-      rescue ArgumentError
-        next
-      end
-    end
-  end
-
-  def self.stamped(path, version)
-    path = path.split('.')
-    path.insert(
-      path.length > 1 ? -2 : -1,
-      version)
-    path.join('.')
-  end
-
-  def self.version(paths)
-    paths = [paths] if !paths.is_a?(Array)
-    versions = paths.map do |path|
-      log = `git log -n1 #{path} 2> /dev/null`.split("\n")
-      log.length > 1 ? log[0].split(' ').last : '0'
-    end
-    versions.size == 1 ?
-      versions[0] :
-      Digest::SHA1.hexdigest(versions.join('.'))
-  end
-
-  def self.matcher=(regex)
-    @@matcher = regex
-  end
-
-  def self.mapping
-    @@mapping
-  end
-
-  def self.concat(dest, files)
-    @@concats_pre[dest] = files
-  end
-
-  def self.concats
-    @@concats
-  end
-
-  private
-  def ignore?(path)
-    @ignore_paths ||= @stasis.plugins.
-      find { |plugin| plugin.class == Stasis::Ignore }.
-      instance_variable_get(:@ignore)
-
-    matches = _match_key?(@ignore_paths, path)
-    matches.each do |group|
-      group.each do |group_path|
-        return true if _within?(group_path)
-      end
-    end
-    false
-  end
-end
-
-Stasis.register(Homeostasis::Asset)

data/lib/homeostasis/blog.rb

@@ -1,50 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', 'homeostasis')
-require 'date'
-
-class Homeostasis::Blog < Stasis::Plugin
-  before_all    :before_all
-  after_all     :after_all
-  action_method :blog_posts
-
-  def initialize(stasis)
-    @stasis = stasis
-    @@directory = nil
-    @@posts = []
-  end
-
-  def self.directory(directory)
-    @@directory = directory
-  end
-
-  def before_all
-    raise 'Homeostasis::Blog#directory never set' if @@directory.nil?
-    blog_dir = File.join(@stasis.root, @@directory)
-    front_site = Homeostasis::Front._front_site
-    Dir.glob("#{blog_dir}/*").each do |filename|
-      next if File.basename(filename) !~ /^(\d{4}-\d{2}-\d{2})-/
-      date = $1
-      post = front_site[filename.sub(@stasis.root, '')[1..-1]] || {}
-      post[:date] = Date.parse(date)
-      post[:path] = post[:path].sub("/#{@@directory}/#{$1}-", "/#{@@directory}/")
-      @@posts << post
-    end
-    @@posts = @@posts.sort_by {|post| post[:date]}.reverse
-  end
-
-  def after_all
-    return if @@directory.nil?
-    blog_dir = File.join(@stasis.destination, @@directory)
-    Dir.glob("#{blog_dir}/*").each do |filename|
-      next if filename !~ /^\d{4}-\d{2}-\d{2}-/
-      newbase = File.basename(filename).sub(/^(\d{4}-\d{2}-\d{2})-/, '')
-      FileUtils.mv(filename, File.join(File.dirname(filename), newbase))
-    end
-  end
-
-  def blog_posts
-    raise 'Homeostasis::Blog#directory never set' if @@directory.nil?
-    @@posts
-  end
-end
-
-Stasis.register(Homeostasis::Blog)

data/lib/homeostasis/front.rb

@@ -1,89 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', 'homeostasis')
-require 'yaml'
-
-class Homeostasis::Front < Stasis::Plugin
-  before_all    :before_all
-  action_method :front
-  action_method :front_site
-
-  def initialize(stasis)
-    @stasis = stasis
-    @@front_site = {}
-    @@matchers = {
-      'erb'  => /<%#/,
-      'haml' => /-#/,
-      'html' => /<!--/,
-      'md'   => /<!--/
-    }
-  end
-
-  def before_all
-    @stasis.paths.each do |path|
-      next if path !~ /\.(#{@@matchers.keys.join('|')})$/
-      contents = File.read(path)
-      next if contents !~ @@matchers[File.extname(path)[1..-1]]
-
-      lines, data, index = contents.split("\n"), "", 1
-      while index < lines.size
-        break if lines[index] !~ /^  /
-        data += lines[index] + "\n"
-        index += 1
-      end
-
-      relative = path[(@stasis.root.length+1)..-1]
-      ext = Tilt.mappings.keys.find { |ext| File.extname(path)[1..-1] == ext }
-      dest = (ext && File.extname(relative) == ".#{ext}") ?
-        relative[0..-1*ext.length-2] :
-        relative
-      dest = trailify(dest)
-      
-      begin
-        yaml = YAML.load(data)
-        yaml[:path] = dest
-        @@front_site[front_key(path)] = yaml if yaml.is_a?(Hash)
-      rescue Psych::SyntaxError => error
-        @@front_site[front_key(path)] = {:path => dest}
-      end
-    end
-  end
-
-  def front
-    @@front_site[front_key(@stasis.path)] || {}
-  end
-
-  def front_site
-    @@front_site
-  end
-
-  def self._front_site # for other plugins
-    @@front_site
-  end
-
-  def self.matchers
-    @@matchers
-  end
-
-  def self.matchers=(ext)
-    @@matchers = ext
-  end
-
-  private
-  def front_key(filename)
-    filename.sub(@stasis.root, '')[1..-1]
-  end
-
-  def trailify(filename)
-    @trail_included ||= @stasis.plugins.any? {|plugin| plugin.is_a?(Homeostasis::Trail)}
-    if filename == 'index.html'
-      '/'
-    elsif File.basename(filename) == 'index.html'
-      "/#{File.dirname(filename)}/"
-    elsif @trail_included
-      "/#{filename.sub(/\.html$/, '/')}"
-    else
-      "/#{filename}"
-    end
-  end
-end
-
-Stasis.register(Homeostasis::Front)

data/lib/homeostasis/trail.rb

@@ -1,24 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', 'homeostasis')
-
-class Homeostasis::Trail < Stasis::Plugin
-  after_all :after_all
-
-  def initialize(stasis)
-    @stasis = stasis
-  end
-
-  def after_all
-    Dir.glob("#{@stasis.destination}/**/*.html").each do |filename|
-      next if File.basename(filename) == 'index.html'
-      dir = "#{filename[0..-6]}/"
-      if File.exists?("#{dir}index.html")
-        puts "Unable to trail #{filename[(@stasis.destination.length+1)..-1]}"
-      else
-        FileUtils.mkdir_p(dir)
-        File.rename(filename, "#{dir}index.html")
-      end
-    end
-  end
-end
-
-Stasis.register(Homeostasis::Trail)