retter 0.1.0 → 0.1.1

data/.gitignore

@@ -4,6 +4,7 @@ Gemfile.lock
 pkg/*
 tmp/*
 .rvmrc
+.rbenv-version
 lib/generator/skel/.gitignore
 lib/generator/skel/.preview.html
 lib/generator/skel/retters/*.md

data/.travis.yml

@@ -1,2 +1,3 @@
 rvm:
   - '1.9.2-p290'
+  - '1.9.3-rc1'

data/README.md

@@ -66,7 +66,7 @@ You can use `retter` command anywhere, If you set `$RETTER_HOME` variable.
 
 作業ディレクトリにRetterfileがある場合は、そのディレクトリが`$RETTER_HOME`に指定されているものとして動作します。
 
-### 記事を書く - Write an article
+### 記事を書く - Write an entry
 
 `retter`コマンドは設定されているエディタを起動します。今のところMarkdown形式で記事を書くことができます。
 
@@ -151,15 +151,65 @@ To publish, use the git command. Or, upload the file to your server.
 
 後述するコールバックを設定しておくことで、さらに手数を減らすことも可能です。
 
-### 特定の日付の記事を編集する - Edit article (specific date).
+### 特定の日付の記事を編集する - Edit entry (specific date).
 
 昨日、明日、過去や未来の日付を指定して記事を編集・プレビューするには、 `--date` オプションを用います。
 
 `--date` option is available in `edit` `preview` sub-command.
 
 ~~~~
-  retter edit --date 20110101
-  retter preview --date 20110101
+  retter --date 20110101         # 編集
+  retter preview --date 20110101 # プレビュー
+~~~~
+
+サブコマンドを明示する場合は、日付の指定は引数のように指定することもできます（`--date`が不要になります）。
+
+~~~~
+  retter edit 20110101
+  retter preview 20110101
+~~~~
+
+日付は相対的に指定することができます。以下のような形式をサポートします。
+
+~~~~
+  retter edit yesterday    # 昨日
+  retter edit today        # 今日
+  retter edit tommorow     # 明日
+
+  retter edit '3 days ago' # 3日前
+  retter edit 3.days.ago   # 3日前
+  retter edit 3.days.since # 3日後
+  retter edit 1.week.ago   # 1週間前
+  retter edit 3.weeks.ago  # 3週間前
+  retter edit 3.months.ago # 3カ月前
+  retter edit 3.years.ago  # 3年前
+~~~~
+
+### 記事の一覧を出力する - Browse entries
+
+これまでに書いた記事の一覧を出力することができます。すべての一覧を出力するため、`less`や`lv`、`grep`などで適宜フィルタしてください。
+
+~~~~
+  retter list
+  [e0] 2011-10-12
+    記事ごとにPermlinkがつくようにした, retter 0.1.0
+
+  [e1] 2011-10-10
+    Rubyのトップレベルについて整理する
+
+  [e2] 2011-10-03
+    モジュール関数がprivateな理由
+
+  [e3] 2011-09-19
+    スタイルシートを追加してテーマを変えられるようにした
+~~~~
+
+日付の左側に表示されている文字列は、編集やプレビューの際の記事の指定に使うことができます。
+
+~~~~
+  retter edit e3
+  retter preview e3
+  retter preview --key e3
 ~~~~
 
 ### コールバック - Callbacks

data/bin/retter

@@ -5,6 +5,8 @@ $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 
 require 'retter'
 
+Retter.load_config ENV
+
 case ARGV[0]
 when 'new'
   Retter::Generator::Creator.start ARGV[1..-1]

data/lib/retter/command.rb

@@ -1,47 +1,50 @@
 # coding: utf-8
 
 class Retter::Command < Thor
+  include Retter::Stationery
+
   map '-v' => :version,
       '-e' => :edit,
       '-p' => :preview,
       '-o' => :open,
       '-r' => :rebind,
-      '-b' => :bind,
-      '-h' => :home
+      '-b' => :bind
 
   desc 'edit', 'Open $EDITOR. Write an article with Markdown.'
-  method_options date: :string, silent: :boolean
-  def edit
-    system config.editor, detected_retter_file.to_s
+  method_options date: :string, key: :string, silent: :boolean
+  def edit(date_or_index = options[:date] || options[:key])
+    entry = entries.detect_by_string(date_or_index)
+
+    system config.editor, entry.path
 
-    invoke_after :edit unless options[:silent]
+    invoke_after :edit unless silent?
   end
 
   default_task :edit
 
   desc 'preview', 'Preview the draft article (browser will open).'
-  method_options date: :string
-  def preview
-    preview = Retter::Stationery.previewer(config, detected_date)
+  method_options date: :string, key: :string
+  def preview(date_or_index = options[:date] || options[:key])
+    entry = entries.detect_by_string(date_or_index)
 
-    preview.print
-    Launchy.open preview.file_path.to_s
+    preprint.print entry
+
+    Launchy.open preprint.path
   end
 
   desc 'open', 'Open your (static) site top page (browser will open).'
   def open
-    Launchy.open config.index_file.to_s
+    Launchy.open pages.index.path
   end
 
   desc 'rebind', 'Bind the draft article, re-generate all html pages.'
   method_options silent: :boolean
   def rebind
-    binder = Retter::Stationery.binder(config)
+    entries.commit_wip_entry!
 
-    binder.commit_wip_file
-    binder.rebind!
+    pages.bind!
 
-    unless options[:silent]
+    unless silent?
       invoke_after :bind
       invoke_after :rebind
     end
@@ -54,14 +57,21 @@ class Retter::Command < Thor
   desc 'commit', "cd $RETTER_HOME && git add . && git commit -m 'Retter commit'"
   method_options silent: :boolean
   def commit
-    working_dir = config.retter_home.to_s
-    git = Grit::Repo.new(working_dir)
-    Dir.chdir working_dir
+    repository.open do |git|
+      say git.add(config.retter_home), :green
+      say git.commit_all('Retter commit'), :green
+    end
 
-    say git.add(working_dir), :green
-    say git.commit_all('Retter commit'), :green
+    invoke_after :commit unless silent?
+  end
 
-    invoke_after :commit unless options[:silent]
+  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
 
   desc 'home', 'Open a new shell in $RETTER_HOME'
@@ -81,6 +91,9 @@ class Retter::Command < Thor
   desc 'new', 'Create a new site'
   def new; end
 
+  desc 'gen', 'Generate initial files'
+  def gen; end
+
   desc 'usage', 'Show usage.'
   def usage
     say Retter::Command.usage, :green
@@ -93,25 +106,8 @@ class Retter::Command < Thor
 
   private
 
-  def detected_retter_file
-    if options[:date]
-      config.retter_file(Date.parse(options[:date]))
-    else
-      todays_file = config.retter_file(Date.today)
-      todays_file.exist? ? todays_file : config.wip_file
-    end
-  end
-
-  def detected_date
-    options[:date] ? Date.parse(options[:date]) : Date.today
-  end
-
-  def config
-    @retter_config ||= Retter::Config.new(ENV)
-  rescue Retter::EnvError
-    say 'Set $RETTER_HOME and $EDITOR, first.', :red
-    say Retter::Command.usage, :green
-    exit 1
+  def silent?
+    !options[:silent].nil?
   end
 
   def invoke_after(name)

data/lib/retter/config.rb

@@ -1,102 +1,112 @@
 # coding: utf-8
 
-class Retter::Config
-  ATTRIBUTES = [
-    :editor,
-    :shell,
-    :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
-  ]
+module Retter
+  class EnvError < RuntimeError; end
 
-  ATTRIBUTES.each do |att|
-    class_eval <<-EOM
-      def #{att}(val = nil)
-        val ? @options[:#{att}] = val : @options[:#{att}]
-      end
-    EOM
-  end
+  class Config
+    ATTRIBUTES = [
+      :editor,
+      :shell,
+      :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
+    ]
 
-  attr_reader :retter_home
+    ATTRIBUTES.each do |att|
+      class_eval <<-EOM
+        def #{att}(val = nil)
+          val ? @options[:#{att}] = val : @options[:#{att}]
+        end
+      EOM
+    end
 
-  def initialize(env)
-    @env, @options = env, {}
-    @after_callbacks = {}
+    attr_reader :retter_home
 
-    detect_retter_home
-    raise Retter::EnvError unless env.values_at('EDITOR', 'RETTER_HOME').all?
+    def initialize(env)
+      @env, @options = env, {}
+      @after_callbacks = {}
 
-    @retter_home = Pathname.new(@env['RETTER_HOME'])
-    load_defaults
-    load_retterfile_if_exists
-  end
+      detect_retter_home
+      unless env.values_at('EDITOR', 'RETTER_HOME').all?
+        raise Retter::EnvError, 'Set $RETTER_HOME and $EDITOR, first.'
+      end
 
-  def load_defaults
-    editor              @env['EDITOR']
-    shell               @env['SHELL']
-    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')
-  end
+      @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
+        exit 1
+    end
 
-  def load_retterfile_if_exists
-    retterfile = retter_home.join('Retterfile')
-    instance_eval retterfile.read, retterfile.to_s if retterfile.exist?
-  end
+    def load_defaults
+      editor              @env['EDITOR']
+      shell               @env['SHELL']
+      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')
+    end
 
-  def detect_retter_home
-    # TODO こういうの上のディレクトリも見て判断するのを何か参考にして書く
-    @env['RETTER_HOME'] = Dir.pwd if File.exist? 'Retterfile'
-  end
+    def load_retterfile_if_exists
+      retterfile = retter_home.join('Retterfile')
+      instance_eval retterfile.read, retterfile.to_s if retterfile.exist?
+    end
 
-  def retter_file(date)
-    retters_dir.join(date ? date.strftime("%Y%m%d.md") : "today.md")
-  end
+    def detect_retter_home
+      # TODO こういうの上のディレクトリも見て判断するのを何か参考にして書く
+      @env['RETTER_HOME'] = Dir.pwd if File.exist? 'Retterfile'
+    end
 
-  def entry_file(date)
-    entries_dir.join date.strftime('%Y%m%d.html')
-  end
+    def retter_file(date)
+      retters_dir.join(date ? date.strftime("%Y%m%d.md") : "today.md")
+    end
 
-  def entry_dir(date)
-    entries_dir.join date.strftime('%Y%m%d')
-  end
+    def entry_file(date)
+      entries_dir.join date.strftime('%Y%m%d.html')
+    end
 
-  def self.delegatables
-    ATTRIBUTES + [:retter_file, :entry_file, :entry_dir]
-  end
+    def entry_dir(date)
+      entries_dir.join date.strftime('%Y%m%d')
+    end
 
-  def after(name, sym = nil, &block)
-    if callback = sym || block
-      @after_callbacks[name] = callback
-    else
-      @after_callbacks[name]
+    def self.delegatables
+      ATTRIBUTES + [:retter_file, :entry_file, :entry_dir]
+    end
+
+    def after(name, sym = nil, &block)
+      if callback = sym || block
+        @after_callbacks[name] = callback
+      else
+        @after_callbacks[name]
+      end
     end
   end
 end

data/lib/retter/entries.rb

@@ -0,0 +1,93 @@
+# coding: utf-8
+
+require 'active_support/core_ext/object'
+
+module Retter
+  class Entries < Array
+    include Retter::Stationery
+
+    def initialize
+      load_entries config.retters_dir
+    end
+
+    def detect_by_string(str)
+      case str
+      when nil, ''
+        detect_by_today or wip_entry
+      when /^e([0-9]+)$/
+        index = $1.to_i
+        self[index] or wip_entry
+      else
+        date = parse_date_string(str)
+        detect_by_date(date) || wip_entry(date)
+      end
+    end
+
+    def detect_by_today
+      detect_by_date(Date.today)
+    end
+
+    def detect_by_date(date)
+      detect {|e| e.date == date }
+    end
+
+    def parse_date_string(date_str)
+      case date_str
+      when /^yesterday$/i then 1.day.ago
+      when /^today$/i     then 0.day.ago
+      when /^tomorrow$/i  then 1.day.since
+      when /^[0-9]+[\.\s](?:days?|weeks?|months?|years?)[\.\s](?:ago|since)$/i
+        eval(date_str.gsub(/\s+/, '.')).to_date
+      else
+        Date.parse(date_str)
+      end
+    end
+
+    def wip_entry(date = nil)
+      wip_file = config.retter_file(date)
+      wip_date = date || Date.today
+      wip_body = wip_file.exist? ? wip_file.read : ''
+
+      Retter::Entry.new date: wip_date, body: markupper.render(wip_body), pathname: wip_file
+    end
+
+    def commit_wip_entry!
+      if config.wip_file.exist?
+        copy = config.wip_file.read
+        config.retter_file(Date.today).open('a') {|f| f.puts copy }
+        config.wip_file.unlink
+      end
+
+      Retter.reset_entries!
+    end
+
+    def load_entries(path)
+      date_files = find_markup_files(path).map {|file|
+        date_str = file.basename('.*').to_s
+        [Date.parse(date_str), file]
+      }.sort_by(&:first)
+
+      date_files.reverse_each {|date, file|
+        self << Retter::Entry.new(date: date, body: markupper.render(file.read))
+      }
+    end
+
+    def find_markup_files(path)
+      path = Pathname.new(path).realpath
+      Dir.open(path, &:to_a).grep(/^\d{4}(?:0[1-9]|1[012])(?:0[1-9]|[12][0-9]|3[01])\.(md)$/).map {|f| path.join f }
+    end
+
+    def markupper
+      @markupper ||= ::Redcarpet::Markdown.new(
+        Renderer,
+        autolink: true,
+        space_after_headers: true,
+        fenced_code_blocks: true,
+        strikethrough: true,
+        superscript: true,
+        fenced_code_blocks: true,
+        tables: true
+      )
+    end
+  end
+end

data/lib/retter/entry.rb

@@ -4,25 +4,67 @@ class Retter::Entry
   class Article
     attr_accessor :entry, :id, :title, :body
 
+    def initialize(attrs = {})
+      @id, @entry, @title, @body = attrs.values_at(:id, :entry, :title, :body)
+    end
+
     def to_s
       body
     end
+
+    def next
+      articles[index.next] || (entry.next && entry.next.articles.first)
+    end
+
+    def prev
+      index.pred < 0 ? (entry.prev && entry.prev.articles.last) : articles[index.pred]
+    end
+
+    def index
+      articles.index(self)
+    end
+
+    def articles
+      @articles ||= entry.articles
+    end
   end
 
+  include Retter::Stationery
+
   attr_accessor :date, :lede, :body, :articles
+  attr_reader :pathname
 
   def initialize(attrs={})
     @date, @body = attrs.values_at(:date, :body)
 
+    pathname_by_date = Retter.config.retters_dir.join(date.strftime('%Y%m%d.md'))
+    @pathname = attrs[:pathname] || pathname_by_date
+
     attach_titles
     extract_articles
     load_lede
   end
 
+  def path
+    pathname.to_s
+  end
+
   def to_s
     body
   end
 
+  def next
+    entries[index.next]
+  end
+
+  def prev
+    entries[index.pred] unless index.pred < 0
+  end
+
+  def index
+    entries.index(self) || 0
+  end
+
   private
 
   def body_elements
@@ -41,16 +83,11 @@ class Retter::Entry
   def extract_articles
     @articles = body_elements.search('body > *').each_with_object([]) {|c, r|
       if c.name == 'h1'
-        article = Article.new
-        article.entry = self
-        article.id = c.attr('id')
-        article.title = c.text
-        article.body  = ''
-        r << article
+        r << Article.new(entry: self, id: c.attr('id'), title: c.text, body: '')
       else
-        article  = r.last
-        next if article.nil?
+        next if r.empty?
 
+        article = r.last
         article.body += c.to_s
       end
     } || []
@@ -59,7 +96,7 @@ class Retter::Entry
   def load_lede
     @lede = body_elements.search('body > *').each_with_object('') {|c, r|
       break r if c.name == 'h1'
-      r<< c.to_s
+      r << c.to_s
     }
   end
 end

data/lib/retter/generator/skel/layouts/article.html.haml

@@ -1,6 +1,19 @@
-%article
+%article.autopagerize_page_element
   %h1.date
-    %a{href: entry_path(entry.date)}= entry.date.strftime('%Y/%m/%d')
+    %a{href: entry_path(entry)}= entry.date
+
   %h1{id: article.id}
-    %a{href: article_path(entry.date, article.id)}= article.title
+    %a{href: article_path(article)}= article.title
+
   = article
+
+.nav
+  .prev
+    - if prev_article = article.prev
+      %link{href: article_path(prev_article), rel: :prev}
+
+  .next
+    - if next_article = article.next
+      %link{href: article_path(next_article), rel: :next}
+
+.autopagerize_insert_before

data/lib/retter/generator/skel/layouts/entries.html.haml

@@ -2,8 +2,8 @@
   %ul#entries
     - entries.each do |entry|
       %li
-        %a.entry{href: entry_path(entry.date)}= entry.date.strftime('%Y/%m/%d')
+        %a.entry{href: entry_path(entry)}= entry.date
         %ul.titles
           - entry.articles.each do |article|
             %li
-              %a.title{href: article_path(entry.date, article.id)}= article.title
+              %a.title{href: article_path(article)}= article.title

data/lib/retter/generator/skel/layouts/entry.html.haml

@@ -1,9 +1,23 @@
-%article
+%article.autopagerize_page_element
   %h1.date
-    %a{href: entry_path(entry.date)}= entry.date.strftime('%Y/%m/%d')
+    %a{href: entry_path(entry)}= entry.date
+
   - unless entry.lede.empty?
     = entry.lede
+
   - entry.articles.each do |article|
     %h1{id: article.id}
-      %a{href: article_path(entry.date, article.id)}= article.title
+      %a{href: article_path(article)}= article.title
+
     = article
+
+.nav
+  .prev
+    - if prev_entry = entry.prev
+      %link{href: entry_path(prev_entry), rel: :prev}
+
+  .next
+    - if next_entry = entry.next
+      %link{href: entry_path(next_entry), rel: :next}
+
+.autopagerize_insert_before