ruhoh 1.0 → 1.1

data/Gemfile

@@ -3,11 +3,11 @@ gemspec
 
 gem 'rack', "~> 1.4"
 gem 'directory_watcher', "~> 1.4"
-gem 'psych', "~> 1.3"
+gem 'psych', "~> 1.3", :platforms => [:ruby_18, :mingw_18]
 gem 'redcarpet', "~> 2.1"
 gem 'nokogiri', "~> 1.5"
 
 group :development do
-  gem 'rspec'
+  gem 'rspec', "~> 2.11"
   gem 'rake'
 end

data/README.md

@@ -3,6 +3,22 @@
 <http://ruhoh.com>
 
 ### Usage
+
 $ gem install ruhoh     
 $ ruhoh help
 
+### Platforms
+
+ruhoh is tested with ruby 1.9.2 on mac OSX Lion.
+ruhoh runs in production with ruby 1.9.2 on Ubuntu 10.04.4 LTS.
+
+ruby 1.8.7 will not be (consciously) supported unless enough users bother me about it.
+
+**Windows**
+
+ruhoh should run on Windows with a few considerations:
+
+If you run into trouble with YAML and psych see: https://github.com/ruhoh/ruhoh.rb/issues/54
+More help is available here: https://github.com/ruhoh/ruhoh.rb/issues/search?q=windows
+
+I can't easily test ruhoh on a Windows machine, so please consider contributing back to the community for running on Windows.

data/bin/ruhoh

@@ -8,7 +8,7 @@ require 'ruhoh/client/client'
 
 require 'optparse'
 
-Options = Struct.new(:title, :date, :ext, :verbose)
+Options = Struct.new(:title, :date, :ext, :hg, :verbose)
 options = Options.new
 
 opt_parser = OptionParser.new do |opts|
@@ -18,6 +18,10 @@ opt_parser = OptionParser.new do |opts|
     options.ext = ext
   end
   
+  opts.on("--hg", "Use mercurial (hg) instead of git for source control.") do
+    options.hg = true
+  end
+
   opts.on("-v", "--[no-]verbose", "Run verbosely. For pages, shows extra title, url meta-data.") do |v|
     options.verbose = v
   end

data/history.json

@@ -1,4 +1,23 @@
 [
+  {
+    "version" : "1.1",
+    "date" : "26.08.2012",
+    "changes" : [
+      "All urls are normalized to never have trailing slashes. Fixes unfound urls when user forgets to add trailing slash to permalink formats.",
+      "Default partials have been moved to the 'system' level; ruhoh gem. User may still override them at the blog/theme level.",
+      "Partial files may now have extensions but wil still be referenced by name excluding extension.",
+      "(Internal) All system level assets are namespaced into the 'system' folder.",
+      "Theme scaffolding has been removed from the command line tool. `ruhoh theme <name>`"
+    ],
+    "features" : [
+      "@MrWerewolf adds ability to use custom blog scaffold url. Supports mercurial(hg) repository endpoints.",
+      "Add IRB console for ruhoh environment: `ruhoh console` ",
+      "Add scaffolds for file generation: post, page, layout, etc. System level scaffolds may be overwritten by blog level files."
+    ],
+    "bugs" : [
+      "@MrWerewolf removes psych gem dependency for ruby 1.9+ users."
+    ]
+  },
   {
     "version" : "1.0",
     "date" : "22.08.2012",

data/lib/ruhoh/client/client.rb

@@ -1,14 +1,16 @@
 require 'ruhoh/compiler'
+require 'ruhoh/client/console_methods'
+require 'irb'
 
 class Ruhoh
+  
   class Client
     
     Paths = Struct.new(:page_template, :draft_template, :post_template, :layout_template, :theme_template)
-    BlogScaffold = 'git://github.com/ruhoh/blog.git'
+    DefaultBlogScaffold = 'git://github.com/ruhoh/blog.git'
     
     def initialize(data)
       @iterator = 0
-      self.setup_paths
       self.setup_options(data)
       
       cmd = (data[:args][0] == 'new') ? 'blog' : (data[:args][0] || 'help')
@@ -26,6 +28,14 @@ class Ruhoh
       self.__send__(cmd)
     end  
     
+    # Thanks rails! https://github.com/rails/rails/blob/master/railties/lib/rails/commands/console.rb
+    def console
+      ARGV.clear # IRB throws an error otherwise.
+      require 'pp'
+      IRB::ExtendCommandBundle.send :include, Ruhoh::ConsoleMethods
+      IRB.start
+    end
+    
     def setup_options(data)
       @args = data[:args]
       @options = data[:options]
@@ -33,15 +43,6 @@ class Ruhoh
       @options.ext = (@options.ext || 'md').gsub('.', '')
     end
     
-    def setup_paths
-      @paths = Paths.new
-      @paths.page_template    = File.join(Ruhoh::Root, "scaffolds", "page.html")
-      @paths.draft_template   = File.join(Ruhoh::Root, "scaffolds", "draft.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')
@@ -78,9 +79,10 @@ class Ruhoh
         @iterator += 1
       end while File.exist?(filename)
       
-      FileUtils.mkdir_p File.dirname(filename)
+      Ruhoh::DB.update(:scaffolds)
 
-      output = File.open(@paths.send("#{type}_template"), 'r:UTF-8') { |f| f.read }
+      FileUtils.mkdir_p File.dirname(filename)
+      output = Ruhoh::DB.scaffolds["#{type}.html"].to_s
       output = output.gsub('{{DATE}}', Ruhoh::Parsers::Posts.formatted_date(Time.now))
       File.open(filename, 'w:UTF-8') {|f| f.puts output }
       
@@ -105,12 +107,12 @@ class Ruhoh
       if File.exist?(filename)
         abort("Create new page: aborted!") if ask("#{filename} already exists. Do you want to overwrite?", ['y', 'n']) == 'n'
       end
-
+      
+      Ruhoh::DB.update(:scaffolds)
+      
       FileUtils.mkdir_p File.dirname(filename)
-      File.open(@paths.page_template, 'r:UTF-8') do |template|
-        File.open(filename, 'w:UTF-8') do |page|
-          page.puts template.read
-        end
+      File.open(filename, 'w:UTF-8') do |page|
+        page.puts Ruhoh::DB.scaffolds['page.html'].to_s
       end
       
       Ruhoh::Friend.say { 
@@ -140,6 +142,8 @@ class Ruhoh
     # Public: Create a new blog at the directory provided.
     def blog
       name = @args[1]
+      scaffold = @args.length > 2 ? @args[2] : DefaultBlogScaffold
+      useHg = @options.hg
       Ruhoh::Friend.say { 
         red "Please specify a directory path." 
         plain "  ex: ruhoh new the-blogist"
@@ -156,9 +160,16 @@ class Ruhoh
       
       Ruhoh::Friend.say { 
         plain "Trying this command:"
-        cyan "  git clone #{BlogScaffold} #{target_directory}"
 
-        if system('git', 'clone', BlogScaffold, target_directory)
+        if useHg
+          cyan "  hg clone #{scaffold} #{target_directory}"
+          success = system('hg', 'clone', scaffold, target_directory)
+        else
+          cyan "  git clone #{scaffold} #{target_directory}"
+          success = system('git', 'clone', scaffold, target_directory)
+        end
+
+        if success
           green "Success! Now do..."
           cyan "  cd #{target_directory}"
           cyan "  rackup -p9292"
@@ -170,30 +181,6 @@ class Ruhoh
       }
     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]
@@ -208,11 +195,11 @@ class Ruhoh
         abort("Create new layout: aborted!") if ask("#{filename} already exists. Do you want to overwrite?", ['y', 'n']) == 'n'
       end
       
+      Ruhoh::DB.update(:scaffolds)
+      
       FileUtils.mkdir_p File.dirname(filename)
-      File.open(@paths.layout_template) do |template|
-        File.open(filename, 'w:UTF-8') do |page|
-          page.puts template.read
-        end
+      File.open(filename, 'w:UTF-8') do |page|
+        page.puts Ruhoh::DB.scaffolds['layout.html'].to_s
       end
       
       Ruhoh::Friend.say {

data/lib/ruhoh/client/console_methods.rb

@@ -0,0 +1,9 @@
+class Ruhoh
+  module ConsoleMethods
+    def reload!
+      Ruhoh.setup
+      Ruhoh.setup_paths
+      Ruhoh.setup_urls
+    end
+  end
+end

data/lib/ruhoh/client/help.yml

@@ -50,10 +50,6 @@ commands:
     "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" : |

data/lib/ruhoh/config.rb

@@ -14,8 +14,8 @@ class Ruhoh
       :base_path
     )
 
-    def self.generate(path_to_config)
-      site_config = Ruhoh::Utils.parse_yaml_file(path_to_config)
+    def self.generate
+      site_config = Ruhoh::Utils.parse_yaml_file(Ruhoh.base, Ruhoh.names.config_data)
       unless site_config
         Ruhoh.log.error("Empty site_config.\nEnsure ./#{Ruhoh.names.config_data} exists and contains valid YAML")
         return false
@@ -42,6 +42,7 @@ class Ruhoh
       config.rss_limit = 20 if config.rss_limit.nil?
 
       config.posts_permalink = site_config['posts']['permalink'] rescue nil
+      config.posts_permalink ||= "/:categories/:year/:month/:day/:title.html"
       config.posts_layout = site_config['posts']['layout'] rescue nil
       config.posts_layout = 'post' if config.posts_layout.nil?
       excluded_posts = site_config['posts']['exclude'] rescue nil

data/lib/ruhoh/db.rb

@@ -9,44 +9,23 @@ require 'ruhoh/parsers/stylesheets'
 require 'ruhoh/parsers/javascripts'
 require 'ruhoh/parsers/payload'
 require 'ruhoh/parsers/site'
+require 'ruhoh/parsers/scaffolds'
 
 class Ruhoh
   # Public: Database class for interacting with "data" in Ruhoh.
   class DB
-    WhiteList = [:site, :posts, :pages, :routes, :layouts, :partials, :widgets, :theme_config, :stylesheets, :javascripts, :payload]
+    WhiteList = [:site, :posts, :pages, :routes, :layouts, :partials, :widgets, :theme_config, :stylesheets, :javascripts, :payload, :scaffolds]
 
     class << self
       self.__send__ :attr_reader, *WhiteList
 
       def update(name)
-        self.instance_variable_set("@#{name}", 
-          case name
-          when :site
-            Ruhoh::Parsers::Site.generate
-          when :routes
-            Ruhoh::Parsers::Routes.generate
-          when :posts
-            Ruhoh::Parsers::Posts.generate
-          when :pages
-            Ruhoh::Parsers::Pages.generate
-          when :layouts
-            Ruhoh::Parsers::Layouts.generate
-          when :partials
-            Ruhoh::Parsers::Partials.generate
-          when :widgets
-            Ruhoh::Parsers::Widgets.generate
-          when :theme_config
-            Ruhoh::Parsers::ThemeConfig.generate
-          when :stylesheets
-            Ruhoh::Parsers::Stylesheets.generate
-          when :javascripts
-            Ruhoh::Parsers::Javascripts.generate
-          when :payload
-            Ruhoh::Parsers::Payload.generate
-          else
-            raise "Data type: '#{name}' is not a valid data type."
-          end
+        camelized_name = name.to_s.split('_').map {|a| a.capitalize}.join
+        self.instance_variable_set("@#{name}",
+          Ruhoh::Parsers.const_get(camelized_name).generate
         )
+      rescue NameError
+        raise NameError, "Data type: '#{name}' is not a valid data type."
       end
       
       # Always regenerate a fresh payload since it

data/lib/ruhoh/page.rb

@@ -86,7 +86,7 @@ class Ruhoh
       self.ensure_id
       path = CGI.unescape(@data['url']).gsub(/^\//, '') #strip leading slash.
       path = "index.html" if path.empty?
-      path += 'index.html' unless path =~ /\.\w+$/
+      path += '/index.html' unless path =~ /\.\w+$/
       path
     end
     

data/lib/ruhoh/parsers/pages.rb

@@ -67,13 +67,11 @@ class Ruhoh
         url = name.split('/').map {|p| Ruhoh::Urls.to_url_slug(p) }.join('/')
         url = "#{url}#{ext}".gsub(/index.html$/, '')
         if page['permalink'] == 'pretty' || Ruhoh.config.pages_permalink == 'pretty'
-          url = url.gsub(/\.html$/, '/') 
+          url = url.gsub(/\.html$/, '')
         end
         
-        url = "#{Ruhoh.config.base_path}#{url}"
         url = '/' if url.empty?
-
-        url
+        Ruhoh::Urls.to_url(url)
       end
     
     end # Pages

data/lib/ruhoh/parsers/partials.rb

@@ -3,7 +3,11 @@ class Ruhoh
     module Partials
     
       def self.generate
-        self.global_partials.merge(self.theme_partials)
+        self.system_partials.merge(
+          self.global_partials
+        ).merge(
+          self.theme_partials
+        )
       end
       
       def self.theme_partials
@@ -13,6 +17,10 @@ class Ruhoh
       def self.global_partials
         self.process(Ruhoh.paths.partials)
       end
+
+      def self.system_partials
+        self.process(Ruhoh.paths.system_partials)
+      end
       
       def self.process(path)
         return {} unless File.exist?(path)
@@ -22,7 +30,8 @@ class Ruhoh
           Dir.glob("**/*").each { |filename|
             next if FileTest.directory?(filename)
             next if ['.'].include? filename[0]
-            File.open(filename, 'r:UTF-8') { |f| partials[filename] = f.read }
+            name = filename.chomp(File.extname(filename))
+            File.open(filename, 'r:UTF-8') { |f| partials[name] = f.read }
           }
         }
         partials

data/lib/ruhoh/parsers/payload.rb

@@ -26,7 +26,7 @@ class Ruhoh
       def self.determine_category_and_tag_urls
         return nil unless Ruhoh::DB.routes && Ruhoh::DB.posts
         categories_url = nil
-        ["#{Ruhoh.config.base_path}categories/", "#{Ruhoh.config.base_path}categories.html"].each { |url|
+        [Ruhoh::Urls.to_url("categories"), Ruhoh::Urls.to_url("categories.html")].each { |url|
           categories_url = url and break if Ruhoh::DB.routes.key?(url)
         }
         Ruhoh::DB.posts['categories'].each do |key, value|
@@ -34,7 +34,7 @@ class Ruhoh
         end
         
         tags_url = nil
-        ["#{Ruhoh.config.base_path}tags/", "#{Ruhoh.config.base_path}tags.html"].each { |url|
+        [Ruhoh::Urls.to_url("tags"), Ruhoh::Urls.to_url("tags.html")].each { |url|
           tags_url = url and break if Ruhoh::DB.routes.key?(url)
         }
         Ruhoh::DB.posts['tags'].each do |key, value|

data/lib/ruhoh/parsers/posts.rb

@@ -137,34 +137,31 @@ class Ruhoh
       def self.permalink(post)
         date = Date.parse(post['date'])
         title = Ruhoh::Urls.to_url_slug(post['title'])
-        format = post['permalink'] || Ruhoh.config.posts_permalink  || "/:categories/:year/:month/:day/:title.html"
+        format = post['permalink'] || Ruhoh.config.posts_permalink
 
-        # Use the literal permalink if it is a non-tokenized string.
-        unless format.include?(':')
+        if format.include?(':')
+          filename = File.basename(post['id'], File.extname(post['id']))
+          category = Array(post['categories'])[0]
+          category = category.split('/').map {|c| Ruhoh::Urls.to_url_slug(c) }.join('/') if category
+        
+          url = {
+            "year"       => date.strftime("%Y"),
+            "month"      => date.strftime("%m"),
+            "day"        => date.strftime("%d"),
+            "title"      => title,
+            "filename"   => filename,
+            "i_day"      => date.strftime("%d").to_i.to_s,
+            "i_month"    => date.strftime("%m").to_i.to_s,
+            "categories" => category || '',
+          }.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.
           url = format.gsub(/^\//, '').split('/').map {|p| CGI::escape(p) }.join('/')
-          return "#{Ruhoh.config.base_path}#{url}"
         end  
 
-        filename = File.basename(post['id'], File.extname(post['id']))
-        category = Array(post['categories'])[0]
-        category = category.split('/').map {|c| Ruhoh::Urls.to_url_slug(c) }.join('/') if category
-        
-        url = {
-          "year"       => date.strftime("%Y"),
-          "month"      => date.strftime("%m"),
-          "day"        => date.strftime("%d"),
-          "title"      => title,
-          "filename"   => filename,
-          "i_day"      => date.strftime("%d").to_i.to_s,
-          "i_month"    => date.strftime("%m").to_i.to_s,
-          "categories" => category || '',
-        }.inject(format) { |result, token|
-          result.gsub(/:#{Regexp.escape token.first}/, token.last)
-        }.gsub(/\/+/, "/")
-
-        url = url.gsub(/^\//, '') #prep for prepending the base_path
-        url = "#{Ruhoh.config.base_path}#{url}"
-        url
+        Ruhoh::Urls.to_url(url)
       end
     
       def self.build_chronology(ordered_posts)

data/lib/ruhoh/parsers/scaffolds.rb

@@ -0,0 +1,35 @@
+class Ruhoh
+  module Parsers
+    module Scaffolds
+    
+      def self.generate
+        self.system_scaffolds.merge(
+          self.scaffolds
+        )
+      end
+      
+      def self.scaffolds
+        self.process(Ruhoh.paths.scaffolds)
+      end
+
+      def self.system_scaffolds
+        self.process(Ruhoh.paths.system_scaffolds)
+      end
+      
+      def self.process(path)
+        return {} unless File.exist?(path)
+      
+        scaffolds = {}
+        FileUtils.cd(path) {
+          Dir.glob("**/*").each { |filename|
+            next if FileTest.directory?(filename)
+            next if ['.'].include? filename[0]
+            File.open(filename, 'r:UTF-8') { |f| scaffolds[filename] = f.read }
+          }
+        }
+        scaffolds
+      end
+    
+    end #Scaffolds
+  end #Parsers
+end #Ruhoh

data/lib/ruhoh/paths.rb

@@ -14,6 +14,7 @@ class Ruhoh
       :partials,
       :plugins,
       :posts,
+      :scaffolds,
       :site_data,
       :themes,
       :widgets,
@@ -27,8 +28,11 @@ class Ruhoh
       :theme_javascripts,
       :theme_stylesheets,
       :theme_widgets,
-    
+      
+      :system,
       :system_dashboard_file,
+      :system_scaffolds,
+      :system_partials,
       :system_widgets
     )
     
@@ -46,6 +50,7 @@ class Ruhoh
       paths.site_data           = File.join(Ruhoh.base, Ruhoh.names.site_data)
       paths.themes              = File.join(Ruhoh.base, Ruhoh.names.themes)
       paths.plugins             = File.join(Ruhoh.base, Ruhoh.names.plugins)
+      paths.scaffolds           = File.join(Ruhoh.base, Ruhoh.names.scaffolds)
       
       paths.theme               = File.join(Ruhoh.base, Ruhoh.names.themes, Ruhoh.config.theme)
       paths.theme_dashboard_file= File.join(paths.theme, Ruhoh.names.dashboard_file)
@@ -59,8 +64,11 @@ class Ruhoh
       
       return false unless self.theme_is_valid?(paths)
       
-      paths.system_dashboard_file = File.join(Ruhoh::Root, Ruhoh.names.dashboard_file)
-      paths.system_widgets      = File.join(Ruhoh::Root, Ruhoh.names.widgets)
+      paths.system                    = File.join(Ruhoh::Root, Ruhoh.names.system)
+      paths.system_dashboard_file     = File.join(paths.system, Ruhoh.names.dashboard_file)
+      paths.system_partials           = File.join(paths.system, Ruhoh.names.partials)
+      paths.system_scaffolds          = File.join(paths.system, Ruhoh.names.scaffolds)
+      paths.system_widgets            = File.join(paths.system, Ruhoh.names.widgets)
 
       paths
     end

data/lib/ruhoh/previewer.rb

@@ -14,8 +14,9 @@ class Ruhoh
 
     def call(env)
       return favicon if env['PATH_INFO'] == '/favicon.ico'
-      env['PATH_INFO'] += "/" unless (env['PATH_INFO'] =~ /\.\w+$/ || env['PATH_INFO'][-1] == "/")
-      return admin if env['PATH_INFO'] == "#{Ruhoh.urls.dashboard}/"
+      # Always remove trailing slash if sent unless it's the root page.
+      env['PATH_INFO'].gsub!(/\/$/, '') unless env['PATH_INFO'] == "/"
+      return admin if env['PATH_INFO'] == Ruhoh.urls.dashboard
       
       id = Ruhoh::DB.routes[env['PATH_INFO']]
       raise "Page id not found for url: #{env['PATH_INFO']}" unless id

data/lib/ruhoh/urls.rb

@@ -28,8 +28,12 @@ class Ruhoh
       urls
     end
 
+    # Ruhoh.config.base_path is assumed to be well-formed.
+    # Always remove trailing slash.
+    # Returns String - normalized url with prepended base_path
     def self.to_url(*args)
-      Ruhoh.config.base_path + args.join('/')
+      url = args.join('/').chomp('/').reverse.chomp('/').reverse
+      url = Ruhoh.config.base_path + url
     end
     
     def self.to_url_slug(title)

data/lib/ruhoh/version.rb

@@ -1,4 +1,4 @@
 class Ruhoh
-  Version = VERSION = '1.0'
+  Version = VERSION = '1.1'
   RuhohSpec = '1.0'
 end

data/lib/ruhoh.rb

@@ -47,8 +47,10 @@ class Ruhoh
     :plugins => 'plugins',
     :posts => 'posts',
     :javascripts => 'javascripts',
+    :scaffolds => 'scaffolds',
     :site_data => 'site.yml',
     :stylesheets => 'stylesheets',
+    :system => 'system',
     :themes => 'themes',
     :theme_config => 'theme.yml',
     :widgets => 'widgets',
@@ -63,7 +65,7 @@ class Ruhoh
     self.reset
     @log.log_file = opts[:log_file] if opts[:log_file]
     @base = opts[:source] if opts[:source]
-    @config = Ruhoh::Config.generate(@names.config_data)
+    @config = Ruhoh::Config.generate
     !!@config
   end