bunto 3.0.0 → 3.2.1

data/lib/bunto/tags/highlight.rb

@@ -8,28 +8,15 @@ module Bunto
       # forms: name, name=value, or name="<quoted list>"
       #
       # <quoted list> is a space-separated list of numbers
-      SYNTAX = /^([a-zA-Z0-9.+#-]+)((\s+\w+(=(\w+|"([0-9]+\s)*[0-9]+"))?)*)$/
+      SYNTAX = %r!^([a-zA-Z0-9.+#-]+)((\s+\w+(=(\w+|"([0-9]+\s)*[0-9]+"))?)*)$!
 
       def initialize(tag_name, markup, tokens)
         super
         if markup.strip =~ SYNTAX
           @lang = Regexp.last_match(1).downcase
-          @highlight_options = {}
-          if defined?(Regexp.last_match(2)) && Regexp.last_match(2) != ''
-            # Split along 3 possible forms -- key="<quoted list>", key=value, or key
-            Regexp.last_match(2).scan(/(?:\w="[^"]*"|\w=\w|\w)+/) do |opt|
-              key, value = opt.split('=')
-              # If a quoted list, convert to array
-              if value && value.include?("\"")
-                value.delete!('"')
-                  value = value.split
-              end
-              @highlight_options[key.to_sym] = value || true
-            end
-          end
-          @highlight_options[:linenos] = "inline" if @highlight_options.key?(:linenos) && @highlight_options[:linenos] == true
+          @highlight_options = parse_options(Regexp.last_match(2))
         else
-          raise SyntaxError.new <<-eos
+          raise SyntaxError, <<-eos
 Syntax Error in tag 'highlight' while parsing the following markup:
 
   #{markup}
@@ -42,15 +29,15 @@ eos
       def render(context)
         prefix = context["highlighter_prefix"] || ""
         suffix = context["highlighter_suffix"] || ""
-        code = super.to_s.gsub(/\A(\n|\r)+|(\n|\r)+\z/, '')
+        code = super.to_s.gsub(%r!\A(\n|\r)+|(\n|\r)+\z!, "")
 
         is_safe = !!context.registers[:site].safe
 
         output =
           case context.registers[:site].highlighter
-          when 'pygments'
+          when "pygments"
             render_pygments(code, is_safe)
-          when 'rouge'
+          when "rouge"
             render_rouge(code)
           else
             render_codehighlighter(code)
@@ -66,7 +53,7 @@ eos
             [:startinline, opts.fetch(:startinline, nil)],
             [:hl_lines,    opts.fetch(:hl_lines, nil)],
             [:linenos,     opts.fetch(:linenos, nil)],
-            [:encoding,    opts.fetch(:encoding, 'utf-8')],
+            [:encoding,    opts.fetch(:encoding, "utf-8")],
             [:cssclass,    opts.fetch(:cssclass, nil)]
           ].reject { |f| f.last.nil? }]
         else
@@ -74,8 +61,30 @@ eos
         end
       end
 
+      private
+
+      def parse_options(input)
+        options = {}
+        unless input.empty?
+          # Split along 3 possible forms -- key="<quoted list>", key=value, or key
+          input.scan(%r!(?:\w="[^"]*"|\w=\w|\w)+!) do |opt|
+            key, value = opt.split("=")
+            # If a quoted list, convert to array
+            if value && value.include?("\"")
+              value.delete!('"')
+              value = value.split
+            end
+            options[key.to_sym] = value || true
+          end
+        end
+        if options.key?(:linenos) && options[:linenos] == true
+          options[:linenos] = "inline"
+        end
+        options
+      end
+
       def render_pygments(code, is_safe)
-        Bunto::External.require_with_graceful_fail('pygments')
+        Bunto::External.require_with_graceful_fail("pygments")
 
         highlighted_code = Pygments.highlight(
           code,
@@ -84,22 +93,27 @@ eos
         )
 
         if highlighted_code.nil?
-          Bunto.logger.error "There was an error highlighting your code:"
-          puts
-          Bunto.logger.error code
-          puts
-          Bunto.logger.error "While attempting to convert the above code, Pygments.rb" \
-            " returned an unacceptable value."
-          Bunto.logger.error "This is usually a timeout problem solved by running `bunto build` again."
-          raise ArgumentError.new("Pygments.rb returned an unacceptable value when attempting to highlight some code.")
+          Bunto.logger.error <<eos
+There was an error highlighting your code:
+
+#{code}
+
+While attempting to convert the above code, Pygments.rb returned an unacceptable value.
+This is usually a timeout problem solved by running `bunto build` again.
+eos
+          raise ArgumentError, "Pygments.rb returned an unacceptable value "\
+          "when attempting to highlight some code."
         end
 
-        highlighted_code.sub('<div class="highlight"><pre>', '').sub('</pre></div>', '')
+        highlighted_code.sub('<div class="highlight"><pre>', "").sub("</pre></div>", "")
       end
 
       def render_rouge(code)
-        Bunto::External.require_with_graceful_fail('rouge')
-        formatter = Rouge::Formatters::HTML.new(:line_numbers => @highlight_options[:linenos], :wrap => false)
+        Bunto::External.require_with_graceful_fail("rouge")
+        formatter = Rouge::Formatters::HTML.new(
+          :line_numbers => @highlight_options[:linenos],
+          :wrap         => false
+        )
         lexer = Rouge::Lexer.find_fancy(@lang, code) || Rouge::Lexers::PlainText
         formatter.format(lexer.lex(code))
       end
@@ -110,13 +124,14 @@ eos
 
       def add_code_tag(code)
         code_attributes = [
-          "class=\"language-#{@lang.to_s.tr('+', '-')}\"",
+          "class=\"language-#{@lang.to_s.tr("+", "-")}\"",
           "data-lang=\"#{@lang}\""
         ].join(" ")
-        "<figure class=\"highlight\"><pre><code #{code_attributes}>#{code.chomp}</code></pre></figure>"
+        "<figure class=\"highlight\"><pre><code #{code_attributes}>"\
+        "#{code.chomp}</code></pre></figure>"
       end
     end
   end
 end
 
-Liquid::Template.register_tag('highlight', Bunto::Tags::HighlightBlock)
+Liquid::Template.register_tag("highlight", Bunto::Tags::HighlightBlock)

data/lib/bunto/tags/include.rb

@@ -12,17 +12,23 @@ module Bunto
     end
 
     class IncludeTag < Liquid::Tag
-      VALID_SYNTAX = /([\w-]+)\s*=\s*(?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w\.-]+))/
-      VARIABLE_SYNTAX = /(?<variable>[^{]*(\{\{\s*[\w\-\.]+\s*(\|.*)?\}\}[^\s{}]*)+)(?<params>.*)/
+      VALID_SYNTAX = %r!
+        ([\w-]+)\s*=\s*
+        (?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w\.-]+))
+      !x
+      VARIABLE_SYNTAX = %r!
+        (?<variable>[^{]*(\{\{\s*[\w\-\.]+\s*(\|.*)?\}\}[^\s{}]*)+)
+        (?<params>.*)
+      !x
 
       def initialize(tag_name, markup, tokens)
         super
         matched = markup.strip.match(VARIABLE_SYNTAX)
         if matched
-          @file = matched['variable'].strip
-          @params = matched['params'].strip
+          @file = matched["variable"].strip
+          @params = matched["params"].strip
         else
-          @file, @params = markup.strip.split(' ', 2)
+          @file, @params = markup.strip.split(%r!\s+!, 2)
         end
         validate_params if @params
         @tag_name = tag_name
@@ -36,13 +42,13 @@ module Bunto
         params = {}
         markup = @params
 
-        while match = VALID_SYNTAX.match(markup) do
+        while (match = VALID_SYNTAX.match(markup))
           markup = markup[match.end(0)..-1]
 
           value = if match[2]
-                    match[2].gsub(/\\"/, '"')
+                    match[2].gsub(%r!\\"!, '"')
                   elsif match[3]
-                    match[3].gsub(/\\'/, "'")
+                    match[3].gsub(%r!\\'!, "'")
                   elsif match[4]
                     context[match[4]]
                   end
@@ -53,8 +59,8 @@ module Bunto
       end
 
       def validate_file_name(file)
-        if file !~ /^[a-zA-Z0-9_\/\.-]+$/ || file =~ /\.\// || file =~ /\/\./
-          raise ArgumentError.new <<-eos
+        if file !~ %r!^[a-zA-Z0-9_/\.-]+$! || file =~ %r!\./! || file =~ %r!/\.!
+          raise ArgumentError, <<-eos
 Invalid syntax for include tag. File contains invalid characters or sequences:
 
   #{file}
@@ -68,9 +74,9 @@ eos
       end
 
       def validate_params
-        full_valid_syntax = Regexp.compile('\A\s*(?:' + VALID_SYNTAX.to_s + '(?=\s|\z)\s*)*\z')
+        full_valid_syntax = %r!\A\s*(?:#{VALID_SYNTAX}(?=\s|\z)\s*)*\z!
         unless @params =~ full_valid_syntax
-          raise ArgumentError.new <<-eos
+          raise ArgumentError, <<-eos
 Invalid syntax for include tag:
 
   #{@params}
@@ -91,7 +97,10 @@ eos
       # Render the variable if required
       def render_variable(context)
         if @file.match(VARIABLE_SYNTAX)
-          partial = context.registers[:site].liquid_renderer.file("(variable)").parse(@file)
+          partial = context.registers[:site]
+            .liquid_renderer
+            .file("(variable)")
+            .parse(@file)
           partial.render!(context)
         end
       end
@@ -106,9 +115,9 @@ eos
           path = File.join(dir, file)
           return path if valid_include_file?(path, dir, safe)
         end
-        raise IOError, "Could not locate the included file '#{file}' in any of #{includes_dirs}." \
-          " Ensure it exists in one of those directories and, if it is a symlink, " \
-          "does not point outside your site source."
+        raise IOError, "Could not locate the included file '#{file}' in any of "\
+          "#{includes_dirs}. Ensure it exists in one of those directories and, "\
+          "if it is a symlink, does not point outside your site source."
       end
 
       def render(context)
@@ -120,24 +129,23 @@ eos
         path = locate_include_file(context, file, site.safe)
         return unless path
 
-        # Add include to dependency tree
+        add_include_to_dependency(site, path, context)
+
+        partial = load_cached_partial(path, context)
+
+        context.stack do
+          context["include"] = parse_params(context) if @params
+          partial.render!(context)
+        end
+      end
+
+      def add_include_to_dependency(site, path, context)
         if context.registers[:page] && context.registers[:page].key?("path")
           site.regenerator.add_dependency(
             site.in_source_dir(context.registers[:page]["path"]),
             path
           )
         end
-
-        #begin
-          partial = load_cached_partial(path, context)
-
-          context.stack do
-            context['include'] = parse_params(context) if @params
-            partial.render!(context)
-          end
-          #rescue => e
-          #raise IncludeTagError.new e.message, path
-          #end
       end
 
       def load_cached_partial(path, context)
@@ -147,7 +155,10 @@ eos
         if cached_partial.key?(path)
           cached_partial[path]
         else
-          cached_partial[path] = context.registers[:site].liquid_renderer.file(path).parse(read_file(path, context))
+          cached_partial[path] = context.registers[:site]
+            .liquid_renderer
+            .file(path)
+            .parse(read_file(path, context))
         end
       end
 
@@ -188,5 +199,5 @@ eos
   end
 end
 
-Liquid::Template.register_tag('include', Bunto::Tags::IncludeTag)
-Liquid::Template.register_tag('include_relative', Bunto::Tags::IncludeRelativeTag)
+Liquid::Template.register_tag("include", Bunto::Tags::IncludeTag)
+Liquid::Template.register_tag("include_relative", Bunto::Tags::IncludeRelativeTag)

data/lib/bunto/tags/link.rb

@@ -1,7 +1,11 @@
 module Bunto
   module Tags
     class Link < Liquid::Tag
-      TagName = 'link'
+      class << self
+        def tag_name
+          self.name.split("::").last.downcase
+        end
+      end
 
       def initialize(tag_name, relative_path, tokens)
         super
@@ -16,11 +20,14 @@ module Bunto
           return document.url if document.relative_path == @relative_path
         end
 
-        raise ArgumentError, "Could not find document '#{@relative_path}' in tag '#{TagName}'.\n\n" \
-          "Make sure the document exists and the path is correct."
+        raise ArgumentError, <<eos
+Could not find document '#{@relative_path}' in tag '#{self.class.tag_name}'.
+
+Make sure the document exists and the path is correct.
+eos
       end
     end
   end
 end
 
-Liquid::Template.register_tag(Bunto::Tags::Link::TagName, Bunto::Tags::Link)
+Liquid::Template.register_tag(Bunto::Tags::Link.tag_name, Bunto::Tags::Link)

data/lib/bunto/tags/post_url.rb

@@ -1,20 +1,20 @@
 module Bunto
   module Tags
     class PostComparer
-      MATCHER = /^(.+\/)*(\d+-\d+-\d+)-(.*)$/
+      MATCHER = %r!^(.+/)*(\d+-\d+-\d+)-(.*)$!
 
       attr_reader :path, :date, :slug, :name
 
       def initialize(name)
         @name = name
 
-        all, @path, @date, @slug = *name.sub(/^\//, "").match(MATCHER)
+        all, @path, @date, @slug = *name.sub(%r!^/!, "").match(MATCHER)
         unless all
           raise Bunto::Errors::InvalidPostNameError,
             "'#{name}' does not contain valid date and/or title."
         end
 
-        @name_regex = /^#{path}#{date}-#{slug}\.[^.]+/
+        @name_regex = %r!^#{path}#{date}-#{slug}\.[^.]+!
       end
 
       def post_date
@@ -42,9 +42,9 @@ module Bunto
       def post_slug(other)
         path = other.basename.split("/")[0...-1].join("/")
         if path.nil? || path == ""
-          other.data['slug']
+          other.data["slug"]
         else
-          path + '/' + other.data['slug']
+          path + "/" + other.data["slug"]
         end
       end
     end
@@ -78,7 +78,8 @@ eos
 
         site.posts.docs.each do |p|
           next unless @post.deprecated_equality p
-          Bunto::Deprecator.deprecation_message "A call to '{{ post_url #{@post.name} }}' did not match " \
+          Bunto::Deprecator.deprecation_message "A call to "\
+            "'{{ post_url #{@post.name} }}' did not match " \
             "a post using the new matching method of checking name " \
             "(path-date-slug) equality. Please make sure that you " \
             "change this tag to match the post's name exactly."
@@ -95,4 +96,4 @@ eos
   end
 end
 
-Liquid::Template.register_tag('post_url', Bunto::Tags::PostUrl)
+Liquid::Template.register_tag("post_url", Bunto::Tags::PostUrl)

data/lib/bunto/theme.rb

@@ -10,7 +10,11 @@ module Bunto
     end
 
     def root
-      @root ||= gemspec.full_gem_path
+      # Must use File.realpath to resolve symlinks created by rbenv
+      # Otherwise, Bunto.sanitized path with prepend the unresolved root
+      @root ||= File.realpath(gemspec.full_gem_path)
+    rescue Errno::ENOENT, Errno::EACCES, Errno::ELOOP
+      nil
     end
 
     def includes_path
@@ -27,18 +31,15 @@ module Bunto
 
     def configure_sass
       return unless sass_path
-      require 'sass'
+      require "sass"
       Sass.load_paths << sass_path
     end
 
     private
 
     def path_for(folder)
-      resolved_dir = realpath_for(folder)
-      return unless resolved_dir
-
-      path = Bunto.sanitized_path(root, resolved_dir)
-      path if Dir.exists?(path)
+      path = realpath_for(folder)
+      path if path && File.directory?(path)
     end
 
     def realpath_for(folder)
@@ -50,7 +51,8 @@ module Bunto
     def gemspec
       @gemspec ||= Gem::Specification.find_by_name(name)
     rescue Gem::LoadError
-      raise Bunto::Errors::MissingDependencyException, "The #{name} theme could not be found."
+      raise Bunto::Errors::MissingDependencyException,
+        "The #{name} theme could not be found."
     end
   end
 end

data/lib/bunto/theme_builder.rb

@@ -0,0 +1,117 @@
+class Bunto::ThemeBuilder
+  SCAFFOLD_DIRECTORIES = %w(
+    _layouts _includes _sass
+  ).freeze
+
+  attr_reader :name, :path, :code_of_conduct
+
+  def initialize(theme_name, opts)
+    @name = theme_name.to_s.tr(" ", "_").gsub(%r!_+!, "_")
+    @path = Pathname.new(File.expand_path(name, Dir.pwd))
+    @code_of_conduct = !!opts["code_of_conduct"]
+  end
+
+  def create!
+    create_directories
+    create_starter_files
+    create_gemspec
+    create_accessories
+    initialize_git_repo
+  end
+
+  private
+
+  def root
+    @root ||= Pathname.new(File.expand_path("../", __dir__))
+  end
+
+  def template_file(filename)
+    [
+      root.join("theme_template", "#{filename}.erb"),
+      root.join("theme_template", filename.to_s)
+    ].find(&:exist?)
+  end
+
+  def template(filename)
+    erb.render(template_file(filename).read)
+  end
+
+  def erb
+    @erb ||= ERBRenderer.new(self)
+  end
+
+  def mkdir_p(directories)
+    Array(directories).each do |directory|
+      full_path = path.join(directory)
+      Bunto.logger.info "create", full_path.to_s
+      FileUtils.mkdir_p(full_path)
+    end
+  end
+
+  def write_file(filename, contents)
+    full_path = path.join(filename)
+    Bunto.logger.info "create", full_path.to_s
+    File.write(full_path, contents)
+  end
+
+  def create_directories
+    mkdir_p(SCAFFOLD_DIRECTORIES)
+  end
+
+  def create_starter_files
+    %w(page post default).each do |layout|
+      write_file("_layouts/#{layout}.html", template("_layouts/#{layout}.html"))
+    end
+  end
+
+  def create_gemspec
+    write_file("Gemfile", template("Gemfile"))
+    write_file("#{name}.gemspec", template("theme.gemspec"))
+  end
+
+  def create_accessories
+    accessories = %w(README.md LICENSE.txt)
+    accessories << "CODE_OF_CONDUCT.md" if code_of_conduct
+    accessories.each do |filename|
+      write_file(filename, template(filename))
+    end
+  end
+
+  def initialize_git_repo
+    Bunto.logger.info "initialize", path.join(".git").to_s
+    Dir.chdir(path.to_s) { `git init` }
+    write_file(".gitignore", template("gitignore"))
+  end
+
+  def user_name
+    @user_name ||= `git config user.name`.chomp
+  end
+
+  def user_email
+    @user_email ||= `git config user.email`.chomp
+  end
+
+  class ERBRenderer
+    extend Forwardable
+
+    def_delegator :@theme_builder, :name, :theme_name
+    def_delegator :@theme_builder, :user_name, :user_name
+    def_delegator :@theme_builder, :user_email, :user_email
+
+    def initialize(theme_builder)
+      @theme_builder = theme_builder
+    end
+
+    def bunto_version_with_minor
+      Bunto::VERSION.split(".").take(2).join(".")
+    end
+
+    def theme_directories
+      SCAFFOLD_DIRECTORIES
+    end
+
+    def render(contents)
+      ERB.new(contents).result binding
+    end
+  end
+end