cheat 1.1.0 → 1.2

data/lib/cheat.rb

@@ -4,13 +4,41 @@ $:.unshift File.dirname(__FILE__)
 module Cheat
   extend self
 
-  HOST = 'cheat.errtheblog.com'
-  PORT = 80
+  HOST = ARGV.include?('debug') ? 'localhost' : 'cheat.errtheblog.com'
+  PORT = ARGV.include?('debug') ? 3001 : 80
   SUFFIX = ''
 
   def sheets(args)
     args = args.dup
 
+    return unless parse_args(args)
+
+    FileUtils.mkdir(cache_dir) unless File.exists?(cache_dir) if cache_dir
+
+    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 
+
+    fetch_sheet(uri, @sheet) if @sheet
+  end
+
+  def fetch_sheet(uri, try_to_cache = true)
+    open(uri, headers) do |body|
+      sheet = body.read
+      File.open(cache_file, 'w') { |f| f.write(sheet) } if try_to_cache && cache_file && !@edit 
+      @edit ? edit(sheet) : show(sheet)
+    end 
+    exit
+  rescue OpenURI::HTTPError => e
+    puts "Whoa, some kind of Internets error!", "=> #{e} from #{uri}"
+  end
+
+  def parse_args(args)
     puts "Looking for help?  Try http://cheat.errtheblog.com or `$ cheat cheat'" and return if args.empty?
 
     if args.delete('--clear-cache') || args.delete('--new')
@@ -18,31 +46,42 @@ module Cheat
       return if args.empty?
     end
 
+    if i = args.index('--diff')
+      diff_sheets(args.first, args[i+1]) 
+    end
+
+    show_versions(args.first) if args.delete('--versions')
+
     add(args.shift) and return if args.delete('--add')
+    clear_cache if @edit = args.delete('--edit')
 
-    if edit = args.delete('--edit')
-      clear_cache
-    end
+    @sheet = args.shift
 
-    sheet = args.shift
+    true
+  end
 
-    cache_file = "#{cache_dir}/#{sheet}.yml" if cache_dir
-    FileUtils.mkdir(cache_dir) unless File.exists?(cache_dir) if cache_dir
+  # $ cheat greader --versions
+  def show_versions(sheet)
+    fetch_sheet("http://#{cheat_uri}/h/#{sheet}/")
+  end
 
-    uri  = "http://#{cheat_uri}/y/"
+  # $ cheat greader --diff 1[:3]
+  def diff_sheets(sheet, version)
+    return unless version =~ /^(\d+)(:(\d+))?$/
+    old_version, new_version = $1, $3
 
-    if %w[sheets all recent].include? sheet
-      uri = uri.sub('/y/', sheet == 'recent' ? '/yr/' : '/ya/')
-      return open(uri) { |body| show(body.read) } 
-    end
+    uri = "http://#{cheat_uri}/d/#{sheet}/#{old_version}"
+    uri += "/#{new_version}" if new_version
 
-    return show(File.read(cache_file)) if File.exists?(cache_file) rescue clear_cache if cache_file 
+    fetch_sheet(uri, false) 
+  end
 
-    open(uri += sheet) do |body|
-      sheet = body.read
-      File.open(cache_file, 'w') { |f| f.write(sheet) } if cache_file && !edit
-      edit ? edit(sheet) : show(sheet)
-    end if sheet
+  def cache_file
+    "#{cache_dir}/#{@sheet}.yml" if cache_dir
+  end
+
+  def headers
+    { 'User-Agent' => 'cheat!', 'Accept' => 'text/yaml' } 
   end
 
   def cheat_uri
@@ -53,7 +92,9 @@ module Cheat
     sheet = YAML.load(sheet_yaml).to_a.first
     sheet[-1] = sheet.last.join("\n") if sheet[-1].is_a?(Array)
     puts sheet.first + ':'
-    puts '  ' + sheet.last.gsub("\r",'').gsub("\n", "\n  ").wrap(80)
+    puts '  ' + sheet.last.gsub("\r",'').gsub("\n", "\n  ").wrap
+  rescue
+    puts "That didn't work.  Try something else?"
   end
 
   def edit(sheet_yaml)

data/lib/diffr.rb

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'diff/lcs'
+require 'diff/lcs/hunk'
+
+module Cheat
+  class Diffr
+    def self.diff(sheet_old, sheet_new)
+      format, lines, output = :unified, 10000, ''
+      file_length_difference = 0
+
+      data_old = sheet_old.body.wrap.split(/\n/).map! { |e| e.chomp }
+      data_new = sheet_new.body.wrap.split(/\n/).map! { |e| e.chomp }
+
+      diffs = Diff::LCS.diff(data_old, data_new)
+      return if diffs.empty?
+
+      header = ''
+      ft = sheet_old.updated_at
+      header << "#{'-' * 3} #{sheet_new.title} version #{sheet_old.version}\t#{ft}\n"
+      ft = sheet_new.updated_at
+      header <<  "#{'+' * 3} #{sheet_new.title} version #{sheet_new.version}\t#{ft}\n"
+
+      oldhunk = hunk = nil
+
+      diffs.each do |piece|
+        begin
+          hunk = Diff::LCS::Hunk.new(data_old, data_new, piece, lines, file_length_difference)
+          file_length_difference = hunk.file_length_difference
+
+          next unless oldhunk
+
+          if lines > 0 && hunk.overlaps?(oldhunk)
+            hunk.unshift(oldhunk)
+          else
+            output << oldhunk.diff(format)
+          end
+        ensure
+          oldhunk = hunk
+          output << "\n"
+        end
+      end
+
+      output << oldhunk.diff(format)
+      output << "\n"
+
+      return header + output.lstrip
+    end
+  end
+end

data/lib/responder.rb

@@ -0,0 +1,42 @@
+# class Something < R 'route'
+#   include Responder
+#   
+#   def get
+#    ... important code ...
+#
+#     respond_to do |wants|
+#       wants.html { render :something }
+#       wants.text { "Just some text." }
+#       wants.yaml { "Something neat!".to_yaml }
+#       wants.xml  { "Also, XML.".to_xml }
+#     end
+#   end
+# end
+module Cheat::Controllers
+  module Responder
+    def respond_to
+      yield response = Response.new(env.HTTP_ACCEPT)
+      @headers['Content-Type'] = response.content_type
+      response.body
+    end
+
+    class Response
+      attr_reader :body, :content_type
+      def initialize(accept) @accept = accept end
+
+      TYPES = { 
+        :yaml => %w[application/yaml text/yaml],
+        :text => %w[text/plain],
+        :html => %w[text/html */* application/html],
+        :xml  => %w[application/xml]
+      }
+
+      def method_missing(method, *args)
+        if TYPES[method] && @accept =~ Regexp.union(*TYPES[method])
+          @content_type = TYPES[method].first 
+          @body = yield if block_given?
+        end
+      end
+    end
+  end
+end

data/lib/site.rb

@@ -21,12 +21,12 @@
 #   Cheat Lake, a nearby resevoir
 #   Cheat Mountain, one of the highest mountains in the Alleghenies
 #
-%w[rubygems camping camping/db erb open-uri acts_as_versioned wrap].each { |f| require f }
+%w[rubygems camping camping/db erb open-uri acts_as_versioned wrap diffr responder].each { |f| require f }
 require_gem 'camping', '>=1.4.152'
 
 Camping.goes :Cheat
 
-URL  = 'http://cheat.errtheblog.com' # need this to get around exposing :port in redirects
+URL  = ARGV.include?('debug') ? 'http://localhost:3001' : 'http://cheat.errtheblog.com' 
 FEED = 'http://feeds.feedburner.com/cheatsheets' # rss feed
 
 module Cheat::Models
@@ -108,14 +108,11 @@ module Cheat::Controllers
   class Edit < R '/e/(\w+)/(\d+)', '/e/(\w+)'
     def get(title, version = nil)
       @sheet = Sheet.find_by_title(title)
-      unless @sheet
-        @error = "Cheat sheet not found."
-        return render(:error)
-      end
+      @error = "Cheat sheet not found." unless @sheet
       unless version.nil? || version == @sheet.version.to_s        
         @sheet = @sheet.find_version(version)
       end
-      render :edit
+      render @error ? :error : :edit
     end
   end
   
@@ -125,12 +122,9 @@ module Cheat::Controllers
   
       @error = input.sheet_body =~ /<a\s*href=/
 
-      unless input.from_gem
-        @error = true unless captcha_pass?(input.chunky, input.bacon)
-      end
+      check_captcha! unless input.from_gem
 
-      if !@error && @sheet.update_attributes(:title => input.sheet_title, 
-                                             :body => input.sheet_body)
+      if !@error && @sheet.update_attributes(:title => input.sheet_title, :body => input.sheet_body)
         redirect "#{URL}/s/#{@sheet.title}"
       else
         @error = true
@@ -138,6 +132,10 @@ module Cheat::Controllers
       end
     end
 
+    def check_captcha!
+      @error ||= !(@cookies[:passed] ||= captcha_pass?(input.chunky, input.bacon))
+    end
+
     def captcha_pass?(session, answer)
       open("http://captchator.ruby-forum.com/captcha/check_answer/#{session}/#{answer}").read.to_i.nonzero? rescue false
     end
@@ -150,31 +148,46 @@ module Cheat::Controllers
     end
   end
   
-  class Show < R '/s/(\w+)', '/s/(\w+)/(\d+)', '/s/(\w+\.txt)'
+  class Show < R '/s/(\w+)', '/s/(\w+)/(\d+)'
     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 && text
-        return @sheet.body
-      elsif @sheet 
-        render :show
-      else
-        redirect "#{URL}/b/"
+      @sheet ? render(:show) : redirect("#{URL}/b/")
+    end
+  end
+
+  # we are going to start consolidating classes with respond_to and what not.
+  # diff is the first, as the api and the site will use the same code
+  class Diff < R '/d/(\w+)/(\d+)', '/d/(\w+)/(\d+)/(\d+)'
+    include Responder
+
+    def get(title, old_version, new_version = nil)
+      redirect "#{URL}/b/" and return unless old_version.to_i.nonzero?
+
+      @sheet = Sheet.find_by_title(title)
+      @old_sheet = @sheet.find_version(old_version)
+      @new_sheet = (new_version ? @sheet.find_version(new_version) : @sheet)
+
+      @diffed = Diffr.diff(@old_sheet, @new_sheet) rescue nil
+
+      respond_to do |wants|
+        wants.html { render :diff }
+        wants.yaml { { @sheet.title => @diffed }.to_yaml }
       end
     end
   end
 
   class History < R '/h/(\w+)'
+    include Responder
+
     def get(title)
       @sheets = Sheet.find_by_title(title).find_versions(:order => 'version DESC')
-      render :history
+
+      respond_to do |wants|
+        wants.html { render :history }
+        wants.yaml { { @sheets.first.title => @sheets.map { |s| s.version } }.to_yaml }
+      end
     end
   end
 end
@@ -185,15 +198,13 @@ module Cheat::Views
       head {
         _style
         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"
+        title @page_title ? "$ cheat #{@page_title}" : "$ command line ruby cheat sheets"
       }
       body {
         div.main {
           div.header { 
             h1 { logo_link 'cheat sheets.' } 
-            code.header defined?(@sheet_title) ? "$ cheat #{@sheet_title}" : \
-              "$ command line ruby cheat sheets"
+            code.header @sheet_title ? "$ cheat #{@sheet_title}" : "$ command line ruby cheat sheets"
             }
           div.content { self << yield }         
           div.side { _side }
@@ -214,7 +225,7 @@ module Cheat::Views
   def show
     @page_title = @sheet.title
     @sheet_title = @sheet.title
-    pre.sheet { text h(sheet.body.wrap(80)) }
+    pre.sheet { text h(@sheet.body.wrap) }
     div.version {
       text "Version "
       strong sheet.version
@@ -223,26 +234,49 @@ module Cheat::Views
       text " ago.  "
       br
       text ". o 0 ( "
-      a "edit", :href => R(Edit, @sheet.title)
-      if @sheet.version > 1
+      if @sheet.version == current_sheet.version
+        a "edit", :href => R(Edit, @sheet.title)
         text " | "
+      end
+      if @sheet.version > 1
         a "previous", :href => R(Show, @sheet.title, @sheet.version - 1)
         text " | "
-        a "history", :href => R(History, @sheet.title)
       end
-      if @sheet.version != (current = current_sheet).version
-        text " | "
+      a "history", :href => R(History, @sheet.title)
+      text " | "        
+      unless @sheet.version == current_sheet.version
         a "revert to", :href => R(Edit, @sheet.title, @sheet.version)
         text " | "        
         a "current", :href => R(Show, @sheet.title)
-      end
-      if @sheet.version == current_sheet.version
         text " | "
-        a "text", :href => R(Show, @sheet.title + '.txt')
       end
+      diff_version = 
+        if @sheet.version == current_sheet.version 
+          @sheet.version == 1 ? nil : @sheet.version - 1
+        else
+          @sheet.version
+        end
+      a "diff", :href => R(Diff, @sheet.title, diff_version) if diff_version
       text " )"
      }
   end
+
+  def diff
+    @page_title = @sheet.title
+    @sheet_title = @sheet.title
+    pre.sheet { color_diff(@diffed) if @diffed }
+    div.version {
+      text ". o 0 ("
+      if @old_sheet.version > 1
+        a "diff previous", :href => R(Diff, @sheet.title, @old_sheet.version - 1)
+        text " | "
+      end
+      a "history", :href => R(History, @sheet.title)
+      text " | "
+      a "current", :href => R(Show, @sheet.title)
+      text " )"
+    }
+  end
   
   def browse
     @page_title = "browse"
@@ -269,7 +303,9 @@ module Cheat::Views
           text " - created "
           text last_updated(sheet)
           text " ago"
-          strong " (current)" if i == 0
+          strong " (current)" if i.zero?
+          text " "
+          a "(diff to current)", :href => R(Diff, sheet.title, sheet.version) if i.nonzero?
         }
       end
     }
@@ -312,11 +348,13 @@ module Cheat::Views
           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'
+          unless @cookies[:passed]
+            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'
+          end
         }
       }
       p "Your cheat sheet will be editable (fixable) by anyone.  Each cheat 
@@ -459,6 +497,8 @@ module Cheat::Views
         div.clear_10 { clear: both; font-size: 10px; line-height: 10px; }
         textarea { font-family: courier; }
         code { background-color: #{version} }
+        span.diff_cut { color: #f65077; }
+        span.diff_add { color: #009933; }
         @media print {
           .side, .version, .footer { display: none; }
           div.content { width: 100%; }
@@ -516,6 +556,16 @@ module Cheat::Helpers
   def h(text)
     ::Cheat::Helpers.h(text)
   end
+
+  def color_diff(diff)
+    diff.split("\n").map do |line|
+      action = case line
+               when /^-/  then 'cut'
+               when /^\+/ then 'add'
+               end
+      action ? span.send("diff_#{action}", line) : line
+    end * "\n"
+  end
 end
 
 def Cheat.create

data/lib/wrap.rb

@@ -1,7 +1,7 @@
 # >> Evan Weaver
 # => http://blog.evanweaver.com/articles/2006/09/03/smart-plaintext-wrapping
 class String
-  def wrap(width, hanging_indent = 0, magic_lists = false)
+  def wrap(width = 80, hanging_indent = 0, magic_lists = false)
     lines = self.split(/\n/)
 
     lines.collect! do |line|

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: cheat
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
-date: 2006-10-15 00:00:00 -07:00
+  version: "1.2"
+date: 2006-11-09 00:00:00 -08:00
 summary: Cheat is a simple command line utility reference program.
 require_paths: 
 - lib
@@ -33,6 +33,8 @@ files:
 - LICENSE
 - bin/cheat
 - lib/cheat.rb
+- lib/diffr.rb
+- lib/responder.rb
 - lib/site.rb
 - lib/wrap.rb
 - test/fixtures