silent_listener 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 47ffc8500f8a368b4265c99165e356545ce6d510
+  data.tar.gz: 1fc7f64328343d351ae46521527a72c6d196b6c6
+SHA512:
+  metadata.gz: 1e922a2755e54af88f95762ffa959d903f17e840e52b6b1e0cf553008d1beba9db0507e663ef294cfd9bf5b1519107e503142f382c76b2c8b01c1ed0d6e30e68
+  data.tar.gz: 9c5d844f43e50faf7853cb1579b632654b23fc9e9d6a25358e87804ddb8ebc701ca526b9baf2f2b95148c49b61d49bc37abe32606e494ace2e9c1ef9e2f7d65c

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at samtgarson@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 samtgarson
+
+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 @@
+# SilentListener
+
+> Listen out for selectors and instantiate your classes
+
+SilentListener allows you to define _SilentListeners_ which will be instantiated whenever an element appears which matches a given selector. It also comes with some handy functionality for reinstantiating classes using events, and handling class options.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'silent_listener'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install silent_listener
+
+## Usage
+
+### Dependencies
+
+This gem comes with `rails-coffee` as it is written in CoffeeScript, but also depends on jQuery or some other dom selection library which uses `$` (e.g. [Sprint](https://github.com/bendc/sprint)). It leaves that choice up to you.
+
+### Setup
+
+To define a silent listener, name your class as a `SilentListener`, and make it a descendant of the `SilentListener` class:
+
+```coffeescript
+class SilentListeners.MyClass extends SilentListener
+```
+
+To add a selector to listen out for, define a class variable called `silentListenerSelector`:
+
+```coffeescript
+    @silentListenerSelector: '.my-class'
+```
+
+Once your class has been instantiated, a class method instantiate will be called (if it exists), and a class variable called `el` will be set:
+
+```coffeescript
+    instantiate: =>
+        @el.doSomething()
+```
+
+The elements will have the instance of its silent listner class set on a data attribute `data-silent-listener`, as well as being accessible on the class variable `instances`. 
+
+e.g.:
+
+```coffeescript```
+    $('.my-class').first().data('silent-listener') # => bound class instance
+    MyClass.instances # => array of all class instances
+```
+
+### Options
+
+Given an element with the data attribute `data-listener-options`, silent listeners will merge the `data-listener-options` hash with the result of an instance method called `_defaultOptions` and set an instance variable called `options` upon instantiation.
+
+e.g.:
+
+```html
+<div class="my-class" data-listener-options="{ some-option: true }"></div>
+```
+
+```coffeescript
+class SilentListeners.MyClass extends SilentListener
+    @silentListenerSelector: '.my-class'
+
+    instantiate: =>
+        console.log(@options)
+
+    # the underscore implies a private method, despite the concept not existing yet
+    _defaultOptions: =>
+        some-option: false
+```
+
+### Events
+Each silent listener can told to look again for its selector by calling `MyClass.bindSelf()`
+
+You can also tell all of your silent listeners to rebind themselves by calling `SilentListener.bindAll()`
+
+
+## Development
+
+### ToDo: Test coverage, potentially using [konacha](https://github.com/jfirebaugh/konacha)
+
+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/[USERNAME]/silent_listener. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "silent_listener"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/silent_listener/version.rb

@@ -0,0 +1,3 @@
+module SilentListener
+  VERSION = "0.2.0"
+end

data/lib/silent_listener.rb

@@ -0,0 +1,6 @@
+require "silent_listener/version"
+
+module SilentListener
+  class Engine < ::Rails::Engine
+  end
+end

data/silent_listener.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'silent_listener/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "silent_listener"
+  spec.version       = SilentListener::VERSION
+  spec.authors       = ["samtgarson"]
+  spec.email         = ["samtgarson@gmail.com"]
+
+  spec.summary       = %q{Listen out for selectors and instantiate your classes.}
+  spec.description   = %q{SilentListener allows you to define _SilentListeners_ which will be instantiated whenever an element appears which matches a given selector. It also comes with some handy functionality for reinstantiating classes using events, and handling class options.}
+  spec.homepage      = "http://github.com/samtgarson/silent-listener"
+  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_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_runtime_dependency 'coffee-rails', '~> 4.1.0'
+end

data/vendor/assets/javascripts/silent_listener.js.coffee

@@ -0,0 +1,30 @@
+class @SilentListener
+
+  @bindAll: (e) =>
+    for name, cls of SilentListeners
+      cls.bindSelf()
+
+  @bindSelf: ->
+    @instances ?= []
+    $(@silentListenerSelector).each (i, el) =>
+      unless $(el).data('silent-listener')?
+        instance = new @($(el))
+        $(el).data('silent-listener', instance)
+        @instances.push instance
+
+  constructor: (@el) ->
+    @options = @mergeOptions()
+    @instantiate()
+
+  instantiate: =>
+
+  mergeOptions: =>
+    $.extend(true, {}, @_defaultOptions(), (@el.data('listener-options') || {}))
+
+  _defaultOptions: => 
+    {}
+
+$ ->
+  setTimeout SilentListener.bindAll, 0
+
+@SilentListeners = {}

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: silent_listener
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- samtgarson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+description: SilentListener allows you to define _SilentListeners_ which will be instantiated
+  whenever an element appears which matches a given selector. It also comes with some
+  handy functionality for reinstantiating classes using events, and handling class
+  options.
+email:
+- samtgarson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/silent_listener.rb
+- lib/silent_listener/version.rb
+- silent_listener.gemspec
+- vendor/assets/javascripts/silent_listener.js.coffee
+homepage: http://github.com/samtgarson/silent-listener
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Listen out for selectors and instantiate your classes.
+test_files: []