meteorite 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3f52eccbd85f2408b28c8a2acb0dabdab2eb93b
+  data.tar.gz: d8ebb4b1153e0b8764ba678f08f7c2510ac138ef
+SHA512:
+  metadata.gz: edc2773a003260faba62a75b9728afbb5de580aa2a1528302bcf48bba677c7105c23a773f7b94f9f5df1717955d157108fa44f8d2478381ffdc52ac0df9b1578
+  data.tar.gz: 32cb165eff72479b076842bf3057e2af5b0fa096a0c9c5dae96a1f671f3bcc2d85f91ae66a6ba3dfaf85774807b349cbbaa63fb38c0bbe128c20e5c9239e42a0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 llawlor
+
+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,101 @@
+# Meteorite
+
+Meteorite enables you to add two-way data binding to your application with minimal effort.
+
+## Dependencies
+
+You need Redis installed and running for Meteorite to work properly.
+
+Install Redis server (on Ubuntu):
+
+    sudo apt-get install redis-server
+
+Run Redis server:
+
+    nohup redis-server &
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'meteorite'
+
+And then execute:
+
+    $ bundle install
+
+Install required files:
+
+    $ rails generate meteorite:install
+    
+The generated JavaScript file needs to be added to the assets pipeline.  In app/assets/javascripts/application.js, add this line:
+
+    //= require meteorite
+
+Run the websocket daemon:
+
+    ruby daemons/websocket.rb
+
+## Example Usage in a Task Model
+
+### Create a task:
+task_controller#create
+```ruby
+# create the task
+task = Task.create(task_params)
+# render the partial to a string
+task_string = render_to_string(partial: 'task', locals: { task: task })
+# use the $redis.publish method to send your bind_key and task partial
+$redis.publish(Meteorite.bind_key(Task.all), task_string)
+```
+
+tasks/index.html.erb
+```html
+<table class="meteorite" data-bind-key="<%= Meteorite.bind_key(@tasks) %>">
+  <% @tasks.each do |task| %>
+    <%= render partial: 'task', locals: { task: task } %>
+  <% end %>
+</table>
+```
+
+tasks/_task.html.erb
+```html
+<%= form_for task do |f| %>
+  <label>
+    <%= f.check_box :checked, class: 'meteorite', data: { bind_key: Meteorite.bind_key(task), bind_attr: 'checked' } %>
+    <%= task.text %>
+  </label>
+<% end %>
+```
+
+### Update a task:
+tasks_controller#update
+```ruby
+# use the $redis.publish method to send your bind_key and task as JSON
+task = Task.find(params[:id])
+$redis.publish(Meteorite.bind_key(task), task.to_json)
+```
+
+### Delete a task:
+tasks_controller#destroy
+```ruby
+# use the $redis.publish method to send your bind_key and 'delete' message
+task = Task.find(params[:id])
+$redis.publish(Meteorite.bind_key(task), 'delete')
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+### Items that contributors can help with:
+1. Tests
+2. Examples
+
+Please discuss major feature changes with me first, to see if changes should be included in this gem or forked as your own.
+

data/Rakefile

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

data/app/assets/javascripts/meteorite.js

@@ -0,0 +1,103 @@
+// meteorite namespace
+var Meteorite = Meteorite || {};
+
+// initialize websocket
+Meteorite.websocket = new WebSocket("ws://192.168.56.101:8080/");
+
+console.log('starting meteorite websockets. . .');
+
+// when a new websocket message is received
+Meteorite.websocket.onmessage = function(msg) {
+  // parse the json message
+  // todo: handle non-json messages
+  var json = JSON.parse(msg.data);
+  
+  // log the data
+  console.log(json);
+  
+  // if this is a delete
+  if (json.bind_data === 'delete') {
+    // remove the item
+    $('#' + json.bind_key).remove();
+    // halt further processing
+    return false;
+  }
+  
+  // for each meteorite class
+  $('.meteorite').each(function() {
+    // if the bind keys match
+    if ($(this).data('bind-key') === json.bind_key) {
+      console.log('bind found');
+      
+      // if there is no bind-attr present, this is a collection
+      if ($(this).data('bind-attr') === undefined) {
+        Meteorite.add(json, $(this));
+      // else update the element
+      } else {
+        Meteorite.update(json, $(this));
+      }
+      
+    }
+  });
+}
+
+// add an item
+Meteorite.add = function(json, $element) {
+  // add to the dom
+  $element.append(json.bind_data);
+  // listen to subscribe events
+  Meteorite.subscribe($(json.bind_data).find('.meteorite').data('bind-key'));  
+}
+
+// update a single attribute
+Meteorite.update = function(json, $element) {
+  // get the bind data
+  var bind_data = JSON.parse(json.bind_data);
+  // desired attribute
+  var bind_attr = $element.data('bind-attr');
+  // get the attribute data
+  var attr_data = bind_data[bind_attr];
+
+  // update the property
+  $element.prop('checked', attr_data);
+  // update the text
+  $element.text(attr_data);
+  // notify event handlers that a change has occurred
+  $element.trigger('change');
+}
+
+// subscribe to all bind keys of meteorite classes
+Meteorite.subscribeAll = function() {
+  // for each meteorite class
+  $('.meteorite').each(function() {
+    // if there is a bind key
+    if ($(this).data('bind-key') !== undefined) {
+      // subscribe
+      Meteorite.subscribe($(this).data('bind-key'));
+    }
+  });
+}
+
+// wait for websocket to be ready, then subscribe all
+Meteorite.subscribeAfterWebsocket = function() {
+  // set a 5ms timeout
+  setTimeout(function() {
+    // if the websocket is ready
+    if (Meteorite.websocket.readyState === 1) {
+      // send the subscribe notices
+      Meteorite.subscribeAll();
+    // try again if not ready
+    } else { subscribeAfterWebsocket(); }
+  }, 5);
+}
+
+// subscribe to events when the websocket is ready
+Meteorite.subscribe = function(bind_key) {
+  // send the subscribe notice
+  Meteorite.websocket.send(JSON.stringify({ action: 'subscribe', key: bind_key }));
+}
+
+// when the document is ready
+$(document).on('page:load ready', function() {
+  Meteorite.subscribeAfterWebsocket();
+});

data/lib/generators/meteorite/install_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators/base'
+
+module Meteorite
+  
+  class InstallGenerator < ::Rails::Generators::Base
+  
+    desc "This generator creates a websocket.rb file at daemons/ and an initializer file at config/initializers/meteorite.rb"
+
+    source_root File.expand_path("../../templates", __FILE__)
+
+    def copy_websocket_file
+      copy_file "websocket.rb", "daemons/websocket.rb"
+    end
+
+    def copy_initializer_file
+      copy_file "meteorite.rb", "config/initializers/meteorite.rb"
+    end
+    
+  end
+  
+end

data/lib/generators/templates/meteorite.rb

@@ -0,0 +1,4 @@
+require "redis"
+
+# configure your Redis server
+$redis = Redis.new(url: "redis://127.0.0.1:6379")

data/lib/generators/templates/websocket.rb

@@ -0,0 +1,56 @@
+require 'em-websocket'
+require 'em-hiredis'
+require 'json'
+
+$clients = []
+
+EM.run do
+  puts "starting websocket server. . ."
+  
+  redis = EM::Hiredis.connect #("redis://127.0.0.1:6379")
+  pubsub = redis.pubsub
+
+  # when a pubsub message is received
+  pubsub.on(:message) do |channel, message|
+    puts [:message, channel, message]
+    # for each client
+    $clients.each do |client|
+      # send a message
+      client.send({bind_key: channel, bind_data: message}.to_json)
+    end
+  end
+    
+  EM::WebSocket.run(:host => "0.0.0.0", :port => 8080) do |ws|
+    ws.onopen do |handshake|
+      puts "WebSocket connection open"
+      
+      # add the client
+      $clients.push(ws)
+      # Access properties on the EM::WebSocket::Handshake object, e.g.
+      # path, query_string, origin, headers
+
+      # Publish message to the client
+      #ws.send "Hello Client, you connected to #{handshake.path}"
+    end
+
+    ws.onclose do
+      puts "Connection closed"
+      $clients.delete(ws)
+    end
+
+    ws.onmessage do |msg|
+      puts "Received message: #{msg}"
+      #ws.send "Pong: #{msg}"
+      
+      json = JSON.parse(msg)
+      
+      if json['action'] == 'subscribe'
+        # subscribe
+        pubsub.subscribe(json['key'])
+        puts "subscribe to: #{json['key']}"
+      end
+    end
+  
+  end
+
+end

data/lib/meteorite.rb

@@ -0,0 +1,7 @@
+require 'meteorite/version'
+require 'meteorite/assets'
+require 'meteorite/bindings'
+
+
+
+

data/lib/meteorite/assets.rb

@@ -0,0 +1,7 @@
+module Meteorite
+  # mount the Rails engine so that our JavaScript assets are included
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/meteorite/bindings.rb

@@ -0,0 +1,14 @@
+module Meteorite
+  # get the unique bind key for an instance or collection of ActiveRecord models
+  def self.bind_key(object)
+  
+    # if we're dealing with a collection
+    if object.class.parent == ActiveRecord
+      return "#{object.table_name}"
+    # else if we're dealing with an object
+    elsif object.class.parent == Object && object.respond_to?('id')
+      return "#{object.class.name}-#{object.id}"
+    end
+    
+  end
+end

data/lib/meteorite/version.rb

@@ -0,0 +1,3 @@
+module Meteorite
+  VERSION = "0.1.0"
+end

data/meteorite.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'meteorite/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "meteorite"
+  spec.version       = Meteorite::VERSION
+  spec.authors       = ["llawlor"]
+  spec.email         = ["primemod3@gmail.com"]
+  spec.description   = %q{Uses websockets to update HTML pages automatically when the underlying model changes.}
+  spec.summary       = %q{Two-way data binding for Rails}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency "em-websocket"
+  spec.add_runtime_dependency "em-hiredis"
+  spec.add_runtime_dependency "redis"
+  spec.add_dependency "railties"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: meteorite
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- llawlor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: em-websocket
+  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: em-hiredis
+  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: redis
+  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: railties
+  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'
+description: Uses websockets to update HTML pages automatically when the underlying
+  model changes.
+email:
+- primemod3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/meteorite.js
+- lib/generators/meteorite/install_generator.rb
+- lib/generators/templates/meteorite.rb
+- lib/generators/templates/websocket.rb
+- lib/meteorite.rb
+- lib/meteorite/assets.rb
+- lib/meteorite/bindings.rb
+- lib/meteorite/version.rb
+- meteorite.gemspec
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Two-way data binding for Rails
+test_files: []