henshin 0.4.2 → 1.0.0.pre

data/lib/henshin.rb

@@ -1,50 +1,175 @@
-$:.unshift File.dirname(__FILE__)
+$: << File.dirname(__FILE__)
 
-require 'time'
+require 'attr_plus/class'
+require 'fileutils'
+require 'hashie/mash'
+require 'highline'
+require 'tilt'
 require 'yaml'
-require 'pp'
-require 'pathname'
 
-require 'titlecase'
-require 'parsey'
+require 'slim'
+require 'redcarpet'
+Object.send(:remove_const, :RedcarpetCompat) if defined?(::RedcarpetCompat)
 
-require 'henshin/site'
-require 'henshin/plugin'
+require 'henshin/error'
+require 'henshin/safety'
+
+require 'henshin/compressor'
+require 'henshin/compressors/css'
+require 'henshin/compressors/js'
+
+require 'henshin/core_ext'
+require 'henshin/path'
+require 'henshin/scope'
+
+require 'henshin/writer'
+require 'henshin/publisher'
+require 'henshin/publishers/sftp'
 
-require 'henshin/gen'
-require 'henshin/post'
-require 'henshin/static'
+require 'henshin/file'
+require 'henshin/files/attributes'
+require 'henshin/files/abstract'
+require 'henshin/files/physical'
+require 'henshin/files/templatable'
 
-require 'henshin/labels'
-require 'henshin/archive'
-require 'henshin/ext'
+require 'henshin/files/empty_template'
+require 'henshin/files/post'
+require 'henshin/files/template'
+require 'henshin/files/tilt'
+require 'henshin/files/tilt_template'
 
+require 'henshin/package'
+require 'henshin/packages/script'
+require 'henshin/packages/style'
+
+require 'henshin/reader'
+require 'henshin/site'
+require 'henshin/ui'
+require 'henshin/version'
 
 module Henshin
-  
-  # Default options for configuration
-  Defaults = {'title' => 'A site',
-              'file_name' => '<{category}/>{title-with-dashes}.{extension}',
-              'permalink' => '/{year}/{month}/{date}/{title}.html',
-              'plugins' => ['maruku', 'liquid'],
-              'root' => './',
-              'target' => '_site',
-              'exclude' => []}.freeze
-              
-  # Partial regexs for use in parsing file names
-  Partials = {'title' => '([a-zA-Z0-9_ -]+)',
-              'title-with-dashes' => '([a-zA-Z0-9-]+)',
-              'date' => '(\d{4}-\d{2}-\d{2})',
-              'date-time' => '(\d{4}-\d{2}-\d{2} at \d{2}:\d{2})',
-              'xml-date-time' => '(\d{4}-\d{2}-\d{2}T\d{2}:\d{2}(:\d{2})?((\+|-)\d{2}:\d{2})?)',
-              'category' => '([a-zA-Z0-9_ -]+)',
-              'extension' => "([a-zA-Z0-9_-]+)"}.freeze
-  
-  # Reads the current version from VERSION
-  #
-  # @return [String] current version
-  def self.version
-    File.read( File.join(File.dirname(__FILE__), '..', 'VERSION') )
+  extend self
+
+  # Loads the yaml text given returning a Hash with symbol keys.
+  #
+  # @param text [String]
+  # @return [Hash{Symbol=>Object}]
+  def load_yaml(text)
+    (YAML.load(text) || {}).symbolise
+  end
+
+  SETTINGS = {
+    colour:  true,
+    dry_run: false,
+    klass:   Site,
+    local:   false,
+    profile: false,
+    quiet:   false
+  }
+
+  # Sets a global Henshin setting.
+  #
+  # @param key [Symbol]
+  # @example
+  #
+  #   Henshin.set :colour
+  #   Henshin.colour? #=> true
+  #
+  def set(key)
+    SETTINGS[key] = true
+  end
+
+  # Unsets a global Henshin setting.
+  #
+  # @param key [Symbol]
+  # @example
+  #
+  #   Henshin.unset :colour
+  #   Henshin.colour? #=> false
+  #
+  def unset(key)
+    SETTINGS[key] = false
+  end
+
+  # @return Whether to display colourful output.
+  def colour?
+    SETTINGS[:colour]
+  end
+
+  # @return Whether to write files to disk.
+  def dry_run?
+    SETTINGS[:dry_run]
+  end
+
+  # @return Whether to use local referencing urls.
+  # @note This is very much work in progress and does break!
+  def local?
+    SETTINGS[:local]
+  end
+
+  # @return Whether to calculate profiling data.
+  def profile?
+    SETTINGS[:profile]
+  end
+
+  # @return Whether to only show vital output.
+  def quiet?
+    SETTINGS[:quiet]
+  end
+
+  # Set the Site class that is used to build the site.
+  #
+  # @param klass [Class]
+  # @example
+  #
+  #   class MyCoolSite < Henshin::Site
+  #     # ...
+  #   end
+  #
+  #   Henshin.use MyCoolSite
+  #
+  def use(klass)
+    SETTINGS[:klass] = klass
+  end
+
+  # Evaluates the +init.rb+ file if it exists.
+  #
+  # @param root [Pathname] Root of the site.
+  def eval_init(root)
+    if (root + 'init.rb').exist?
+      eval (root + 'init.rb').read
+    end
+  end
+
+  # Builds the site in +root+.
+  #
+  # @param root [Pathname]
+  def build(root, opts={})
+    time = Time.now if profile?
+
+    site   = SETTINGS[:klass].new(root)
+    writer = Writer.new(site.dest)
+    site.write(writer)
+
+    puts "#{Time.now - time}s to build site." if profile?
+  end
+
+  # Publishes the site in +root+.
+  #
+  # @param root [Pathname]
+  def publish(root, opts={})
+    time = Time.now if profile?
+
+    site = SETTINGS[:klass].new(root)
+
+    unless site.config.has_key?(:publish)
+      UI.fail "No publish configuration in config.yml."
+    end
+
+    writer = Publisher::Sftp.create(site.config[:publish])
+    site.write(writer)
+
+    puts "#{Time.now - time}s to publish site." if profile?
   end
 
 end

data/lib/henshin/compressor.rb

@@ -0,0 +1,31 @@
+module Henshin
+
+  # @abstract You need to implement {#compress}.
+  #
+  # Compresses a set of files into one big ol' ugly file.
+  #
+  # @example
+  #
+  #   compressed = Compressor.new(files)
+  #   compressed.compress #=> "..."
+  #
+  class Compressor
+
+    # @param files [Array<File>]
+    def initialize(files=[])
+      @files = files
+    end
+
+    # @return [String] Simply joins the contents of all +files+ into a single
+    #   string separated by newlines.
+    def join
+      @files.map {|file| file.text }.join("\n")
+    end
+
+    # @return [String] The compressed text for the +files+.
+    def compress
+      join
+    end
+  end
+
+end

data/lib/henshin/compressors/css.rb

@@ -0,0 +1,20 @@
+require 'yui/compressor'
+
+module Henshin
+
+  class Compressor
+    # Compresses css files using the yui-compressor.
+    class Css < Compressor
+
+      def initialize(*args)
+        super
+        @compressor = YUI::CssCompressor.new
+      end
+
+      # @return [String] The compressed, joined text from the given css files.
+      def compress
+        @compressor.compress(join)
+      end
+    end
+  end
+end

data/lib/henshin/compressors/js.rb

@@ -0,0 +1,20 @@
+require 'yui/compressor'
+
+module Henshin
+
+  class Compressor
+    # Compresses js files using the yui-compressor.
+    class Js < Compressor
+
+      def initialize(*args)
+        super
+        @compressor = YUI::JavaScriptCompressor.new
+      end
+
+      # @return [String] The compressed, joined text from the given js files.
+      def compress
+        @compressor.compress(join)
+      end
+    end
+  end
+end

data/lib/henshin/core_ext.rb

@@ -0,0 +1,69 @@
+class Hash
+
+  # Changes all keys to symbols, works recursively.
+  #
+  # @example
+  #
+  #   {"a" => 1, "b" => 2}.symbolise
+  #   #=> {:a => 1, :b => 2}
+  #
+  # @return [Hash]
+  def symbolise
+    each_with_object({}) do |(k, v), h|
+      h[k.to_sym] = (v.respond_to?(:symbolise) ? v.symbolise : v)
+    end
+  end
+
+  # Merges the hash given with this hash but deeply.
+  #
+  # @example
+  #
+  #   a = {:person => {:name => "John", :age => 30}}
+  #   b = {:person => {:age => 31, :job => "Dummy"}}
+  #
+  #   a.merge(b)
+  #   #=> {:person => {:age => 31, :job => "Dummy"}}
+  #
+  #   a.deep_merge(b)
+  #   #=> {:person => {:name => "John", :age => 31, :job => "Dummy"}}
+  #
+  # @param other [Hash]
+  # @see http://timelessrepo.com/when-in-doubt
+  def deep_merge(other)
+    m = proc {|_,o,n| o.respond_to?(:merge) ? o.merge(n, &m) : n }
+    merge(other, &m)
+  end
+
+  def to_hash
+    self
+  end
+end
+
+class Pathname
+  def same_type?(other)
+    if relative?
+      other.relative?
+    else
+      other.absolute?
+    end
+  end
+end
+
+class String
+
+  # Converts the string to a format suitable for use as a url.
+  #
+  # @example
+  #
+  #   "Hey, Wait! I've got this string.".slugify
+  #   #=> "hey-wait-ive-got-this-string"
+  #
+  # @return [String]
+  def slugify
+    gsub(/[']+/, '').
+      gsub(/\W+/, ' ').
+      strip.
+      downcase.
+      gsub(' ', '-')
+  end
+end

data/lib/henshin/error.rb

@@ -0,0 +1,28 @@
+module Henshin
+
+  # As most errors will be shown to a user of Henshin, they don't care about
+  # large backtraces. Using {.prettify} limits the backtrace and displays the
+  # message in an easier to read way.
+  class Error
+
+    LIMIT = 3
+
+    # @param msg [String] Message describing the error
+    # @param err [Exception] The exception raised
+    # @example
+    #
+    #   begin
+    #     # an exception is raised
+    #   rescue => err
+    #     Error.prettify 'Something went wrong', err
+    #   end
+    #
+    def self.prettify(msg, err)
+      puts "\n#{msg}".red.bold
+      puts "  #{err.message}"
+      puts err.backtrace.take(LIMIT).map {|l| "    #{l}" }.join("\n")
+      exit 1
+    end
+
+  end
+end

data/lib/henshin/file.rb

@@ -0,0 +1,67 @@
+module Henshin
+
+  # A Factory class which abstracts away the process of creating File (subclass)
+  # objects.
+  #
+  # File types can be registered using {.register} and then the
+  # appropriate class will be used when {.create} is used. You can also add
+  # functionality that is meant for broader use than a specific file type using
+  # modules, these can be registered using the {.apply} method and when
+  # {.create} is called the File will be extended with the correct modules.
+  #
+  # @example
+  #
+  #   class MyFileType < Henshin::File::Physical
+  #     # override some methods...
+  #   end
+  #
+  #   Henshin::File.register /\.abc\Z/, MyFileType
+  #
+  #   module SomeFileRole
+  #     # define some methods...
+  #   end
+  #
+  #   Henshin::File.apply %r{(^|/)special_files/}, SomeFileRole
+  #
+  #   file = Henshin::File.create(site, Pathname.new('special_files/test.abc')
+  #
+  #   file.class                                   #=> MyFileType
+  #   file.singleton_class.include?(SomeFileRole)  #=> true
+  #
+  class File
+
+    @types = []
+    @applies = []
+
+    # Registers a new file type which can then be used by {.create}.
+    #
+    # @param match [#match] Regexp path must match to be +klass+ type
+    # @param klass [Class] Subclass of File
+    def self.register(match, klass)
+      @types.unshift [match, klass]
+    end
+
+    # Registers a module to be applied to files which have a path matching
+    # +match+.
+    #
+    # @param match [#match] Regexp path must match to extend +mod+
+    # @param mod [Module]
+    def self.apply(match, mod)
+      @applies.unshift [match, mod]
+    end
+
+    # Creates a new File, or if possible a subclass of File, depending on the
+    # extension of the path given.
+    #
+    # @param site [Site]
+    # @param path [Pathname]
+    def self.create(site, path)
+      klass = (@types.find {|k,v| k =~ path.to_s } || [nil, File::Physical]).last
+      obj = klass.new(site, path)
+
+      @applies.find_all {|k,v| k =~ path.to_s }.each {|_,v| obj.extend(v) }
+      obj
+    end
+  end
+
+end