bunto 3.2.1 → 3.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b6a72b2c296e0ff7b771f3c59f5323253e692a4
-  data.tar.gz: 74867fde8fc979a13b377bffdd737c9587eada07
+  metadata.gz: fc4d2fd1daf376ef5b227a641d9cfae478c88ccf
+  data.tar.gz: 3a52c08ff2176c9e6ccc01dd1a7e40da4cf73bfb
 SHA512:
-  metadata.gz: 139c2359381a93813449163d1858c9a1647dfa3ea11d60d6681e57a1915c641c57ac0b1406762e2ab55afa0bb5082be60aa139ab6414578eabb0db1bc5264329
-  data.tar.gz: a2bc45dc264572fe426cfd5cf1d2cd12342c12e2ae162a5a93b8cde1c9e2ce2480cbd7b2634fc707da10876313dc1f09ebecdf93b7495ee76463311a595a8bd6
+  metadata.gz: bc89a21c76795154d7bf53188ea374fa5afdc70d63b4fd900fa063f8d9d49edeea41c18f186dcb2075afbb92241efc2735c723120c3e25b3bfa2b6ecfb7b855f
+  data.tar.gz: 82ef4cb32b2be7bd8f9c93083f57b3f50b5340c581c2b3bbd4fa31444d3861a625bea8ebf3d01ca90f9af18e60f34a7e0d922cd8dd28c520ed6b068273c5f9b9

data/.rubocop.yml

@@ -4,10 +4,9 @@ AllCops:
   Include:
     - lib/**/*.rb
   Exclude:
-    - lib/bunto/convertible.rb
-    - lib/bunto/document.rb
     - lib/bunto/renderer.rb
     - bin/**/*
+    - exe/**/*
     - benchmark/**/*
     - script/**/*
     - vendor/**/*
@@ -18,17 +17,25 @@ Lint/UnreachableCode:
 Lint/UselessAccessModifier:
   Enabled: false
 Metrics/AbcSize:
-  Max: 20
+  Max: 21
+Metrics/BlockLength:
+  Exclude:
+    - test/**/*.rb
+    - lib/bunto/configuration.rb
+    - rake/*.rake
+    - bunto.gemspec
 Metrics/ClassLength:
   Exclude:
     - !ruby/regexp /features\/.*.rb$/
     - !ruby/regexp /test\/.*.rb$/
   Max: 300
 Metrics/CyclomaticComplexity:
-  Max: 8
+  Max: 9
 Metrics/LineLength:
   Exclude:
     - !ruby/regexp /features\/.*.rb/
+    - Rakefile
+    - rake/*.rake
   Max: 90
   Severity: warning
 Metrics/MethodLength:
@@ -41,6 +48,14 @@ Metrics/ParameterLists:
   Max: 4
 Metrics/PerceivedComplexity:
   Max: 8
+Security/MarshalLoad:
+  Exclude:
+    - !ruby/regexp /test\/.*.rb$/
+    - lib/bunto/regenerator.rb
+Security/YAMLLoad:
+  Exclude:
+    - !ruby/regexp /features\/.*.rb/
+    - !ruby/regexp /test\/.*.rb$/
 Style/Alias:
   Enabled: false
 Style/AlignArray:
@@ -124,5 +139,7 @@ Style/StringLiterals:
   EnforcedStyle: double_quotes
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: consistent_comma
 Style/UnneededCapitalW:
   Enabled: false

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-present Suriyaa Kudo
+Copyright (c) 2014-present Suriyaa Kudo and Bunto contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.markdown

@@ -11,6 +11,7 @@
       <th>CodeShip</th>
       <th>RubyGems</th>
       <th>Gemnasium</th>
+      <th>CLA</th>
     </tr>
   </thead>
   <tbody>
@@ -33,32 +34,32 @@
       <td align="center">
         <a href="https://gemnasium.com/bunto/bunto"><img src="https://gemnasium.com/bunto/bunto.svg" alt="Dependency Status"></a>
       </td>
+      <td align="center">
+        <a href="https://gist.github.com/f76d4854fb196820325ee8a5072a5722"><img src="https://cla-assistant.io/readme/badge/bunto/bunto" alt="CLA assistant"></a>
+      </td>
     </tr>
   </tbody>
 </table>
 
 By Suriyaa Kudo, Tom Preston-Werner, Parker Moore 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](https://pages.github.com), which you can use to host sites right from your GitHub repositories.
+Bunto is a Web Application Framework and can be used as a simple, blog-aware, 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 Markdown and Liquid templates, and spits out a complete, static website ready to be served by Apache, Nginx or another web server. Bunto is the engine behind [GitHub Pages](https://pages.github.com), which you can use to host sites right from your GitHub repositories.
 
 ## Philosophy
 
-Bunto does what you tell it to do — no more, no less. It doesn't try to outsmart users by making bold assumptions, nor does it burden them with needless complexity and configuration. Put simply, Bunto gets out of your way and allows you to concentrate on what truly matters: your content.
+Bunto does what you tell it to do — no more, no less. It doesn't try to outsmart users by making bold assumptions, nor does it burden them with needless complexity and configuration. Put simply, Bunto gets out of your way and allows you to concentrate on what truly matters: your content.
 
-## Getting Started
+## Having trouble with OS X El Capitan?
 
-Bunto will work on most systems out-of-the-box. You need only to install [RubyGems](https://rubygems.org/pages/download) on your system.
-After that run in your command line program this command:
+See: https://buntowaf.tk/docs/troubleshooting/#bunto-amp-mac-os-x-1011
 
-``` bash
-gem install bunto
-```
+## Getting Started
 
-* [Install](https://bunto.github.io/docs/installation/) the gem
-* Read up about its [Usage](https://bunto.github.io/docs/usage/) and [Configuration](https://bunto.github.io/docs/configuration/)
+* [Install](https://buntowaf.tk/docs/installation/) the gem
+* Read up about its [Usage](https://buntowaf.tk/docs/usage/) and [Configuration](https://buntowaf.tk/docs/configuration/)
 * Take a gander at some existing [Sites](https://wiki.github.com/bunto/bunto/sites)
-* [Fork](https://github.com/bunto/bunto/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/)
+* [Fork](https://github.com/bunto/bunto/fork) and [Contribute](https://buntowaf.tk/docs/contributing/) your own modifications
+* Have questions? Check out our official forum community [Bunto Talk](https://talk.buntowaf.tk/) or [`#bunto` on irc.freenode.net](https://botbot.me/freenode/bunto/)
 
 ## Code of Conduct
 
@@ -69,22 +70,16 @@ 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](https://github.com/SuriyaaKudoIsc)) know
-and we will address it as soon as possible.
+these terms, please let a maintainer ([@parkr](https://github.com/parkr), [@envygeeks](https://github.com/envygeeks), [@mattr-](https://github.com/mattr-), or [@alfredxing](https://github.com/alfredxing)) know and we will address it as soon as possible.
 
 ## Diving In
 
-* [Migrate](https://bunto-import.tk/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
-
-## Have a problem? Come chat with us!
-[![Join the chat at https://gitter.im/bunto/bunto](https://badges.gitter.im/bunto/bunto.svg)](https://gitter.im/bunto/bunto?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![IRC - #bunto on freenode WebChat](https://img.shields.io/badge/freenode-bunto-yellowgreen.svg?style=flat)](http://webchat.freenode.net/?channels=bunto)
-[<img src="https://upload.wikimedia.org/wikipedia/commons/0/06/Facebook.svg" width="60">](https://www.facebook.com/groups/BuntoWAF)
+* [Migrate](http://import.buntowaf.tk/docs/home/) from your previous system
+* Learn how the [YAML Front Matter](https://buntowaf.tk/docs/frontmatter/) works
+* Put information on your site with [Variables](https://buntowaf.tk/docs/variables/)
+* Customize the [Permalinks](https://buntowaf.tk/docs/permalinks/) your posts are generated with
+* Use the built-in [Liquid Extensions](https://buntowaf.tk/docs/templates/) to make your life easier
+* Use custom [Plugins](https://buntowaf.tk/docs/plugins/) to generate content specific to your site
 
 ## License
 

data/exe/bunto

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 STDOUT.sync = true
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w(.. lib)))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 
 require "bunto"
 require "mercenary"

data/lib/bunto.rb

@@ -41,7 +41,6 @@ module Bunto
   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"
@@ -55,6 +54,7 @@ module Bunto
   autoload :PostReader,          "bunto/readers/post_reader"
   autoload :PageReader,          "bunto/readers/page_reader"
   autoload :StaticFileReader,    "bunto/readers/static_file_reader"
+  autoload :ThemeAssetsReader,   "bunto/readers/theme_assets_reader"
   autoload :LogAdapter,          "bunto/log_adapter"
   autoload :Page,                "bunto/page"
   autoload :PluginManager,       "bunto/plugin_manager"
@@ -119,7 +119,11 @@ module Bunto
     # Returns nothing
     # rubocop:disable Style/AccessorMethodName
     def set_timezone(timezone)
-      ENV["TZ"] = timezone
+      ENV["TZ"] = if Utils::Platforms.really_windows?
+                    Utils::WinTZ.calculate(timezone)
+                  else
+                    timezone
+                  end
     end
     # rubocop:enable Style/AccessorMethodName
 
@@ -160,11 +164,13 @@ module Bunto
 
       questionable_path.insert(0, "/") if questionable_path.start_with?("~")
       clean_path = File.expand_path(questionable_path, "/")
-      clean_path.sub!(%r!\A\w:/!, "/")
 
-      if clean_path.start_with?(base_directory.sub(%r!\A\w:/!, "/"))
+      return clean_path if clean_path.eql?(base_directory)
+
+      if clean_path.start_with?(base_directory.sub(%r!\z!, "/"))
         clean_path
       else
+        clean_path.sub!(%r!\A\w:/!, "/")
         File.join(base_directory, clean_path)
       end
     end

data/lib/bunto/collection.rb

@@ -32,8 +32,8 @@ module Bunto
     # 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 "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
@@ -197,6 +197,7 @@ module Bunto
     end
 
     private
+
     def read_document(full_path)
       doc = Bunto::Document.new(full_path, :site => site, :collection => self)
       doc.read
@@ -208,14 +209,20 @@ module Bunto
     end
 
     private
+
     def read_static_file(file_path, full_path)
       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)
+      files << StaticFile.new(
+        site,
+        site.source,
+        relative_dir,
+        File.basename(full_path),
+        self
+      )
     end
   end
 end

data/lib/bunto/commands/build.rb

@@ -71,12 +71,27 @@ module Bunto
         #
         # Returns nothing.
         def watch(site, options)
+          # Warn Windows users that they might need to upgrade.
+          if Utils::Platforms.bash_on_windows?
+            Bunto.logger.warn "",
+              "Auto-regeneration may not work on some Windows versions."
+            Bunto.logger.warn "",
+              "Please see: https://github.com/Microsoft/BashOnWindows/issues/216"
+            Bunto.logger.warn "",
+              "If it does not work, please upgrade Bash on Windows or "\
+                "run Bunto with --no-watch."
+          end
+
           External.require_with_graceful_fail "bunto-watch"
           watch_method = Bunto::Watcher.method(:watch)
           if watch_method.parameters.size == 1
-            watch_method.call(options)
+            watch_method.call(
+              options
+            )
           else
-            watch_method.call(options, site)
+            watch_method.call(
+              options, site
+            )
           end
         end
       end # end of class << self

data/lib/bunto/commands/doctor.rb

@@ -35,7 +35,7 @@ module Bunto
             fsnotify_buggy?(site),
             !deprecated_relative_permalinks(site),
             !conflicting_urls(site),
-            !urls_only_differ_by_case(site)
+            !urls_only_differ_by_case(site),
           ].all?
         end
 

data/lib/bunto/commands/new.rb

@@ -11,6 +11,7 @@ module Bunto
 
             c.option "force", "--force", "Force creation even if PATH already exists"
             c.option "blank", "--blank", "Creates scaffolding but with empty files"
+            c.option "skip-bundle", "--skip-bundle", "Skip 'bundle install'"
 
             c.action do |args, options|
               Bunto::Commands::New.process(args, options)
@@ -34,7 +35,7 @@ module Bunto
             create_site new_blog_path
           end
 
-          Bunto.logger.info "New bunto site installed in #{new_blog_path}."
+          after_install(new_blog_path, options)
         end
 
         def create_blank_site(path)
@@ -73,16 +74,20 @@ ruby RUBY_VERSION
 gem "bunto", "#{Bunto::VERSION}"
 
 # This is the default theme for new Bunto sites. You may change this to anything you like.
-gem "minima"
+gem "minima", "~> 2.0"
 
 # If you want to use GitHub Pages, remove the "gem "bunto"" above and
 # uncomment the line below. To upgrade, run `bundle update github-pages`.
 # gem "github-pages", group: :bunto_plugins
 
 # If you have any plugins, put them here!
-# group :bunto_plugins do
-#   gem "bunto-github-metadata", "~> 1.0"
-# end
+group :bunto_plugins do
+   gem "bunto-feed", "~> 0.6"
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+
 RUBY
         end
 
@@ -114,6 +119,31 @@ RUBY
         def scaffold_path
           "_posts/0000-00-00-welcome-to-bunto.markdown.erb"
         end
+
+        # After a new blog has been created, print a success notification and
+        # then automatically execute bundle install from within the new blog dir
+        # unless the user opts to generate a blank blog or skip 'bundle install'.
+
+        def after_install(path, options = {})
+          unless options["blank"] || options["skip-bundle"]
+            bundle_install path
+          end
+
+          Bunto.logger.info "New bunto site installed in #{path.cyan}."
+          Bunto.logger.info "Bundle install skipped." if options["skip-bundle"]
+        end
+
+        def bundle_install(path)
+          Bunto::External.require_with_graceful_fail "bundler"
+          Bunto.logger.info "Running bundle install in #{path.cyan}..."
+          Dir.chdir(path) do
+            process, output = Bunto::Utils::Exec.run("bundle", "install")
+            output.to_s.each_line do |line|
+              Bunto.logger.info("Bundler:".green, line.strip) unless line.to_s.empty?
+            end
+            raise SystemExit unless process.success?
+          end
+        end
       end
     end
   end

data/lib/bunto/commands/new_theme.rb

@@ -16,6 +16,7 @@ class Bunto::Commands::NewTheme < Bunto::Command
       end
     end
 
+    # rubocop:disable Metrics/AbcSize
     def process(args, opts)
       if !args || args.empty?
         raise Bunto::Errors::InvalidThemeName, "You must specify a theme name."
@@ -28,9 +29,10 @@ class Bunto::Commands::NewTheme < Bunto::Command
       end
 
       theme.create!
-      Bunto.logger.info "Your new Bunto theme, #{theme.name}," \
-        " is ready for you in #{theme.path}!"
+      Bunto.logger.info "Your new Bunto theme, #{theme.name.cyan}," \
+        " is ready for you in #{theme.path.to_s.cyan}!"
       Bunto.logger.info "For help getting started, read #{theme.path}/README.md."
     end
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/bunto/commands/serve.rb

@@ -10,9 +10,9 @@ module Bunto
           "ssl_key"            => ["--ssl-key [KEY]", "X.509 (SSL) Private Key."],
           "port"               => ["-P", "--port [PORT]", "Port to listen on"],
           "show_dir_listing"   => ["--show-dir-listing",
-            "Show a directory listing instead of loading your index file."],
+            "Show a directory listing instead of loading your index file.",],
           "skip_initial_build" => ["skip_initial_build", "--skip-initial-build",
-            "Skips the initial site build which occurs before the server is started."]
+            "Skips the initial site build which occurs before the server is started.",],
         }.freeze
 
         #
@@ -33,6 +33,7 @@ module Bunto
               opts["serving"] = true
               opts["watch"  ] = true unless opts.key?("watch")
               config = opts["config"]
+              opts["url"] = default_url(opts) if Bunto.env == "development"
               Build.process(opts)
               opts["config"] = config
               Serve.process(opts)
@@ -47,11 +48,7 @@ module Bunto
           destination = opts["destination"]
           setup(destination)
 
-          server = WEBrick::HTTPServer.new(webrick_opts(opts)).tap { |o| o.unmount("") }
-          server.mount(opts["baseurl"], Servlet, destination, file_handler_opts)
-          Bunto.logger.info "Server address:", server_address(server, opts)
-          launch_browser server, opts if opts["open_url"]
-          boot_or_detach server, opts
+          start_up_webrick(opts, destination)
         end
 
         # Do a base pre-setup of WEBRick so that everything is in place
@@ -91,7 +88,7 @@ module Bunto
               index.rhtml
               index.cgi
               index.xml
-            )
+            ),
           }
 
           opts[:DirectoryIndex] = [] if opts[:BuntoOptions]["show_dir_listing"]
@@ -101,6 +98,17 @@ module Bunto
           opts
         end
 
+        #
+
+        private
+        def start_up_webrick(opts, destination)
+          server = WEBrick::HTTPServer.new(webrick_opts(opts)).tap { |o| o.unmount("") }
+          server.mount(opts["baseurl"].to_s, Servlet, destination, file_handler_opts)
+          Bunto.logger.info "Server address:", server_address(server, opts)
+          launch_browser server, opts if opts["open_url"]
+          boot_or_detach server, opts
+        end
+
         # Recreate NondisclosureName under utf-8 circumstance
 
         private
@@ -108,25 +116,47 @@ module Bunto
           WEBrick::Config::FileHandler.merge({
             :FancyIndexing     => true,
             :NondisclosureName => [
-              ".ht*", "~*"
-            ]
+              ".ht*", "~*",
+            ],
           })
         end
 
         #
 
         private
-        def server_address(server, opts)
+        def server_address(server, options = {})
+          format_url(
+            server.config[:SSLEnable],
+            server.config[:BindAddress],
+            server.config[:Port],
+            options["baseurl"]
+          )
+        end
+
+        private
+        def format_url(ssl_enabled, address, port, baseurl = nil)
           format("%{prefix}://%{address}:%{port}%{baseurl}", {
-            :prefix  => server.config[:SSLEnable] ? "https" : "http",
-            :baseurl => opts["baseurl"] ? "#{opts["baseurl"]}/" : "",
-            :address => server.config[:BindAddress],
-            :port    => server.config[:Port]
+            :prefix  => ssl_enabled ? "https" : "http",
+            :address => address,
+            :port    => port,
+            :baseurl => baseurl ? "#{baseurl}/" : "",
           })
         end
 
         #
 
+        private
+        def default_url(opts)
+          config = configuration_from_options(opts)
+          format_url(
+            config["ssl_cert"] && config["ssl_key"],
+            config["host"] == "127.0.0.1" ? "localhost" : config["host"],
+            config["port"]
+          )
+        end
+
+        #
+
         private
         def launch_browser(server, opts)
           address = server_address(server, opts)