marlene 0.1.1

data/.gitignore

@@ -0,0 +1,5 @@
+bin/bm.pl
+test*.js
+TODO.markdown
+*.bookmarklet
+pkg

data/README.markdown

@@ -0,0 +1,17 @@
+Marlene - A bookmarklet builder
+===============================
+
+Marlene is inspired by John Grubers Perl based [JavaScript Bookmarklet Builder](http://daringfireball.net/2007/03/javascript_bookmarklet_builder).
+
+
+
+Specs
+-----
+
+run specs with
+
+    spec spec/marlene_spec.rb --format specdoc
+
+or
+
+    autospec

data/Rakefile

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + "/lib/marlene.rb"
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "marlene"
+    gemspec.version = Marlene::VERSION
+    gemspec.summary = "Bookmarklet Generator from a local or remote JavaScript file"
+    gemspec.description = "Marlene generates bookmarklet files or bookmarklet-pages from existing local javascript files or from remote javascript files represented by a URL."
+    gemspec.email = "thomduerr@gmail.com"
+    gemspec.homepage = "http://github.com/thomd/marlene/"
+    gemspec.authors = ["Thomas Duerr"]
+    gemspec.add_dependency "yui-compressor", ">= 0.9.1"
+    gemspec.add_dependency "mustache", ">= 0.11.2"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/bin/bm.pl

@@ -0,0 +1,33 @@
+#!/usr/bin/env perl
+#
+# http://daringfireball.net/2007/03/javascript_bookmarklet_builder
+
+use strict;
+use warnings;
+use URI::Escape qw(uri_escape_utf8);
+use open  IO  => ":utf8",       # UTF8 by default
+          ":std";               # Apply to STDIN/STDOUT/STDERR
+
+my $src = do { local $/; <> };
+
+# Zap the first line if there's already a bookmarklet comment:
+$src =~ s{^// ?javascript:.+\n}{};
+my $bookmarklet = $src;
+
+for ($bookmarklet) {
+    s{^\s*//.+\n}{}gm;  # Kill comments.
+    s{\t}{ }gm;         # Tabs to spaces
+    s{[ ]{2,}}{ }gm;    # Space runs to one space
+    s{^\s+}{}gm;        # Kill line-leading whitespace
+    s{\s+$}{}gm;        # Kill line-ending whitespace
+    s{\n}{}gm;          # Kill newlines
+}
+
+# Escape single- and double-quotes, spaces, control chars, unicode:
+$bookmarklet = "javascript:" .
+    uri_escape_utf8($bookmarklet, qq('" \x00-\x1f\x7f-\xff));
+
+print "// $bookmarklet\n" . $src;
+
+# Put bookmarklet on clipboard:
+`/bin/echo -n '$bookmarklet' | /usr/bin/pbcopy`;

data/bin/marlene

@@ -0,0 +1,112 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'trollop'
+require 'uri'
+require 'net/http'
+require File.dirname(__FILE__) + '/../lib/marlene.rb'
+
+opts = Trollop::options do
+  version "Marlene 0.1 (c) 2010 Thomas Duerr"
+  banner <<-EOS
+Marlene builds code for bookmarklets from a local or from a remote hoted javascript file.
+
+Usage:
+       marlene [options] <input>
+       
+where <input> is a file path or an URI to a javascript file.
+       
+[options] are:
+EOS
+
+  opt :file, "write bookmarklet to file. Otherwise output goes to clipboard (OSX only) and STDOUT", :default => false
+  opt :include, "include bookmarklet code on top of input file as a comment", :default => false
+#  opt :jslint, "analyse javascript code via jslint before", :default => false, :short => "-l"
+  opt :publish, "build html page for bookmarklet and open it in a browser.", :default => false
+end 
+
+Trollop::die "need at least a javascript file-path or a valid URI as input" if ARGV.empty?
+
+input = ARGV.to_s
+
+uri = URI.extract(input, 'http')[0]
+if uri.nil? then
+
+  #
+  # ===== local javascript ==========
+  #
+
+  # stop if file does not exist
+  Trollop::die "#{input} must exist" unless File.exist?(input) if input
+
+  # read javascript file
+  local_file = File.read(input)
+
+  # build bookmarklet
+  bookmarklet = local_file.compress.to_bookmarklet
+
+  # include bookmarklet code as comment on top of input file
+  if opts[:include]
+  
+    # remove first line if there's already a bookmarklet comment and 
+    input.gsub!(/^\/\/ javascript:.+\n\n/, '')
+
+    File.open(input, "w") do |f|      
+      f.puts "// #{bookmarklet}\n\n#{local_file}"
+    end
+  end
+   
+else 
+  
+  #
+  # ===== remote javascript ==========
+  #
+  
+  # stop if URIs HTTP status is not 200
+  def remote_file_exists?(url)
+    url = URI.parse(url)
+    Net::HTTP.start(url.host, url.port) do |http|
+      return http.head(url.request_uri).code == "200"
+    end
+  end  
+  Trollop::die "#{uri} must exist" unless remote_file_exists?(uri) if uri
+
+  # build bookmarklet loadscript
+  bookmarklet = uri.to_loader_script.compress.to_bookmarklet
+
+end
+
+
+#
+# ===== output ==========
+#
+if opts[:file]
+
+  # write bookmarklet code to a file "filename.bookmarklet"
+  output = input.gsub(Regexp.new(File.extname(input)), ".bookmarklet") 
+  File.open(output, "w").write(bookmarklet)
+else
+
+  # copy bookmarklet code to clipboard (OSX only)
+  IO.popen('pbcopy', 'w').puts bookmarklet
+end
+  
+
+# generate and open html page with bookmarklet-link in order to drag'n'drop bookmarklet up to bookmarks-bar 
+if opts[:publish]
+  begin
+    require 'bcat'
+    IO.popen('bcat', 'w').puts bookmarklet.to_bookmarklet_page
+  rescue LoadError => e
+    puts "Error: Publishing requires bcat gem: http://rtomayko.github.com/bcat/"
+    exit 1
+  end
+end
+  
+
+# write to stdout 
+if !opts[:publish] && !opts[:file]
+  puts bookmarklet
+end
+
+

data/lib/marlene.rb

@@ -0,0 +1,60 @@
+require "uri"
+require "yui/compressor"
+require "mustache"
+
+
+module Marlene  
+
+  VERSION          = "0.1.1"
+  ANCHOR_TEXTNODE  = "bookmarklet"
+  PSEUDOCOL        = "javascript:"
+  LOADER_SCRIPT    = File.join(File.dirname(__FILE__), 'templates', 'loader.js')
+  BOOKMARKLET_PAGE = File.join(File.dirname(__FILE__), 'templates', 'page.html')
+
+  def yui_compressor
+    YUI::JavaScriptCompressor.new(:munge => true)
+  end
+  
+end
+
+
+class String
+  include Marlene
+
+  # transform into bookmarklet
+  def to_bookmarklet
+    js = self.to_s
+    js.gsub!(/^ +/, '')                # remove line-leading whitespace
+    js.gsub!(/ +$/, '')                # remove line-ending whitespace
+    js.gsub!(/\t/, ' ')                # replace tabs with spaces
+    js.gsub!(/ +/, ' ')                # replace multiple spaces with a single space
+    js.gsub!(/^ *\/\/.+\n/, '')        # remove comment lines starting with a double slash
+    js.gsub!(/\n/, '')                 # remove all newlines
+    js = URI.escape(js, %Q(''" ))      # URI escape: single- and double-quotes, spaces
+    PSEUDOCOL + js                     # prefix with 'javascript:'
+  end
+
+  # use YUI compressor to minimize javascript code
+  def compress
+    yui_compressor.compress(self)
+  end
+
+  # insert into loader script a javascript URL
+  def to_loader_script
+    Mustache.template_file = LOADER_SCRIPT
+    loader = Mustache.new
+    loader[:script] = self
+    loader.render
+  end
+  
+  # insert bookmarklet into html code for drag-drop bookmarklet up to linkbar
+  def to_bookmarklet_page
+    Mustache.template_file = BOOKMARKLET_PAGE
+    page = Mustache.new
+    page[:bookmarklet] = self
+    page[:anchor] = ANCHOR_TEXTNODE
+    page.render
+  end
+  
+end
+

data/lib/templates/loader.js

@@ -0,0 +1,6 @@
+(function(){
+    var script = document.createElement('script');
+    script.type = 'text/javascript';
+    script.src = '{{script}}?' + (new Date().getTime());
+    document.getElementsByTagName('body')[0].appendChild(script);
+})()

data/lib/templates/page.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title>{{anchor}}</title>
+  </head>
+  <body>
+    <a href="{{{bookmarklet}}}">{{anchor}}</a>  
+  </body>
+</html>

data/spec/marlene_spec.rb

@@ -0,0 +1,105 @@
+require "rubygems"
+require "spec"
+require File.dirname(__FILE__) + '/../lib/marlene.rb'
+
+describe "Marlene bookmark generator" do
+
+  before(:all) do
+    @remote_url = "http://example.com/this/is/a/remote/javascript.js"   
+  end
+
+  it "should transform a local javascript file to a bookmarklet" do
+    input  = javascript_local
+    output = bookmarklet_local
+    input.to_bookmarklet.should == output
+  end
+  
+  it "should transform and escape a local javascript file to a bookmarklet" do
+    input  = javascript_local_unescaped
+    output = bookmarklet_local_escaped
+    input.to_bookmarklet.should == output
+  end
+  
+  it "should transform an external javascript into a bookmarklet loaderscript" do
+    input  = @remote_url
+    output = bookmarklet_remote
+    input.to_loader_script.to_bookmarklet.should == output
+  end
+
+  it "should compress javascript code with a javascript compressor" do
+    input  = javascript_local
+    output = javascript_local_compressed
+    input.compress.should == output
+  end
+  
+  it "should transform a local javascript file to a compressed bookmarklet" do
+    input  = javascript_local
+    output = bookmarklet_local_compressed
+    input.compress.to_bookmarklet.should == output
+  end
+  
+  it "should transform an external javascript into a compressed bookmarklet loaderscript" do
+    input  = @remote_url
+    output = bookmarklet_remote_compressed
+    input.to_loader_script.compress.to_bookmarklet.should == output
+  end
+  
+  it "should write a html page with a bookmarklet link" do
+    input  = javascript_local_compressed
+    output = html_page_compressed_bookmarklet
+    input.compress.to_bookmarklet.to_bookmarklet_page.should == output
+  end
+
+end
+
+# fixtures
+
+def javascript_local
+  "// a contains method for arrays
+  Array.prototype.contains = function(item){
+      return this.indexOf(item) > -1;
+  }
+
+  alert([1,2,3,4,5].contains(4));"
+end
+
+def javascript_local_unescaped
+  %Q{console.info(indentString + methodName, '-> ', result, "(", new Date - startTime, 'ms', ")");}
+end
+
+def javascript_local_compressed
+  "Array.prototype.contains=function(a){return this.indexOf(a)>-1};alert([1,2,3,4,5].contains(4));"
+end
+
+def bookmarklet_local
+  "javascript:Array.prototype.contains%20=%20function(item){return%20this.indexOf(item)%20>%20-1;}alert([1,2,3,4,5].contains(4));"
+end
+
+def bookmarklet_local_escaped
+  %Q{javascript:console.info(indentString%20+%20methodName,%20%27->%20%27,%20result,%20%22(%22,%20new%20Date%20-%20startTime,%20%27ms%27,%20%22)%22);}
+end
+
+def bookmarklet_local_compressed
+  "javascript:Array.prototype.contains=function(a){return%20this.indexOf(a)>-1};alert([1,2,3,4,5].contains(4));"
+end
+
+def bookmarklet_remote
+  "javascript:(function(){var%20script%20=%20document.createElement(%27script%27);script.type%20=%20%27text/javascript%27;script.src%20=%20%27http://example.com/this/is/a/remote/javascript.js?%27%20+%20(new%20Date().getTime());document.getElementsByTagName(%27body%27)[0].appendChild(script);})()"
+end
+
+def bookmarklet_remote_compressed
+  "javascript:(function(){var%20a=document.createElement(%22script%22);a.type=%22text/javascript%22;a.src=%22http://example.com/this/is/a/remote/javascript.js?%22+(new%20Date().getTime());document.getElementsByTagName(%22body%22)[0].appendChild(a)})();"
+end
+
+def html_page_compressed_bookmarklet
+  %Q(<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title>bookmarklet</title>
+  </head>
+  <body>
+    <a href="javascript:Array.prototype.contains=function(b){return%20this.indexOf(b)>-1};alert([1,2,3,4,5].contains(4));">bookmarklet</a>  
+  </body>
+</html>)
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: marlene
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Thomas Duerr
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-09 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yui-compressor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 57
+        segments: 
+        - 0
+        - 9
+        - 1
+        version: 0.9.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mustache
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 55
+        segments: 
+        - 0
+        - 11
+        - 2
+        version: 0.11.2
+  type: :runtime
+  version_requirements: *id002
+description: Marlene generates bookmarklet files or bookmarklet-pages from existing local javascript files or from remote javascript files represented by a URL.
+email: thomduerr@gmail.com
+executables: 
+- bm.pl
+- marlene
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- README.markdown
+- Rakefile
+- bin/marlene
+- lib/marlene.rb
+- lib/templates/loader.js
+- lib/templates/page.html
+- spec/marlene_spec.rb
+- bin/bm.pl
+has_rdoc: true
+homepage: http://github.com/thomd/marlene/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Bookmarklet Generator from a local or remote JavaScript file
+test_files: 
+- spec/marlene_spec.rb