moft 1.0.0

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+(The MIT License)
+
+Copyright (c) 2008 Tom Preston-Werner
+
+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/bin/moft

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+STDOUT.sync = true
+
+$:.unshift File.join(File.dirname(__FILE__), *%w{ .. lib })
+
+require 'commander/import'
+require 'moft'
+
+Moft::Deprecator.process(ARGV)
+
+program :name, 'moft'
+program :version, Moft::VERSION
+program :description, 'Moft is a static site generator in Ruby, originally forked from Jekyll'
+
+default_command :help
+
+global_option '-s', '--source [DIR]', 'Source directory (defaults to ./)'
+global_option '-d', '--destination [DIR]', 'Destination directory (defaults to ./_site)'
+global_option '--safe', 'Safe mode (defaults to false)'
+global_option '--plugins PLUGINS_DIR1[,PLUGINS_DIR2[,...]]', Array, 'Plugins directory (defaults to ./_plugins)'
+global_option '--layouts', 'Layouts directory (defaults to ./_layouts)'
+
+# Option names don't always directly match the configuration value we'd like.
+# This method will rename options to match what Moft configuration expects.
+#
+# options - The Hash of options from Commander.
+#
+# Returns the normalized Hash.
+def normalize_options(options)
+  if drafts_state = options.delete(:drafts)
+    options[:show_drafts] = drafts_state
+  end
+  options
+end
+
+command :new do |c|
+  c.syntax = 'moft new PATH'
+  c.description = 'Creates a new Moft site scaffold in PATH'
+
+  c.action do |args, options|
+    Moft::Commands::New.process(args)
+  end
+end
+
+command :build do |c|
+  c.syntax = 'moft build [options]'
+  c.description = 'Build your site'
+
+  c.option '--config CONFIG_FILE[,CONFIG_FILE2,...]', Array, 'Custom configuration file'
+  c.option '-w', '--watch', 'Watch for changes and rebuild'
+  c.option '--drafts', 'Render posts in the _drafts folder'
+
+  c.action do |args, options|
+    options = normalize_options(options.__hash__)
+    options = Moft.configuration(options)
+    Moft::Commands::Build.process(options)
+  end
+end
+
+command :serve do |c|
+  c.syntax = 'moft serve [options]'
+  c.description = 'Serve your site locally'
+
+  c.option '--config CONFIG_FILE[,CONFIG_FILE2,...]', Array, 'Custom configuration file'
+  c.option '-w', '--watch', 'Watch for changes and rebuild'
+  c.option '--drafts', 'Render posts in the _drafts folder'
+
+  c.option '-p', '--port [PORT]', 'Port to listen on'
+  c.option '-h', '--host [HOST]', 'Host to bind to'
+  c.option '-b', '--baseurl [URL]', 'Base URL'
+
+  c.action do |args, options|
+    options.default :serving => true
+
+    options = normalize_options(options.__hash__)
+    options = Moft.configuration(options)
+    Moft::Commands::Build.process(options)
+    Moft::Commands::Serve.process(options)
+  end
+end
+alias_command :server, :serve
+
+

data/lib/moft.rb

@@ -0,0 +1,89 @@
+$:.unshift File.dirname(__FILE__) # For use/testing when no gem is installed
+
+# Require all of the Ruby files in the given directory.
+#
+# path - The String relative path from here to the directory.
+#
+# Returns nothing.
+def require_all(path)
+  glob = File.join(File.dirname(__FILE__), path, '*.rb')
+  Dir[glob].each do |f|
+    require f
+  end
+end
+
+# rubygems
+require 'rubygems'
+
+# stdlib
+require 'fileutils'
+require 'time'
+require 'safe_yaml'
+# require 'English'
+
+# 3rd party
+require 'liquid'
+require 'maruku'
+require 'colorator'
+
+# internal requires
+require 'moft/core_ext'
+require 'moft/logger'
+require 'moft/deprecator'
+require 'moft/configuration'
+require 'moft/site'
+require 'moft/convertible'
+require 'moft/layout'
+require 'moft/page'
+require 'moft/post'
+require 'moft/draft'
+require 'moft/filters'
+require 'moft/static_file'
+require 'moft/errors'
+
+# extensions
+require 'moft/plugin'
+require 'moft/converter'
+require 'moft/generator'
+require 'moft/command'
+
+require_all 'moft/commands'
+require_all 'moft/converters'
+require_all 'moft/converters/markdown'
+require_all 'moft/generators'
+require_all 'moft/tags'
+
+SafeYAML::OPTIONS[:suppress_warnings] = true
+
+module Moft
+  VERSION = '1.0.0'
+
+  # Public: Generate a Moft configuration Hash by merging the default
+  # options with anything in _config.yml, and adding the given options on top.
+  #
+  # override - A Hash of config directives that override any options in both
+  #            the defaults and the config file. See Moft::Configuration::DEFAULTS for a
+  #            list of option names and their defaults.
+  #
+  # Returns the final configuration Hash.
+  def self.configuration(override)
+    config = Configuration[Configuration::DEFAULTS]
+    override = Configuration[override].stringify_keys
+    config = config.read_config_files(config.config_files(override))
+
+    # Merge DEFAULTS < _config.yml < override
+    config = config.deep_merge(override).stringify_keys
+    set_timezone(config['timezone']) if config['timezone']
+
+    config
+  end
+
+  # Static: Set the TZ environment variable to use the timezone specified
+  #
+  # timezone - the IANA Time Zone
+  #
+  # Returns nothing
+  def self.set_timezone(timezone)
+    ENV['TZ'] = timezone
+  end
+end

data/lib/moft/command.rb

@@ -0,0 +1,27 @@
+module Moft
+  class Command
+    def self.globs(source, destination)
+      Dir.chdir(source) do
+        dirs = Dir['*'].select { |x| File.directory?(x) }
+        dirs -= [destination, File.expand_path(destination), File.basename(destination)]
+        dirs = dirs.map { |x| "#{x}/**/*" }
+        dirs += ['*']
+      end
+    end
+
+    # Static: Run Site#process and catch errors
+    #
+    # site - the Moft::Site object
+    #
+    # Returns nothing
+    def self.process_site(site)
+      site.process
+    rescue Moft::FatalException => e
+      puts
+      Moft::Logger.error "ERROR:", "YOUR SITE COULD NOT BE BUILT:"
+      Moft::Logger.error "", "------------------------------------"
+      Moft::Logger.error "", e.message
+      exit(1)
+    end
+  end
+end

data/lib/moft/commands/build.rb

@@ -0,0 +1,64 @@
+module Moft
+  module Commands
+    class Build < Command
+      def self.process(options)
+        site = Moft::Site.new(options)
+
+        self.build(site, options)
+        self.watch(site, options) if options['watch']
+      end
+
+      # Private: Build the site from source into destination.
+      #
+      # site - A Moft::Site instance
+      # options - A Hash of options passed to the command
+      #
+      # Returns nothing.
+      def self.build(site, options)
+        source = options['source']
+        destination = options['destination']
+        Moft::Logger.info "Source:", source
+        Moft::Logger.info "Destination:", destination
+        print Moft::Logger.formatted_topic "Generating..."
+        self.process_site(site)
+        puts "done."
+      end
+
+      # Private: Watch for file changes and rebuild the site.
+      #
+      # site - A Moft::Site instance
+      # options - A Hash of options passed to the command
+      #
+      # Returns nothing.
+      def self.watch(site, options)
+        require 'directory_watcher'
+
+        source = options['source']
+        destination = options['destination']
+
+        Moft::Logger.info "Auto-regeneration:", "enabled"
+
+        dw = DirectoryWatcher.new(source, :glob => self.globs(source, destination), :pre_load => true)
+        dw.interval = 1
+
+        dw.add_observer do |*args|
+          t = Time.now.strftime("%Y-%m-%d %H:%M:%S")
+          print Moft::Logger.formatted_topic("Regenerating:") + "#{args.size} files at #{t} "
+          self.process_site(site)
+          puts  "...done."
+        end
+
+        dw.start
+
+        unless options['serving']
+          trap("INT") do
+            puts "     Halting auto-regeneration."
+            exit 0
+          end
+
+          loop { sleep 1000 }
+        end
+      end
+    end
+  end
+end

data/lib/moft/commands/new.rb

@@ -0,0 +1,50 @@
+require 'erb'
+
+module Moft
+  module Commands
+    class New < Command
+      def self.process(args)
+        raise ArgumentError.new('You must specify a path.') if args.empty?
+
+        new_blog_path = File.expand_path(args.join(" "), Dir.pwd)
+        FileUtils.mkdir_p new_blog_path
+        unless Dir["#{new_blog_path}/**/*"].empty?
+          Moft::Logger.error "Conflict:", "#{new_blog_path} exists and is not empty."
+          exit(1)
+        end
+
+        create_sample_files new_blog_path
+
+        File.open(File.expand_path(self.initialized_post_name, new_blog_path), "w") do |f|
+          f.write(self.scaffold_post_content(site_template))
+        end
+        puts "New moft site installed in #{new_blog_path}."
+      end
+
+      def self.scaffold_post_content(template_site)
+        ERB.new(File.read(File.expand_path(scaffold_path, site_template))).result
+      end
+
+      # Internal: Gets the filename of the sample post to be created
+      #
+      # Returns the filename of the sample post, as a String
+      def self.initialized_post_name
+        "_posts/#{Time.now.strftime('%Y-%m-%d')}-welcome-to-moft.markdown"
+      end
+
+      private
+      def self.create_sample_files(path)
+        FileUtils.cp_r site_template + '/.', path
+        FileUtils.rm File.expand_path(scaffold_path, path)
+      end
+
+      def self.site_template
+        File.expand_path("../../site_template", File.dirname(__FILE__))
+      end
+
+      def self.scaffold_path
+        "_posts/0000-00-00-welcome-to-moft.markdown.erb"
+      end
+    end
+  end
+end

data/lib/moft/commands/serve.rb

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+module Moft
+  module Commands
+    class Serve < Command
+      def self.process(options)
+        require 'webrick'
+        include WEBrick
+
+        destination = options['destination']
+
+        FileUtils.mkdir_p(destination)
+
+        mime_types_file = File.expand_path('../mime.types', File.dirname(__FILE__))
+        mime_types = WEBrick::HTTPUtils::load_mime_types(mime_types_file)
+
+        # recreate NondisclosureName under utf-8 circumstance
+        fh_option = WEBrick::Config::FileHandler
+        fh_option[:NondisclosureName] = ['.ht*','~*']
+
+        s = HTTPServer.new(
+          :Port => options['port'],
+          :BindAddress => options['host'],
+          :MimeTypes => mime_types
+        )
+
+        s.mount(options['baseurl'], HTTPServlet::FileHandler, destination, fh_option)
+        t = Thread.new { s.start }
+        trap("INT") { s.shutdown }
+        t.join()
+      end
+    end
+  end
+end

data/lib/moft/configuration.rb

@@ -0,0 +1,171 @@
+# encoding: UTF-8
+
+module Moft
+  class Configuration < Hash
+
+    # Default options. Overriden by values in _config.yml.
+    # Strings rather than symbols are used for compatability with YAML.
+    DEFAULTS = {
+      'source'        => Dir.pwd,
+      'destination'   => File.join(Dir.pwd, '_site'),
+      'plugins'       => '_plugins',
+      'layouts'       => '_layouts',
+      'keep_files'    => ['.git','.svn'],
+
+      'timezone'      => nil,           # use the local timezone
+
+      'safe'          => false,
+      'show_drafts'   => nil,
+      'limit_posts'   => 0,
+      'lsi'           => false,
+      'future'        => true,           # remove and make true just default
+      'pygments'      => true,           # remove and make true just default
+
+      'markdown'      => 'maruku',
+      'permalink'     => 'date',
+      'baseurl'       => '/',
+      'include'       => ['.htaccess'],
+      'exclude'       => [],
+      'paginate_path' => 'page:num',
+
+      'markdown_ext'  => 'markdown,mkd,mkdn,md',
+      'textile_ext'   => 'textile',
+
+      'port'          => '4000',
+      'host'          => '0.0.0.0',
+
+      'excerpt_separator' => "\n\n",
+
+      'maruku' => {
+        'use_tex'    => false,
+        'use_divs'   => false,
+        'png_engine' => 'blahtex',
+        'png_dir'    => 'images/latex',
+        'png_url'    => '/images/latex'
+      },
+
+      'rdiscount' => {
+        'extensions' => []
+      },
+
+      'redcarpet' => {
+        'extensions' => []
+      },
+
+      'kramdown' => {
+        'auto_ids'      => true,
+        'footnote_nr'   => 1,
+        'entity_output' => 'as_char',
+        'toc_levels'    => '1..6',
+        'smart_quotes'  => 'lsquo,rsquo,ldquo,rdquo',
+        'use_coderay'   => false,
+
+        'coderay' => {
+          'coderay_wrap'              => 'div',
+          'coderay_line_numbers'      => 'inline',
+          'coderay_line_number_start' => 1,
+          'coderay_tab_width'         => 4,
+          'coderay_bold_every'        => 10,
+          'coderay_css'               => 'style'
+        }
+      },
+
+      'redcloth' => {
+        'hard_breaks' => true
+      }
+    }
+
+    # Public: Turn all keys into string
+    #
+    # Return a copy of the hash where all its keys are strings
+    def stringify_keys
+      reduce({}) { |hsh,(k,v)| hsh.merge(k.to_s => v) }
+    end
+
+    # Public: Directory of the Moft source folder
+    #
+    # override - the command-line options hash
+    #
+    # Returns the path to the Moft source directory
+    def source(override)
+      override['source'] || self['source'] || DEFAULTS['source']
+    end
+
+    # Public: Generate list of configuration files from the override
+    #
+    # override - the command-line options hash
+    #
+    # Returns an Array of config files
+    def config_files(override)
+      # Get configuration from <source>/_config.yml or <source>/<config_file>
+      config_files = override.delete('config')
+      config_files = File.join(source(override), "_config.yml") if config_files.to_s.empty?
+      config_files = [config_files] unless config_files.is_a? Array
+      config_files
+    end
+
+    # Public: Read configuration and return merged Hash
+    #
+    # file - the path to the YAML file to be read in
+    #
+    # Returns this configuration, overridden by the values in the file
+    def read_config_file(file)
+      next_config = YAML.safe_load_file(file)
+      raise "Configuration file: (INVALID) #{file}".yellow if !next_config.is_a?(Hash)
+      Moft::Logger.info "Configuration file:", file
+      next_config
+    end
+
+    # Public: Read in a list of configuration files and merge with this hash
+    #
+    # files - the list of configuration file paths
+    #
+    # Returns the full configuration, with the defaults overridden by the values in the
+    # configuration files
+    def read_config_files(files)
+      configuration = clone
+
+      begin
+        files.each do |config_file|
+          new_config = read_config_file(config_file)
+          configuration = configuration.deep_merge(new_config)
+        end
+      rescue SystemCallError
+        # Errno:ENOENT = file not found
+        Moft::Logger.warn "Configuration file:", "none"
+      rescue => err
+        Moft::Logger.warn "WARNING:", "Error reading configuration. " +
+                     "Using defaults (and options)."
+        $stderr.puts "#{err}"
+      end
+
+      configuration.backwards_compatibilize
+    end
+
+    # Public: Ensure the proper options are set in the configuration to allow for
+    # backwards-compatibility with Moft pre-1.0
+    #
+    # Returns the backwards-compatible configuration
+    def backwards_compatibilize
+      config = clone
+      # Provide backwards-compatibility
+      if config.has_key?('auto') || config.has_key?('watch')
+        Moft::Logger.warn "Deprecation:", "Auto-regeneration can no longer" +
+                            " be set from your configuration file(s). Use the"+
+                            " --watch/-w command-line option instead."
+        config.delete('auto')
+        config.delete('watch')
+      end
+
+      if config.has_key? 'server'
+        Moft::Logger.warn "Deprecation:", "The 'server' configuration option" +
+                            " is no longer accepted. Use the 'moft serve'" +
+                            " subcommand to serve your site with WEBrick."
+        config.delete('server')
+      end
+
+      config
+    end
+
+  end
+end