retter 0.1.2 → 0.1.3

data/README.md

@@ -14,12 +14,12 @@
 * CLIでの操作を前提としています
 * どこ（cwd）にいてもすぐに記事を編集できます（Markdown）
 * オフラインで簡単にプレビューできます
-* だいたいどんなサーバ上でも動作します（静的HTMLまたはRackアプリとして）
+* だいたいどんなサーバ上でも動作します（Heroku, GitHub Pages, Dropbox などで、静的HTMLまたはRackアプリとして）
 * RSSフィードを吐きます
-* トラックバック、**コメント**などの機能はありません
+* トラックバック、**コメント**などの機能は外部のサービスを使用できます
 * コールバックを設定することでさらに手数を減らすことができます
 
-## インストール - Installation
+# インストール - Installation
 
 *ruby-1.9.2* or later is required.
 
@@ -27,9 +27,9 @@
   gem install retter
 ~~~~
 
-## 使い方 - Usage
+# 使い方 - Usage
 
-### 新規サイト生成 - New site
+## 新規サイト生成 - New site
 
 `retter new`で新しいサイトのひな形を生成し、依存ライブラリをインストールし、gitリポジトリを初期化します。
 
@@ -39,9 +39,9 @@
 
 生成するファイルはHAMLテンプレート、設定ファイル、デフォルトのCSS、Rackアプリ用の設定などです。
 
-### 初期設定 - Settings
+## 初期設定 - Settings
 
-#### $EDITOR
+### $EDITOR
 
 **retter requires `$EDITOR` variable.**
 
@@ -53,7 +53,7 @@ Retterで記事を編集する際には任意のエディタが起動します
   $ . ~/.bash_profile
 ~~~~
 
-#### $RETTER_HOME
+### $RETTER_HOME
 
 ファイルシステム上のどこに居ても`retter`コマンドを使って編集から公開まで行えるよう、 事前に`$RETTER_HOME`環境変数を設定します。
 
@@ -66,7 +66,7 @@ You can use `retter` command anywhere, If you set `$RETTER_HOME` variable.
 
 作業ディレクトリにRetterfileがある場合は、そのディレクトリが`$RETTER_HOME`に指定されているものとして動作します。
 
-### 記事を書く - Write an entry
+## 記事を書く - Write an entry
 
 `retter`コマンドは設定されているエディタを起動します。今のところMarkdown形式で記事を書くことができます。
 
@@ -79,7 +79,7 @@ You can use `retter` command anywhere, If you set `$RETTER_HOME` variable.
 記事をひと通り書き終えたり確認したくなったら、エディタの機能で記事を保存して終了してください。
 保存された記事は、その段階ではまだ下書きの状態です。
 
-### プレビュー - Preview
+## プレビュー - Preview
 
 下書きの記事を確認するには`preview`サブコマンドを使います（デフォルトブラウザが起動します）。
 
@@ -93,7 +93,7 @@ You can use `retter` command anywhere, If you set `$RETTER_HOME` variable.
 満足のいく文章が出来上がるまで編集とプレビューを繰り返しましょう。
 
 
-### 記事の生成 - Bind
+## 記事の生成 - Bind
 
 下書きが完成したら、記事をそのサイトのページとして生成します。
 `bind`, `rebind` は下書きの記事をその日の記事として保存し、すべてのHTMLを再生成します。
@@ -104,7 +104,7 @@ You can use `retter` command anywhere, If you set `$RETTER_HOME` variable.
   $ retter bind
 ~~~~
 
-### サイト全体の確認 - Browse Offline
+## サイト全体の確認 - Browse Offline
 
 生成されるすべてのページは静的HTMLですから、オフラインでも自分のマシンで全体的な見栄えを確認できます。
 `open`サブコマンドはデフォルトブラウザを起動してサイトのトップページを開きます。
@@ -122,13 +122,13 @@ You can use `retter` command anywhere, If you set `$RETTER_HOME` variable.
   (retter) bundle exec rackup
 ~~~~
 
-### 記事の公開 - Publish
+## 記事の公開 - Publish
 
 記事をインターネット上に公開するには、必要なすべてのファイルを git リポジトリにコミットしリモートサーバに push、または単純にファイルをアップロードします。
 
 To publish, use the git command. Or, upload the file to your server.
 
-#### Basic flow
+### Basic flow
 
 最も原始的な方法は、gitコマンドを直接使う方法です。
 
@@ -139,7 +139,7 @@ To publish, use the git command. Or, upload the file to your server.
   $ git push [remote] [branch]     # heroku, github pages, etc..
 ~~~~
 
-#### Using shortcut commands
+### Using shortcut commands
 
 いくつかのショートカットを使い、コミットメッセージを書くことを省略したりすることができます。
 
@@ -151,7 +151,7 @@ To publish, use the git command. Or, upload the file to your server.
 
 後述するコールバックを設定しておくことで、さらに手数を減らすことも可能です。
 
-### 特定の日付の記事を編集する - Edit entry (specific date).
+## 特定の日付の記事を編集する - Edit entry (specific date).
 
 昨日、明日、過去や未来の日付を指定して記事を編集・プレビューするには、 `--date` オプションを用います。
 
@@ -185,7 +185,7 @@ To publish, use the git command. Or, upload the file to your server.
   retter edit 3.years.ago  # 3年前
 ~~~~
 
-### 特定のファイルを編集する - Edit entry (specific file).
+## 特定のファイルを編集する - Edit entry (specific file).
 
 記事の編集・プレビューにはファイル名での指定も可能です。
 
@@ -195,7 +195,7 @@ To publish, use the git command. Or, upload the file to your server.
   retter preview 20110101.md
 ~~~~
 
-### 記事の一覧を出力する - Browse entries
+## 記事の一覧を出力する - Browse entries
 
 これまでに書いた記事の一覧を出力することができます。すべての一覧を出力するため、`less`や`lv`、`grep`などで適宜フィルタしてください。
 
@@ -221,20 +221,20 @@ To publish, use the git command. Or, upload the file to your server.
   retter preview e3
 ~~~~
 
-### コールバック - Callbacks
+## コールバック - Callbacks
 
 コールバックはいくつかのサブコマンド（edit bind rebind commit）の実行直後に自動的に実行されます。
 コールバックを定義しておくことで、手数の多い割に代わり映えのしない作業を自動化することができます。
 
 Callback is enabled in `edit`, `bind`, `rebind` and `commit` sub-command.
 
-#### Syntax
+### Syntax
 
 ~~~~ruby
   after [command], [invoke command or proc]
 ~~~~
 
-#### HTMLの生成時、デプロイまでの作業を自動化する - Auto deploying
+### HTMLの生成時、デプロイまでの作業を自動化する - Auto deploying
 
 以下のような内容を Retterfile に記述しておくことで、rebind または bind が実行されると即座に公開までの処理も実行されます。
 
@@ -254,7 +254,7 @@ In Retterfile:
 
 `--silent` option skip the callback.
 
-#### エディタを終了したとき即座にプレビューする - Auto preview
+### エディタを終了したとき即座にプレビューする - Auto preview
 
 記事を編集しエディタを終了したあとブラウザでプレビューしたい場合は、`edit`へのコールバックを設定できます。
 
@@ -266,7 +266,7 @@ In Retterfile:
 
 もしもコールバックを毎回実行したくない場合、`--silent`を指定する以外に、上記のように確認プロンプトを表示させるという方法もあります。
 
-#### コールバック呼出し
+### コールバック呼出し
 
 コマンド実行後にコールバックだけを再度実行したい場面では、`callback`サブコマンドを使用できます。
 
@@ -274,12 +274,40 @@ In Retterfile:
   $ retter callback --after edit
 ~~~~
 
-### 組込みテーマ - Pre-installed themes
+## コメントシステム（DISQUS）の導入 - Install DISQUS
+
+
+### Prepare
+
+1. Create DISQUS Account
+2. Add new site for retter
+
+### Install
+
+First, Add your `disqus_shortname` to Retterfile.
+
+in Retterfile
+
+~~~~ruby
+disqus_shortname 'your_disqus_shortname'
+~~~~
+
+Second, Edit templete and paste `render_disqus_comment_form`.
+
+in layouts/article.html.haml
+
+~~~~haml
+-# abbrev
+#comments= render_disqus_comment_form
+-# abbrev
+~~~~
+
+## 組込みテーマ - Pre-installed themes
 
 スタイルシートを変更することでテーマを変更できます。HTMLのヘッダを変更するには `layouts/retter.html.haml` を編集します。
 スタイルシートの指定を変更し、`retter rebind`コマンドを実行するとすべてのページが更新されます。
 
-#### Default
+### Default
 
 ~~~~haml
     %link{href: '/stylesheets/default.css', media: 'screen', rel: 'stylesheet', type: 'text/css'}
@@ -287,7 +315,7 @@ In Retterfile:
 
 ![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'}
@@ -295,7 +323,7 @@ In Retterfile:
 
 ![Orange](http://hibariya.github.com/images/theme_samples/retter_orange.jpg)
 
-### HTMLの修正 - HTML Layout
+## HTMLの修正 - HTML Layout
 
 HTMLのレイアウト自体を変更するには`layouts/`ディレクトリ以下のHAMLファイルを修正します。
 これらのファイルを変更したとしても、`retter rebind`コマンドを実行するまでは反映されません。
@@ -315,7 +343,7 @@ layouts
 `article.html.haml`を変更することで個々の記事のレイアウトを変更することができます。
 その他のファイルは実際のURLと名前が対応しています。
 
-## LICENSE
+# LICENSE
 
 The MIT License
 

data/lib/retter/config.rb

@@ -25,6 +25,8 @@ module Retter
       :index_file,
       :entries_file,
       :feed_file
+    ] + [ # extras
+      :disqus_shortname
     ]
 
     ATTRIBUTES.each do |att|

data/lib/retter/generator/skel/stylesheets/orange.css

@@ -90,15 +90,15 @@ article {
   position: relative;
 }
 
-article ul li{	
+article ul li {
 	list-style-image: url("../images/orange/ic_li01.gif");
 }
 
-article p a{
+article p a {
   color: #F30;
 }
 
-article p a:hover{
+article p a:hover {
   color: #F93;
 }
 
@@ -138,6 +138,19 @@ article ul#entries {
   width: 100%;
 }
 
+#comments {
+  color: #603;
+  border-radius: 10px;
+  border: 3px #FFC solid;
+  -moz-border-radius: 10px;
+  -webkit-border-radius: 10px;
+  padding: 1em 1.5em 1em 1.5em;
+  margin: 1em 0 1em 0;
+  width: 100%;
+  background-image: url("../images/orange/bg_entry.jpg");
+  position: relative;
+}
+
 pre {
   background: #EEE;
   color: rgb(0,30,67);

data/lib/retter/generator/skel/stylesheets/retter.css

@@ -92,6 +92,18 @@ article ul#entries {
   width 100%;
 }
 
+#comments {
+  background: rgb(228,239,192);
+  color: rgb(0,30,67);
+  border-radius: 20px;
+  border: 3px rgb(25,30,10) solid;
+  -moz-border-radius: 20px;
+  -webkit-border-radius: 20px;
+  padding: 1em 1.5em 1em 1.5em;
+  margin: 1em 0 1em 0;
+  width 100%;
+}
+
 pre {
   background: #EEE;
   color: rgb(0,30,67);

data/lib/retter/page/view_helper.rb

@@ -7,11 +7,9 @@ module Retter::Page
     def entry_path(*args)
       case args.first
       when Date, Time
-        date, id = *args
-        date.strftime('/entries/%Y%m%d.html') + (id ? "##{id}" : '')
+        entry_path_by_date(*args)
       when Retter::Entry
-        entry = args.first
-        entry_path(entry.date)
+        entry_path_by_entry(args.first)
       else
         raise TypeError, "wrong argument type #{args.first.class} (expected Date, Time or Retter::Entry)"
       end
@@ -20,14 +18,41 @@ module Retter::Page
     def article_path(*args)
       case args.first
       when Date, Time
-        date, id = *args
-        date.strftime("/entries/%Y%m%d/#{id}.html")
+        article_path_by_date_and_id(*args)
       when Retter::Entry::Article
-        article = args.first
-        article_path(article.entry.date, article.id)
+        article_path_by_article(args.first)
       else
         raise TypeError, "wrong argument type #{args.first.class} (expected Date, Time or Retter::Entry::Article)"
       end
     end
+
+    def render_disqus_comment_form(disqus_shortname = config.disqus_shortname)
+      Haml::Engine.new(<<-HAML).render
+#disqus_thread
+  :javascript
+    var disqus_shortname = '#{disqus_shortname}';
+    (function() {
+      var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
+      dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
+      (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
+    })();
+      HAML
+    end
+
+    def article_path_by_date_and_id(date, id)
+      date.strftime("/entries/%Y%m%d/#{id}.html")
+    end
+
+    def article_path_by_article(article)
+      article_path(article.entry.date, article.id)
+    end
+
+    def entry_path_by_date(date, id = nil)
+      date.strftime('/entries/%Y%m%d.html') + (id ? "##{id}" : '')
+    end
+
+    def entry_path_by_entry(entry)
+      entry_path(entry.date)
+    end
   end
 end

data/lib/retter/version.rb

@@ -1,3 +1,3 @@
 module Retter
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/retter.gemspec

@@ -15,19 +15,23 @@ Gem::Specification.new do |s|
   s.post_install_message = <<-EOM
     **Important** Some features were added or updated.
 
+    * DISQUS (comment system) support is now available.
+      First, Add your `disqus_shortname` to Retterfile.
+
+      in Retterfile:
+        disqus_shortname 'your_disqus_shortname'
+
+      Second, Edit templete and paste `render_disqus_comment_form`.
+
+      in layouts/article.html.haml:
+        #comments= render_disqus_comment_form
+
     * Filename is now specificable.
       Examples:
         $ retter edit today.md
         $ retter edit 20110101.md
         $ retter preview 20110101.md
 
-    * `--key` option is now available in edit (and preview).
-      Examples:
-        $ retter list
-        [e0] 2011-10-12  article3, article4
-        [e1] 2011-10-10  article1, article2
-        $ retter edit e0 # edit 2011-10-12 entry
-
     -- Thanks for flying Retter :-> --
   EOM
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: retter
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-08 00:00:00.000000000 Z
+date: 2011-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70149981954420 !ruby/object:Gem::Requirement
+  requirement: &70305075013900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 0.14.6
   type: :runtime
   prerelease: false
-  version_requirements: *70149981954420
+  version_requirements: *70305075013900
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &70149981950780 !ruby/object:Gem::Requirement
+  requirement: &70305075013280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70149981950780
+  version_requirements: *70305075013280
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70149981949060 !ruby/object:Gem::Requirement
+  requirement: &70305075012780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 2.0.0b3
   type: :runtime
   prerelease: false
-  version_requirements: *70149981949060
+  version_requirements: *70305075012780
 - !ruby/object:Gem::Dependency
   name: coderay
-  requirement: &70149981947840 !ruby/object:Gem::Requirement
+  requirement: &70305075012240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: 0.9.8
   type: :runtime
   prerelease: false
-  version_requirements: *70149981947840
+  version_requirements: *70305075012240
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70149981944640 !ruby/object:Gem::Requirement
+  requirement: &70305075011700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70149981944640
+  version_requirements: *70305075011700
 - !ruby/object:Gem::Dependency
   name: launchy
-  requirement: &70149981937400 !ruby/object:Gem::Requirement
+  requirement: &70305075011060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: 2.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *70149981937400
+  version_requirements: *70305075011060
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &70149981931400 !ruby/object:Gem::Requirement
+  requirement: &70305075010460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +88,10 @@ dependencies:
         version: 3.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *70149981931400
+  version_requirements: *70305075010460
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70149981930460 !ruby/object:Gem::Requirement
+  requirement: &70305075009600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70149981930460
+  version_requirements: *70305075009600
 - !ruby/object:Gem::Dependency
   name: grit
-  requirement: &70149981929240 !ruby/object:Gem::Requirement
+  requirement: &70305075007740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,10 +110,10 @@ dependencies:
         version: 2.4.1
   type: :runtime
   prerelease: false
-  version_requirements: *70149981929240
+  version_requirements: *70305075007740
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70149981927780 !ruby/object:Gem::Requirement
+  requirement: &70305075005360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -121,10 +121,10 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70149981927780
+  version_requirements: *70305075005360
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70149981924700 !ruby/object:Gem::Requirement
+  requirement: &70305075002780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -132,10 +132,10 @@ dependencies:
         version: 0.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *70149981924700
+  version_requirements: *70305075002780
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70149981923760 !ruby/object:Gem::Requirement
+  requirement: &70305075001560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -143,10 +143,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70149981923760
+  version_requirements: *70305075001560
 - !ruby/object:Gem::Dependency
   name: ir_b
-  requirement: &70149990284080 !ruby/object:Gem::Requirement
+  requirement: &70305075000220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -154,10 +154,10 @@ dependencies:
         version: 1.4.0
   type: :development
   prerelease: false
-  version_requirements: *70149990284080
+  version_requirements: *70305075000220
 - !ruby/object:Gem::Dependency
   name: tapp
-  requirement: &70149990281040 !ruby/object:Gem::Requirement
+  requirement: &70305074999360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -165,10 +165,10 @@ dependencies:
         version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *70149990281040
+  version_requirements: *70305074999360
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70149990279600 !ruby/object:Gem::Requirement
+  requirement: &70305074998600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -176,10 +176,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70149990279600
+  version_requirements: *70305074998600
 - !ruby/object:Gem::Dependency
   name: fuubar
-  requirement: &70149990278380 !ruby/object:Gem::Requirement
+  requirement: &70305074997140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -187,10 +187,10 @@ dependencies:
         version: 0.0.6
   type: :development
   prerelease: false
-  version_requirements: *70149990278380
+  version_requirements: *70305074997140
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70149990276400 !ruby/object:Gem::Requirement
+  requirement: &70305074995900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -198,7 +198,7 @@ dependencies:
         version: 0.5.3
   type: :development
   prerelease: false
-  version_requirements: *70149990276400
+  version_requirements: *70305074995900
 description: Flyweight diary workflow. ruby-1.9.2 or later is required.
 email:
 - celluloid.key@gmail.com
@@ -276,11 +276,12 @@ files:
 homepage: https://github.com/hibariya/retter
 licenses: []
 post_install_message: ! "    **Important** Some features were added or updated.\n\n
-  \   * Filename is now specificable.\n      Examples:\n        $ retter edit today.md\n
-  \       $ retter edit 20110101.md\n        $ retter preview 20110101.md\n\n    *
-  `--key` option is now available in edit (and preview).\n      Examples:\n        $
-  retter list\n        [e0] 2011-10-12  article3, article4\n        [e1] 2011-10-10
-  \ article1, article2\n        $ retter edit e0 # edit 2011-10-12 entry\n\n    --
+  \   * DISQUS (comment system) support is now available.\n      First, Add your `disqus_shortname`
+  to Retterfile.\n\n      in Retterfile:\n        disqus_shortname 'your_disqus_shortname'\n\n
+  \     Second, Edit templete and paste `render_disqus_comment_form`.\n\n      in
+  layouts/article.html.haml:\n        #comments= render_disqus_comment_form\n\n    *
+  Filename is now specificable.\n      Examples:\n        $ retter edit today.md\n
+  \       $ retter edit 20110101.md\n        $ retter preview 20110101.md\n\n    --
   Thanks for flying Retter :-> --\n"
 rdoc_options: []
 require_paths: