clipboard 0.9.4 → 0.9.5

data/CHANGELOG.rdoc

@@ -0,0 +1,8 @@
+== 0.9.5
+* Fallback to Clipboard::File, if no other clipboard is available
+* Also check for xsel if using linux implementation
+* Fix for jruby copying
+* You can directly use a specific implementation, e.g.: require 'clipboard/file' # gives you Clipboard::File
+
+== < 0.9.4
+See https://github.com/janlelis/clipboard/commits/0.9.4

data/README.rdoc

@@ -21,22 +21,28 @@ If you paste with 1.9, the Clipboard encoding will be translated to your <tt>Enc
 If you paste with 1.8, it will fallback to CP850 encoding.
 Copying with 1.8 will fallback to the +clip+ utility, which is installed by default since Vista
 
+==== SSH note
+To you use the clipboard through ssh, you need to install <tt>xauth</tt> on your server and connect via <tt>ssh -X</tt> or <tt>ssh -Y</tt>.
+
 === Non-gem requirements
 * *Linux*: +xclip+, you can install it on debian/ubuntu with <tt>sudo apt-get install xclip</tt>
 
 === Todo
 * Don't depend on +xclip+
 
-Feel free to report bugs or to implement one of the Todo entries ;)
+...if there is enough demand or motivation for me °_°
 
-=== blip
+==== Planned for 0.9.5
+* Fallback to <tt>~/.clipboard</tt> if the real clipboard can't be accessed.
+* Also check for +xsel+ on linux
 
+=== blip
 Copy and paste from the commandline (like xclip, pbpaste/pbcopy), but even easier? {blip}[http://rubygems.org/gems/blip]!
 
 === Copyright
 Copyright (c) 2010-2011 Jan Lelis, http://rbjl.net, released under the MIT license
 
-Contributions by
+Contributions by and thanks to
 * Michael Grosser
 
 J-_-L

data/VERSION

@@ -1 +1 @@
-0.9.4
+0.9.5

data/clipboard.gemspec

@@ -6,12 +6,12 @@ Gem::Specification.new do |s|
   s.version = File.read('VERSION').chomp
 
   s.authors = ["Jan Lelis"]
-  s.date = '2011-01-16'
+  s.date = '2011-02-28'
   s.summary = 'Access the clipboard on all systems.'
   s.description = 'Access the clipboard on all systems (Clipboard.copy & Clipboard.paste).'
   s.email = 'mail@janlelis.de'
   s.homepage = %q{http://github.com/janlelis/clipboard}
-  s.rubygems_version = %q{1.3.7}
+  s.required_rubygems_version = ">= 1.3.6"
   s.requirements =  ["On Linux (or other X), you need xclip. Install it on debian/ubuntu with sudo apt-get install xclip"]
   s.requirements << ["On Windows, you need the ffi gem."]
   s.files = Dir.glob(%w[{lib,spec}/**/*.rb [A-Z]* [A-Z]*.rdoc]) + %w{clipboard.gemspec}

data/lib/clipboard.rb

@@ -1,18 +1,49 @@
 module Clipboard
   extend self
+
   VERSION = File.read( (File.dirname(__FILE__) + '/../VERSION') ).chomp
 
-  os = proc do
-    case RbConfig::CONFIG['host_os']
-    when /mac|darwin/ then 'mac'
-    when /linux|cygwin/ then 'linux'
-    when /mswin|mingw/ then 'windows'
-    when /bsd/ then 'linux'
-    # when /solaris|sunos/ then 'linux' # needs testing..
+  class ClipboardLoadError < Exception
+  end
+
+  autoload :Linux,   'clipboard/linux'
+  autoload :Mac,     'clipboard/mac'
+  autoload :Windows, 'clipboard/windows'
+  autoload :File,    'clipboard/file'
+
+  def self.implementation
+  return @implementation if @implementation
+
+    os = case RbConfig::CONFIG['host_os']
+    when /mac|darwin/        then :Mac
+    when /linux|bsd|cygwin/  then :Linux
+    when /mswin|mingw/       then :Windows
+    # when /solaris|sunos/     then :Linux # needs testing..
     else
-      raise "You OS is not supported -> fork me"
+      raise ClipboardLoadError, "Your OS(#{ RbConfig::CONFIG['host_os'] }) is not supported, using file-based (fake) clipboard"
     end
+
+    @implementation = Clipboard.const_get os
+  rescue ClipboardLoadError => e
+    $stderr.puts e.message if $VERBOSE
+    @implementation = Clipboard::File
+  end
+
+  def self.implementation=(val)
+    @implementation = val
+  end
+
+  def paste(*args)
+    Clipboard.implementation.paste(*args)
   end
 
-  require "clipboard/#{os.call}"
+  def clear(*args)
+    Clipboard.implementation.clear(*args)
+  end
+
+  def copy(*args)
+    Clipboard.implementation.copy(*args)
+  end
 end
+
+Clipboard.implementation # TODO remove this?

data/lib/clipboard/file.rb

@@ -0,0 +1,20 @@
+module Clipboard; end
+
+module Clipboard::File
+  extend self
+
+  FILE = File.expand_path("~/.clipboard")
+
+  def copy(text)
+    File.open(FILE,'w'){|f| f.write(text) } rescue ''
+    paste
+  end
+
+  def paste(_ = nil)
+    File.read(FILE) rescue ''
+  end
+
+  def clear
+    copy ''
+  end
+end

data/lib/clipboard/linux.rb

@@ -1,18 +1,32 @@
-module Clipboard
+require 'open3'
+
+module Clipboard; end
+
+module Clipboard::Linux
+  extend self
+
   CLIPBOARDS   = %w[clipboard primary secondary]
-  WriteCommands = CLIPBOARDS.map{|cb| 'xclip -selection ' + cb }
-  ReadCommand  = 'xclip -o'
 
-  # catch dependency errors
-  if `which xclip`.empty?
-    raise LoadError, "clipboard:\n" +
-          "Could not find required prgram xclip\n" +
+  # check which backend to use
+  if !`which xclip`.empty?
+    WriteCommand = 'xclip'
+    ReadCommand  = 'xclip -o'
+    Selection    = proc{|x| "-selection #{x}"}
+  elsif !`which xsel`.empty?
+    WriteCommand = 'xsel'
+    ReadCommand  = 'xsel -o'
+    Selection    = {'clipboard' => '-b', 'primary' => '-p', 'secondary' => '-s'}
+  else
+    raise Clipboard::ClipboardLoadError, "clipboard:\n" \
+          "Could not find required program xclip (or xsel)\n" \
           "On debian/ubuntu, you can install it with: sudo apt-get install xclip"
   end
 
   def paste(which = nil)
-    which ||= CLIPBOARDS.first
-    `#{ReadCommand} -selection #{which}`
+    if !which || !CLIPBOARDS.include?(which.to_s.downcase)
+      which = CLIPBOARDS.first
+    end
+    `#{ReadCommand} #{Selection[which.to_s.downcase]}`
   end
 
   def clear
@@ -20,8 +34,8 @@ module Clipboard
   end
 
   def copy(data)
-    WriteCommands.each{ |cmd|
-      IO.popen( cmd, 'w' ){ |input| input << data }
+    CLIPBOARDS.each{ |which|
+      Open3.popen3( "#{WriteCommand} #{Selection[which.to_s.downcase]}" ){ |input,_,_| input << data }
     }
     paste
   end

data/lib/clipboard/mac.rb

@@ -1,10 +1,16 @@
-module Clipboard
+require 'open3'
+
+module Clipboard; end
+
+module Clipboard::Mac
+  extend self
+
   def paste(_ = nil)
     `pbpaste`
   end
 
   def copy(data)
-    IO.popen('pbcopy', 'w'){|input| input << data }
+    Open3.popen3( 'pbcopy' ){ |input,_,_| input << data }
     paste
   end
 

data/lib/clipboard/windows.rb

@@ -1,4 +1,10 @@
-module Clipboard
+require 'open3'
+
+module Clipboard; end
+
+module Clipboard::Windows
+  extend self
+
   CF_TEXT = 1
   CF_UNICODETEXT = 13
   GMEM_MOVEABLE = 2
@@ -33,7 +39,7 @@ module Clipboard
   end
 
   # see http://www.codeproject.com/KB/clipboard/archerclipboard1.aspx
-  def paste(_=nil)
+  def paste(_ = nil)
     ret = ""
       if 0 != User32.open( 0 )
         hclip = User32.get( CF_UNICODETEXT )
@@ -82,7 +88,7 @@ module Clipboard
       User32.set( CF_UNICODETEXT, handler )
       User32.close( )
     else # don't touch anything
-      IO.popen( 'clip', 'w' ){ |input| input << data_to_copy } # depends on clip (available by default since Vista)
+      Open3.popen3( 'clip' ){ |input,_,_| input << data_to_copy } # depends on clip (available by default since Vista)
     end
     paste
   end

data/spec/clipboard_spec.rb

@@ -1,6 +1,12 @@
 require File.expand_path('spec/spec_helper')
 
+$os = RbConfig::CONFIG['host_os']
+
 describe Clipboard do
+  before do
+    RbConfig::CONFIG['host_os'] = $os
+  end
+
   it "has a VERSION" do
     Clipboard::VERSION.should =~ /^\d+\.\d+\.\d+$/
   end
@@ -13,4 +19,72 @@ describe Clipboard do
   it "returns data on copy" do
     Clipboard.copy('xxx').should == 'xxx'
   end
-end
+
+  it "can clear" do
+    Clipboard.copy('xxx')
+    Clipboard.clear
+    Clipboard.paste.should == ''
+  end
+
+  describe "when included" do
+    class A
+      include Clipboard
+    end
+
+    it "can copy & paste & clear" do
+      a = A.new
+      a.send(:copy, "XXX").should == 'XXX'
+      a.send(:paste).should == "XXX"
+      a.send(:clear)
+      a.send(:paste).should == ''
+    end
+  end
+
+  describe 'Clipboard::File' do
+    before :all do
+      Clipboard.implementation = Clipboard::File
+      cache = Clipboard::File::FILE
+      FileUtils.rm cache if File.exist?(cache)
+    end
+
+    it "can paste with empty file" do
+      Clipboard.paste.should == ''
+    end
+
+    it "can copy & paste" do
+      Clipboard.copy('xxx').should == 'xxx'
+      Clipboard.paste.should == 'xxx'
+    end
+
+    it "can clear" do
+      Clipboard.copy('xxx').should == 'xxx'
+      Clipboard.clear
+      Clipboard.paste.should == ''
+    end
+  end
+
+  describe :implementation do
+    before do
+      $VERBOSE = true
+      Clipboard.implementation = nil
+    end
+
+    it "does not warn on normal detection" do
+      $stderr.should_not_receive(:puts)
+      Clipboard.implementation
+    end
+
+    it "warns when OS is unknown" do
+      RbConfig::CONFIG['host_os'] = 'Fooo OS'
+      $stderr.should_receive(:puts)
+      Clipboard.implementation.should == Clipboard::File
+    end
+
+    it "does not warn when $VERBOSE is false" do
+      $VERBOSE = false
+      RbConfig::CONFIG['host_os'] = 'Fooo OS'
+      $stderr.should_not_receive(:puts)
+      Clipboard.implementation
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,2 +1,3 @@
 $LOAD_PATH.unshift 'lib'
-require 'clipboard'
+require 'clipboard'
+require 'clipboard/file'

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 9
-  - 4
-  version: 0.9.4
+  - 5
+  version: 0.9.5
 platform: ruby
 authors: 
 - Jan Lelis
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-16 00:00:00 +01:00
+date: 2011-02-28 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -28,17 +28,19 @@ extra_rdoc_files: []
 
 files: 
 - lib/clipboard.rb
-- lib/clipboard/mac.rb
 - lib/clipboard/linux.rb
+- lib/clipboard/mac.rb
+- lib/clipboard/file.rb
 - lib/clipboard/windows.rb
-- spec/spec_helper.rb
 - spec/clipboard_spec.rb
-- Gemfile
+- spec/spec_helper.rb
 - Rakefile
-- LICENSE
-- Gemfile.lock
 - README.rdoc
+- Gemfile
+- Gemfile.lock
+- LICENSE
 - VERSION
+- CHANGELOG.rdoc
 - clipboard.gemspec
 has_rdoc: true
 homepage: http://github.com/janlelis/clipboard
@@ -63,8 +65,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: 
 - On Linux (or other X), you need xclip. Install it on debian/ubuntu with sudo apt-get install xclip
 - - On Windows, you need the ffi gem.