bunto 3.0.0 → 3.2.1

data/lib/bunto/deprecator.rb

@@ -9,20 +9,24 @@ module Bunto
                           'serve' subcommand."
       arg_is_present? args, "--no-server", "To build Bunto without launching a server, \
                           use the 'build' subcommand."
-      arg_is_present? args, "--auto", "The switch '--auto' has been replaced with '--watch'."
+      arg_is_present? args, "--auto", "The switch '--auto' has been replaced with \
+                          '--watch'."
       arg_is_present? args, "--no-auto", "To disable auto-replication, simply leave off \
                           the '--watch' switch."
       arg_is_present? args, "--pygments", "The 'pygments'settings has been removed in \
                           favour of 'highlighter'."
-      arg_is_present? args, "--paginate", "The 'paginate' setting can only be set in your \
+      arg_is_present? args, "--paginate", "The 'paginate' setting can only be set in \
+                          your config files."
+      arg_is_present? args, "--url", "The 'url' setting can only be set in your \
                           config files."
-      arg_is_present? args, "--url", "The 'url' setting can only be set in your config files."
       no_subcommand(args)
     end
 
     def no_subcommand(args)
-      if args.size > 0 && args.first =~ /^--/ && !%w(--help --version).include?(args.first)
-        deprecation_message "Bunto now uses subcommands instead of just switches. Run `bunto help` to find out more."
+      unless args.empty? ||
+          args.first !~ %r(!/^--/!) || %w(--help --version).include?(args.first)
+        deprecation_message "Bunto now uses subcommands instead of just switches. \
+                          Run `bunto help` to find out more."
         abort
       end
     end
@@ -39,7 +43,8 @@ module Bunto
 
     def defaults_deprecate_type(old, current)
       Bunto.logger.warn "Defaults:", "The '#{old}' type has become '#{current}'."
-      Bunto.logger.warn "Defaults:", "Please update your front-matter defaults to use 'type: #{current}'."
+      Bunto.logger.warn "Defaults:", "Please update your front-matter defaults to use \
+                        'type: #{current}'."
     end
 
   end

data/lib/bunto/desktop.ini

@@ -0,0 +1,2 @@
+[.ShellClassInfo]
+LocalizedResourceName=bunto

data/lib/bunto/document.rb

@@ -7,9 +7,9 @@ module Bunto
     attr_reader :path, :site, :extname, :collection
     attr_accessor :content, :output
 
-    YAML_FRONT_MATTER_REGEXP = /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m
-    DATELESS_FILENAME_MATCHER = /^(.+\/)*(.*)(\.[^.]+)$/
-    DATE_FILENAME_MATCHER = /^(.+\/)*(\d+-\d+-\d+)-(.*)(\.[^.]+)$/
+    YAML_FRONT_MATTER_REGEXP = %r!\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)!m
+    DATELESS_FILENAME_MATCHER = %r!^(?:.+/)*(.*)(\.[^.]+)$!
+    DATE_FILENAME_MATCHER = %r!^(?:.+/)*(\d+-\d+-\d+)-(.*)(\.[^.]+)$!
 
     # Create a new Document.
     #
@@ -51,16 +51,16 @@ module Bunto
     #
     # Returns the merged data.
     def merge_data!(other, source: "YAML front matter")
-      if other.key?('categories') && !other['categories'].nil?
-        if other['categories'].is_a?(String)
-          other['categories'] = other['categories'].split(" ").map(&:strip)
+      if other.key?("categories") && !other["categories"].nil?
+        if other["categories"].is_a?(String)
+          other["categories"] = other["categories"].split(" ").map(&:strip)
         end
-        other['categories'] = (data['categories'] || []) | other['categories']
+        other["categories"] = (data["categories"] || []) | other["categories"]
       end
       Utils.deep_merge_hashes!(data, other)
-      if data.key?('date') && !data['date'].is_a?(Time)
-        data['date'] = Utils.parse_date(
-          data['date'].to_s,
+      if data.key?("date") && !data["date"].is_a?(Time)
+        data["date"] = Utils.parse_date(
+          data["date"].to_s,
           "Document '#{relative_path}' does not have a valid date in the #{source}."
         )
       end
@@ -68,7 +68,7 @@ module Bunto
     end
 
     def date
-      data['date'] ||= (draft? ? source_file_mtime : site.time)
+      data["date"] ||= (draft? ? source_file_mtime : site.time)
     end
 
     def source_file_mtime
@@ -81,7 +81,8 @@ module Bunto
     #
     # Returns whether the document is a draft.
     def draft?
-      data['draft'] ||= relative_path.index(collection.relative_directory).nil? && collection.label == "posts"
+      data["draft"] ||= relative_path.index(collection.relative_directory).nil? &&
+        collection.label == "posts"
     end
 
     # The path to the document, relative to the site source.
@@ -89,7 +90,8 @@ module Bunto
     # Returns a String path which represents the relative path
     #   from the site source to this document
     def relative_path
-      @relative_path ||= Pathname.new(path).relative_path_from(Pathname.new(site.source)).to_s
+      @relative_path ||= Pathname.new(path)
+        .relative_path_from(Pathname.new(site.source)).to_s
     end
 
     # The output extension of the document.
@@ -103,7 +105,7 @@ module Bunto
     #
     # Returns the basename without the file extname.
     def basename_without_ext
-      @basename_without_ext ||= File.basename(path, '.*')
+      @basename_without_ext ||= File.basename(path, ".*")
     end
 
     # The base filename of the document.
@@ -156,7 +158,7 @@ module Bunto
     #
     # Returns true if extname == .coffee, false otherwise.
     def coffeescript_file?
-      '.coffee'.eql?(extname)
+      ".coffee" == extname
     end
 
     # Determine whether the file should be rendered with Liquid.
@@ -195,7 +197,7 @@ module Bunto
     #
     # Returns the permalink or nil if no permalink was set in the data.
     def permalink
-      data && data.is_a?(Hash) && data['permalink']
+      data && data.is_a?(Hash) && data["permalink"]
     end
 
     # The computed URL for the document. See `Bunto::URL#to_s` for more details.
@@ -203,9 +205,9 @@ module Bunto
     # Returns the computed URL for the document.
     def url
       @url = URL.new({
-        :template => url_template,
+        :template     => url_template,
         :placeholders => url_placeholders,
-        :permalink => permalink
+        :permalink    => permalink
       }).to_s
     end
 
@@ -237,18 +239,17 @@ module Bunto
     def write(dest)
       path = destination(dest)
       FileUtils.mkdir_p(File.dirname(path))
-      File.open(path, 'wb') do |f|
-        f.write(output)
-      end
+      File.write(path, output, :mode => "wb")
 
       trigger_hooks(:post_write)
     end
 
     # Whether the file is published or not, as indicated in YAML front-matter
     #
-    # Returns true if the 'published' key is specified in the YAML front-matter and not `false`.
+    # Returns 'false' if the 'published' key is specified in the
+    # YAML front-matter and is 'false'. Otherwise returns 'true'.
     def published?
-      !(data.key?('published') && data['published'] == false)
+      !(data.key?("published") && data["published"] == false)
     end
 
     # Read in the file and assign the content and data based on the file contents.
@@ -263,23 +264,24 @@ module Bunto
         @data = SafeYAML.load_file(path)
       else
         begin
-          defaults = @site.frontmatter_defaults.all(relative_path, collection.label.to_sym)
-          merge_data!(defaults, source: "front matter defaults") unless defaults.empty?
+          defaults = @site.frontmatter_defaults.all(
+            relative_path,
+            collection.label.to_sym
+          )
+          merge_data!(defaults, :source => "front matter defaults") unless defaults.empty?
 
           self.content = File.read(path, Utils.merged_file_read_opts(site, opts))
           if content =~ YAML_FRONT_MATTER_REGEXP
             self.content = $POSTMATCH
             data_file = SafeYAML.load(Regexp.last_match(1))
-            merge_data!(data_file, source: "YAML front matter") if data_file
+            merge_data!(data_file, :source => "YAML front matter") if data_file
           end
 
           post_read
         rescue SyntaxError => e
           Bunto.logger.error "Error:", "YAML Exception reading #{path}: #{e.message}"
-        rescue Exception => e
-          if e.is_a? Bunto::Errors::FatalException
-            raise e
-          end
+        rescue => e
+          raise e if e.is_a? Bunto::Errors::FatalException
           Bunto.logger.error "Error:", "could not read file #{path}: #{e.message}"
         end
       end
@@ -287,19 +289,19 @@ module Bunto
 
     def post_read
       if relative_path =~ DATE_FILENAME_MATCHER
-        date, slug, ext = $2, $3, $4
-        if !data['date'] || data['date'].to_i == site.time.to_i
-          merge_data!({"date" => date}, source: "filename")
+        date, slug, ext = Regexp.last_match.captures
+        if !data["date"] || data["date"].to_i == site.time.to_i
+          merge_data!({ "date" => date }, :source => "filename")
         end
       elsif relative_path =~ DATELESS_FILENAME_MATCHER
-        slug, ext = $2, $3
+        slug, ext = Regexp.last_match.captures
       end
 
       # Try to ensure the user gets a title.
       data["title"] ||= Utils.titleize_slug(slug)
       # Only overwrite slug & ext if they aren't specified.
-      data['slug'] ||= slug
-      data['ext']  ||= ext
+      data["slug"] ||= slug
+      data["ext"]  ||= ext
 
       populate_categories
       populate_tags
@@ -312,16 +314,19 @@ module Bunto
     #
     # Returns nothing.
     def categories_from_path(special_dir)
-      superdirs = relative_path.sub(/#{special_dir}(.*)/, '').split(File::SEPARATOR).reject do |c|
+      superdirs = relative_path.sub(%r!#{special_dir}(.*)!, "")
+        .split(File::SEPARATOR)
+        .reject do |c|
         c.empty? || c.eql?(special_dir) || c.eql?(basename)
       end
-      merge_data!({ 'categories' => superdirs }, source: "file path")
+      merge_data!({ "categories" => superdirs }, :source => "file path")
     end
 
     def populate_categories
       merge_data!({
-        'categories' => (
-          Array(data['categories']) + Utils.pluralized_array_from_hash(data, 'category', 'categories')
+        "categories" => (
+          Array(data["categories"]) +
+          Utils.pluralized_array_from_hash(data, "category", "categories")
         ).map(&:to_s).flatten.uniq
       })
     end
@@ -351,7 +356,7 @@ module Bunto
     #
     # Returns the content of the document
     def to_s
-      output || content || 'NO CONTENT'
+      output || content || "NO CONTENT"
     end
 
     # Compare this document against another document.
@@ -361,8 +366,8 @@ module Bunto
     #   equal or greater than the other doc's path. See String#<=> for more details.
     def <=>(other)
       return nil unless other.respond_to?(:data)
-      cmp = data['date'] <=> other.data['date']
-      cmp = path <=> other.path if cmp.nil? || cmp == 0
+      cmp = data["date"] <=> other.data["date"]
+      cmp = path <=> other.path if cmp.nil? || cmp.zero?
       cmp
     end
 
@@ -380,7 +385,7 @@ module Bunto
     #
     # Returns the document excerpt_separator
     def excerpt_separator
-      (data['excerpt_separator'] || site.config['excerpt_separator']).to_s
+      (data["excerpt_separator"] || site.config["excerpt_separator"]).to_s
     end
 
     # Whether to generate an excerpt
@@ -394,8 +399,6 @@ module Bunto
       pos = collection.docs.index { |post| post.equal?(self) }
       if pos && pos < collection.docs.length - 1
         collection.docs[pos + 1]
-      else
-        nil
       end
     end
 
@@ -403,8 +406,6 @@ module Bunto
       pos = collection.docs.index { |post| post.equal?(self) }
       if pos && pos > 0
         collection.docs[pos - 1]
-      else
-        nil
       end
     end
 
@@ -414,7 +415,7 @@ module Bunto
     end
 
     def id
-      @id ||= File.join(File.dirname(url), (data['slug'] || basename_without_ext).to_s)
+      @id ||= File.join(File.dirname(url), (data["slug"] || basename_without_ext).to_s)
     end
 
     # Calculate related posts.
@@ -433,8 +434,9 @@ module Bunto
     # Override of method_missing to check in @data for the key.
     def method_missing(method, *args, &blck)
       if data.key?(method.to_s)
-        Bunto.logger.warn "Deprecation:", "Document##{method} is now a key in the #data hash."
-        Bunto.logger.warn "", "Called by #{caller.first}."
+        Bunto::Deprecator.deprecation_message "Document##{method} is now a key "\
+                           "in the #data hash."
+        Bunto::Deprecator.deprecation_message "Called by #{caller.first}."
         data[method.to_s]
       else
         super

data/lib/bunto/drops/bunto_drop.rb

@@ -16,6 +16,18 @@ module Bunto
       def environment
         Bunto.env
       end
+
+      def to_h
+        @to_h ||= {
+          "version"     => version,
+          "environment" => environment
+        }
+      end
+
+      def to_json(state = nil)
+        require "json"
+        JSON.generate(to_h, state)
+      end
     end
   end
 end

data/lib/bunto/drops/document_drop.rb

@@ -5,10 +5,12 @@ module Bunto
     class DocumentDrop < Drop
       extend Forwardable
 
+      NESTED_OBJECT_FIELD_BLACKLIST = %w(
+        content output excerpt next previous
+      ).freeze
+
       mutable false
 
-      def_delegator :@obj, :next_doc, :next
-      def_delegator :@obj, :previous_doc, :previous
       def_delegator :@obj, :relative_path, :path
       def_delegators :@obj, :id, :output, :content, :to_s, :relative_path, :url
 
@@ -17,16 +19,49 @@ module Bunto
       end
 
       def excerpt
-        fallback_data['excerpt'].to_s
+        fallback_data["excerpt"].to_s
       end
 
       def <=>(other)
         return nil unless other.is_a? DocumentDrop
-        cmp = self['date'] <=> other['date']
-        cmp = self['path'] <=> other['path'] if cmp.nil? || cmp == 0
+        cmp = self["date"] <=> other["date"]
+        cmp = self["path"] <=> other["path"] if cmp.nil? || cmp.zero?
         cmp
       end
 
+      def previous
+        @obj.previous_doc.to_liquid
+      end
+
+      def next
+        @obj.next_doc.to_liquid
+      end
+
+      # Generate a Hash for use in generating JSON.
+      # This is useful if fields need to be cleared before the JSON can generate.
+      #
+      # state - the JSON::State object which determines the state of current processing.
+      #
+      # Returns a Hash ready for JSON generation.
+      def hash_for_json(state = nil)
+        to_h.tap do |hash|
+          if state && state.depth >= 2
+            hash["previous"] = collapse_document(hash["previous"]) if hash["previous"]
+            hash["next"]     = collapse_document(hash["next"]) if hash["next"]
+          end
+        end
+      end
+
+      # Generate a Hash which breaks the recursive chain.
+      # Certain fields which are normally available are omitted.
+      #
+      # Returns a Hash with only non-recursive fields present.
+      def collapse_document(doc)
+        doc.keys.each_with_object({}) do |(key, _), result|
+          result[key] = doc[key] unless NESTED_OBJECT_FIELD_BLACKLIST.include?(key)
+        end
+      end
+
       private
       def_delegator :@obj, :data, :fallback_data
     end

data/lib/bunto/drops/drop.rb

@@ -3,7 +3,9 @@
 module Bunto
   module Drops
     class Drop < Liquid::Drop
-      NON_CONTENT_METHODS = [:[], :[]=, :inspect, :to_h, :fallback_data].freeze
+      include Enumerable
+
+      NON_CONTENT_METHODS = [:fallback_data, :collapse_document].freeze
 
       # Get or set whether the drop class is mutable.
       # Mutability determines whether or not pre-defined fields may be
@@ -13,11 +15,11 @@ module Bunto
       #
       # Returns the mutability of the class
       def self.mutable(is_mutable = nil)
-        if is_mutable
-          @is_mutable = is_mutable
-        else
-          @is_mutable = false
-        end
+        @is_mutable = if is_mutable
+                        is_mutable
+                      else
+                        false
+                      end
       end
 
       def self.mutable?
@@ -86,7 +88,9 @@ module Bunto
       # Returns an Array of strings which represent method-specific keys.
       def content_methods
         @content_methods ||= (
-          self.class.instance_methods(false) - NON_CONTENT_METHODS
+          self.class.instance_methods \
+            - Bunto::Drops::Drop.instance_methods \
+            - NON_CONTENT_METHODS
         ).map(&:to_s).reject do |method|
           method.end_with?("=")
         end
@@ -98,8 +102,8 @@ module Bunto
       #
       # Returns true if the given key is present
       def key?(key)
-        if self.class.mutable && @mutations.key?(key)
-          true
+        if self.class.mutable
+          @mutations.key?(key)
         else
           respond_to?(key) || fallback_data.key?(key)
         end
@@ -134,10 +138,28 @@ module Bunto
       #
       # Returns a pretty generation of the hash representation of the Drop.
       def inspect
-        require 'json'
+        require "json"
         JSON.pretty_generate to_h
       end
 
+      # Generate a Hash for use in generating JSON.
+      # This is useful if fields need to be cleared before the JSON can generate.
+      #
+      # Returns a Hash ready for JSON generation.
+      def hash_for_json(*)
+        to_h
+      end
+
+      # Generate a JSON representation of the Drop.
+      #
+      # state - the JSON::State object which determines the state of current processing.
+      #
+      # Returns a JSON representation of the Drop in a String.
+      def to_json(state = nil)
+        require "json"
+        JSON.generate(hash_for_json(state), state)
+      end
+
       # Collects all the keys and passes each to the block in turn.
       #
       # block - a block which accepts one argument, the key
@@ -147,6 +169,12 @@ module Bunto
         keys.each(&block)
       end
 
+      def each
+        each_key.each do |key|
+          yield key, self[key]
+        end
+      end
+
       def merge(other, &block)
         self.dup.tap do |me|
           if block.nil?
@@ -171,6 +199,17 @@ module Bunto
           end
         end
       end
+
+      # Imitate Hash.fetch method in Drop
+      #
+      # Returns value if key is present in Drop, otherwise returns default value
+      # KeyError is raised if key is not present and no default value given
+      def fetch(key, default = nil, &block)
+        return self[key] if key?(key)
+        raise KeyError, %(key not found: "#{key}") if default.nil? && block.nil?
+        return yield(key) unless block.nil?
+        return default unless default.nil?
+      end
     end
   end
 end