ruhoh 0.3.0 → 1.0.0.alpha

data/lib/ruhoh/utils.rb

@@ -1,11 +1,9 @@
 class Ruhoh
-  
   module Utils
     
     FMregex = /^(---\s*\n.*?\n?)^(---\s*$\n?)/m
-    ContentRegex = /\{\{\s*content\s*\}\}/i
     
-    def self.parse_file_as_yaml(*args)
+    def self.parse_yaml_file(*args)
       filepath = File.__send__ :join, args
       return nil unless File.exist? filepath
 
@@ -17,20 +15,23 @@ class Ruhoh
       nil
     end
     
-    def self.parse_file(*args)
+    def self.parse_page_file(*args)
       path = File.__send__(:join, args)
-      
       raise "File not found: #{path}" unless File.exist?(path)
 
       page = File.open(path, 'r:UTF-8') {|f| f.read }
-      front_matter = page.match(FMregex)
-
-      return {} unless front_matter
-
-      data = YAML.load(front_matter[0].gsub(/---\n/, "")) || {}
 
+      front_matter = page.match(FMregex)
+      if front_matter
+        data = YAML.load(front_matter[0].gsub(/---\n/, "")) || {}
+        data['categories'] = Array(data['categories'])
+        data['tags'] = Array(data['tags'])
+      else
+        data = {}
+      end
+      
       { 
-        "data" => self.format_meta(data),
+        "data" => data,
         "content" => page.gsub(FMregex, '')
       }
     rescue Psych::SyntaxError => e
@@ -38,13 +39,36 @@ class Ruhoh
       nil
     end
     
-    def self.format_meta(data)
-      data['categories'] = Array(data['categories'])
-      data['tags'] = Array(data['tags'])
-      data
+    def self.parse_layout_file(*args)
+      path = File.__send__(:join, args)
+      raise "Layout file not found: #{path}" unless File.exist?(path)
+      data = {}
+      page = File.open(path, 'r:UTF-8') {|f| f.read }
+
+      front_matter = page.match(FMregex)
+      if front_matter
+        data = YAML.load(front_matter[0].gsub(/---\n/, "")) || {}
+      end
+      
+      { 
+        "data" => data,
+        "content" => page.gsub(FMregex, '')
+      }
+    rescue Psych::SyntaxError => e
+      Ruhoh.log.error("ERROR in #{path}: #{e.message}")
+      nil
     end
     
-    
+    def self.relative_path(filename)
+      filename.gsub(Regexp.new("^#{Ruhoh.paths.base}/"), '')
+    end
+
+    def self.url_to_path(url, base=nil)
+      parts = url.split('/')
+      parts = parts.unshift(base) if base
+      File.__send__(:join, parts)
+    end    
+
     def self.report(name, collection, invalid)
       output = "#{collection.count}/#{collection.count + invalid.count} #{name} processed."
       if collection.empty? && invalid.empty?
@@ -59,6 +83,24 @@ class Ruhoh
       end
     end
     
+    # Merges hash with another hash, recursively.
+    #
+    # Adapted from Jekyll which got it from some gem whose link is now broken.
+    # Thanks to whoever made it.
+    def self.deep_merge(hash1, hash2)
+      target = hash1.dup
+
+      hash2.keys.each do |key|
+        if hash2[key].is_a? Hash and hash1[key].is_a? Hash
+          target[key] = self.deep_merge(target[key], hash2[key])
+          next
+        end
+
+        target[key] = hash2[key]
+      end
+
+      target
+    end
+    
   end
-  
 end #Ruhoh

data/lib/ruhoh/version.rb

@@ -1,4 +1,4 @@
 class Ruhoh
-  Version = VERSION = '0.3.0'
-  RuhohSpec = '0.2'
+  Version = VERSION = '1.0.0.alpha'
+  RuhohSpec = '1.0'
 end

data/lib/ruhoh/watch.rb

@@ -11,46 +11,58 @@ class Ruhoh
     def self.start
       Ruhoh.ensure_setup
       Ruhoh::Friend.say {
-        plain "=> Start watching: #{Ruhoh.paths.site_source}"
+        plain "=> Start watching: #{Ruhoh.paths.base}"
       }
       glob = ''
     
       # Watch all files + all sub directories except for special folders e.g '_database'
-      Dir.chdir(Ruhoh.paths.site_source) {
+      Dir.chdir(Ruhoh.paths.base) {
         dirs = Dir['*'].select { |x| File.directory?(x) }
-        dirs -= [Ruhoh.folders.database]
         dirs = dirs.map { |x| "#{x}/**/*" }
         dirs += ['*']
         glob = dirs
       }
 
-      dw = DirectoryWatcher.new(Ruhoh.paths.site_source, {
+      dw = DirectoryWatcher.new(Ruhoh.paths.base, {
         :glob => glob, 
         :pre_load => true
       })
       dw.interval = 1
       dw.add_observer {|*args| 
         args.each {|event|
-          path = event['path'].gsub(Ruhoh.paths.site_source, '')
+          path = event['path'].gsub(Ruhoh.paths.base + '/', '')
 
-          if path == "/#{Ruhoh.files.site}"
+          if path == Ruhoh.names.site_data
             type = "Site"
             Ruhoh::DB.update(:site)
-          elsif path == "/#{Ruhoh.files.config}"
+          elsif path == Ruhoh.names.config_data
             type = "Config"
             Ruhoh::DB.update(:site)
-          elsif path =~ Regexp.new("^\/?#{Ruhoh.folders.posts}")
+          elsif path =~ Regexp.new("^#{Ruhoh.names.pages}")
+            type = "Pages"
+            Ruhoh::DB.update(:pages)
+            Ruhoh::DB.update(:routes)
+          elsif path =~ Regexp.new("^(#{Ruhoh.names.partials}|#{Ruhoh.names.themes}\/#{Ruhoh.config.theme}\/#{Ruhoh.names.partials})")
+            type = "Partials"
+            Ruhoh::DB.update(:partials)
+          elsif path =~ Regexp.new("^#{Ruhoh.names.posts}")
             type = "Posts"
             Ruhoh::DB.update(:posts)
             Ruhoh::DB.update(:routes)
-          elsif path =~ Regexp.new("^\/?#{Ruhoh.folders.templates}")
-            type = "Themes"
+          elsif path =~ Regexp.new("^#{Ruhoh.names.themes}\/#{Ruhoh.config.theme}\/#{Ruhoh.names.layouts}")
+            type = "Layouts"
             Ruhoh::DB.update(:layouts)
-            Ruhoh::DB.update(:partials)
+          elsif path =~ Regexp.new("^#{Ruhoh.names.themes}\/#{Ruhoh.config.theme}")
+            type = "Theme"
+            Ruhoh::DB.update(:stylesheets)
+            Ruhoh::DB.update(:javascripts)
+            Ruhoh::DB.update(:widgets)
+            Ruhoh::DB.update(:layouts)
+          elsif path =~ Regexp.new("^#{Ruhoh.names.widgets}")
+            type = "Widgets"
+            Ruhoh::DB.update(:widgets)
           else
-            type = "Pages"
-            Ruhoh::DB.update(:pages)
-            Ruhoh::DB.update(:routes)
+            type = 'Unrecognized'
           end
           
           Ruhoh::Friend.say {

data/lib/ruhoh.rb

@@ -8,23 +8,18 @@ require 'json'
 require 'time'
 require 'cgi'
 require 'fileutils'
+require 'ostruct'
 
 require 'mustache'
 
 require 'ruhoh/logger'
 require 'ruhoh/utils'
 require 'ruhoh/friend'
-require 'ruhoh/parsers/posts'
-require 'ruhoh/parsers/pages'
-require 'ruhoh/parsers/routes'
-require 'ruhoh/parsers/layouts'
-require 'ruhoh/parsers/partials'
-require 'ruhoh/parsers/site'
+require 'ruhoh/config'
+require 'ruhoh/paths'
+require 'ruhoh/urls'
 require 'ruhoh/db'
-require 'ruhoh/templaters/helpers'
 require 'ruhoh/templaters/rmustache'
-require 'ruhoh/templaters/base'
-require 'ruhoh/converters/markdown'
 require 'ruhoh/converters/converter'
 require 'ruhoh/page'
 require 'ruhoh/previewer'
@@ -35,97 +30,52 @@ class Ruhoh
   
   class << self
     attr_accessor :log
-    attr_reader :folders, :files, :config, :paths, :filters
+    attr_reader :config, :names, :paths, :root, :urls
   end
   
   @log = Ruhoh::Logger.new
-
-  Root      = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-  Folders   = Struct.new(:database, :pages, :posts, :templates, :themes, :layouts, :partials, :media, :syntax, :compiled, :plugins)
-  Files     = Struct.new(:site, :config, :dashboard)
-  Filters   = Struct.new(:posts, :pages, :static)
-  Config    = Struct.new(:permalink, :pages_permalink, :theme, :theme_path, :media_path, :syntax_path, :exclude, :env)
-  Paths     = Struct.new(
-                :site_source, :database, :pages, :posts, :theme, :layouts, :partials, :global_partials, :media, :syntax,
-                :compiled, :dashboard, :plugins)
-  
+  Root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+  Names = {
+    :assets => 'assets',
+    :config_data => 'config.yml',
+    :compiled => 'compiled',
+    :dashboard_file => 'dash.html',
+    :layouts => 'layouts',
+    :media => 'media',
+    :pages => 'pages',
+    :partials => 'partials',
+    :plugins => 'plugins',
+    :posts => 'posts',
+    :javascripts => 'javascripts',
+    :site_data => 'site.yml',
+    :stylesheets => 'stylesheets',
+    :themes => 'themes',
+    :theme_config => 'theme.yml',
+    :widgets => 'widgets',
+    :widget_config => 'config.yml'
+  }
+  @names = OpenStruct.new(Names)
+  @root = Root
   
   # Public: Setup Ruhoh utilities relative to the current application directory.
   # Returns boolean on success/failure
   def self.setup(opts={})
-    @log.log_file = opts[:log_file] if opts[:log_file]
     self.reset
-    @site_source = opts[:source] if opts[:source]
-    
-    if (self.setup_config && self.setup_paths && self.setup_filters)
-      self.setup_plugins unless opts[:enable_plugins] == false
-      true
-    else
-      false
-    end
-  end
-  
-  def self.reset
-    @folders     = Folders.new('_database', '_pages', '_posts', '_templates', 'themes', 'layouts', 'partials', "_media", "syntax", '_compiled', '_plugins')
-    @files       = Files.new('_site.yml', '_config.yml', 'dash.html')
-    @filters     = Filters.new
-    @config      = Config.new
-    @paths       = Paths.new
-    @site_source = Dir.getwd
-  end
-  
-  def self.setup_config
-    site_config = Ruhoh::Utils.parse_file_as_yaml(@site_source, @files.config)
-    
-    unless site_config
-      Ruhoh.log.error("Empty site_config.\nEnsure ./#{Ruhoh.files.config} exists and contains valid YAML")
-      return false
-    end
-    
-    theme = site_config['theme'] ? site_config['theme'].to_s.gsub(/\s/, '') : ''
-    if theme.empty?
-      Ruhoh.log.error("Theme not specified in _config.yml")
-      return false
-    end
+    @log.log_file = opts[:log_file] if opts[:log_file]
+    @base = opts[:source] if opts[:source]
     
-    @config.theme         = theme
-    @config.theme_path    = File.join('/', @folders.templates, @folders.themes, @config.theme)
-    @config.media_path    = File.join('/', @folders.media)
-    @config.syntax_path   = File.join('/', @folders.templates, @folders.syntax)
-    @config.permalink     = site_config['permalink']
-    @config.pages_permalink = site_config['pages']['permalink'] rescue nil
-    excluded_pages = site_config['pages']['exclude'] rescue nil
-    @config.exclude       = {
-      "posts" => Array(site_config['exclude'] || nil),
-      "pages" => Array(excluded_pages),
-    }
-    @config.env           = site_config['env'] || nil
-    @config
-  end
-  
-  def self.setup_paths
-    @paths.site_source      = @site_source
-    @paths.database         = self.absolute_path(@folders.database)
-    @paths.pages            = self.absolute_path(@folders.pages)
-    @paths.posts            = self.absolute_path(@folders.posts)
+    @config   = Ruhoh::Config.generate(@names.config_data)
+    @paths    = Ruhoh::Paths.generate(@config, @base)
+    @urls     = Ruhoh::Urls.generate(@config)
 
-    @paths.theme            = self.absolute_path(@folders.templates, @folders.themes, @config.theme)
-    @paths.layouts          = self.absolute_path(@folders.templates, @folders.themes, @config.theme, @folders.layouts)
-    @paths.partials         = self.absolute_path(@folders.templates, @folders.themes, @config.theme, @folders.partials)
-    @paths.global_partials  = self.absolute_path(@folders.templates, @folders.partials)
-    @paths.media            = self.absolute_path(@folders.media)
-    @paths.syntax           = self.absolute_path(@folders.templates, @folders.syntax)
-    @paths.compiled         = self.absolute_path(@folders.compiled)
-    @paths.dashboard        = self.absolute_path(@files.dashboard)
-    @paths.plugins          = self.absolute_path(@folders.plugins)
-    @paths
+    return false unless(@config && @paths && @urls)
+    
+    self.setup_plugins unless opts[:enable_plugins] == false
+    true
   end
   
-  # filename filters
-  def self.setup_filters
-    @filters.pages = @config.exclude['pages'].map {|node| Regexp.new(node) }
-    @filters.posts = @config.exclude['posts'].map {|node| Regexp.new(node) }
-    @filters
+  def self.reset
+    @base = Dir.getwd
   end
   
   def self.setup_plugins
@@ -133,14 +83,6 @@ class Ruhoh
     plugins.each {|f| require f } unless plugins.empty?
   end
   
-  def self.absolute_path(*args)
-    File.__send__ :join, args.unshift(self.paths.site_source)
-  end
-  
-  def self.relative_path(filename)
-    filename.gsub( Regexp.new("^#{self.paths.site_source}/"), '' )
-  end
-    
   def self.ensure_setup
     raise 'Ruhoh has not been setup. Please call: Ruhoh.setup' unless Ruhoh.config && Ruhoh.paths
   end  

data/ruhoh.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'directory_watcher', "~> 1.4"
   s.add_dependency 'redcarpet', "~> 2.1"
   s.add_dependency 'psych', "~> 1.3"
+  s.add_dependency 'nokogiri', "~> 1.5"
   
   # = MANIFEST =
   s.files = %w[
@@ -32,6 +33,9 @@ Gem::Specification.new do |s|
     lib/ruhoh/client/client.rb
     lib/ruhoh/client/help.yml
     lib/ruhoh/compiler.rb
+    lib/ruhoh/compilers/rss.rb
+    lib/ruhoh/compilers/theme.rb
+    lib/ruhoh/config.rb
     lib/ruhoh/converters/converter.rb
     lib/ruhoh/converters/markdown.rb
     lib/ruhoh/db.rb
@@ -39,30 +43,42 @@ Gem::Specification.new do |s|
     lib/ruhoh/friend.rb
     lib/ruhoh/logger.rb
     lib/ruhoh/page.rb
+    lib/ruhoh/parsers/javascripts.rb
     lib/ruhoh/parsers/layouts.rb
     lib/ruhoh/parsers/pages.rb
     lib/ruhoh/parsers/partials.rb
+    lib/ruhoh/parsers/payload.rb
     lib/ruhoh/parsers/posts.rb
     lib/ruhoh/parsers/routes.rb
     lib/ruhoh/parsers/site.rb
+    lib/ruhoh/parsers/stylesheets.rb
+    lib/ruhoh/parsers/widgets.rb
+    lib/ruhoh/paths.rb
     lib/ruhoh/previewer.rb
     lib/ruhoh/program.rb
-    lib/ruhoh/templaters/base.rb
+    lib/ruhoh/templaters/asset_helpers.rb
+    lib/ruhoh/templaters/base_helpers.rb
     lib/ruhoh/templaters/helpers.rb
     lib/ruhoh/templaters/rmustache.rb
+    lib/ruhoh/urls.rb
     lib/ruhoh/utils.rb
     lib/ruhoh/version.rb
     lib/ruhoh/watch.rb
     ruhoh.gemspec
+    scaffolds/draft.html
     scaffolds/layout.html
     scaffolds/page.html
     scaffolds/post.html
-    scaffolds/theme/css/style.css
-    scaffolds/theme/images/.gitkeep
+    scaffolds/theme/javascripts/.gitkeep
     scaffolds/theme/layouts/default.html
     scaffolds/theme/layouts/page.html
     scaffolds/theme/layouts/post.html
+    scaffolds/theme/media/.gitkeep
     scaffolds/theme/partials/.gitkeep
+    scaffolds/theme/stylesheets/style.css
+    scaffolds/theme/theme.yml
+    scaffolds/theme/widgets/.gitkeep
+    spec/config_spec.rb
     spec/db_spec.rb
     spec/page_spec.rb
     spec/parsers/layouts_spec.rb
@@ -72,13 +88,16 @@ Gem::Specification.new do |s|
     spec/parsers/site_spec.rb
     spec/setup_spec.rb
     spec/spec_helper.rb
-    system_partials/analytics/getclicky
-    system_partials/analytics/google
-    system_partials/comments/disqus
-    system_partials/comments/facebook
-    system_partials/comments/intensedebate
-    system_partials/comments/livefyre
-    system_partials/syntax/google_prettify
+    widgets/analytics/config.yml
+    widgets/analytics/layouts/getclicky.html
+    widgets/analytics/layouts/google.html
+    widgets/comments/config.yml
+    widgets/comments/layouts/disqus.html
+    widgets/comments/layouts/facebook.html
+    widgets/comments/layouts/intensedebate.html
+    widgets/comments/layouts/livefyre.html
+    widgets/google_prettify/config.yml
+    widgets/google_prettify/layouts/google_prettify.html
   ]
   # = MANIFEST =
 end

data/scaffolds/draft.html

@@ -0,0 +1,9 @@
+---
+title:
+date: '{{DATE}}'
+description:
+categories:
+tags: []
+
+type: draft
+---

data/scaffolds/page.html

@@ -1,6 +1,4 @@
 ---
 title:
 description:
-
-layout: page
 ---

data/scaffolds/post.html

@@ -3,8 +3,4 @@ title:
 date: '{{DATE}}'
 description:
 categories:
-tags: []
-
-layout: post
-type: draft
 ---

data/scaffolds/theme/layouts/default.html

@@ -1,15 +1,13 @@
----
----
 <!DOCTYPE html>
 <html lang="en">
 <head>
   <meta charset="utf-8">
-  <link href="{{ paths.theme }}/css/style.css" rel="stylesheet" type="text/css" media="all">
+  {{{ assets }}}
 </head>
 <body>
 
     <div class="content">
-      {{ content }}
+      {{{ content }}}
     </div>
 
   {{{ analytics }}}

data/scaffolds/theme/layouts/page.html

@@ -4,4 +4,4 @@ layout : default
 
 <h1>{{ page.title }}</h1>
 
-{{ content }}
+{{{ content }}}

data/scaffolds/theme/layouts/post.html

@@ -2,7 +2,7 @@
 layout : default
 ---
 
-{{ content }}
+{{{ content }}}
 
 {{{ comments }}}
  

data/scaffolds/theme/theme.yml

@@ -0,0 +1,27 @@
+{
+  "stylesheets" : {
+    "default" : [
+      "style.css"
+    ],
+    
+    "page" : [
+    
+    ],
+    
+    "post" : [
+    
+    ],
+    
+    "widgets" : {
+
+    }
+    
+  },
+  
+  "javascripts" : {
+    "default" : [
+
+    ]
+  }
+  
+}

data/spec/config_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+module Config
+  describe "Config" do
+    describe "#setup_config" do
+      context "Invalid _config.yml file" do
+        it 'should log error and return false if theme is not specified.' do
+          Ruhoh::Utils.should_receive(:parse_yaml_file).and_return({})
+          
+          Ruhoh.log.should_receive(:error)
+          Ruhoh::Config.generate('config.yml').should be_false
+        end
+      end
+      context "Valid _config.yml file" do
+        it 'should setup the config struct based on configuration input.' do
+          custom_permalink = '/my/custom/link'
+          custom_theme = 'table'
+          custom_exclude = ['.secret']
+          Ruhoh::Utils.should_receive(:parse_yaml_file).and_return({
+            "theme" => custom_theme,
+            "posts" => {
+              "permalink" => custom_permalink, 
+              'exclude' => custom_exclude
+            }
+          })
+
+          config = Ruhoh::Config.generate('config.yml')
+          config.theme.should == custom_theme
+          config.posts_exclude.should == [/.secret/]
+        end
+      end
+    end
+    
+    describe "#setup_filters" do
+      it 'should add custom exclude filters to the filters variable' do
+        custom_exclude = ['.secret', '^test']
+        Ruhoh::Utils.should_receive(:parse_yaml_file).and_return({
+          'theme' => "twitter",
+          "posts" => {
+            'exclude' => custom_exclude
+          },
+        })
+        
+        config = Ruhoh::Config.generate('config.yml')
+        config.posts_exclude.should include(/.secret/)
+        config.posts_exclude.should include(/^test/)
+      end
+    end
+  end
+end

data/spec/db_spec.rb

@@ -1,21 +1,19 @@
-require 'spec_helper'
-
 module DB
   
   describe Ruhoh::DB do
-    let(:whitelist){
-      [:site, :routes, :posts, :pages, :layouts, :partials]
-    }
+    let(:whitelist){ Ruhoh::DB::WhiteList }
     
     before(:each) do
-      Ruhoh::Utils.stub(:parse_file_as_yaml).and_return({'theme' => "twitter"})
+      Ruhoh::Utils.stub(:parse_yaml_file).and_return({'theme' => "twitter"})
+      Ruhoh::Paths.stub(:theme_is_valid?).and_return(true)
       Ruhoh.setup(:source => SampleSitePath)
     end
     
     context "database has not been updated" do
-      it "should return nil for all whitelisted variables" do
+      it "should return nil for all whitelisted variables except payload" do
         whitelist.each do |var|
-          result = Ruhoh::DB.__send__ var
+          result = Ruhoh::DB.__send__(var)
+          next if var == :payload
           result.should be_nil
         end
       end
@@ -62,16 +60,32 @@ module DB
         Ruhoh::DB.update(:partials)
         Ruhoh::DB.partials.should == {'test' => 'hi'}
       end
+      
+      it "should run the widgets parser when updating :widgets" do
+        Ruhoh::Parsers::Widgets.should_receive(:generate).and_return({'test' => 'hi'})
+        Ruhoh::DB.update(:widgets)
+        Ruhoh::DB.widgets.should == {'test' => 'hi'}
+      end
+      
+      it "should run the stylesheets parser when updating :stylesheets" do
+        Ruhoh::Parsers::Stylesheets.should_receive(:generate).and_return({'test' => 'hi'})
+        Ruhoh::DB.update(:stylesheets)
+        Ruhoh::DB.stylesheets.should == {'test' => 'hi'}
+      end
+
+      it "should run the scripts parser when updating :javascripts" do
+        Ruhoh::Parsers::Javascripts.should_receive(:generate).and_return({'test' => 'hi'})
+        Ruhoh::DB.update(:javascripts)
+        Ruhoh::DB.javascripts.should == {'test' => 'hi'}
+      end
+      
     end
     
     describe "#update_all" do
       it "should call update for all WhiteListed variables." do
-        Ruhoh::DB.should_receive(:update).with(:site).ordered
-        Ruhoh::DB.should_receive(:update).with(:posts).ordered
-        Ruhoh::DB.should_receive(:update).with(:pages).ordered
-        Ruhoh::DB.should_receive(:update).with(:routes).ordered
-        Ruhoh::DB.should_receive(:update).with(:layouts).ordered
-        Ruhoh::DB.should_receive(:update).with(:partials).ordered
+        whitelist.each do |name|
+          Ruhoh::DB.should_receive(:update).with(name).ordered
+        end
         Ruhoh::DB.update_all
       end
     end