retter 0.0.0 → 0.0.1

data/README.md

@@ -0,0 +1,62 @@
+# RETTER (レッター) Lightweight diary workflow.
+
+コマンドラインで簡単に起動してブラウザですぐに確認できてデプロイがちょう楽そうな日記作成支援コマンドをつくる予定。
+
+## Installation
+
+*ruby-1.9.2* or later is required.
+
+~~~~
+  gem install retter
+~~~~
+
+## Usage
+
+To create new site, use `new` subcommand.
+
+~~~~
+  $ retter new my_sweet_diary
+~~~~
+
+You can use `retter` command anywhere, If you set `$RETTER_HOME` variable.
+
+~~~~
+  $ echo "export RETTER_HOME=/path/to/my_sweet_diary" >> ~/.bash_profile
+  $ . ~/.bash_profile
+~~~~
+
+`retter` command open `$EDITOR`. You can write an article with Markdown.
+The article will be draft.
+
+~~~~
+  $ cd /path/to/my_sweet_diary # You can skip this step if you already set $RETTER_HOME.
+  $ retter
+~~~~
+
+`preview` sub-command open the draft article by your default browser.
+
+~~~~
+  $ retter preview
+~~~~
+
+`bind` and `rebind` sub-command save the draft article.
+And generate actual web pages.
+
+~~~~
+  $ retter bind
+~~~~
+
+`open` sub-command open your web site by your default browser.
+
+~~~~
+  $ retter open
+~~~~
+
+You can use rack, if you needed.
+
+~~~~
+  $ cd /path/to/my_sweet_diary
+  $ bundle exec rackup
+~~~~
+
+

data/lib/generator/skel/Gemfile

@@ -2,4 +2,5 @@ source :rubygems
 
 gem 'rack'
 gem 'thin' # for heroku
+gem 'retter'
 

data/lib/retter/command.rb

@@ -12,7 +12,7 @@ class Retter::Command < Thor
   desc 'preview', 'Preview current entry'
   method_options date: :string
   def preview
-    preview = Retter::Stationery.previewer(detected_date, config)
+    preview = Retter::Stationery.previewer(config, detected_date)
 
     preview.print
     Launchy.open preview.file_path.to_s
@@ -42,9 +42,9 @@ class Retter::Command < Thor
 
   def detected_retter_file
     if options[:date]
-      config.retter_file(Date.parse(options[:date]), '.md')
+      config.retter_file(Date.parse(options[:date]))
     else
-      todays_file = config.retter_file(Date.today, '.md')
+      todays_file = config.retter_file(Date.today)
       todays_file.exist? ? todays_file : config.wip_file
     end
   end

data/lib/retter/config.rb

@@ -1,7 +1,28 @@
 # coding: utf-8
 
 class Retter::Config
-  [:editor, :retter_home, :title, :description, :url, :author].each do |att|
+  ATTRIBUTES =  [
+    :editor,
+    :title,
+    :description,
+    :url,
+    :author,
+    :retters_dir,
+    :wip_file,
+    :layouts_dir,
+    :layout_file,
+    :profile_layout_file,
+    :entry_layout_file,
+    :entries_layout_file,
+    :index_layout_file,
+    :entries_dir,
+    :profile_file,
+    :index_file,
+    :entries_file,
+    :feed_file
+  ]
+
+  ATTRIBUTES.each do |att|
     class_eval <<-EOM
       def #{att}(val = nil)
         val ? @options[:#{att}] = val : @options[:#{att}]
@@ -9,81 +30,53 @@ class Retter::Config
     EOM
   end
 
+  attr_reader :retter_home
+
   def initialize(env)
     @env, @options = env, {}
 
     detect_retter_home
     raise Retter::EnvError unless env.values_at('EDITOR', 'RETTER_HOME').all?
 
-    editor env['EDITOR']
-    retter_home Pathname.new(env['RETTER_HOME'])
-    url 'http://example.com'
+    @retter_home = Pathname.new(@env['RETTER_HOME'])
+    load_defaults
 
     retterfile = retter_home.join('Retterfile')
     instance_eval retterfile.read if retterfile.exist?
   end
 
-  def detect_retter_home
-    @env['RETTER_HOME'] = Dir.pwd if File.exist? 'Retterfile'
-  end
-
-  def retters_dir
-    retter_home.join 'retters/'
-  end
-
-  def wip_file
-    retters_dir.join 'today.md'
+  def load_defaults
+    editor              @env['EDITOR']
+    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')
+    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 retter_file(date, suf)
-    retters_dir.join(date ? date.strftime("%Y%m%d#{suf}") : "today#{suf}")
-  end
-
-  def layouts_dir
-    retter_home.join 'layouts/'
-  end
-
-  def layout_file
-    layouts_dir.join 'retter.html.haml'
-  end
-
-  def profile_layout_file
-    layouts_dir.join 'profile.html.haml'
-  end
-
-  def entry_layout_file
-    layouts_dir.join 'entry.html.haml'
-  end
-
-  def entries_layout_file
-    layouts_dir.join 'entries.html.haml'
-  end
-
-  def index_layout_file
-    layouts_dir.join 'index.html.haml'
+  def detect_retter_home
+    # TODO こういうの上のディレクトリも見て判断するのを何か参考にして書く
+    @env['RETTER_HOME'] = Dir.pwd if File.exist? 'Retterfile'
   end
 
-  def entries_dir
-    retter_home.join 'entries/'
+  def retter_file(date)
+    retters_dir.join(date ? date.strftime("%Y%m%d.md") : "today.md")
   end
 
   def entry_file(date)
     entries_dir.join date.strftime('%Y%m%d.html')
   end
 
-  def profile_file
-    retter_home.join 'profile.html'
-  end
-
-  def index_file
-    retter_home.join 'index.html'
-  end
-
-  def entries_file
-    retter_home.join 'entries.html'
-  end
-
-  def feed_file
-    retter_home.join 'entries.rss'
+  def self.delegatables
+    ATTRIBUTES + [:retter_file, :entry_file]
   end
 end

data/lib/retter/stationery/binder.rb

@@ -4,6 +4,10 @@ module Retter::Stationery
   class Binder
     attr_reader :config, :entries
 
+    extend Forwardable
+
+    def_delegators :@config, *Retter::Config.delegatables
+
     def initialize(config)
       @config = config
     end
@@ -12,30 +16,18 @@ module Retter::Stationery
       @view_scope ||= View::Scope.new(config, entries: entries)
     end
 
-    def renderer
-      Haml::Engine.new(config.layout_file.read, ugly: true)
-    end
-
-    def entries_renderer
-      Haml::Engine.new(config.entries_layout_file.read, ugly: true)
+    def layout_renderer
+      @layout_renderer ||= Haml::Engine.new(layout_file.read, ugly: true)
     end
 
     def entry_renderer
-      Haml::Engine.new(config.entry_layout_file.read, ugly: true)
-    end
-
-    def index_renderer
-      Haml::Engine.new(config.index_layout_file.read, ugly: true)
-    end
-
-    def profile_renderer
-      Haml::Engine.new(config.profile_layout_file.read, ugly: true)
+      @entry_renderer ||= Haml::Engine.new(entry_layout_file.read, ugly: true)
     end
 
     def rebind!
       commit_wip_file
 
-      @entries = Retter::Stationery.scan(config.retters_dir)
+      @entries = Retter::Stationery.scan(retters_dir)
 
       bind_entries
       print_index
@@ -44,10 +36,10 @@ module Retter::Stationery
     end
 
     def commit_wip_file
-      if config.wip_file.exist?
-        html = config.wip_file.read
-        config.retter_file(Date.today, '.md').open('a') {|f| f.puts html }
-        config.wip_file.unlink
+      if wip_file.exist?
+        html = wip_file.read
+        retter_file(Date.today).open('a') {|f| f.puts html }
+        wip_file.unlink
       end
     end
 
@@ -58,42 +50,42 @@ module Retter::Stationery
 
     def print_entry(entry)
       part = entry_renderer.render(view_scope, entry: entry)
-      html = renderer.render(view_scope, content: part)
+      html = layout_renderer.render(view_scope, content: part)
 
-      config.entry_file(entry.date).open('w') do |f|
+      entry_file(entry.date).open('w') do |f|
         f.puts View::Helper.fix_path(html, '../')
       end
     end
 
     def print_index
-      part = index_renderer.render(view_scope)
-      html = renderer.render(view_scope, content: part)
+      part = Haml::Engine.new(index_layout_file.read, ugly: true).render(view_scope)
+      html = layout_renderer.render(view_scope, content: part)
 
-      config.index_file.open('w') do |f|
+      index_file.open('w') do |f|
         f.puts  View::Helper.fix_path(html, './')
       end
     end
 
     def print_profile
-      part = profile_renderer.render(view_scope)
-      html = renderer.render(view_scope, content: part)
+      part = Haml::Engine.new(profile_layout_file.read, ugly: true).render(view_scope)
+      html = layout_renderer.render(view_scope, content: part)
 
-      config.profile_file.open('w') do |f|
+      profile_file.open('w') do |f|
         f.puts  View::Helper.fix_path(html, './')
       end
     end
 
     def print_toc
-      part = entries_renderer.render(view_scope)
-      html = renderer.render(view_scope, content: part)
+      part = Haml::Engine.new(entries_layout_file.read, ugly: true).render(view_scope)
+      html = layout_renderer.render(view_scope, content: part)
 
-      config.entries_file.open('w') do |f|
+      entries_file.open('w') do |f|
         f.puts  View::Helper.fix_path(html, './')
       end
     end
 
     def print_rss
-      config.feed_file.open('w') {|f| f.puts rss }
+      feed_file.open('w') {|f| f.puts rss }
     end
 
     def rss
@@ -103,11 +95,11 @@ module Retter::Stationery
                    :'xmlns:rdf'  => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
                    :'xmlns:dc'   => 'http://purl.org/dc/elements/1.1/',
                    :'xml:lang'   => 'ja' do
-        xml.channel :'rdf:about' => config.url do
-          xml.title config.title
-          xml.link config.url
+        xml.channel :'rdf:about' => url do
+          xml.title title
+          xml.link url
           xml.dc:date, entries.first.date
-          xml.description config.description
+          xml.description description
           xml.items { xml.rdf(:Seq) { entries.each {|e| xml.rdf:li, :'rdf:resource' => entry_url(e.date) } } }
         end
 
@@ -117,14 +109,14 @@ module Retter::Stationery
             xml.description { xml.cdata! entry.body }
             xml.dc:date, entry.date
             xml.link     entry_url(entry.date)
-            xml.author   config.author
+            xml.author   author
           end
         end
       end
     end
 
     def entry_url(date, id = nil)
-      (URI.parse(config.url) + date.strftime('/entries/%Y%m%d.html')).to_s
+      (URI.parse(url) + date.strftime('/entries/%Y%m%d.html')).to_s
     end
   end
 end

data/lib/retter/stationery/previewer.rb

@@ -4,7 +4,11 @@ module Retter::Stationery
   class Previewer
     attr_reader :config
 
-    def initialize(date, config)
+    extend Forwardable
+
+    def_delegators :@config, *Retter::Config.delegatables
+
+    def initialize(config, date)
       @config, @date = config, date
       @body, @entry  = *nil
 
@@ -17,11 +21,11 @@ module Retter::Stationery
     end
 
     def renderer
-      Haml::Engine.new(config.layout_file.read, ugly: true)
+      Haml::Engine.new(layout_file.read, ugly: true)
     end
 
     def entry_renderer
-      Haml::Engine.new(config.entry_layout_file.read, ugly: true)
+      Haml::Engine.new(entry_layout_file.read, ugly: true)
     end
 
     def print
@@ -42,17 +46,17 @@ module Retter::Stationery
     end
 
     def build_entry
-      @entry = Retter::Entry.new(date: @date, body: Retter::Stationery.parser.render(@body))
+      @entry = Retter::Entry.new(date: @date, body: Retter::Stationery.markupper.render(@body))
     end
 
     def load_retter_file
-      retter_file = config.retter_file(@date, '.md')
+      retter_file = retter_file(@date)
       @body = retter_file.exist? ? retter_file.read : ''
     end
 
     def load_wip_entry_if_needed
-      if @date == Date.today && config.wip_file.exist?
-        @body = [@body, config.wip_file.read].join("\n")
+      if @date == Date.today && wip_file.exist?
+        @body = [@body, wip_file.read].join("\n")
       end
     end
   end

data/lib/retter/stationery/view.rb

@@ -38,6 +38,9 @@ module Retter::Stationery::View
     attr_accessor :assigns
 
     include Helper
+    extend Forwardable
+
+    def_delegators :@config, *Retter::Config.delegatables
 
     [:entries].each do |meth|
       define_method meth do

data/lib/retter/stationery.rb

@@ -6,7 +6,7 @@ module Retter::Stationery
       entries = find_markup_files(path).map {|file|
         date = file.basename('.*').to_s
         mkup = File.open(file, &:read)
-        Retter::Entry.new date: Date.parse(date), body: parser.render(mkup)
+        Retter::Entry.new date: Date.parse(date), body: markupper.render(mkup)
       }
 
       entries.sort_by(&:date).reverse
@@ -17,8 +17,8 @@ module Retter::Stationery
       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 parser
-      @parser ||= ::Redcarpet::Markdown.new(
+    def markupper
+      @markupper ||= ::Redcarpet::Markdown.new(
         Renderer,
         autolink: true,
         space_after_headers: true,
@@ -30,8 +30,8 @@ module Retter::Stationery
       )
     end
 
-    def previewer(date, config)
-      Previewer.new date, config
+    def previewer(config, date)
+      Previewer.new config, date
     end
 
     def binder(config)

data/lib/retter/version.rb

@@ -1,3 +1,3 @@
 module Retter
-  VERSION = '0.0.0'
+  VERSION = '0.0.1'
 end

data/lib/retter.rb

@@ -18,8 +18,9 @@ require 'nokogiri'
 require 'launchy'
 require 'haml'
 require 'uri'
+require 'forwardable'
 require 'retter/version'
 require 'retter/entry'
-require 'retter/stationery'
 require 'retter/config'
+require 'retter/stationery'
 require 'retter/command'

data/spec/command/preview_spec.rb

@@ -6,7 +6,7 @@ describe 'Retter::Command#preview', clean: :all do
   let(:command) { Retter::Command.new }
   let(:preview) { retter_config.retter_home.join('.preview.html').read }
   let(:wip_file) { retter_config.wip_file }
-  let(:date_file) { retter_config.retter_file(Date.parse(date), '.md') }
+  let(:date_file) { retter_config.retter_file(Date.parse(date)) }
 
   before do
     command.stub!(:config) { retter_config }

data/spec/command/rebind_spec.rb

@@ -5,7 +5,7 @@ require File.dirname(__FILE__) + '/../spec_helper'
 describe 'Retter::Command#rebind', clean: :all do
   let(:command) { Retter::Command.new }
   let(:wip_file) { retter_config.wip_file }
-  let(:date_file) { retter_config.retter_file(Date.parse(date), '.md') }
+  let(:date_file) { retter_config.retter_file(Date.parse(date)) }
   let(:date_html) { retter_config.retter_home.join('entries', "#{date}.html") }
 
   before do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: retter
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-08 00:00:00.000000000Z
+date: 2011-09-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70260599810340 !ruby/object:Gem::Requirement
+  requirement: &70276239686360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70260599810340
+  version_requirements: *70276239686360
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &70260599899920 !ruby/object:Gem::Requirement
+  requirement: &70276239685920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70260599899920
+  version_requirements: *70276239685920
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70260599902380 !ruby/object:Gem::Requirement
+  requirement: &70276239685400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 2.0.0b3
   type: :runtime
   prerelease: false
-  version_requirements: *70260599902380
+  version_requirements: *70276239685400
 - !ruby/object:Gem::Dependency
   name: coderay
-  requirement: &70260599904040 !ruby/object:Gem::Requirement
+  requirement: &70276239684980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70260599904040
+  version_requirements: *70276239684980
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70260599913220 !ruby/object:Gem::Requirement
+  requirement: &70276239684520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70260599913220
+  version_requirements: *70276239684520
 - !ruby/object:Gem::Dependency
   name: launchy
-  requirement: &70260599914340 !ruby/object:Gem::Requirement
+  requirement: &70276239684100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70260599914340
+  version_requirements: *70276239684100
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &70260599913880 !ruby/object:Gem::Requirement
+  requirement: &70276239683680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70260599913880
+  version_requirements: *70276239683680
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70260599913440 !ruby/object:Gem::Requirement
+  requirement: &70276239683260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70260599913440
+  version_requirements: *70276239683260
 - !ruby/object:Gem::Dependency
   name: grit
-  requirement: &70260599912660 !ruby/object:Gem::Requirement
+  requirement: &70276239682820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70260599912660
+  version_requirements: *70276239682820
 - !ruby/object:Gem::Dependency
   name: ir_b
-  requirement: &70260599910020 !ruby/object:Gem::Requirement
+  requirement: &70276239675480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70260599910020
+  version_requirements: *70276239675480
 - !ruby/object:Gem::Dependency
   name: tapp
-  requirement: &70260599907780 !ruby/object:Gem::Requirement
+  requirement: &70276239674960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70260599907780
+  version_requirements: *70276239674960
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70260599907300 !ruby/object:Gem::Requirement
+  requirement: &70276239674540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,7 +142,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70260599907300
+  version_requirements: *70276239674540
 description: Lightweight diary workflow
 email:
 - celluloid.key@gmail.com
@@ -153,6 +153,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- README.md
 - Rakefile
 - bin/retter
 - lib/generator/newretter.rb