ruhoh 0.0.2 → 0.0.3

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+gemspec
+
+gem 'rake'
+gem 'rack', "~> 1.4"
+gem 'directory_watcher', "~> 1.4"
+gem 'mustache', "~> 0.99"
+gem 'maruku', "~> 0.6"
+gem 'aws-s3'
+
+group :development do
+  gem 'rspec'
+end

data/README.md

@@ -1,57 +1,9 @@
-=)
-
-
-## Setup/Config
-
-Ruhoh.setup is responsible for building the configuration data.
-The config takes a given source directory, parses its \_config.yml
-and builds absolute paths to all the Filesystem API endpoints relative to the source directory.
-
-## Parsers
-
-Parsers are small, atomic, functional methods used to process data.
-Parsers follow the Ruhoh interface specification, to locate, extract, and process data relative to the source directory.
-
-
-## DB
-
-The database is responsible for holding website's main data.
-The database depends on Ruhoh.config. 
-It depends on the parsers to parse the source directory in order to return the data.
-
-
-## Page
-
-The page class models a page in the ruhoh system.
-A page is technically a post object or a page object.
-
-- content
-- data (includes yaml front matter + url, id etc.)
-- sub\_layout
-- master\_layout
-
-## Converter
-
-The converter is responsible for converting a pages 'content' into HTML.
-A page can be written in various markup formats specified by the page's extension.
-
-## Templater
-
-The templater is responsible for building the finished page by 
-utilizing the layouts, content, and any embedded templating language expressions.
-
-
-# Compiler
-
-Compiles the full website
-
-# Preview
-
-Serves a singular page view to a web-server identified by its url.
-
-
-
 
+## Ruhoh is the Universal Static Blog API
 
+<http://ruhoh.com>
 
+### Usage
 
+    $ gem install ruhoh
+    $ ruhoh help

data/Rakefile

@@ -0,0 +1,56 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w[lib]))
+require 'rubygems'
+require 'rake'
+require 'bundler'
+require 'ruhoh/version'
+require 'rspec/core/rake_task'
+
+name = Dir['*.gemspec'].first.split('.').first
+gemspec_file = "#{name}.gemspec"
+gem_file = "#{name}-#{Ruhoh::VERSION}.gem"
+
+task :release => :build do
+  #unless `git branch` =~ /^\* master$/
+  #  puts "You must be on the master branch to release!"
+  #  exit!
+  #end
+  sh "git commit --allow-empty -m 'Release #{Ruhoh::VERSION}'"
+  sh "git tag v#{Ruhoh::VERSION}"
+  sh "git push origin master"
+  sh "git push origin v#{Ruhoh::VERSION}"
+  sh "gem push pkg/#{name}-#{Ruhoh::VERSION}.gem"
+end
+
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+task :gemspec do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg|coverage)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+## Tests
+
+RSpec::Core::RakeTask.new('spec')
+
+desc "Run tests"
+task :default => :spec

data/bin/ruhoh

@@ -3,20 +3,29 @@
 $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
 require 'ruhoh'
-require 'ruhoh/client'
+require 'ruhoh/client/client'
+require 'optparse'
 
-help = <<HELP
-Ruhoh is the best static blog generator known to mankind.
+Options = Struct.new(:title, :date, :ext, :verbose)
+options = Options.new
 
-Basic Command Line Usage:
-  Test
-HELP
+opt_parser = OptionParser.new do |opts|
+  opts.banner = 'Use `ruhoh help` for full command list.'
+  
+  opts.on("-e", "--ext [EXT]", "Specify filename extension. Defaults to '.md' ") do |ext|
+    options.ext = ext
+  end
+  
+  opts.on("-v", "--[no-]verbose", "Run verbosely. For pages, shows extra title, url meta-data.") do |v|
+    options.verbose = v
+  end
+    
+end
+opt_parser.parse!
+
+Ruhoh::Client.new({
+  :args => ARGV,
+  :options => options,
+  :opt_parser => opt_parser
+})
 
-case ARGV[0]
-when 'new'
-  Ruhoh::Client.new_blog(ARGV[1])
-when 'help'
-  puts help
-else
-  puts help
-end

data/lib/ruhoh/client/client.rb

@@ -0,0 +1,310 @@
+require 'ruhoh/compiler'
+
+class Ruhoh
+  class Client
+    
+    Paths = Struct.new(:blog_template, :page_template, :post_template, :layout_template, :theme_template)
+    
+    def initialize(data)
+      self.setup_paths
+      self.setup_options(data)
+      
+      cmd = (data[:args][0] == 'new') ? 'blog' : (data[:args][0] || 'help')
+      Ruhoh::Friend.say { 
+        red "Command not found"
+        exit 
+      } unless self.respond_to?(cmd)
+
+      Ruhoh.setup unless ['help','blog'].include?(cmd)
+
+      self.__send__(cmd)
+    end  
+    
+    def setup_options(data)
+      @args = data[:args]
+      @options = data[:options]
+      @opt_parser = data[:opt_parser]
+      @options.ext = (@options.ext || 'md').gsub('.', '')
+    end
+    
+    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")
+      @paths.theme_template   = File.join(Ruhoh::Root, "scaffolds", "theme")
+    end
+
+    # Internal: Show Client Utility help documentation.
+    def help
+      file = File.join(Ruhoh::Root, 'lib', 'ruhoh', 'client', 'help.yml')
+      content = Ruhoh::Utils.parse_file_as_yaml(file)
+      options = @opt_parser.help
+      Ruhoh::Friend.say { 
+        plain content['description']
+        plain ''
+        plain options
+        plain ''
+        plain 'Commands:'
+        plain ''
+        content['commands'].each do |a|
+          green("  " + a["command"])
+          plain("    "+ a["desc"])
+        end
+      }
+    end
+    
+    # Public: Create a new draft file.
+    # Requires no settings as it is meant to be fastest way to create content.
+    def draft
+      filename = File.join(Ruhoh.paths.drafts, "#{Time.now.to_i}.#{@options.ext}")
+      if File.exist?(filename)
+        sleep 1 ; self.write(args) ; exit
+      end
+      
+      FileUtils.mkdir_p File.dirname(filename)
+      File.open(@paths.post_template) do |template|
+        File.open(filename, 'w') do |post|
+          post.puts template.read
+        end
+      end
+      
+      Ruhoh::Friend.say { 
+        green "New draft:" 
+        green Ruhoh.relative_path(filename)
+      }
+    end
+    
+    # Public: Publishes the last active draft file.
+    def publish
+      id = self.last('draft')
+      Ruhoh::Friend.say { yellow "No draft to publish." ; exit } if id.nil?
+      Ruhoh::Friend.say { plain "Publishing draft: #{id}" }
+      draft = Ruhoh::Parsers::Posts.process_file(id)
+
+      Ruhoh::Friend.say { red "Draft title cannot be blank." ; exit } unless draft['data']['title']
+      Ruhoh::Friend.say {
+        red "Invalid date format: #{draft['data']['date']}"
+        red "Date format must be YYYY-MM-DD."
+        exit
+      } unless draft['data']['date']
+      
+      draft['data']['ext'] = @options.ext
+      filename = Ruhoh::Parsers::Posts.to_filename(draft['data'])
+
+      if File.exist?(filename)
+        abort("\e[31m Aborted! \e[0m") if ask("#{filename} already exists. Do you want to overwrite?", ['y', 'n']) == 'n'
+      end
+      
+      FileUtils.mkdir_p File.dirname(filename)
+      FileUtils.mv id, filename
+
+      Ruhoh::Friend.say { 
+        green "Published post:"
+        green Ruhoh.relative_path(filename)
+      }
+    end
+    
+    # Public: Unpublishes the last active post file.
+    def unpublish
+      post = self.last('post')
+      Ruhoh::Friend.say { yellow "No post to unpublish." ; exit } if post.nil?
+      Ruhoh::Friend.say { plain "Unpublishing post: #{post}" }
+
+      FileUtils.mv post, File.join(Ruhoh.paths.drafts, File.basename(post))
+
+      Ruhoh::Friend.say { 
+        yellow "Unpublished post:"
+        yellow Ruhoh.relative_path(post)
+      }
+    end
+    
+    # Public: Create a new page file.
+    def page
+      name = @args[1]
+      Ruhoh::Friend.say { 
+        red "Please specify a path"
+        plain "  ex: ruhoh page projects/hello-world"
+        exit
+      } if (name.nil? || name.gsub(/\s/, '').empty?)
+
+      filename = File.join(Ruhoh.paths.site_source, 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'
+      end
+
+      FileUtils.mkdir_p File.dirname(filename)
+      File.open(@paths.page_template) do |template|
+        File.open(filename, 'w') do |page|
+          page.puts template.read
+        end
+      end
+      
+      Ruhoh::Friend.say { 
+        green "New page:"
+        plain Ruhoh.relative_path(filename)
+      }
+    end
+
+    # Public: Compile to static website.
+    def compile
+      Ruhoh::Compiler.new(@args[1]).compile
+    end
+    
+    # Public: Create a new blog at the directory provided.
+    def blog
+      name = @args[1]
+      Ruhoh::Friend.say { 
+        red "Please specify a directory path." 
+        plain "  ex: ruhoh new the-blogist"
+        exit
+      } if name.nil?
+
+      target_directory = File.join(Dir.pwd, name)
+
+      Ruhoh::Friend.say { 
+        red "#{target_directory} already exists."
+        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}"
+      }
+    end
+    
+    # Public: Create a new theme scaffold with the given name.
+    def theme
+      name = @args[1]
+      Ruhoh::Friend.say { 
+        red "Please specify a theme name." 
+        cyan "ex: ruhoh new theme the-rain"
+        exit
+      } if name.nil?
+
+      target_directory = File.expand_path(File.join(Ruhoh.paths.theme, '..', name.gsub(/\s/, '-').downcase))
+      
+      if File.exist?(target_directory)
+        abort("Create new theme: \e[31mAborted!\e[0m") if ask("#{target_directory} already exists. Do you want to overwrite?", ['y', 'n']) == 'n'
+      end
+
+      FileUtils.mkdir target_directory unless File.exist?(target_directory)
+      FileUtils.cp_r "#{@paths.theme_template}/.", target_directory
+      
+      Ruhoh::Friend.say { 
+        green "New theme scaffold:"
+        green target_directory
+      }
+    end
+
+    # Public: Create a new layout file for the active theme.
+    def layout
+      name = @args[1]
+      Ruhoh::Friend.say { 
+        red "Please specify a layout name." 
+        cyan "ex: ruhoh new layout splash"
+        exit
+      } if name.nil?
+      
+      filename = File.join(Ruhoh.paths.layouts, name.gsub(/\s/, '-').downcase) + ".html"
+      if File.exist?(filename)
+        abort("Create new layout: aborted!") if ask("#{filename} already exists. Do you want to overwrite?", ['y', 'n']) == 'n'
+      end
+      
+      FileUtils.mkdir_p File.dirname(filename)
+      File.open(@paths.layout_template) do |template|
+        File.open(filename, 'w') do |page|
+          page.puts template.read
+        end
+      end
+      
+      Ruhoh::Friend.say {
+        green "New layout:"
+        plain Ruhoh.relative_path(filename)
+      }
+    end
+
+    # Public : List drafts
+    def drafts
+      self.list(:drafts)
+    end
+
+    # Public : List posts
+    def posts
+      self.list(:posts)
+    end
+
+    # Public : List pages
+    def pages
+      self.list(:pages)
+    end
+ 
+    # Internal: Outputs a list of the given data-type to the terminal.
+    def list(type)
+      Ruhoh::DB.update(type)
+      data = Ruhoh::DB.__send__(type)
+      data = data['dictionary'] if type == :posts
+
+      if @options.verbose
+        Ruhoh::Friend.say {
+          data.each_value do |p|
+            cyan("- #{p['id']}")
+            plain("  title: #{p['title']}") 
+            plain("  url: #{p['url']}")
+          end
+        }
+      else
+        Ruhoh::Friend.say {
+          data.each_value do |p|
+            cyan("- #{p['id']}")
+          end
+        }
+      end
+    end
+    
+    # Internal: Get the last active file based on data-type.
+    # Note File.ctime is the last time the file was changed as opposed to created.
+    # Returns: String file id, where id is the relative path to the file.
+    def last(type)
+      self.get_files(type).sort_by { |f| File.ctime(f) }.last || nil
+    end
+    
+    # Internal: Get an Array list of file ids based on the data-type.
+    # Returns: Array of file ids (ids are relative paths to the file.)
+    def get_files(type)
+      case type
+      when 'post'
+        Ruhoh::Parsers::Posts.files
+      when 'draft'
+        Ruhoh::Parsers::Drafts.files
+      when 'page'
+        Ruhoh::Parsers::Pages.files
+      else
+        Ruhoh::Friend.say { red  "Type: '#{type}' not supported." }
+        exit
+      end
+    end
+    
+    def ask(message, valid_options)
+      if valid_options
+        answer = get_stdin("#{message} #{valid_options.to_s.gsub(/"/, '').gsub(/, /,'/')} ") while !valid_options.include?(answer)
+      else
+        answer = get_stdin(message)
+      end
+      answer
+    end
+
+    def get_stdin(message)
+      print message
+      STDIN.gets.chomp
+    end
+    
+    
+  end #Client
+end #Ruhoh

data/lib/ruhoh/client/help.yml

@@ -0,0 +1,56 @@
+---
+description: |
+
+  Ruhoh is a nifty, modular static blog generator.
+  It is the Universal Static Blog API.
+  Visit http://www.ruhoh.com for complete usage and documentation.
+
+commands:
+  - 
+    "command" : "new <directory_path>"
+    "desc" : |
+      Create a new blog directory based on the Ruhoh specification.
+  -
+    "command" : "compile"
+    "desc" : |
+      Compile to static website.
+  -
+    "command" : "draft"
+    "desc" : |
+      Create a new draft.
+  -
+    "command" : "publish"
+    "desc" : |
+      Publish the last active draft file.
+  -
+    "command" : "unpublish"
+    "desc" : |
+      UnPublish the last active post file.
+  -
+    "command" : "page <path>"
+    "desc" : |
+      Create a new page at the given path.
+  -
+    "command" : "drafts"
+    "desc" : |
+      List all drafts.
+  -
+    "command" : "posts"
+    "desc" : |
+      List all posts.
+  -
+    "command" : "pages"
+    "desc" : |
+      List all pages.
+  -
+    "command" : "layout <name>"
+    "desc" : |
+      Create a new layout for the currently active theme.
+  -
+    "command" : "theme <name>"
+    "desc" : |
+      Create a new theme scaffold.
+  -
+    "command" : "help"
+    "desc" : |
+      Show this menu.

data/lib/ruhoh/compiler.rb

@@ -2,17 +2,19 @@ class Ruhoh
   
   class Compiler
     
-    def initialize(target_directory = './_compiled')
-      Ruhoh::DB.initialize
-      @target = target_directory
+    def initialize(target_directory)
+      Ruhoh::DB.update!
+      @target = target_directory || "./#{Ruhoh.folders.compiled}"
       @page = Ruhoh::Page.new
     end
     
     def compile
-      FileUtils.mkdir @target unless File.exist?(@target)
+      FileUtils.rm_r @target if File.exist?(@target)
+      FileUtils.mkdir @target
       self.theme
       self.pages
       self.media
+      self.syntax
     end
     
     def pages
@@ -21,38 +23,33 @@ class Ruhoh
       FileUtils.cd(@target) {
         Ruhoh::DB.posts['dictionary'].merge(Ruhoh::DB.pages).each_value do |p|
           @page.change(p['id'])
-          
+
           FileUtils.mkdir_p File.dirname(@page.compiled_path)
           File.open(@page.compiled_path, 'w') { |p| p.puts @page.render }
 
-          processed << path
+          processed << p
+          Ruhoh::Friend.say { green "processed: #{p['id']}" }
         end
       }
 
-      puts "=> Posts Processed:"
-      puts processed
     end
     
     def theme
-      FileUtils.mkdir_p File.join(@target, Ruhoh.config.asset_path)
+      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
       FileUtils.mkdir_p File.join(@target, Ruhoh.folders.media)
-      FileUtils.cp_r Ruhoh.paths.media, File.join(@target)
+      FileUtils.cp_r Ruhoh.paths.media, @target
     end
     
-    def write_data
-      File.open(Ruhoh.paths.database + '/posts_dictionary.yml', 'w') { |page|
-        page.puts Ruhoh::DB.posts.to_yaml
-      }
-  
-      File.open(Ruhoh.paths.database + '/pages_dictionary.yml', 'w') { |page|
-        page.puts Ruhoh::DB.pages.to_yaml
-      }
+    def 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
     end
-  
+    
   end #Compiler
   
 end #Ruhoh

data/lib/ruhoh/converters/converter.rb

@@ -4,14 +4,41 @@ class Ruhoh
 
   module Converter
     
+    MarkdownExtensions = ['.md', '.markdown']
+    TextileExtensions = ['.textile']
+    
     def self.convert(page)
-      if ['.md', '.markdown'].include? File.extname(page.data['id']).downcase
-        Maruku.new(page.content).to_html
+      self.__send__ self.which_converter(page.data['id']), page
+    end
+    
+    def self.which_converter(filename)
+      extension = File.extname(filename).downcase
+
+      if MarkdownExtensions.include? extension
+        :markdown
+      elsif TextileExtensions.include? extension
+        :textile
       else
-        page.content
+        :none
       end
     end
     
+    # Markdown
+    def self.markdown(page)
+      Maruku.new(page.content).to_html
+    end
+    
+    # Textile
+    # sample implementation
+    def self.textile(page)
+      'textile not supported yet =('
+    end
+    
+    # No converter
+    def self.none(page)
+      page.content
+    end
+    
   end #Converter
   
 end #Ruhoh