benoit 0.1.0

data/lib/benoit/compiler_error.rb

@@ -0,0 +1,49 @@
+#
+#  CompilerError.rb
+#  Benoit
+#
+#  Created by Joseph Fiorini on 11/5/12.
+#  Copyright 2012 densitypop. All rights reserved.
+#
+
+class StandardError
+  def to_json
+    { message: "Benoit has encountered an internal error. Please contact @benoitapp on Twitter to resolve this problem.", type: "error" }.to_json
+  end
+end
+
+module Benoit
+    class CompilerError < StandardError
+        attr_accessor :line, :message
+        attr_reader :output, :env, :file_path, :original_error
+
+        def initialize(line, file_path, original_error)
+            @line = line
+            @file_path = file_path
+            @output = output
+            @env = env
+            @original_error = original_error
+        end
+
+        def to_json
+          { line_no: @line, message: @message, path: @file_path, original_error: @original_error, type: "error" }.to_json
+        end
+
+    end
+
+    class FileMissingError < CompilerError
+      attr_accessor :missing_file
+
+      def initialize(missing_file, line, file_path, original_error)
+        @missing_file = missing_file
+        super line, file_path, original_error
+      end
+
+      def message
+<<-EOS
+You included a file named #{missing_file.inspect} in #{file_path.inspect}. I could not find a file with that name. Maybe you forgot to specify a folder?
+EOS
+      end
+
+    end
+end

data/lib/benoit/configuration.rb

@@ -0,0 +1,24 @@
+module Benoit
+  module Configuration
+
+    class Config
+
+      attr_accessor :output_mode, :cache_path, :output_path, :site_path
+      attr_writer :clean_before_build
+
+      def clean_before_build?
+        @clean_before_build
+      end
+
+    end
+
+    def configure(&block)
+      block.call(config)
+    end
+
+    def config
+      @config ||= Config.new
+    end
+
+  end
+end

data/lib/benoit/current_site.rb

@@ -0,0 +1,12 @@
+require 'delegate'
+
+module Benoit
+  class CurrentSite < SimpleDelegator
+    def self.load
+      context_hash = PageMetadata::SiteContextConverter.export
+      new(Benoit::SiteContext.from_hash(context_hash))
+    end
+  end
+end
+
+

data/lib/benoit/file_wrapper_extensions.rb

@@ -0,0 +1,13 @@
+module Benoit
+  module FileWrapperExtensions
+    
+    def final_output=(output)
+      @final_output = output
+    end
+
+    def final_output
+      @final_output
+    end
+
+  end
+end

data/lib/benoit/filters.rb

@@ -0,0 +1,15 @@
+module Benoit
+  module Filters
+      require_relative './filters/base_filter'
+      require_relative './filters/sass_filter'
+      require_relative './filters/cadenza_filter'
+      require_relative './filters/pass_thru_filter'
+      require_relative './filters/blacklist_filter'
+      require_relative './filters/markdown_filter'
+      require_relative './filters/metadata_cleaner'
+      require_relative './filters/pagination_filter'
+      require_relative './filters/content_page_filter'
+      require_relative './filters/move_to_root_filter'
+  end
+end
+

data/lib/benoit/filters/base_filter.rb

@@ -0,0 +1,44 @@
+module Benoit
+  module Filters
+    class BaseFilter < Rake::Pipeline::Filter
+
+      class << self
+        attr_reader :builder, :output_name_generator
+
+        def build_output(&block)
+          @builder = block
+        end
+
+        def output_name(&block)
+          @output_name_generator = block
+        end
+      end
+
+      attr_accessor :current_site
+
+      def output_name_generator
+        self.class.output_name_generator ||
+          @output_name_generator
+      end
+
+      def builder
+        self.class.builder
+      end
+
+      def generate_output(inputs, output)
+        inputs.each do |input|
+          page = current_site[input.path]
+          content = build_output(page, input) if builder
+          output.write(content || page["content"])
+        end
+      end
+
+      private
+
+      def build_output(page, input)
+        builder.(page, input)
+      end
+
+    end
+  end
+end

data/lib/benoit/filters/blacklist_filter.rb

@@ -0,0 +1,18 @@
+module Benoit::Filters
+  class BlacklistFilter < Rake::Pipeline::Filter
+    attr_accessor :whitelist
+
+    def initialize(options={}, &block)
+      @whitelist = options.delete(:allow)
+      super &block
+    end
+
+    def generate_rake_tasks
+      @rake_tasks = []
+    end
+
+    def output_files
+      []
+    end
+  end
+end

data/lib/benoit/filters/cadenza_filter.rb

@@ -0,0 +1,75 @@
+require 'cadenza'
+
+class Benoit::Filters::CadenzaFilter < Rake::Pipeline::Filter
+    attr_reader :options
+    attr_accessor :current_site
+
+    include Benoit
+
+    def initialize
+      super
+      @page_layouts = {}
+    end
+
+    def generate_output(inputs, output)
+
+      site_context = current_site.to_context
+
+        inputs.each do |input|
+            load_paths = [input.root, Dir.pwd, "#{Dir.pwd}/_layouts"]
+
+            Benoit::Cadenza.load_output_filters!
+
+            load_paths.each do |load_path|
+              ::Cadenza::BaseContext.add_load_path load_path
+            end
+
+            page = current_site[input.path].to_hash
+
+            # Leave the original page for paginated pages blank
+            #  otherwise we will get an "iteration reached an end" error
+            #  from trying to iterate past the end of the enumerator
+            if input.path !~ /\d+.html/ && page.keys.any? { |key| key =~ /\w+_per_page/ }
+              output.write("")
+              next
+            end
+
+            context_hash = {
+                "site" => site_context,
+                "page" => page
+            }
+
+            begin
+              compiled = ::Cadenza.render_template input.path, context_hash
+            rescue ::Cadenza::TemplateNotFoundError => ex
+              error = Benoit::FileMissingError.new(ex.message, nil, input.path, ex)
+              raise error
+            rescue ::Cadenza::FilterNotDefinedError => ex
+              missing_filter = ex.message.scan(/undefined filter '([\w\-_]*)'/).flatten.first
+              error = Benoit::CompilerError.new(nil, input.path, ex)
+              error.message = "You used a filter named #{missing_filter.inspect}, but I could not find it. Maybe it's misspelled?"
+              raise error
+            rescue ::Cadenza::Error => ex
+            end
+
+            output.write compiled
+        end
+    end
+
+
+      def page_layouts_for_input(input)
+          @page_layouts[input.path] ||=
+              FindsLayoutsForTemplate(input.path, root: input.root, load_paths: ["_layouts"])
+      end
+
+      def additional_dependencies(input=nil)
+          if input
+              Dir["**/*.markdown"].map do |f|
+                  f.gsub input.root, ""
+              end
+          else
+              []
+          end
+      end
+
+end

data/lib/benoit/filters/content_page_filter.rb

@@ -0,0 +1,45 @@
+module Benoit::Filters
+
+  class ContentPageFilter < Rake::Pipeline::Filter
+
+    attr_accessor :current_site
+
+      def initialize
+          super
+          @page_layouts = {}
+      end
+
+      def generate_output(inputs, output)
+          inputs.each do |input|
+
+              layout = page_layouts_for_input(input).first
+
+              template =
+                if layout
+              # TODO: Only use this for files that don't extend already but have specified a layout, if the file extends, then just replace the extends line with the normalized layout
+                  "{% extends '#{layout}' %}\n\n"
+                end.to_s
+
+            template << input.read
+
+            output.write(template)
+
+          end
+      end
+
+      def page_layouts_for_input(input)
+          @page_layouts[input.path] ||=
+              FindsLayoutsForTemplate(input, root: input.root, load_paths: ["_layouts"])
+      end
+
+      def additional_dependencies(input=nil)
+          if input
+             output = current_site.paths_map[input.path]
+             page_layouts_for_input(input)
+          else
+              []
+          end
+      end
+
+  end
+end

data/lib/benoit/filters/markdown_filter.rb

@@ -0,0 +1,19 @@
+require 'redcarpet'
+
+module Benoit::Filters
+  class MarkdownFilter < BaseFilter
+
+    output_name do |path|
+      path.sub(/\.(md|mdown|mkdown|markdown)$/, '.html')
+    end
+
+    build_output do |page|
+
+      markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML, fenced_code_blocks: true)
+      rendered = markdown.render(page["content"])
+
+      page["content"] = rendered
+    end
+
+  end
+end

data/lib/benoit/filters/metadata_cleaner.rb

@@ -0,0 +1,30 @@
+module Benoit::Filters
+  class MetadataCleaner < Rake::Pipeline::Filter
+
+    include Benoit
+
+    attr_accessor :current_site
+
+    def generate_output(inputs, output)
+      inputs.each do |input|
+        metadata = current_site[input.path]
+        if metadata and metadata.key?("content")
+          output.write metadata["content"]
+        else
+          output.write input.read
+        end
+      end
+    end
+
+
+    def super_pipeline(descendent=self.pipeline)
+        if descendent.respond_to? :pipeline
+            super_pipeline(descendent.pipeline)
+        else
+            descendent
+        end
+    end
+
+
+  end
+end

data/lib/benoit/filters/move_to_root_filter.rb

@@ -0,0 +1,22 @@
+class Benoit::Filters::MoveToRootFilter < Rake::Pipeline::Filter
+
+  def initialize
+      block = proc { |input|
+          components = input.split('/')
+          if components.length == 1 # Already at root
+              components.first
+          elsif components.first.start_with? '_'
+              components.shift
+          end
+          components.join('/')
+      }
+      super &block
+  end
+
+  def generate_output(inputs, output)
+      inputs.each do |input|
+          output.write input.read
+      end
+  end
+
+end

data/lib/benoit/filters/pagination_filter.rb

@@ -0,0 +1,23 @@
+class Pathname
+  def append_basename(str, suffix=nil)
+    ext = suffix || extname
+    dirname.join(basename(ext).to_s + str + ext.to_s)
+  end
+end
+
+module Benoit
+  module Filters
+    class PaginationFilter < MetadataCleaner
+
+      def initialize
+        @output_name_generator = ->(_,input){
+          pages_for_input = pipeline.per_page_counts[input]
+          (1..pages_for_input).to_a.map do |page|
+            Pathname.new(input.path).append_basename(page.to_s).to_path
+          end
+        }
+      end
+
+    end
+  end
+end

data/lib/benoit/filters/pass_thru_filter.rb

@@ -0,0 +1,22 @@
+#
+#  pass_thru_filter.rb
+#  Benoit
+#
+#  Created by Joseph Fiorini on 10/3/12.
+#  Copyright 2012 densitypop. All rights reserved.
+#
+
+
+module Benoit::Filters
+    class PassThruFilter < Rake::Pipeline::Filter
+
+        processes_binary_files
+
+        def generate_output(inputs, output)
+            inputs.each do |input|
+                output.write input.read
+            end
+        end
+
+    end
+end

data/lib/benoit/filters/sass_filter.rb

@@ -0,0 +1,74 @@
+#
+#  sass_filter.rb
+#  Benoit
+#
+#  Created by Joseph Fiorini on 10/6/12.
+#  Copyright 2012 densitypop. All rights reserved.
+#
+
+require 'compass'
+require 'sass'
+
+class Benoit::Filters::SassFilter < Rake::Pipeline::Filter
+    attr_reader :options, :additional_load_paths
+
+    def initialize(options={})
+      load_paths = options.delete(:additional_load_paths) || []
+
+      # TODO: Handle files that don't end in .scss
+      block ||= proc { |input| input.sub(/\.(?:css\.)?(scss|sass)$/, '.css') }
+      super(&block)
+      Compass.add_project_configuration
+      Compass.configuration.project_path ||= Dir.pwd
+      @additional_load_paths = Compass.configuration.sass_load_paths
+      @additional_load_paths += load_paths.map do |f|
+        File.expand_path(f)
+      end
+
+
+      @options = options
+      @options[:load_paths] ||= []
+      @options[:load_paths].concat(additional_load_paths)
+
+    end
+
+    def generate_output(inputs, output)
+      inputs.each do |input|
+        begin
+          sass_options = sass_options_for_file(input).merge(filename: input.path)
+          sass_engine = Sass::Engine.for_file(input.fullpath, sass_options)
+          output.write sass_engine.render
+        rescue Sass::SyntaxError => ex
+          path = ex.sass_filename.gsub(input.root + "/", "")
+          missing_files = ex.message.scan(/File to import not found or unreadable: ([\w\-]*)\./).flatten
+          if missing_files.empty?
+            error = Benoit::CompilerError.new(nil, path, ex)
+            error.line = ex.sass_line
+          else
+            error = Benoit::FileMissingError.new(missing_files.first, ex.sass_line, path, ex)
+          end
+          raise error
+        rescue StandardError => ex
+          raise Benoit::CompilerError.new(nil, path, ex)
+        end
+      end
+    end
+
+    def additional_dependencies(input=nil)
+      Dir.glob("**/*.scss")
+    end
+
+
+    private
+
+    def sass_options_for_file(file)
+      added_opts = {
+        :syntax => file.path.match(/\.sass$/) ? :sass : :scss,
+        :trace => true,
+        :cache => false,
+        :cache_location => nil
+      }
+
+      added_opts.merge(@options)
+    end
+  end