clipboard 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cb0707321680a4dbb4b9ab0bf24ff6fc1162e9f2770d6424065ee3c63fd6b1b
-  data.tar.gz: 4a92d7a1546f178e5acfef108307a27eb1c230d127bedde527f1d45c8f1a1fd2
+  metadata.gz: 0db9702c7b8ca48e95e26e612cf294b78d4eb188a4e74a72a002fb064e6c61e3
+  data.tar.gz: 6abd7baac11e392fa41997d771504c6b104350f8049693735f233dee6bba8915
 SHA512:
-  metadata.gz: f6839e8dc8d63e1fe38a2c66ead80cf90abf22ced2539fa0ab8024f0be8d8fdecf93f3e007a29b039988d9b3162ef29abb9f001db13e8a1cd903242f9c199e22
-  data.tar.gz: 9c5554455692d8a41322763abbfbc939a8ddd6344b183042b56a4aa6a1d72014449a912fc5cabcc3800b3930022ec831012b6a1f28a2f4b6b943f1cbbc5b91b0
+  metadata.gz: a4b5ff54912337f98f1918375e8839b6eae786b9aa464bfa1b1aacf4bff3e30967f9104fa520f8fe6f343e7273c5982db1c109705884f4426b23166f02a8ec37
+  data.tar.gz: cbe9164425d0f9f1ab7f0efd270a8adcf9e65ba472a644afab3301e100e9fab9d27a400c0e8964200898edec99a2fa91259d877dc0219549778f35625d594295

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## 1.3.0
+### Bug Fixes
+* Conditionally read or don't read the output stream of external commands, fixes #32
+  * Special thanks to @orange-kao for the bug report + PR
+
+### New Features
+* Add a GTK based clipboard
+
+### Internal changes
+* Use frozen string literals
+
 ## 1.2.1
 * Add WSL to autoloaded constants
 

data/MIT-LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2016 Jan Lelis
+Copyright (c) 2010-2018 Jan Lelis
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,66 +1,87 @@
-# Ruby Clipboard [![version](https://badge.fury.io/rb/clipboard.svg)](https://badge.fury.io/rb/clipboard) [<img src="https://travis-ci.org/janlelis/clipboard.svg" />](https://travis-ci.org/janlelis/clipboard)
+# Clipboard Ruby Gem [![version](https://badge.fury.io/rb/clipboard.svg)](https://badge.fury.io/rb/clipboard) [<img src="https://travis-ci.org/janlelis/clipboard.svg" />](https://travis-ci.org/janlelis/clipboard)
 
-Lets you access the clipboard on Linux, MacOS, Windows and Cygwin.
+Lets you access the clipboard from everywhere. Currently supported platforms:
+
+- Linux
+- MacOS
+- Windows
+- Cygwin (POSIX environment for Windows)
+- WSL (Windows Subsystem for Linux)
+- Gtk+ (Cross Platform Widget Toolkit)
+- Java (on JRuby)
 
 ## Usage
 
-* `Clipboard.copy`
-* `Clipboard.paste`
-* `Clipboard.clear`
+* `Clipboard.copy` - Copies a string to system clipboard
+* `Clipboard.paste` - Paste contents from system clipboard as string
+* `Clipboard.clear` - Empties the system clipboard
 
 ## Setup
 
-Add to `Gemfile`:
+Add the following lines to your `Gemfile`:
 
 ```ruby
 gem 'clipboard'
 gem 'ffi', :platforms => [:mswin, :mingw]
 ```
 
-- **Linux**: You will need the `xclip` or `xsel` program. On debian/ubuntu
-this is: `sudo apt-get install xclip`
+- Important note for **Linux** users: The clipboard requires the *xclip* or the *xsel* command-line program. On debian and ubuntu, xclip can be installed with: `sudo apt-get install xclip`
 
-## Remarks
-### Multiple Clipboards
+## Clipboard Implementations
 
-On Linux, you can choose from which clipboard you want to `paste` from by
-passing it as an argument. The default is CLIPBOARD.
+In most environments, the appropriate clipboard implementation can be detected automatically. If none is found, the gem will fallback to a file based one, which will just write to/read from `~/.clipboard` instead of the system clipboard.
 
-`copy` copies to all clipboards in `Clipboard::Linux::CLIPBOARDS`.
+You can check the implementation used with: `Clipboard.implementation`
 
-### Windows Encoding
+### Alternative Clipboard Providers
 
-Windows uses [UTF-16LE](https://en.wikipedia.org/wiki/UTF-16) as its default
-encoding, so pasted strings will always come in UTF-16LE. You can manually
-convert them to your desired encoding (e.g. UTF-8) using the
-[String#encode](ruby-doc.org/core-2.3.0/String.html#method-i-encode) method:
+There are two implementations included in this gem, which are not used by default. You can opt-in to use them if you think they are a better fit for your application environment:
 
-```ruby
-Clipboard.paste.encode('UTF-8')
-```
+#### Java
+
+Activate with: `Clipboard.implementation = Clipboard::Java`
+
+This is an option for [JRuby users](https://www.jruby.org/) which will use the clipboard functionality from the Java standard library.
+
+#### GTK+
+
+Activate with: `Clipboard.implementation = Clipboard::Gtk`
+
+This utilizes the **GTK+** library. See [Ruby-GNOME2](https://github.com/ruby-gnome2/ruby-gnome2#ruby-gnome2) for more info.
+
+Requires the `gtk3` or `gtk2` gem to be installed.
 
-### SSH
+## Tips & Tricks
 
-To use the clipboard through ssh, you need to install `xauth` on your server
-and connect via `ssh -X` or `ssh -Y`. Please note that some server settings
-restrict this feature.
+### Linux: Using Clipboard via SSH
 
-### Java
+To be able to use the clipboard through SSH, you need to install `xauth` on your server and connect via `ssh -X` or `ssh -Y`. Please note that some server settings restrict this feature.
 
-There is a Java implementation included (`Clipboard::Java`) as an option for
-JRuby. On Linux, it always operates only on the CLIPBOARD clipboard.
+### Linux: Paste From Specific X11 Selection
 
-### TODO
+The clipboard on Linux is divided into multiple clipboard selections. You can choose from which clipboard you want to `paste` from by
+passing it as an argument. The default is *:clipboard*, other options are *:primary* and *:secondary*.
 
-* Native support on X (don't depend on `xclip`/`xsel`) would be great
+`Clipboard.copy` always copies to all three clipboards.
 
-### blip
+### Windows: Encoding Info
+
+Windows uses [UTF-16LE](https://en.wikipedia.org/wiki/UTF-16) as its default encoding, so pasted strings will always come in UTF-16. You can then manually convert them to your desired encoding, for example, UTF-8, using the [String#encode](ruby-doc.org/core-2.3.0/String.html#method-i-encode) method:
+
+```ruby
+Clipboard.paste.encode('UTF-8')
+```
+
+### CLI Utility: blip
+
+The [blip gem]((https://gist.github.com/janlelis/781835)) is a handy command-line wrapper for the clipboard gem. It lets you quickly copy file content to your clipboard:
+
+```
+$ blip FILE_NAME
+```
 
-**blip** is a handy commandline wrapper that lets you quickly copy file
-content to your clipboard: [blip](https://gist.github.com/janlelis/781835)!
+Without any arguments, it will just paste the contents of the clipboard.
 
-### Copyright
+### MIT
 
-Copyright (c) 2010-2016 Jan Lelis <http://janlelis.com> released under the MIT
-license. Contributions by and thanks to Michael Grosser and [all the other
-contributors!](https://github.com/janlelis/clipboard/graphs/contributors)
+Copyright (c) 2010-2018 Jan Lelis <http://janlelis.com> released under the MIT license. Contributions by and thanks to Michael Grosser and [all the other contributors!](https://github.com/janlelis/clipboard/graphs/contributors)

data/clipboard.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.summary = "Access to the clipboard on Linux, MacOS, Windows, and Cygwin."
   s.description = "Access to the clipboard on Linux, MacOS, Windows, and Cygwin: Clipboard.copy, Clipboard.paste, Clipboard.clear"
   s.email = "mail@janlelis.de"
-  s.homepage = "http://github.com/janlelis/clipboard"
+  s.homepage = "https://github.com/janlelis/clipboard"
   s.license = "MIT"
   s.requirements = [
     "On Linux (or other X), you will need xclip. On debian/ubuntu this is: sudo apt-get install xclip",
@@ -20,4 +20,6 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.9.3'
   s.add_development_dependency 'rake', '~> 11'
   s.add_development_dependency 'rspec', '~> 3'
+  # s.add_development_dependency 'ffi', '~> 1.9'
+  # s.add_development_dependency 'gtk3', '~> 3'
 end

data/lib/clipboard.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rbconfig'
 require File.dirname(__FILE__) + '/clipboard/version'
 
@@ -13,6 +15,7 @@ module Clipboard
     autoload :Java,    'clipboard/java'
     autoload :Cygwin,  'clipboard/cygwin'
     autoload :Wsl,     'clipboard/wsl'
+    autoload :Gtk,     'clipboard/gtk'
   end
   autoload :Windows, 'clipboard/windows'
   autoload :File,    'clipboard/file'

data/lib/clipboard/cygwin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Clipboard
   module Cygwin
     extend self

data/lib/clipboard/file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Clipboard
   module File
     extend self

data/lib/clipboard/gtk.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# Ruby-Gnome2 based implementation
+# Requires either the gtk3 or the gtk2 gem
+
+module Clipboard
+  module Gtk
+    extend self
+
+    CLIPBOARDS = %w[CLIPBOARD PRIMARY SECONDARY].freeze
+
+    unless defined? ::Gtk
+      begin
+        require 'gtk3'
+      rescue LoadError
+        begin
+          require 'gtk2'
+        rescue LoadError
+          raise LoadError, 'Could not load the required gtk3 or gtk2 gem, please install it with: gem install gtk3'
+        end
+      end
+    end
+
+    def copy(text)
+      CLIPBOARDS.each{ |which|
+        ::Gtk::Clipboard.get(Gdk::Selection.const_get(which)).set_text(text).store
+      }
+      paste
+    end
+
+    def paste(which = nil)
+      if !which || !CLIPBOARDS.include?(which_normalized = which.to_s.upcase)
+        which_normalized = CLIPBOARDS.first
+      end
+
+      ::Gtk::Clipboard.get(
+        Gdk::Selection.const_get(which_normalized)
+      ).wait_for_text || ""
+    end
+
+    def clear
+      CLIPBOARDS.each{ |which|
+        ::Gtk::Clipboard.get(Gdk::Selection.const_get(which)).clear
+      }
+    end
+  end
+end

data/lib/clipboard/java.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Clipboard
   # Basic java clipboard access (jruby). No fun to use on X.
   module Java

data/lib/clipboard/linux.rb

@@ -1,6 +1,6 @@
-require 'open3'
+# frozen_string_literal: true
 
-require_relative 'utils'
+require_relative "utils"
 
 module Clipboard
   module Linux
@@ -10,23 +10,31 @@ module Clipboard
 
     # check which backend to use
     if Utils.executable_installed?('xclip')
-      WriteCommand = 'xclip'.freeze
-      ReadCommand  = 'xclip -o'.freeze
-      Selection    = proc{ |x| "-selection #{x}" }.freeze
+      WriteCommand = 'xclip'
+      ReadCommand  = 'xclip -o'
+      ReadOutputStream = false
+      Selection    = proc{ |x|
+        "-selection #{x}"
+      }.freeze
     elsif Utils.executable_installed?('xsel')
-      WriteCommand = 'xsel -i'.freeze
-      ReadCommand  = 'xsel -o'.freeze
-      Selection    = { 'clipboard' => '-b', 'primary' => '-p', 'secondary' => '-s' }.freeze
+      WriteCommand = 'xsel -i'
+      ReadCommand  = 'xsel -o'
+      ReadOutputStream = true
+      Selection    = {
+        'clipboard' => '-b',
+        'primary' => '-p',
+        'secondary' => '-s'
+      }.freeze
     else
       raise Clipboard::ClipboardLoadError, "clipboard: 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)
-      if !which || !CLIPBOARDS.include?(which.to_s.downcase)
-        which = CLIPBOARDS.first
+      if !which || !CLIPBOARDS.include?(which_normalized = which.to_s.downcase)
+        which_normalized = CLIPBOARDS.first
       end
-      `#{ReadCommand} #{Selection[which.to_s.downcase]} 2> /dev/null`
+      `#{ReadCommand} #{Selection[which_normalized]} 2> /dev/null`
     end
 
     def clear
@@ -35,7 +43,7 @@ module Clipboard
 
     def copy(data)
       CLIPBOARDS.each{ |which|
-        Open3.popen3( "#{WriteCommand} #{Selection[which.to_s.downcase]}" ){ |input, _, _| input << data }
+        Utils.popen "#{WriteCommand} #{Selection[which]}", data, ReadOutputStream
       }
       paste
     end

data/lib/clipboard/mac.rb

@@ -1,4 +1,6 @@
-require 'open3'
+# frozen_string_literal: true
+
+require_relative "utils"
 
 module Clipboard
   module Mac
@@ -9,7 +11,7 @@ module Clipboard
     end
 
     def copy(data)
-      Open3.popen3( 'pbcopy' ){ |input, _, _| input << data }
+      Utils.popen "pbcopy", data
       paste
     end
 

data/lib/clipboard/utils.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require "open3"
+
 module Clipboard
   module Utils
     extend self
@@ -7,5 +11,23 @@ module Clipboard
         ::File.executable?(::File.join(path, cmd))
       end
     end
+
+    # Utility to call external command
+    # - pure .popen2 becomes messy with xsel when not reading the output stream
+    # - xclip doesn't like to have output stream read
+    def popen(cmd, data, read_output_stream = false)
+      Open3.popen2(cmd) { |input, output, waiter_thread|
+        output_thread = Thread.new { output.read } if read_output_stream
+
+        begin
+          input.write data
+        rescue Errno::EPIPE
+        end
+
+        input.close
+        output_thread.value if read_output_stream
+        waiter_thread.value
+      }
+    end
   end
 end

data/lib/clipboard/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Clipboard
-  VERSION = "1.2.1".freeze
+  VERSION = "1.3.0"
 end

data/lib/clipboard/windows.rb

@@ -1,4 +1,6 @@
-require 'open3'
+# frozen_string_literal: true
+
+require_relative "utils"
 
 module Clipboard
   module Windows
@@ -76,7 +78,7 @@ module Clipboard
         User32.set( CF_UNICODETEXT, handler )
         User32.close( )
       else # don't touch anything
-        Open3.popen3( 'clip' ){ |input, _, _| input << data_to_copy } # depends on clip (available by default since Vista)
+        Utils.popen "clip", data_to_copy # depends on clip (available by default since Vista)
       end
       paste
     end

data/lib/clipboard/wsl.rb

@@ -1,4 +1,6 @@
-require 'open3'
+# frozen_string_literal: true
+
+require_relative "utils"
 
 module Clipboard
   module Wsl
@@ -9,7 +11,7 @@ module Clipboard
     end
 
     def copy(data)
-      Open3.popen3( 'clip.exe' ){ |input, _, _| input << data }
+      Utils.popen "clip.exe", data
       paste
     end
 

data/spec/clipboard_linux_spec.rb

@@ -0,0 +1,20 @@
+require_relative 'spec_helper'
+
+require "clipboard/linux"
+
+describe Clipboard::Linux do
+  # See https://github.com/janlelis/clipboard/issues/32 by @orange-kao
+  it "can copy more than 8192 bytes" do
+    # first batch
+    data1 = Random.new.bytes(2**14).unpack("H*").first
+    data2 = Clipboard.copy(data1)
+
+    expect(data2).to eq data1
+
+    # second batch
+    data1 = Random.new.bytes(2**14).unpack("H*").first
+    data2 = Clipboard.copy(data1)
+
+    expect(data2).to eq data1
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clipboard
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Jan Lelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-10 00:00:00.000000000 Z
+date: 2018-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -53,6 +53,7 @@ files:
 - lib/clipboard.rb
 - lib/clipboard/cygwin.rb
 - lib/clipboard/file.rb
+- lib/clipboard/gtk.rb
 - lib/clipboard/java.rb
 - lib/clipboard/linux.rb
 - lib/clipboard/mac.rb
@@ -60,9 +61,10 @@ files:
 - lib/clipboard/version.rb
 - lib/clipboard/windows.rb
 - lib/clipboard/wsl.rb
+- spec/clipboard_linux_spec.rb
 - spec/clipboard_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/janlelis/clipboard
+homepage: https://github.com/janlelis/clipboard
 licenses:
 - MIT
 metadata: {}