harmony 0.5

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.yardoc/
+doc/
+TODO
+.yard_issues.md

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright © 2009 Martin Aumont (mynyml)
+
+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/Manifest

@@ -0,0 +1,117 @@
+.gitignore
+LICENSE
+Manifest
+README.md
+Rakefile
+docs.watchr
+harmony.gemspec
+lib/harmony.rb
+lib/harmony/page.rb
+specs.watchr
+test/harmony_test.rb
+test/page_test.rb
+test/test_helper.rb
+vendor/README
+vendor/envjs/README
+vendor/envjs/bin/envjsrb
+vendor/envjs/bin/jquery-1.2.6-test.js
+vendor/envjs/bin/jquery-1.3.1-test.js
+vendor/envjs/bin/jquery-1.3.2-test.js
+vendor/envjs/bin/prototype-1.6.0.3-test.js
+vendor/envjs/bin/prototype_1.6.0.3_tmpl.txt
+vendor/envjs/bin/test-jquery.sh
+vendor/envjs/bin/test-prototype.sh
+vendor/envjs/bin/tidy
+vendor/envjs/lib/envjs.rb
+vendor/envjs/lib/envjs/env.js
+vendor/envjs/lib/envjs/net.rb
+vendor/envjs/lib/envjs/net/cgi.rb
+vendor/envjs/lib/envjs/net/file.rb
+vendor/envjs/lib/envjs/options.rb
+vendor/envjs/lib/envjs/runtime.rb
+vendor/envjs/lib/envjs/tempfile.rb
+vendor/envjs/test/base64.js
+vendor/envjs/test/call-load-test.js
+vendor/envjs/test/data.js
+vendor/envjs/test/debug.js
+vendor/envjs/test/firebug/errorIcon.png
+vendor/envjs/test/firebug/firebug.css
+vendor/envjs/test/firebug/firebug.html
+vendor/envjs/test/firebug/firebug.js
+vendor/envjs/test/firebug/firebugx.js
+vendor/envjs/test/firebug/infoIcon.png
+vendor/envjs/test/firebug/warningIcon.png
+vendor/envjs/test/fixtures/html/events.html
+vendor/envjs/test/fixtures/html/iframe1.html
+vendor/envjs/test/fixtures/html/iframe1a.html
+vendor/envjs/test/fixtures/html/iframe2.html
+vendor/envjs/test/fixtures/html/iframe3.html
+vendor/envjs/test/fixtures/html/iframeN.html
+vendor/envjs/test/fixtures/html/malformed.html
+vendor/envjs/test/fixtures/html/scope.html
+vendor/envjs/test/fixtures/html/trivial.html
+vendor/envjs/test/fixtures/html/with_js.html
+vendor/envjs/test/fixtures/images/icon-blue.png
+vendor/envjs/test/fixtures/js/external_script.js
+vendor/envjs/test/fixtures/js/script.js
+vendor/envjs/test/fixtures/js/script_error.js
+vendor/envjs/test/html/events.html
+vendor/envjs/test/html/iframe1.html
+vendor/envjs/test/html/iframe1a.html
+vendor/envjs/test/html/iframe2.html
+vendor/envjs/test/html/iframe3.html
+vendor/envjs/test/html/iframeN.html
+vendor/envjs/test/html/malformed.html
+vendor/envjs/test/html/scope.html
+vendor/envjs/test/html/script.js
+vendor/envjs/test/html/trivial.html
+vendor/envjs/test/html/with_js.html
+vendor/envjs/test/index.html
+vendor/envjs/test/java-prototype.js
+vendor/envjs/test/primary-tests.js
+vendor/envjs/test/prototype-test.js
+vendor/envjs/test/qunit.js
+vendor/envjs/test/qunit/qunit/qunit.css
+vendor/envjs/test/qunit/qunit/qunit.js
+vendor/envjs/test/scope.rb
+vendor/envjs/test/specs/dist/env.spec.js
+vendor/envjs/test/specs/envjs.spec.css
+vendor/envjs/test/specs/parser/html.js
+vendor/envjs/test/specs/parser/spec.html
+vendor/envjs/test/specs/parser/xml.js
+vendor/envjs/test/specs/qunit.bdd.js
+vendor/envjs/test/specs/qunit.css
+vendor/envjs/test/specs/qunit.js
+vendor/envjs/test/specs/template/spec-0.js
+vendor/envjs/test/specs/template/spec-1.js
+vendor/envjs/test/specs/template/spec.html
+vendor/envjs/test/specs/window/css.js
+vendor/envjs/test/specs/window/dialog.js
+vendor/envjs/test/specs/window/document.js
+vendor/envjs/test/specs/window/event.js
+vendor/envjs/test/specs/window/history.js
+vendor/envjs/test/specs/window/location.js
+vendor/envjs/test/specs/window/navigator.js
+vendor/envjs/test/specs/window/screen.js
+vendor/envjs/test/specs/window/spec.html
+vendor/envjs/test/specs/window/timer.js
+vendor/envjs/test/specs/window/window.js
+vendor/envjs/test/specs/xhr/spec.html
+vendor/envjs/test/specs/xhr/xhr.js
+vendor/envjs/test/test.js
+vendor/envjs/test/unit/dom.js
+vendor/envjs/test/unit/elementmembers.js
+vendor/envjs/test/unit/events.js
+vendor/envjs/test/unit/fixtures/external_script.js
+vendor/envjs/test/unit/iframe.js
+vendor/envjs/test/unit/multi-window.js
+vendor/envjs/test/unit/nu.validator.js
+vendor/envjs/test/unit/onload.js
+vendor/envjs/test/unit/parser.js
+vendor/envjs/test/unit/prototypecompat.js
+vendor/envjs/test/unit/proxy.js
+vendor/envjs/test/unit/scope.js
+vendor/envjs/test/unit/timer.js
+vendor/envjs/test/unit/window.js
+vendor/envjs/test/vendor/jQuery/README
+vendor/envjs/test/vendor/prototype-1.6.0.3.js

data/README.md

@@ -0,0 +1,155 @@
+Harmony
+=======
+
+                       .,ad88888888baa,
+                   ,d8P"""        ""9888ba.
+                .a8"          ,ad88888888888a
+               aP'          ,88888888888888888a
+             ,8"           ,88888888888888888888,
+            ,8'            (888888888( )888888888,
+           ,8'             `8888888888888888888888
+           8)               `888888888888888888888,
+           8                  "8888888888888888888)
+           8                   `888888888888888888)
+           8)                    "8888888888888888
+           (b                     "88888888888888'
+           `8,        (8)          8888888888888)
+            "8a                   ,888888888888)
+              V8,                 d88888888888"
+               `8b,             ,d8888888888P'
+                 `V8a,       ,ad8888888888P'
+                    ""88888888888888888P"
+                         """"""""""""
+
+Summary
+-------
+
+Harmony provides a simple DSL to execute javascript + DOM code within ruby.
+
+Install
+-------
+
+    # manually install dependencies until rubygems issue is resolved
+    gem install stackdeck
+    gem install johnson -v "2.0.0.pre0"
+
+    gem install harmony
+
+Examples
+--------
+
+### Simple Javascript Parsing
+
+    require 'harmony'
+
+    page = Harmony::Page.new(<<-HTML)
+      <html>
+        <head>
+          <title>Foo</title>
+        </head>
+        <body></body>
+      </html>
+    HTML
+
+    page.execute_js("1+1")            #=> 2
+    page.execute_js("document.title") #=> "Foo"
+
+The Page object's `#execute_js` method (aliased as `#x` for convenience) takes a
+string of javascript code, executes it and returns the last statement's value
+(just like a ruby method).
+
+### Javascript Unit Tests
+
+One interesting use of Harmony is to test your javascript code within your ruby
+application's own tests (test/unit, minitest, RSpec, nanotest, etc). Which
+consequently means that you can now run browser-less, fully command-line
+based, DOM-javascript tests.
+
+    require 'test/unit'
+    require 'harmony'
+
+    class JavascriptTest < Test::Unit::TestCase
+      def setup
+        @page = Harmony::Page.new
+        @page.load('public/javascripts/foo.js')
+      end
+
+      def test_foo
+        assert_equal "world", @page.execute_js(<<-JS)
+          foo = new Foo;
+          foo.hello();
+        JS
+      end
+    end
+
+### DOM Handling
+
+Don't be affraid to throw in your favorite client-side js framework, like
+JQuery or Prototype. And notice that scripts linked to in `<script>` tags will
+automatically get pulled in.
+
+    require 'harmony'
+
+    page = Harmony::Page.new(<<-HTML)
+      <html>
+        <head>
+          <script src="javascripts/jquery.js" type="text/javascript"></script>
+        </head>
+        <body>
+          <div id="widget">ohaie</div>
+        </body>
+      </html>
+    HTML
+
+    page.execute_js("$('#widget').innerHTML") #=> "ohaie"
+
+### Fetching Documents
+
+Use `Harmony::Page.fetch(uri)` to create a page from a remote document.
+
+    require 'harmony'
+
+    page = Harmony::Page.fetch('http://example.com')
+    page.execute_js('document.title') #=> "Example Web Page"
+
+`fetch` also accepts "file://" uris.
+
+Acknowledgement
+---------------
+
+Harmony is a thin DSL wrapper around three **amazing** libs, [Johnson][1],
+[env.js][30] and [Envjs][2] . The authors of those libs have been doing a huge
+amount of great work for quite a while, so please go recommend them on
+WorkingWithRails right now and/or follow them on github:
+
+  [jbarnette][3], [tenderlove][4], [smparkes][5], [wycats][6], [matthewd][7], [thatcher][8], [jeresig][9]
+
+Special thanks go to [smparkes][10] for his patient help, and for providing the
+last puzzle pieces that made [everything][12] [work][11] [together][13].
+
+Links
+-----
+* code: <http://github.com/mynyml/harmony>
+* docs: <http://yardoc.org/docs/mynyml-harmony>
+* wiki: <http://wiki.github.com/mynyml/harmony>
+* bugs: <http://github.com/mynyml/harmony/issues>
+
+
+
+YinYang ASCII art is © Normand Veilleux (nveilleuATemr1.emrDOTca)
+
+
+[1]:  http://github.com/jbarnette/johnson/
+[2]:  http://env-js.appspot.com/
+[3]:  http://www.workingwithrails.com/person/10668-john-barnette
+[4]:  http://github.com/tenderlove/
+[5]:  http://www.workingwithrails.com/person/11739-steven-parkes
+[6]:  http://www.workingwithrails.com/person/1805-yehuda-katz
+[7]:  http://www.workingwithrails.com/person/6221-matthew-draper
+[8]:  http://github.com/thatcher/
+[9]:  http://ejohn.org/
+[10]: http://github.com/smparkes/
+[11]: http://github.com/smparkes/env-js/commit/49abe259813a505b0761e6d31dde671344b5bc87#L0R279
+[12]: http://groups.google.com/group/envjs/msg/4ac719f7db7912f5
+[13]: http://gemcutter.org/gems/envjs
+[30]: http://github.com/thatcher/env-js

data/Rakefile

@@ -0,0 +1,39 @@
+def gem_opt
+  defined?(Gem) ? "-rubygems" : ""
+end
+
+# --------------------------------------------------
+# Tests
+# --------------------------------------------------
+task(:default => "test:all")
+
+namespace(:test) do
+
+  desc "Run all tests"
+  task(:all) do
+    exit system("ruby #{gem_opt} -I.:lib:test -e'%w( #{Dir['test/**/*_test.rb'].join(' ')} ).each {|p| require p }'")
+  end
+
+  desc "Run all tests on multiple ruby versions (requires rvm)"
+  task(:portability) do
+    versions = %w(  1.8.6  1.8.7  )
+    versions.each do |version|
+      system <<-BASH
+        bash -c 'source ~/.rvm/scripts/rvm;
+                 rvm use #{version};
+                 echo "--------- #{version} ----------";
+                 rake -s test:all'
+      BASH
+    end
+  end
+end
+
+# --------------------------------------------------
+# Docs
+# --------------------------------------------------
+desc "Generate YARD Documentation"
+task :yardoc do
+  require 'yard'
+  YARD::CLI::Yardoc.run *%w( --no-private --no-highlight -o doc/yard --readme README.md --markup markdown - LICENSE )
+end
+

data/docs.watchr

@@ -0,0 +1,25 @@
+# Run me with:
+#   $ watchr docs.watchr
+
+require 'yard'
+# --------------------------------------------------
+# Rules
+# --------------------------------------------------
+watch( 'lib/.*\.rb' ) { yard }
+watch( 'README.md'  ) { yard }
+
+# --------------------------------------------------
+# Signal Handling
+# --------------------------------------------------
+Signal.trap('QUIT') { yard        } # Ctrl-\
+Signal.trap('INT' ) { abort("\n") } # Ctrl-C
+
+# --------------------------------------------------
+# Helpers
+# --------------------------------------------------
+def yard
+  print "Updating yardocs... "; STDOUT.flush
+  YARD::CLI::Yardoc.run *%w( --no-private --no-highlight -o doc/yard --readme README.md --markup markdown - LICENSE )
+  print "done\n"
+end
+

data/harmony.gemspec

@@ -0,0 +1,18 @@
+require 'lib/harmony'
+
+Gem::Specification.new do |s|
+  s.name                = "harmony"
+  s.summary             = "Javascript + DOM in your ruby, the simple way"
+  s.description         = "yo dawg, i heard you liked developing web apps while using ruby on the cmd line, so i added javascript and a DOM in your ruby so you could js the dom without browser while you code in your editor"
+  s.author              = "mynyml"
+  s.email               = "mynyml@gmail.com"
+  s.homepage            = "http://github.com/mynyml/harmony"
+  s.rubyforge_project   = "harmony"
+  s.require_path        = "lib"
+  s.version             =  Harmony::VERSION
+  s.files               =  File.read("Manifest").strip.split("\n")
+
+  s.add_dependency 'johnson', '2.0.0.pre0'
+  s.add_dependency 'stackdeck' #johnson dependency
+  s.add_development_dependency 'minitest'
+end

data/lib/harmony.rb

@@ -0,0 +1,5 @@
+module Harmony
+  VERSION = '0.5'
+
+  autoload :Page, 'harmony/page'
+end

data/lib/harmony/page.rb

@@ -0,0 +1,123 @@
+require 'pathname'
+require 'tempfile'
+
+require 'johnson/tracemonkey'
+require  Pathname(__FILE__).dirname.parent.parent + 'vendor/envjs/lib/envjs/runtime'
+
+module Harmony
+  class Page
+
+    # Window factory
+    #
+    # @private
+    module Window #:nodoc:
+      extend self
+
+      # Cache the initial runtime. Parsing env.js (done automatically when
+      # Envjs::Runtime is extended) takes a while, so we only want to do this
+      # once.
+      #
+      # @private
+      BASE_RUNTIME = Johnson::Runtime.new
+      BASE_RUNTIME.extend(Envjs::Runtime)
+
+      def from_uri(uri)
+        BASE_RUNTIME.evaluate("window.open('#{uri}')")
+      end
+
+      def from_document(document)
+        Tempfile.open('harmony') {|f| f << document; @path = f.path }
+        from_uri("file://#{@path}")
+      end
+
+      def blank
+        from_uri('about:blank')
+      end
+    end
+
+    # Create page from remote document.
+    #
+    # @example
+    #
+    #     Page.fetch('http://montrealrb.org')
+    #     Page.fetch('http://localhost:3000')
+    #     Page.fetch('file:///home/mynyml/www/foo/index.html')
+    #
+    # @param [String] uri
+    #   uri to fetch document from
+    #
+    # @return [Page]
+    #   new page object preloaded with fetched document
+    #
+    def self.fetch(uri)
+      page = new
+      page.instance_variable_set(:@window, Window.from_uri(uri))
+      page
+    end
+
+    # Create new page containing given document.
+    #
+    # @param [String] document
+    #   HTML document. Defaults to an "about:blank" window, with the basic
+    #   structure: `<html><head><title></title></head><body></body></html>`
+    #
+    def initialize(document=nil)
+      @window = Window.from_document(document) if document
+    end
+
+    # Load a javascript file in page's context
+    #
+    # @param [String] path
+    #   path to js file
+    #
+    # @return [Page] self
+    #
+    def load(path)
+      window.load(path.to_s)
+      self
+    end
+
+    # Evaluate Javascript code within this page's context.
+    #
+    # @param [String] code
+    #   javascript code to execute
+    #
+    # @return [Object]
+    #   last javascript statement's value, cast to a ruby object
+    #
+    def execute_js(code)
+      window.evaluate(code)
+    end
+    alias :x :execute_js
+
+    # DOM document's `window` object. Equivalent to the return value of
+    # `page.execute_js('window')`
+    #
+    # @return [Object]
+    #   window DOM object
+    #
+    def window
+      @window ||= Window.blank
+    end
+
+    # Convenience method, equivalent to the return value of
+    # `page.execute_js('window.document')`
+    #
+    # @return [Object]
+    #   document DOM object
+    #
+    def document
+      window.document
+    end
+
+    # Page's document at current state
+    #
+    # @return [String]
+    #   document as string
+    #
+    def to_s
+      document.innerHTML
+    end
+  end
+end
+