bigpipe-rails 0.0.2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,20 @@
+source "http://rubygems.org"
+
+gem "rails", "3.1.0.rc4"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development, :test do
+  gem "sqlite3"
+  gem "rspec-rails"
+  gem "bundler"
+  gem "jeweler"
+  gem "guard-rspec"
+  gem "guard-coffeescript"
+  gem "ruby-debug19", :require => "ruby-debug"
+  gem 'mocha'
+  gem 'unicorn'
+  gem 'factory_girl_rails'
+  gem 'rails3-generators'
+  gem 'growl'
+end

data/Gemfile.lock

@@ -0,0 +1,160 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.1.0.rc4)
+      actionpack (= 3.1.0.rc4)
+      mail (~> 2.3.0)
+    actionpack (3.1.0.rc4)
+      activemodel (= 3.1.0.rc4)
+      activesupport (= 3.1.0.rc4)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.0)
+      rack-cache (~> 1.0.1)
+      rack-mount (~> 0.8.1)
+      rack-test (~> 0.6.0)
+      sprockets (~> 2.0.0.beta.10)
+      tzinfo (~> 0.3.27)
+    activemodel (3.1.0.rc4)
+      activesupport (= 3.1.0.rc4)
+      bcrypt-ruby (~> 2.1.4)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.0.rc4)
+      activemodel (= 3.1.0.rc4)
+      activesupport (= 3.1.0.rc4)
+      arel (~> 2.1.1)
+      tzinfo (~> 0.3.27)
+    activeresource (3.1.0.rc4)
+      activemodel (= 3.1.0.rc4)
+      activesupport (= 3.1.0.rc4)
+    activesupport (3.1.0.rc4)
+      multi_json (~> 1.0)
+    archive-tar-minitar (0.5.2)
+    arel (2.1.3)
+    bcrypt-ruby (2.1.4)
+    builder (3.0.0)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.1.1)
+    columnize (0.3.4)
+    diff-lcs (1.1.2)
+    erubis (2.7.0)
+    execjs (1.2.0)
+      multi_json (~> 1.0)
+    factory_girl (2.0.1)
+    factory_girl_rails (1.1.0)
+      factory_girl (~> 2.0.0)
+      railties (>= 3.0.0)
+    git (1.2.5)
+    growl (1.0.3)
+    guard (0.5.1)
+      thor (~> 0.14.6)
+    guard-coffeescript (0.3.1)
+      coffee-script (>= 2.2.0)
+      guard (>= 0.4)
+    guard-rspec (0.4.0)
+      guard (>= 0.4.0)
+    hike (1.2.0)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    kgio (2.6.0)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    mail (2.3.0)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    mocha (0.9.12)
+    multi_json (1.0.3)
+    polyglot (0.3.1)
+    rack (1.3.1)
+    rack-cache (1.0.2)
+      rack (>= 0.4)
+    rack-mount (0.8.1)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.0)
+      rack (>= 1.0)
+    rails (3.1.0.rc4)
+      actionmailer (= 3.1.0.rc4)
+      actionpack (= 3.1.0.rc4)
+      activerecord (= 3.1.0.rc4)
+      activeresource (= 3.1.0.rc4)
+      activesupport (= 3.1.0.rc4)
+      bundler (~> 1.0)
+      railties (= 3.1.0.rc4)
+    rails3-generators (0.17.4)
+      railties (>= 3.0.0)
+    railties (3.1.0.rc4)
+      actionpack (= 3.1.0.rc4)
+      activesupport (= 3.1.0.rc4)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    raindrops (0.7.0)
+    rake (0.9.2)
+    rdoc (3.8)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    rspec-rails (2.6.1)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.6.0)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    sprockets (2.0.0.beta.10)
+      hike (~> 1.0)
+      rack (~> 1.0)
+      tilt (!= 1.3.0, ~> 1.1)
+    sqlite3 (1.3.3)
+    thor (0.14.6)
+    tilt (1.3.2)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.29)
+    unicorn (4.0.1)
+      kgio (~> 2.4)
+      rack
+      raindrops (~> 0.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  factory_girl_rails
+  growl
+  guard-coffeescript
+  guard-rspec
+  jeweler
+  mocha
+  rails (= 3.1.0.rc4)
+  rails3-generators
+  rspec-rails
+  ruby-debug19
+  sqlite3
+  unicorn

data/Guardfile

@@ -0,0 +1,21 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('spec/spec_helper.rb')                        { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end
+
+guard 'coffeescript', :input => 'assets'

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Dan Langevin
+
+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/README.rdoc

@@ -0,0 +1,19 @@
+= bigpipe_rails
+
+Description goes here.
+
+== Contributing to bigpipe_rails
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Dan Langevin. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "bigpipe-rails"
+  gem.homepage = "http://github.com/dlangevin/bigpipe-rails"
+  gem.license = "MIT"
+  gem.summary = %Q{Rails Engines Plugin to provide BigPipe functionality}
+  gem.description = %Q{Takes advantage of context switching and provides in Rails 3.1}
+  gem.email = "dan.langevin@gmail.com"
+  gem.authors = ["Dan Langevin"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "bigpipe_rails #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/assets/bigpipe.coffee

@@ -0,0 +1,150 @@
+# Bigpipe - singleton/factory for PageletResources and Pagelets
+class Bigpipe
+  # set up our instance variables to hold the CSS/JS PageletResources
+  constructor : ()->
+    @css = {}
+    @js = {}
+    @pagelets = []
+  
+  # add a Pagelet to the stack, the Pagelet takes care of its own loading
+  add_pagelet : (data)=>
+    @pagelets.push(new Pagelet(data))
+
+  # some Pagelets will need the same css/js before initializing, make sure that
+  # we only load each resource once
+  get_resource : (file, type)=>
+    if type == "css"
+      @css[file] ?= new CssResource(file)
+      return @css[file]
+    else if type == "js"
+      @js[file] ?= new JsResource(file)
+      return @js[file]
+       
+# Load a resource
+# Loading has 3 phases
+# 0 - not on the page
+# 1 - on the page but not finished loading
+# 2 - loaded
+class PageletResource
+  # get the file name and set load_phase to 0 (not started)
+  constructor : (file_name)->
+    @load_phase = 0
+    @file_name = file_name
+  # if load_phase is 2, we have completed loading
+  loaded : ()->
+    @load_phase == 2
+  # only call this once, we set load phase to 1 when the element is created
+  # and add a listener to the element's 'ready' callback to set it to 2
+  load : ()->
+    return if @load_phase > 0
+    @load_phase = 1
+    # handled in the subclass
+    this.create_element()
+    @el.ready(()=>
+      this.load_phase = 2
+    )
+    this
+    
+# concrete implementation for CSS
+class CssResource extends PageletResource
+  create_element : ()->
+    @el = $j(document.createElement('link'))
+    @el.attr('rel', 'stylesheet').attr('href', "#{@file_name}.css")
+    @el
+
+# concrete implementation for JS
+class JsResource extends PageletResource
+  create_element : ()->
+    @el = $j(document.createElement('script'))
+    @el.attr('type', 'text/javascript').attr('src', "#{@file_name}.js")
+    @el
+  
+# a Pagelet is a composed of a container element, some HTML content and resources
+# the order is as follows
+# 1 - initialize Pagelet giving it the paths of its resources, its container, its content and any callbacks
+# 2 - load all of the CSS, checking back every 20ms to see if the loading is complete
+# 3 - put the HTML on the page
+# 4 - load all of the JS, checking back every 20ms to see if the loading is complete
+# 5 - call the on_load callback
+class Pagelet
+  # constructor data
+  # - container - jQuery selector of the container to populate
+  # - content - HTML content to put in the container
+  # - css - Array of css files to load
+  # - js - Array of js files to load
+  # - append - Option to append the content to the container rather than replace its HTML
+  constructor : (data)->
+    @container = data.container
+    @content = data.content
+    @append = data.append || false
+    @css_resources = []
+    @js_resources = []
+    @on_load = data.on_load ? ()->
+    this.init_resources(data)
+    this.load_css()
+  # use Bigpipe's factory method to find or create the js and css resources
+  init_resources : (data)->
+    $j.each((data['css'] || []),(i, file)=>
+      this.css_resources.push(window.Bigpipe.get_resource(file, 'css'))
+    )
+    $j.each((data['js'] || []),(i, file)=>
+      this.js_resources.push(window.Bigpipe.get_resource(file, 'js'))
+    )
+  # first phase - load the css files
+  load_css : ()->
+    this.add_css()
+    # keep trying every 20ms til the loading of the CSS is complete
+    # TODO: this will lock up a browser if the CSS is never found - make sure to take care of that
+    unless this.css_loaded()
+      setTimeout(()=>
+        this.load_css()
+      , 20)
+    else
+      # once we've loaded the CSS, we move on to the HTML and JS
+      this.add_html()
+      this.load_js()
+  
+  # final phase - load the js 
+  # TODO: maybe make this before the HTML and use on_load to initialize
+  # listeners?
+  load_js : ()->
+    this.add_js()
+    unless this.js_loaded()
+      setTimeout(()=>
+        this.load_js()
+      ,20)
+    else
+      this.on_load()
+  # check to seee if all of the css resources are loaded  
+  css_loaded : ()->
+    loaded = true
+    $j.each(@css_resources, (i, resource)->
+      loaded = (loaded && resource.loaded())
+    )
+    return loaded
+  # check to see if all of the js resources are loaded
+  js_loaded : ()->
+    loaded = true
+    $j.each(@js_resources, (i, resource)->
+      loaded = (loaded && resource.loaded())
+    )
+    return loaded
+  # add and load a js resource
+  add_js : ()->
+    $j.each(@js_resources, (i, resource)->
+      resource.load()
+    )
+  # add and load a css resource
+  add_css : ()->
+    $j.each(@css_resources, (i, resource)->
+      resource.load()
+    )
+  # add htmlt to the container - replacing or appending as appropriate
+  add_html : ()->
+    unless @append
+      $j(@container).html(@content)
+    else
+      $j(@container).append(@content)
+
+this.$j = jQuery.noConflict()
+this.Bigpipe = new Bigpipe()