ruhoh 0.0.3 → 0.0.6

data/README.md

@@ -7,3 +7,44 @@
 
     $ gem install ruhoh
     $ ruhoh help
+
+
+# SIMPLIFY SIMPLIFY SIMPLIFY 
+
+# Fronts
+
+## ruhoh hosting
+
+User Workflow:
+
+- user auths with ruhoh.com
+  ruhoh expects a users blog to be in the GitHub repo: username.ruhoh.com
+- user gives GitHub the ruhoh.com POST receive hook for his username.ruhoh.com repo
+
+Implementation:
+
+Sinatra app
+  handle POST requests from GitHub post receive hook.
+  oAuth via GitHub provider.
+  user accounts via GitHub oAuth.
+  wildcard domain name mapping: *.ruhoh.com
+  
+  git clone/fetch repositories and compile the blog for hosting.
+
+
+  x] create server on linode
+  x] host sinatra app at app.ruhoh.com
+  send post receive hook to app.ruhoh.com
+
+  hook should trigger git clone if repo does not exist.
+  hook should trigger git pull/fetch if repo does exist
+  repo should compile after repo update 
+  
+
+
+## Sbvtle 
+
+Adopt the admin UI at /\_drafts 
+
+
+  

data/bin/ruhoh

@@ -20,6 +20,12 @@ opt_parser = OptionParser.new do |opts|
     options.verbose = v
   end
     
+  opts.on("--version", "Display current gem and ruhoh specification versions.") do
+    puts "ruhoh " + Ruhoh::VERSION
+    puts "RuhohSpec " + Ruhoh::RuhohSpec
+    exit 0
+  end
+  
 end
 opt_parser.parse!
 

data/lib/ruhoh/client/client.rb

@@ -3,7 +3,8 @@ require 'ruhoh/compiler'
 class Ruhoh
   class Client
     
-    Paths = Struct.new(:blog_template, :page_template, :post_template, :layout_template, :theme_template)
+    Paths = Struct.new(:page_template, :post_template, :layout_template, :theme_template)
+    BlogScaffold = 'git://github.com/ruhoh/blog.git'
     
     def initialize(data)
       self.setup_paths
@@ -29,7 +30,6 @@ class Ruhoh
     
     def setup_paths
       @paths = Paths.new
-      @paths.blog_template    = File.join(Ruhoh::Root, "scaffolds", "blog")
       @paths.page_template    = File.join(Ruhoh::Root, "scaffolds", "page.html")
       @paths.post_template    = File.join(Ruhoh::Root, "scaffolds", "post.html")
       @paths.layout_template  = File.join(Ruhoh::Root, "scaffolds", "layout.html")
@@ -60,7 +60,7 @@ class Ruhoh
     def draft
       filename = File.join(Ruhoh.paths.drafts, "#{Time.now.to_i}.#{@options.ext}")
       if File.exist?(filename)
-        sleep 1 ; self.write(args) ; exit
+        sleep 1 ; self.draft(args) ; exit
       end
       
       FileUtils.mkdir_p File.dirname(filename)
@@ -73,6 +73,7 @@ class Ruhoh
       Ruhoh::Friend.say { 
         green "New draft:" 
         green Ruhoh.relative_path(filename)
+        green 'View drafts at the URL: /_drafts'
       }
     end
     
@@ -129,7 +130,7 @@ class Ruhoh
         exit
       } if (name.nil? || name.gsub(/\s/, '').empty?)
 
-      filename = File.join(Ruhoh.paths.site_source, name.gsub(/\s/, '-'))
+      filename = File.join(Ruhoh.paths.pages, name.gsub(/\s/, '-'))
       filename = File.join(filename, "index.#{@options.ext}") if File.extname(filename) == ""
       if File.exist?(filename)
         abort("Create new page: aborted!") if ask("#{filename} already exists. Do you want to overwrite?", ['y', 'n']) == 'n'
@@ -169,13 +170,20 @@ class Ruhoh
         plain "  Specify another directory or `rm -rf` this directory first."
         exit
       } if File.exist?(target_directory)
-        
-      FileUtils.mkdir target_directory
-      FileUtils.cp_r "#{@paths.blog_template}/.", target_directory
       
       Ruhoh::Friend.say { 
-        green "Blog cloned to:"
-        green "#{target_directory}"
+        plain "Trying this command:"
+        cyan "  git clone #{BlogScaffold} #{target_directory}"
+
+        if system('git', 'clone', BlogScaffold, target_directory)
+          green "Success! Now do..."
+          cyan "  cd #{target_directory}"
+          cyan "  rackup -p9292"
+          cyan "  http://localhost:9292"
+        else
+          red "Could not git clone blog scaffold. Please try it manually:"
+          cyan "  git clone git://github.com/ruhoh/blog.git #{target_directory}"
+        end
       }
     end
     
@@ -245,6 +253,15 @@ class Ruhoh
       self.list(:pages)
     end
  
+    # Return the payload hash for inspection/study.
+    def payload
+      require 'pp'
+      Ruhoh::DB.update!
+      Ruhoh::Friend.say {
+        plain Ruhoh::Templaters::Base.build_payload.pretty_inspect
+      }
+    end
+    
     # Internal: Outputs a list of the given data-type to the terminal.
     def list(type)
       Ruhoh::DB.update(type)

data/lib/ruhoh/client/help.yml

@@ -42,6 +42,10 @@ commands:
     "command" : "pages"
     "desc" : |
       List all pages.
+  -
+    "command" : "payload"
+    "desc" : |
+      List the full payload hash as given to the templater. Note page is blank for example purposes.
   -
     "command" : "layout <name>"
     "desc" : |

data/lib/ruhoh/compiler.rb

@@ -8,18 +8,18 @@ class Ruhoh
       @page = Ruhoh::Page.new
     end
     
+    # TODO: seems rather dangerous to delete the incoming target directory?
     def compile
       FileUtils.rm_r @target if File.exist?(@target)
-      FileUtils.mkdir @target
+      FileUtils.mkdir_p @target
       self.theme
       self.pages
       self.media
       self.syntax
+      true
     end
     
     def pages
-      processed = []
-      
       FileUtils.cd(@target) {
         Ruhoh::DB.posts['dictionary'].merge(Ruhoh::DB.pages).each_value do |p|
           @page.change(p['id'])
@@ -27,7 +27,6 @@ class Ruhoh
           FileUtils.mkdir_p File.dirname(@page.compiled_path)
           File.open(@page.compiled_path, 'w') { |p| p.puts @page.render }
 
-          processed << p
           Ruhoh::Friend.say { green "processed: #{p['id']}" }
         end
       }
@@ -35,16 +34,19 @@ class Ruhoh
     end
     
     def theme
+      return unless FileTest.directory? Ruhoh.paths.theme
       FileUtils.mkdir_p File.join(@target, Ruhoh.config.theme_path)
       FileUtils.cp_r Ruhoh.paths.theme, File.join(@target, Ruhoh.folders.templates, Ruhoh.folders.themes)
     end
     
     def media
+      return unless FileTest.directory? Ruhoh.paths.media
       FileUtils.mkdir_p File.join(@target, Ruhoh.folders.media)
-      FileUtils.cp_r Ruhoh.paths.media, @target
+      FileUtils.cp_r Ruhoh.paths.media, @target 
     end
     
     def syntax
+      return unless FileTest.directory? Ruhoh.paths.syntax
       syntax_path = File.join(@target, Ruhoh.folders.templates, Ruhoh.folders.syntax)
       FileUtils.mkdir_p syntax_path
       FileUtils.cp_r "#{Ruhoh.paths.syntax}/.", syntax_path

data/lib/ruhoh/logger.rb

@@ -0,0 +1,37 @@
+class Ruhoh
+  class Logger
+    
+    attr_reader :buffer
+    attr_accessor :log_file
+
+    def initialize
+      @buffer = []
+    end
+    
+    def error(string=nil)
+      message = ""
+      message << string if string
+      message << "\n" unless message[-1] == ?\n
+      @buffer << message
+      
+      self.on_error
+    end  
+    
+    def on_error
+      msg = @buffer[0]
+      Ruhoh::Friend.say { red msg }
+      self.to_file
+      exit -1
+    end
+    
+    def to_file
+      return unless self.log_file && @buffer.size > 0
+      File.open(self.log_file, "a") { |f|
+        f.puts '---'
+        f.puts Time.now.utc
+        f.puts @buffer.slice!(0..-1).join
+      }
+    end
+
+  end #Logger
+end #Ruhoh

data/lib/ruhoh/page.rb

@@ -12,12 +12,13 @@ class Ruhoh
     # Public: Change this page using an id.
     def change(id)
       @data = nil
-      
+      @path = id
       @data = if id =~ Regexp.new("^#{Ruhoh.folders.posts}")
         Ruhoh::DB.posts['dictionary'][id] 
       elsif id =~ Regexp.new("^#{Ruhoh.folders.drafts}")
         Ruhoh::DB.drafts[id] 
       else
+        @path = "#{Ruhoh.folders.pages}/#{id}"
         Ruhoh::DB.pages[id]
       end
       
@@ -32,7 +33,6 @@ class Ruhoh
       else
         Ruhoh::DB.routes[url]
       end
-      
       raise "Page id not found for url: #{url}" unless id
       self.change(id)
     end
@@ -62,8 +62,8 @@ class Ruhoh
     # Converters (markdown) always choke on the templating language.
     def process_content
       raise "ID is null: Id must be set via page.change(id) or page.change_with_url(url)" if @id.nil?
-      data = Ruhoh::Utils.parse_file(Ruhoh.paths.site_source, @id)
-      raise "Invalid Frontmatter in page: #{@id}" if data.empty?
+      data = Ruhoh::Utils.parse_file(Ruhoh.paths.site_source, @path)
+      raise "Invalid Frontmatter in page: #{@path}" if data.empty?
       
       @content = @templater.parse(data['content'], self)
       @content = @converter.convert(self)

data/lib/ruhoh/parsers/pages.rb

@@ -14,17 +14,18 @@ class Ruhoh
         dictionary = {}
 
         pages.each do |filename|
+          id = self.make_id(filename)
           parsed_page = Ruhoh::Utils.parse_file(filename)
           if parsed_page.empty?
             error = "Invalid Yaml Front Matter.\n Ensure this page has valid YAML, even if it's empty."
             invalid << [filename, error] ; next
           end
           
-          parsed_page['data']['id']     = filename
+          parsed_page['data']['id']     = id
           parsed_page['data']['url']    = self.permalink(parsed_page['data'])
           parsed_page['data']['title']  = parsed_page['data']['title'] || self.titleize(filename)
 
-          dictionary[filename] = parsed_page['data']
+          dictionary[id] = parsed_page['data']
         end
           
         report = "#{pages.count - invalid.count }/#{pages.count} pages processed."
@@ -45,7 +46,7 @@ class Ruhoh
 
       def self.files
         FileUtils.cd(Ruhoh.paths.site_source) {
-          return Dir["**/*.*"].select { |filename| 
+          return Dir["#{Ruhoh.folders.pages}/**/*.*"].select { |filename|
             next unless self.is_valid_page?(filename)
             true
           }
@@ -54,12 +55,16 @@ class Ruhoh
       
       def self.is_valid_page?(filepath)
         return false if FileTest.directory?(filepath)
-        return false if ['_', '.'].include? filepath[0]
+        return false if ['.'].include? filepath[0]
         return false if Ruhoh.filters.pages['names'].include? filepath
         Ruhoh.filters.pages['regexes'].each {|regex| return false if filepath =~ regex }
         true
       end
     
+      def self.make_id(filename)
+        filename.gsub(Regexp.new("^#{Ruhoh.folders.pages}/"), '')
+      end
+      
       def self.titleize(filename)
         name = File.basename( filename, File.extname(filename) )
         name = filename.split('/')[-2] if name == 'index' && !filename.index('/').nil?

data/lib/ruhoh/templaters/base.rb

@@ -4,15 +4,19 @@ class Ruhoh
     
     module Base
     
-      def self.build_payload(page)
+      def self.build_payload(page=nil)
         {
-          "page"    => page.attributes,
-          "site"    => Ruhoh::DB.site,
-          "pages"   => Ruhoh::DB.pages,
-          "_posts"  => Ruhoh::DB.posts,
-          "THEME_PATH" => Ruhoh.config.theme_path,
-          "SYNTAX_PATH" => Ruhoh.config.syntax_path,
-          "MEDIA_PATH" => Ruhoh.config.media_path
+          "db" => {
+            "pages" =>  Ruhoh::DB.pages,
+            "posts" => Ruhoh::DB.posts,
+          },
+          "page" => (page ? page.attributes : {}),
+          "site" => Ruhoh::DB.site,
+          "paths" => {
+            "theme"   => Ruhoh.config.theme_path,
+            "syntax"  => Ruhoh.config.syntax_path,
+            "media"   => Ruhoh.config.media_path
+          }
         }
       end
     

data/lib/ruhoh/templaters/helpers.rb

@@ -1,15 +1,35 @@
 require 'pp'
 
 class Ruhoh
-
   module Templaters
-    
     module Helpers
-
+      
       def partial(name)
         Ruhoh::DB.partials[name.to_s]
       end
-
+      
+      def pages
+        pages = []
+        self.context['db']['pages'].each_value {|page| pages << page }
+        self.mark_active_page(pages)
+      end
+      
+      def posts
+        self.to_posts(self.context['db']['posts']['chronological'])
+      end
+      
+      def categories
+        cats = []
+        self.context['db']['posts']['categories'].each_value { |cat| cats << cat }
+        cats
+      end
+      
+      def tags
+        tags = []
+        self.context['db']['posts']['categories'].each_value { |tag| tags << tag }
+        tags
+      end
+      
       def raw_code(sub_context)
         code = sub_context.gsub('{', '&#123;').gsub('}', '&#125;').gsub('<', '&lt;').gsub('>', '&gt;')
         "<pre><code>#{code}</code></pre>"
@@ -25,84 +45,51 @@ class Ruhoh
         "<pre>#{sub_context.class}\n#{sub_context.pretty_inspect}</pre>"
       end
 
-      def to_tags(sub_context)
-        if sub_context.is_a?(Array)
-          sub_context.map { |id|
-            self.context['_posts']['tags'][id] if self.context['_posts']['tags'][id]
-          }
-        else
-          tags = []
-          self.context['_posts']['tags'].each_value { |tag|
-            tags << tag
-          }
-          tags
-        end
-      end
-
       def to_posts(sub_context)
-        sub_context = sub_context.is_a?(Array) ? sub_context : self.context['_posts']['chronological']
-
-        sub_context.map { |id|
-          self.context['_posts']['dictionary'][id] if self.context['_posts']['dictionary'][id]
-        }
+        Array(sub_context).map { |id|
+          self.context['db']['posts']['dictionary'][id]
+        }.compact
       end
 
       def to_pages(sub_context)
-        pages = []
-        if sub_context.is_a?(Array) 
-          sub_context.each do |id|
-            if self.context[:pages][id]
-              pages << self.context[:pages][id]
-            end
-          end
-        else
-          self.context[:pages].each_value {|page| pages << page }
-        end
-        
-        pages.each_with_index do |page, i| 
-          next unless page['id'] == self.context[:page]['id']
-          active_page = page.dup
-          active_page['is_active_page'] = true
-          pages[i] = active_page
-        end
-        
-        pages
+        pages = Array(sub_context).map { |id|
+          self.context['db']['pages'][id]
+        }.compact
+        self.mark_active_page(pages)
       end
-
+      
       def to_categories(sub_context)
-        if sub_context.is_a?(Array)
-          sub_context.map { |id|
-            self.context['_posts']['categories'][id] if self.context['_posts']['categories'][id]
-          }
-        else
-          cats = []
-          self.context['_posts']['categories'].each_value { |cat|
-            cats << cat
-          }
-          cats
-        end
+        Array(sub_context).map { |id|
+          self.context['db']['posts']['categories'][id] 
+        }.compact
       end
-
+      
+      def to_tags(sub_context)
+        Array(sub_context).map { |id|
+          self.context['db']['posts']['tags'][id] 
+        }.compact
+      end
+      
       def next(sub_context)
         return unless sub_context.is_a?(String) || sub_context.is_a?(Hash)
         id = sub_context.is_a?(Hash) ? sub_context['id'] : sub_context
         return unless id
-        index = self.context['_posts']['chronological'].index(id)
+        index = self.context['db']['posts']['chronological'].index(id)
         return unless index && (index-1 >= 0)
-        next_id = self.context['_posts']['chronological'][index-1]
+        next_id = self.context['db']['posts']['chronological'][index-1]
         return unless next_id
-        self.to_posts([next_id])
+        self.to_posts(next_id)
       end
       
       def previous(sub_context)
         return unless sub_context.is_a?(String) || sub_context.is_a?(Hash)
         id = sub_context.is_a?(Hash) ? sub_context['id'] : sub_context
         return unless id
-        index = self.context['_posts']['chronological'].index(id)
+        index = self.context['db']['posts']['chronological'].index(id)
         return unless index && (index+1 >= 0)
-        prev_id = self.context['_posts']['chronological'][index+1]
+        prev_id = self.context['db']['posts']['chronological'][index+1]
         return unless prev_id
-        self.to_posts([prev_id])
+        self.to_posts(prev_id)
       end
             
       def analytics
@@ -152,8 +139,17 @@ class Ruhoh
         self.render(code)
       end
       
+      # Marks the active page if exists in the given pages Array
+      def mark_active_page(pages)
+        pages.each_with_index do |page, i| 
+          next unless page['id'] == self.context[:page]['id']
+          active_page = page.dup
+          active_page['is_active_page'] = true
+          pages[i] = active_page
+        end
+        pages
+      end
+      
     end #Helpers
-  
   end #Templaters
-  
 end #Ruhoh

data/lib/ruhoh/utils.rb

@@ -12,8 +12,10 @@ class Ruhoh
       file = File.open(filepath)
       yaml = YAML.load(file) || {}
       file.close  
-      
       yaml
+    rescue Psych::SyntaxError => e
+      Ruhoh.log.error("ERROR in #{filepath}: #{e.message}")
+      nil
     end
     
     def self.parse_file(*args)
@@ -33,6 +35,9 @@ class Ruhoh
         "data" => self.format_meta(data),
         "content" => page.gsub(FMregex, '')
       }
+    rescue Psych::SyntaxError => e
+      Ruhoh.log.error("ERROR in #{path}: #{e.message}")
+      nil
     end
     
     def self.format_meta(data)

data/lib/ruhoh/version.rb

@@ -1,3 +1,4 @@
 class Ruhoh
-  Version = VERSION = '0.0.3'
+  Version = VERSION = '0.0.6'
+  RuhohSpec = '0.1'
 end

data/lib/ruhoh.rb

@@ -6,6 +6,7 @@ require 'fileutils'
 
 require 'mustache'
 
+require 'ruhoh/logger'
 require 'ruhoh/utils'
 require 'ruhoh/friend'
 require 'ruhoh/parsers/drafts'
@@ -26,17 +27,23 @@ require 'ruhoh/watch'
 
 class Ruhoh
 
-  class << self; attr_reader :folders, :files, :config, :paths, :filters end
+  class << self
+    attr_accessor :log
+    attr_reader :folders, :files, :config, :paths, :filters
+  end
+  
+  @log = Ruhoh::Logger.new
   
   Root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
   DefaultExclude = ['Gemfile', 'Gemfile.lock', 'config.ru', 'README.md']
-  Folders = Struct.new(:database, :posts, :drafts, :templates, :themes, :layouts, :partials, :media, :syntax, :compiled)
+  Folders = Struct.new(:database, :pages, :posts, :drafts, :templates, :themes, :layouts, :partials, :media, :syntax, :compiled)
   Files = Struct.new(:site, :config)
   Filters = Struct.new(:posts, :pages, :static)
   Config = Struct.new(:permalink, :theme, :theme_path, :media_path, :syntax_path, :exclude)
   Paths = Struct.new(
     :site_source,
     :database,
+    :pages,
     :posts,
     :drafts,
     :theme,
@@ -49,20 +56,18 @@ class Ruhoh
   )
   
   
-  # Public: Setup Ruhoh utilities relative to the current directory
-  # of the application and its corresponding ruhoh.json file.
-  #
-  def self.setup(site_source = nil)
+  # 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]
 
-    @site_source = site_source if site_source
-    self.setup_config
-    self.setup_paths
-    self.setup_filters
+    !!(self.setup_config && self.setup_paths && self.setup_filters)
   end
   
   def self.reset
-    @folders     = Folders.new('_database', '_posts', '_drafts', '_templates', 'themes', 'layouts', 'partials', "_media", "syntax", '_compiled')
+    @folders     = Folders.new('_database', '_pages', '_posts', '_drafts', '_templates', 'themes', 'layouts', 'partials', "_media", "syntax", '_compiled')
     @files       = Files.new('_site.yml', '_config.yml')
     @filters     = Filters.new
     @config      = Config.new
@@ -72,17 +77,18 @@ class Ruhoh
   
   def self.setup_config
     site_config = Ruhoh::Utils.parse_file_as_yaml(@site_source, @files.config)
+    
     unless site_config
-      Ruhoh::Friend.say {
-        red "Empty site_config"
-        red "Please ensure ./#{Ruhoh.files.config} exists and contains valid YAML"
-      }
-      exit
+      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/, '') : ''
-    raise "Theme not specified in _config.yml" if theme.empty?
-
+    if theme.empty?
+      Ruhoh.log.error("Theme not specified in _config.yml")
+      return false
+    end
+    
     @config.theme         = theme
     @config.theme_path    = File.join('/', @folders.templates, @folders.themes, @config.theme)
     @config.media_path    = File.join('/', @folders.media)
@@ -94,6 +100,7 @@ class Ruhoh
   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)
     @paths.drafts           = self.absolute_path(@folders.drafts)
 
@@ -104,6 +111,7 @@ class Ruhoh
     @paths.media            = self.absolute_path(@folders.media)
     @paths.syntax           = self.absolute_path(@folders.templates, @folders.syntax)
     @paths.compiled         = self.absolute_path(@folders.compiled)
+    @paths
   end
   
   # filename filters
@@ -116,6 +124,7 @@ class Ruhoh
       @filters.pages['names'] << node if node.is_a?(String)
       @filters.pages['regexes'] << node if node.is_a?(Regexp)
     }
+    @filters
   end
   
   def self.absolute_path(*args)