cheat 1.0.2 → 1.1.0

data/README

@@ -7,6 +7,23 @@ $ cheat sheets
 $ cheat cheat
 $ cheat recent
 
+To freshen your local cache, supply the --new edit.
+
+$ cheat sheets --new
+
+To edit a cheat sheet, use the --edit switch.
+
+$ cheat markaby --edit
+
+To add a cheat sheet, use the --add switch.
+
+$ cheat readme --add
+
+Special Thanks To:
+- Evan Weaver
+- Kevin Marsh
+- Jeremy Apthorp
+
 The Cheat Sheet Repository:
 - http://cheat.errtheblog.com/
 

data/lib/cheat.rb

@@ -1,5 +1,5 @@
 $:.unshift File.dirname(__FILE__)
-%w[rubygems fileutils net/http yaml open-uri wrap].each { |f| require f }
+%w[rubygems tempfile fileutils net/http yaml open-uri wrap].each { |f| require f }
 
 module Cheat
   extend self
@@ -11,34 +11,42 @@ module Cheat
   def sheets(args)
     args = args.dup
 
-    return puts("Looking for help?  Try http://cheat.errtheblog.com or `$ cheat cheat'") if args.empty?
+    puts "Looking for help?  Try http://cheat.errtheblog.com or `$ cheat cheat'" and return if args.empty?
 
-    if (i = args.index('--clear-cache') || i = args.index('--new'))
-      args.delete_at(i)
+    if args.delete('--clear-cache') || args.delete('--new')
       clear_cache
       return if args.empty?
     end
 
+    add(args.shift) and return if args.delete('--add')
+
+    if edit = args.delete('--edit')
+      clear_cache
+    end
+
     sheet = args.shift
 
     cache_file = "#{cache_dir}/#{sheet}.yml" if cache_dir
     FileUtils.mkdir(cache_dir) unless File.exists?(cache_dir) if cache_dir
 
-    host   = HOST + ':' + PORT.to_s + SUFFIX
-    uri    = "http://#{host}/y/"
+    uri  = "http://#{cheat_uri}/y/"
 
     if %w[sheets all recent].include? sheet
       uri = uri.sub('/y/', sheet == 'recent' ? '/yr/' : '/ya/')
       return open(uri) { |body| show(body.read) } 
     end
 
-    return show(File.read(cache_file)) if File.exists?(cache_file) rescue clear_cache if cache_file
+    return show(File.read(cache_file)) if File.exists?(cache_file) rescue clear_cache if cache_file 
 
     open(uri += sheet) do |body|
       sheet = body.read
-      File.open(cache_file, 'w') { |f| f.write(sheet) } if cache_file
-      show(sheet)
-    end
+      File.open(cache_file, 'w') { |f| f.write(sheet) } if cache_file && !edit
+      edit ? edit(sheet) : show(sheet)
+    end if sheet
+  end
+
+  def cheat_uri
+    "#{HOST}:#{PORT}#{SUFFIX}"
   end
 
   def show(sheet_yaml)
@@ -48,6 +56,55 @@ module Cheat
     puts '  ' + sheet.last.gsub("\r",'').gsub("\n", "\n  ").wrap(80)
   end
 
+  def edit(sheet_yaml)
+    sheet = YAML.load(sheet_yaml).to_a.first
+    sheet[-1] = sheet.last.gsub("\r", '')
+    body, title = write_to_tempfile(*sheet), sheet.first
+    return if body.strip == sheet.last.strip
+    res = post_sheet(title, body)
+    check_errors(res, title, body)
+  end
+
+  def add(title)
+    body = write_to_tempfile(title)
+    res = post_sheet(title, body, true)
+    check_errors(res, title, body)
+  end
+
+  def post_sheet(title, body, new = false)
+    uri = "http://#{cheat_uri}/w/"
+    uri += title unless new
+    Net::HTTP.post_form(URI.parse(uri), "sheet_title" => title, "sheet_body" => body.strip, "from_gem" => true)
+  end
+
+  def write_to_tempfile(title, body = nil)
+    # god dammit i hate tempfile, this is so messy but i think it's
+    # the only way.
+    tempfile = Tempfile.new(title + '.cheat')
+    tempfile.write(body) if body
+    tempfile.close
+    system "#{editor} #{tempfile.path}"
+    tempfile.open
+    body = tempfile.read
+    tempfile.close
+    body
+  end
+
+  def check_errors(result, title, text)
+    if result.body =~ /<p class="error">(.+?)<\/p>/m
+      puts $1.gsub(/\n/, '').gsub(/<.+?>/, '').squeeze(' ').wrap(80)
+      puts 
+      puts "Here's what you wrote, so it isn't lost in the void:" 
+      puts text
+    else
+      puts "Success!  Try it!", "$ cheat #{title} --new"
+    end
+  end
+
+  def editor
+    ENV['VISUAL'] || ENV['EDITOR'] || "vim" 
+  end
+
   def cache_dir
     PLATFORM =~ /win32/ ? win32_cache_dir : File.join(File.expand_path("~"), ".cheat")
   end

data/lib/site.rb

@@ -21,7 +21,7 @@
 #   Cheat Lake, a nearby resevoir
 #   Cheat Mountain, one of the highest mountains in the Alleghenies
 #
-%w[rubygems camping camping/db erb acts_as_versioned wrap].each { |f| require f }
+%w[rubygems camping camping/db erb open-uri acts_as_versioned wrap].each { |f| require f }
 require_gem 'camping', '>=1.4.152'
 
 Camping.goes :Cheat
@@ -73,8 +73,7 @@ module Cheat::Controllers
     def get
       @headers['Content-Type'] = 'text/plain'
 
-      fake = Class.new.send(:include, Cheat::Helpers).new
-      return { 'Recent Cheat Sheets' => fake.recent_sheets.map(&:title) }.to_yaml
+      return { 'Recent Cheat Sheets' => Sheet.find(:all, :order => 'created_at DESC', :limit => 15).map(&:title) }.to_yaml
     end
   end
 
@@ -106,16 +105,6 @@ module Cheat::Controllers
     end
   end
   
-  class Revert < R '/r/(\w+)/(\d+)'
-    def get(title, version)
-      current = Sheet.find_by_title(title) 
-      old     = current.find_version(version)
-      current.title, current.body = old.title, old.body
-      current.save
-      redirect "#{URL}/s/#{title}"
-    end
-  end
-
   class Edit < R '/e/(\w+)/(\d+)', '/e/(\w+)'
     def get(title, version = nil)
       @sheet = Sheet.find_by_title(title)
@@ -136,6 +125,10 @@ module Cheat::Controllers
   
       @error = input.sheet_body =~ /<a\s*href=/
 
+      unless input.from_gem
+        @error = true unless captcha_pass?(input.chunky, input.bacon)
+      end
+
       if !@error && @sheet.update_attributes(:title => input.sheet_title, 
                                              :body => input.sheet_body)
         redirect "#{URL}/s/#{@sheet.title}"
@@ -144,20 +137,33 @@ module Cheat::Controllers
         render title ? :edit : :add
       end
     end
+
+    def captcha_pass?(session, answer)
+      open("http://captchator.ruby-forum.com/captcha/check_answer/#{session}/#{answer}").read.to_i.nonzero? rescue false
+    end
   end
   
   class Browse < R '/b'
     def get
-      @sheets = Sheet.find(:all, :order => 'created_at DESC')
+      @sheets = Sheet.find(:all, :order => 'title ASC')
       render :browse
     end
   end
   
-  class Show < R '/s/(\w+)', '/s/(\w+)/(\d+)'
+  class Show < R '/s/(\w+)', '/s/(\w+)/(\d+)', '/s/(\w+\.txt)'
     def get(title, version = nil)
+      # fake respond_to
+      if title =~ /\.txt/ && title.sub!('.txt', '').size
+        text = true
+        @headers['Content-Type'] = 'text/plain'
+      end
+
       @sheet = Sheet.find_by_title(title)
       @sheet = @sheet.find_version(version) if version && @sheet    
-      if @sheet    
+
+      if @sheet && text
+        return @sheet.body
+      elsif @sheet 
         render :show
       else
         redirect "#{URL}/b/"
@@ -178,12 +184,11 @@ module Cheat::Views
     html {
       head {
         _style
-        link :href => FEED, :rel => "alternate", :title => "Recent Cheat Sheets", :type => "application/atom+xml"
+        link :href => FEED, :rel => "alternate", :title => "Recently Updated Cheat Sheets", :type => "application/atom+xml"
         title defined?(@page_title) ? "$ cheat #{@page_title}" : \
                 "$ command line ruby cheat sheets"
       }
       body {
-        #code "Hi this is defunkt.  I'm messing around right now (8-9pm pst).  Things will get normal soon.  thx."
         div.main {
           div.header { 
             h1 { logo_link 'cheat sheets.' } 
@@ -209,7 +214,6 @@ module Cheat::Views
   def show
     @page_title = @sheet.title
     @sheet_title = @sheet.title
-    #div.sheet { text h(sheet.body).gsub(/\n(\s+)/, '<br/>' + '&nbsp;' * '\1'.size).gsub(/\r/,'').gsub(/\n/,'<br/>') }
     pre.sheet { text h(sheet.body.wrap(80)) }
     div.version {
       text "Version "
@@ -227,10 +231,14 @@ module Cheat::Views
         a "history", :href => R(History, @sheet.title)
       end
       if @sheet.version != (current = current_sheet).version
+        text " | "
+        a "revert to", :href => R(Edit, @sheet.title, @sheet.version)
         text " | "        
-        a "revert to", :href => R(Revert, @sheet.title, @sheet.version)
-        text " | "        
-        a "current", :href => R(Show, @sheet.title, current.version)
+        a "current", :href => R(Show, @sheet.title)
+      end
+      if @sheet.version == current_sheet.version
+        text " | "
+        a "text", :href => R(Show, @sheet.title + '.txt')
       end
       text " )"
      }
@@ -284,7 +292,7 @@ module Cheat::Views
   end
   
   def _form
-    if (@error = @error)
+    if @error
       p.error {
         strong "HEY!  "
         text "Something is wrong!  You can't give your cheat sheet the same name 
@@ -300,10 +308,15 @@ module Cheat::Views
                 :type => 'text'
           small " [ no_spaces_alphanumeric_only ]"
         }
-      p {
-        text 'Cheat Sheet:'
-        br
-        textarea @sheet.body, :name => 'sheet_body', :cols => 80, :rows => 30
+        p {
+          text 'Cheat Sheet:'
+          br
+          textarea @sheet.body, :name => 'sheet_body', :cols => 80, :rows => 30
+          random = rand(10_000)
+          br
+          img :src => "http://captchator.ruby-forum.com/captcha/image/#{random}"
+          input :name => 'chunky', :type => 'hidden', :value => random
+          input :name => 'bacon', :size => 10, :type => 'text'
         }
       }
       p "Your cheat sheet will be editable (fixable) by anyone.  Each cheat 
@@ -324,7 +337,7 @@ module Cheat::Views
       text "."
     }
     p "Get started:"
-    code "$ sudo gem install cheat --source require.errtheblog.com"
+    code "$ sudo gem install cheat"
     br
     code "$ cheat strftime"
     p "A magnificent cheat sheet for Ruby's strftime method will be printed to 
@@ -357,12 +370,12 @@ module Cheat::Views
     xml.instruct!
     xml.feed "xmlns"=>"http://www.w3.org/2005/Atom" do
 
-      xml.title "Recent Cheat Sheets"
+      xml.title "Recently Updated Cheat Sheets"
       xml.id URL + '/'
       xml.link "rel" => "self", "href" => FEED
 
-      sheets = Cheat::Models::Sheet.find(:all, :order => 'created_at DESC', :limit => 30)
-      xml.updated sheets.first.created_at.xmlschema
+      sheets = Cheat::Models::Sheet.find(:all, :order => 'updated_at DESC', :limit => 20)
+      xml.updated sheets.first.updated_at.xmlschema
 
       sheets.each do |sheet|
         xml.entry do
@@ -372,6 +385,9 @@ module Cheat::Views
           xml.updated sheet.updated_at.xmlschema
           xml.link "rel" => "alternate", "href" => URL + '/s/' + sheet.title
           xml.summary "A cheat sheet about #{sheet.title}.  Run it: `$ cheat #{sheet.title}'"
+          xml.content 'type' => 'html' do 
+            xml.text! sheet.body.gsub("\n", '<br/>').gsub("\r", '') 
+          end
         end
       end   
     end
@@ -379,15 +395,15 @@ module Cheat::Views
   
   def _side
     text '( '
-    a 'add', :href => R(Add)
+    a 'add new', :href => R(Add)
     text ' | '
-    a 'browse', :href => R(Browse)
+    a 'see all', :href => R(Browse)
     text ' )'
     ul {
-      li { strong "recent cheat sheets" }
+      li { strong "updated sheets" }
       li do
         a :href => FEED do
-          img(:alt => "Recent Cheat Sheets Feed", :src => "http://errtheblog.com/images/theme/feed.png")
+          img(:border => 0, :alt => "Recently Updated Cheat Sheets Feed", :src => "http://errtheblog.com/images/theme/feed.png")
         end
       end
       recent_sheets.each do |sheet|
@@ -414,7 +430,7 @@ module Cheat::Views
     dash  = hover    
     version = "#fcf095"
     style :type => "text/css" do
-      text %{
+      text %[
         body { font-family: verdana, sans-serif; background-color: #{bg};
                line-height: 20px; }
         a:link, a:visited { color: #{link}; }                
@@ -424,6 +440,7 @@ module Cheat::Views
                       background-color: #{version}; }       
         h1 { font-size: 5em; margin: 0; padding-left: 30px; color: #{h1}; 
              clear: both; font-weight: bold; letter-spacing: -5px; }
+        h1 a { text-decoration: none; }
         div.main    { float: left; width: 100%; }
         div.content { float: left; width: 70%; padding: 15px 0 15px 30px;
                       line-height: 20px; }
@@ -442,7 +459,14 @@ module Cheat::Views
         div.clear_10 { clear: both; font-size: 10px; line-height: 10px; }
         textarea { font-family: courier; }
         code { background-color: #{version} }
-      }.gsub(/(\s{2,})/, '').gsub("\n", '')
+        @media print {
+          .side, .version, .footer { display: none; }
+          div.content { width: 100%; }
+          h1 a:link, h1 a:visited { color: #eee;}
+          .header code { font-size: 18px; background: none; }
+          div.header { border-bottom: none; }
+        }
+      ].gsub(/(\s{2,})/, '').gsub("\n", '')
     end
   end
 end
@@ -451,7 +475,7 @@ module Cheat::Helpers
   def logo_link(title)
     ctr = Cheat::Controllers
     if @sheet && !@sheet.new_record? && @sheet.version != current_sheet.version
-      a title, :href => R(ctr::Show, @sheet.title, current_sheet.version)
+      a title, :href => R(ctr::Show, @sheet.title)
     else
       a title, :href => R(ctr::Index)
     end
@@ -462,7 +486,7 @@ module Cheat::Helpers
   end
   
   def recent_sheets
-    Cheat::Models::Sheet.find(:all, :order => 'created_at DESC', :limit => 10)
+    Cheat::Models::Sheet.find(:all, :order => 'updated_at DESC', :limit => 15)
   end
   
   def sheet_link(title, version = nil)
@@ -485,9 +509,13 @@ module Cheat::Helpers
     end
   end
 
-  def h(text)
+  def self.h(text)
     ERB::Util::h(text)
   end
+
+  def h(text)
+    ::Cheat::Helpers.h(text)
+  end
 end
 
 def Cheat.create

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: cheat
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
-date: 2006-09-03 00:00:00 -07:00
+  version: 1.1.0
+date: 2006-10-15 00:00:00 -07:00
 summary: Cheat is a simple command line utility reference program.
 require_paths: 
 - lib