SrBuj 0.9.2 → 0.10.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MDg3NWQxYWZjNWM3MTgyMWFhNjY1ZWZmNGRiYzFkOTZjNGE5ZGI1Yg==
-  data.tar.gz: !binary |-
-    MjBiY2Y3ZDY3MTNhMmUzYzkxYjczZjVkMzg0MmM3ZWZiODU2ZGU4Nw==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    MzQ3N2Q1MDg4YTY1YTNlNzkxOWU5YmFkNjI4YTI2YTYwOGUyZTQyY2UyMTVk
-    NGQ0NmJhYzUyYzBmZmY4MGNkMmIwMDgwNGI5MDc3YjUzZDdjYjM5OTI4YjM2
-    OGE2ODQ3NjdhMjMwZTc1YmRmZTFhNDFhYmRjYWE3YzE1YjIxMzE=
-  data.tar.gz: !binary |-
-    MjZmMWMyZjFjZGMxMmM2ZTA2Zjk0ZTE3MzVkOTM4YTg3OGZiN2M0OTgxODBk
-    YmFlYzRmMTM1ZDAxMGI0YmUyNjQzMmJmMDEyY2M2YWRkZWIzY2EyZDVmMTZm
-    MjYyN2I0ZDMzYWU2NjFhMGJmMDc0NGE0ZDZlNmMwNjdlYTczNDY=
+SHA1:
+  metadata.gz: d57d1efa04c6824dc15dc61ae92b3e972111019c
+  data.tar.gz: bddf430716cf06249b94d97b44ec99602bd57d69
+SHA512:
+  metadata.gz: b5249af11986231029f9dad485c67fed25661a32d931e79c57869d0f69484c65a281d85a744568f0c8e79d26c9905928a14f75f58e031171a7c6ac80a60d1430
+  data.tar.gz: 5cf71ac75514f968ddbad7e39dc9caf3a2c3fe78cd1878916c6438b67bd2eee6ff6aa06f199bd1b5d429daabf671cbc071fba854118943272133c5c5d4eea96a

data/README.md

@@ -1,11 +1,12 @@
 SrBuj
 =
- 
-[![Gem Version](https://badge.fury.io/rb/SrBuj.png)](https://rubygems.org/gems/SrBuj)[![Dependency Status](https://gemnasium.com/gagoar/SrBuj.png)](https://gemnasium.com/gagoar/SrBuj) [![Code Climate](https://codeclimate.com/github/gagoar/SrBuj.png)](https://codeclimate.com/github/gagoar/SrBuj.png)
+
+[![Gem Version](https://badge.fury.io/rb/SrBuj.png)](https://rubygems.org/gems/SrBuj)[![Dependency Status](https://gemnasium.com/gagoar/SrBuj.png)](https://gemnasium.com/gagoar/SrBuj) [![Code Climate](https://codeclimate.com/github/gagoar/SrBuj.png)](https://codeclimate.com/github/gagoar/SrBuj)[![Travis-CI](https://travis-ci.org/gagoar/SrBuj.png)](https://travis-ci.org/gagoar/SrBuj)[![endorse](https://api.coderwall.com/gagoar/endorsecount.png)](https://coderwall.com/gagoar)
 
 Better Unobtrusive JavaScript Respond (for Rails and jquery_ujs, twitter/bootstrap modal.js)
 
 SrBuj comes to cure a common illness in a life of every Rails developer (maybe other kind too):
+
   - write the same code to rise up a modal
   - render a partial on it.
   - change an element in a view without reload the entire web page
@@ -15,11 +16,11 @@ SrBuj comes to cure a common illness in a life of every Rails developer (maybe o
   - replace an specific element (PUT/PATCH)
   - bind a callback to run specific js function.
 
-every time, we end up with a lot of code, ugly code, messy code or at best with an old and known .js.rb file with the same 4 lines... Well enough it's enough!
+Every time, we end up with a lot of code, ugly code, messy code or at best with an old and known .js.rb file with the same 4 lines... Well enough it's enough!
 This is the cure...and comes with a simple treatment too!
 
 Steps:
--
+=
 
 1. bundle the gem
 2. required in your manifest
@@ -30,8 +31,9 @@ This unobtrusive scripting support file is developed for the Ruby on Rails frame
 
 These features are achieved by adding certain ["data" attributes][data] to your HTML markup. In Rails, they are added by the framework's template helpers.
 
+
 Requirements
-------------
+=
 
 - [jQuery 1.7.x or higher](http://jquery.com/);
 - [jquery_ujs](https://github.com/rails/jquery-ujs)
@@ -41,7 +43,7 @@ Requirements
 If you don't use HTML5, adding "data" attributes to your HTML4 or XHTML pages might make them fail [W3C markup validation][validator]. However, this shouldn't create any issues for web browsers or other user agents.
 
 Installation
-------------
+=
 
 For automated installation in Rails, use the "jquery-rails" gem. Place this in your Gemfile:
 
@@ -53,9 +55,14 @@ And run:
 
     $ bundle install
 
-This next step depends on your version of Rails.
+use the generator:
 
-a. For Rails 3.1, add these lines to the top of your app/assets/javascripts/application.js file:
+    $ bundle exec rails g sr_buj:install
+
+
+or the manual way:
+
+For Rails 3.1 and higher, add `//= require SrBuj` in your `app/assets/javascripts/application.js` file like this:
 
 ```javascript
 //= require jquery
@@ -63,22 +70,43 @@ a. For Rails 3.1, add these lines to the top of your app/assets/javascripts/appl
 //= require SrBuj
 ```
 
+and add `*= require SrBuj` in your `app/assets/stylesheets/application.css` file:
+
+```css
+ /*
+ *= require_self
+ *= require SrBuj
+ *= require_tree .
+ */
+```
+
 Use and Options
----
-  - target( data[target] ):  depending on the type of request(GET/PUT/POST/DELETE) is used to alter the Dom. it represent the element that we want to alter in the view after an succceded request (needed)
-  - modal( data[modal] ): if you wish that the response ends up in a modal. value: true|false (default false)
-  - error (data[error]): id Element In a form data[error] is the holder in witch de form re renders to show the errors
-  - replace(data[replace]):  if you wish to replace de data[target] element with the response content on success. represent the PUT/PATCH action for SrBuj. value: true|false (default false)
-  - remove (data[method:delete] && data[target]): if these are combined the success response execute a remove() over the data[target] element.
-  - nochange (data[nochange]): do all but don't change the document in any way.
-  - callback(data[callback]) = after a successeded request, call this function.
-  - data[custom] = just proxy the response to my custom function in callback, nothing more.
-  - jqueryselector(data[jqueryselector]): Change the data[target] & data[error] for selectors in jquery and find the element!
-  - respond-as(data[respond-as]): We can alter the respond behavior without careing the method used on the request. values: GET/POST/PUT/PATCH/DELETE
-You can use it with any element available. (links forms tables divs anything).
+=
+
+  - `data-target`: Depending on the type of request(`GET`/`PUT`/`POST`/`DELETE`) is used to alter the Dom. it represent the element that we want to alter in the view after an succceded request (needed)
+
+  - `data-modal`: If you wish that the response ends up in a modal (default: false).
+
+  - `data-error`: The id element where errors will be rendered if the response received a different state than 200(Ok).
+
+  - `data-delete`: On a successded response, remove the 'data-target' element from document.
+
+  - `data-nochange`: Don't alter the Document.(ignore the verb).
+
+  - `data-callback`: After a succeeded response, call this function.
+
+  - `data-custom`: Just proxy the response to `data-callback` function. (default: false).
+
+  - `data-jqueryselector`: Change the `data-target` & `data-error` for selectors in jquery and find the element!
+
+  - `data-respond-as`: We can alter the respond behavior without careing the method used on the request. values: `GET`/`POST`/`PUT`/`PATCH`/`DELETE`
+
+  - `data-push`: if there is a href or action in the element, replace the url.(default: false)
+
+You can use it with any html element available. (links forms tables divs...Anything).
 
 Example
-=======
+=
 
 modal
 ----
@@ -104,8 +132,28 @@ fine.
 
 that's it.
 
+Testing
+=
+
+You need [Node](http://nodejs.org) and [Testem](https://github.com/airportyh/testem) to run the tests.
+
+1. Install
+
+````
+  npm install testem -g
+````
+
+2. Run
+
+````bash
+  testem ci # For test with all launchers
+  ####  or  ####
+  testem # and enter in http://localhost:7357
+````
+
+
 Contributing
-------------
+=
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
@@ -114,8 +162,12 @@ Contributing
 5. Create new Pull Request
 
 Copyright
----------
+=
 
 Copyright (c) 2013 gagoar. See LICENSE.txt for
 further details.
 
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/gagoar/srbuj/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/lib/SrBuj/rails/action_controller/helpers.rb

@@ -1,12 +1,14 @@
 module SrBuj
   module ActionController
     module Helpers
-      HEADERS = { message: 'X-SRBUJ-MSG',
-                  type: 'X-SRBUJ-TYPE',
-                  side: 'X-SRBUJ-SIDE',
-                  position: 'X-SRBUJ-POS',
-                  time: 'X-SRBUJ-TIME'
-                }
+      HEADERS = {
+        message: 'X-SRBUJ-MSG',
+        type: 'X-SRBUJ-TYPE',
+        side: 'X-SRBUJ-SIDE',
+        position: 'X-SRBUJ-POS',
+        time: 'X-SRBUJ-TIME',
+        raw: 'X-SRBUJ-RAW'
+      }
       #=> helpfull method to return redirect_to in an js way.
       # use: js_redirect(to: root_path)
       # use: js_redirect(reload: true)
@@ -32,6 +34,8 @@ module SrBuj
           HEADERS.each do |value, header|
             response.headers[header] = options[value].to_s if options[value]
           end
+        else
+          response.headers['X-SRBUJ-REMOVE'] = 'true'
         end
       end
     end

data/lib/SrBuj/version.rb

@@ -1,3 +1,3 @@
 module SrBuj
-  VERSION = '0.9.2'
+  VERSION = '0.10.0'
 end

data/lib/assets/javascripts/SrBuj.js

@@ -19,9 +19,17 @@
     };
     var SrBuj;
     $.SrBuj = SrBuj = {
-        version: '0.9.2',
+        version: '0.10.0',
         selector: '[data-remote][data-target]',
-        notifyHeaders: { message: 'X-SRBUJ-MSG', type: 'X-SRBUJ-TYPE', side: 'X-SRBUJ-SIDE', position: 'X-SRBUJ-POS', time: 'X-SRBUJ-TIME' },
+        notifyHeaders: {
+          message  : 'X-SRBUJ-MSG',
+          type     : 'X-SRBUJ-TYPE',
+          side     : 'X-SRBUJ-SIDE',
+          position : 'X-SRBUJ-POS',
+          time     : 'X-SRBUJ-TIME',
+          remove   : 'X-SRBUJ-REMOVE',
+          raw      : 'X-SRBUJ-RAW'
+        },
         defaults: {
             '$el': undefined,
             target: undefined,
@@ -86,10 +94,10 @@
                 return respond_as.toUpperCase();
             } else
             if (dataVerb) {
-                return dataVerb.toUpperCase();
+              return dataVerb.toUpperCase();
             } else {
                 if (proto) {
-                    return replace ? 'PUT' : proto.toUpperCase();
+                  return replace ? 'PUT' : proto.toUpperCase();
                 }
             }
         },
@@ -115,7 +123,7 @@
                 };
             user_options = user_options || {};
             for ( var attr in this.defaults ) {
-                if ( this.defaults.hasOwnProperty( attr ) ) {
+                if ( this.defaults.hasOwnProperty(attr) ) {
                     options[attr] = user_options[attr] || el_options[attr] || this.defaults[attr];
                 }
             }
@@ -125,10 +133,11 @@
           if ( xhr ){
             var notify = {};
             for ( var attr in $.SrBuj.notifyHeaders )
-              if ( $.SrBuj.notifyHeaders.hasOwnProperty( attr ) ) {
-                notify[attr] =  xhr.getResponseHeader( $.SrBuj.notifyHeaders[attr] );
+              if ( $.SrBuj.notifyHeaders.hasOwnProperty(attr) ) {
+                notify[attr] = xhr.getResponseHeader($.SrBuj.notifyHeaders[attr]);
               }
-              if ( notify.message ){ $.SrBuj.Util.notify(notify) }
+              if (notify.message){ $.SrBuj.Util.notify(notify) }
+              if (notify.remove){ $.SrBuj.Util.removeNotify() }
               if ( (/javascript/).test( xhr.getResponseHeader('Content-Type') )){
                 return true;
               }
@@ -172,11 +181,11 @@
           if (error) {
             $.SrBuj.changeDom('ERROR', $error, data.responseText);
             var notify = {};
-            for ( var attr in $.SrBuj.notifyHeaders )
-              if ( $.SrBuj.notifyHeaders.hasOwnProperty( attr ) ) {
-                notify[attr] =  data.getResponseHeader( $.SrBuj.notifyHeaders[attr] );
+            for (var attr in $.SrBuj.notifyHeaders)
+              if ($.SrBuj.notifyHeaders.hasOwnProperty(attr)) {
+                notify[attr] = data.getResponseHeader($.SrBuj.notifyHeaders[attr]);
               }
-              if ( notify.message ){ $.SrBuj.Util.notify(notify) }
+              if (notify.message){ $.SrBuj.Util.notify(notify) }
           }else {
             throw 'cant find data-error on element ' + e.target + ' maybe content_type missing on response?';
           }
@@ -203,15 +212,25 @@
              }else{
                gMsg.className = 'alert-info';
              }
-             gMsg.textContent = options.message;
+             gMsg.innerHTML = options.raw ? options.message
+                                          : $.SrBuj.Util.decodeUTF8(options.message);
              $('body').append(gMsg);
              gMsg.className += [' alert', options.side || 'right', options.position ||  'bottom', 'srbuj-notify' ].join(' ').toLowerCase();
-             options.time = Number( options.time ) > 0 ? options.time : 2000;
-             $.SrBuj.gMsg_interval =  window.setInterval( $.SrBuj.Util.removeNotify, options.time );
+             if (options.time != -1) {
+               options.time = Number(options.time) > 0 ? options.time : 2000;
+               $.SrBuj.gMsg_interval = window.setInterval( $.SrBuj.Util.removeNotify, options.time );
+             }
           },
           removeNotify: function(){
             $('#_growlingMsg').removeClass('srbuj-notify');
           },
+          randomCode: function(size) {
+            var size = !isNaN(size) && size < 12 ? size : 12
+            return Math.random().toString(36).substring(4).substring(0, size)
+          },
+          decodeUTF8: function(message) {
+            return decodeURIComponent(escape(message))
+          },
           link: function (user_options){
             /* This function will create a link with options, trigger it and remove the link afterwards
              * user_options must be a hash (Obj) with key: value without the data word
@@ -226,8 +245,20 @@
             var user_options = user_options || {};
             $.extend(user_options, {remote: true, srbuj: true});
             if(user_options.target && user_options.href){
-              var _srbujLink = document.createElement('a');
-              _srbujLink.id = '_srbujLink';
+              var _srbujLink = document.createElement('a'),
+                  randomKey = $.SrBuj.Util.randomCode(6);
+
+              _srbujLink.id = ['_srbujLink', randomKey].join('_');
+              if (user_options.force_refresh) {
+                var params     = { key: randomKey }
+                  , urlParams  = $.param(params)
+                  , splitedUrl = user_options.href.split(/\?.+/)
+                  , joinChar   = (splitedUrl.length > 1) ? '&'
+                                 : splitedUrl[0].match(/\?$/) ? ''
+                                   : '?';
+
+                user_options.href +=  joinChar + urlParams;
+              }
               _srbujLink.href = user_options.href;
                   delete user_options.href;
               for (var attr in user_options) {

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: SrBuj
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.0
 platform: ruby
 authors:
 - gagoar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-05 00:00:00.000000000 Z
+date: 2014-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '2.1'
 - !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'
 description: Better Unobtrusive JavaScript Respond
@@ -93,19 +93,18 @@ 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.0.3
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: http://github.com/gagoar/SrBuj/
 test_files: []
-has_rdoc: