architect 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a8eaf51e9027f92886fc6f7a80a32962314d6b3
-  data.tar.gz: c9e08da85647823e5191dcbf95d0efa5e82eef14
+  metadata.gz: daa8aa8ac05c622ddde6c3d2ede4dec0600a655c
+  data.tar.gz: aad21f214942aac852900fef7bf51ccbd740652a
 SHA512:
-  metadata.gz: 5e01127c50ab864af2b781d6ee9a8d54fb2dbdc639a9857a8ef711ce06e6d86883e51a42e6c1b2f17e665941a819743c991ee3d6a3fcb910d6426b2a62ec1dd9
-  data.tar.gz: 03257ade602761acedb3c484973aba2a436daeeefe761f65bfe60a9f041557d969690338947f451ac57c2c3e594b1f01045ec189e8edb9bb839419b1c4937049
+  metadata.gz: c77723dd253c39a2249168eff0a57a0672ff08c9edf50f319d89f1b8e2478fd64f4b55c99570c2ee1347c76f94f9a4829d95648c62226ad32fbe5f41b4c1c662
+  data.tar.gz: 367cb3d57759dd32c63f98960e1935abb6e0981c98545689de99bb4748d6b517220e1cfee2e68af8bd07de616931d076d48e6fe55b286751406fab402ce72222

data/README.md

@@ -1,12 +1,22 @@
-**Architect** is a JavaScript library built on top of [Web Workers][].<br>
-He will manage them workers so you don’t have to.
+<p align="center">
+  <a href="https://github.com/EtienneLem/architect">
+    <img src="https://f.cloud.github.com/assets/436043/856991/59ff07ce-f547-11e2-9a89-74501d0878c3.png">
+  </a>
+</p>
+
+<p align="center">
+  <strong>Architect</strong> is a JavaScript library built on top of <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/workers.html">Web Workers</a>.<br>
+  He will manage and polyfill them workers so you don’t have to.
+</p>
+
+## Short-lived workers
+These will be automatically terminated as soon as the work is done. It will spawn a new worker every time.
 
-## 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']
+var 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']
@@ -20,6 +30,8 @@ Architect.proxy(images, function(data) {
 })
 ```
 
+Alias for `Architect.work(data, 'proxy', callback)`.
+
 ### ajax
 Makes an Ajax request in a background process.
 
@@ -30,8 +42,10 @@ Architect.ajax('/users/1', function(data) {
 })
 ```
 
+Alias for `Architect.work(url, 'ajax', callback)`.
+
 ### jsonp
-Makes a JSONP request in a background process. **Do not add `?callback=foo` to your URL**, Architect will handle JSONP callbacks himself.
+Makes a JSONP request in a background process. **Do not add `?callback=foo` to your URL**, Architect will handle JSONP callbacks himself. See the [request Architect makes](https://api.github.com/users/etiennelem?callback=architect_jsonp).
 
 ```js
 Architect.jsonp('https://api.github.com/users/etiennelem', function(data) {
@@ -40,7 +54,72 @@ Architect.jsonp('https://api.github.com/users/etiennelem', function(data) {
 })
 ```
 
-See the [request Architect makes](https://api.github.com/users/etiennelem?callback=architect_jsonp).
+Alias for `Architect.work(url, 'jsonp', callback)`.
+
+## Long-lived workers
+These need to be manually terminated when the work is done. The same worker can therefore be reused many times with different data.
+
+### proxyOn
+```js
+var images, jobName, imagesCount
+
+images = ['foo.png', 'bar.png', 'twiz.png', 'foozle.png', 'barzle.png', 'twizle.png']
+jobName = 'appendImages'
+imagesCount = 0
+
+images.forEach(function(image) {
+  Architect.proxyOn(jobName, image, function(data) {
+    imagesCount++
+
+    img = document.createElement('img')
+    img.src = data
+    document.body.appendChild(img)
+
+    if (imagesCount == images.length) { Architect.endJob(jobName) }
+  })
+})
+```
+
+Alias for `Architect.workOn(jobName, data, 'proxy', callback)`.
+
+### ajaxOn
+```js
+var totalPages, jobName, queryApi
+
+totalPages = 10
+jobName = 'getUsers'
+
+queryApi = function(page) {
+  Architect.ajaxOn(jobName, '/users?page=' + page, function(data) {
+    // [Add DOM elements, do your thing ;)]
+
+    if (page == totalPages) {
+      // Manually terminate the 'getUsers' ajax worker
+      Architect.endJob(jobName)
+      console.log('Done')
+    } else {
+      // Reuse the same worker
+      queryApi(page + 1)
+    }
+  })
+}
+
+queryApi(1)
+```
+
+Alias for `Architect.workOn(jobName, url, 'ajax', callback)`.
+
+### jsonpOn
+```js
+Architect.jsonpOn('profile', 'https://api.github.com/users/etiennelem', function(data) {
+  console.log(data);
+  // => { meta: { status: 200, … }, data: { login: 'EtienneLem', company: 'Heliom', … } }
+
+  Architect.endJob('profile')
+})
+```
+
+Alias for `Architect.workOn(jobName, url, 'jsonp', callback)`.
 
 ## Setup
 ### Rails
@@ -49,11 +128,8 @@ See the [request Architect makes](https://api.github.com/users/etiennelem?callba
 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.
+You’ll need to serve the [worker files](/static/workers) at `/architect` (i.e. `http://foo.com/architect/proxy_worker.min.js`) and manually include [architect.min.js](/static/architect.min.js) to your HTML pages.
 
 ## 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
+- Tests
+- Support Shared Workers [[See #3](https://github.com/EtienneLem/architect/issues/3)]

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

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

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

@@ -1,7 +1,7 @@
 #= require_self
 #= require_tree ./workers
 
-class Architect.Worker
+class @Architect.Worker
 
   constructor: ->
     @callbacks = {}
@@ -24,6 +24,3 @@ class Architect.Worker
     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

@@ -1,4 +1,4 @@
-class Architect.AjaxWorker extends Architect.Worker
+class @Architect.AjaxWorker extends @Architect.Worker
 
   postMessage: (url) ->
     xhr = new XMLHttpRequest
@@ -9,6 +9,3 @@ class Architect.AjaxWorker extends Architect.Worker
       this.handleRequest(xhr.responseText)
 
     xhr.send()
-
-# Global scope
-window.Architect.AjaxWorker = Architect.AjaxWorker

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

@@ -1,4 +1,4 @@
-class Architect.JSONPWorker extends Architect.Worker
+class @Architect.JSONPWorker extends @Architect.Worker
 
   constructor: ->
     super()
@@ -19,6 +19,3 @@ class Architect.JSONPWorker extends Architect.Worker
 
   appendQuery: (url, query) ->
     (url + '&' + query).replace(/[&?]{1,2}/, '?')
-
-# Global scope
-window.Architect.JSONPWorker = Architect.JSONPWorker

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

@@ -1,7 +1,4 @@
-class Architect.ProxyWorker extends Architect.Worker
+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

@@ -1,37 +1,48 @@
 #= 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
+# Constants
+@Architect.SUPPORT_WORKER = !!window.Worker
+@Architect.WORKERS =
+  proxy: { polyfill: @Architect.ProxyWorker, workerPath: '<%= Architect.worker_path("proxy") %>' }
+  ajax:  { polyfill: @Architect.AjaxWorker,  workerPath: '<%= Architect.worker_path("ajax") %>'  }
+  jsonp: { polyfill: @Architect.JSONPWorker, workerPath: '<%= Architect.worker_path("jsonp") %>' }
+
+# Private methods
+spawnWorker = (type) ->
+  return new @Architect.WORKERS[type].polyfill unless @Architect.SUPPORT_WORKER
+  new Worker(@Architect.WORKERS[type].workerPath)
+
+# Short-lived workers
+@Architect.work = (data, type, callback) ->
+  worker = spawnWorker(type)
+  worker.postMessage(data)
+  worker.addEventListener 'message', (e) ->
+    worker.terminate()
+    callback(e.data)
+
+@Architect.proxy = (data, callback) => @Architect.work(data, 'proxy', callback)
+@Architect.ajax  = (url,  callback) => @Architect.work(url,  'ajax',  callback)
+@Architect.jsonp = (url,  callback) => @Architect.work(url,  'jsonp', callback)
+
+# Long-lived workers
+jobs = {}
+@Architect.workOn = (jobName, data, type, callback) ->
+  alreadySpawned = !!jobs[jobName]
+
+  worker = jobs[jobName] ||= spawnWorker(type)
+  worker.postMessage(data)
+
+  return if alreadySpawned
+  worker.addEventListener 'message', (e) ->
+    callback(e.data)
+
+@Architect.endJob = (jobName) ->
+  return unless worker = jobs[jobName]
+
+  worker.terminate()
+  delete jobs[jobName]
+
+@Architect.proxyOn = (jobName, data, callback) => @Architect.workOn(jobName, data, 'proxy', callback)
+@Architect.ajaxOn  = (jobName, url,  callback) => @Architect.workOn(jobName, url,  'ajax',  callback)
+@Architect.jsonpOn = (jobName, url,  callback) => @Architect.workOn(jobName, url,  'jsonp', callback)

data/lib/architect/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: architect
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Etienne Lemay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-24 00:00:00.000000000 Z
+date: 2013-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails