ruhoh 2.2 → 2.3

data/Gemfile

@@ -3,7 +3,7 @@ gemspec
 
 gem 'rack', "~> 1.4"
 gem 'directory_watcher', "~> 1.4.0"
-gem 'psych', "~> 1.3", :platforms => [:ruby_18, :mingw_18]
+#gem 'psych', "~> 1.3", :platforms => [:ruby_18, :mingw_18]
 gem 'redcarpet', "~> 2.1"
 gem 'nokogiri', "~> 1.5"
 

data/README.md

@@ -1,3 +1,4 @@
+[![Stories in Ready](https://badge.waffle.io/ruhoh/ruhoh.rb.png?label=ready)](https://waffle.io/ruhoh/ruhoh.rb)  
 [![Build Status](https://travis-ci.org/ruhoh/ruhoh.rb.png?branch=master)](https://travis-ci.org/ruhoh/ruhoh.rb)
 
 ## Ruhoh is the Universal Static Blog API

data/features/config.feature

@@ -0,0 +1,22 @@
+Feature: Config
+  As a content publisher
+  I want to configure the way my site works
+  so I can publish content in a way that makes me happy.
+
+  Scenario: Setting a production_url
+    Given some files with values:
+      | file       | body |
+      | config.yml | production_url: 'http://hello-world.com' |
+      | _root/index.html | <span>{{ urls.production }}</span> |
+    When I compile my site
+    Then my compiled site should have the file "index.html"
+      And this file should contain the content node "span|http://hello-world.com"
+
+  Scenario: Setting a production_url and using legacy urls.production_url
+    Given some files with values:
+      | file       | body |
+      | config.yml | production_url: 'http://hello-world.com' |
+      | _root/index.html | <span>{{ urls.production_url }}</span> |
+    When I compile my site
+    Then my compiled site should have the file "index.html"
+      And this file should contain the content node "span|http://hello-world.com"

data/features/ignore.feature

@@ -0,0 +1,14 @@
+Feature: Ignored resources
+  As a content publisher
+  I want to ignore certain folders
+  so that I can manage non-website related resources freely without screwing up my website.
+
+  Scenario: Defining an ignored resource (directory)
+  Given a config file with values:
+    | deploy | { "use" : "ignore" } |
+    Given some files with values:
+      | file |
+      | deploy/hello.md |
+    When I compile my site
+    Then my compiled site should NOT have the file "deploy/hello/index.html"
+    Then my compiled site should NOT have the folder "deploy"

data/features/permalinks.feature

@@ -54,6 +54,29 @@ Feature: Page Permalinks
     When I compile my site
     Then my compiled site should have the file "essays/2012/1/2/hello/index.html"
 
+  Scenario: Custom permalink format in page metadata using explicit html extension
+    Given some files with values:
+    | file              | permalink      |
+    | essays/hello.md   | :filename.html |
+    When I compile my site
+    Then my compiled site should have the file "hello.html"
+
+  Scenario: Custom permalink format in page metadata using explicit convertable extension
+    Given some files with values:
+    | file              | permalink      |
+    | essays/hello.md   | :filename.md   |
+    When I compile my site
+    Then my compiled site should have the file "hello.md"
+
+  Scenario: Custom permalink format in page metadata using explicit arbitrary extension
+    Given some files with values:
+    | file              | permalink      |
+    | essays/hello.md   | :filename.derp |
+    When I compile my site
+    Then my compiled site should have the file "hello.derp"
+
+## Literal permalink
+
   Scenario: Literal permalink format in page metadata.
     Given some files with values:
     | file              | permalink | body |

data/features/static.feature

@@ -0,0 +1,19 @@
+Feature: Static resources
+  As a content publisher
+  I want to include static folders
+  so that I can statically transfer files over to my website output.
+
+  Scenario: Defining an ignored resource (directory)
+  Given a config file with values:
+    | recipes | { "use" : "static" } |
+    Given some files with values:
+      | file |
+      | recipes/hello.md |
+      | recipes/hi.txt |
+      | recipes/yo.html |
+      | recipes/cool/data.json |
+    When I compile my site
+    Then my compiled site should have the file "recipes/hello.md"
+    Then my compiled site should have the file "recipes/hi.txt"
+    Then my compiled site should have the file "recipes/yo.html"
+    Then my compiled site should have the file "recipes/cool/data.json"

data/features/step_defs.rb

@@ -34,6 +34,15 @@ Then(/^my compiled site (should|should NOT) have the file "(.*?)"$/) do |matcher
   }
 end
 
+Then(/^my compiled site (should|should NOT) have the (?:directory|folder) "(.*?)"$/) do |matcher, path|
+  @filepath = path
+  FileUtils.cd(@ruhoh.paths.compiled) {
+    # Done this way so the error output is more informative.
+    files = Dir.glob("**/*").delete_if{ |a| File.file?(a) }
+    files.__send__(matcher, include(path)) 
+  }
+end
+
 Then(/^this file (should|should NOT) (?:have|contain) the content "(.*?)"$/) do |matcher, content|
   this_compiled_file.__send__(matcher, have_content(content))
 end

data/features/summary.feature

@@ -28,6 +28,30 @@ Feature: Summary
       And this file should contain the content node "div.summary|The Giraffe and the Zebra and the Eland and the Koodoo and the Hartebeest lived there: and they were 'sclusively sandy-yellow-brownish all over; but the Leopard, he was the 'sclusivest sandiest-yellowest-brownest of them all -- a greyish-yellowish catty-shaped kind of beast, and he matched the 'sclusively yellowish-greyish-brownish colour of the High Veldt to one hair."
       And this file should NOT contain the content "This was very bad for the Giraffe and the Zebra and the rest of them: for he would lie down by a 'sclusively yellowish-greyish-brownish stone or clump of grass, and when the Giraffe or the Zebra or the Eland or the Koodoo or the Bush-Buck or the Bonte-Buck came by he would surprise them out of their jumpsome lives."
 
+  Scenario: Summary with configured summary_lines in page's meta-data
+    Given some files with values:
+      | file                | body |
+      | layouts/essays.md   | {{{ page.summary }}} |
+      And the file "essays/hello.md" with body:
+      """
+      ---
+      summary_lines: 2
+      ---
+      In the days when everybody started fair, Best Beloved, the Leopard lived in a place called the High Veldt. 'Member it wasn't the Low Veldt, or the Bush Veldt, or the Sour Veldt, but the 'sclusively bare, hot shiny High Veldt, where there was sand and sandy-coloured rock and 'sclusively tufts of sandy-yellowish grass.
+
+      The Giraffe and the Zebra and the Eland and the Koodoo and the Hartebeest lived there: and they were 'sclusively sandy-yellow-brownish all over; but the Leopard, he was the 'sclusivest sandiest-yellowest-brownest of them all -- a greyish-yellowish catty-shaped kind of beast, and he matched the 'sclusively yellowish-greyish-brownish colour of the High Veldt to one hair.
+
+      This was very bad for the Giraffe and the Zebra and the rest of them: for he would lie down by a 'sclusively yellowish-greyish-brownish stone or clump of grass, and when the Giraffe or the Zebra or the Eland or the Koodoo or the Bush-Buck or the Bonte-Buck came by he would surprise them out of their jumpsome lives.
+
+      He would indeed! And, also, there was an Ethiopian with bows and arrows (a 'sclusively greyish-brownish-yellowish man he was then), who lived on the High Veldt with the Leopard: and the two used to hunt together -- the Ethiopian with his bows and arrows, and the Leopard 'sclusively with his teeth and claws -- till the Giraffe and the Eland and the Koodoo and the Quagga and all the rest of them didn't know which way to jump, Best Beloved.
+      They didn't indeed!
+      """
+    When I compile my site
+    Then my compiled site should have the file "essays/hello/index.html"
+      And this file should contain the content node "div.summary|In the days when everybody started fair, Best Beloved, the Leopard lived in a place called the High Veldt. 'Member it wasn't the Low Veldt, or the Bush Veldt, or the Sour Veldt, but the 'sclusively bare, hot shiny High Veldt, where there was sand and sandy-coloured rock and 'sclusively tufts of sandy-yellowish grass."
+      And this file should contain the content node "div.summary|The Giraffe and the Zebra and the Eland and the Koodoo and the Hartebeest lived there: and they were 'sclusively sandy-yellow-brownish all over; but the Leopard, he was the 'sclusivest sandiest-yellowest-brownest of them all -- a greyish-yellowish catty-shaped kind of beast, and he matched the 'sclusively yellowish-greyish-brownish colour of the High Veldt to one hair."
+      And this file should NOT contain the content "This was very bad for the Giraffe and the Zebra and the rest of them: for he would lie down by a 'sclusively yellowish-greyish-brownish stone or clump of grass, and when the Giraffe or the Zebra or the Eland or the Koodoo or the Bush-Buck or the Bonte-Buck came by he would surprise them out of their jumpsome lives."
+
   Scenario: Specifying an explicit summary DOM node
     Given some files with values:
       | file                | body |

data/history.json

@@ -1,10 +1,29 @@
 [
+  {
+    "version" : "2.3",
+    "date" : "25.08.2013",
+    "changes" : [
+      "(Internal) Ruhoh::CleanUrl and Ruhoh::StringFormat better encapsulate url-slug generation.",
+      "(Internal) page.summary is now single-purpose Ruhoh::Summarizer service."
+    ],
+    "features" : [
+      "Add ability to use: 'ignore' to ignore a collection folder.",
+      "Add ability to use: 'static' to serve a collection folder staticly.",
+      "Add title into base scaffold if defined from CLI."
+    ],
+    "bugs" : [
+      "Fix plugins not running on the CLI.",
+      "Fix permalinks not persisting explicit extentions, e.g. .html",
+      "Expose urls.production and urls.production_url in the view."
+    ]
+  }
+  ,
   {
     "version" : "2.2",
     "date" : "09.06.2013",
     "changes" : [
       "@binaryphile updates google analytics tracking script",
-      "@stebalien overhauls page.summary internal implementation",
+      "@stebalien overhauls page.summary internal implementation"
     ],
     "features" : [
       "Cache the collection#all call to improve performance.",
@@ -19,7 +38,7 @@
       "@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",
+      "Fix widget config not deep merging with default widget config"
     ]
   },
   {

data/lib/ruhoh/base/compiler.rb

@@ -15,6 +15,7 @@ module Ruhoh::Base
     include Compilable
 
     # A basic compiler task which copies each valid collection resource file to the compiled folder.
+    # This is different from the static compiler in that it supports fingerprinting.
     # Valid files are identified by their pointers.
     # Invalid files are files that are excluded from the resource's configuration settings.
     # The collection's url_endpoint is used to determine the final compiled path.

data/lib/ruhoh/base/model.rb

@@ -39,7 +39,7 @@ module Ruhoh::Base
 
     def try(method)
       return __send__(method) if respond_to?(method)
-      return data[method] if data.key?(method.to_s)
+      return data[method.to_s] if data.key?(method.to_s)
       false
     end
   end
@@ -68,7 +68,7 @@ module Ruhoh::Base
 
       data['title'] = data['title'] || filename_data['title']
       data['date'] ||= filename_data['date'].to_s
-      data['url'] = permalink(data)
+      data['url'] = url(data)
       data['layout'] = collection.config['layout'] if data['layout'].nil?
 
       parsed_page['data'] = data
@@ -157,80 +157,19 @@ module Ruhoh::Base
         file_slug = @pointer['id'].split('/')[-2]
       end
 
-      file_slug.gsub(/[^\p{Word}+]/u, ' ').gsub(/\b\w/){$&.upcase}
+      Ruhoh::StringFormat.titleize(file_slug)
     end
 
-    # Another blatently stolen method from Jekyll
-    # The category is only the first one if multiple categories exist.
-    def permalink(page_data)
-      format = page_data['permalink'] || collection.config['permalink']
-      format ||= "/:path/:filename"
-
-      url = if format.include?(':')
-        title = Ruhoh::Utils.to_url_slug(page_data['title'])
-        filename = File.basename(page_data['id'])
-        category = Array(page_data['categories'])[0]
-        category = category.split('/').map {|c| Ruhoh::Utils.to_url_slug(c) }.join('/') if category
-        relative_path = File.dirname(page_data['id'])
-        relative_path = "" if relative_path == "."
-        data = {
-          "title"      => title,
-          "filename"   => filename,
-          "path"      => File.join(@pointer["resource"], relative_path),
-          "relative_path" => relative_path,
-          "categories" => category || '',
-        }
-
-        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"),
-            "i_day"      => date.strftime("%d").to_i.to_s,
-            "i_month"    => date.strftime("%m").to_i.to_s,
-          })
-        end
-
-        data.inject(format) { |result, token|
-          result.gsub(/:#{Regexp.escape token.first}/, token.last)
-        }.gsub(/\/+/, "/")
-      else
-        # Use the literal permalink if it is a non-tokenized string.
-        format.gsub(/^\//, '').split('/').map {|p| CGI::escape(p) }.join('/')
-      end
+    def url(page_data)
+      page_data['permalink_ext'] ||= collection.config['permalink_ext']
 
-      # Only recognize extensions registered from a 'convertable' module.
-      # This means 'non-convertable' extensions should pass-through.
-      if Ruhoh::Converter.extensions.include?(File.extname(url))
-        url = url.gsub(%r{#{File.extname(url)}$}, '.html')
-      end
-
-      unless (page_data['permalink_ext'] || collection.config['permalink_ext'])
-        url = url.gsub(/index.html$/, '').gsub(/\.html$/, '')
-      end
+      format = page_data['permalink'] ||
+               collection.config['permalink'] ||
+               "/:path/:filename"
 
-      url = '/' if url.empty?
+      slug = Ruhoh::UrlSlug.new(page_data: page_data, format: format)
 
-      @ruhoh.to_url(url)
+      @ruhoh.to_url(slug.generate)
     end
   end
 

data/lib/ruhoh/base/model_view.rb

@@ -1,5 +1,5 @@
-require 'nokogiri'
 require 'set'
+require 'ruhoh/summarizer'
 
 module Ruhoh::Base
   module ModelViewable
@@ -89,72 +89,21 @@ module Ruhoh::Base
     def is_active_page
       id == @model.collection.master.page_data['id']
     end
-    
-    # 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
-      # 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
+    def summary
       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
-        end
-
-        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
+      line_limit = model_data['summary_lines'] ||
+                   collection_config['summary_lines']
+      stop_at_header = model_data['summary_stop_at_header'] ||
+                       collection_config['summary_stop_at_header']
 
-      summary_doc.to_html
+      Ruhoh::Summarizer.new({
+        content: @ruhoh.master_view(@model.pointer).render_content,
+        line_limit: line_limit,
+        stop_at_header: stop_at_header
+      }).generate
     end
 
     def next

data/lib/ruhoh/client.rb

@@ -30,6 +30,7 @@ class Ruhoh
 
       @ruhoh.setup
       @ruhoh.setup_paths
+      @ruhoh.setup_plugins
 
       return __send__(cmd) if respond_to?(cmd)
 

data/lib/ruhoh/collections.rb

@@ -113,8 +113,6 @@ class Ruhoh
 
     def url_endpoints
       urls = {}
-      urls["base_path"] = @ruhoh.base_path
-
       all.each do |name|
         collection = load(name)
         next unless collection.respond_to?(:url_endpoint)
@@ -169,4 +167,4 @@ class Ruhoh
       name.to_s.split('_').map {|a| a.capitalize}.join
     end
   end
-end
+end

data/lib/ruhoh/programs/preview.rb

@@ -36,8 +36,8 @@ class Ruhoh
         # since presumably they define customized permalinks per singular resource.
         # Page-like resources are handled the root mapping below.
         ruhoh.collections.url_endpoints_sorted.each do |h|
-          # Omit base_path and theme because they are special use-cases.
-          next if %w{base_path theme}.include?(h["name"])
+          # Omit theme because they are special use-cases.
+          next if %w{ theme }.include?(h["name"])
           map h["url"] do
             collection = ruhoh.collection(h["name"])
             if collection.previewer?

data/lib/ruhoh/programs/watch.rb

@@ -27,15 +27,22 @@ class Ruhoh
             yellow "Watch [#{Time.now.strftime("%H:%M:%S")}] [Update #{path}] : #{args.size} files changed"
           }
 
-          separator = File::ALT_SEPARATOR ?
-                      %r{#{ File::SEPARATOR }|#{ File::ALT_SEPARATOR }} :
-                      File::SEPARATOR
-          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)
+          if path == "config.yml"
+            ruhoh.config true
+          else
+            separator = File::ALT_SEPARATOR ?
+                        %r{#{ File::SEPARATOR }|#{ File::ALT_SEPARATOR }} :
+                        File::SEPARATOR
+            resource = path.split(separator)[0]
+
+            ruhoh.cache.delete(ruhoh.collection(resource).files_cache_key)
+            ruhoh.cache.delete("#{ resource }-all")
+
+            puts("HERE", resource)
+
+            ruhoh.collection(resource).load_watcher.update(path)
+            puts(ruhoh.collection(resource))
+          end
         end
       end
 
@@ -43,4 +50,4 @@ class Ruhoh
     end
 
   end
-end
+end

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

@@ -0,0 +1,5 @@
+module Ruhoh::Resources::Ignore
+  class Collection
+    include Ruhoh::Base::Collectable
+  end
+end

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

@@ -43,7 +43,7 @@ module Ruhoh::Resources::Pages
     def titleize
       @collection.dictionary.each do |id, data|
         next unless File.basename(data['id']) =~ /^untitled/
-        new_name = Ruhoh::Utils.to_slug(data['title'])
+        new_name = Ruhoh::StringFormat.clean_slug(data['title'])
         new_file = "#{new_name}#{File.extname(data['id'])}"
         old_file = File.basename(data['id'])
         next if old_file == new_file
@@ -63,13 +63,35 @@ module Ruhoh::Resources::Pages
       _list(@collection.all)
     end
 
+    # Public - renders the scaffold, if available, for this resource.
+    def render_scaffold
+      (@collection.scaffold || '')
+        .gsub('{{DATE}}', Time.now.strftime('%Y-%m-%d'))
+        .gsub('{{TITLE}}', @args[2])
+    end
+
     protected
 
     def create(opts={})
+      filename = ensure_unique_filename(@args[2], opts)
+      FileUtils.mkdir_p File.dirname(filename)
+
+      File.open(filename, 'w:UTF-8') { |f| f.puts render_scaffold }
+
       ruhoh = @ruhoh
+      resource_name = @collection.resource_name
+      Ruhoh::Friend.say { 
+        green "New #{resource_name}:"
+        green "  > #{ruhoh.relative_path(filename)}"
+        if opts[:draft]
+          plain "View drafts at the URL: /dash"
+        end
+      }
+    end
 
+    def ensure_unique_filename(original_filename, opts)
       begin
-        file = @args[2] || "untitled"
+        file = original_filename || "untitled"
         ext = File.extname(file).to_s
         ext  = ext.empty? ? @collection.config["ext"] : ext
 
@@ -78,7 +100,7 @@ module Ruhoh::Resources::Pages
                   name = File.basename(file, ext).gsub(/\s+/, '-')
                   File.join(File.dirname(file), name)
                 else
-                  Ruhoh::Utils.to_slug(File.basename(file, ext))
+                  Ruhoh::StringFormat.clean_slug(File.basename(file, ext))
                 end
 
         name = "#{name}-#{@iterator}" unless @iterator.zero?
@@ -88,19 +110,7 @@ module Ruhoh::Resources::Pages
         @iterator += 1
       end while File.exist?(filename)
 
-      FileUtils.mkdir_p File.dirname(filename)
-      output = (@collection.scaffold || '').gsub('{{DATE}}', Time.now.strftime('%Y-%m-%d'))
-
-      File.open(filename, 'w:UTF-8') {|f| f.puts output }
-
-      resource_name = @collection.resource_name
-      Ruhoh::Friend.say { 
-        green "New #{resource_name}:"
-        green "  > #{ruhoh.relative_path(filename)}"
-        if opts[:draft]
-          plain "View drafts at the URL: /dash"
-        end
-      }
+      filename
     end
 
     def _list(data)
@@ -121,4 +131,4 @@ module Ruhoh::Resources::Pages
       end
     end
   end
-end
+end

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

@@ -72,6 +72,7 @@ module Ruhoh::Resources::Pages
        xml.rss(:version => '2.0') {
          xml.channel {
            xml.title_ data['title']
+           xml.description_ (data['description'] ? data['description'] : data['title'])
            xml.link_ @ruhoh.config['production_url']
            xml.pubDate_ Time.now          
            pages.each do |page|
@@ -98,4 +99,4 @@ module Ruhoh::Resources::Pages
       }
     end
   end
-end
+end

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

@@ -0,0 +1,9 @@
+module Ruhoh::Resources::Static
+  class Collection
+    include Ruhoh::Base::Collectable
+
+    def url_endpoint
+      resource_name
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Ruhoh::Resources::Static
+  class Compiler
+    include Ruhoh::Base::Compilable
+
+    # A basic compiler task which copies each valid collection resource file to the compiled folder.
+    # Valid files are identified by their pointers.
+    # Invalid files are files that are excluded from the resource's configuration settings.
+    # The collection's url_endpoint is used to determine the final compiled path.
+    #
+    # @returns Nothing.
+    def run
+      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}: (copying valid files)" }
+
+      compiled_path = Ruhoh::Utils.url_to_path(@ruhoh.to_url(@collection.url_endpoint), @ruhoh.paths.compiled)
+      FileUtils.mkdir_p compiled_path
+
+      @collection.files.values.each do |pointer|
+        compiled_file = File.join(compiled_path, pointer['id'])
+
+        FileUtils.mkdir_p File.dirname(compiled_file)
+        FileUtils.cp_r pointer['realpath'], compiled_file
+
+        Ruhoh::Friend.say { green "  > #{pointer['id']}" }
+      end
+    end
+  end
+end

data/lib/ruhoh/string_format.rb

@@ -0,0 +1,51 @@
+class Ruhoh
+  # StringFormat is meant to expose the common (public) interface
+  # for where strings (namely URLS) are formatted.
+  # Users are encouraged to reimplement these methods via plugins to enable
+  # custom-defined slug generation logic based on their tastes. 
+  #
+  # TODO: 
+  #   - Natively support the most popular slug formats.
+  #   - Better support for Internationalization.
+  module StringFormat
+
+    # Public interface for building 'clean slugs'
+    # Redefine this method to implement custom slug generation.
+    def self.clean_slug(string)
+      hyphenate(string)
+    end
+
+    def self.clean_slug_and_escape(string)
+      CGI::escape(clean_slug(string))
+    end
+
+    # Simple url slug normalization.
+    # Converts all non word characters into hyphens.
+    # This may not be what you want so feel free to overwite the public
+    # method in place of another formatter.
+    #
+    # Ex: My Post Title ===> my-post-title
+    def self.hyphenate(string)
+      string = string.to_s.downcase.strip.gsub(/[^\p{Word}+]/u, '-')
+      string.gsub(/^\-+/, '').gsub(/\-+$/, '').gsub(/\-+/, '-')
+    end
+
+    # TODO: Probably use ActiveSupport for this stuff
+    # Ex: my-post-title ===> My Post Title
+    def self.titleize(string)
+      string.gsub(/[^\p{Word}+]/u, ' ').gsub(/\b\w/){ $&.upcase }
+    end
+
+    # Convert CamelCase to snake_case
+    # Thanks ActiveSupport: http://stackoverflow.com/a/1509939/101940
+    def self.snake_case(string)
+      string.
+      to_s.
+      gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+    end
+  end
+end

data/lib/ruhoh/summarizer.rb

@@ -0,0 +1,65 @@
+require 'nokogiri'
+class Ruhoh
+  class Summarizer
+    SummaryNodeClassName = 'summary'
+    Headings = Nokogiri::HTML::ElementDescription::HEADING + %w{ header hgroup }
+
+    def initialize(opts)
+      @content = opts[:content] ; opts.delete(:content)
+      @opts = opts
+    end
+
+    # 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 @opts[:stop_at_header] is a number n, stop before the nth header.
+    # - If @opts[: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 generate
+      content_doc = Nokogiri::HTML.fragment(@content)
+
+      # Return a summary element if specified
+      summary_el = content_doc.at_css('.' + SummaryNodeClassName)
+      return summary_el.to_html if summary_el
+
+      # Create the summary element.
+      summary_doc = Nokogiri::XML::Node.new("div", Nokogiri::HTML::Document.new)
+      summary_doc["class"] = SummaryNodeClassName
+
+      content_doc.children.each do |node|
+
+        if @opts[:stop_at_header] == true
+          # Detect first header after content
+          if not (Headings.include?(node.name) && node.content.empty?)
+            @opts[:stop_at_header] = 1
+          end
+        elsif @opts[:stop_at_header].is_a?(Integer) && Headings.include?(node.name)
+          if @opts[:stop_at_header] > 1
+            @opts[:stop_at_header] -= 1;
+          else
+            summary_doc["class"] += " ellipsis"
+            break
+          end
+        end
+
+        if @opts[:line_limit] > 0 && summary_doc.content.lines.to_a.length > @opts[: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_doc.to_html
+    end
+  end
+end

data/lib/ruhoh/url_slug.rb

@@ -0,0 +1,126 @@
+class Ruhoh
+  class UrlSlug
+    def initialize(opts)
+      @page_data = opts[:page_data]
+      @format = opts[:format]
+      @pointer = @page_data["pointer"]
+    end
+
+    # @return[String] URL Slug based on the given data and format.
+    def generate
+      url = @format.include?(':') ? dynamic : literal
+      url = process_url_extension(url)
+      url.empty? ? '/' : url
+    end 
+
+    # @return[String] the literal URL without token substitution.
+    def literal
+      @format.gsub(/^\//, '').split('/').map {|p| CGI::escape(p) }.join('/')
+    end
+
+    # @return[String] the dynamic URL with token substitution.
+    def dynamic
+      data.inject(@format) { |result, token|
+        result.gsub(/:#{ Regexp.escape(token.first) }/, token.last)
+      }.gsub(/\/+/, "/")
+    end
+
+    def data
+      result = uses_date? ? date_data : {}
+      result.merge({
+        "title"             => title,
+        "filename"          => filename,
+        "path"              => path,
+        "relative_path"     => relative_path,
+        "categories"        => category,
+      })
+    end
+
+    def date_data
+      date = Time.parse(@page_data['date'].to_s)
+
+      {
+        "year"       => date.strftime("%Y"),
+        "month"      => date.strftime("%m"),
+        "day"        => date.strftime("%d"),
+        "i_day"      => date.strftime("%d").to_i.to_s,
+        "i_month"    => date.strftime("%m").to_i.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
+
+    def title
+      Ruhoh::StringFormat.clean_slug_and_escape(@page_data['title'])
+    end
+
+    def filename
+      File.basename(@page_data['id'], ext)
+    end
+
+    def ext
+      File.extname(@page_data['id'])
+    end
+
+    # Category is only the first one if multiple categories exist.
+    def category
+      string = Array(@page_data['categories'])[0]
+      return '' if string.to_s.empty?
+
+      string.split('/').map { |c|
+        Ruhoh::StringFormat.clean_slug_and_escape(c)
+      }.join('/')
+    end
+
+    def relative_path
+      string = File.dirname(@page_data['id'])
+      (string == ".") ? "" : string
+    end
+
+    def path
+      File.join(@pointer["resource"], relative_path)
+    end
+
+    private
+
+    def uses_date?
+      result = false
+      %w{ :year :month :day :i_day :i_month }.each do |token|
+        if @format.include?(token)
+          result = true
+          break
+        end
+      end
+
+      result
+    end
+
+    # Is an extension explicitly defined?
+    def uses_extension?
+      @format =~ /\.[^\.]+$/
+    end
+
+    # The url extension depends on multiple factors: 
+    # user-config   : preserve any extension set by the user in the format.
+    # converters    : Automatically change convertable extensions to .html
+    #                 Non-convertable file-extensions should 'pass-through' 
+    # 'pretty'      : Automatically prettify urls (omit .html) unless user disabled.
+    #
+    # @return[String]
+    def process_url_extension(url)
+      return url if uses_extension?
+
+      url += Ruhoh::Converter.extensions.include?(ext) ? '.html' : ext
+
+      # Prettify by default
+      @page_data['permalink_ext'] ?
+        url :
+        url.gsub(/index|index.html$/, '').gsub(/\.html$/, '')
+    end
+  end
+end

data/lib/ruhoh/utils.rb

@@ -21,18 +21,7 @@ class Ruhoh
       parts = parts.unshift(base) if base
       File.__send__(:join, parts)
     end    
-    
-    def self.to_url_slug(title)
-      CGI::escape self.to_slug(title)
-    end
-    
-    # My Post Title ===> my-post-title
-    def self.to_slug(title)
-      title = title.to_s.downcase.strip.gsub(/[^\p{Word}+]/u, '-')
-      title.gsub(/^\-+/, '').gsub(/\-+$/, '').gsub(/\-+/, '-')
-    end
-    
-    
+
     def self.report(name, collection, invalid)
       output = "#{collection.count}/#{collection.count + invalid.count} #{name} processed."
       if collection.empty? && invalid.empty?
@@ -73,17 +62,5 @@ class Ruhoh
 
       Object.module_eval("::#{$1}", __FILE__, __LINE__)
     end
-    
-    # Thanks ActiveSupport: http://stackoverflow.com/a/1509939/101940
-    def self.underscore(string)
-      string.
-      to_s.
-      gsub(/::/, '/').
-      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-      gsub(/([a-z\d])([A-Z])/,'\1_\2').
-      tr("-", "_").
-      downcase
-    end
-    
   end
-end #Ruhoh
+end

data/lib/ruhoh/version.rb

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

data/lib/ruhoh/views/master_view.rb

@@ -45,7 +45,11 @@ module Ruhoh::Views
     end
 
     def urls
-      @ruhoh.collections.url_endpoints
+      @ruhoh.collections.url_endpoints.merge({
+        'base_path' => @ruhoh.base_path,
+        'production' => @ruhoh.config["production_url"],
+        'production_url' => @ruhoh.config["production_url"]
+      })
     end
 
     def content
@@ -93,7 +97,7 @@ module Ruhoh::Views
     # Handy for transforming ids into css-classes in your views.
     # @returns[String]
     def to_slug(sub_context)
-      Ruhoh::Utils.to_slug(sub_context)
+      Ruhoh::StringFormat.clean_slug(sub_context)
     end
     
     # Public: Formats the path to the compiled file based on the URL.

data/lib/ruhoh.rb

@@ -23,6 +23,8 @@ require 'ruhoh/views/master_view'
 require 'ruhoh/collections'
 require 'ruhoh/cache'
 require 'ruhoh/routes'
+require 'ruhoh/string_format'
+require 'ruhoh/url_slug'
 require 'ruhoh/programs/preview'
 
 class Ruhoh
@@ -60,7 +62,9 @@ class Ruhoh
     @collections.load(resource)
   end
 
-  def config
+  def config(reload=false)
+    return @config unless (reload or @config.nil?)
+
     config = Ruhoh::Utils.parse_yaml_file(@base, "config.yml") || {}
     config['compiled'] = config['compiled'] ? File.expand_path(config['compiled']) : "compiled"
 
@@ -255,4 +259,4 @@ class Ruhoh
   def self.model(resource)
     Collections.get_module_namespace_for(resource).const_get(:ModelView)
   end
-end
+end

data/system/_scaffold.html

@@ -1,6 +1,6 @@
 ---
-title:
+title: '{{TITLE}}'
 date: '{{DATE}}'
 description:
 tags: []
----
+---

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

@@ -1,3 +1,4 @@
+require File.join(File.dirname(__FILE__), '..', 'compiler.rb')
 class Ruhoh::Resources::Stylesheets::Compiler
   include Ruhoh::SprocketsPlugin::Compiler
 end

data/system/plugins/sprockets/stylesheets/previewer.rb

@@ -1,3 +1,4 @@
+require File.join(File.dirname(__FILE__), '..', 'previewer.rb')
 module Ruhoh::Resources::Stylesheets
   class Previewer
     include Ruhoh::SprocketsPlugin::Previewer

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruhoh
 version: !ruby/object:Gem::Version
-  version: '2.2'
+  version: '2.3'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-09 00:00:00.000000000 Z
+date: 2013-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -152,14 +152,17 @@ files:
 - bin/ruhoh
 - cucumber.yml
 - features/categories.feature
+- features/config.feature
 - features/conversion.feature
 - features/data.feature
 - features/drafts.feature
+- features/ignore.feature
 - features/javascripts.feature
 - features/layouts.feature
 - features/pagination.feature
 - features/partials.feature
 - features/permalinks.feature
+- features/static.feature
 - features/step_defs.rb
 - features/stylesheets.feature
 - features/summary.feature
@@ -194,6 +197,7 @@ files:
 - lib/ruhoh/resources/dash/previewer.rb
 - lib/ruhoh/resources/data/collection.rb
 - lib/ruhoh/resources/data/collection_view.rb
+- lib/ruhoh/resources/ignore/collection.rb
 - lib/ruhoh/resources/javascripts/collection.rb
 - lib/ruhoh/resources/javascripts/collection_view.rb
 - lib/ruhoh/resources/javascripts/compiler.rb
@@ -209,6 +213,8 @@ files:
 - lib/ruhoh/resources/pages/model_view.rb
 - lib/ruhoh/resources/pages/previewer.rb
 - lib/ruhoh/resources/partials/model.rb
+- lib/ruhoh/resources/static/collection.rb
+- lib/ruhoh/resources/static/compiler.rb
 - lib/ruhoh/resources/stylesheets/collection.rb
 - lib/ruhoh/resources/stylesheets/collection_view.rb
 - lib/ruhoh/resources/stylesheets/compiler.rb
@@ -219,6 +225,9 @@ files:
 - lib/ruhoh/resources/widgets/compiler.rb
 - lib/ruhoh/resources/widgets/model.rb
 - lib/ruhoh/routes.rb
+- lib/ruhoh/string_format.rb
+- lib/ruhoh/summarizer.rb
+- lib/ruhoh/url_slug.rb
 - lib/ruhoh/utils.rb
 - lib/ruhoh/version.rb
 - lib/ruhoh/views/helpers/categories.rb
@@ -267,7 +276,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3919672923865862161
+      hash: 897888631782695949
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -276,7 +285,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3919672923865862161
+      hash: 897888631782695949
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24