win32-clipboard 0.4.2 → 0.4.3

data/CHANGES

@@ -1,3 +1,9 @@
+== 0.4.3 - 25-Jul-2007
+* Changed ClipboardError to Clipboard::Error
+* Added a Rakefile with tasks for testing and installation.
+* Removed the install.rb file since installation is now handled by the Rakefile.
+* Updates to the README and MANIFEST.
+
 == 0.4.2 - 27-Jan-2007
 * Fixes for the clipboard_test.rb example program setup code. Thanks go to
   Harold Hausman for the spot.
@@ -44,4 +50,4 @@
 * Moved the sample script to doc/examples.
 
 == 0.1.0 - 19-Nov-2003
-* Initial release
+* Initial release

data/MANIFEST

@@ -1,11 +1,8 @@
-MANIFEST
-CHANGES
-README
-install.rb
-win32-clipboard.gemspec
-
-examples/clipboard_test.rb
-
-lib/win32/clipboard.rb
-
-test/tc_clipboard.rb
+* MANIFEST
+* CHANGES
+* README
+* Rakefile
+* win32-clipboard.gemspec
+* examples/clipboard_test.rb
+* lib/win32/clipboard.rb
+* test/tc_clipboard.rb

data/README

@@ -1,8 +1,12 @@
 == Description
    win32-clipboard - a Ruby package for interacting with the Win32 clipboard.
 
+== Installation
+   rake test (optional)
+   rake install (non-gem) or rake install_gem (gem)
+
 == Synopsis
-   require "win32/clipboard"
+   require 'win32/clipboard'
    include Win32
     
    puts "Data on clipboard: " + Clipboard.data
@@ -18,8 +22,7 @@
         
 == Class Methods
 Clipboard.data(format=nil)
-Clipboard.get_data(format=nil)
-   Returns the data currently in the clipboard.  If 'format' is
+   Returns the data currently in the clipboard.  If +format+ is
    specified, it will attempt to retrieve the data in that format. The
    default is Clipboard::TEXT.  See the 'Constants' section for
    the supported formats.
@@ -31,43 +34,46 @@ Clipboard.empty
    Empty the contents of the clipboard
     
 Clipboard.format_available?(format_number)
-	Returns true if 'format_number' is currently available on the clipboard,
-	false otherwise.
-	
+   Returns true if 'format_number' is currently available on the clipboard,
+   false otherwise.
+
 Clipboard.format_name(format_number)
-	Returns the corresponding name for the given 'format_number', or nil
-	if it does not exist.
-	
+   Returns the corresponding name for the given 'format_number', or nil
+   if it does not exist.
+
 Clipboard.formats
-	Returns a hash of all the current formats, with the format number as the
-	key and the format name as the value for that key.
+   Returns a hash of all the current formats, with the format number as the
+   key and the format name as the value for that key.
+
+Clipboard.get_data(format=nil)
+   Alias for Clipboard.data.
     
 Clipboard.num_formats
     Returns the number of different data formats currently on the clipboard.
     
 Clipboard.register_format(format)
-	Registers the given 'format' (a String) as a clipboard format, which
-	can then be used as a valid clipboard format.
+   Registers the given 'format' (a String) as a clipboard format, which
+   can then be used as a valid clipboard format.
 	
-	If a registered format with the specified name already exists, a new
-	format is not registered and the return value identifies the existing
-	format. This enables more than one application to copy and paste data
-	using the same registered clipboard format. Note that the format name
-	comparison is case-insensitive.
+   If a registered format with the specified name already exists, a new
+   format is not registered and the return value identifies the existing
+   format. This enables more than one application to copy and paste data
+   using the same registered clipboard format. Note that the format name
+   comparison is case-insensitive.
+
+   Registered clipboard formats are identified by values in the range 0xC000
+   through 0xFFFF.
 
-	Registered clipboard formats are identified by values in the range 0xC000
-	through 0xFFFF.
-	
 Clipboard.set_data(data, format=nil)
    Sets the clipboard contents to the data that you specify.  You may
-   optionally specify a clipboard format.  The default is Clipboard::TEXT.
+   optionally specify a clipboard format. The default is Clipboard::TEXT.
     
    See the 'Constants' section for a list of the supported formats.
-	
+
 == Error Classes
-ClipboardError
-	Typically only raised if the clipboard fails to open or if you attempt to
-	register an invalid format.
+Clipboard::Error
+   Typically only raised if the clipboard fails to open or if you attempt to
+   register an invalid format.
     
 == Constants
 === Standard Constants
@@ -97,10 +103,10 @@ Clipboard::UNICODETEXT
    Ruby's
     
 == Copyright
-   (C) 2003-2006 Daniel J. Berger
+   (C) 2003-2007 Daniel J. Berger
    All Rights Reserved
     
 == Author
    Daniel J. Berger
-   djberg96 at gmail dot com
-   imperator/mok on IRC
+   djberg96 at nospame gmail dot com
+   imperator on IRC (irc.freenode.org)

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+
+desc "Install the win32-clipboard package (non-gem)"
+task :install do
+   dest = File.join(Config::CONFIG['sitelibdir'], 'win32')
+   Dir.mkdir(dest) unless File.exists? dest
+   cp 'lib/win32/clipboard.rb', dest, :verbose => true
+end
+
+desc "Install the win32-clipboard package as a gem"
+task :install_gem do
+   ruby 'win32-clipboard.gemspec'
+   file = Dir["*.gem"].first
+   sh "gem install #{file}"
+end
+
+Rake::TestTask.new do |t|
+   t.libs << 'lib'
+   t.warning = true
+   t.test_files = FileList['test/tc*']
+end

data/lib/win32/clipboard.rb

@@ -3,8 +3,9 @@ require 'windows/memory'
 require 'windows/error'
 
 module Win32
-   class ClipboardError < StandardError; end
    class Clipboard
+      class Error < StandardError; end
+      
       include Windows::Clipboard
       include Windows::Memory
       include Windows::Error
@@ -12,7 +13,7 @@ module Win32
       extend Windows::Memory
       extend Windows::Error
       
-      VERSION = '0.4.2'
+      VERSION = '0.4.3'
       
       # Clipboard data types
       TEXT        = CF_TEXT
@@ -46,7 +47,7 @@ module Win32
             error = get_last_error
             GlobalFree(hmem)
             self.close
-            raise ClipboardError, "SetClipboardData() failed: #{error}"
+            raise Error, "SetClipboardData() failed: #{error}"
          end
 
          GlobalFree(hmem)   
@@ -149,7 +150,7 @@ module Win32
       def self.register_format(format)
          if RegisterClipboardFormat(format) == 0
             error = "RegisterClipboardFormat() call failed: " + get_last_error
-            raise ClipboardError,  error
+            raise Error,  error
          end
       end
 
@@ -157,7 +158,7 @@ module Win32
 
       def self.open
          if 0 == OpenClipboard(0)
-            raise ClipboardError, "OpenClipboard() failed: " + get_last_error
+            raise Error, "OpenClipboard() failed: " + get_last_error
          end
       end
 

data/test/tc_clipboard.rb

@@ -4,21 +4,16 @@
 # Test suite for the win32-clipboard package.  This will copy and remove
 # data from your clipboard.  If your current clipboard data is crucial to
 # you, please save it first.
+#
+# You should run this test case via the 'rake test' task.
 ###########################################################################
-base = File.basename(Dir.pwd)
-if base == 'test' || base =~ /win32-clipboard/
-   Dir.chdir('..') if base == 'test'
-   $LOAD_PATH.unshift(Dir.pwd + '/lib')
-   Dir.chdir('test') if base =~ /win32-clipboard/
-end
-
-require "win32/clipboard"
-require "test/unit"
+require 'win32/clipboard'
+require 'test/unit'
 include Win32
 
 class TC_Win32ClipBoard < Test::Unit::TestCase  
    def test_version
-      assert_equal('0.4.2', Clipboard::VERSION)
+      assert_equal('0.4.3', Clipboard::VERSION)
    end
      
    def test_data

data/win32-clipboard.gemspec

@@ -2,7 +2,7 @@ require "rubygems"
 
 spec = Gem::Specification.new do |gem|
 	gem.name         = "win32-clipboard"
-	gem.version      = "0.4.2"
+	gem.version      = "0.4.3"
 	gem.author       = "Daniel J. Berger"
 	gem.email        = "djberg96@gmail.com"
 	gem.homepage     = "http://www.rubyforge.org/projects/win32utils"
@@ -12,7 +12,7 @@ spec = Gem::Specification.new do |gem|
 	gem.test_file    = "test/tc_clipboard.rb"
 	gem.has_rdoc     = true
 	gem.require_path = "lib"
-	gem.extra_rdoc_files  = ["CHANGES","README"]
+	gem.extra_rdoc_files  = ['CHANGES', 'README', 'MANIFEST']
 	gem.rubyforge_project = "win32utils"
 	gem.add_dependency("windows-pr", ">= 0.4.1")
 	

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0.8
+rubygems_version: 0.9.2
 specification_version: 1
 name: win32-clipboard
 version: !ruby/object:Gem::Version 
-  version: 0.4.2
-date: 2007-01-27 00:00:00 -07:00
+  version: 0.4.3
+date: 2007-07-25 00:00:00 -06:00
 summary: A package for interacting with the Windows clipboard
 require_paths: 
 - lib
@@ -34,9 +34,9 @@ files:
 - test/tc_clipboard.rb
 - CHANGES
 - examples
-- install.rb
 - lib
 - MANIFEST
+- Rakefile
 - README
 - test
 - win32-clipboard.gemspec
@@ -47,6 +47,7 @@ rdoc_options: []
 extra_rdoc_files: 
 - CHANGES
 - README
+- MANIFEST
 executables: []
 
 extensions: []

data/install.rb

@@ -1,10 +0,0 @@
-require 'rbconfig'
-require 'ftools'
-include Config
-
-sitelibdir = CONFIG['sitelibdir']
-installdir = sitelibdir + '/win32'
-file = 'lib\win32\clipboard.rb'
-
-Dir.mkdir(installdir) unless File.exists?(installdir)
-File.copy(file, installdir, true)