zclip-rails 0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Henrik Wenz
+
+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,174 @@
+# Zclip::Rails
+
+Adds easy copytoclipboard functionality to your html-elements this is done by including the Jquery zClip libary to Rails 3.x.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'zclip-rails'
+
+And then execute:
+
+    $ bundle
+
+Add this line to your application.js:
+
+    //= require zclip
+
+## Usage
+
+Add an element (button, input, div, span etc.) somewhere in your .erb template e.g.:
+
+    <button type="button" id="copy-some-txt">example</button>
+
+Add this in some required js file of your app:
+
+    $('#copy-some-txt').zclip({
+        copy: "this is the text to copy"
+    });
+
+### Supply custom callback functions
+
+    $('#copy-some-txt').zclip({
+        copy: "this is the text to copy",
+        beforeCopy: function() {
+          alert("I am going to copy some text to your clipboard");
+        },
+        afterCopy: function() {
+          alert("done");
+        }
+    });
+
+### Settings
+
+<table>
+  <thead>
+    <tr>
+      <th colspan="3">
+        <h4>Settings</h4>
+      </th>
+    </tr>
+    <tr>
+      <th>
+        <h5>Variable</h5>
+      </th>
+      <th>
+        <h5>Default Value</h5>
+      </th>
+      <th>
+        <h5>Available Values</h5>
+      </th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>copy *</td>
+      <td>null</td>
+      <td>any string, or any javascript expression or function that returns a string</td>
+    </tr>
+    <tr>
+      <td>afterCopy</td>
+      <td>null</td>
+      <td>specify a function to call after text is copied.<br><br>(your afterCopy function will overwrite the default alert box.)</td>
+    </tr>
+    <tr>
+      <td>beforeCopy</td>
+      <td>null</td>
+      <td>specify a function to call before text is copied.</td>
+    </tr>
+    <tr>
+      <td>clickAfter</td>
+      <td>true</td>
+      <td>true<br>false</td>
+    </tr>
+    <tr>
+      <td>setHandCursor</td>
+      <td>true</td>
+      <td>true<br>false</td>
+    </tr>
+    <tr>
+      <td>setCSSEffects</td>
+      <td>true</td>
+      <td>true<br>false</td>
+    </tr>
+    <tr>
+      <td colspan="3" style="text-align:right">* required</td>
+    </tr>
+  </tbody>
+</table>
+
+### Notes
+
+#### Proper CSS effects
+zClip is a flash overlay, so it must provide the target element with "hover" and "active" classes to simulate native :hover and :active states. Be sure to write your CSS as follows for best results:
+
+    a:hover, a.hover {...}
+    a:active, a.active {...}
+
+    $('a.copy').zclip('show'); // enable zClip on the selected element
+
+    $('a.copy').zclip('hide'); // hide zClip on the selected element
+
+    $('a.copy').zclip('remove'); // remove zClip from the selected element
+
+### Requirements
+
+* jquery
+* Rails 3.x
+
+### Browsersupport
+
+The Zero Clipboard Library has been tested on the following browsers / platforms:
+
+<table>
+    <tr>
+      <td><strong>Browser</strong></td>
+      <td><strong>Windows XP SP3</strong></td>
+      <td><strong>Windows Vista</strong></td>
+      <td><strong>Mac OS X Leopard</strong></td>
+    </tr> 
+    <tr>
+      <td> Internet Exploder </td>
+      <td> 7.0 </td>
+      <td> 7.0 </td>
+      <td> - </td>
+    </tr> <tr>
+      <td> Firefox </td>
+      <td> 3.0 </td>
+      <td> 3.0 </td>
+      <td> 3.0 </td>
+    </tr> <tr>
+      <td> Safari </td>
+      <td> - </td>
+      <td> - </td>
+      <td> 3.0 </td>
+    </tr> <tr>
+      <td> Google Chrome </td>
+      <td> 1.0 </td>
+      <td> 1.0 </td>
+      <td> - </td>
+    </tr> 
+</table>
+
+Adobe Flash Flash Player versions 9 and 10 are supported.
+
+## TODO
+
+* Write a gem tests
+
+## Credits
+
+* Thanks to Joseph Huckaby for writing the zeroclipboard libary.
+
+* Thanks to [steamdev.com](http://www.steamdev.com/zclip/) for writing the jQuery wrapper.
+
+* Thanks to all the contributers to this Project.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/zclip-rails.rb

@@ -0,0 +1,8 @@
+require "zclip-rails/version"
+
+module Zclip
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/zclip-rails/version.rb

@@ -0,0 +1,5 @@
+module Zclip
+  module Rails
+    VERSION = "0.0.1"
+  end
+end

data/vendor/assets/javascripts/zclip.js

@@ -0,0 +1,2 @@
+//= require "./zero-clipboard/zero-clipboard"
+//= require "./zclip/jquery.zclip"

data/vendor/assets/javascripts/zclip/jquery.zclip.js.erb

@@ -0,0 +1,141 @@
+/*
+ * zClip :: jQuery ZeroClipboard v1.1.1
+ * http://steamdev.com/zclip
+ *
+ * Copyright 2011, SteamDev
+ * Released under the MIT license.
+ * http://www.opensource.org/licenses/mit-license.php
+ *
+ * Date: Wed Jun 01, 2011
+ *
+ * Modified by Henrik Wenz 
+ *
+ * Date: Mon Nov 07, 2012
+ */
+
+
+(function ($) {
+
+    $.fn.zclip = function (params) {
+
+        if (typeof params == "object" && !params.length) {
+
+            var settings = $.extend({
+
+                path: '<%= asset_path 'ZeroClipboard10.swf' %>',
+                copy: null,
+                beforeCopy: null,
+                afterCopy: null,
+                clickAfter: true,
+                setHandCursor: true,
+                setCSSEffects: true
+
+            }, params);
+      
+
+            return this.each(function () {
+
+                var o = $(this);
+
+                if (o.is(':visible') && (typeof settings.copy == 'string' || $.isFunction(settings.copy))) {
+
+                    ZeroClipboard.setMoviePath(settings.path);
+                    var clip = new ZeroClipboard.Client();
+                    
+                    if($.isFunction(settings.copy)){
+                      o.bind('zClip_copy',settings.copy);
+                    }
+                    if($.isFunction(settings.beforeCopy)){
+                      o.bind('zClip_beforeCopy',settings.beforeCopy);
+                    }
+                    if($.isFunction(settings.afterCopy)){
+                      o.bind('zClip_afterCopy',settings.afterCopy);
+                    }                    
+
+                    clip.setHandCursor(settings.setHandCursor);
+                    clip.setCSSEffects(settings.setCSSEffects);
+                    clip.addEventListener('mouseOver', function (client) {
+                        o.trigger('mouseenter');
+                    });
+                    clip.addEventListener('mouseOut', function (client) {
+                        o.trigger('mouseleave');
+                    });
+                    clip.addEventListener('mouseDown', function (client) {
+
+                        o.trigger('mousedown');
+                        
+      if(!$.isFunction(settings.copy)){
+         clip.setText(settings.copy);
+      } else {
+         clip.setText(o.triggerHandler('zClip_copy'));
+      }                        
+                        
+                        if ($.isFunction(settings.beforeCopy)) {
+                            o.trigger('zClip_beforeCopy');                            
+                        }
+
+                    });
+
+                    clip.addEventListener('complete', function (client, text) {
+
+                        if ($.isFunction(settings.afterCopy)) {
+                            
+                            o.trigger('zClip_afterCopy');
+
+                        } else {
+                            if (text.length > 500) {
+                                text = text.substr(0, 500) + "...\n\n(" + (text.length - 500) + " characters not shown)";
+                            }
+              
+                            o.removeClass('hover');
+                        }
+
+                        if (settings.clickAfter) {
+                            o.trigger('click');
+                        }
+
+                    });
+
+          
+                    clip.glue(o[0], o.parent()[0]);
+          
+        $(window).bind('load resize',function(){clip.reposition();});
+          
+
+                }
+
+            });
+
+        } else if (typeof params == "string") {
+
+            return this.each(function () {
+
+                var o = $(this);
+
+                params = params.toLowerCase();
+                var zclipId = o.data('zclipId');
+                var clipElm = $('#' + zclipId + '.zclip');
+
+                if (params == "remove") {
+
+                    clipElm.remove();
+                    o.removeClass('active hover');
+
+                } else if (params == "hide") {
+
+                    clipElm.hide();
+                    o.removeClass('active hover');
+
+                } else if (params == "show") {
+
+                    clipElm.show();
+
+                }
+
+            });
+
+        }
+
+    } 
+
+})(jQuery);

data/vendor/assets/javascripts/zero-clipboard/zero-clipboard.js

@@ -0,0 +1,337 @@
+// Simple Set Clipboard System
+// Author: Joseph Huckaby
+
+window.ZeroClipboard = {
+
+  version: "1.0.8",
+  clients: {}, // registered upload clients on page, indexed by id
+  moviePath: 'ZeroClipboard.swf', // URL to movie
+  nextId: 1, // ID of next movie
+
+  $: function(thingy) {
+    // simple DOM lookup utility function
+    if (typeof(thingy) == 'string') thingy = document.getElementById(thingy);
+    if (!thingy.addClass) {
+      // extend element with a few useful methods
+      thingy.hide = function() { this.style.display = 'none'; };
+      thingy.show = function() { this.style.display = ''; };
+      thingy.addClass = function(name) { this.removeClass(name); this.className += ' ' + name; };
+      thingy.removeClass = function(name) {
+        var classes = this.className.split(/\s+/);
+        var idx = -1;
+        for (var k = 0; k < classes.length; k++) {
+          if (classes[k] == name) { idx = k; k = classes.length; }
+        }
+        if (idx > -1) {
+          classes.splice( idx, 1 );
+          this.className = classes.join(' ');
+        }
+        return this;
+      };
+      thingy.hasClass = function(name) {
+        return !!this.className.match( new RegExp("\\s*" + name + "\\s*") );
+      };
+    }
+    return thingy;
+  },
+
+  setMoviePath: function(path) {
+    // set path to ZeroClipboard.swf
+    this.moviePath = path;
+  },
+
+  // use this method in JSNI calls to obtain a new Client instance
+  newClient: function() {
+    return new ZeroClipboard.Client();
+  },
+
+  dispatch: function(id, eventName, args) {
+    // receive event from flash movie, send to client
+    var client = this.clients[id];
+    if (client) {
+      client.receiveEvent(eventName, args);
+    }
+  },
+
+  register: function(id, client) {
+    // register new client to receive events
+    this.clients[id] = client;
+  },
+
+  getDOMObjectPosition: function(obj, stopObj) {
+    // get absolute coordinates for dom element
+    var info = {
+      left: 0,
+      top: 0,
+      width: obj.width ? obj.width : obj.offsetWidth,
+      height: obj.height ? obj.height : obj.offsetHeight
+    };
+
+    while (obj && (obj != stopObj)) {
+      info.left += obj.offsetLeft;
+      info.left += obj.style.borderLeftWidth ? parseInt(obj.style.borderLeftWidth) : 0;
+      info.top += obj.offsetTop;
+      info.top += obj.style.borderTopWidth ? parseInt(obj.style.borderTopWidth) : 0;
+      obj = obj.offsetParent;
+    }
+
+    return info;
+  },
+
+  Client: function(elem) {
+    // constructor for new simple upload client
+    this.handlers = {};
+
+    // unique ID
+    this.id = ZeroClipboard.nextId++;
+    this.movieId = 'ZeroClipboardMovie_' + this.id;
+
+    // register client with singleton to receive flash events
+    ZeroClipboard.register(this.id, this);
+
+    // create movie
+    if (elem) this.glue(elem);
+  }
+};
+
+ZeroClipboard.Client.prototype = {
+
+  id: 0, // unique ID for us
+  title: "",  // tooltip for the flash element
+  ready: false, // whether movie is ready to receive events or not
+  movie: null, // reference to movie object
+  clipText: '', // text to copy to clipboard
+  handCursorEnabled: true, // whether to show hand cursor, or default pointer cursor
+  cssEffects: true, // enable CSS mouse effects on dom container
+  handlers: null, // user event handlers
+  zIndex: 99, // default zIndex of the movie object
+
+  glue: function(elem, appendElem, stylesToAdd) {
+    // glue to DOM element
+    // elem can be ID or actual DOM element object
+    this.domElement = ZeroClipboard.$(elem);
+
+    // float just above object, or default zIndex if dom element isn't set
+    if (this.domElement.style.zIndex) {
+      this.zIndex = parseInt(this.domElement.style.zIndex, 10) + 1;
+    }
+
+    // check if the element has a title
+    if (this.domElement.getAttribute("title") != null) {
+      this.title = this.domElement.getAttribute("title");
+    }
+
+    if (typeof(appendElem) == 'string') {
+      appendElem = ZeroClipboard.$(appendElem);
+    }
+    else if (typeof(appendElem) == 'undefined') {
+      appendElem = document.getElementsByTagName('body')[0];
+    }
+
+    // find X/Y position of domElement
+    var box = ZeroClipboard.getDOMObjectPosition(this.domElement, appendElem);
+
+    // create floating DIV above element
+    this.div = document.createElement('div');
+    var style = this.div.style;
+    style.position = 'absolute';
+    style.left = '' + box.left + 'px';
+    style.top = '' + box.top + 'px';
+    style.width = '' + box.width + 'px';
+    style.height = '' + box.height + 'px';
+    style.zIndex = this.zIndex;
+
+    if (typeof(stylesToAdd) == 'object') {
+      for (var addedStyle in stylesToAdd) {
+        style[addedStyle] = stylesToAdd[addedStyle];
+      }
+    }
+
+    // style.backgroundColor = '#f00'; // debug
+
+    appendElem.appendChild(this.div);
+
+    this.div.innerHTML = this.getHTML( box.width, box.height );
+  },
+
+  getHTML: function(width, height) {
+    // return HTML for movie
+    var html = '';
+    var flashvars = 'id=' + this.id +
+      '&width=' + width +
+      '&height=' + height,
+            title = this.title ? ' title="' + this.title + '"' : '';
+
+    if (navigator.userAgent.match(/MSIE/)) {
+      // IE gets an OBJECT tag
+      var protocol = location.href.match(/^https/i) ? 'https://' : 'http://';
+      html += '<object' + title + ' classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" codebase="'+protocol+'download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=9,0,0,0" width="'+width+'" height="'+height+'" id="'+this.movieId+'"><param name="allowScriptAccess" value="always" /><param name="allowFullScreen" value="false" /><param name="movie" value="'+ZeroClipboard.moviePath+'" /><param name="loop" value="false" /><param name="menu" value="false" /><param name="quality" value="best" /><param name="bgcolor" value="#ffffff" /><param name="flashvars" value="'+flashvars+'"/><param name="wmode" value="transparent"/></object>';
+    }
+    else {
+      // all other browsers get an EMBED tag
+      html += '<embed' + title + ' id="'+this.movieId+'" src="'+ZeroClipboard.moviePath+'" loop="false" menu="false" quality="best" bgcolor="#ffffff" width="'+width+'" height="'+height+'" name="'+this.movieId+'" allowScriptAccess="always" allowFullScreen="false" type="application/x-shockwave-flash" pluginspage="http://www.macromedia.com/go/getflashplayer" flashvars="'+flashvars+'" wmode="transparent" />';
+    }
+    return html;
+  },
+
+  hide: function() {
+    // temporarily hide floater offscreen
+    if (this.div) {
+      this.div.style.left = '-2000px';
+    }
+  },
+
+  show: function() {
+    // show ourselves after a call to hide()
+    this.reposition();
+  },
+
+  destroy: function() {
+    // destroy control and floater
+    if (this.domElement && this.div) {
+      this.hide();
+      this.div.innerHTML = '';
+
+      var body = document.getElementsByTagName('body')[0];
+      try { body.removeChild( this.div ); } catch(e) {}
+
+      this.domElement = null;
+      this.div = null;
+    }
+  },
+
+  reposition: function(elem) {
+    // reposition our floating div, optionally to new container
+    // warning: container CANNOT change size, only position
+    if (elem) {
+      this.domElement = ZeroClipboard.$(elem);
+      if (!this.domElement) this.hide();
+    }
+
+    if (this.domElement && this.div) {
+      var box = ZeroClipboard.getDOMObjectPosition(this.domElement);
+      var style = this.div.style;
+      style.left = '' + box.left + 'px';
+      style.top = '' + box.top + 'px';
+    }
+  },
+
+  setText: function(newText) {
+    // set text to be copied to clipboard
+    this.clipText = newText;
+    if (this.ready) this.movie.setText(newText);
+  },
+
+  setTitle: function(newTitle) {
+    // set title of flash element
+    this.title = newTitle;
+    if (this.ready) this.movie.setTitle(newTitle);
+  },
+
+  addEventListener: function(eventName, func) {
+    // add user event listener for event
+    // event types: load, queueStart, fileStart, fileComplete, queueComplete, progress, error, cancel
+    eventName = eventName.toString().toLowerCase().replace(/^on/, '');
+    if (!this.handlers[eventName]) this.handlers[eventName] = [];
+    this.handlers[eventName].push(func);
+  },
+
+  setHandCursor: function(enabled) {
+    // enable hand cursor (true), or default arrow cursor (false)
+    this.handCursorEnabled = enabled;
+    if (this.ready) this.movie.setHandCursor(enabled);
+  },
+
+  setCSSEffects: function(enabled) {
+    // enable or disable CSS effects on DOM container
+    this.cssEffects = !!enabled;
+  },
+
+  receiveEvent: function(eventName, args) {
+    // receive event from flash
+    eventName = eventName.toString().toLowerCase().replace(/^on/, '');
+
+    // special behavior for certain events
+    switch (eventName) {
+      case 'load':
+        // movie claims it is ready, but in IE this isn't always the case...
+        // bug fix: Cannot extend EMBED DOM elements in Firefox, must use traditional function
+        this.movie = document.getElementById(this.movieId);
+        if (!this.movie) {
+          var self = this;
+          setTimeout( function() { self.receiveEvent('load', null); }, 1 );
+          return;
+        }
+
+        // firefox on pc needs a "kick" in order to set these in certain cases
+        if (!this.ready && navigator.userAgent.match(/Firefox/) && navigator.userAgent.match(/Windows/)) {
+          var self = this;
+          setTimeout( function() { self.receiveEvent('load', null); }, 100 );
+          this.ready = true;
+          return;
+        }
+
+        this.ready = true;
+        this.movie.setText( this.clipText );
+        this.movie.setTitle( this.title );
+        this.movie.setHandCursor( this.handCursorEnabled );
+        break;
+
+      case 'mouseover':
+        if (this.domElement && this.cssEffects) {
+          this.domElement.addClass('hover');
+          if (this.recoverActive) this.domElement.addClass('active');
+        }
+        break;
+
+      case 'mouseout':
+        if (this.domElement && this.cssEffects) {
+          this.recoverActive = false;
+          if (this.domElement.hasClass('active')) {
+            this.domElement.removeClass('active');
+            this.recoverActive = true;
+          }
+          this.domElement.removeClass('hover');
+        }
+        break;
+
+      case 'mousedown':
+        if (this.domElement && this.cssEffects) {
+          this.domElement.addClass('active');
+        }
+        break;
+
+      case 'mouseup':
+        if (this.domElement && this.cssEffects) {
+          this.domElement.removeClass('active');
+          this.recoverActive = false;
+        }
+        break;
+    } // switch eventName
+
+    if (this.handlers[eventName]) {
+      for (var idx = 0, len = this.handlers[eventName].length; idx < len; idx++) {
+        var func = this.handlers[eventName][idx];
+
+        if (typeof(func) == 'function') {
+          // actual function reference
+          func(this, args);
+        }
+        else if ((typeof(func) == 'object') && (func.length == 2)) {
+          // PHP style object + method, i.e. [myObject, 'myMethod']
+          func[0][ func[1] ](this, args);
+        }
+        else if (typeof(func) == 'string') {
+          // name of function
+          window[func](this, args);
+        }
+      } // foreach event handler defined
+    } // user defined handler for event
+  }
+
+};
+
+if (typeof module !== "undefined") {
+  module.exports = ZeroClipboard;
+}
+

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: zclip-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Henrik Wenz
+- Joseph Huckaby
+- SteamDev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.17
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.17
+description: Wrapper for jQuery - zClip (zeroclipboard). Adds easy copy to clipboard
+  functionality to your Rails 3.x app
+email:
+- handtrix@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/zclip-rails/version.rb
+- lib/zclip-rails.rb
+- vendor/assets/images/ZeroClipboard10.swf
+- vendor/assets/javascripts/zclip/jquery.zclip.js.erb
+- vendor/assets/javascripts/zclip.js
+- vendor/assets/javascripts/zero-clipboard/zero-clipboard.js
+- LICENSE
+- README.md
+homepage: https://github.com/HaNdTriX/zclip-rails
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Adds easy copy to clipboard functionality to your Rails 3.x app
+test_files: []