rum 0.0.1-universal-darwin-10

data/doc/resources/build.rb

@@ -0,0 +1,235 @@
+require 'haml'
+
+class Doc
+  module Pygmentize
+    Bin = if RUBY_PLATFORM =~ /mswin|mingw/ and ENV['USER'] == 'nonsequitur'
+            'C:/Programme/Python26/Scripts/pygmentize.exe'
+          else
+            'pygmentize'
+          end
+    Cmd = "#{Bin} -O encoding=utf-8 -l ruby -f html"
+    
+    def self.file file
+      fix_pygments_output(`#{Cmd} #{file}`)
+    end
+
+    def self.string str
+      IO.popen(Cmd, 'w+') do |pygmentize|
+        pygmentize.write str
+        pygmentize.close_write
+        fix_pygments_output(pygmentize.read)
+      end
+    end
+
+    def self.fix_pygments_output str
+      # Bug in Pygments 1.3.1: 'type' is no Ruby builtin
+      str.gsub('<span class="nb">type</span>', 'type')\
+         .gsub('<span class="nb">require</span>', 'require')
+    end
+
+    class Snippets
+      def initialize
+        @snippets = []
+        @highlighted = []
+      end
+
+      def add str
+        @snippets << str
+        result = ''
+        @highlighted << result
+        result
+      end
+
+      def pygmentize!
+        highlighted = Pygmentize.string(@snippets.join("\n")).lines.to_a
+        highlighted.first.sub! /<div.*?pre>/, ''
+        @snippets.each_with_index do |snippet, i|
+          length = snippet.lines.to_a.length
+          str  = '<pre class="highlight">'
+          str << highlighted.slice!(0, length).join.chomp
+          str << '</pre>'
+          @highlighted[i].replace str
+        end
+      end
+    end
+  end
+
+  class Code
+    def initialize(file)
+      @lines = File.read(file).split /\n/
+    end
+
+    def render
+      parse
+      to_html
+    end
+    
+    def parse
+      @result = []
+      @last_type = nil
+      @lines.each { |line| compose_doc(*classify_and_extract(line)) }
+      @result
+    end
+
+    def classify_and_extract line
+      case line
+      when /^#?\s*$/      then [:empty,   nil]
+      when /^####\s+(.*)/ then [:chapter, $1.rstrip]
+      when /^###\s+(.*)/  then [:h2,      $1.rstrip]
+      when /^##\s+(.*)/   then [:h3,      $1.rstrip]
+      when /^#\s*(.*)/    then [:text,    $1.rstrip]
+      else [:code, line]
+      end
+    end
+    
+    EmptyAllowed = { code: true, text: true }
+
+    def compose_doc type, line
+      if type == :empty
+        @result.last << '' if EmptyAllowed[@last_type]
+      elsif type == @last_type
+        @result.last << line
+      else
+        @result << [type, line]
+        @last_type = type
+      end
+    end
+
+    class TableOfContents
+      Heading = Struct.new(:text, :anchor_name)
+      
+      def initialize
+        @headings = []
+      end
+
+      def add_heading heading
+        chapter_number = @headings.count + 1
+        @headings << Heading.new(heading, "chapter_#{chapter_number}")
+      end
+    
+      def heading_html
+        heading = @headings.last
+        "<a name=\"#{heading.anchor_name}\"><h1>#{heading.text}</h1></a>"
+      end
+
+      def heading_list_items
+        @headings.map do |heading|
+          "<li><a href=\"##{heading.anchor_name}\">#{heading.text}</a></li>"
+        end.join
+      end
+
+      def to_html
+        html  = "<div id=\"table_of_contents\"><h1>Chapters</h1>"
+        html << "<ul>"
+        html << heading_list_items
+        html << "</ul>"
+        html << "</div>"
+      end
+    end
+
+    ChapterEnd = "</div>\n"
+    ChapterBeginning = "<div class=\"chapter\">\n"
+
+    def to_html
+      snippets = Pygmentize::Snippets.new
+      table_of_contents = TableOfContents.new
+      
+      sections = @result.map do |type, *lines|
+        case type
+        when :chapter
+          table_of_contents.add_heading lines.first
+          chapter  = ChapterEnd.dup
+          chapter << ChapterBeginning
+          chapter << table_of_contents.heading_html << "\n"
+        when :h2
+          "<h2>#{lines.first}</h2>"
+        when :h3
+          "<h3>#{lines.first}</h3>"
+        when :text
+          "<p>#{join_text(lines)}</p>"
+        when :code
+          snippets.add(lines.join("\n").rstrip)
+        end
+      end
+
+      sections.first.sub! ChapterEnd, ''
+      sections << ChapterEnd
+      sections.unshift table_of_contents.to_html
+
+      snippets.pygmentize!
+      sections.join("\n")
+    end
+
+    def join_text(lines)
+      paragraphs = []
+      paragraphs << lines.first.dup
+      lines.each_cons(2) do |a, b|
+        if (a.empty? or b.empty? or
+            a.chars.to_a.last =~ /[.:!?)>]/ or a.length < 8)
+          paragraphs << b
+        else
+          paragraphs.last << ' ' <<  b
+        end
+      end
+      paragraphs.pop while paragraphs.last.empty?
+      paragraphs.join('<br />')
+    end
+  end
+
+  def initialize(index, intro, basic, example, reference, args)
+    @dir = args[:dir] || ''
+    @output    = File.join(@dir, args[:output])
+    @index     = File.join(@dir, index)
+    @intro     = File.join(@dir, intro)
+    @basic     = File.join(@dir, basic)
+    @example   = File.join(@dir, example)
+    @reference = File.join(@dir, reference)
+  end
+
+  def current_version
+    gemspec = eval(IO.read('rum.gemspec'))
+    gemspec.version
+  end
+
+  def intro
+    Pygmentize.file @intro
+  end
+
+  def inf_ruby_setup
+    <<EOF
+(add-to-list 'inf-ruby-implementations
+  '("rum-client" . "rum-client -i --inf-ruby-mode")
+(defun rum-client ()
+  (interactive)
+  (inf-ruby "rum-client")))
+EOF
+  end
+
+  def basic
+    Pygmentize.file(@basic)
+  end
+
+  def example
+    Pygmentize.file @example
+  end
+
+  def reference
+    Doc::Code.new(@reference).render
+  end
+
+  def render
+    doc = File.read(@index)
+    # Ugly is needed for Pygments-formatted code
+    haml = Haml::Engine.new(doc, ugly: true)
+    @doc = haml.render(self)
+  end
+
+  def save
+    File.open(@output, 'w') { |f| f.write @doc }
+  end
+
+  def build
+    render
+    save
+  end
+end

data/doc/resources/doc.haml

@@ -0,0 +1,167 @@
+%html(xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en")
+  %head
+    %title Rum
+    %meta(http-equiv="Content-Type" content="text/html;charset=utf-8")
+    %link(rel="stylesheet" href="resources/screen.css" type="text/css" media="screen")
+    %link(rel="stylesheet" href="resources/highlight.css" type="text/css" media="screen")
+
+  %body
+    %img{id: "logo", src: "resources/logo.png"}
+    #nav
+      %ul
+        %li
+          %a{href: "#"} Intro
+        %li
+          %a{href: "#installation"} Installation
+        %li
+          %a{href: "#coding"} Coding
+        %li
+          %a{href: "#example"} Example
+        %li
+          %a{href: "#reference"} Reference
+        %li
+          %a{href: "#development"} Development
+    #wrapper
+      #intro Rum is a cross-platform Hotkey and Macro utility, built in Ruby.<br />Not yet running on Linux, it’s progressing steadily on the Mac (MacRuby) and is fully supported on Windows.
+
+      %img{src: "resources/screenshot.png"}
+      #screenshot-sub
+      #intro-code
+        #top
+        #content
+          %img{id: "flash", src: "resources/flash.png"}
+          #sshot-sub This snippet powers the above screenshot.
+          -# #sshot-sub The above screenshot is powered by this snippet.
+          = intro
+        #bottom
+        #intro-code-sub Rum configuration files are regular Ruby scripts, like the above.<br /> Running Rum is as easy as calling <span class="code">ruby my_rum_config_file.rb</span> from the command line.<br />(Or <span class="code">macruby -rubygems my_rum_config_file.rb</span> on the Mac.)
+      #guide
+        #installation
+          %a{name: "installation"}
+            %h1 Installation
+          #gem
+            #regulargem
+              %span{class: "code"} gem install rum
+            #macgem
+              %span{class: "code"} macgem install rum
+              %div
+                -# %span{class: "onthemac"} On the Mac
+            .clear
+
+          %p{id: "current_version"}
+            Current version:
+            = current_version
+            %span{id: "changelog"} (<a href="https://github.com/nonsequitur/rum/blob/master/CHANGELOG">Changelog</a>)
+
+          #platforms
+            %h3 Supported platforms
+            %ul
+              %li Mac OS X – MacRuby >=0.10
+              %li
+                32-bit Windows XP/Vista/7 – Ruby >=1.9.1p378.<br />
+          #growl
+            %h2 Recommended: Growl
+            %ul
+              %li Get Growl: <a href="http://growl.info/">Mac</a>, <a href="http://www.growlforwindows.com/gfw/">Windows</a>
+              %li To use Growl in Rum: Add <span class="code">Gui.use Gui::Growl</span> to your Rum config.
+            #growl-explanation
+              %h3 Why Growl?
+              Notification bubbles are a convenient alternative to focus-stealing message boxes.
+              Some higher level Rum methods only work smoothly with Growl-style notifications.
+              Currently, Growl is the only notification system supported by Rum.
+
+        #coding
+          %a{name: "coding"}
+            %h1 Coding in Rum
+          Rum encourages an interactive approach to coding and a fast code-and-feedback cycle.
+          %h2 Core techniques
+          %ul{id: "core-techniques"}
+            %li
+              %h3 rum-client REPL
+              %p Add <span class="code">Rum::Server.start</span> to your Rum config.
+              %p Call <span class="code">rum-client -i</span> from the command line to start an IRB-session inside a running Rum instance. IRB Completion is fully supported.
+              %p Nearly all snippets in this guide can be evaluated interactively.
+
+              %p Set the environment variable <span class="code">RUM_PORT</span> to change the port on which client and server connect.
+
+              %p
+                %h3 rum-client in emacs:
+                %ul
+                  %li Get the latest Inf-Ruby via <a href="http://marmalade-repo.org/packages/inf-ruby">ELPA</a>
+                  %li
+                    Add the following to your Emacs config:
+                    %pre{id: "inf_ruby_setup"}= inf_ruby_setup
+                  %li
+                    Run <span class="code">M-x rum-client</span>
+                #auto-completion
+                  %h4 Auto-completion
+                  %img{id: "auto-completion",
+                       src: "resources/emacs-auto-completion.png"}
+                  -# %p The Inf-Ruby backend for Company-Mode offers auto-completion for Inf-Ruby buffers.
+                  %p
+                    Company-Mode features auto-completion for IRB sessions.<br />
+                    <a href="http://www.emacswiki.org/emacs/InfRubyCompany">See here for installation instructions</a>.
+
+            %li
+              %%h3 Rum.restart
+              Restarts Rum.
+              Bind it to a key, like <span class="code">'shift f1'.do { Rum.restart }</span>
+
+          Run Rum with this basic, REPL-enabled setup to get started:
+          #basic= basic
+
+          #example
+            %a{name: "example"}
+              %h1 Extended Example
+            = example
+
+
+          -# #example-configs
+
+          %a{name: "reference"}
+            %h1 Reference
+          %p
+            This section is also available as a Ruby source file and can be
+            conveniently viewed in a text editor.<br />
+            Call <span class="code">Rum.reference</span> or manually open
+            <span class="code">rum_dir/doc/reference.rb</span>.
+      #reference_wrapper= reference
+
+      #development
+        %a{name: "development"}
+          %h1 Development
+        %p
+          Patches and suggestions are most appreciated.
+        %p
+          There's a <a href="https://github.com/nonsequitur/rum-dev/blob/master/rum-development.org">low-ceremony
+          to-do list</a> to coordinate the development
+          of larger-scale features.<br />
+          -# Please check this out if you're interested in contributing.
+          Feel free to have a look if you're interested in contributing.
+          -# Instructions on how to contribute can be found inside the list.
+        %h2 Building
+        %p
+          %span{class: "code"} rake build
+          builds the extension and the document.
+        %p
+          %span{class: "code"} rake ext
+          builds just the extension.
+        %p
+          %span{class: "code"} rake doc
+          builds this document. Requires Pygments.
+        %h3 Mac specifics:
+        %p
+          XCode required.
+        %h3 Windows specifics:
+        %p
+          Visual Studio required. (Out-of-the-box MinGW support coming soon.)
+        %p
+          You need to setup the Visual Studio build environment before running the rake commands.<br />Call <span class="code">"%programfiles%\Microsoft Visual Studio 9.0\VC\vcvarsall.bat" x86</span> from your Windows terminal.
+        %p
+          You might have to delete the following lines from <span class="code">ruby_dir/include/ruby-1.9.x/i386-mswin32/ruby/config.h</span> to work around a compiler error:
+          %pre
+            \#if _MSC_VER != 1200
+            \#error MSC version unmatch: _MSC_VER: 1200 is expected.
+            \#endif
+        #footer
+      

data/doc/resources/highlight.css

@@ -0,0 +1,94 @@
+.chapter .highlight { background-color: #F4F4F4; }
+
+
+/* .chapter .highlight { color: #F7F7F7; background-color: #27262F; } */
+/* .chapter .c1 { color: #8b8b8b; font-style: italic } /\* Comment.Single *\/ */
+/* .chapter .nb { color: #c13a3a } /\* Name.Builtin *\/ */
+/* .chapter .k { color: #c13a3a; font-weight: bold } /\* Keyword *\/ */
+/* .chapter .kp { color: #c13a3a } /\* Keyword.Pseudo *\/ */
+/* .chapter .no { color: #FF4530 } /\* Name.Constant *\/ */
+/* /\* .no { color: #664312 } /\\* Name.Constant *\\/ *\/ */
+/* .chapter .s1 { color: #13E618 } /\* Literal.String.Single *\/ */
+/* /\* .s1 { color: #68b800 } /\\* Literal.String.Single *\\/ *\/ */
+/* /\* #content .s1 { color: #68b800 } *\/ */
+/* .chapter .ss { color: #FF9E21 } /\* Literal.String.Symbol *\/ */
+/* .chapter .sr { color: #BB6688 } /\* Literal.String.Regex *\/ */
+
+
+
+.c1 { color: #717171; font-style: italic } /* Comment.Single */
+.nb { color: #c13a3a } /* Name.Builtin */
+.k { color: #c13a3a; font-weight: bold } /* Keyword */
+.kp { color: #c13a3a } /* Keyword.Pseudo */
+/* .no { color: #661A12 } /\* Name.Constant */
+.no { color: #B42313 } /* Name.Constant */
+/* .no { color: ##FF3300 } /\* Name.Constant *\/ */
+/* .no { color: #664312 } /\* Name.Constant *\/ */
+/* .s1 { color: #58920e } /\* Literal.String.Single *\/ */
+.s1 { color: #39BF06 } /* Literal.String.Single */
+.s1 { color: #34AD06 } /* Literal.String.Single */39BF06
+/* .s1 { color: #68b800 } /\* Literal.String.Single *\/ */
+/* #content .s1 { color: #68b800 } */
+.ss { color: #58920e } /* Literal.String.Symbol */
+.sr { color: #BB6688 } /* Literal.String.Regex */
+/* .mi { color: #666666 } /\* Literal.Number.Integer *\/ */
+
+
+
+.hll { background-color: #ffffcc }
+.c { color: #408080; font-style: italic } /* Comment */
+.err { border: 1px solid #FF0000 } /* Error */
+/* .o { color: #666666 } /\* Operator *\/ */
+.cm { color: #408080; font-style: italic } /* Comment.Multiline */
+.cp { color: #BC7A00 } /* Comment.Preproc */
+
+
+.cs { color: #408080; font-style: italic } /* Comment.Special */
+.gd { color: #A00000 } /* Generic.Deleted */
+.ge { font-style: italic } /* Generic.Emph */
+.gr { color: #FF0000 } /* Generic.Error */
+.gh { color: #000080; font-weight: bold } /* Generic.Heading */
+.gi { color: #00A000 } /* Generic.Inserted */
+.go { color: #808080 } /* Generic.Output */
+.gp { color: #000080; font-weight: bold } /* Generic.Prompt */
+.gs { font-weight: bold } /* Generic.Strong */
+.gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+.gt { color: #0040D0 } /* Generic.Traceback */
+.kc { color: #008000; font-weight: bold } /* Keyword.Constant */
+.kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
+.kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
+.kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
+.kt { color: #B00040 } /* Keyword.Type */
+.m { color: #666666 } /* Literal.Number */
+.s { color: #BA2121 } /* Literal.String */
+.na { color: #7D9029 } /* Name.Attribute */
+
+.nc { color: #0000FF; font-weight: bold } /* Name.Class */
+.nd { color: #AA22FF } /* Name.Decorator */
+.ni { color: #999999; font-weight: bold } /* Name.Entity */
+.ne { color: #D2413A; font-weight: bold } /* Name.Exception */
+.nf { color: #0000FF } /* Name.Function */
+.nl { color: #A0A000 } /* Name.Label */
+.nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
+.nt { color: #008000; font-weight: bold } /* Name.Tag */
+.nv { color: #19177C } /* Name.Variable */
+.ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
+.w { color: #bbbbbb } /* Text.Whitespace */
+.mf { color: #666666 } /* Literal.Number.Float */
+.mh { color: #666666 } /* Literal.Number.Hex */
+
+.mo { color: #666666 } /* Literal.Number.Oct */
+.sb { color: #BA2121 } /* Literal.String.Backtick */
+.sc { color: #BA2121 } /* Literal.String.Char */
+.sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
+.s2 { color: #BA2121 } /* Literal.String.Double */
+.se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
+.sh { color: #BA2121 } /* Literal.String.Heredoc */
+.si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
+.sx { color: #008000 } /* Literal.String.Other */
+
+.bp { color: #008000 } /* Name.Builtin.Pseudo */
+.vc { color: #19177C } /* Name.Variable.Class */
+.vg { color: #19177C } /* Name.Variable.Global */
+.vi { color: #19177C } /* Name.Variable.Instance */
+.il { color: #666666 } /* Literal.Number.Integer.Long */