retter 0.2.0 → 0.2.1

data/ChangeLog.md

@@ -0,0 +1,53 @@
+# 0.2.1
+
+## Features
+
+### Multiple template engine support.
+
+To change, remove existing template and create new template (e.g. retter.html.haml -> retter.html.erb).
+
+### Skipping page binding.
+
+You can skip following pages bind.
+
+* profile.html
+* entries.html
+* feed.rss
+
+If you want, add `allow_binding` configuration to Retterfile.
+
+```ruby
+# skip all pages
+allow_binding :none
+
+# allow only entries.html and feed.html
+allow_binding [:profile, :entries, :feed]
+```
+
+## Bugfix
+
+### Fix cache bugs.
+
+Retter creates cache directory if not exists.
+
+# 0.2.0
+
+## Features
+
+Pygments Support.
+
+Pygments syntax highlight is now available.
+To use, add a following line to Retterfile.
+
+```ruby
+renderer Retter::Renderers::PygmentsRenderer
+```
+
+## Improves
+
+* Improved boot overhead of all command.
+* Improved wait time for rebind (bind) command by cache.
+
+# 0.0.1
+
+It's first release.

data/README.md

@@ -203,14 +203,14 @@ In Retterfile:
   $ retter callback --after edit
 ~~~~
 
-## Install DISQUS (Comment tool)
+# Install DISQUS (Comment tool)
 
-### Prepare
+## Prepare
 
 1. Create DISQUS Account
 2. Add new site for retter
 
-### Install
+## Install
 
 First, Add your `disqus_shortname` to Retterfile.
 
@@ -239,12 +239,22 @@ To use, add a following line to Retterfile.
 renderer Retter::Renderers::PygmentsRenderer
 ```
 
-## Built-in themes
+# Remove caches
+
+When change the renderer, you have to remove cache files.
+Cache files is in `tmp/cache`.
+Please remove these files manually.
+
+```
+  $ rm -rf tmp/cache/*
+```
+
+# Built-in themes
 
 Retter has some themes.
 You can switch the theme by replacing stylesheet.
 
-### Default
+## Default
 
 ~~~~haml
     %link{href: '/stylesheets/default.css', media: 'screen', rel: 'stylesheet', type: 'text/css'}
@@ -252,7 +262,7 @@ You can switch the theme by replacing stylesheet.
 
 ![Default](http://hibariya.github.com/images/theme_samples/retter_default.jpg)
 
-### Orange
+## Orange
 
 ~~~~haml
     %link{href: '/stylesheets/orange.css', media: 'screen', rel: 'stylesheet', type: 'text/css'}
@@ -260,7 +270,7 @@ You can switch the theme by replacing stylesheet.
 
 ![Orange](http://hibariya.github.com/images/theme_samples/retter_orange.jpg)
 
-## HTML Layout
+# HTML Layout
 
 To customize layout, edit following files.
 
@@ -274,6 +284,28 @@ layouts
   `-- retter.html.haml  # Basic layout
 ~~~~
 
+# Skipping page binding
+
+You can skip following pages bind.
+
+* profile.html
+* entries.html
+* feed.rss
+
+If you want, add `allow_binding` configuration to Retterfile.
+
+```ruby
+# skip all pages
+allow_binding :none
+
+# allow only entries.html and feed.html
+allow_binding [:profile, :entries, :feed]
+```
+
+# Other template engines
+
+If you want change the template engine, remove existing template and create new template (e.g. retter.html.haml to retter.html.erb).
+
 # LICENSE
 
 The MIT License

data/bin/retter

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 
 require 'retter'
 
-Retter.load_config ENV
+Retter.load ENV
 
 case ARGV[0]
 when 'new'

data/lib/retter/command.rb

@@ -3,132 +3,140 @@
 require 'thor'
 require 'launchy'
 
-class Retter::Command < Thor
-  include Retter::Stationery
+module Retter
+  class Command < Thor
+    include Stationery
 
-  map '-v' => :version,
-      '-e' => :edit,
-      '-p' => :preview,
-      '-o' => :open,
-      '-r' => :rebind,
-      '-b' => :bind
+    map '-v' => :version,
+        '-e' => :edit,
+        '-p' => :preview,
+        '-o' => :open,
+        '-r' => :rebind,
+        '-b' => :bind
 
-  desc 'edit', 'Open $EDITOR. Write an article with Markdown.'
-  method_options date: :string, key: :string, silent: :boolean
-  def edit(identifier = options[:date] || options[:key])
-    entry = entries.detect_by_string(identifier)
+    desc 'edit', 'Open $EDITOR. Write an article with Markdown.'
+    method_options date: :string, key: :string, silent: :boolean
+    def edit(identifier = options[:date] || options[:key])
+      entry = entries.detect_by_string(identifier)
 
-    system "#{config.editor} #{entry.path}"
+      system config.editor, entry.path
 
-    invoke_after :edit unless silent?
-  end
+      invoke_after :edit unless silent?
+    end
 
-  default_task :edit
+    default_task :edit
 
-  desc 'preview', 'Preview the draft article (browser will open).'
-  method_options date: :string, key: :string
-  def preview(identifier = options[:date] || options[:key])
-    entry = entries.detect_by_string(identifier)
+    desc 'preview', 'Preview the draft article (browser will open).'
+    method_options date: :string, key: :string
+    def preview(identifier = options[:date] || options[:key])
+      preprint = Preprint.new
+      entry = entries.detect_by_string(identifier)
 
-    preprint.print entry
+      preprint.print entry
 
-    Launchy.open preprint.path
-  end
+      Launchy.open preprint.path
+    end
 
-  desc 'open', 'Open your (static) site top page (browser will open).'
-  def open
-    Launchy.open pages.index.path
-  end
+    desc 'open', 'Open your (static) site top page (browser will open).'
+    def open
+      index_page = Pages::Index.new
+
+      Launchy.open index_page.path
+    end
 
-  desc 'rebind', 'Bind the draft article, re-generate all html pages.'
-  method_options silent: :boolean
-  def rebind
-    entries.commit_wip_entry!
+    desc 'rebind', 'Bind the draft article, re-generate all html pages.'
+    method_options silent: :boolean
+    def rebind
+      entries.commit_wip_entry!
 
-    pages.bind!
+      pages.bind!
 
-    unless silent?
-      invoke_after :bind
-      invoke_after :rebind
+      unless silent?
+        invoke_after :bind
+        invoke_after :rebind
+      end
     end
-  end
 
-  desc 'bind', 'Alias of rebind'
-  method_options silent: :boolean
-  alias_method :bind, :rebind
+    desc 'bind', 'Alias of rebind'
+    method_options silent: :boolean
+    alias_method :bind, :rebind
 
-  desc 'commit', "cd $RETTER_HOME && git add . && git commit -m 'Retter commit'"
-  method_options silent: :boolean
-  def commit
-    repository.open do |git|
-      say git.add(config.retter_home), :green
-      say git.commit_all('Retter commit'), :green
-    end
+    desc 'commit', "cd $RETTER_HOME && git add . && git commit -m 'Retter commit'"
+    method_options silent: :boolean
+    def commit
+      Repository.open config.retter_home do |git|
+        say git.add(config.retter_home), :green
+        say git.commit_all('Retter commit'), :green
+      end
 
-    invoke_after :commit unless silent?
-  end
+      invoke_after :commit unless silent?
+    end
 
-  desc 'list', 'List retters'
-  def list
-    entries.each_with_index do |entry, n|
-      say "[e#{n}] #{entry.date}"
-      say "  #{entry.articles.map(&:title).join(', ')}"
-      say
+    desc 'list', 'List retters'
+    def list
+      entries.each_with_index do |entry, n|
+        say "[e#{n}] #{entry.date}"
+        say "  #{entry.articles.map(&:title).join(', ')}"
+        say
+      end
     end
-  end
 
-  desc 'home', 'Open a new shell in $RETTER_HOME'
-  def home
-    Dir.chdir config.retter_home.to_s
+    desc 'home', 'Open a new shell in $RETTER_HOME'
+    def home
+      Dir.chdir config.retter_home.to_path
 
-    system %(PS1="(retter) " #{config.shell})
-    say 'bye', :green
-  end
+      system config.shell
 
-  desc 'callback', 'Call a callback process only'
-  method_options after: :string
-  def callback
-    invoke_after options[:after].intern
-  end
+      say 'bye', :green
+    end
 
-  desc 'new', 'Create a new site'
-  def new; end
+    desc 'callback', 'Call a callback process only'
+    method_options after: :string
+    def callback
+      invoke_after options[:after].intern
+    end
 
-  desc 'gen', 'Generate initial files'
-  def gen; end
+    desc 'new', 'Create a new site'
+    def new; end
 
-  desc 'usage', 'Show usage.'
-  def usage
-    say Retter::Command.usage, :green
-  end
+    desc 'gen', 'Generate initial files'
+    def gen; end
 
-  desc 'version', 'Show version.'
-  def version
-    say "Retter version #{Retter::VERSION}"
-  end
+    desc 'usage', 'Show usage.'
+    def usage
+      say Command.usage, :green
+    end
 
-  private
+    desc 'version', 'Show version.'
+    def version
+      say "Retter version #{VERSION}"
+    end
 
-  def silent?
-    !options[:silent].nil?
-  end
+    private
 
-  def invoke_after(name)
-    callback = config.after(name)
-    return unless callback
-
-    case callback
-    when Proc
-      instance_eval &callback
-    when Symbol
-      invoke callback
-    else
-      raise ArgumentError
+    def pages
+      @pages ||= Pages.new
+    end
+
+    def silent?
+      !options[:silent].nil?
     end
-  end
 
-  def self.usage
-    <<-EOM
+    def invoke_after(name)
+      callback = config.after_callback(name)
+
+      case callback
+      when Proc
+        instance_eval &callback
+      when Symbol
+        invoke callback
+      else
+        # noop
+      end
+    end
+
+    def self.usage
+      <<-EOM
 Usage:
   # 1. Startup
   cd /path/to/dir
@@ -175,6 +183,7 @@ Usage:
   retter open    # Open your (static) site top page (browser will open).
 
   See also: https://github.com/hibariya/retter
-    EOM
+      EOM
+    end
   end
 end

data/lib/retter/config.rb

@@ -1,116 +1,94 @@
 # coding: utf-8
 
 require 'active_support/cache'
+require 'forwardable'
+require 'fileutils'
 
 module Retter
   class EnvError < RetterError; end
 
   class Config
-    ATTRIBUTES = [
-      :editor,
-      :shell,
-      :renderer,
-      :cache,
-      :title,
-      :description,
-      :url,
-      :author,
-      :retters_dir,
-      :wip_file,
-      :layouts_dir,
-      :layout_file,
-      :profile_layout_file,
-      :entry_layout_file,
-      :article_layout_file,
-      :entries_layout_file,
-      :index_layout_file,
-      :entries_dir,
-      :profile_file,
-      :index_file,
-      :entries_file,
-      :feed_file
-    ] + [ # extras
-      :disqus_shortname
-    ]
+    extend Forwardable
 
-    ATTRIBUTES.each do |att|
-      class_eval <<-EOM
-        def #{att}(val = nil)
-          val ? @options[:#{att}] = val : @options[:#{att}]
-        end
-      EOM
-    end
+    def_delegators Entries, :renderer, :retters_dir, :wip_file
+    def_delegators Pages,   :layouts_dir, :entries_dir, :allow_binding
 
     attr_reader :retter_home
 
     def initialize(env)
-      @env, @options = env, {}
+      @env             = env
       @after_callbacks = {}
+      @attributes      = {}
 
       detect_retter_home
-      unless env.values_at('EDITOR', 'RETTER_HOME').all?
-        raise Retter::EnvError, 'Set $RETTER_HOME and $EDITOR, first.'
-      end
+      environments_required
 
       @retter_home = Pathname.new(@env['RETTER_HOME'])
       load_defaults
       load_retterfile_if_exists
-    rescue Retter::EnvError
-      $stderr.puts 'Set $RETTER_HOME and $EDITOR, first.'
-      say Retter::Command.usage, :green
+    rescue EnvError => e
+      $stderr.puts e.message
+
+      say Command.usage, :green
 
       exit 1
     end
 
-    def load_defaults
-      editor              @env['EDITOR']
-      shell               @env['SHELL']
-      renderer            Retter::Renderers::CodeRayRenderer
-      cache               ActiveSupport::Cache::FileStore.new(retter_home.join('tmp/cache').to_s)
-      url                 'http://example.com'
-      retters_dir         retter_home.join('retters/')
-      wip_file            retters_dir.join('today.md')
-      layouts_dir         retter_home.join('layouts/')
-      layout_file         layouts_dir.join('retter.html.haml')
-      profile_layout_file layouts_dir.join('profile.html.haml')
-      entry_layout_file   layouts_dir.join('entry.html.haml')
-      article_layout_file layouts_dir.join('article.html.haml')
-      entries_layout_file layouts_dir.join('entries.html.haml')
-      index_layout_file   layouts_dir.join('index.html.haml')
-      entries_dir         retter_home.join('entries/')
-      profile_file        retter_home.join('profile.html')
-      index_file          retter_home.join('index.html')
-      entries_file        retter_home.join('entries.html')
-      feed_file           retter_home.join('entries.rss')
+    def after_callback(name, sym = nil, &block)
+      if callback = sym || block
+        @after_callbacks[name] = callback
+      else
+        @after_callbacks[name]
+      end
     end
 
-    def load_retterfile_if_exists
-      retterfile = retter_home.join('Retterfile')
-      instance_eval retterfile.read, retterfile.to_s if retterfile.exist?
+    alias_method :after, :after_callback
+
+    [ # base
+      :editor, :shell, :cache, :title, :description, :url, :author,
+      # extra
+      :disqus_shortname
+    ].each do |att|
+      class_eval <<-EOM
+        def #{att}(val = nil)
+          val ? @attributes[:#{att}] = val : @attributes[:#{att}]
+        end
+      EOM
     end
 
+    private
+
     def detect_retter_home
-      # TODO こういうの上のディレクトリも見て判断するのを何か参考にして書く
       @env['RETTER_HOME'] = Dir.pwd if File.exist? 'Retterfile'
     end
 
-    def retter_file(date)
-      retters_dir.join(date ? date.strftime("%Y%m%d.md") : "today.md")
-    end
+    def load_defaults
+      editor @env['EDITOR']
+      shell  @env['SHELL']
+      url    'http://example.com'
+
+      renderer    Retter::Renderers::CodeRayRenderer
+      retters_dir retter_home.join('retters/')
+      wip_file    retters_dir.join('today.md')
+
+      layouts_dir retter_home.join('layouts/')
+      entries_dir retter_home.join('entries/')
 
-    def entry_file(date)
-      entries_dir.join date.strftime('%Y%m%d.html')
+      cache_dir = retter_home.join('tmp/cache')
+      cache ActiveSupport::Cache::FileStore.new(cache_dir.to_path)
+
+      FileUtils.mkdir_p cache_dir.to_path unless cache_dir.directory? # for old versions
     end
 
-    def entry_dir(date)
-      entries_dir.join date.strftime('%Y%m%d')
+    def load_retterfile_if_exists
+      retterfile = retter_home.join('Retterfile')
+
+      instance_eval retterfile.read, retterfile.to_path if retterfile.exist?
     end
 
-    def after(name, sym = nil, &block)
-      if callback = sym || block
-        @after_callbacks[name] = callback
-      else
-        @after_callbacks[name]
+    def environments_required
+      unless @env.values_at('EDITOR', 'RETTER_HOME').all?
+        raise EnvError, 'Set $RETTER_HOME and $EDITOR, first.'
       end
     end
   end

data/lib/retter/configurable.rb

@@ -0,0 +1,26 @@
+# coding: utf-8
+
+module Retter
+  module Configurable
+    def configurable(*names)
+      names.each do |name|
+        define_configurable_method name
+        define_instance_shortcut_method name
+      end
+    end
+
+    def define_configurable_method(name)
+      instance_eval <<-EOM
+        def #{name}(val = nil)
+          val ? @#{name} = val : @#{name}
+        end
+      EOM
+    end
+
+    def define_instance_shortcut_method(name)
+      define_method name do
+        self.class.send(name)
+      end
+    end
+  end
+end