clipboard 1.3.6 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bce074b10a99ccac1cae0b51ab4a896cd366409376f54a93f39d3405fca795a7
-  data.tar.gz: 0676b27cf0ab8ecb7ba8eed63c72e7785c5d1c786546ade903a2e59e093dcf61
+  metadata.gz: 1176250dac08a0b34135139cae0057d85980a5db1b64f56b5c89fd4745d176e2
+  data.tar.gz: b55213775852ec00ffa7d58a8e97b8e3b31530067e02e6604885873e44a6424e
 SHA512:
-  metadata.gz: 8a81a237755008ec1f8ea650b585d0f751e50b5e53e14db7e0490514e5f6894fe04333ebff7f0f4a2106d23c552ac2a84c7696f37bfba6c3e3361aaee89d8391
-  data.tar.gz: 97099eb3b2ac762e79d4aa63da3bc3c6c4c8bcd510f3d846c551bb9ff3312c3e85466bd3edc332cc421be8f9dff319035a59f8ec6195bae91e3780eb36b06200
+  metadata.gz: 317ce477428ad9390f5ea8dff8afac8fbd23633210bc94de5a4f5db55982681e1a6fa7c4eca2c2204ca4d46238a707ec1a5516076fa456556ad0ec0bd1b7221e
+  data.tar.gz: f7245a4588ba5fecfd2974f970b6849807fe488acc321b54d546c993900c95487b2be5c0bf50230ba617fa3aac15097ffc912050fdbe1cf2983be41321b6b976

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## 1.4.1
+* Always use plaintext mimetype for wl-clipboard
+* Do not include newline when pasting from wl-clipboard
+* Internal: Let ClipboardLoadError inherit from StandardError, not Exception
+
+## 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
 

data/MIT-LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2021 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

@@ -2,7 +2,8 @@
 
 Lets you access the clipboard from everywhere. Currently supported platforms:
 
-- Linux
+- Linux (X11)
+- Linux (Wayland)
 - MacOS
 - Windows
 - Cygwin (POSIX environment for Windows)
@@ -10,9 +11,9 @@ Lets you access the clipboard from everywhere. Currently supported platforms:
 - Gtk+ (Cross Platform Widget Toolkit)
 - Java (on JRuby)
 
-Supported Rubies: **3.0**, **2.7**, **2.6**
+Supported Rubies: **3.3**, **3.2**, **3.1**, **3.0**
 
-Unsupported, but might still work: **2.5**, **2.4**, **2.3**, **2.2**, **2.1**, **2.0**
+Unsupported, but might still work: **2.X**
 
 ## Usage
 
@@ -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')
@@ -90,9 +91,10 @@ Without any arguments, it will just paste the contents of the clipboard.
 
 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:
 
-- Wayland support (via FFI?)
+- Native support for clipboard on X11 or Wayland
+- Support more platforms
 - Support clipboard meta data
 
 ## MIT
 
-Copyright (c) 2010-2021 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)
+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,35 @@
+# frozen_string_literal: true
+
+require_relative "utils"
+
+module Clipboard
+  module LinuxWayland
+    extend self
+
+    TEST_COMMAND  = "wl-copy"
+    WRITE_COMMAND = "wl-copy --type text/plain"
+    READ_COMMAND  = "wl-paste --type text/plain --no-newline"
+
+    if !Utils.executable_installed?(TEST_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} --primary`
+      else
+        `#{READ_COMMAND}`
+      end
+    end
+
+    def copy(data)
+      Utils.popen WRITE_COMMAND, data
+      paste
+    end
+
+    def clear
+      `#{WRITE_COMMAND} --clear`
+    end
+  end
+end

data/lib/clipboard/version.rb

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

data/lib/clipboard.rb

@@ -1,21 +1,24 @@
 # frozen_string_literal: true
 
 require 'rbconfig'
-require File.dirname(__FILE__) + '/clipboard/version'
+
+require_relative 'clipboard/version'
+require_relative 'clipboard/utils'
 
 module Clipboard
   extend self
 
-  class ClipboardLoadError < Exception
+  class ClipboardLoadError < StandardError
   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

@@ -8,7 +8,7 @@ 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

@@ -74,12 +74,13 @@ describe Clipboard do
 
   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
@@ -91,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.6
+  version: 1.4.1
 platform: ruby
 authors:
 - Jan Lelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-25 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.2.3
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Access to the clipboard on Linux, MacOS, Windows, and Cygwin.