architect 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a8eaf51e9027f92886fc6f7a80a32962314d6b3
+  data.tar.gz: c9e08da85647823e5191dcbf95d0efa5e82eef14
+SHA512:
+  metadata.gz: 5e01127c50ab864af2b781d6ee9a8d54fb2dbdc639a9857a8ef711ce06e6d86883e51a42e6c1b2f17e665941a819743c991ee3d6a3fcb910d6426b2a62ec1dd9
+  data.tar.gz: 03257ade602761acedb3c484973aba2a436daeeefe761f65bfe60a9f041557d969690338947f451ac57c2c3e594b1f01045ec189e8edb9bb839419b1c4937049

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Etienne Lemay
+
+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.md

@@ -0,0 +1,59 @@
+**Architect** is a JavaScript library built on top of [Web Workers][].<br>
+He will manage them workers so you don’t have to.
+
+## Methods
+### proxy
+Returns anything it receives in a background process. Useful when dealing with heavy DOM manipulation (i.e. Infinite scroll). It greatly improves initial page load speed, especially on mobiles.
+
+```js
+images = ['foo.png', 'bar.png', 'twiz.png', 'foozle.png', 'barzle.png', 'twizle.png']
+Architect.proxy(images, function(data) {
+  console.log(data)
+  // => ['foo.png', 'bar.png', 'twiz.png', 'foozle.png', 'barzle.png', 'twizle.png']
+
+  data.forEach(function(image) {
+    img = document.createElement('img')
+    img.src = image
+
+    document.body.appendChild(img)
+  })
+})
+```
+
+### ajax
+Makes an Ajax request in a background process.
+
+```js
+Architect.ajax('/users/1', function(data) {
+  console.log(data);
+  // => { id: 1, name: 'Foo', email: 'foo@bar.com' }
+})
+```
+
+### jsonp
+Makes a JSONP request in a background process. **Do not add `?callback=foo` to your URL**, Architect will handle JSONP callbacks himself.
+
+```js
+Architect.jsonp('https://api.github.com/users/etiennelem', function(data) {
+  console.log(data);
+  // => { meta: { status: 200, … }, data: { login: 'EtienneLem', company: 'Heliom', … } }
+})
+```
+
+See the [request Architect makes](https://api.github.com/users/etiennelem?callback=architect_jsonp).
+
+## Setup
+### Rails
+1. Add `gem 'architect'` to your Gemfile.
+2. Add `//= require architect` to your JavaScript manifest file (usually found at `app/assets/javascripts/application.js`).
+3. Restart your server and you'll have access to your very own Architect!
+
+### Other
+You’ll need to serve the [worker files](/static/workers) at `/architect` (i.e. `http://foo.com/architect/proxy_worker.min.js`) and manually add [architect.min.js](/static/architect.min.js) to your HTML page.
+
+## Todo
+- A way to reuse the same worker (and stop it)
+- Support [Shared workers][]
+
+[Web Workers]: http://www.whatwg.org/specs/web-apps/current-work/multipage/workers.html
+[Shared workers]: http://www.whatwg.org/specs/web-apps/current-work/multipage/workers.html#shared-workers

data/Rakefile

@@ -0,0 +1,27 @@
+$:.unshift File.join(File.dirname(__FILE__), *%w[lib])
+require 'tasks/task_helpers'
+
+require 'uglifier'
+require 'architect'
+require 'sprockets'
+
+desc 'Merge, compiles and minify CoffeeScript files'
+task :compile do
+  @environment = Sprockets::Environment.new
+  @environment.append_path 'app/assets/javascripts'
+  @environment.js_compressor = Uglifier.new(mangle: true)
+
+  compile('architect.js')
+  compile('workers/proxy_worker.js')
+  compile('workers/ajax_worker.js')
+  compile('workers/jsonp_worker.js')
+end
+
+task :default => :compile
+
+def compile(file)
+  minjs = @environment[file].to_s
+  out = "static/#{file.sub('.js', '.min.js')}"
+  File.open(out, 'w') { |f| f.write(minjs) }
+  success "Compiled #{out}"
+end

data/app/assets/javascripts/architect/version.coffee.erb

@@ -0,0 +1,5 @@
+Architect = {}
+Architect.VERSION = '<%= Architect::VERSION %>'
+
+# Global scope
+window.Architect = Architect

data/app/assets/javascripts/architect/worker.coffee

@@ -0,0 +1,29 @@
+#= require_self
+#= require_tree ./workers
+
+class Architect.Worker
+
+  constructor: ->
+    @callbacks = {}
+    @callbacksQueue = {}
+
+  addEventListener: (type, callback) ->
+    @callbacks[type] = callback
+
+    return unless data = @callbacksQueue[type]
+    delete @callbacksQueue[type]
+    this.dispatch(type, data)
+
+  dispatch: (type, data) ->
+    if @callbacks[type]
+      @callbacks[type]({data: data})
+    else
+      @callbacksQueue[type] = data
+
+  handleRequest: (data) ->
+    this.dispatch('message', data)
+
+  terminate: -> # This is meant to be empty
+
+# Global scope
+window.Architect.Worker = Architect.Worker

data/app/assets/javascripts/architect/workers/ajax_worker.coffee

@@ -0,0 +1,14 @@
+class Architect.AjaxWorker extends Architect.Worker
+
+  postMessage: (url) ->
+    xhr = new XMLHttpRequest
+    xhr.open('GET', url)
+
+    xhr.onreadystatechange = (e) =>
+      return unless xhr.readyState is 4 && xhr.status is 200
+      this.handleRequest(xhr.responseText)
+
+    xhr.send()
+
+# Global scope
+window.Architect.AjaxWorker = Architect.AjaxWorker

data/app/assets/javascripts/architect/workers/jsonp_worker.coffee

@@ -0,0 +1,24 @@
+class Architect.JSONPWorker extends Architect.Worker
+
+  constructor: ->
+    super()
+    @jsonpID = 0
+
+  postMessage: (url) ->
+    tmpScript = document.createElement('script')
+
+    callbackName = 'architect_jsonp' + (++@jsonpID)
+    window[callbackName] = (data) =>
+      delete window[callbackName]
+      document.head.removeChild(tmpScript)
+
+      this.handleRequest(data)
+
+    tmpScript.src = this.appendQuery(url, "callback=#{callbackName}")
+    document.head.appendChild(tmpScript)
+
+  appendQuery: (url, query) ->
+    (url + '&' + query).replace(/[&?]{1,2}/, '?')
+
+# Global scope
+window.Architect.JSONPWorker = Architect.JSONPWorker

data/app/assets/javascripts/architect/workers/proxy_worker.coffee

@@ -0,0 +1,7 @@
+class Architect.ProxyWorker extends Architect.Worker
+
+  postMessage: (data) ->
+    this.handleRequest(data)
+
+# Global scope
+window.Architect.ProxyWorker = Architect.ProxyWorker

data/app/assets/javascripts/architect.coffee.erb

@@ -0,0 +1,37 @@
+#= require ./architect/version
+#= require ./architect/worker
+
+class _Architect
+
+  constructor: ->
+    @VERSION = Architect.VERSION
+
+    @SUPPORT_WORKER = !!window.Worker
+    @WORKERS =
+      proxy: { class: Architect.ProxyWorker, workerPath: '<%= Architect.worker_path("proxy") %>' }
+      ajax:  { class: Architect.AjaxWorker,  workerPath: '<%= Architect.worker_path("ajax") %>'  }
+      jsonp: { class: Architect.JSONPWorker, workerPath: '<%= Architect.worker_path("jsonp") %>' }
+
+  proxy: (data, callback) -> this.work(data, 'proxy', callback)
+  ajax:  (url,  callback) -> this.work(url,  'ajax',  callback)
+  jsonp: (url,  callback) -> this.work(url,  'jsonp', callback)
+
+  work: (data, type, callback) ->
+    if typeof type is 'function'
+      callback = type
+      type = undefined
+
+    type = 'proxy' if type is undefined
+
+    worker = this.spawnWorker(type)
+    worker.postMessage(data)
+    worker.addEventListener 'message', (e) =>
+      worker.terminate()
+      callback(e.data)
+
+  spawnWorker: (type) ->
+    return new @WORKERS[type].class unless @SUPPORT_WORKER
+    worker = new Worker(@WORKERS[type].workerPath)
+
+# Singleton
+window.Architect = new _Architect

data/app/assets/javascripts/workers/ajax_worker.coffee

@@ -0,0 +1,11 @@
+handleRequest = (data) ->
+  postMessage(data)
+
+addEventListener 'message', (e) ->
+  xhr = new XMLHttpRequest
+  xhr.open('GET', e.data)
+  xhr.onreadystatechange = (e) ->
+    return unless xhr.readyState is 4 && xhr.status is 200
+    handleRequest(xhr.responseText)
+
+  xhr.send()

data/app/assets/javascripts/workers/jsonp_worker.coffee

@@ -0,0 +1,9 @@
+self.handleRequest = (data) ->
+  postMessage(data)
+
+appendQuery = (url, query) ->
+  (url + '&' + query).replace(/[&?]{1,2}/, '?')
+
+addEventListener 'message', (e) ->
+  url = appendQuery(e.data, 'callback=handleRequest')
+  importScripts(url)

data/app/assets/javascripts/workers/proxy_worker.coffee

@@ -0,0 +1,2 @@
+addEventListener 'message', (e) ->
+  postMessage(e.data)

data/lib/architect/engine.rb

@@ -0,0 +1,4 @@
+module Architect
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/architect/helpers.rb

@@ -0,0 +1,12 @@
+module Architect
+  def self.worker_path(type)
+    worker_filename = "#{type}_worker.js"
+    return "architect/#{worker_filename.sub('.js', '.min.js')}" unless defined?(Rails)
+
+    # Cacheable digest path on main domain because of same-origin policy
+    File.join(
+      Rails.application.config.assets.prefix,
+      Rails.application.assets["workers/#{worker_filename}"].digest_path
+    )
+  end
+end

data/lib/architect/version.rb

@@ -0,0 +1,3 @@
+module Architect
+  VERSION = '0.0.1'
+end

data/lib/architect.rb

@@ -0,0 +1,3 @@
+require 'architect/version'
+require 'architect/helpers'
+require 'architect/engine' if defined?(Rails) && Rails::VERSION::MAJOR >= 3

data/lib/tasks/task_helpers.rb

@@ -0,0 +1,18 @@
+def colorize(text, color_code)
+  "\e[#{color_code}m#{text}\e[0m"
+end
+
+{ # See: http://kpumuk.info/ruby-on-rails/colorizing-console-ruby-script-output/
+  31 => 'red',
+  32 => 'green',
+  33 => 'yellow',
+  34 => 'blue',
+  35 => 'magenta',
+  36 => 'cyan',
+}.each do |code, color|
+  define_method(color) { |text| colorize(text, code) }
+end
+
+def error(text);   puts red('ERROR: ') + text; end
+def success(text); puts green('SUCCESS: ') + text; end
+def warn(text);    puts yellow('WARNING: ') + text; end

data/static/architect.min.js

@@ -0,0 +1 @@
+!function(){var t;t={},t.VERSION="0.0.1",window.Architect=t}.call(this),function(){Architect.Worker=function(){function t(){this.callbacks={},this.callbacksQueue={}}return t.prototype.addEventListener=function(t,r){var e;return this.callbacks[t]=r,(e=this.callbacksQueue[t])?(delete this.callbacksQueue[t],this.dispatch(t,e)):void 0},t.prototype.dispatch=function(t,r){return this.callbacks[t]?this.callbacks[t]({data:r}):this.callbacksQueue[t]=r},t.prototype.handleRequest=function(t){return this.dispatch("message",t)},t.prototype.terminate=function(){},t}(),window.Architect.Worker=Architect.Worker}.call(this),function(){var t,r={}.hasOwnProperty,e=function(t,e){function o(){this.constructor=t}for(var n in e)r.call(e,n)&&(t[n]=e[n]);return o.prototype=e.prototype,t.prototype=new o,t.__super__=e.prototype,t};Architect.AjaxWorker=function(r){function o(){return t=o.__super__.constructor.apply(this,arguments)}return e(o,r),o.prototype.postMessage=function(t){var r,e=this;return r=new XMLHttpRequest,r.open("GET",t),r.onreadystatechange=function(){return 4===r.readyState&&200===r.status?e.handleRequest(r.responseText):void 0},r.send()},o}(Architect.Worker),window.Architect.AjaxWorker=Architect.AjaxWorker}.call(this),function(){var t={}.hasOwnProperty,r=function(r,e){function o(){this.constructor=r}for(var n in e)t.call(e,n)&&(r[n]=e[n]);return o.prototype=e.prototype,r.prototype=new o,r.__super__=e.prototype,r};Architect.JSONPWorker=function(t){function e(){e.__super__.constructor.call(this),this.jsonpID=0}return r(e,t),e.prototype.postMessage=function(t){var r,e,o=this;return e=document.createElement("script"),r="architect_jsonp"+ ++this.jsonpID,window[r]=function(t){return delete window[r],document.head.removeChild(e),o.handleRequest(t)},e.src=this.appendQuery(t,"callback="+r),document.head.appendChild(e)},e.prototype.appendQuery=function(t,r){return(t+"&"+r).replace(/[&?]{1,2}/,"?")},e}(Architect.Worker),window.Architect.JSONPWorker=Architect.JSONPWorker}.call(this),function(){var t,r={}.hasOwnProperty,e=function(t,e){function o(){this.constructor=t}for(var n in e)r.call(e,n)&&(t[n]=e[n]);return o.prototype=e.prototype,t.prototype=new o,t.__super__=e.prototype,t};Architect.ProxyWorker=function(r){function o(){return t=o.__super__.constructor.apply(this,arguments)}return e(o,r),o.prototype.postMessage=function(t){return this.handleRequest(t)},o}(Architect.Worker),window.Architect.ProxyWorker=Architect.ProxyWorker}.call(this),function(){var t;t=function(){function t(){this.VERSION=Architect.VERSION,this.SUPPORT_WORKER=!!window.Worker,this.WORKERS={proxy:{"class":Architect.ProxyWorker,workerPath:"architect/proxy_worker.min.js"},ajax:{"class":Architect.AjaxWorker,workerPath:"architect/ajax_worker.min.js"},jsonp:{"class":Architect.JSONPWorker,workerPath:"architect/jsonp_worker.min.js"}}}return t.prototype.proxy=function(t,r){return this.work(t,"proxy",r)},t.prototype.ajax=function(t,r){return this.work(t,"ajax",r)},t.prototype.jsonp=function(t,r){return this.work(t,"jsonp",r)},t.prototype.work=function(t,r,e){var o;return"function"==typeof r&&(e=r,r=void 0),void 0===r&&(r="proxy"),o=this.spawnWorker(r),o.postMessage(t),o.addEventListener("message",function(t){return o.terminate(),e(t.data)})},t.prototype.spawnWorker=function(t){var r;return this.SUPPORT_WORKER?r=new Worker(this.WORKERS[t].workerPath):new this.WORKERS[t]["class"]},t}(),window.Architect=new t}.call(this);

data/static/workers/ajax_worker.min.js

@@ -0,0 +1 @@
+!function(){var e;e=function(e){return postMessage(e)},addEventListener("message",function(t){var n;return n=new XMLHttpRequest,n.open("GET",t.data),n.onreadystatechange=function(){return 4===n.readyState&&200===n.status?e(n.responseText):void 0},n.send()})}.call(this);

data/static/workers/jsonp_worker.min.js

@@ -0,0 +1 @@
+!function(){var e;self.handleRequest=function(e){return postMessage(e)},e=function(e,t){return(e+"&"+t).replace(/[&?]{1,2}/,"?")},addEventListener("message",function(t){var n;return n=e(t.data,"callback=handleRequest"),importScripts(n)})}.call(this);

data/static/workers/proxy_worker.min.js

@@ -0,0 +1 @@
+!function(){addEventListener("message",function(e){return postMessage(e.data)})}.call(this);

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: architect
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Etienne Lemay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: uglifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Architect is a JavaScript library built on top of Web Workers that will
+  handle and polyfill HTML Web Workers.
+email:
+- etienne@heliom.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/architect/version.coffee.erb
+- app/assets/javascripts/architect/worker.coffee
+- app/assets/javascripts/architect/workers/ajax_worker.coffee
+- app/assets/javascripts/architect/workers/jsonp_worker.coffee
+- app/assets/javascripts/architect/workers/proxy_worker.coffee
+- app/assets/javascripts/architect.coffee.erb
+- app/assets/javascripts/workers/ajax_worker.coffee
+- app/assets/javascripts/workers/jsonp_worker.coffee
+- app/assets/javascripts/workers/proxy_worker.coffee
+- lib/architect/engine.rb
+- lib/architect/helpers.rb
+- lib/architect/version.rb
+- lib/architect.rb
+- lib/tasks/task_helpers.rb
+- static/architect.min.js
+- static/workers/ajax_worker.min.js
+- static/workers/jsonp_worker.min.js
+- static/workers/proxy_worker.min.js
+- Rakefile
+- MIT-LICENSE
+- README.md
+homepage: https://github.com/EtienneLem/architect
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Your web workers’ supervisor
+test_files: []