ruhoh 2.1 → 2.2

data/history.json

@@ -1,4 +1,27 @@
 [
+  {
+    "version" : "2.2",
+    "date" : "09.06.2013",
+    "changes" : [
+      "@binaryphile updates google analytics tracking script",
+      "@stebalien overhauls page.summary internal implementation",
+    ],
+    "features" : [
+      "Cache the collection#all call to improve performance.",
+      "@stebalien introduces more powerful controls over page.summary",
+      "@lynnfaraday adds page.url to the previewer page data.",
+      "Add cucumber integration tests",
+      "@caspervonb adds system level widgets.syntax to act as unified syntax highlighting widget"
+    ],
+    "bugs" : [
+      "@tlupfer fixes date metadata not being substituted in permalinks",
+      "@stebalien fixes sprockets plugin",
+      "@caspervonb makes widgets compiler respect model excludes",
+      "Avoid data parse errors by always converting to string",
+      "Improve error messages for a few parse error cases",
+      "Fix widget config not deep merging with default widget config",
+    ]
+  },
   {
     "version" : "2.1",
     "date" : "19.05.2013",

data/lib/ruhoh/base/model.rb

@@ -99,7 +99,13 @@ module Ruhoh::Base
 
       page = File.open(@pointer['realpath'], 'r:UTF-8') {|f| f.read }
 
-      front_matter = page.match(FMregex)
+      begin
+        front_matter = page.match(FMregex)
+      rescue => e
+        raise "Error trying to read meta-data from #{@pointer['realpath']}." +
+        " Check your folder configuration.  Error details: #{e}"
+      end
+        
       data = front_matter ?
         (YAML.load(front_matter[0].gsub(/---\n/, "")) || {}) :
         {}
@@ -122,10 +128,6 @@ module Ruhoh::Base
       nil
     end
 
-    def formatted_date(date)
-      Time.parse(date.to_s).strftime('%Y-%m-%d') rescue false
-    end
-
     def parse_page_filename(filename)
       data = *filename.match(DateMatcher)
       data = *filename.match(Matcher) if data.empty?
@@ -179,9 +181,27 @@ module Ruhoh::Base
           "categories" => category || '',
         }
 
-        date = Date.parse(page_data['date']) rescue nil
-        if date
-          data.merge({
+        uses_date = false
+        %w{ :year :month :day :i_day :i_month }.each do |token|
+          if format.include?(token)
+            uses_date = true
+            break
+          end
+        end
+
+        if uses_date
+          begin
+            date = Time.parse(page_data['date'].to_s)
+          rescue ArgumentError, TypeError
+            Ruhoh.log.error(
+              "ArgumentError:" +
+              " The file '#{ @pointer["realpath"] }' has a permalink '#{ format }'" +
+              " which is date dependant but the date '#{page_data['date']}' could not be parsed." +
+              " Ensure the date's format is: 'YYYY-MM-DD'"
+            )
+          end
+
+          data.merge!({
             "year"       => date.strftime("%Y"),
             "month"      => date.strftime("%m"),
             "day"        => date.strftime("%d"),
@@ -217,4 +237,4 @@ module Ruhoh::Base
   class Model
     include Modelable
   end
-end
+end

data/lib/ruhoh/base/model_view.rb

@@ -1,3 +1,6 @@
+require 'nokogiri'
+require 'set'
+
 module Ruhoh::Base
   module ModelViewable
     def initialize(model)
@@ -5,7 +8,6 @@ module Ruhoh::Base
       @model = model
       @ruhoh = model.ruhoh
 
-      # TODO: THIS AUTOMATICALLY CALLS PROCESS ON THE MODEL =XXXX
       # Define direct access to the data Hash object
       # but don't overwrite methods if already defined.
       data.keys.each do |method|
@@ -44,9 +46,9 @@ module Ruhoh::Base
       other_data = other.__send__(attribute)
       if attribute == "date"
         begin
-          this_data = Date.parse(this_data)
-          other_data = Date.parse(other_data)
-        rescue ArgumentError
+          this_data = Time.parse(this_data.to_s)
+          other_data = Time.parse(other_data.to_s)
+        rescue ArgumentError, TypeError
           Ruhoh.log.error(
             "ArgumentError:" +
             " The '#{ @model.collection.resource_name }' collection is configured to sort based on 'date'" +
@@ -88,41 +90,71 @@ module Ruhoh::Base
       id == @model.collection.master.page_data['id']
     end
     
-    # Truncate the page content relative to a line_count limit.
-    # This is optimized for markdown files in which content is largely
-    # blocked into chunks and separating by blank lines.
-    # The line_limit truncates content based on # of content-based lines,
-    # so blank lines don't count toward the limit.
-    # Always break the content on a blank line only so result stays formatted nicely.
+    # Generate a truncated summary.
+    # - If a summary element (`<tag class="summary">...</tag>`) is specified
+    #   in the content, return it.
+    # - If summary_lines > 0, truncate after the first complete element where
+    #   the number of summary lines is greater than summary_lines.
+    # - If summary_stop_at_header is a number n, stop before the nth header.
+    # - If summary_stop_at_header is true, stop before the first header after
+    #   content has been included. In other words, don't count headers at the
+    #   top of the page.
     def summary
-      line_limit = @model.collection.config['summary_lines']
-      line_count = 0
-      line_breakpoint = @model.content.lines.count
-
-      content.lines.each_with_index do |line, i|
-        if line =~ /^\s*$/  # line with only whitespace
-          if line_count >= line_limit
-            line_breakpoint = i
+      # Parse the document
+      full_content = @ruhoh.master_view(@model.pointer).render_content
+      content_doc = Nokogiri::HTML.fragment(full_content)
+
+      # Return a summary element if specified
+      summary_el = content_doc.at_css('.summary')
+      return summary_el.to_html unless summary_el.nil?
+
+      # Get the configuration parameters
+      # Default to the parameters provided in the page itself
+      model_data = @model.data
+      collection_config = @model.collection.config
+      line_limit = model_data['summary_lines'] || collection_config['summary_lines']
+      stop_at_header = model_data['summary_stop_at_header']
+      stop_at_header = collection_config['summary_stop_at_header'] if stop_at_header.nil?
+
+      # Create the summary element.
+      summary_doc = Nokogiri::XML::Node.new("div", Nokogiri::HTML::Document.new)
+      summary_doc["class"] = "summary"
+
+      # All "heading" elements.
+      headings = Nokogiri::HTML::ElementDescription::HEADING + ["header", "hgroup"]
+
+
+      content_doc.children.each do |node|
+
+        if stop_at_header == true
+          # Detect first header after content
+          if not (headings.include?(node.name) && node.content.empty?)
+            stop_at_header = 1
+          end
+        elsif stop_at_header.is_a?(Integer) && headings.include?(node.name)
+          if stop_at_header > 1
+            stop_at_header -= 1;
+          else
+            summary_doc["class"] += " ellipsis"
             break
           end
-        else
-          line_count += 1
         end
-      end
-
-      summary = content.lines.to_a[0, line_breakpoint].join
 
-      # The summary may be missing some key items needed to render properly.
-      # So search the rest of the content and add it to the summary.
-      content.lines.with_index(line_breakpoint) do |line, i|
-        # Add lines containing destination urls.
-        if line =~ /^\[[^\]]+\]:/
-          summary << "\n#{line}"
+        if line_limit > 0 && summary_doc.content.lines.to_a.length > line_limit
+          # Skip through leftover whitespace. Without this check, the summary
+          # can be marked as ellipsis even if it isn't.
+          unless node.text? && node.text.strip.empty?
+            summary_doc["class"] += " ellipsis"
+            break
+          else
+            next
+          end
         end
+
+        summary_doc << node
       end
 
-      summary = @model.collection.master.render(summary)
-      Ruhoh::Converter.convert(summary, id)
+      summary_doc.to_html
     end
 
     def next
@@ -149,4 +181,4 @@ module Ruhoh::Base
   class ModelView < SimpleDelegator
     include ModelViewable
   end
-end
+end

data/lib/ruhoh/programs/watch.rb

@@ -33,6 +33,7 @@ class Ruhoh
           resource = path.split(separator)[0]
 
           ruhoh.cache.delete(ruhoh.collection(resource).files_cache_key)
+          ruhoh.cache.delete("#{ resource }-all")
 
           ruhoh.collection(resource).load_watcher.update(path)
         end

data/lib/ruhoh/resources/pages/collection.rb

@@ -42,6 +42,7 @@ module Ruhoh::Resources::Pages
       hash['permalink'] ||= "/:path/:filename"
       hash['summary_lines'] ||= 20
       hash['summary_lines'] = hash['summary_lines'].to_i
+      hash['summary_stop_at_header'] ||= false
       hash['latest'] ||= 2
       hash['latest'] = hash['latest'].to_i
       hash['ext'] ||= ".md"
@@ -83,4 +84,4 @@ module Ruhoh::Resources::Pages
       hash
     end
   end
-end
+end

data/lib/ruhoh/resources/pages/collection_view.rb

@@ -9,9 +9,11 @@ module Ruhoh::Resources::Pages
     include Ruhoh::Views::Helpers::Paginator
 
     def all
-      dictionary.each_value.find_all { |model|
-        File.basename(File.dirname(model.id)) != "drafts"
-      }.sort
+      ruhoh.cache.get("#{ resource_name }-all") ||
+        ruhoh.cache.set("#{ resource_name }-all", dictionary.each_value.find_all { |model|
+              File.basename(File.dirname(model.id)) != "drafts"
+            }.sort
+          )
     end
 
     def drafts
@@ -39,11 +41,11 @@ module Ruhoh::Resources::Pages
       collated = []
       pages = all
       pages.each_with_index do |page, i|
-        thisYear = Time.parse(page['date']).strftime('%Y')
-        thisMonth = Time.parse(page['date']).strftime('%B')
+        thisYear = Time.parse(page['date'].to_s).strftime('%Y')
+        thisMonth = Time.parse(page['date'].to_s).strftime('%B')
         if (i-1 >= 0)
-          prevYear = Time.parse(pages[i-1]['date']).strftime('%Y')
-          prevMonth = Time.parse(pages[i-1]['date']).strftime('%B')
+          prevYear = Time.parse(pages[i-1]['date'].to_s).strftime('%Y')
+          prevMonth = Time.parse(pages[i-1]['date'].to_s).strftime('%B')
         end
 
         if(prevYear == thisYear) 

data/lib/ruhoh/resources/pages/previewer.rb

@@ -13,17 +13,15 @@ module Ruhoh::Resources::Pages
       env['PATH_INFO'].chomp!("/") unless env['PATH_INFO'] == "/"
 
       pointer = @ruhoh.routes.find(env['PATH_INFO'])
+      Ruhoh::Friend.say {
+        plain "- previewing page:"
+        plain "   #{pointer.inspect}"
+      }
+
       view = pointer ? @ruhoh.master_view(pointer) : paginator_view(env)
+
       if view
-        content = view.render_full
-        Ruhoh::Friend.say {
-          cyan "-> previewing page:"
-          plain "   - #{pointer.inspect}"
-          plain "   - sub-layout: #{ view.sub_layout }"
-          plain "   - master-layout: #{ view.master_layout }"
-          plain "   - meta-data: #{ view.page_data }"
-        }
-        [200, {'Content-Type' => 'text/html'}, [content]]
+        [200, {'Content-Type' => 'text/html'}, [view.render_full]]
       else
         message = "No generated page URL matches '#{ env['PATH_INFO'] }'" +
           " using file pointer: '#{ pointer.inspect }'."
@@ -57,10 +55,13 @@ module Ruhoh::Resources::Pages
       collection = @ruhoh.collection(resource)
       config = collection.config["paginator"] || {}
 
+      url = "#{config["url"]}/#{page_number}"
+      
       view = @ruhoh.master_view({"resource" => resource})
       view.page_data = {
         "layout" => config["layout"],
-        "current_page" => page_number
+        "current_page" => page_number,
+        "url" => @ruhoh.to_url(url)
       }
       view
     end

data/lib/ruhoh/resources/widgets/collection_view.rb

@@ -9,15 +9,13 @@ module Ruhoh::Resources::Widgets
       model = find("#{ name }/#{ (widget_config['use'] || "default") }")
       return '' unless model
 
-      view = ruhoh.master_view({})
-
       # merge the config.yml data into the inline layout data.
       # Note this is reversing the normal hierarchy 
       # in that inline should always override config level.
       # However the inline in this case is set as implementation defaults 
       # and meant to be overridden by user specific data.
-      view.render(model.content, {
-        "this_config" => model.data.merge(widget_config),
+      master.render(model.content, {
+        "this_config" => Ruhoh::Utils.deep_merge(model.data, widget_config),
         "this_path" => ruhoh.to_url(url_endpoint, name)
       })
     end

data/lib/ruhoh/resources/widgets/compiler.rb

@@ -13,9 +13,9 @@ module Ruhoh::Resources::Widgets
       compiled_path = Ruhoh::Utils.url_to_path(@ruhoh.to_url(@collection.url_endpoint), @ruhoh.paths.compiled)
       FileUtils.mkdir_p compiled_path
 
-      files = @collection.files.values
-      # Don't copy over the layouts.
-      files.delete_if { |p| p['id'].end_with?('.html') }
+      files = collection.files.values
+      files.delete_if { |p| !is_valid_file? (p['id']) }
+
       files.each do |pointer|
         compiled_file = File.join(compiled_path, pointer['id'])
         FileUtils.mkdir_p File.dirname(compiled_file)
@@ -23,5 +23,21 @@ module Ruhoh::Resources::Widgets
         Ruhoh::Friend.say { green "  > #{pointer['id']}" }
       end
     end
+
+    def is_valid_file?(filepath)
+      return false if filepath.end_with?('.html')
+
+      collection.widgets.each do |name|
+        widget_config = collection.config[name] || {}
+
+        model = collection.find("#{ name }/#{ (widget_config['use'] || "default") }")
+        next unless model
+
+        excludes = Array(model.data['exclude']).map { |node| Regexp.new(node) }
+        excludes.each { |regex| return false if filepath =~ regex }
+      end
+
+      true
+    end
   end
 end

data/lib/ruhoh/version.rb

@@ -1,4 +1,4 @@
 class Ruhoh
-  Version = VERSION = '2.1'
+  Version = VERSION = '2.2'
   RuhohSpec = '2.1'
 end

data/ruhoh.gemspec

@@ -20,6 +20,10 @@ Gem::Specification.new do |s|
   s.add_dependency 'redcarpet', "~> 2.1"
   s.add_dependency 'nokogiri', "~> 1.5"
 
+  s.add_development_dependency 'cucumber'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'rspec-expectations'
+
   s.files = `git ls-files`.
               split("\n").
               sort.

data/system/plugins/sprockets/compiler.rb

@@ -0,0 +1,38 @@
+require 'sprockets'
+
+module Ruhoh::SprocketsPlugin
+  module Compiler
+    extend Ruhoh::Base::CompilableAsset
+    def run
+      env = Sprockets::Environment.new
+      env.logger = Logger.new(STDOUT)
+      env.logger.level = Logger::WARN
+
+      collection = @collection
+
+      unless collection.paths?
+        Ruhoh::Friend.say { yellow "#{collection.resource_name.capitalize}: directory not found - skipping." }
+        return
+      end
+
+      Ruhoh::Friend.say { cyan "#{collection.resource_name.capitalize}: (using sprockets)" }
+
+      collection.paths.reverse.each do |path|
+        env.append_path(path)
+      end
+
+      compiled_path = Ruhoh::Utils.url_to_path(@ruhoh.to_url(collection.url_endpoint), @ruhoh.paths.compiled)
+      FileUtils.mkdir_p compiled_path
+
+      manifest = Sprockets::Manifest.new(env, compiled_path)
+      assets = collection.files.values.map{ |p|
+        Ruhoh::Friend.say { green "  > #{p['id']}" }
+        p["id"]
+      }
+      manifest.compile(assets)
+
+      # Update the paths to the digest format:
+      @collection._cache.merge!(manifest.assets)
+    end
+  end
+end

data/system/plugins/sprockets/javascripts/compiler.rb

@@ -1,25 +1,4 @@
-require 'sprockets'
-module Ruhoh::Resources::Javascripts
-  class Compiler
-    include Ruhoh::Base::Compilable
-
-    def run
-      Ruhoh::Friend.say { cyan "Javascripts: (using sprockets)" }
-      env = Sprockets::Environment.new
-      env.logger = Logger.new(STDOUT)
-      @collection.paths.reverse.each do |h|
-        env.append_path(File.join(h["path"], @collection.resource_name))
-      end
-
-      compiled_path = Ruhoh::Utils.url_to_path(@collection.url_endpoint, @ruhoh.paths.compiled)
-      FileUtils.mkdir_p compiled_path
-
-      manifest = Sprockets::Manifest.new(env, compiled_path)
-      assets = @collection.files.values.map{ |p| p["id"] }
-      manifest.compile(assets)
-
-      # Update the stylesheet paths to the digest format:
-      @collection._cache.merge!(manifest.assets)
-    end
-  end
+require File.join(File.dirname(__FILE__), '..', 'compiler.rb')
+class Ruhoh::Resources::Javascripts::Compiler
+  include Ruhoh::SprocketsPlugin::Compiler
 end