zeroclipboard-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,126 @@
+# Zeroclipboard::Rails
+
+Adds the Zeroclipboard libary to your Rails 3.x app.
+If you would like to use JQuery try the zClip libary instead.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'zeroclipboard-rails'
+
+And then execute:
+
+    $ bundle
+
+Add this line to your application.js file:
+
+    //= require zero-clipboard
+
+## Usage
+
+### Clients
+
+Now you are ready to create one or more Clients. A client is a single instance of the clipboard library on the page, linked to a particular button or other DOM element. You probably only need a single instance, but if you have multiple copy-to-clipboard buttons on your page, potentially containing different text, you can activate an instance for each. Here is how to create a client instance:
+
+    var clip = new ZeroClipboard.Client();
+
+Next, you can set some options.
+
+### Setting Options
+
+Once you have your client instance, you can set some options. These include setting the initial text to be copied, amongst other things. The following subsections describe all the available options you can set.
+
+### Text To Copy
+
+This function allows you to set the text to be copied to the clipboard, once the user clicks on the control. You can call this function at any time; when the page first loads, or later in an onMouseOver or onMouseDown handler. Example:
+
+    clip.setText( "Copy me!" );
+
+### Hand Cursor
+
+This setting controls whether the "hand" or "arrow" cursor is shown when the mouse hovers over the Flash movie. Here is an example:
+
+    clip.setHandCursor( true );
+
+The only values accepted are true (show "hand" cursor), or false (show "arrow" cursor). The default is true. You can set this option at any time.
+
+### Gluing
+
+Gluing refers to the process of "linking" the Flash movie to a DOM element on the page. Meaning, the library will automatically generate a movie that is the exact size of the DOM element, and float it just above the element. Since the Flash movie is completely transparent, the user sees nothing out of the ordinary.
+
+The Flash movie receives the click event and copies the current text (last set with setText()) to the clipboard (a requirement of Flash Player 10 is that a user click event inside the movie must initiate the thread that interacts with the clipboard). Also, mouse actions like hovering and mouse-down generate events that you can capture (see Event Handlers below) and set CSS classes on your DOM element too (see CSS Effects below).
+
+Here is how to glue your clip library instance to a DOM element:
+
+     clip.glue( 'd_clip_button' );
+
+You can pass in a DOM element ID (as shown above), or a reference to the actual DOM element object itself. The rest all happens automatically -- the movie is created, all your options set, and it is floated above the element, awaiting clicks from the user.
+
+The glue system is an optional implementation. If you would prefer to handle your own implementation of the Flash movie, see Custom Implementation below.
+
+### Recommended Implementation
+
+It is highly recommended you create a "container" DIV element around your button, set its CSS "position" to "relative", and place your button just inside. Then, pass two arguments to glue(), your button DOM element or ID, and the container DOM element or ID. This way Zero Clipboard can position the floating Flash movie relative to the container DIV (not the page body), resulting in much more exact positioning. Example (HTML):
+
+    <div id="d_clip_container" style="position:relative">
+      <div id="d_clip_button">Copy to Clipboard</div>
+    </div>
+
+And the code:
+
+    clip.glue( 'd_clip_button', 'd_clip_container' );
+
+Note that gluing to a container element does not work with the reposition() method (see next section).
+
+
+For all usage options please visit the [zeroclipboard doc page](http://code.google.com/p/zeroclipboard/wiki/Instructions)
+
+## Browser Support
+
+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.
+
+### Credits
+
+Thanks to Joseph Huckaby and all the [contributers](http://code.google.com/u/100866768200529838600/)!
+
+
+## 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/zeroclipboard-rails.rb

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

data/lib/zeroclipboard-rails/version.rb

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

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

@@ -0,0 +1,2 @@
+//= require "./zero-clipboard/zero-clipboard"
+//= require "./zero-clipboard/asset-path"

data/vendor/assets/javascripts/zero-clipboard/asset-path.js.erb

@@ -0,0 +1 @@
+ZeroClipboard.setMoviePath( '<%= asset_path 'ZeroClipboard10.swf' %>' );

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,70 @@
+--- !ruby/object:Gem::Specification
+name: zeroclipboard-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Henrik Wenz
+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'
+description: Adds the Javascript ZeroClipboard libary to Rails 3.x
+email:
+- handtrix@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/zeroclipboard-rails/version.rb
+- lib/zeroclipboard-rails.rb
+- vendor/assets/images/ZeroClipboard.swf
+- vendor/assets/images/ZeroClipboard10.swf
+- vendor/assets/javascripts/zero-clipboard/asset-path.js.erb
+- vendor/assets/javascripts/zero-clipboard/zero-clipboard.js
+- vendor/assets/javascripts/zero-clipboard.js
+- LICENSE
+- README.md
+homepage: ''
+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 the Javascript ZeroClipboard libary to Rails 3.x
+test_files: []