ethereal 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 285353e09738b1de4ca744c90c0ae9adf8946cbd
+  data.tar.gz: ae0b4d6959fde680a366e03678c9e88ddffb20c3
+SHA512:
+  metadata.gz: fc6149905f25a6d5c5313638300bb963c28d73b41e4dce11c39221cbcbad476716dc6e206cda5e2c8f7665352d3b1271c62787999735044b2371ade76ce9f142
+  data.tar.gz: 632710b135f3a2ff699ab6f3aebb3451b39068e2775f74a43b7476cdc40ece04da7562a9603afbafade5be9c639776694c3cbe1773c32900c4f25f398e9991a6

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pier-Olivier Thibault
+
+MIT License
+
+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,64 @@
+# Ethereal
+
+Event based JavaScript framework tailored made for Ruby on rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ethereal'
+```
+
+Then add this line to application.js
+
+```js
+//= require 'ethereal'
+```
+## Usage
+
+Ethereal is an event based framework that manages the life cycle of JavaScript objects. Here's a simple Todo where you can dynamically add/remove items on the list.
+
+```erb
+<%= content_tag :ol, as: 'Todo.List, do %>
+  <%= render @todos %>
+<% end %>
+```
+
+```coffee
+class Todos
+  # @element() always return the element to which your object is bound.
+
+  loaded: =>
+    @element().on 'todos:create', @add
+    @element().on 'todos:destroy', @delete
+
+  add: (e) =>
+    @element().appendChild(e.html)
+
+  delete: (e) =>
+    @element().querySelector("[tid=#{e.todoId}]")?.remove()
+
+Ethereal.Models.add Todos, 'Todo.List'
+```
+
+```ruby
+  #views/todos/create.js.erb
+  e.html = "<%= j render @todo %>".toHTML()
+```
+
+```ruby
+  #views/todos/destroy.js.erb
+  e.todoId = <%= @todo.id %> 
+```
+
+Some notes:
+
+- Automatic instantiation. No need to wrap things in DOMContentReady anymore.
+- Events are built following the "controller:action" pattern.
+- A callback (@loaded) is called right after Ethereal has instantiated an object.
+- In *.js.erb, an event is created. You can set HTML to the event object.
+- To ease the process, a toHTML() method has been added to the String object (JS).
+- You need to register any class you create through the ```Ethereal.Models.add Class, 'name'````. The name is the attribute you set in your DOM.
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/ethereal.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ethereal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ethereal"
+  spec.version       = Ethereal::VERSION
+  spec.authors       = ["Pier-Olivier Thibault"]
+  spec.email         = ["pothibo@gmail.com"]
+  spec.summary       = %q{Event based JavaScript framework tailored for Ruby on rails.}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/ethereal.rb

@@ -0,0 +1,5 @@
+require "ethereal/version"
+
+module Ethereal
+  require 'ethereal/railtie'
+end

data/lib/ethereal/app/assets/javascripts/ethereal.js.coffee

@@ -0,0 +1,6 @@
+#= require 'ethereal/ext'
+#= require 'ethereal/base'
+#= require 'ethereal/god'
+#= require 'ethereal/model'
+#= require 'ethereal/watcher'
+#= require 'ethereal/xhr'

data/lib/ethereal/app/assets/javascripts/ethereal/base.js.coffee

@@ -0,0 +1,50 @@
+@Ethereal = {
+  attributeName: 'as'
+}
+
+@Ethereal.isDOM = (el) ->
+  el instanceof HTMLDocument ||
+  el instanceof HTMLElement
+
+listen = (e) ->
+  if e.type && e.type == 'DOMContentLoaded'
+    document.removeEventListener('DOMContentLoaded', listen)
+
+  Ethereal.Watcher(document, {
+      attributes: true,
+      subtree: true,
+      childList: true,
+      attributeFilter: [Ethereal.attributeName],
+      characterData: true
+  })
+
+  Ethereal.Watcher().inspect(document.body)
+
+  document.addEventListener 'submit', (e) ->
+    if e.target.getAttribute('disabled')? || e.target.dataset['remote'] != 'true'
+      return
+
+    Ethereal.XHR.Form(e.target)
+
+    e.preventDefault()
+    return false
+
+  document.addEventListener 'click', (e) ->
+
+    if e.target.getAttribute('disabled')? || e.target.dataset['remote'] != 'true'
+      return
+
+    xhr = new Ethereal.XHR(e.target)
+    xhr.send(e.target.getAttribute('href'))
+
+    e.preventDefault()
+    return false
+
+
+if document.readyState == 'complete'
+  listen()
+else
+  document.addEventListener('DOMContentLoaded', listen)
+
+
+

data/lib/ethereal/app/assets/javascripts/ethereal/ext.js.coffee

@@ -0,0 +1,7 @@
+String::toHTML = ->
+  el = document.createElement('div')
+  el.innerHTML = this
+  if el.children.length > 1
+    el.children
+  else
+    el.children[0]

data/lib/ethereal/app/assets/javascripts/ethereal/god.js.coffee

@@ -0,0 +1,43 @@
+class God
+  update: (el) =>
+    model = el.getAttribute(Ethereal.attributeName)
+    if model?
+      @create(el, model)
+    else
+      @destroy(el)
+
+  create: (el) =>
+    model = el.getAttribute(Ethereal.attributeName)
+    if @modelExists(model)
+      el.instance = new Ethereal.Models.klass[model](el)
+
+      el.instance.element = ->
+        el
+
+      el.instance.on = (event, target, callback) ->
+        if callback?
+          el.instance.on.events.push([event, target, callback])
+        else
+          callback = target
+          target = el
+        target.addEventListener(event, callback)
+
+      el.instance.on.events = []
+
+      if el.instance.loaded?
+        el.instance.loaded()
+
+    else
+      throw "error: #{model} is not registered. Add your model with Ethereal.Models.add(#{model})"
+
+  destroy: (el) =>
+    el.instance.on.events?.forEach (event) ->
+      event[1].removeEventListener(event[0], event[2])
+
+
+  modelExists: (name) =>
+    Ethereal.Models.klass[name]?
+    
+
+Ethereal.God = new God
+

data/lib/ethereal/app/assets/javascripts/ethereal/model.js.coffee

@@ -0,0 +1,8 @@
+class Models
+  klass: {}
+  add: (kls, name) ->
+    unless name?
+      name = kls.name
+    @klass[name] = kls
+
+Ethereal.Models = new Models

data/lib/ethereal/app/assets/javascripts/ethereal/watcher.js.coffee

@@ -0,0 +1,50 @@
+instance = undefined
+
+class Watcher
+  constructor: (target, config = {}) ->
+    @observer = new MutationObserver(@observed)
+    @observer.observe(target, config)
+
+  observed: (mutations) =>
+    mutations.forEach (mutation) =>
+      if mutation.type == 'attributes'
+        Ethereal.God.update(target)
+      else
+        @add(mutation.addedNodes)
+        @destroy(mutation.removedNodes)
+
+
+  add: (nodes) =>
+    for node in nodes
+      continue unless Ethereal.isDOM(node)
+      if node.hasAttribute(Ethereal.attributeName)
+        Ethereal.God.create(node, node.getAttribute(Ethereal.attributeName))
+
+      for child in node.querySelectorAll("[#{Ethereal.attributeName}]")
+        Ethereal.God.create(child, child.getAttribute(Ethereal.attributeName))
+
+  destroy: (nodes) =>
+    for node in nodes
+      continue unless Ethereal.isDOM(node)
+      if node.hasAttribute(Ethereal.attributeName)
+        Ethereal.God.destroy(node)
+
+      for child in node.querySelectorAll("[#{Ethereal.attributeName}]")
+        Ethereal.God.destroy(child)
+
+  inspect: (node) ->
+    if Ethereal.isDOM(node)
+      found = node.querySelectorAll("[#{Ethereal.attributeName}]")
+      Ethereal.God.create(el) for el in found
+
+# !! **************************************** !! #
+
+Ethereal.Watcher = ->
+  unless instance?
+    i = 0
+    target = null
+    target = if Ethereal.isDOM(arguments[i]) then arguments[i++] else document
+    instance = new Watcher(target, arguments[i])
+
+  instance
+

data/lib/ethereal/app/assets/javascripts/ethereal/xhr.js.coffee

@@ -0,0 +1,32 @@
+class XHR
+  constructor: (el) ->
+    @element(el)
+    @request = new XMLHttpRequest()
+    @request.addEventListener('load', @completed)
+
+
+  element: (el) ->
+    @element = ->
+      el
+
+  completed: (e) =>
+    if e.target.responseText.length > 1
+      eval(e.target.responseText)(@element())
+
+  send: (src, method = 'GET', data) =>
+    @request.open(method, src)
+    @request.setRequestHeader('X-Requested-With', "XMLHttpRequest")
+
+    @request.send(data)
+
+  @Form: (element) =>
+    xhr = new XHR(element)
+    data = new FormData(element)
+    param = document.querySelector('meta[name=csrf-param]').getAttribute('content')
+    token = document.querySelector('meta[name=csrf-token]').getAttribute('content')
+    data.append(param, token)
+    xhr.send(element.getAttribute('action'), element.getAttribute('method'), data)
+    xhr
+
+
+Ethereal.XHR = XHR

data/lib/ethereal/app/views/layouts/application.js.erb

@@ -0,0 +1,6 @@
+(function(target) {
+  var e = new CustomEvent("<%= j "#{controller_name}:#{action_name}" %>", {bubbles: true})
+  <%= yield %>
+  target.dispatchEvent(e)
+})
+

data/lib/ethereal/railtie.rb

@@ -0,0 +1,11 @@
+module Ethereal
+  class Railtie < Rails::Railtie
+    initializer 'ethereal.assets.paths', before: :add_view_paths do |app|
+      ethereal_assets_path = File.dirname(__FILE__) + '/app/assets/'
+      app.paths['vendor/assets'] << ethereal_assets_path
+      app.config.assets.precompile << ethereal_assets_path
+
+      app.paths['app/views'] << File.dirname(__FILE__) + '/app/views/'
+    end
+  end
+end

data/lib/ethereal/version.rb

@@ -0,0 +1,3 @@
+module Ethereal
+  VERSION = "0.0.1"
+end

data/test/js/base.js

@@ -0,0 +1,33 @@
+// Generated by CoffeeScript 1.6.3
+(function() {
+  var listen;
+
+  this.Shiny = {
+    attributeName: 'as'
+  };
+
+  this.Shiny.isDOM = function(el) {
+    return el instanceof HTMLDocument || el instanceof HTMLElement;
+  };
+
+  listen = function(e) {
+    if (e.type && e.type === 'DOMContentLoaded') {
+      document.removeEventListener('DOMContentLoaded', listen);
+    }
+    Shiny.Watcher(document, {
+      attributes: true,
+      subtree: true,
+      childList: true,
+      attributeFilter: [Shiny.attributeName],
+      characterData: true
+    });
+    return Shiny.Watcher().inspect(document.body);
+  };
+
+  if (document.readyState === 'complete') {
+    listen();
+  } else {
+    document.addEventListener('DOMContentLoaded', listen);
+  }
+
+}).call(this);

data/test/js/god.js

@@ -0,0 +1,67 @@
+// Generated by CoffeeScript 1.6.3
+(function() {
+  var God,
+    __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; };
+
+  God = (function() {
+    function God() {
+      this.modelExists = __bind(this.modelExists, this);
+      this.destroy = __bind(this.destroy, this);
+      this.create = __bind(this.create, this);
+      this.update = __bind(this.update, this);
+    }
+
+    God.prototype.update = function(el) {
+      var model;
+      model = el.getAttribute(Shiny.attributeName);
+      if (model != null) {
+        return this.create(el, model);
+      } else {
+        return this.destroy(el);
+      }
+    };
+
+    God.prototype.create = function(el) {
+      var model;
+      model = el.getAttribute(Shiny.attributeName);
+      if (this.modelExists(model)) {
+        el.instance = new Shiny.Models.klass[model](el);
+        el.instance.element = function() {
+          return el;
+        };
+        el.instance.on = function(event, target, callback) {
+          if (callback != null) {
+            el.instance.on.events.push([event, target, callback]);
+          } else {
+            callback = target;
+            target = el;
+          }
+          return target.addEventListener(event, callback);
+        };
+        el.instance.on.events = [];
+        if (el.instance.loaded != null) {
+          return el.instance.loaded();
+        }
+      } else {
+        throw "error: " + model + " is not registered. Add your model with Shiny.Models.add(" + model + ")";
+      }
+    };
+
+    God.prototype.destroy = function(el) {
+      var _ref;
+      return (_ref = el.instance.on.events) != null ? _ref.forEach(function(event) {
+        return event[1].removeEventListener(event[0], event[2]);
+      }) : void 0;
+    };
+
+    God.prototype.modelExists = function(name) {
+      return Shiny.Models.klass[name] != null;
+    };
+
+    return God;
+
+  })();
+
+  Shiny.God = new God;
+
+}).call(this);

data/test/js/list.js

@@ -0,0 +1,21 @@
+(function() {
+
+  function List() {
+
+    this.loaded = function() {
+
+      this.on('click', this.remove)
+      this.on('click', document, this.hello)
+    }
+
+    this.remove = function() {
+      this.remove()
+    }
+
+    this.hello = function() {
+      console.log('hello')
+    }
+  }
+
+  Shiny.Models.add(List, "List")
+})()

data/test/js/models.js

@@ -0,0 +1,23 @@
+// Generated by CoffeeScript 1.6.3
+(function() {
+  var Models;
+
+  Models = (function() {
+    function Models() {}
+
+    Models.prototype.klass = {};
+
+    Models.prototype.add = function(kls, name) {
+      if (name == null) {
+        name = kls.name;
+      }
+      return this.klass[name] = kls;
+    };
+
+    return Models;
+
+  })();
+
+  Shiny.Models = new Models;
+
+}).call(this);

data/test/js/watcher.js

@@ -0,0 +1,110 @@
+// Generated by CoffeeScript 1.6.3
+(function() {
+  var Watcher, instance,
+    __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; };
+
+  instance = void 0;
+
+  Watcher = (function() {
+    function Watcher(target, config) {
+      if (config == null) {
+        config = {};
+      }
+      this.destroy = __bind(this.destroy, this);
+      this.add = __bind(this.add, this);
+      this.observed = __bind(this.observed, this);
+      this.observer = new MutationObserver(this.observed);
+      this.observer.observe(target, config);
+    }
+
+    Watcher.prototype.observed = function(mutations) {
+      var _this = this;
+      return mutations.forEach(function(mutation) {
+        if (mutation.type === 'attributes') {
+          return Shiny.God.update(target);
+        } else {
+          _this.add(mutation.addedNodes);
+          return _this.destroy(mutation.removedNodes);
+        }
+      });
+    };
+
+    Watcher.prototype.add = function(nodes) {
+      var child, node, _i, _len, _results;
+      _results = [];
+      for (_i = 0, _len = nodes.length; _i < _len; _i++) {
+        node = nodes[_i];
+        if (!Shiny.isDOM(node)) {
+          continue;
+        }
+        if (node.hasAttribute(Shiny.attributeName)) {
+          Shiny.God.create(node, node.getAttribute(Shiny.attributeName));
+        }
+        _results.push((function() {
+          var _j, _len1, _ref, _results1;
+          _ref = node.querySelectorAll("[" + Shiny.attributeName + "]");
+          _results1 = [];
+          for (_j = 0, _len1 = _ref.length; _j < _len1; _j++) {
+            child = _ref[_j];
+            _results1.push(Shiny.God.create(child, child.getAttribute(Shiny.attributeName)));
+          }
+          return _results1;
+        })());
+      }
+      return _results;
+    };
+
+    Watcher.prototype.destroy = function(nodes) {
+      var child, node, _i, _len, _results;
+      _results = [];
+      for (_i = 0, _len = nodes.length; _i < _len; _i++) {
+        node = nodes[_i];
+        if (!Shiny.isDOM(node)) {
+          continue;
+        }
+        if (node.hasAttribute(Shiny.attributeName)) {
+          Shiny.God.destroy(node);
+        }
+        _results.push((function() {
+          var _j, _len1, _ref, _results1;
+          _ref = node.querySelectorAll("[" + Shiny.attributeName + "]");
+          _results1 = [];
+          for (_j = 0, _len1 = _ref.length; _j < _len1; _j++) {
+            child = _ref[_j];
+            _results1.push(Shiny.God.destroy(child));
+          }
+          return _results1;
+        })());
+      }
+      return _results;
+    };
+
+    Watcher.prototype.inspect = function(node) {
+      var el, found, _i, _len, _results;
+      if (Shiny.isDOM(node)) {
+        found = node.querySelectorAll("[" + Shiny.attributeName + "]");
+        _results = [];
+        for (_i = 0, _len = found.length; _i < _len; _i++) {
+          el = found[_i];
+          _results.push(Shiny.God.create(el));
+        }
+        return _results;
+      }
+    };
+
+    return Watcher;
+
+  })();
+
+  Shiny.Watcher = function() {
+    var i, target;
+    if (instance == null) {
+      i = 0;
+      target = null;
+      target = Shiny.isDOM(arguments[i]) ? arguments[i++] : document;
+      instance = new Watcher(target, arguments[i]);
+    }
+    return instance;
+  };
+
+}).call(this);

data/test/test.html

@@ -0,0 +1,18 @@
+<!DOCTYPE>
+<html>
+  <head>
+    <script src="js/base.js"></script>
+    <script src="js/god.js"></script>
+    <script src="js/models.js"></script>
+    <script src="js/watcher.js"></script>
+
+    <script src="js/list.js"></script>
+  </head>
+  <body>
+
+    <ol as="List">
+      <li>Hello</li>
+    </ol>
+
+  </body>
+</html>

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: ethereal
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pier-Olivier Thibault
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- pothibo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ethereal.gemspec
+- lib/ethereal.rb
+- lib/ethereal/app/assets/javascripts/ethereal.js.coffee
+- lib/ethereal/app/assets/javascripts/ethereal/base.js.coffee
+- lib/ethereal/app/assets/javascripts/ethereal/ext.js.coffee
+- lib/ethereal/app/assets/javascripts/ethereal/god.js.coffee
+- lib/ethereal/app/assets/javascripts/ethereal/model.js.coffee
+- lib/ethereal/app/assets/javascripts/ethereal/watcher.js.coffee
+- lib/ethereal/app/assets/javascripts/ethereal/xhr.js.coffee
+- lib/ethereal/app/views/layouts/application.js.erb
+- lib/ethereal/railtie.rb
+- lib/ethereal/version.rb
+- test/js/base.js
+- test/js/god.js
+- test/js/list.js
+- test/js/models.js
+- test/js/watcher.js
+- test/test.html
+homepage: 
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Event based JavaScript framework tailored for Ruby on rails.
+test_files:
+- test/js/base.js
+- test/js/god.js
+- test/js/list.js
+- test/js/models.js
+- test/js/watcher.js
+- test/test.html