RubyGems - kuntoaji-harmony - Versions diffs - 0.5.6 - Mend

kuntoaji-harmony 0.5.6

Files changed (16) hide show

data/.gitignore ADDED Viewed

@@ -0,0 +1,12 @@
+pkg/*
+*.gem
+.bundle
+.yardoc/
+doc/
+TODO
+.yard_issues.md
+sanity_check.rb
+*.swp
+*.swo
+*~
+Gemfile.lock

data/Gemfile ADDED Viewed

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+# Specify your gem's dependencies in mygem.gemspec
+gemspec

data/LICENSE ADDED Viewed

@@ -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 ADDED Viewed

@@ -0,0 +1,13 @@
+.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

data/README.md ADDED Viewed

@@ -0,0 +1,162 @@
+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.
+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.
+Install
+-------
+    # There's a gem dependency bug in rubygems currently, so we'll have to
+    # install some dependencies manually. This will be fixed soon.
+    gem install stackdeck
+    gem install johnson -v "2.0.0.pre3"
+    gem install harmony
+See Also
+--------
+* [holygrail][20]: Harmony plugin for Rails tests
+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
+[20]: http://github.com/mynyml/holygrail
+[30]: http://github.com/thatcher/env-js

data/Rakefile ADDED Viewed

@@ -0,0 +1,41 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "harmony/version"
+Gem::Specification.new do |s|
+  s.name        = "kuntoaji-harmony"
+  s.version     = Harmony::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["mynyml", "Kunto Aji Kristianto"]
+  s.email       = ["mynyml@gmail.com", "kunto.aji.kr@gmail.com"]
+  s.homepage    = "http://github.com/kuntoaji/harmony"
+  s.summary     = %q{Javascript + DOM in your ruby, the simple way}
+  s.description = %q{Javascript + DOM in your ruby, the simple way. Kuntoaji's version.}
+  #s.rubyforge_project = ""
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_dependency 'johnson', '2.0.0.pre3'
+  s.add_dependency 'envjs', '0.3.7'
+  s.add_development_dependency 'minitest'
+end

data/lib/harmony.rb ADDED Viewed

@@ -0,0 +1,4 @@
+module Harmony
+  require 'harmony/version'
+  autoload :Page, 'harmony/page'
+end

data/lib/harmony/page.rb ADDED Viewed

@@ -0,0 +1,125 @@
+require 'pathname'
+require 'tempfile'
+require 'johnson/tracemonkey'
+require '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 one or more javascript files in page's context
+    #
+    # @param [#to_s, #to_s, ...] paths
+    #   paths to js file
+    # @return [Page] self
+    #
+    def load(*paths)
+      paths.flatten.each do |path|
+        path.to_s.map {|f|
+          window.evaluate(File.read(f).gsub(/\A#!.*$/, ''), f, 1)
+        }.last
+      end
+      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 as html document
+    #
+    # @return [String] html
+    #
+    def to_html
+      document.innerHTML
+    end
+  end
+end

data/lib/harmony/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Harmony
+  VERSION = "0.5.6"
+end

data/specs.watchr ADDED Viewed

@@ -0,0 +1,36 @@
+# Run me with:
+#   $ watchr specs.watchr
+# --------------------------------------------------
+# Rules
+# --------------------------------------------------
+watch( '^test.*/.*_test\.rb'   )  {|m| ruby m[0] }
+watch( '^lib/(.*)\.rb'         )  {|m| ruby "test/#{m[1]}_test.rb" }
+watch( '^lib/harmony/(.*)\.rb' )  {|m| ruby "test/#{m[1]}_test.rb" }
+watch( '^test/test_helper\.rb' )  { ruby tests }
+# --------------------------------------------------
+# Signal Handling
+# --------------------------------------------------
+Signal.trap('QUIT') { ruby tests  } # Ctrl-\
+Signal.trap('INT' ) { abort("\n") } # Ctrl-C
+# --------------------------------------------------
+# Helpers
+# --------------------------------------------------
+def ruby(*paths)
+  run "ruby #{gem_opt} -I.:lib:test -e'%w( #{paths.flatten.join(' ')} ).each {|p| require p }'"
+end
+def tests
+  Dir['test/**/*_test.rb']
+end
+def run( cmd )
+  puts   cmd
+  system cmd
+end
+def gem_opt
+  defined?(Gem) ? "-rubygems" : ""
+end

data/test/harmony_test.rb ADDED Viewed

@@ -0,0 +1,8 @@
+require 'test/test_helper'
+class HarmonyTest < MiniTest::Unit::TestCase
+  test "version" do
+    refute_nil Harmony::VERSION
+  end
+end

data/test/page_test.rb ADDED Viewed

@@ -0,0 +1,101 @@
+require 'test/test_helper'
+class PageTest < MiniTest::Unit::TestCase
+  include Harmony
+  PAGE = Page.new
+  test "api" do
+    assert_respond_to Page, :fetch
+    assert_respond_to Page, :new
+    assert_respond_to PAGE, :window
+    assert_respond_to PAGE, :document
+    assert_respond_to PAGE, :execute_js
+    assert_respond_to PAGE, :x
+    assert_respond_to PAGE, :to_s
+  end
+  test "document shortcut" do
+    assert_equal PAGE.window.document, PAGE.document
+  end
+  test "executes javascript" do
+    assert_equal 7, PAGE.x('5+2')
+  end
+  test "excutes DOM-accessing javascript" do
+    page = Page.new(<<-HTML)
+      <html>
+        <head>
+          <title>Harmony</title>
+        </head>
+        <body>
+          <div></div>
+          <div></div>
+        </body>
+      </html>
+    HTML
+    assert_equal 'Harmony', page.document.title
+    assert_equal 2, page.x(<<-JS)
+      document.getElementsByTagName('div').length
+    JS
+  end
+  test "fetches remote document" do
+    path = tempfile(<<-HTML)
+      <html><head><title>foo</title></head><body></body></html>
+    HTML
+    page = Page.fetch("file://#{path}")
+    assert_equal 'foo', page.document.title
+  end
+  test "default window" do
+    assert_empty Page.new.document.title
+  end
+  test "cast to html" do
+    assert_equal "<html><head><title></title></head><body></body></html>", Page.new.to_html
+  end
+  test "loads javascript file" do
+    path = tempfile(<<-HTML)
+      function foo() { return 'bar' };
+    HTML
+    page = Page.new.load(path)
+    assert_equal 'bar', page.x('foo()')
+  end
+  test "can load multiple files as array" do
+    paths = []
+    paths << tempfile(<<-HTML)
+      function foo() { return 'bar' };
+    HTML
+    paths << tempfile(<<-HTML)
+      function moo() { return 'boo' };
+    HTML
+    page = Page.new.load(paths)
+    assert_equal 'bar', page.x('foo()')
+    assert_equal 'boo', page.x('moo()')
+  end
+  test "can load multiple files as splat" do
+    paths = []
+    paths << tempfile(<<-HTML)
+      function foo() { return 'bar' };
+    HTML
+    paths << tempfile(<<-HTML)
+      function moo() { return 'boo' };
+    HTML
+    page = Page.new.load(*paths)
+    assert_equal 'bar', page.x('foo()')
+    assert_equal 'boo', page.x('moo()')
+  end
+  private
+    def tempfile(content)
+      Tempfile.open('abc') {|f| f << content; @__path = f.path }
+      @__path
+    end
+end

data/test/test_helper.rb ADDED Viewed

@@ -0,0 +1,13 @@
+require 'minitest/autorun'
+begin require 'ruby-debug'; rescue LoadError; end
+begin require 'redgreen'  ; rescue LoadError; end
+begin require 'phocus'    ; rescue LoadError; end
+require 'lib/harmony'
+class MiniTest::Unit::TestCase
+  def self.test(name, &block)
+    define_method("test_#{name}".gsub(/\s/,'_'), &block)
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: kuntoaji-harmony
+version: !ruby/object:Gem::Version
+  hash: 7
+  prerelease:
+  segments:
+  - 0
+  - 5
+  - 6
+  version: 0.5.6
+platform: ruby
+authors:
+- mynyml
+- Kunto Aji Kristianto
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-02-03 00:00:00 +07:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: johnson
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - "="
+      - !ruby/object:Gem::Version
+        hash: -223651601
+        segments:
+        - 2
+        - 0
+        - 0
+        - pre
+        - 3
+        version: 2.0.0.pre3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: envjs
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - "="
+      - !ruby/object:Gem::Version
+        hash: 29
+        segments:
+        - 0
+        - 3
+        - 7
+        version: 0.3.7
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency
+  name: minitest
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 3
+        segments:
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Javascript + DOM in your ruby, the simple way. Kuntoaji's version.
+email:
+- mynyml@gmail.com
+- kunto.aji.kr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- Manifest
+- README.md
+- Rakefile
+- docs.watchr
+- harmony.gemspec
+- lib/harmony.rb
+- lib/harmony/page.rb
+- lib/harmony/version.rb
+- specs.watchr
+- test/harmony_test.rb
+- test/page_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/kuntoaji/harmony
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project:
+rubygems_version: 1.4.2
+signing_key:
+specification_version: 3
+summary: Javascript + DOM in your ruby, the simple way
+test_files:
+- test/harmony_test.rb
+- test/page_test.rb
+- test/test_helper.rb