shutterbug 0.1.1 → 0.1.2

data/.travis.yml

@@ -3,7 +3,6 @@ rvm:
   - "1.9.2"
   - "1.9.3"
   - "2.0.0"
-  - jruby-18mode # JRuby in 1.8 mode
   - jruby-19mode # JRuby in 1.9 mode
   - rbx-19mode
 # uncomment this line if your project needs to run something other than `rake`:

data/README.md

@@ -6,7 +6,7 @@
 
 ## Overview ##
 
-A rack utility using phantomjs that will create and save images (pngs) from parts of your html's documents current dom. These images become available as public png resources in the rack application. Currently shutterbug supports HTML, SVG and Canvas elements. Here is a sampel config.ru file:
+A rack utility using phantomjs that will create and save images (pngs) from parts of your html's documents current dom. These images become available as public png resources in the rack application. Currently shutterbug supports HTML, SVG and Canvas elements. Here is a sample config.ru file:
 
 
     use Shutterbug::Rackapp do |config|
@@ -22,6 +22,12 @@ Shutterbug is distributed as a Ruby Gem. The rack service delivers a javascript
 
   ![System Overview](images/shutterbug.jpg)
 
+## Requirements & Dependencies
+
+  * shutterbug.js requires [JQuery](http://jquery.com/), and expects JQuery to be found via window.$ . Note that shutterbug will allow you to pass in JQuery through its constructor too, in the event that its not at window.$
+  * Ruby 1.9x or greater is required to run the Rack application.
+  * [PhantomJS](http://phantomjs.org/) is requird to run the Rack application.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -48,7 +54,7 @@ See [LICENSE.md](LICENSE.md) for more information.
 
 After adding `use Shutterbug::Rackapp` to your config.ru file, you can convert pieces of your web-page into png images.  Just follow these steps:
 
-include the following javascript in your pages:
+Include the following javascript in your pages:
 
      <script src='http://<yourhost:port>/shutterbug/shutterbug.js' type='text/javascript'></script>
 
@@ -59,9 +65,12 @@ Elsewhere in your javascript, something like this:
         shutterbug.getDomSnapshot();
       });
 
-This will replace the contents of `$("#outselector")` with an `<img src="http://<yourhost:port>/gete_png/sha1hash>` tag which will magically spring into existance.  `optCallbackFn` is an optional callback function which will be invoked whith the `<img src=..>` tag. `optIdentifier` is useful when there are multiple snapshot buttons targetting multiple iframes, and you need to verify the destination for various snapshot window message events.
+This will replace the contents of `$("#outselector")` with an `<img src="http://<yourhost:port>/gete_png/sha1hash>` tag which will magically spring into existance.  `optCallbackFn` is an optional callback function which will be invoked with the `<img src=..>` tag. `optIdentifier` is useful when there are multiple snapshot buttons targetting multiple iframes, and you need to verify the destination for various snapshot window message events.
+
+## Advanced usage
 
-## IFrame support
+
+### IFrame support
 
 If the element being snapshot'd is an iframe then the iframe needs to handle a postMessage API.
 Shutterbug will run something like the following JS to get the html of the iframe
@@ -95,7 +104,15 @@ Additionally the `#outselector` in the iframe is not used.
 You could also reimplement this API in the html of the iframe if you'd like. However the shutterbug implementation includes
 some useful things like finding and including all the css on the page, and 'serializing' canvas elements into images.
 
-## Deploying on Heroku ##
+### Shutterbug JQuery custom events ###
+
+Shutterbug emits a jQuery custom event called 'shutterbug-saycheese' just prior to copying styles, elements, and canvas contents to the document fragment. This allows applications to do any preparation required before they are ready to be snapshotted.
+
+After all elements are copied, emits a 'shutterbug-asyouwere' event, so that any customized preperations can be torn down again.
+
+After all elements are copied, emits a 'shutterbug-asyouwere' event.
+
+### Deploying on Heroku ###
 
 To deploy on heroku, you are going to want to modify your stack following [these instructions](http://nerdery.crowdmob.com/post/33143120111/heroku-ruby-on-rails-and-phantomjs).
 
@@ -114,7 +131,7 @@ Your app should have a config.ru that looks something like this:
 
     # Without a complete set of S3 credentials, Shutterbug
     # Places images in a temporary directory where
-    # you will LOOSE your images...
+    # you will LOSE your images...
     use Shutterbug::Rackapp do |config|
       config.uri_prefix = "http://<your app name>.herokuapp.com/"
       config.path_prefix = "/shutterbug"
@@ -143,17 +160,15 @@ And a Procfile which looks like this:
 *  Better abstraction phantomjs command line invocation. Use phantomjs.rb ?
 *  Use [sprockets](https://github.com/sstephenson/sprockets) for and coffee.erb for shutterbug.js
 *  Write Tests.
-*  Write Documentation.
 
-## Contributing
 
+## Contributing
 
 2. Join the mailing list: [email](mailto:shutterbug-dev+subscribe@googlegroups.com) or [web](https://groups.google.com/forum/?hl=en#!forum/shutterbug-dev)
 2. Fork this project.
-com/forum/#!forum/shutterbug-dev)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-© 2013 The concord Consortium.
+© 2013 The Concord Consortium.

data/lib/shutterbug.rb

@@ -1,5 +1,5 @@
 module Shutterbug
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
   autoload :Rackapp,        "shutterbug/rackapp"
   autoload :Configuration,  "shutterbug/configuration"
   autoload :Storage,        "shutterbug/storage"

data/lib/shutterbug/handlers/shutterbug.js

@@ -23,6 +23,8 @@
   var getHtmlFragment = function() {
     var $element = $(this.element);
 
+    $element.trigger('shutterbug-saycheese');
+
     var css     = $('<div>').append($('link[rel="stylesheet"]').clone()).append($('style').clone()).html();
     var width   = $element.width();
     var height  = $element.height();
@@ -59,6 +61,9 @@
       height: height,
       base_url: getBaseUrl()
     };
+
+    $element.trigger('shutterbug-asyouwere');
+
     return html_content;
   };
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shutterbug
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-24 00:00:00.000000000 Z
+date: 2013-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -234,7 +234,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -698833425453840935
+      hash: 2889769158720153016
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -243,7 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -698833425453840935
+      hash: 2889769158720153016
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25