launchy_opensearch 1.0.0 → 1.1.0

data/History.txt

@@ -1,4 +1,18 @@
+=== 1.1.0 / 2009-03-08
+
+* 1 major enhancements
+
+  * Better commandline outputs
+  * Now compatibile with ruby 1.9.1
+
+* 3 minor enhancement
+
+  * Added a --version command to output version and licensing information
+  * Added automated tests
+  * Some more comments
+
 === 1.0.0 / 2009-02-24
 
-* Initial release
+* 1 major enhancement
 
+  * Birthday!

data/Manifest.txt

@@ -4,4 +4,10 @@ README.txt
 COPYING.txt
 Rakefile
 bin/launchy_opensearch
-lib/launchy_opensearch.rb
+lib/launchy_opensearch.rb
+spec/launchy_opensearch_spec.rb
+spec/fixtures/launchy.ini
+spec/fixtures/discogs.xml
+spec/fixtures/secure-wikipedia-english.xml
+spec/fixtures/youtube.xml
+

data/README.txt

@@ -11,9 +11,11 @@ Launchy's ini config file.
 
 == FEATURES/PROBLEMS:
 
-* Usable as library and commandline tool.
-* Tested on Ubuntu Linux
-* Written for Ruby 1.8
+* Usable as library and commandline tool
+* Tested and fully working on:
+  * Windows XP i386 (Ruby 1.8.6)
+  * Ubuntu Linux 8.10 i386_64 (Ruby 1.8.7 and 1.9.1p0)
+* The commandline tool doesn't work with Ruby 1.9.x because the user-choices gem is not yet updated. A patch is available here: https://rubyforge.org/tracker/index.php?func=detail&aid=24307&group_id=4192&atid=16176
 
 == SYNOPSIS:
 
@@ -60,10 +62,12 @@ Launchy should be closed while using OpenSearchLaunchy
 * hpricot (for XML parsing)
 * facets (for ini parsing)
 * sys-uname (for operating system detection)
+* user-choices (for commandline tool)
 
 == INSTALL:
 
 * gem install launchy_opensearch
+* gem install user-choices (only for commandline tool)
 
 == LICENSE:
 

data/Rakefile

@@ -8,6 +8,9 @@ Hoe.new('launchy_opensearch', LaunchyOpenSearch::VERSION) do |p|
   p.rubyforge_name = 'aef'
   p.developer('Alexander E. Fischer', 'aef@raxys.net')
   p.extra_deps = %w{facets hpricot sys-uname}
+  p.extra_dev_deps = %w{user-choices}
+  p.testlib = 'spec'
+  p.test_globs = ['spec/**/*_spec.rb']
 end
 
 # vim: syntax=Ruby

data/bin/launchy_opensearch

@@ -17,13 +17,21 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-require 'rubygems'
-require 'launchy_opensearch'
+# TODO: If user-choices patch gets accepted, use :one_way => true for --version
 
+# If library is not locally accessible, use gem to include it.
+begin
+  require 'lib/launchy_opensearch'
+rescue LoadError
+  require 'rubygems'
+  require 'launchy_opensearch'
+end
+
+# User friendly message if user-choices is not available
 begin
   require 'user-choices'
 rescue LoadError
-  puts 'This command needs the user-choices gem to be installed'; exit
+  warn "This command needs the user-choices gem to be installed.\n\nSolution: gem install user-choices"; exit false
 end
 
 class LaunchyOpenSearch::Application < UserChoices::Command
@@ -35,8 +43,8 @@ class LaunchyOpenSearch::Application < UserChoices::Command
   def add_sources(builder)
     builder.add_source(
       CommandLineSource, :usage,
-      "Usage: #$PROGRAM_NAME [options] opensearch-files",
-      'Import OpenSearch XML files into the Weby plugin of the keystroke application launcher Launchy'
+      "Usage: #$PROGRAM_NAME [options] opensearch-files\n\n",
+      "Import OpenSearch XML files into the Weby plugin of the keystroke application launcher Launchy\n"
     )
   end
   
@@ -52,18 +60,31 @@ class LaunchyOpenSearch::Application < UserChoices::Command
         "Insert mode. Possible settings: #{MODES.join(', ')}. Default is #{MODES.first}.")
     end
 
+    builder.add_choice(:version, :default => false, :type => :boolean) do |cli|
+      cli.uses_switch('-v', '--version', 'Display version and licensing information')
+    end
+
     builder.add_choice(:filenames) {|cli| cli.uses_arglist }
   end
 
   # Main program
   def execute
-    raise 'No OpenSearch files specified' if @user_choices[:filenames].empty?
+    if @user_choices[:version]
+      klass = LaunchyOpenSearch
+      puts "\n#{klass.name} #{klass::VERSION}"
+      puts DATA.read; exit
+    end
+
+    if @user_choices[:filenames].empty?
+      warn 'No OpenSearch files specified'; exit false
+    end
 
     @user_choices[:filenames].each do |filename|
-      warn "Ignoring #{filename}. Not readble or missing." unless File.readable?(filename)
+      warn "Ignoring #{filename}. Not readable or missing." unless File.readable?(filename)
     end
 
     new_engines = LaunchyOpenSearch.parse_opensearch_files(@user_choices[:filenames])
+    count = new_engines.size
     config = LaunchyOpenSearch.read_config_hash(@user_choices[:config_path])
 
     if @user_choices[:mode] == 'append'
@@ -73,7 +94,29 @@ class LaunchyOpenSearch::Application < UserChoices::Command
 
     LaunchyOpenSearch.patch_config_hash(config, new_engines)
     LaunchyOpenSearch.write_config_hash(config, @user_choices[:config_path])
+
+    puts "#{count} search engines installed."
   end
 end
 
 S4tUtils.with_pleasant_exceptions {LaunchyOpenSearch::Application.new.execute}
+
+__END__
+
+Project: https://rubyforge.org/projects/aef/
+RDoc: http://aef.rubyforge.org/launchy_opensearch/
+
+Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+
+LaunchyOpenSearch is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/lib/launchy_opensearch.rb

@@ -21,13 +21,14 @@ require 'uri'
 require 'rubygems'
 require 'hpricot'
 require 'facets/ini'
+require 'facets/version'
 require 'sys/uname'
 
 # Offers static methods for all steps in parsing usefull information out of the
 # OpenSearch XML format and modifying the configuration of Launchy's Weby plugin
 module LaunchyOpenSearch
 
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 
   # Determines the location of Launchy's configuration Ini file on different
   # platforms
@@ -87,7 +88,12 @@ module LaunchyOpenSearch
   def self.read_config_hash(path)
     # Ini class doesn't like empty lines and can only read from files.
     original = File.read(path)
-    cleaned = original.map{|line| line.chomp.squeeze(' ')}.reject{|line| line == ''}.join("\n")
+
+    if VersionNumber.new(RUBY_VERSION) >= VersionNumber.new('1.9.0')
+      cleaned = original.lines.map{|line| line.chomp.squeeze(' ')}.reject{|line| line == ''}.join("\n")
+    else
+      cleaned = original.map{|line| line.chomp.squeeze(' ')}.reject{|line| line == ''}.join("\n")
+    end
 
     temp_file = Tempfile.open('launchy')
     temp_file.write(cleaned)
@@ -137,7 +143,7 @@ module LaunchyOpenSearch
         new_section["sites\\#{i + 1}\\#{key}"] = value
       }
     end
-    new_section['sites\\size'] = engines.size
+    new_section['sites\\size'] = engines.size.to_s
     config_hash['weby'] = new_section
     config_hash
   end
@@ -150,7 +156,12 @@ module LaunchyOpenSearch
       File.open("#{path}.bak", 'w') do |f|
         f.write(original)
       end
+    end
 
+    if VersionNumber.new(RUBY_VERSION) >= VersionNumber.new('1.9.0')
+      # Facets ini parser doesn't seems to use the .lines enumerator yet
+      Ini.write_to_file(path, config_hash)
+    else
       Ini.write_to_file(path, config_hash, "Written by LaunchyOpenSearch #{Time.now}\n")
     end
   end

data/spec/fixtures/discogs.xml

@@ -0,0 +1,12 @@
+<SearchPlugin xmlns="http://www.mozilla.org/2006/browser/search/" xmlns:os="http://a9.com/-/spec/opensearch/1.1/">
+<os:ShortName>Discogs</os:ShortName>
+<os:Description>Discogs search all</os:Description>
+<os:InputEncoding>UTF-8</os:InputEncoding>
+<os:Image width="16" height="16">data:image/x-icon;base64,AAABAAIAEBAAAAAAAABoAwAAJgAAACAgAAAAAAAAqAwAAI4DAAAoAAAAEAAAACAAAAABABgAAAAAAEADAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAa3N7a3N7a3N7a3N7AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAa3N7QkJCQkJCKTk5EBAQEBAQAAAAEBAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAQkJCvcbGa3N7QkJCISkpEBAQEBAQAAAAAAAAEBAQAAAAAAAAAAAAAAAAAAAAISkpQkJCa3N7vcbGa3N7ISkpEBAQEBAQAAAAAAAAAAAAEBAQAAAAAAAAAAAAISkpKTk5QkJCQkJCa3N7a3N7KTk5ISkpEBAQAAAAAAAAAAAAAAAAISkpAAAAAAAAEBAQISkpISkpKTk5KTk5EBAQGGNrGGNrCAgICAgIAAAAAAAAAAAAAAAAAAAAa3N7AAAAEBAQEBAQEBAQEBAQAMbWAMbWAMbWAMbWCAgIAAAAAAAAAAAAAAAAa3N7a3N7AAAAAAAAAAAAAAgIGGNrAMbWAMbWAMbWAMbWGGNrAAAAAAAAAAAAAAAAa3N7a3N7AAAAAAAAAAAAAAAAGGNrAMbWAMbWAMbWAMbWGGNrEBAQEBAQEBAQEBAQa3N7a3N7AAAAAAAAAAAAAAAAEBAQAMbWAMbWAMbWAMbWEBAQISkpISkpEBAQEBAQa3N7AAAAEBAQAAAAAAAAAAAAAAAAEBAQGGNrGGNrEBAQQkJCQkJCISkpISkpISkpAAAAAAAAQkJCAAAAAAAAAAAAEBAQEBAQISkpQkJCa3N7a62tQkJCQkJCISkpQkJCAAAAAAAAAAAAISkpAAAAAAAAEBAQEBAQISkpKTk5a3N7vcbGa3N7KTk5QkJCAAAAAAAAAAAAAAAAAAAAQkJCAAAAEBAQEBAQISkpKTk5QkJCa3N7a3N7a3N7AAAAAAAAAAAAAAAAAAAAAAAAAAAAKTk5KTk5EBAQEBAQEBAQISkpQkJCQkJCAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAa3N7a3N7a3N7a3N7AAAAAAAAAAAAAAAAAAAAAAAA/D////AP///gB///wAP//4AB//+AAf//AAD//wAA//8AAP//AAD//4AB//+AAf//wAP//+AH///wD////D///ygAAAAgAAAAQAAAAAEAGAAAAAAAgAwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYGBgYGBgYGBgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYGBgxMTExMTExMTExMTExMTExMTEYGBgYGBgYGBgYGBgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAxMTGcjIycjIxaY2NaY2NaY2NaY2NKSkoxMTExMTEYGBgYGBgYGBgYGBgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYGBiEc3OctbXOxsa9ra2Ec3NKSkpKSkoxMTExMTEYGBgYGBgYGBgYGBgYGBgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAxMTEAAABKSkpaY2POxsb///+9ra1aY2MxMTExMTExMTEYGBgYGBgYGBgYGBgYGBgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAxMTFKSkqEc3OcjIy9ra2cjIyEc3NaY2NKSkpKSkoxMTExMTEYGBgYGBgYGBgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAxMTExMTFaY2NaY2NKSkpaY2Pn5+fn5+eEc3MxMTExMTEYGBgYGBgYGBgYGBgYGBgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYGBgYGBgxMTFKSkpKSkoxMTExMTGcjIze1tbOxsZaY2NKSkoxMTEYGBgYGBgYGBgYGBgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYGBgxMTFKSkoxMTExMTFaY2NaY2NaY2OctbXOxsZjOTkYGBgYGBgYGBgpAAApAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYGBgYGBgYGBgxMTExMTEYGBhKSkpKSkoxMTFKSkqcjIx7WloYGBgIY2sIY2sIY2sIY2sxMTEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYGBgYGBgYGBgYGBgxMTFKSkoxMTExMTFKSkoYGBgxMTEApbUAvcYAvcYAvcYAvcYAvcYIY2sYGBgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYGBgYGBgYGBgYGBgxMTExMTEYGBgxMTEYGBgIY2sA5/cAvcYAvcYAvcYAvcYApbUAvcYA5/cApbUYGBgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAxMTEAAAAAAAAYGBgYGBgYGBgYGBgYGBgYGBgYGBgYGBgA5/cApbUAvcYA5/cA5/cA5/cA5/cA5/cApbUA5/cIY2sAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYGBgAAAAAAAAAAAAAAAAYGBgYGBgYGBgYGBgYGBgIY2sAvcYAvcYA5/cA5/cA5/cA5/cA5/cA5/cA5/cAvcYApbUYGBgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYGBgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYGBgApbUAvcYA5/cA5/cA5/cAvcYAvcYA5/cA5/cA5/cAvcYAvcYxMTEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYGBgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYGBgAvcYAvcYA5/cA5/cA5/eEc3OEc3MAvcYA5/cA5/cAvcYAvcYxMTEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYGBgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYGBgApbUAvcYA5/cA5/cA5/cAvcYAvcYA5/cA5/cA5/cAvcYAvcYxMTEpAAAYGBgYGBgAAAAAAAAAAAAAAAAAAAAAAAAYGBgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAIY2sAvcYAvcYA5/cA5/cA5/cA5/cA5/cA5/cAvcYAvcYApbUYGBgYGBgYGBgYGBgYGBgYGBgYGBgYGBgAAAAAAAAxMTEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAxMTEA5/cApbUAvcYA5/cA5/cA5/cA5/cA5/cApbUA5/cIY2spAAAYGBgYGBgYGBgYGBgYGBgYGBgYGBgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAIY2sA5/cAvcYAvcYAvcYAvcYAvcYAvcYA5/cIY2spAAAxMTEYGBgYGBgxMTEYGBgYGBgYGBgYGBgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAIY2sApbUAvcYAvcYAvcYAvcYApbUxMTEAAABKSkoxMTExMTFKSkoxMTEYGBgYGBgYGBgYGBgAAAAAAAAAAAAYGBgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYGBgIY2sIY2sIY2sxMTExMTF7WlqcjIxKSkoxMTFKSkpKSkoYGBgxMTExMTEYGBgYGBgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAApAAApAAAYGBgYGBhCGBiEc3Pe1tacjIxKSkpKSkpKSkoxMTExMTExMTExMTEYGBgYGBgAAAAAAAAAAAAAAAAYGBgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYGBgYGBgYGBgxMTExMTFaY2OcjIzOxsbOxsaEc3MxMTExMTFKSkpKSkoxMTExMTEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYGBgYGBgYGBgYGBgYGBgxMTExMTFKSkqcjIz////n5+daY2MxMTFKSkpKSkoxMTExMTEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYGBgYGBgYGBgxMTExMTFKSkpKSkqEc3OcjIyctbWcjIyEc3NaY2MxMTExMTEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABKSkoAAAAAAAAAAAAAAAAAAAAAAAAYGBgYGBgYGBgYGBgYGBgYGBgxMTExMTExMTFaY2Pe1tb///+9ra1KSkoxMTEpAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABKSkoAAAAAAAAAAAAAAAAYGBgYGBgYGBgYGBgYGBgYGBgxMTExMTExMTFKSkqEc3POxsbn5+ecjIxaY2MYGBgYGBgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYGBgYGBgYGBgYGBgYGBgxMTExMTExMTExMTExMTFKSkpaY2O9ra29ra0xMTEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAxMTEAAAAAAAAAAAAYGBgYGBgYGBgYGBgYGBgYGBgYGBgYGBgxMTExMTExMTExMTEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAxMTEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAxMTEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABaY2NKSkpKSkpKSkpKSkpaY2MAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD/8A///4AB//4AAH/8AAA/8AAAD/AAAA/gAAAHwAAAA8AAAAOAAAABgAAAAYAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAgAAAAYAAAAGAAAABwAAAA8AAAAPgAAAH8AAAD/AAAA/4AAAf/gAAf/8AAP//wAP///gf/w==</os:Image>
+<UpdateInterval>7</UpdateInterval>
+<UpdateUrl>http://mycroft.mozdev.org/updateos.php/id0/discogs.xml</UpdateUrl>
+<IconUpdateUrl>http://mycroft.mozdev.org/updateos.php/id0/discogs.ico</IconUpdateUrl>
+<SearchForm>http://www.discogs.com/</SearchForm>
+<os:Url type="text/html" method="GET" template="http://www.discogs.com/search?type=all&amp;q={searchTerms}&amp;btn=Search">
+</os:Url>
+</SearchPlugin>

data/spec/fixtures/launchy.ini

@@ -0,0 +1,60 @@
+[GenOps]
+skin=/usr/share/launchy/skins/Default
+
+[General]
+donateTime=@Variant(\0\0\0\x10\0%u\x85\x2\a\xe3L\xff)
+version=212
+
+[runner]
+cmds\1\name=cmd
+cmds\1\file=/usr/bin/xterm
+cmds\1\args=-hold -e $$
+cmds\size=1
+version=2
+
+[weby]
+sites\1\name=Google
+sites\1\base=http://www.google.com/
+sites\1\query="search?source=launchy&q=%s"
+sites\1\default=true
+sites\2\name=Live Search
+sites\2\base=http://search.live.com/
+sites\2\query="results.aspx?q=%s"
+sites\3\name=Yahoo
+sites\3\base=http://search.yahoo.com/
+sites\3\query="search?p=%s"
+sites\4\name=MSN
+sites\4\base=http://search.msn.com/
+sites\4\query="results.aspx?q=%s"
+sites\5\name=Weather
+sites\5\base=http://www.weather.com/
+sites\5\query=weather/local/%s
+sites\6\name=Amazon
+sites\6\base=http://www.amazon.com/
+sites\6\query="gp/search/?keywords=%s&index=blended"
+sites\7\name=YouTube
+sites\7\base=http://www.youtube.com/
+sites\7\query="results?search_query=%s"
+sites\8\name=Wikipedia
+sites\8\base=http://en.wikipedia.com/
+sites\8\query="wiki/Special:Search?search=%s&fulltext=Search"
+sites\9\name=Dictionary
+sites\9\base=http://www.dictionary.com/
+sites\9\query=browse/%s
+sites\10\name=Thesaurus
+sites\10\base=http://www.thesaurus.com/
+sites\10\query=browse/%s
+sites\11\name=Netflix
+sites\11\base=http://www.netflix.com/
+sites\11\query="Search?v1=%s"
+sites\12\name=E-Mail
+sites\12\base=mailto:
+sites\12\query=%s
+sites\13\name=IMDB
+sites\13\base=http://www.imdb.com/
+sites\13\query="find?s=all&q=%s"
+sites\14\name=Maps
+sites\14\base=http://maps.google.com/
+sites\14\query="maps?f=q&hl=en&geocode=&q=%s&ie=UTF8&z=12&iwloc=addr&om=1"
+sites\size=14
+version=2

data/spec/fixtures/secure-wikipedia-english.xml

@@ -0,0 +1,13 @@
+<SearchPlugin xmlns="http://www.mozilla.org/2006/browser/search/" xmlns:os="http://a9.com/-/spec/opensearch/1.1/">
+<os:ShortName>SSL Wikipedia (English)</os:ShortName>
+<os:Description>Return articles from english wikipedia using https url</os:Description>
+<os:InputEncoding>UTF-8</os:InputEncoding>
+<os:Image width="16" height="16">data:image/x-icon;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAABzklEQVQ4y6WTL6vycBTHP9stgmETGWIaF6bFNA0qWMQZxDIQ34cv4WLwDYhJsK1o0CQKDhUMNllQg2tiERQUBMGwGx7Y83i9T/LArxzO+XK+f36CKIoeb5TIm/U+QKFQwLIshsMhhUIBgGq1ynA4pF6vo2kaAPV6Hcuy0DQNTdNoNptYloVo2zbr9RpVVX3UXq8HQKVSAUBRFO73O7PZDNd1uVwuAMxmsz8Uut0usixjmiaKogDQ7/eRZRld1/n8/CQajdJut5/Ob7fbfAiC8HU+n0mlUpRKJcbjMYfDgev1SjKZxDRNbrcbq9WKzWYDQDab5Xg8stls/orY6XQAMAwDANd16ff7xGIxEomET0tRFNLpNOfz+dkF27ZxHIdcLucLN51OWS6XhEIh/2xJkggEAti2/WrjYrHAMAx0XX/iqqqq71A+n2e/3/+eg0ajwW6388XUdR3HcTidTpim6VMYDAb+zocgCF//gsiyTCqVIhKJcDweGQwGSJJEuVzm8XgQDAYZj8f/T+JutyMcDvsZcF2X+XwOQK1WYzKZ/IiiKHo/32g08kajkRePx/1eq9Xyttvty+yvAMVi0ctkMk+9eDzuFYvFl1nh3e/8DVlGxpnqRIOzAAAAAElFTkSuQmCC</os:Image>
+<UpdateInterval>7</UpdateInterval>
+<UpdateUrl>http://mycroft.mozdev.org/updateos.php/id0/securewikipedia.xml</UpdateUrl>
+<IconUpdateUrl>http://mycroft.mozdev.org/updateos.php/id0/securewikipedia.png</IconUpdateUrl>
+<SearchForm>https://secure.wikimedia.org/wikipedia/en/wiki/</SearchForm>
+<os:Url type="text/html" method="GET" template="https://secure.wikimedia.org/wikipedia/en/wiki/Special:Search?go=Go&amp;search={searchTerms}">
+</os:Url><os:Url type="application/x-suggestions+json" method="GET" template="https://secure.wikimedia.org/wikipedia/en/w/api.php?action=opensearch&amp;search={searchTerms}">
+</os:Url>
+</SearchPlugin>

data/spec/fixtures/youtube.xml

@@ -0,0 +1,13 @@
+<SearchPlugin xmlns="http://www.mozilla.org/2006/browser/search/" xmlns:os="http://a9.com/-/spec/opensearch/1.1/">
+<os:ShortName>YouTube</os:ShortName>
+<os:Description>YouTube - Videos</os:Description>
+<os:InputEncoding>UTF-8</os:InputEncoding>
+<os:Image width="16" height="16">data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAABMLAAATCwAAAAAAAAAAAAD//////////4OD//9paf//bm7//2Fh//9ZWf//Wlr//1pa//9WVv//ZGT//3Bw//9jY///goL//////////////////11d//8sLP//QUH//ygo//84OP//RET//y4u//8xMf//UVH//y4u//8PD///ZWX//x0d//9aWv////////////88PP//Cgr///////8zM///1NT///////+lpf//ubn///////+urv//fHz////////g4P//Fhb/////////////MzP//woK////////NDT//8vL//9ycv//paX//7Cw//9jY///s7P//8nJ//9XV///eXn//yIi/////////////zMz//8LC///+/v//zMz///Gxv//hYX//6Ki//+srP//W1v//6ys//+3t///2tr//93d//8PD/////////////80NP//AgL///b2//8nJ///5ub//56e//+5uf//oaH//+/v//+5uf//oKD//+Li///f3///AgL/////////////MzP//wUF////////Skr//0pK//9NTf//NTX//97e//+ysv//Nzf//xIS//+mpv//Kyv//z09/////////////xkZ///Y2P////////////8nJ///EBD//wAA///y8v//Ly///wAA//8mJv//Hh7//6mp//92dv////////////+vr///Jib//xMS//8eIP//MzP//zY2//84OP//Hh///y4u//9XV///hoj//8LC///R0f//qqr/////////////////////////////////////////////////////////////////////////////////////////////////////////////AAAA/8zMzP/u7u7/IiIi/wAAAP8iIiL//////zMzM/8AAAD/AAAA/////////////////////////////////wAAAP/MzMz//////yIiIv/u7u7/ERER/7u7u/8AAAD/iIiI/xEREf///////////////////////////+7u7v8AAAD/zMzM//////8iIiL/7u7u/xEREf+7u7v/AAAA/8zMzP8RERH///////////////////////////93d3f/AAAA/1VVVf/u7u7/IiIi/wAAAP8iIiL//////wAAAP/MzMz/ERER///////////////////////d3d3/AAAA/4iIiP8AAAD/3d3d/////////////////////////////////////////////////////////////////wAAAP//////AAAA////////////////////////////////////////////////////////////AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA==</os:Image>
+<UpdateInterval>7</UpdateInterval>
+<UpdateUrl>http://mycroft.mozdev.org/updateos.php/id0/youtube.xml</UpdateUrl>
+<IconUpdateUrl>http://mycroft.mozdev.org/updateos.php/id0/youtube.ico</IconUpdateUrl>
+<SearchForm>http://www.youtube.com/index</SearchForm>
+<os:Url type="text/html" method="GET" template="http://www.youtube.com/results?search_query={searchTerms}&amp;search=Search">
+</os:Url><os:Url type="application/x-suggestions+json" method="GET" template="http://suggestqueries.google.com/complete/search?hl=en&amp;ds=yt&amp;json=t&amp;q={searchTerms}">
+</os:Url>
+</SearchPlugin>

data/spec/launchy_opensearch_spec.rb

@@ -0,0 +1,245 @@
+# Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+#
+# This file is part of LaunchyOpenSearch.
+#
+# LaunchyOpenSearch is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'lib/launchy_opensearch'
+require 'tempfile'
+
+require 'rubygems'
+require 'sys/uname'
+
+# If there is a way to get the executable path of the currently running ruby
+# interpreter, please tell me how.
+warn 'Attention: If the ruby interpreter to be tested with is not ruby in the' +
+     'default path, you have to change this manually in spec/breakverter_spec.rb'
+RUBY_PATH = 'ruby'
+
+module LaunchyOpenSearchSpecHelper
+  def windows?
+    Sys::Uname.sysname.downcase.include?('windows')
+  end
+
+  def info_youtube
+    {
+      :name => 'YouTube',
+      :base => 'http://www.youtube.com/',
+      :query => '"results?search_query=%s&search=Search"',
+      :default => 'false'
+    }
+  end
+
+  def info_discogs
+    {
+      :name => 'Discogs',
+      :base => 'http://www.discogs.com/',
+      :query => '"search?type=all&q=%s&btn=Search"',
+      :default => 'false'
+    }
+  end
+
+  def info_wikipedia
+    {
+      :name => 'SSL Wikipedia (English)',
+      :base => 'https://secure.wikimedia.org/',
+      :query => '"wikipedia/en/wiki/Special:Search?go=Go&search=%s"',
+      :default => 'false'
+    }
+  end
+end
+
+describe LaunchyOpenSearch do
+  include LaunchyOpenSearchSpecHelper
+
+  describe 'library' do
+    it "should be able to determine Launchy's config file path correctly" do
+      if windows?
+        path = File.join(ENV['APPDATA'], 'Launchy', 'Launchy.ini')
+      else
+        path = File.join(ENV['HOME'], '.launchy', 'launchy.ini')
+      end
+
+      LaunchyOpenSearch.launchy_config_path.should eql(path)
+    end
+    
+    it "should be able to parse useful information out of OpenSearch XML documents" do
+      content = File.read('spec/fixtures/youtube.xml')
+      result = LaunchyOpenSearch.parse_opensearch(content)
+
+      result.should be_an_instance_of(Hash)
+
+      result[:name].should eql(info_youtube[:name])
+      result[:base].should eql(info_youtube[:base])
+      result[:query].should eql(info_youtube[:query])
+      result[:default].should eql(info_youtube[:default])
+    end
+
+    it "should be able to parse useful information out of OpenSearch XML document files" do
+      result = LaunchyOpenSearch.parse_opensearch_file('spec/fixtures/discogs.xml')
+
+      result.should be_an_instance_of(Hash)
+
+      result[:name].should eql(info_discogs[:name])
+      result[:base].should eql(info_discogs[:base])
+      result[:query].should eql(info_discogs[:query])
+      result[:default].should eql(info_discogs[:default])
+    end
+
+    it "should be able to parse useful information out of multiple OpenSearch XML document files" do
+      files = [
+        'spec/fixtures/youtube.xml',
+        'spec/fixtures/discogs.xml',
+        'spec/fixtures/secure-wikipedia-english.xml'
+      ]
+      
+      result = LaunchyOpenSearch.parse_opensearch_files(files)
+
+      result.should be_an_instance_of(Array)
+      result.should include(info_youtube)
+      result.should include(info_discogs)
+      result.should include(info_wikipedia)
+    end
+
+    it "should be able to read a Launchy configuration ini file" do
+      result = LaunchyOpenSearch.read_config_hash('spec/fixtures/launchy.ini')
+
+      result.should be_an_instance_of(Hash)
+
+      result.keys.sort.should eql(['General', 'GenOps', 'runner', 'weby'].sort)
+      
+      result['General'].should have(2).items
+      result['General']['version'].should eql('212')
+
+      result['runner'].should have(5).items
+      result['runner']['cmds\\1\\file'].should eql('/usr/bin/xterm')
+
+      result['GenOps'].should have(1).items
+      result['GenOps']['skin'].should eql('/usr/share/launchy/skins/Default')
+
+      result['weby'].should have(45).items
+      result['weby']['sites\\size'].should eql('14')
+      result['weby']['sites\\6\\query'].should eql('"gp/search/?keywords=%s&index=blended"')
+    end
+
+    it "should be able to extract an array of engine hashes from a config file hash" do
+      config_hash = LaunchyOpenSearch.read_config_hash('spec/fixtures/launchy.ini')
+
+      result = LaunchyOpenSearch.extract_config_hash(config_hash)
+
+      result.should be_an_instance_of(Array)
+      result.should have(14).items
+
+      result.should include(:name  => 'Live Search',
+                            :base  => 'http://search.live.com/',
+                            :query => '"results.aspx?q=%s"')
+
+      result.should include(:name  => 'Dictionary',
+                            :base  => 'http://www.dictionary.com/',
+                            :query => 'browse/%s')
+    end
+
+    it "should be able to patch an array of engines with additional engines" do
+      config_hash = LaunchyOpenSearch.read_config_hash('spec/fixtures/launchy.ini')
+
+      engines = LaunchyOpenSearch.extract_config_hash(config_hash)
+      engines << info_discogs
+
+      lambda {
+        LaunchyOpenSearch.patch_config_hash(config_hash, engines)
+      }.should change{ config_hash['weby'].size }.from(45).to(49)
+
+      name_key = config_hash['weby'].find {|key, value| value == 'Discogs'}.first
+      name_key =~ /^.*\\(.*)\\.*$/
+
+      config_hash['weby']["sites\\#$1\\base"].should eql(info_discogs[:base])
+      config_hash['weby']["sites\\#$1\\query"].should eql(info_discogs[:query])
+      config_hash['weby']["sites\\#$1\\default"].should eql(info_discogs[:default])
+    end
+
+    it "should be able to write a config hash to ini file" do
+      temp_file = Tempfile.new('launchy_opensearch_spec')
+      location = temp_file.path
+      temp_file.close
+      temp_file.unlink
+
+      config_hash = LaunchyOpenSearch.read_config_hash('spec/fixtures/launchy.ini')
+
+      engines = LaunchyOpenSearch.extract_config_hash(config_hash)
+      engines << info_discogs
+
+      LaunchyOpenSearch.patch_config_hash(config_hash, engines)
+
+      LaunchyOpenSearch.write_config_hash(config_hash, location)
+      File.exist?(location).should be_true
+
+      LaunchyOpenSearch.read_config_hash(location)['weby'].sort.should eql(config_hash['weby'].sort)
+
+      File.unlink(location)
+    end
+  end
+
+  describe 'commandline tool' do
+    it "should be able add an engine from an OpenSearch XML file to Launchy's ini-file" do
+      temp_file = Tempfile.new('launchy_opensearch_spec')
+      location = temp_file.path
+      temp_file.close
+      temp_file.unlink
+      
+      FileUtils.copy('spec/fixtures/launchy.ini', location)
+
+      lambda {
+        `#{RUBY_PATH} bin/launchy_opensearch -c #{location} spec/fixtures/discogs.xml`
+      }.should change{
+        LaunchyOpenSearch.read_config_hash(location)['weby']['sites\\size']
+      }.from('14').to('15')
+
+      File.unlink(location)
+    end
+
+    it "should be able replace current engines with an engine from an OpenSearch XML file" do
+      temp_file = Tempfile.new('launchy_opensearch_spec')
+      location = temp_file.path
+      temp_file.close
+      temp_file.unlink
+
+      FileUtils.copy('spec/fixtures/launchy.ini', location)
+
+      lambda {
+        `#{RUBY_PATH} bin/launchy_opensearch --mode replace -c #{location} spec/fixtures/discogs.xml`
+      }.should change{
+        LaunchyOpenSearch.read_config_hash(location)['weby']['sites\\size']
+      }.from('14').to('1')
+
+      File.unlink(location)
+    end
+
+    it "should be able to replace current engines with multiple engines from OpenSearch XML files" do
+      temp_file = Tempfile.new('launchy_opensearch_spec')
+      location = temp_file.path
+      temp_file.close
+      temp_file.unlink
+
+      FileUtils.copy('spec/fixtures/launchy.ini', location)
+
+      lambda {
+        `#{RUBY_PATH} bin/launchy_opensearch -m replace --config #{location} spec/fixtures/discogs.xml spec/fixtures/youtube.xml spec/fixtures/secure-wikipedia-english.xml`
+      }.should change{
+        LaunchyOpenSearch.read_config_hash(location)['weby']['sites\\size']
+      }.from('14').to('3')
+
+      File.unlink(location)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: launchy_opensearch
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Alexander E. Fischer
@@ -29,7 +29,7 @@ cert_chain:
   55akF+N8NbO6tpVDy6TMagqa10LfEpiQH6dvDHe/xdAqYOCrXKpmqzwu2PI=
   -----END CERTIFICATE-----
 
-date: 2009-02-25 00:00:00 +01:00
+date: 2009-03-08 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,6 +62,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: user-choices
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -92,6 +102,11 @@ files:
 - Rakefile
 - bin/launchy_opensearch
 - lib/launchy_opensearch.rb
+- spec/launchy_opensearch_spec.rb
+- spec/fixtures/launchy.ini
+- spec/fixtures/discogs.xml
+- spec/fixtures/secure-wikipedia-english.xml
+- spec/fixtures/youtube.xml
 has_rdoc: true
 homepage: "Project: https://rubyforge.org/projects/aef/"
 post_install_message: 
@@ -119,5 +134,5 @@ rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: This program allows to parse OpenSearch XML files and include them as search engines in the Weby plugin of the keystroke app launcher Launchy by editing Launchy's ini config file.
-test_files: []
-
+test_files: 
+- spec/launchy_opensearch_spec.rb