RubyGems - easymarklet - Versions diffs - 0.0.1 → 0.0.2 - Mend

easymarklet 0.0.1 → 0.0.2

Files changed (10) hide show

data/README.md CHANGED Viewed

@@ -14,23 +14,23 @@ Then run:
     bundle install
-Building your bookmarklet code
----------------------------------
-Add a file to your app/assets/javascripts directory that will hold the
-code for your bookmarklet.  For example :
-app/assets/javascripts/foobaz_bookmarklet.js
+Types of bookmarklets
+----------------------------------
-    (function(){
-      var p = document.createElement('p');
-      p.appendChild(document.createTextNode('Foo vs. Baz'));
-      document.body.appendChild(p);
-    })();
+Easymarklet supports two types of bookmarklets, simple bookmarklets and
+xdm bookmarklets.  Simple bookmarklets allow new functionality to be
+injected into a page, but they are restricted in the amount of
+communication that can go back to your app.  Xdm bookmarklets use
+[easyXDM](http://easyxdm.net/wp/) to allow cross domain communication.
-Linking to your bookmarklet
+Generating a new simple bookmarklet
 ---------------------------------
+Run something like this:
+    rails generate easymarklet:simple foobaz
 Then in a view template you can link to your bookmarklet using the
 easymarklet_js helper.
@@ -41,24 +41,28 @@ load your bookmarklet code into the current page and execute it.  Place
 some instructions for your users near the link that tells them to drag
 the link into their bookmark bar.
-XDM Bookmarklets
-----------------------------------
+[See the Simple Bookmarklets wiki page for more info.](https://github.com/Octo-Labs/easymarklet/wiki/Simple-Bookmarklets)
-* Note : XDM is a work in progress.
-To enable cross domain communictaion between your site and other pages
-on the 'net we need to be able to generate a fully qualified URL to your
-bookmarklet code.  To set the correct host you should add this to each
-of your confing/environment/*.rb files.  Adjust the :host accordingly.
-:port is optional.
+Generating a new XDM bookmarklet
+----------------------------------
+To enable cross domain communictaion between your site and other pages on the 'net we need to be able to generate a fully qualified URL to your bookmarklet code.  To set the correct host you should add this to each of your confing/environment/*.rb files.  Adjust the :host accordingly. :port is optional.
-    config.action_controller.default_url_options = {:host =>
-'localhost', :port => 3000}
+    config.action_controller.default_url_options = {:host => 'localhost', :port => 3000}
 XDM bookmarklet code acts as a consumer for data or a service that is
 supplied by the provider, a page on your app.
+To generate your bookmarklet run something like this:
+    rails generate easymarklet:xdm barbaz_xdm
+Then link to the consumer in a view:
+    <%= link_to "Bar Baz!", easymarklet_js('barbaz_xdm_consumer.js') %>
+[See the XDM Bookmarklets wiki page for more info](https://github.com/Octo-Labs/easymarklet/wiki/XDM-Bookmarklets)
 This project rocks and uses MIT-LICENSE.

data/lib/easymarklet/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Easymarklet
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/generators/easymarklet/xdm/templates/views/easymarklet_layout.html.erb ADDED Viewed

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title><%= name.titleize %> Producer</title>
+  <%%= stylesheet_link_tag    "application", :media => "all" %>
+  <%%= javascript_include_tag "application" %>
+  <%%= csrf_meta_tags %>
+</head>
+<body>
+<%%= yield %>
+<%%= javascript_include_tag "<%= name %>_producer" %>
+</body>
+</html>

data/lib/generators/easymarklet/xdm/templates/xdm_bookmarklet.js CHANGED Viewed

@@ -1,6 +1,6 @@
 (function(){
-  var <%= name.titleize %>Bookmarklet = {
+  var <%= name.camelize %>Bookmarklet = {
     visible : true,
     consumer : {
@@ -17,7 +17,7 @@
     }
   }
-  window.<%= name.titleize %>Bookmarklet = <%= name.titleize %>Bookmarklet;
+  window.<%= name.camelize %>Bookmarklet = <%= name.camelize %>Bookmarklet;
 })();

data/lib/generators/easymarklet/xdm/templates/xdm_consumer.js CHANGED Viewed

@@ -1,5 +1,5 @@
 //= require easymarklet/consumer
-//= require <%= name %>_xdm
+//= require <%= name %>_bookmarklet
 //
-var <%= name %>_consumer = new Easymarklet.Consumer(<%= name.titleize %>Bookmarklet);
+var <%= name %>_consumer = new Easymarklet.Consumer(<%= name.camelize %>Bookmarklet);
 <%= name %>_consumer.init();

data/lib/generators/easymarklet/xdm/templates/xdm_producer.js CHANGED Viewed

@@ -1,6 +1,6 @@
-//= require easymarklet/producer
-//= require <%= name %>_xdm
 //= require easyXDM
+//= require easymarklet/producer
+//= require <%= name %>_bookmarklet
-var <%= name %>_producer = new Easymarklet.Producer(<%= name.titleize %>Bookmarklet);
+var <%= name %>_producer = new Easymarklet.Producer(<%= name.camelize %>Bookmarklet);
 <%= name %>_producer.init();

data/lib/generators/easymarklet/xdm/templates/xdm_producer_controller.rb ADDED Viewed

@@ -0,0 +1,8 @@
+class <%= name.camelize %>ProducerController < ApplicationController
+  layout '<%= name %>_producer'
+  def index
+  end
+end

data/lib/generators/easymarklet/xdm/templates/xdm_producer_index.html.erb ADDED Viewed

@@ -0,0 +1,3 @@
+This is the <%= name %> producer.
+<%%= link_to_function "Close", "<%= name %>_producer.closeFrame()" %>

data/lib/generators/easymarklet/xdm/xdm_generator.rb CHANGED Viewed

@@ -2,10 +2,17 @@ module Easymarklet
   class XdmGenerator < Rails::Generators::NamedBase
     source_root File.expand_path('../templates', __FILE__)
-    def copy_js_file
+    def copy_files
       template "xdm_bookmarklet.js", "app/assets/javascripts/#{file_name}_bookmarklet.js"
       template "xdm_consumer.js", "app/assets/javascripts/#{file_name}_consumer.js"
       template "xdm_producer.js", "app/assets/javascripts/#{file_name}_producer.js"
+      template "xdm_producer_controller.rb", "app/controllers/#{file_name}_producer_controller.rb"
+      template "xdm_producer_index.html.erb", "app/views/#{file_name}_producer/index.html.erb"
+      template "views/easymarklet_layout.html.erb", "app/views/layouts/#{file_name}_producer.html.erb"
+    end
+    def create_routes
+      route("match '#{file_name}' => '#{file_name}_producer#index'")
     end
     def display_msg

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easymarklet
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease:
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-11-06 00:00:00.000000000 Z
+date: 2012-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -173,9 +173,12 @@ files:
 - lib/generators/easymarklet/simple/simple_generator.rb
 - lib/generators/easymarklet/simple/templates/simple_bookmarklet.js
 - lib/generators/easymarklet/simple/USAGE
+- lib/generators/easymarklet/xdm/templates/views/easymarklet_layout.html.erb
 - lib/generators/easymarklet/xdm/templates/xdm_bookmarklet.js
 - lib/generators/easymarklet/xdm/templates/xdm_consumer.js
 - lib/generators/easymarklet/xdm/templates/xdm_producer.js
+- lib/generators/easymarklet/xdm/templates/xdm_producer_controller.rb
+- lib/generators/easymarklet/xdm/templates/xdm_producer_index.html.erb
 - lib/generators/easymarklet/xdm/USAGE
 - lib/generators/easymarklet/xdm/xdm_generator.rb
 - lib/tasks/easymarklet_tasks.rake
@@ -196,7 +199,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4490360310275386110
+      hash: 1957519611268656497
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -205,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4490360310275386110
+      hash: 1957519611268656497
 requirements: []
 rubyforge_project:
 rubygems_version: 1.8.24