actioncable-bindings 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9496613ddeddf5f1a48dc01a8c7d4277d021d393
+  data.tar.gz: f0ad964ca472cf28899895b537df77b294372c8c
+SHA512:
+  metadata.gz: f5dd5e7cea6c3f7208ff9525155b10caa7613a2e7114e0f36064017df963dee64a21e202a3e8ca15284afe4c9992eab4a320c3970e5ade59299fadb049494830
+  data.tar.gz: c56a0dbe1244ee0da90f1aa59dd410589b8f58e259192d01db3795fd3ab4643019d993e1b95049ab80398533f0505db08454ce8c12604e9234bf9ba091aedad4

data/.blade.yml

@@ -0,0 +1,19 @@
+load_paths:
+  - vendor/assets/javascripts
+  - test
+
+logical_paths:
+  - setup.js
+  - cable_bindings.js
+  - test.js
+
+gem_paths:
+  jquery-rails:
+    - vendor/assets/javascripts
+  actioncable:
+    - lib/assets/javascripts
+build:
+  logical_paths:
+    - cable_bindings.js
+  path: dist
+  js_compressor: uglifier

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in actioncable-bindings.gemspec
+gemspec
+
+gem 'blade', github: "lsylvester/blade", branch: 'allow-loading-assets-from-paths-in-gems'
+gem 'actioncable', github: "rails/actioncable"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Lachlan Sylvester
+
+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,102 @@
+# Actioncable::Bindings
+
+Provides DOM bindings for [Action Cable](https://github.com/rails/actioncable) 
+
+## Installation
+
+This depends on Action Cable wich has not yet been released. You will need to add the Action Cable as a git dependency in addition to adding this gem to the Gemfile.
+
+Add these lines to your application's Gemfile:
+
+```ruby
+gem 'actioncable', github: 'rails/actioncable'
+gem 'actioncable-bindings'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Add cable_bindings to your `app/assets/javascripts/application.js` file after the jQuery require
+
+```coffee
+//= require jquery
+//= require cable_bindings
+```
+
+Add a cable metatag to point to your Action Cable server
+
+```html
+<meta name="cable-uri" value="ws://localhost:28080">
+```
+
+Then, start creating subscriptions by adding `data-cable-subscribe` attributes your tags, with the value being the name of the channel you want to subscribe to.
+
+```html
+<div data-cable-subscribe="ChatChannel">
+  ...
+</div>
+```
+
+You can also create a subscribion using extra parameters by JSON encoding a object.
+
+```html
+<div data-cable-subscribe="{&quot;channel&quote;: &quote;ChatChannel&quote;, &quot;room&quote;: &quote;Best Room&quote;}">
+  ...
+</div>
+```
+
+Once you have created a subscription, the element will start triggering `cable:received` events whenever data is broadcast through the channel. You can subscribe to these events with something like
+
+```coffee
+$(document).on "cable:received", "#chat", (data)->
+  # Do stuff with data
+```
+
+### Updating the page.
+
+Whenever the page changes and a `data-cable-subscripe` element has been added to or removed from the page, the bindings need to be updated. You can do this by calling
+
+```coffee
+Cable.bindings.refresh
+```
+
+If you are using Turbolinks, this is automattically done for you whenever the `page:chage` event is triggered.
+
+### Performing Actions
+
+You can perform actions on a subscription by triggering the `cable:perform` event on the element.
+
+```coffee
+$('#my-subscribed-element').trigger("cable:perform", "myAction")
+```
+
+Any element with a `data-cable-perform` attribute will automatically perform the action in any parent element with a subscription when clicked.
+
+For example,
+
+```html
+<div data-cable-subscribe="ChatChannel">
+  <a data-cable-perform="away">Appear Away</a>
+</div>
+```
+
+will perform the `away` action on the `ChatChannel` subscription when the link is clicked.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec blade` and visit http://localhost:9876/ to run the javascript tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lsylvester/actioncable-bindings. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/ROADMAP.md

@@ -0,0 +1,6 @@
+# Roadmap
+
+* [ ] Make forms perform actions on submit instead of click
+* [ ] Allow events that perform actions to be customized with `data-cable-on` attributes.
+* [ ] Restrict `data-cable-action` click to elements that click would normally trigger events (like `a` tags)
+* [ ] Support `data-cable-action` in input, textarea, select ect, with default action on change

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/actioncable-bindings.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'actioncable/bindings/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "actioncable-bindings"
+  spec.version       = Actioncable::Bindings::VERSION
+  spec.authors       = ["Lachlan Sylvester"]
+  spec.email         = ["lachlan.sylvester@hypothetical.com.au"]
+
+  spec.summary       = %q{DOM bindings for Action Cable}
+  spec.description   = %q{Manage Action Cable subscriptions using data-* attributes}
+  spec.homepage      = "https://github.com/lsylvester/actioncable-bindings"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "railties", '>= 4.2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.8"
+  spec.add_development_dependency "jquery-rails", "~> 4.0"
+
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "actioncable/bindings"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/actioncable/bindings.rb

@@ -0,0 +1,8 @@
+require "actioncable/bindings/version"
+require "actioncable/bindings/engine"
+
+module Actioncable
+  module Bindings
+    # Your code goes here...
+  end
+end

data/lib/actioncable/bindings/engine.rb

@@ -0,0 +1,8 @@
+require "actioncable/bindings/version"
+
+module Actioncable
+  module Bindings
+    class Engine < Rails::Engine
+    end
+  end
+end

data/lib/actioncable/bindings/version.rb

@@ -0,0 +1,5 @@
+module Actioncable
+  module Bindings
+    VERSION = "0.1.0"
+  end
+end

data/vendor/assets/javascripts/cable_bindings.coffee

@@ -0,0 +1,31 @@
+#= require cable
+
+class Bindings
+  setupConsumer: =>
+    @consumer = Cable.createConsumer $('meta[name=cable-uri]').attr('value')
+
+  refresh: =>
+    for subscription in @consumer.subscriptions.subscriptions
+      if subscription.element and !$.contains(document, subscription.element)
+        subscription.unsubscribe()
+
+    for element in $('[data-cable-subscribe]')
+      element.subscription ||= @consumer.subscriptions.create $(element).data('cable-subscribe'),
+        element: element,
+
+        received: (data)->
+          $(element).trigger("cable:received", data)
+
+        connected: ->
+          $(element).trigger("cable:connected")
+
+      $(element).on 'cable:perform', (e, action, params)->
+        element.subscription.perform action, params
+
+Cable.bindings = new Bindings
+
+$(document).on 'click', "[data-cable-action]", (e)->
+  $(this).trigger 'cable:perform', $(this).data('cable-action')
+
+$(document).ready Cable.bindings.setupConsumer
+$(document).on "page:change", Cable.bindings.refresh

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: actioncable-bindings
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lachlan Sylvester
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Manage Action Cable subscriptions using data-* attributes
+email:
+- lachlan.sylvester@hypothetical.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".blade.yml"
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- ROADMAP.md
+- Rakefile
+- actioncable-bindings.gemspec
+- bin/console
+- bin/setup
+- lib/actioncable/bindings.rb
+- lib/actioncable/bindings/engine.rb
+- lib/actioncable/bindings/version.rb
+- vendor/assets/javascripts/cable_bindings.coffee
+homepage: https://github.com/lsylvester/actioncable-bindings
+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.5
+signing_key: 
+specification_version: 4
+summary: DOM bindings for Action Cable
+test_files: []