RubyGems - kuntoaji-harmony - Versions diffs - 0.5.7 → 0.5.8 - Mend

kuntoaji-harmony 0.5.7 → 0.5.8

Files changed (8) hide show

data/README.md CHANGED Viewed

@@ -1,4 +1,4 @@
-Harmony
+Harmony - the memory reduced version ...
 =======
                        .,ad88888888baa,
@@ -21,89 +21,19 @@ Harmony
                     ""88888888888888888P"
                          """"""""""""
-Summary
+Why this new version of an already great gem?
 -------
-Harmony provides a simple DSL to execute javascript + DOM code within ruby.
+We, at Cohuman, have been using Harmony in our Rspec text suite for javascript unit testing. For performance reasons, the original Harmony gem instantiated one Johnson js runtime per Harmony universe. Envjs was loaded into the runtime once and then each page was instantiated and loaded into this singleton runtime. This lead to a memory explosion since none of the pages created in our test suite are released until the entire suite finished running. Our 700 tests were taking over a gig of memory :(
-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"
+This is an experimental version of Harmony that instantiates a new Johnson runtime with Envjs for each page created. This means that we maintain the unit test isolation that Harmony pages provide while allowing each page to be garbage collected after the test is run. The penalty is, of course, performance. Creating a new Johnson runtime and loading it with the Envjs methods takes time.
-### Fetching Documents
+Ideally, Harmony should allow configuration for performance or memory optimization. Should there be demand we will make it happen!
-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.
+Get the original, and learn more about the API
+--------
+http://github.com/mynyml/harmony
 Install
 -------
@@ -113,50 +43,8 @@ Install
     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
+		# download this version of the gem and install it manually:
+    git clone http://github.com/baccigalupi/harmony.git
+		cd harmony
+		sudo rake install

data/Rakefile CHANGED Viewed

@@ -8,10 +8,21 @@ end
 # --------------------------------------------------
 # Tests
 # --------------------------------------------------
-task(:default => "test:all")
-namespace(:test) do
+# new rspec version
+begin
+  require 'spec/rake/spectask'
+  Spec::Rake::SpecTask.new(:spec) do |spec|
+    spec.libs << 'lib' << 'spec'
+    spec.spec_files = FileList['spec/**/*_spec.rb']
+  end
+  task :default => :spec
+rescue
+  task :default => "test:all"
+end
+# original minitest version
+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 }'")

data/harmony.gemspec CHANGED Viewed

@@ -6,11 +6,11 @@ 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.authors     = ["mynyml", "Kunto Aji Kristianto", "baccigalupi"]
+  s.email       = ["mynyml@gmail.com", "kunto.aji.kr@gmail.com", "baccigalupi@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.description = %q{Javascript + DOM in your ruby, the simple way. More memory sensitive based on baccigalupi's repos. Kuntoaji's version.}
   #s.rubyforge_project = ""

data/lib/harmony/page.rb CHANGED Viewed

@@ -1,40 +1,20 @@
 require 'pathname'
 require 'tempfile'
+require 'forwardable'
 require 'johnson/tracemonkey'
 require 'envjs/runtime'
 module Harmony
   class Page
-    # Window factory
+    # DOM document's `window` object. Equivalent to the return value of
+    # `page.execute_js('window')`
     #
-    # @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
+    # @return [Object]
+    #   window DOM object
+    #
+    attr_reader :window
     # Create page from remote document.
     #
     # @example
@@ -51,7 +31,7 @@ module Harmony
     #
     def self.fetch(uri)
       page = new
-      page.instance_variable_set(:@window, Window.from_uri(uri))
+      page.window.open(uri)
       page
     end
@@ -62,7 +42,7 @@ module Harmony
     #   structure: `<html><head><title></title></head><body></body></html>`
     #
     def initialize(document=nil)
-      @window = Window.from_document(document) if document
+      @window = document ? Window.from_document(document) : Window.blank
     end
     # Load one or more javascript files in page's context
@@ -93,16 +73,6 @@ module Harmony
     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')`
     #
@@ -120,6 +90,47 @@ module Harmony
     def to_html
       document.innerHTML
     end
+    # Window factory
+    #
+    # @private
+    class Window
+      extend Forwardable
+      attr_reader :run_time
+      def_delegators :@run_time, :evaluate, :load
+      def_delegators :@browser, :document
+      def initialize(uri='about:blank')
+        open(uri)
+      end
+      def run_time
+        unless @run_time
+          @run_time = Johnson::Runtime.new
+          @run_time.extend Envjs::Runtime
+        end
+        @run_time
+      end
+      def open(uri)
+        @browser = run_time.evaluate("window.open('#{uri}')")
+        run_time
+      end
+      def self.from_uri(uri)
+        new(uri)
+      end
+      def self.from_document(document)
+        Tempfile.open('harmony') {|f| f << document; @path = f.path }
+        new("file://#{@path}")
+      end
+      def self.blank
+        new
+      end
+    end
   end
 end

data/lib/harmony/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Harmony
-  VERSION = "0.5.7"
+  VERSION = "0.5.8"
 end

data/spec/page_spec.rb ADDED Viewed

@@ -0,0 +1,142 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+Page = Harmony::Page unless defined?( Page )
+describe Harmony::Page do
+  before do
+    @blank = Page.new
+  end
+  describe 'api' do
+    CLASS_METHODS =    [:fetch, :new]
+    INSTANCE_METHODS = [:window, :document, :execute_js, :x]
+    CLASS_METHODS.each do |page_method|
+      it "Page should respond to #{page_method}" do
+        Page.should respond_to(page_method)
+      end
+    end
+    INSTANCE_METHODS.each do |page_method|
+      it "Page instance should respond to #{page_method}" do
+        @blank.should respond_to(page_method)
+      end
+    end
+    it 'Page.document should be a shortcut for Page.window.document' do
+      window = mock('Window')
+      @blank.should_receive(:window).and_return(window)
+      window.should_receive(:document)
+      @blank.document
+    end
+  end
+  describe 'execution' do
+    it 'performs basic js' do
+      @blank.x('5+2').should == 7
+    end
+    it 'executes DOM-accessing js' do
+      page = Page.new(<<-HTML)
+        <html>
+          <head>
+            <title>Harmony</title>
+          </head>
+          <body>
+            <div></div>
+            <div></div>
+          </body>
+        </html>
+      HTML
+      page.document.title.should == 'Harmony'
+      (page.x(<<-JS)
+        document.getElementsByTagName('div').length
+      JS
+      ).should == 2
+    end
+  end
+  describe 'basic characteristics' do
+    it "Page fetches documents from remote locations" do
+      path = tempfile(<<-HTML)
+        <html><head><title>foo</title></head><body></body></html>
+      HTML
+      page = Page.fetch("file://#{path}")
+      page.document.title.should == 'foo'
+    end
+    describe 'default empty page' do
+      it "has no title" do
+        @blank.document.title.should be_empty
+      end
+      it '#to_html should produce an empty document' do
+        @blank.to_html.should == "<html><head><title></title></head><body></body></html>"
+      end
+    end
+  end
+  describe 'loading js files' do
+    it "works with one one path" do
+      path = tempfile(<<-JS)
+        function foo() { return 'bar' };
+      JS
+      page = Page.new.load(path)
+      page.x('foo()').should == 'bar'
+    end
+    it "takes an array of paths" do
+      paths = []
+      paths << tempfile(<<-JS)
+        function foo() { return 'bar' };
+      JS
+      paths << tempfile(<<-JS)
+        function moo() { return 'boo' };
+      JS
+      page = Page.new.load(paths)
+      page.x('foo()').should == 'bar'
+      page.x('moo()').should == 'boo'
+    end
+    it "can load multiple files with splat" do
+      paths = []
+      paths << tempfile(<<-JS)
+        function foo() { return 'bar' };
+      JS
+      paths << tempfile(<<-JS)
+        function moo() { return 'boo' };
+      JS
+      page = Page.new.load(*paths)
+      page.x('foo()').should == 'bar'
+      page.x('moo()').should == 'boo'
+    end
+  end
+  describe 'document context' do
+    it 'should use a different window for each page' do
+      @blank.window.should_not === Page.new.window
+    end
+    it 'should use a different runtime for each page' do
+      @blank.window.run_time.should_not === Page.new.window.run_time
+    end
+    it 'should keep a window/browser run time within the same page' do
+      @blank.window.run_time.should == @blank.window.run_time
+    end
+  end
+  def tempfile(content)
+    Tempfile.open('abc') do |f|
+      f << content
+      @__path = f.path
+    end
+    @__path
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,8 @@
+require 'rubygems'
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'harmony'
+require 'spec'
+Spec::Runner.configure do |config|
+end

metadata CHANGED Viewed

@@ -1,22 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: kuntoaji-harmony
 version: !ruby/object:Gem::Version
-  hash: 5
+  hash: 27
   prerelease:
   segments:
   - 0
   - 5
-  - 7
-  version: 0.5.7
+  - 8
+  version: 0.5.8
 platform: ruby
 authors:
 - mynyml
 - Kunto Aji Kristianto
+- baccigalupi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-02-03 00:00:00 +07:00
+date: 2011-02-20 00:00:00 +07:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -67,10 +68,11 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
-description: Javascript + DOM in your ruby, the simple way. Kuntoaji's version.
+description: Javascript + DOM in your ruby, the simple way. More memory sensitive based on baccigalupi's repos. Kuntoaji's version.
 email:
 - mynyml@gmail.com
 - kunto.aji.kr@gmail.com
+- baccigalupi@gmail.com
 executables: []
 extensions: []
@@ -89,6 +91,8 @@ files:
 - lib/harmony.rb
 - lib/harmony/page.rb
 - lib/harmony/version.rb
+- spec/page_spec.rb
+- spec/spec_helper.rb
 - specs.watchr
 - test/harmony_test.rb
 - test/page_test.rb
@@ -128,6 +132,8 @@ signing_key:
 specification_version: 3
 summary: Javascript + DOM in your ruby, the simple way
 test_files:
+- spec/page_spec.rb
+- spec/spec_helper.rb
 - test/harmony_test.rb
 - test/page_test.rb
 - test/test_helper.rb