gon 5.2.2 → 5.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb56c6f655c420fb5f2b19813f08d6ffa9be49eb
-  data.tar.gz: ac393884fd947158ffa948191d261c2f3f3f3739
+  metadata.gz: 43277ce7c2fa158208c211171b2e2e522ed84cfa
+  data.tar.gz: 161e43d9aada6fe673fd2f938c856defdcb59810
 SHA512:
-  metadata.gz: 0e7693c1b853436ebfa220a91a77ab49d34fad3b9deba29fc8f6c3aa1e4bfcfefa1ba6a2472218462bece617d5cd99c06cabab9c67eafa395dd8c7955276074e
-  data.tar.gz: 34c336d1e7851168c7f3284f230f10967bbaa3368b900978547e3965ffe143b5d793085b6503f51f13dd821e713b422b7dab646ea833fc9ceb2791e238c1fb88
+  metadata.gz: 54085e90ee7e4dbc0a754b6e56b273943fd9f2fb972073a6abd86875a1c067f740f6a79a2e02c133dc437e666181f8adfa54451087a0d5343be96c07ea7a659c
+  data.tar.gz: 15c74e24cdfa5e890d6ceb0b408acce28259748ed157d58a1ebcef3bebc1d6ebd21bceec6a93e14c354f9876ffd81abe7721cc6fedd3c12e72305be26a18c2b8

data/.travis.yml

@@ -3,7 +3,7 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
-  - 2.1.1
+  - 2.1.4
   - jruby-19mode # JRuby in 1.9 mode
   - rbx
 matrix:

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 5.2.3
+
+  * Coffescript implementation of watch.js. Thanks to @willcosgrove
+  * unwatchAll function in watch.js. Thanks to @willcosgrove
+
 ## 5.2.2
 
   * add support for controller helper methods in jbuilder

data/README.md

@@ -3,6 +3,7 @@
 ![Gon. You should try this. If you look closer - you will see an elephant.](https://github.com/gazay/gon/raw/master/doc/logo_small.png)
 
 [![Build Status](https://secure.travis-ci.org/gazay/gon.png)](http://travis-ci.org/gazay/gon) [![CodeClimate](https://codeclimate.com/github/gazay/gon.png)](https://codeclimate.com/github/gazay/gon)
+[![gon API Documentation](https://www.omniref.com/ruby/gems/gon.png)](https://www.omniref.com/ruby/gems/gon)
 
 If you need to send some data to your js files and you don't want to do this with long way through views and parsing - use this force!
 

data/coffee/watch.coffee

@@ -0,0 +1,45 @@
+gon._timers = {}
+
+gon.watch = (name, possibleOptions, possibleCallback) ->
+  return unless $?
+
+  if typeof possibleOptions == 'object'
+    options = {}
+    for key, value of gon.watchedVariables[name]
+      options[key] = value
+    for key, value of possibleOptions
+      options[key] = value
+    callback = possibleCallback
+  else
+    options = gon.watchedVariables[name]
+    callback = possibleOptions
+  performAjax = ->
+    xhr = $.ajax
+      type: options.type || 'GET'
+      url: options.url
+      data:
+        _method: options.method
+        gon_return_variable: true
+        gon_watched_variable: name
+    xhr.done(callback)
+
+  if options.interval
+    timer = setInterval(performAjax, options.interval)
+    gon._timers[name] ?= []
+    return gon._timers[name].push
+      timer: timer
+      fn: callback
+  else
+    return performAjax()
+
+gon.unwatch = (name, fn) ->
+  for timer, index in gon._timers[name] when timer.fn == fn
+    clearInterval(timer.timer)
+    gon._timers[name].splice(index, 1)
+    return
+
+gon.unwatchAll = ->
+  for variable, timers of gon._timers
+    for timer in timers
+      clearInterval(timer.timer)
+  gon._timers = {}

data/js/watch.js

@@ -1,8 +1,9 @@
+// Generated by CoffeeScript 1.7.1
 gon._timers = {};
 
 gon.watch = function(name, possibleOptions, possibleCallback) {
-  var callback, key, options, performAjax, timer, value, _base, _ref, _ref1;
-  if (typeof $ === 'undefined' || $ === null) {
+  var callback, key, options, performAjax, timer, value, _base, _ref;
+  if (typeof $ === "undefined" || $ === null) {
     return;
   }
   if (typeof possibleOptions === 'object') {
@@ -36,7 +37,7 @@ gon.watch = function(name, possibleOptions, possibleCallback) {
   };
   if (options.interval) {
     timer = setInterval(performAjax, options.interval);
-    if ((_ref1 = (_base = gon._timers)[name]) == null) {
+    if ((_base = gon._timers)[name] == null) {
       _base[name] = [];
     }
     return gon._timers[name].push({
@@ -53,10 +54,24 @@ gon.unwatch = function(name, fn) {
   _ref = gon._timers[name];
   for (index = _i = 0, _len = _ref.length; _i < _len; index = ++_i) {
     timer = _ref[index];
-    if (timer.fn === fn) {
+    if (!(timer.fn === fn)) {
+      continue;
+    }
+    clearInterval(timer.timer);
+    gon._timers[name].splice(index, 1);
+    return;
+  }
+};
+
+gon.unwatchAll = function() {
+  var timer, timers, variable, _i, _len, _ref;
+  _ref = gon._timers;
+  for (variable in _ref) {
+    timers = _ref[variable];
+    for (_i = 0, _len = timers.length; _i < _len; _i++) {
+      timer = timers[_i];
       clearInterval(timer.timer);
-      gon._timers[name].splice(index, 1);
-      return;
     }
   }
+  return gon._timers = {};
 };

data/lib/gon/version.rb

@@ -1,3 +1,3 @@
 class Gon
-  VERSION = '5.2.2'
+  VERSION = '5.2.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gon
 version: !ruby/object:Gem::Version
-  version: 5.2.2
+  version: 5.2.3
 platform: ruby
 authors:
 - gazay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-01 00:00:00.000000000 Z
+date: 2014-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -150,8 +150,8 @@ files:
 - Gemfile
 - LICENSE
 - README.md
-- README_old.md
 - Rakefile
+- coffee/watch.coffee
 - doc/logo.png
 - doc/logo_small.png
 - doc/top_sample.png

data/README_old.md

@@ -1,389 +0,0 @@
-# Gon gem — get your Rails variables in your js
-
-![Gon. You should try this. If you look closer - you will see an elephant.](https://github.com/gazay/gon/raw/master/doc/logo_small.png)
-
-
-### Build Status ![http://travis-ci.org/gazay/gon](https://secure.travis-ci.org/gazay/gon.png)
-
-If you need to send some data to your js files and you don't want to do this with long way through views and parsing - use this force!
-
-With [Jbuilder](https://github.com/rails/jbuilder) and [Rabl](https://github.com/nesquena/rabl) support!
-
-For Sinatra available [gon-sinatra](https://github.com/gazay/gon-sinatra).
-
-For .Net MVC available port [NGon](https://github.com/brooklynDev/NGon).
-
-## An example of typical use
-
-### Very good and detailed example and reasons to use is considered in [railscast](http://railscasts.com/episodes/324-passing-data-to-javascript) by Ryan Bates
-
-When you need to send some start data from your controller to your js
-you might be doing something like this:
-
-  1. Write this data in controller(presenter/model) to some variable
-  2. In view for this action you put this variable to some objects by data
-     attributes, or write js right in view
-  3. Then there can be two ways in js:
-    + if you previously wrote data in data
-     attributes - you should parse this attributes and write data to some
-  js variable.
-    + if you wrote js right in view (many frontenders would shame you for
-  that) - you just use data from this js - OK.
-  4. You can use your data in your js
-
-And everytime when you need to send some data from action to js you do this.
-
-With gon you configure it firstly - just put in layout one tag, and add
-gem line to your Gemfile and do the following:
-
-  1. Write variables by
-
-    ``` ruby
-    gon.variable_name = variable_value
-    ```
-
-  2. In your js you get this by
-
-    ``` js
-    gon.variable_name
-    ```
-
-  3. profit?
-
-## Usage
-
-`app/views/layouts/application.html.erb`
-
-``` erb
-<head>
-  <title>some title</title>
-  <%= include_gon %>
-  <!-- include your action js code -->
-  ...
-```
-
-To camelize your variables in js you can use:
-
-``` erb
-<head>
-  <title>some title</title>
-  <%= include_gon(:camel_case => true) %>
-  <!-- include your action js code with camelized variables -->
-  ...
-```
-
-You can change the namespace of the variables:
-
-``` erb
-<head>
-  <title>some title</title>
-  <%= include_gon(:namespace => 'serverExports') %>
-  <!-- include your action js code with 'serverExports' namespace -->
-  ...
-```
-
-You can initialize window.gon = {}; on each request
-
-``` erb
-<head>
-  <title>some title</title>
-  <%= include_gon(:init => true) %>
-  <!-- include your action js code with 'serverExports' namespace -->
-  ...
-```
-
-You can initialize script tag with type="text/javascript"
-
-``` erb
-<head>
-  <title>some title</title>
-  <%= include_gon(:need_type => true) %>
-  <!-- include your action js code with 'serverExports' namespace -->
-  ...
-```
-
-You can get json without script tag (kudos to @afa):
-
-``` erb
-<head>
-  <title>some title</title>
-  <script><%= include_gon(:need_tag => false) %></script>
-  <!-- include your action js code with 'serverExports' namespace -->
-  ...
-```
-
-You put something like this in the action of your controller:
-
-``` ruby
-@your_int = 123
-@your_array = [1,2]
-@your_hash = {'a' => 1, 'b' => 2}
-gon.your_int = @your_int
-gon.your_other_int = 345 + gon.your_int
-gon.your_array = @your_array
-gon.your_array << gon.your_int
-gon.your_hash = @your_hash
-
-gon.all_variables # > {:your_int => 123, :your_other_int => 468, :your_array => [1, 2, 123], :your_hash => {'a' => 1, 'b' => 2}}
-gon.your_array # > [1, 2, 123]
-
-gon.clear # gon.all_variables now is {}
-```
-
-Access the varaibles from your JavaScript file:
-
-``` js
-alert(gon.your_int)
-alert(gon.your_other_int)
-alert(gon.your_array)
-alert(gon.your_hash)
-```
-
-With camelize:
-
-``` js
-alert(gon.yourInt)
-alert(gon.yourOtherInt)
-alert(gon.yourArray)
-alert(gon.yourHash)
-```
-
-With custom namespace and camelize:
-
-``` js
-alert(customNamespace.yourInt)
-alert(customNamespace.yourOtherInt)
-alert(customNamespace.yourArray)
-alert(customNamespace.yourHash)
-```
-
-## Usage with Rabl
-
-You can write your variables assign logic to templates with [Rabl](https://github.com/nesquena/rabl).
-The way of writing Rabl templates is very clearly described in their repo.
-
-Add Rabl to your Gemfile before requiring gon - because gon checks Rabl constant
-
-  `Gemfile`
-
-  ``` ruby
-  gem 'rabl'
-  ...
-  gem 'gon'
-  ```
-
-Profit of using Rabl with gon:
-
-  1. You can clean your controllers now!
-  2. Work with database objects and collections clearly and easyly
-  3. All power of Rabl
-  4. You can still be lazy and don't use common way to transfer data in js
-  5. And so on
-
-For using gon with Rabl you need to create new Rabl template and map gon
-to it.
-For example you have model Post with attributes :title and :body.
-You want to get all your posts in your js as an Array.
-That's what you need to do:
-
-  1. Create Rabl template. You can choose spepicific directory but better
-     use default directory for action.
-
-    `app/views/posts/index.json.rabl`
-
-    ``` rabl
-    collection @posts => 'posts'
-    attributes :id, :title, :body
-    ```
-
-  2. If you create template in default directory for action, you just write in this action:
-
-    `app/controllers/posts_controller.rb#index`
-
-    ``` ruby
-    def index
-      # some controller logic
-      @posts = Post.all # Rabl works with instance variables of controller
-
-      gon.rabl
-      # some controller logic
-    end
-    ```
-
-     But if you choose some specific category - you need to map this template to gon.
-
-    `app/controllers/posts_controller.rb#index`
-
-    ``` ruby
-    def index
-      # some controller logic
-      @posts = Post.all # Rabl works with instance variables of controller
-
-      gon.rabl :template => 'app/goners/posts/index.rabl'
-      # some controller logic
-    end
-    ```
-
-    Thats it! Now you will get in your js gon.posts variable which is Array of
-    post objects with attributes :id, :title and :body.
-
-In javascript file for view of this action write call to your variable:
-
-``` js
-alert(gon.posts)
-alert(gon.posts[0])
-alert(gon.posts[0].post.body)
-```
-
-P.s. If you didn't put include_gon tag in your html head area - it
-wouldn't work. You can read about this in common usage above.
-
-### Some tips of usage Rabl with gon:
-
-If you don't use alias in Rabl template:
-
-``` rabl
-collection @posts
-....
-```
-
-instead of using that:
-
-``` rabl
-collection @posts => 'alias'
-....
-```
-
-Rabl will return you an array and gon by default will put it to variable
-gon.rabl
-
-Two ways how you can change it - using aliases or you can add alias to
-gon mapping method:
-
-``` ruby
-# your controller stuff here
-
-gon.rabl :as => 'alias'
-```
-
-## Usage with Jbuilder
-
-Use gon with [Jbuilder](https://github.com/rails/jbuilder) as with [Rabl](https://guthub.com/nesquena/rabl):
-
-  0. Add jbuilder to your Gemfile (because of it depends on
-     ActiveSuppurt '~> 3.0.0')
-
-    `Gemfile`
-
-    ``` ruby
-    gem 'jbuilder'
-    ```
-
-  1. Create Jbuilder template.
-
-    `app/views/posts/index.json.jbuilder`
-
-    ``` jbuilder
-    json.posts @posts, :id, :title, :body
-    ```
-
-  2. In your controller you should just call 'gon.jbuilder' - if your template in
-     default directory for action. In the other case - you still can use :template option.
-
-    ``` ruby
-    def index
-      # some controller logic
-      @posts = Post.all
-
-      gon.jbuilder
-      # some controller logic
-    end
-    ```
-
-In javascript file for view of this action write call to your variable:
-
-Now you can use partials in jbuilder:
-
-`app/views/posts/index.json.jbuilder`
-
-``` jbuilder
-json.partial! 'app/views/posts/_part.json.jbuilder', :comments => @posts[0].comments
-```
-
-`app/views/posts/_part.json.jbuilder`
-
-``` jbuilder
-json.comments comments.map { |it| 'comment#' + it.id }
-```
-
-``` js
-alert(gon.posts)
-alert(gon.posts[0])
-alert(gon.posts[0].post.body)
-alert(gon.comments)
-alert(gon.comments[0])
-```
-
-P.s. If you didn't put include_gon tag in your html head area - it
-wouldn't work. You can read about this in common usage above.
-
-## gon.global
-
-Now you can use gon for sending your data to js from anywhere!
-
-It works just as simple `gon` but you need to write `Gon.global` instead of `gon` in your ruby code,
-`gon.global` in javascript and it will not clear self after each request. All other things remain the same.
-
-For example I want to set start data into gon, which will be there before I clear it.
-
-Maybe some configuration data or url address which should be present on each page with `include_gon` helper in head.
-
-Now with Gon.global it's easy!
-
-`config/initializers/some_initializer.rb or any file where you can reach Gon constant`
-
-```ruby
-Gon.global.variable = 'Some data'
-```
-
-`in some js which can reach window.gon variable`
-
-```javascript
-alert(gon.global.variable)
-```
-
-Thats it!
-
-## Installation
-
-Puts this line into `Gemfile` then run `$ bundle`:
-
-``` ruby
-gem 'gon', '3.0.5'
-```
-
-Or if you are old-school Rails 2 developer put this into `config/environment.rb` and run `$ rake gems:install`:
-
-``` ruby
-config.gem 'gon', :version => '3.0.5'
-```
-
-Or manually install gon gem: `$ gem install gon`
-
-## Contributors
-
-* @gazay
-
-Special thanks to @brainopia, @kossnocorp and @ai.
-
-## License
-
-The MIT License
-
-Copyright (c) 2011-2012 gazay
-
-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.