clipboard 1.3.5 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 892729b3fc00a3f989dfa1c3c5e1c05062b94a2f01af23a358d519a09b737f33
-  data.tar.gz: 38f17ac7f06b2ff302b9498c3a3ad81bc2e7c9418f700f485569d8b8f15a18c9
+  metadata.gz: 36dbdb09b06bc41833ad82b692560179ea1dde1a061db1dfab093d6ddea64cb7
+  data.tar.gz: 2fc4772e208ee387887ba3558b4acfdc810132877664f59d30fe5605c0218c2e
 SHA512:
-  metadata.gz: 5920c4e55b0322ac05a0df5c36e7d3c2dca41a31a481aab7ed3df6f838a10c0d4592910617c4e95b5878d5133d1b628b46cecef236118abecab608dc64b31827
-  data.tar.gz: 4ff5e2aba0b87384d16941ed3b85ba61382c7e28bc3a07e922328e3a9faf8a23f0524b797d8a729fd34cbb11720d6271890b6d772597444793dc66dd9443ad27
+  metadata.gz: 73d188dcf4b8ce431da705feaa6cdf71889ab48679d584450cdf88e871f19fb0ff15b7c1d325ca65f104bdc4195c8bdbdfb01ff477e4fef8f2ab20a12ff8bd4f
+  data.tar.gz: c7d4e4c0e7ca463c4d3799bfbe7a15b1c1cb67aaca4fa1b84aacb9ea39794b8d64eb264d86ab773806049a1a5c6abe766c7ccb87211ebb4afb64fc7faf313259

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## 1.4.0
+* Add Wayland support via `wl-copy`, patch by @cramt
+* Only silence clipboard warnings when $VERBOSE is nil
+
+## 1.3.6
+* Fix Windows implementation (so it works on more recent Windows), patch by @P3t3rU5
+
 ## 1.3.5
 * Fix missing String#+@ method on Ruby <2.3, patch by @AaronC81
 
@@ -7,7 +14,6 @@
 * Don't break on Ruby 2.1, patch by @grosser
 
 ## 1.3.3
-
 * Fix Cygwin implementation to work when File constant is loaded, fix by @ntachino
 
 ## 1.3.2

data/MIT-LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2020 Jan Lelis
+Copyright (c) 2010-2024 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,8 +1,9 @@
-# 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)
+# Clipboard Ruby Gem [![version](https://badge.fury.io/rb/clipboard.svg)](https://badge.fury.io/rb/clipboard) [![[ci]](https://github.com/janlelis/clipboard/workflows/Test/badge.svg)](https://github.com/janlelis/clipboard/actions?query=workflow%3ATest)
 
 Lets you access the clipboard from everywhere. Currently supported platforms:
 
-- Linux
+- Linux (X11)
+- Linux (Wayland)
 - MacOS
 - Windows
 - Cygwin (POSIX environment for Windows)
@@ -10,14 +11,14 @@ Lets you access the clipboard from everywhere. Currently supported platforms:
 - Gtk+ (Cross Platform Widget Toolkit)
 - Java (on JRuby)
 
-Supported Rubies: **2.7**, **2.6**, **2.5**
+Supported Rubies: **3.3**, **3.2**, **3.1**, **3.0**
 
-Unsupported, but might still work: **2.4**, **2.3**, **2.2**, **2.1**, **2.0**
+Unsupported, but might still work: **2.X**
 
 ## Usage
 
 * `Clipboard.copy` - Copies a string to system clipboard
-* `Clipboard.paste` - Paste contents from system clipboard as string
+* `Clipboard.paste` - Paste text contents from system clipboard as string
 * `Clipboard.clear` - Empties the system clipboard
 
 ## Setup
@@ -29,7 +30,7 @@ gem "clipboard"
 gem "ffi", :platforms => [:mswin, :mingw] # Required by Clipboard on Windows
 ```
 
-- **Important note for Linux** users: The clipboard requires the *xsel* or the *xclip* command-line program. On debian and ubuntu, *xsel* can be installed with: `sudo apt-get install xsel`
+- **Important note for Linux** users: The clipboard requires the *xsel* or the *xclip* command-line program (X11), or the *wl-copy* / *wl-paste* command-line programs (Wayland). On debian and ubuntu, *xsel* can be installed with: `sudo apt-get install xsel` and *wl-copy* / *wl-paste* with `sudo apt-get install wl-clipboard`.
 
 ## Clipboard Implementations
 
@@ -70,7 +71,7 @@ passing it as an argument. The default is *:clipboard*, other options are *:prim
 
 ### 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:
+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](https://rubyapi.org/o/string#method-i-encode) method:
 
 ```ruby
 Clipboard.paste.encode('UTF-8')
@@ -86,6 +87,14 @@ $ blip FILE_NAME
 
 Without any arguments, it will just paste the contents of the clipboard.
 
-### MIT
+## Further Development
 
-Copyright (c) 2010-2020 Jan Lelis <https://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)
+This is a list of nice-to-have features - feel free to open a PR or let me know if you want to work on one of these:
+
+- Native support for clipboard on X11 or Wayland
+- Support more platforms
+- Support clipboard meta data
+
+## MIT
+
+Copyright (c) 2010-2024 Jan Lelis <https://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

@@ -12,8 +12,9 @@ Gem::Specification.new do |s|
   s.description = "Access to the clipboard on Linux, MacOS, Windows, and Cygwin: Clipboard.copy, Clipboard.paste, Clipboard.clear"
   s.homepage = "https://github.com/janlelis/clipboard"
   s.license  = "MIT"
+  s.metadata = { "rubygems_mfa_required" => "true" }
   s.requirements = [
-    "Linux: You need xclip or xsel. On debian/ubuntu run: sudo apt-get install xsel",
+    "Linux: You need xclip / xsel (X11) or wl-clipboard (Wayland)",
     "Windows: You need the ffi gem",
   ]
   s.files = Dir.glob(%w[{lib,spec}/**/*.rb [A-Z]*.txt [A-Z]*.md]) + %w{clipboard.gemspec}

data/lib/clipboard/linux.rb

@@ -27,7 +27,8 @@ module Clipboard
       }.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 xsel"
+                                           "On debian/ubuntu, you can install it with: sudo apt-get install xsel\n" \
+                                           "If your system is Wayland-based, please install wl-clipboard"
     end
 
     def paste(which = nil)

data/lib/clipboard/linux_wayland.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "utils"
+
+module Clipboard
+  module LinuxWayland
+    extend self
+
+    WRITE_COMMAND = "wl-copy"
+    READ_COMMAND = "wl-paste"
+
+    if !Utils.executable_installed?(WRITE_COMMAND)
+      raise Clipboard::ClipboardLoadError, "clipboard: Could not find required program wl-copy\n" \
+                                           "Please install it or try a different implementation"
+    end
+
+    def paste(might_select_primary_clipboard = nil)
+      if might_select_primary_clipboard == "primary"
+        `#{READ_COMMAND} -p`
+      else
+        `#{READ_COMMAND}`
+      end
+    end
+
+    def copy(data)
+      Utils.popen WRITE_COMMAND, data
+      paste
+    end
+
+    def clear
+      `#{WRITE_COMMAND} -c`
+    end
+  end
+end

data/lib/clipboard/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Clipboard
-  VERSION = "1.3.5"
+  VERSION = "1.4.0"
 end

data/lib/clipboard/windows.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "utils"
+require_relative 'utils'
 
 module Clipboard
   module Windows
@@ -19,14 +19,14 @@ module Clipboard
 
     module User32
       extend FFI::Library
-      ffi_lib "user32"
+      ffi_lib 'user32'
       ffi_convention :stdcall
 
-      attach_function :open,  :OpenClipboard,    [ :long ], :long
-      attach_function :close, :CloseClipboard,   [       ], :long
-      attach_function :empty, :EmptyClipboard,   [       ], :long
-      attach_function :get,   :GetClipboardData, [ :long ], :long
-      attach_function :set,   :SetClipboardData, [ :long, :long ], :long
+      attach_function :open,  :OpenClipboard,    [ :pointer ], :bool
+      attach_function :close, :CloseClipboard,   [       ], :bool
+      attach_function :empty, :EmptyClipboard,   [       ], :bool
+      attach_function :get,   :GetClipboardData, [ :long ], :pointer
+      attach_function :set,   :SetClipboardData, [ :long, :pointer ], :pointer
     end
 
     module Kernel32
@@ -34,53 +34,56 @@ module Clipboard
       ffi_lib 'kernel32'
       ffi_convention :stdcall
 
-      attach_function :lock,   :GlobalLock,   [ :long ], :pointer
-      attach_function :unlock, :GlobalUnlock, [ :long ], :long
-      attach_function :size,   :GlobalSize,   [ :long ], :long
-      attach_function :alloc,  :GlobalAlloc,  [ :long, :long ], :long
+      attach_function :lock,   :GlobalLock,   [ :pointer ], :pointer
+      attach_function :unlock, :GlobalUnlock, [ :pointer ], :bool
+      attach_function :size,   :GlobalSize,   [ :pointer ], :long
+      attach_function :alloc,  :GlobalAlloc,  [ :long, :long ], :pointer
     end
 
     # see http://www.codeproject.com/KB/clipboard/archerclipboard1.aspx
     def paste(_ = nil)
-      data = "".dup
-      if 0 != User32.open( 0 )
-        hclip = User32.get( CF_UNICODETEXT )
-        if hclip && 0 != hclip
-          pointer_to_data = Kernel32.lock( hclip )
-          # Windows Unicode is ended by two null bytes, so get the whole string
-          size = Kernel32.size( hclip )
-          data << pointer_to_data.get_bytes( 0, size - 2 )
-          data.force_encoding("UTF-16LE")
-          Kernel32.unlock( hclip )
-        end
-        User32.close( )
-      end
-      data
+      return String.new unless User32.open(nil)
+
+      hclip = User32.get( CF_UNICODETEXT )
+      return String.new if hclip.null?
+
+      pointer_to_data = Kernel32.lock( hclip )
+      # Windows Unicode is ended by two null bytes, so get the whole string
+      size = Kernel32.size( hclip )
+      data = pointer_to_data.read_string( size - 2 )
+      data.force_encoding(Encoding::UTF_16LE)
+    ensure
+      Kernel32.unlock(hclip) if hclip && !hclip.null?
+      User32.close
     end
 
     def clear
-      if 0 != User32.open( 0 )
-        User32.empty( )
-        User32.close( )
-      end
+      User32.empty if User32.open(nil)
       paste
+    ensure
+      User32.close
     end
 
     def copy(data_to_copy)
-      if 0 != User32.open( 0 )
-        User32.empty( )
-        data = data_to_copy.encode("UTF-16LE") # TODO: catch bad encodings
+      if User32.open(nil)
+        User32.empty
+        data = data_to_copy.encode(Encoding::UTF_16LE) # TODO: catch bad encodings
         data << 0
         handler = Kernel32.alloc( GMEM_MOVEABLE, data.bytesize )
         pointer_to_data = Kernel32.lock( handler )
-        pointer_to_data.put_bytes( 0, data, 0, data.bytesize )
-        Kernel32.unlock( handler )
+        begin
+          pointer_to_data.write_string( data )
+        ensure
+          Kernel32.unlock( handler )
+        end
         User32.set( CF_UNICODETEXT, handler )
-        User32.close( )
+        data.chop
       else # don't touch anything
         Utils.popen "clip", data_to_copy # depends on clip (available by default since Vista)
+        paste
       end
-      paste
+    ensure
+      User32.close
     end
   end
 end

data/lib/clipboard.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require 'rbconfig'
-require File.dirname(__FILE__) + '/clipboard/version'
+
+require_relative 'clipboard/version'
+require_relative 'clipboard/utils'
 
 module Clipboard
   extend self
@@ -10,12 +12,13 @@ module Clipboard
   end
 
   unless defined? Ocra # see gh#9
-    autoload :Linux,   'clipboard/linux'
-    autoload :Mac,     'clipboard/mac'
-    autoload :Java,    'clipboard/java'
-    autoload :Cygwin,  'clipboard/cygwin'
-    autoload :Wsl,     'clipboard/wsl'
-    autoload :Gtk,     'clipboard/gtk'
+    autoload :Linux,          'clipboard/linux'
+    autoload :LinuxWayland,   'clipboard/linux_wayland'
+    autoload :Mac,            'clipboard/mac'
+    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'
@@ -29,20 +32,23 @@ module Clipboard
     when /mswin|mingw/       then :Windows
     when /cygwin/            then :Cygwin
     else
-      raise ClipboardLoadError, "Your OS(#{ RbConfig::CONFIG['host_os'] }) is not supported, using file-based (fake) clipboard"
+      raise ClipboardLoadError, "Your OS(#{ RbConfig::CONFIG['host_os'] }) is not supported"
     end
 
-    # Running additional check to detect if running in Microsoft WSL
+    # Running additional check to detect if running in Microsoft WSL or Wayland
     if os == :Linux
       require "etc"
       if Etc.respond_to?(:uname) && Etc.uname[:release] =~ /Microsoft/ # uname was added in ruby 2.2
         os = :Wsl
+      # Only choose Wayland implementation if wl-copy is found, since xclip / xsel *might* work
+      elsif ENV["XDG_SESSION_TYPE"] == "wayland" && Utils.executable_installed?("wl-copy")
+        os = :LinuxWayland
       end
     end
 
     @implementation = Clipboard.const_get(os)
   rescue ClipboardLoadError => e
-    $stderr.puts e.message if $VERBOSE
+    $stderr.puts "#{e.message}\nUsing file-based (fake) clipboard" unless $VERBOSE == nil
     @implementation = Clipboard::File
   end
 

data/spec/clipboard_file_spec.rb

@@ -2,11 +2,13 @@
 
 require_relative "spec_helper"
 
+require "fileutils"
+
 describe 'Clipboard::File' do
   before :all do
     Clipboard.implementation = Clipboard::File
     cache = Clipboard::File::FILE
-    FileUtils.rm cache if File.exist?(cache)
+    FileUtils.rm_f cache
   end
 
   it "can paste with empty file" do

data/spec/clipboard_spec.rb

@@ -9,31 +9,37 @@ os_to_restore = RbConfig::CONFIG['host_os']
 describe Clipboard do
   before do
     RbConfig::CONFIG['host_os'] = os_to_restore
+    @is_windows = Clipboard.implementation.name == 'Clipboard::Windows'
   end
 
+  let(:expected) { ->(text) { @is_windows ? text.encode(Encoding::UTF_16LE) : text } }
+
   it "has a VERSION" do
     expect( Clipboard::VERSION ).to match /^\d+\.\d+\.\d+$/
   end
 
   it "can copy & paste" do
-    Clipboard.copy("FOO\nBAR")
-    expect( Clipboard.paste ).to eq "FOO\nBAR"
+    text = "FOO\nBAR"
+    Clipboard.copy(text)
+    expect( Clipboard.paste.bytes ).to eq expected.(text).bytes
   end
 
   it "can copy & paste with multibyte char" do
-    Encoding.default_external = "utf-8"
-    Clipboard.copy("日本語")
-    expect( Clipboard.paste ).to eq "日本語"
+    Encoding.default_external = 'utf-8'
+    text = '日本語'
+    Clipboard.copy(text)
+    expect( Clipboard.paste ).to eq expected.(text)
   end
 
   it "returns data on copy" do
-    expect( Clipboard.copy('xxx') ).to eq 'xxx'
+    text = 'xxx'
+    expect( Clipboard.copy(text) ).to eq expected.(text)
   end
 
   it "can clear" do
     Clipboard.copy('xxx')
     Clipboard.clear
-    expect( Clipboard.paste ).to eq ''
+    expect( Clipboard.paste ).to eq expected.('')
   end
 
   describe "when included" do
@@ -43,10 +49,11 @@ describe Clipboard do
 
     it "can copy & paste & clear" do
       a = A.new
-      expect( a.send(:copy, "XXX") ).to eq 'XXX'
-      expect( a.send(:paste) ).to eq "XXX"
+      text = 'XXX'
+      expect( a.send(:copy, text) ).to eq expected.(text)
+      expect( a.send(:paste) ).to eq expected.(text)
       a.send(:clear)
-      expect( a.send(:paste) ).to eq ''
+      expect( a.send(:paste) ).to eq expected.('')
     end
   end
 
@@ -56,23 +63,24 @@ describe Clipboard do
     data1 = Random.new.bytes(2**14).unpack("H*").first
     data2 = Clipboard.copy(data1)
 
-    expect(data2).to eq data1
+    expect(data2).to eq expected.(data1)
 
     # second batch
     data1 = Random.new.bytes(2**14).unpack("H*").first
     data2 = Clipboard.copy(data1)
 
-    expect(data2).to eq data1
+    expect(data2).to eq expected.(data1)
   end
 
   describe :implementation do
     before do
-      $VERBOSE = true
+      $VERBOSE = false
       Clipboard.implementation = nil
     end
 
     it "does not warn on normal detection" do
-      if system('which xclip >/dev/null 2>&1') || system('which xsel >/dev/null 2>&1')
+      if ( ENV["XDG_SESSION_TYPE"] != "wayland" && (system('which xclip >/dev/null 2>&1') || system('which xsel >/dev/null 2>&1') ) ) ||
+         ( ENV["XDG_SESSION_TYPE"] == "wayland" && system('which wl-copy >/dev/null 2>&1') )
         expect( $stderr ).not_to receive(:puts)
       end
       Clipboard.implementation
@@ -84,8 +92,8 @@ describe Clipboard do
       expect( Clipboard.implementation ).to eq Clipboard::File
     end
 
-    it "does not warn when $VERBOSE is false" do
-      $VERBOSE = false
+    it "does not warn when $VERBOSE is nil" do
+      $VERBOSE = nil
       RbConfig::CONFIG['host_os'] = 'Fooo OS'
       expect( $stderr ).not_to receive(:puts)
       Clipboard.implementation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clipboard
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.4.0
 platform: ruby
 authors:
 - Jan Lelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-05 00:00:00.000000000 Z
+date: 2024-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -57,6 +57,7 @@ files:
 - lib/clipboard/gtk.rb
 - lib/clipboard/java.rb
 - lib/clipboard/linux.rb
+- lib/clipboard/linux_wayland.rb
 - lib/clipboard/mac.rb
 - lib/clipboard/utils.rb
 - lib/clipboard/version.rb
@@ -68,7 +69,8 @@ files:
 homepage: https://github.com/janlelis/clipboard
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -84,9 +86,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- 'Linux: You need xclip or xsel. On debian/ubuntu run: sudo apt-get install xsel'
+- 'Linux: You need xclip / xsel (X11) or wl-clipboard (Wayland)'
 - 'Windows: You need the ffi gem'
-rubygems_version: 3.1.2
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Access to the clipboard on Linux, MacOS, Windows, and Cygwin.