bunto 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db4d93530a7eb0e73c615ce0699607440a4dfc3c
+  data.tar.gz: 3817cf82a033d008dad8a0438ddcf303a6d71c16
+SHA512:
+  metadata.gz: b19c626c0e74905faddc592b4c6b832d77c2a65d14dafab7ebd81af6ae77763abf1790555c049685b25df402efb2ab7ab26e83c214755c960ff8395776ae7d57
+  data.tar.gz: aae78e9d6637ac07b5b12f5fa7bc508bf79ef4cc59ec24266b2de8b0cbb5295da8664c0e4dfee1475a2437b77fe73e4f9da0c5ae317310f32cca158ef7fbc6dd

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-present Suriyaa Kudo
+
+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.markdown

@@ -0,0 +1,59 @@
+# ![Bunto](https://cloud.githubusercontent.com/assets/5073946/9288138/f4335fee-4337-11e5-9a28-068900097035.png)
+
+
+> **Bunto** is a Web Application Framework which can be used as a simple, static site generator for personal, project, or organization sites. 
+
+[![Gem Version](https://img.shields.io/gem/v/bunto.svg)][ruby-gems]
+[![Build Status](https://travis-ci.org/bunto/bunto.svg?branch=ruby)][travis]
+<!--
+[![Test Coverage](https://codeclimate.com/github/bunto/bunto/badges/coverage.svg)][coverage]
+[![Code Climate](https://codeclimate.com/github/bunto/bunto/badges/gpa.svg)][codeclimate]
+[![Dependency Status](https://gemnasium.com/bunto/bunto.svg)][gemnasium]
+[![Security](https://hakiri.io/github/bunto/bunto/ruby.svg)][hakiri]
+-->
+
+[ruby-gems]: https://rubygems.org/gems/bunto
+<!--
+[gemnasium]: https://gemnasium.com/bunto/bunto
+[codeclimate]: https://codeclimate.com/github/bunto/bunto
+[coverage]: https://codeclimate.com/github/bunto/bunto/coverage
+[hakiri]: https://hakiri.io/github/bunto/bunto/ruby
+-->
+[travis]: https://travis-ci.org/bunto/bunto
+
+By Suriyaa Kudo, Tom Preston-Werner and many [awesome contributors](https://github.com/bunto/bunto/graphs/contributors)!
+
+Bunto is a Web Application Framework and can be used as a static site generator perfect for personal, project, or organization sites. Think of it like a file-based CMS, without all the complexity. Bunto takes your content, renders HTML and CSS templates, and spits out a complete, static website ready to be served by Apache, hostSE, Nginx or another web server. Bunto is the engine behind [GitHub Pages](http://pages.github.com), which you can use to host sites right from your GitHub repositories.
+
+## Getting Started
+
+* [Install](https://bunto.github.io/bunto/docs/installation/) the gem
+* Read up about its [Usage](https://bunto.github.io/docs/usage/) and [Configuration](https://bunto.github.io/docs/configuration/)
+* Take a gander at some existing [Sites](https://wiki.github.com/bunto/bunto/sites)
+* Fork and [Contribute](https://bunto.github.io/docs/contributing/) your own modifications
+* Have questions? Check out our official forum community [Bunto Talk](https://bunto.github.io/talk/) or [`#bunto` on irc.freenode.net](https://botbot.me/freenode/bunto/)
+
+## Code of Conduct
+
+In order to have a more open and welcoming community, Bunto adheres to a
+[code of conduct](CONDUCT.md) adapted from the Ruby on Rails code of
+conduct.
+
+Please adhere to this code of conduct in any interactions you have in the
+Bunto community. It is strictly enforced on all official Bunto
+repositories, websites, and resources. If you encounter someone violating
+these terms, please let a maintainer (@SuriyaaKudoIsc) know
+and we will address it as soon as possible.
+
+## Diving In
+
+* [Migrate](http://bunto.github.io/import/docs/home/) from your previous system
+* Learn how the [YAML Front Matter](https://bunto.github.io/docs/frontmatter/) works
+* Put information on your site with [Variables](https://bunto.github.io/docs/variables/)
+* Customize the [Permalinks](https://bunto.github.io/docs/permalinks/) your posts are generated with
+* Use the built-in [Liquid Extensions](https://bunto.github.io/docs/templates/) to make your life easier
+* Use custom [Plugins](https://bunto.github.io/docs/plugins/) to generate content specific to your site
+
+## License
+
+See [LICENSE](https://github.com/bunto/bunto/blob/master/LICENSE).

data/bin/bunto

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+STDOUT.sync = true
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w( .. lib ))
+
+require 'bunto'
+require 'mercenary'
+
+Bunto::PluginManager.require_from_bundler
+
+Bunto::Deprecator.process(ARGV)
+
+Mercenary.program(:bunto) do |p|
+  p.version Bunto::VERSION
+  p.description 'Bunto is a static site generator in Ruby'
+  p.syntax 'bunto <subcommand> [options]'
+
+  p.option 'source', '-s', '--source [DIR]', 'Source directory (defaults to ./)'
+  p.option 'destination', '-d', '--destination [DIR]', 'Destination directory (defaults to ./_site)'
+  p.option 'safe', '--safe', 'Safe mode (defaults to false)'
+  p.option 'plugins_dir', '-p', '--plugins PLUGINS_DIR1[,PLUGINS_DIR2[,...]]', Array, 'Plugins directory (defaults to ./_plugins)'
+  p.option 'layouts_dir', '--layouts DIR', String, 'Layouts directory (defaults to ./_layouts)'
+  p.option 'profile', '--profile', 'Generate a Liquid rendering profile'
+
+  Bunto::External.require_if_present(Bunto::External.blessed_gems) do |g|
+    cmd = g.split('-').last
+    p.command(cmd.to_sym) do |c|
+      c.syntax cmd
+      c.action do
+        Bunto.logger.abort_with "You must install the '#{g}' gem to use the 'bunto #{cmd}' command."
+      end
+    end
+  end
+
+  Bunto::Command.subclasses.each { |c| c.init_with_program(p) }
+
+  p.action do |args, _|
+    if args.empty?
+      Bunto.logger.error "A subcommand is required."
+      puts p
+      abort
+    else
+      subcommand = args.first
+      unless p.has_command? subcommand
+        Bunto.logger.abort_with "fatal: 'bunto #{args.first}' could not" \
+          " be found. You may need to install the bunto-#{args.first} gem" \
+          " or a related gem to be able to use this subcommand."
+      end
+    end
+  end
+end

data/lib/bunto.rb

@@ -0,0 +1,179 @@
+$LOAD_PATH.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 'forwardable'
+require 'fileutils'
+require 'time'
+require 'English'
+require 'pathname'
+require 'logger'
+require 'set'
+
+# 3rd party
+require 'safe_yaml/load'
+require 'liquid'
+require 'kramdown'
+require 'colorator'
+
+SafeYAML::OPTIONS[:suppress_warnings] = true
+
+module Bunto
+  # internal requires
+  autoload :Cleaner,             'bunto/cleaner'
+  autoload :Collection,          'bunto/collection'
+  autoload :Configuration,       'bunto/configuration'
+  autoload :Convertible,         'bunto/convertible'
+  autoload :Deprecator,          'bunto/deprecator'
+  autoload :Document,            'bunto/document'
+  autoload :Draft,               'bunto/draft'
+  autoload :EntryFilter,         'bunto/entry_filter'
+  autoload :Errors,              'bunto/errors'
+  autoload :Excerpt,             'bunto/excerpt'
+  autoload :External,            'bunto/external'
+  autoload :Filters,             'bunto/filters'
+  autoload :FrontmatterDefaults, 'bunto/frontmatter_defaults'
+  autoload :Hooks,               'bunto/hooks'
+  autoload :Layout,              'bunto/layout'
+  autoload :CollectionReader,    'bunto/readers/collection_reader'
+  autoload :DataReader,          'bunto/readers/data_reader'
+  autoload :LayoutReader,        'bunto/readers/layout_reader'
+  autoload :PostReader,          'bunto/readers/post_reader'
+  autoload :PageReader,          'bunto/readers/page_reader'
+  autoload :StaticFileReader,    'bunto/readers/static_file_reader'
+  autoload :LogAdapter,          'bunto/log_adapter'
+  autoload :Page,                'bunto/page'
+  autoload :PluginManager,       'bunto/plugin_manager'
+  autoload :Publisher,           'bunto/publisher'
+  autoload :Reader,              'bunto/reader'
+  autoload :Regenerator,         'bunto/regenerator'
+  autoload :RelatedPosts,        'bunto/related_posts'
+  autoload :Renderer,            'bunto/renderer'
+  autoload :LiquidRenderer,      'bunto/liquid_renderer'
+  autoload :Site,                'bunto/site'
+  autoload :StaticFile,          'bunto/static_file'
+  autoload :Stevenson,           'bunto/stevenson'
+  autoload :URL,                 'bunto/url'
+  autoload :Utils,               'bunto/utils'
+  autoload :VERSION,             'bunto/version'
+
+  # extensions
+  require 'bunto/plugin'
+  require 'bunto/converter'
+  require 'bunto/generator'
+  require 'bunto/command'
+  require 'bunto/liquid_extensions'
+
+  class << self
+    # Public: Tells you which Bunto environment you are building in so you can skip tasks
+    # if you need to.  This is useful when doing expensive compression tasks on css and
+    # images and allows you to skip that when working in development.
+
+    def env
+      ENV["BUNTO_ENV"] || "development"
+    end
+
+    # Public: Generate a Bunto 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 Bunto::Configuration::DEFAULTS for a
+    #            list of option names and their defaults.
+    #
+    # Returns the final configuration Hash.
+    def configuration(override = {})
+      config = Configuration[Configuration::DEFAULTS]
+      override = Configuration[override].stringify_keys
+      unless override.delete('skip_config_files')
+        config = config.read_config_files(config.config_files(override))
+      end
+
+      # Merge DEFAULTS < _config.yml < override
+      config = Utils.deep_merge_hashes(config, override).stringify_keys
+      set_timezone(config['timezone']) if config['timezone']
+
+      config
+    end
+
+    # Public: Set the TZ environment variable to use the timezone specified
+    #
+    # timezone - the IANA Time Zone
+    #
+    # Returns nothing
+    def set_timezone(timezone)
+      ENV['TZ'] = timezone
+    end
+
+    # Public: Fetch the logger instance for this Bunto process.
+    #
+    # Returns the LogAdapter instance.
+    def logger
+      @logger ||= LogAdapter.new(Stevenson.new, (ENV["BUNTO_LOG_LEVEL"] || :info).to_sym)
+    end
+
+    # Public: Set the log writer.
+    #         New log writer must respond to the same methods
+    #         as Ruby's interal Logger.
+    #
+    # writer - the new Logger-compatible log transport
+    #
+    # Returns the new logger.
+    def logger=(writer)
+      @logger = LogAdapter.new(writer, (ENV["BUNTO_LOG_LEVEL"] || :info).to_sym)
+    end
+
+    # Public: An array of sites
+    #
+    # Returns the Bunto sites created.
+    def sites
+      @sites ||= []
+    end
+
+    # Public: Ensures the questionable path is prefixed with the base directory
+    #         and prepends the questionable path with the base directory if false.
+    #
+    # base_directory - the directory with which to prefix the questionable path
+    # questionable_path - the path we're unsure about, and want prefixed
+    #
+    # Returns the sanitized path.
+    def sanitized_path(base_directory, questionable_path)
+      return base_directory if base_directory.eql?(questionable_path)
+
+      clean_path = File.expand_path(questionable_path, "/")
+      clean_path = clean_path.sub(/\A\w\:\//, '/')
+
+      if clean_path.start_with?(base_directory.sub(/\A\w\:\//, '/'))
+        clean_path
+      else
+        File.join(base_directory, clean_path)
+      end
+    end
+
+    # Conditional optimizations
+    Bunto::External.require_if_present('liquid-c')
+  end
+end
+
+require "bunto/drops/drop"
+require_all 'bunto/commands'
+require_all 'bunto/converters'
+require_all 'bunto/converters/markdown'
+require_all 'bunto/drops'
+require_all 'bunto/generators'
+require_all 'bunto/tags'
+
+require 'bunto-sass-converter'

data/lib/bunto/cleaner.rb

@@ -0,0 +1,105 @@
+require 'set'
+
+module Bunto
+  # Handles the cleanup of a site's destination before it is built.
+  class Cleaner
+    HIDDEN_FILE_REGEX = /\/\.{1,2}$/
+    attr_reader :site
+
+    def initialize(site)
+      @site = site
+    end
+
+    # Cleans up the site's destination directory
+    def cleanup!
+      FileUtils.rm_rf(obsolete_files)
+      FileUtils.rm_rf(metadata_file) unless @site.incremental?
+    end
+
+    private
+
+    # Private: The list of files and directories to be deleted during cleanup process
+    #
+    # Returns an Array of the file and directory paths
+    def obsolete_files
+      (existing_files - new_files - new_dirs + replaced_files).to_a
+    end
+
+    # Private: The metadata file storing dependency tree and build history
+    #
+    # Returns an Array with the metdata file as the only item
+    def metadata_file
+      [site.regenerator.metadata_file]
+    end
+
+    # Private: The list of existing files, apart from those included in keep_files and hidden files.
+    #
+    # Returns a Set with the file paths
+    def existing_files
+      files = Set.new
+      regex = keep_file_regex
+      dirs = keep_dirs
+
+      Utils.safe_glob(site.in_dest_dir, ["**", "*"], File::FNM_DOTMATCH).each do |file|
+        next if file =~ HIDDEN_FILE_REGEX || file =~ regex || dirs.include?(file)
+        files << file
+      end
+
+      files
+    end
+
+    # Private: The list of files to be created when site is built.
+    #
+    # Returns a Set with the file paths
+    def new_files
+      files = Set.new
+      site.each_site_file { |item| files << item.destination(site.dest) }
+      files
+    end
+
+    # Private: The list of directories to be created when site is built.
+    # These are the parent directories of the files in #new_files.
+    #
+    # Returns a Set with the directory paths
+    def new_dirs
+      new_files.map { |file| parent_dirs(file) }.flatten.to_set
+    end
+
+    # Private: The list of parent directories of a given file
+    #
+    # Returns an Array with the directory paths
+    def parent_dirs(file)
+      parent_dir = File.dirname(file)
+      if parent_dir == site.dest
+        []
+      else
+        [parent_dir] + parent_dirs(parent_dir)
+      end
+    end
+
+    # Private: The list of existing files that will be replaced by a directory during build
+    #
+    # Returns a Set with the file paths
+    def replaced_files
+      new_dirs.select { |dir| File.file?(dir) }.to_set
+    end
+
+    # Private: The list of directories that need to be kept because they are parent directories
+    # of files specified in keep_files
+    #
+    # Returns a Set with the directory paths
+    def keep_dirs
+      site.keep_files.map { |file| parent_dirs(site.in_dest_dir(file)) }.flatten.to_set
+    end
+
+    # Private: Creates a regular expression from the config's keep_files array
+    #
+    # Examples
+    #   ['.git','.svn'] creates the following regex: /\/(\.git|\/.svn)/
+    #
+    # Returns the regular expression
+    def keep_file_regex
+      Regexp.union(site.keep_files)
+    end
+  end
+end

data/lib/bunto/collection.rb

@@ -0,0 +1,205 @@
+module Bunto
+  class Collection
+    attr_reader :site, :label, :metadata
+    attr_writer :docs
+
+    # Create a new Collection.
+    #
+    # site - the site to which this collection belongs.
+    # label - the name of the collection
+    #
+    # Returns nothing.
+    def initialize(site, label)
+      @site     = site
+      @label    = sanitize_label(label)
+      @metadata = extract_metadata
+    end
+
+    # Fetch the Documents in this collection.
+    # Defaults to an empty array if no documents have been read in.
+    #
+    # Returns an array of Bunto::Document objects.
+    def docs
+      @docs ||= []
+    end
+
+    # Override of normal respond_to? to match method_missing's logic for
+    # looking in @data.
+    def respond_to?(method, include_private = false)
+      docs.respond_to?(method.to_sym, include_private) || super
+    end
+
+    # Override of method_missing to check in @data for the key.
+    def method_missing(method, *args, &blck)
+      if docs.respond_to?(method.to_sym)
+        Bunto.logger.warn "Deprecation:", "#{label}.#{method} should be changed to #{label}.docs.#{method}."
+        Bunto.logger.warn "", "Called by #{caller.first}."
+        docs.public_send(method.to_sym, *args, &blck)
+      else
+        super
+      end
+    end
+
+    # Fetch the static files in this collection.
+    # Defaults to an empty array if no static files have been read in.
+    #
+    # Returns an array of Bunto::StaticFile objects.
+    def files
+      @files ||= []
+    end
+
+    # Read the allowed documents into the collection's array of docs.
+    #
+    # Returns the sorted array of docs.
+    def read
+      filtered_entries.each do |file_path|
+        full_path = collection_dir(file_path)
+        next if File.directory?(full_path)
+        if Utils.has_yaml_header? full_path
+          doc = Bunto::Document.new(full_path, { :site => site, :collection => self })
+          doc.read
+          if site.publisher.publish?(doc) || !write?
+            docs << doc
+          else
+            Bunto.logger.debug "Skipped From Publishing:", doc.relative_path
+          end
+        else
+          relative_dir = Bunto.sanitized_path(relative_directory, File.dirname(file_path)).chomp("/.")
+          files << StaticFile.new(site, site.source, relative_dir, File.basename(full_path), self)
+        end
+      end
+      docs.sort!
+    end
+
+    # All the entries in this collection.
+    #
+    # Returns an Array of file paths to the documents in this collection
+    #   relative to the collection's directory
+    def entries
+      return [] unless exists?
+      @entries ||=
+        Utils.safe_glob(collection_dir, ["**", "*.*"]).map do |entry|
+          entry["#{collection_dir}/"] = ''
+          entry
+        end
+    end
+
+    # Filtered version of the entries in this collection.
+    # See `Bunto::EntryFilter#filter` for more information.
+    #
+    # Returns a list of filtered entry paths.
+    def filtered_entries
+      return [] unless exists?
+      @filtered_entries ||=
+        Dir.chdir(directory) do
+          entry_filter.filter(entries).reject do |f|
+            path = collection_dir(f)
+            File.directory?(path) || (File.symlink?(f) && site.safe)
+          end
+        end
+    end
+
+    # The directory for this Collection, relative to the site source.
+    #
+    # Returns a String containing the directory name where the collection
+    #   is stored on the filesystem.
+    def relative_directory
+      @relative_directory ||= "_#{label}"
+    end
+
+    # The full path to the directory containing the collection.
+    #
+    # Returns a String containing th directory name where the collection
+    #   is stored on the filesystem.
+    def directory
+      @directory ||= site.in_source_dir(relative_directory)
+    end
+
+    # The full path to the directory containing the collection, with
+    #   optional subpaths.
+    #
+    # *files - (optional) any other path pieces relative to the
+    #           directory to append to the path
+    #
+    # Returns a String containing th directory name where the collection
+    #   is stored on the filesystem.
+    def collection_dir(*files)
+      return directory if files.empty?
+      site.in_source_dir(relative_directory, *files)
+    end
+
+    # Checks whether the directory "exists" for this collection.
+    # The directory must exist on the filesystem and must not be a symlink
+    #   if in safe mode.
+    #
+    # Returns false if the directory doesn't exist or if it's a symlink
+    #   and we're in safe mode.
+    def exists?
+      File.directory?(directory) && !(File.symlink?(directory) && site.safe)
+    end
+
+    # The entry filter for this collection.
+    # Creates an instance of Bunto::EntryFilter.
+    #
+    # Returns the instance of Bunto::EntryFilter for this collection.
+    def entry_filter
+      @entry_filter ||= Bunto::EntryFilter.new(site, relative_directory)
+    end
+
+    # An inspect string.
+    #
+    # Returns the inspect string
+    def inspect
+      "#<Bunto::Collection @label=#{label} docs=#{docs}>"
+    end
+
+    # Produce a sanitized label name
+    # Label names may not contain anything but alphanumeric characters,
+    #   underscores, and hyphens.
+    #
+    # label - the possibly-unsafe label
+    #
+    # Returns a sanitized version of the label.
+    def sanitize_label(label)
+      label.gsub(/[^a-z0-9_\-\.]/i, '')
+    end
+
+    # Produce a representation of this Collection for use in Liquid.
+    # Exposes two attributes:
+    #   - label
+    #   - docs
+    #
+    # Returns a representation of this collection for use in Liquid.
+    def to_liquid
+      Drops::CollectionDrop.new self
+    end
+
+    # Whether the collection's documents ought to be written as individual
+    #   files in the output.
+    #
+    # Returns true if the 'write' metadata is true, false otherwise.
+    def write?
+      !!metadata.fetch('output', false)
+    end
+
+    # The URL template to render collection's documents at.
+    #
+    # Returns the URL template to render collection's documents at.
+    def url_template
+      @url_template ||= metadata.fetch('permalink') do
+        Utils.add_permalink_suffix("/:collection/:path", site.permalink_style)
+      end
+    end
+
+    # Extract options for this collection from the site configuration.
+    #
+    # Returns the metadata for this collection
+    def extract_metadata
+      if site.config['collections'].is_a?(Hash)
+        site.config['collections'][label] || {}
+      else
+        {}
+      end
+    end
+  end
+end