retter 0.2.5 → 1.0.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5a35a925b18fdede4441fe753ba47a06a576a78
+  data.tar.gz: 2ec0f7f3ce3143dfbe532264f328fac939f423e2
+SHA512:
+  metadata.gz: 505c3dae115d8c47f19f024a43cfddb2aa6bd24d743c5f5c1b9f5c49a778222ddbe4ddb08b1e760411eefe1f3c9f4c642b23776c95688fa71f1536eecc56416b
+  data.tar.gz: 9616fe4ee95045645f2550423c2f19e5d5e033ae8f01420551f6a053f8ddae4573302649ac18ec99e042f36989f0061025b62d3fca202a393aa8fa549f0ed676

data/.gitignore

@@ -1,15 +1,19 @@
 *.gem
+*.rbc
 .bundle
+.config
+.yardoc
+.rspec
 Gemfile.lock
-pkg/*
-tmp/*
-.rvmrc
-.rbenv-version
-lib/generator/skel/.gitignore
-lib/generator/skel/.preview.html
-lib/generator/skel/retters/*.md
-lib/generator/skel/entries.*
-lib/generator/skel/entries/*.html
-lib/generator/skel/vendor
-.DS_Store
+InstalledFiles
+_yardoc
 coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tags

data/.travis.yml

@@ -1,3 +1,5 @@
 rvm:
-  - '1.9.3-p194'
-before_install: gem install bundler --version=1.2.1
+  - '1.9.3'
+  - '2.0.0'
+  - '2.1.0'
+before_script: git version

data/ChangeLog.md

@@ -1,12 +1,18 @@
+# 1.0.0
+
+* Many API changes.
+* Directory structure is changed (See README.md).
+* Some commands are deprecated: `rebind`, `bind` and `open`.
+* Some commands are removed: `commit`, `home`, `usage` and `clean`.
+* Many command options are removed.
+* New commands are added: `build`, `preview` and `publish`.
+* Migration command `migrate` is added.
+
 # 0.2.3
 
 ## clean sub command
 
-clean sub command wraps cache clear method.
-
-```
-retter clean
-```
+`clean` sub command wraps cache clear method.
 
 # 0.2.2
 

data/Gemfile

@@ -1,3 +1,6 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec
+
+gem 'pry'
+gem 'fuubar'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 hibariya
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,317 +1,234 @@
-# RETTER - Flyweight diary workflow. [![Build Status](https://secure.travis-ci.org/hibariya/retter.png?branch=master)](http://travis-ci.org/hibariya/retter)
+# RETTER - A diary workflow for shell users. [![Build Status](https://drone.io/github.com/hibariya/retter/status.png)](https://drone.io/github.com/hibariya/retter/latest)
 
-手軽さを追求した記事作成ツール。
+## Required
 
-* CLIでの操作を前提としています
-* どこ（cwd）にいてもすぐに記事をMarkdownで編集できます
-* オフラインで簡単にプレビューできます
-* だいたいどこでも動作します（Heroku, GitHub Pages, Dropbox などで、静的HTMLまたはRackアプリとして）
-* RSSフィードを吐きます
-* トラックバック、**コメント**などの機能は外部のサービスを使う必要があります
-* コールバックを設定することでさらに手数を減らすことができます
+* Ruby-1.9.1 or later
+* $EDITOR variable
+* $BROWSER variable
 
-# Quick Start
+## Quick Start
 
-*ruby-1.9.2* or later is required.
-
-**Install:**
-
-~~~~
-  gem install retter
-~~~~
-
-**Generate a new site:**
-
-~~~~
-  $ retter new my_sweet_diary
-~~~~
-
-**Quick settings:**
-
-~~~~
-  $ export EDITOR=vim
-  $ export RETTER_HOME=`pwd`/my_sweet_diary
-~~~~
-
-**Writing article:**
-
-~~~~
-  $ retter
-~~~~
-
-`retter` opens `$EDITOR`. Write an article with Markdown.
-
-**Preview:**
-
-~~~~
-  $ retter preview
-~~~~
-
-`preview` opens the draft article by your default browser.
-
-**Generate HTML:**
-
-~~~~
-  $ retter rebind
-~~~~
-
-`bind` and `rebind` binds the draft article. And re-generates actual html web pages. All html pages will be overwritten.
-
-**Browse offline:**
-
-~~~~
-  $ retter open
-~~~~
+```
+  $ gem install retter
+  $ retter new my-diary       # Create a new site named `my-sweet-diary'.
+  $ cd my-diary
+  $ retter edit               # Write a first article w/ $EDITOR.
+  $ retter preview            # Open an article you write w/ $BROWSER.
+  $ retter build              # Generate static html files on publish branch (default: master).
+  $ git remote add origin git@github.com:USERNAME/USERNAME.github.io.git
+  $ git push origin master    # Publish static html files on GitHub pages.
+```
 
-`open` sub-command opens your (static) website by your default browser.
+## List, edit and preview
 
-**Show Articles list:**
+`retter list` lists all articles.
 
-~~~~
+```
   $ retter list
-  [e0] 2011-11-09
-    my sweet article title
-~~~~
-
-**Re-writing an article:**
-
-~~~~
-  $ retter edit e0
-  ... abbr ...
-  $ retter preview e0
-~~~~
-
-**How to Deploy**
-
-examle:
-
-~~~~
-  $ cd $RETTER_HOME
-  $ git add .
-  $ git commit -m 'Entry written'
-  $ git push [your_git_remote] master
-~~~~
-
-To publish, use the git command. Or, upload the file to your server.
+  [e0] 2014-01-11
+    First article
+    Second article
+  [e1] 2014-01-13
+    Third article
+```
 
-# Environment variables
+`retter edit [KEYWORD]` opens a source with $EDITOR.
 
-**Important**
+```
+  $ retter edit e1         # Editing source on 2014-01-13.
+  $ retter edit 2014-01-11 # Editing source on 2014-01-11.
+  $ retter edit            # Editing source on Date.today.
+```
 
-retter requires `$EDITOR` variable.
+### Edit and preview (with livereload)
 
-## $RETTER_HOME
+To preview, run `retter preview`.
 
-You can use `retter` command anywhere, If you set `$RETTER_HOME` variable.
+```
+  $ retter edit # Edit and save
+  $ retter preview # Invoke preview server and open last edited article with $BROWSER.
+```
 
-~~~~
-  $ echo "export RETTER_HOME=/path/to/my_sweet_diary" >> ~/.bash_profile
-  $ . ~/.bash_profile
-~~~~
+`retter preview` detects file updates automatically.
 
-You have to cd to the directory, If you don't set `$RETTER_HOME` variable.
+In other shell:
 
-~~~~
-  $ cd path/to/my_sweet_diary
-  $ retter
-~~~~
+```
+  $ retter edit # Edit and save
+                # And $BROWSER will reload automatically.
+```
 
-# Using shortcuts
+## $RETTER_ROOT variable
 
-~~~~
-  $ retter commit # Shortcut of `git add . ; git commit -m 'Retter commit'`
-  $ retter home   # Open a new shell at $RETTER_HOME
-  (retter) git push [remote] [branch] # heroku, github pages, etc..
-~~~~
+You can use all retter commands everywhere if you set `$RETTER_ROOT` variable.
+So, if `$RETTER_ROOT` is set, `retter edit` and `cd $RETTER_ROOT && retter edit` are same.
 
-# Command options
+**`$RETTER_HOME` variable is deprecated.** Please use `$RETTER_ROOT`.
 
-Date is specify-able in `edit` `preview` sub-command.
+## Configure with $RETTER_ROOT/Retterfile
 
-~~~~
-  $ retter edit 20110101    # edit
-  $ retter preview 20110101 # preview
-~~~~
+Retterfile is the configuration file for your site.
 
-Relative date is available too.
+Default configuration is below:
 
-~~~~
-  $ retter edit yesterday
-  $ retter edit today
-  $ retter edit tommorow
+```ruby
+  configure api_revision: 1 do |config|
+    # Website's root URL, title, description and author. URL is needed by feed generator.
+    config.url         = 'http://retter.example.com/'
+    config.title       = 'my-diary'
+    config.description = 'my first diary'
+    config.author      = 'hibariya'
+
+    # Processing for `retter publish` command.
+    config.publisher do
+      # Uncomment it if you want to do `cd $RETTER_ROOT && git push origin master` via `retter publish`.
+      # run 'git push origin master'
+    end
+  end
+```
 
-  $ retter edit '3 days ago'
-  $ retter edit 3.days.ago
-  $ retter edit 3.days.since
-  $ retter edit 1.week.ago
-  $ retter edit 3.weeks.ago
-  $ retter edit 3.months.ago
-  $ retter edit 3.years.ago
-~~~~
+### Hooks
 
-And file name.
+Hooks will be invoked after running commands.
 
-~~~~
-  $ retter edit today.md
-  $ retter edit 20110101.md
-  $ retter preview 20110101.md
-~~~~
+```ruby
+  # Print `Well done :)` after running `retter edit`.
+  config.after :edit do
+    puts 'Well done :)'
+  end
 
-# Callbacks
+  # Ask invoking `retter publish` after running `retter build`.
+  config.after :build do
+    invoke :publish if yes?('Publish now? [yes/no]')
+  end
+```
 
-Some command (edit bind rebind commit) will call callback if you defined callbacks.
+## Markdown structure
 
-In Retterfile:
+Following markdown file includes two articles.
 
-~~~~
-  after [command], [invoke command or proc]
-~~~~
+```
+# First article
 
-## Example1: Auto preview
+Hi, first article.
 
-In Retterfile:
+# Second article
 
-~~~~ruby
-  after :edit do
-    ident = ARGV.pop || 'today'
-    preview ident if yes?("Preview now? [yes/no]")
-  end
-~~~~
+Hi, second article.
+```
 
-## Example2: Auto deploying
+Header equal to h1 means start of an article. Like below:
 
-In Retterfile:
+```
++-- An Entry (A file) --+
+|+-- An article -------+|
+|| # First article     ||
+||                     ||
+|| Hi, first article.  ||
+|+---------------------+|
+|+-- An article -------+|
+|| # Second article    ||
+||                     ||
+|| Hi, second article. ||
+|+---------------------+|
++-----------------------+
+```
 
-~~~~ruby
-  after :rebind, :commit # git commit
+Each article have its own URL.
 
-  after :commit do       # deploy
-    system "cd #{config.retter_home}"
-    system 'git push origin master'
-  end
-~~~~
+## Directory structure
 
-## Skipping callback
+```
+$RETTER_ROOT
+  Retterfile
+  source
+    assets    # Asset files (stylesheets, javascripts, images and so on).
+    retters   # Article markdown files.
+    templates # Templates for static site.
+  tmp         # Temporary files (caches, etc).
+```
 
-`--silent` option skips those callback.
+## Extract source branch
 
-## Run callback
+You can move all files (except public files) to `source` branch.
 
-`callback` sub-command runs only callback proccess.
+Migration example is below:
 
-~~~~
-  $ retter callback --after edit
-~~~~
+```
+  $ cd $RETTER_ROOT
+  $ git checkout -b source
+  $ git rm -r assets entries *.{html,rss} # Removing public files from source branch
+  $ git commit -m 'Remove all public files'
+
+  $ git checkout master
+  $ git rm -r Retterfile source           # Removing source files from master branch
+  $ git commit -m 'Remove all source files'
+```
 
-# Install DISQUS (Comment tool)
+## Install DISQUS (Comment service)
 
-## Prepare
+### Prepare
 
 1. Create DISQUS Account
 2. Add new site for retter
 
-## Install
+### 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
-~~~~
-
-# Code Highlight
-
-Pygments is available.
-To use, add a following line to Retterfile.
-
 ```ruby
-renderer Retter::Renderers::PygmentsRenderer
+config.disqus_shortname = 'your_disqus_shortname'
 ```
 
-# Remove caches
+Second, Edit templete and inject `= render_disqus_comment_form`.
 
-When change the renderer, you have to remove cache files.
+in source/templates/entries/articles/show.html.haml
 
+```haml
+-# snip
+#comments= render_disqus_comment_form
+-# snip
 ```
-  $ retter clean
-```
-
-# Built-in themes
-
-Retter has some themes.
-You can switch the theme by replacing stylesheet.
-
-## Default
-
-~~~~haml
-    %link{href: '/stylesheets/default.css', media: 'screen', rel: 'stylesheet', type: 'text/css'}
-~~~~
-
-![Default](http://hibariya.github.com/images/theme_samples/retter_default.jpg)
-
-## Orange
-
-~~~~haml
-    %link{href: '/stylesheets/orange.css', media: 'screen', rel: 'stylesheet', type: 'text/css'}
-~~~~
-
-![Orange](http://hibariya.github.com/images/theme_samples/retter_orange.jpg)
-
-# HTML Layout
 
-To customize layout, edit following files.
+## Migrate from Retter-0.2.5 or earlier
 
-~~~~
-layouts
-  |-- article.html.haml # Article page
-  |-- entries.html.haml # Entries list page
-  |-- entry.html.haml   # Entry (by day) page
-  |-- index.html.haml   # Front page
-  |-- profile.html.haml # Profile page
-  `-- retter.html.haml  # Basic layout
-~~~~
+They're incompatible with retter-1.0.0.
+Please migrate via `retter migrate`, or create new site.
 
-# Skipping page binding
+### Migrate command
 
-You can skip following pages bind.
+`retter migrate`  attempts to migrate to new version.
 
-* 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 [:entries, :feed]
+```
+  $ cd $RETTER_ROOT
+  $ retter migrate
+  $ git add -A
+  $ git add -u
+  $ git commit -m 'Migrated'
+  $ retter build
 ```
 
-# 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
+You probably get many warnings, and migration command can't fix it.
+Anyway, at least, it will be compatible.
 
-The MIT License
+### Migrate only articles (RECOMMENDED)
 
-Copyright (c) 2011 hibariya, uzura29
+If you can't migrate with `retter migrate`, you may want to migrate only articles. Like below.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+```
+  $ cd $RETTER_ROOT/../
+  $ mv [site-name] old-[site-name]
+  $ retter new [site-name]
+  $ mv old-[site-name]/retters/* [site-name]/source/retters/
+  $ # migrate git repository, and so on...
+```
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+## Contributing
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+1. Fork it ( https://github.com/hibariya/retter/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request