splat 0.0.9 → 0.1.0

data/MIT-LICENSE

@@ -1,20 +1,20 @@
-Copyright (c) 2010 Mark Ryall
- 
-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.
+Copyright (c) 2010 Mark Ryall
+ 
+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.rdoc

@@ -1,31 +1,72 @@
-= splat
-
-small gem to provide an adapter for various platform specific features
-
-== installation
-
-  gem install splat
-
-== instantiate
-
-  splat = Splat.new
-
-== platform
-
-  puts spat.platform
-  puts splat.supported? ? 'supported' : 'not supported'
-
-== clipboard
-
-  splat.clipboard = "some new content"
-
-this will do nothing if the platform is not supported (win32 and macosx for the moment)
-
-== launcher
-
-  splat.launch 'http://google.com'
-
-== Future plans for world domination
-
-* detect remaining platforms
-* determine 1.9 compatibility
+= splat
+
+small gem to provide an adapter for various platform specific features.
+
+This is done by adding the following methods to String:
+
+* to_editor
+* to_browser
+* to_clipboard
+* to_speech
+* to_launcher
+* to_player
+* to_os_path
+
+== installation
+
+  gem install splat
+
+== load
+
+  require 'splat'
+
+== launch editor
+
+  'current content'.to_editor
+
+
+
+== browser automation
+
+  'http://www.google.com'.to_browser
+
+Returns a watir compatible browser - uses safariwatir on mac os x and watir (ie) on windows.
+
+== clipboard
+
+  'some new content'.to_clipboard
+
+Copies the string to the os clipboard
+
+== default application launcher
+
+  'http://google.com'.to_launcher
+  'textfile.txt'.to_launcher
+  'audiofile.mp3'.to_launcher
+
+Launches the referenced content with the default system application
+
+== audio player
+
+  'audio.mp3'.to_player
+
+Uses 'afplay' on mac os x and requires mpg123 on windows.
+
+== text to speech
+
+  "I'm afraid. I'm afraid, Dave. Dave, my mind is going.".to_speech
+
+Uses 'say' on mac os x and win32 sapi on windows
+
+== path cleaning
+
+  'c:/a/path/that/might/upset/some/windows.application'.to_os_path
+
+This will simply replace '/' characters with '\' on windows and otherwise leave the path as is.
+
+Note that this is only necessary for passing a path to native windows applications
+
+== Future plans for world domination
+
+* detect remaining platforms
+* determine 1.9 compatibility

data/lib/splat.rb

@@ -1,76 +1,66 @@
-class Splat
-  attr_reader :platform
+require 'tempfile'
 
-  def try_load feature, params
-    begin
-      params.each {|gem, req| require req }
-      yield
-    rescue Exception
-      puts "for #{feature} support with splat on #{@platform}:"
-      params.each {|gem, req| puts " * gem install #{gem}" }
-    end
-  end
-
-  def initialize
-    @path_cleaner = Object.new
-    def @path_cleaner.clean path
-      path
-    end
-    case Config::CONFIG['host_os']
-      when /mswin|win32|dos|cygwin|mingw/i
-        @platform = :win32
-        try_load 'clipboard', 'win32-clipboard' => 'win32/clipboard' do
-          require 'splat/win32_clipboard'
-          @clipboard = Splat::Win32Clipboard.new
-        end
-        require 'splat/win32_launcher'
-        @launcher = Splat::Win32Launcher.new
-        require 'splat/win32_player'
-        @player = Splat::Win32Player.new
-        try_load 'browser automation', 'watir' => 'watir' do
-          @browser_class = Watir::IE
-        end
-        def @path_cleaner.clean path
-          path.to_s.gsub('/','\\')
-        end
-      when /darwin/i
-        @platform = :macosx
-        require 'splat/darwin_clipboard'
-        @clipboard =  Splat::DarwinClipboard.new
-        require 'splat/darwin_launcher'
-        @launcher = Splat::DarwinLauncher.new
-        require 'splat/darwin_player'
-        @player = Splat::DarwinPlayer.new
-        try_load 'browser automation', 'rb-appscript' => 'appscript', 'safariwatir' => 'safariwatir' do
-          @browser_class = Watir::Safari
-        end
-      else
-        @platform = :unknown
-        puts "I have no idea how to cope with \"#{Config::CONFIG['host_os']}\""
-    end
+class String
+  def splat_unsupported
+    $stderr.puts 'platform not supported'
   end
 
-  def supported?
-    @platform != :unknown
-  end
+  alias :to_browser   :splat_unsupported
+  alias :to_clipboard :splat_unsupported
+  alias :to_speech    :splat_unsupported
+  alias :to_launcher  :splat_unsupported
+  alias :to_player    :splat_unsupported
+  alias :to_os_path   :to_s
 
-  def clipboard= content
-    @clipboard.content = content if @clipboard
-  end
-
-  def browser
-    @browser_class.new if @browser_class
+  def to_editor
+    tmp_file = Tempfile.new('splat')
+    tmp_file.close
+    begin
+      File.open(tmp_file.path, 'w') { |out| out.print self }
+      editor = ENV["EDITOR"] || "notepad"
+      system("#{editor} #{tmp_file.path}")
+      return unless $?.to_i == 0
+      File.read(tmp_file.path)
+    ensure
+      tmp_file.unlink
+    end
   end
+end
 
-  def launch content
-    @launcher.launch content if @launcher
+module Splat
+  def self.platform
+    @platform
   end
 
-  def play path
-    @player.play path if @player
+  def self.try_load feature, dependencies={}
+    begin
+      dependencies.each {|gem_name, require_parameter| require require_parameter }
+      require "splat/#{@platform}_#{feature}"
+    rescue Exception => e
+      $stderr.puts e
+      $stderr.puts "for #{feature} support with splat on #{@platform}:"
+      dependencies.each {|gem_name, require_parameter| $stderr.puts " * gem install #{gem_name}" }
+    end
   end
 
-  def clean_path path
-    @path_cleaner.clean path
+  case Config::CONFIG['host_os']
+    when /mswin|win32|dos|cygwin|mingw/i
+      @platform = :win32
+      try_load 'tts', 'win32-sapi' => 'win32/sapi5'
+      try_load 'clipboard', 'win32-clipboard' => 'win32/clipboard'
+      try_load 'launcher'
+      try_load 'player'
+      try_load 'browser', 'watir' => 'watir'
+      try_load 'os_path'
+    when /darwin/i
+      @platform = :darwin
+      try_load 'tts'
+      try_load 'clipboard'
+      try_load 'launcher'
+      try_load 'player'
+      try_load 'browser', 'rb-appscript' => 'appscript', 'safariwatir' => 'safariwatir'
+    else
+      @platform = :unknown
+      puts "I have no idea how to cope with \"#{Config::CONFIG['host_os']}\""
   end
-end
+end

data/lib/splat/darwin_browser.rb

@@ -0,0 +1,7 @@
+class String
+  def to_browser
+    @browser = Watir::Safari.new
+    @browser.goto self
+    @browser
+  end
+end

data/lib/splat/darwin_clipboard.rb

@@ -1,5 +1,5 @@
-class Splat::DarwinClipboard
-  def content= text
-    `echo "#{text}" | pbcopy`
-  end
-end
+class String
+  def to_clipboard
+    IO.popen('pbcopy','w') { |clipboard| clipboard.print self }
+  end
+end

data/lib/splat/darwin_launcher.rb

@@ -1,5 +1,5 @@
-class Splat::DarwinLauncher
-  def launch text
-    `open #{text}`
-  end
-end
+class String
+  def to_launcher
+    `open #{self}`
+  end
+end

data/lib/splat/darwin_player.rb

@@ -1,5 +1,5 @@
-class Splat::DarwinPlayer
-  def play path
-    `afplay #{path}`
+class String
+  def to_player
+    `afplay #{self}`
   end
 end

data/lib/splat/darwin_tts.rb

@@ -0,0 +1,5 @@
+class String
+  def to_speech
+    `say "#{self}"`
+  end
+end

data/lib/splat/win32_browser.rb

@@ -0,0 +1,7 @@
+class String
+  def to_browser
+    @browser = Watir::IE.new
+    @browser.goto self
+    @browser
+  end
+end

data/lib/splat/win32_clipboard.rb

@@ -1,5 +1,5 @@
-class Splat::Win32Clipboard
-  def content= text
-    Win32::Clipboard.set_data(text)
-  end
-end
+class String
+  def to_clipboard
+    Win32::Clipboard.set_data(self)
+  end
+end

data/lib/splat/win32_launcher.rb

@@ -1,5 +1,5 @@
-class Splat::Win32Launcher
-  def launch text
-    `start #{text}`
-  end
-end
+class String
+  def to_launcher
+    `start #{self}`
+  end
+end

data/lib/splat/win32_os_path.rb

@@ -0,0 +1,5 @@
+class String
+  def to_os_path
+    self.gsub('/','\\')
+  end
+end

data/lib/splat/win32_player.rb

@@ -1,5 +1,5 @@
-class Splat::Win32Player
-  def play path
-    `mpg123 -q #{path}`
+class String
+  def to_player
+    `mpg123 -q #{self}`
   end
-end
+end

data/lib/splat/win32_tts.rb

@@ -0,0 +1,5 @@
+class String
+  def to_speech
+    Win32::SpVoice.new.Speak(self)
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 9
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors: 
 - Mark Ryall
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-07 00:00:00 +11:00
+date: 2010-04-11 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
@@ -22,7 +22,9 @@ description: |
   An adapter to get access to the following features across different platforms:
   
    * the clipboard
-   * an application launcher
+   * a default application launcher
+   * a media player
+   * text to speech
 
 email: mark@ryall.name
 executables: []
@@ -32,12 +34,17 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/splat/darwin_browser.rb
 - lib/splat/darwin_clipboard.rb
 - lib/splat/darwin_launcher.rb
 - lib/splat/darwin_player.rb
+- lib/splat/darwin_tts.rb
+- lib/splat/win32_browser.rb
 - lib/splat/win32_clipboard.rb
 - lib/splat/win32_launcher.rb
+- lib/splat/win32_os_path.rb
 - lib/splat/win32_player.rb
+- lib/splat/win32_tts.rb
 - lib/splat.rb
 - README.rdoc
 - MIT-LICENSE