clipboard 1.3.5 → 1.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 892729b3fc00a3f989dfa1c3c5e1c05062b94a2f01af23a358d519a09b737f33
-  data.tar.gz: 38f17ac7f06b2ff302b9498c3a3ad81bc2e7c9418f700f485569d8b8f15a18c9
+  metadata.gz: bce074b10a99ccac1cae0b51ab4a896cd366409376f54a93f39d3405fca795a7
+  data.tar.gz: 0676b27cf0ab8ecb7ba8eed63c72e7785c5d1c786546ade903a2e59e093dcf61
 SHA512:
-  metadata.gz: 5920c4e55b0322ac05a0df5c36e7d3c2dca41a31a481aab7ed3df6f838a10c0d4592910617c4e95b5878d5133d1b628b46cecef236118abecab608dc64b31827
-  data.tar.gz: 4ff5e2aba0b87384d16941ed3b85ba61382c7e28bc3a07e922328e3a9faf8a23f0524b797d8a729fd34cbb11720d6271890b6d772597444793dc66dd9443ad27
+  metadata.gz: 8a81a237755008ec1f8ea650b585d0f751e50b5e53e14db7e0490514e5f6894fe04333ebff7f0f4a2106d23c552ac2a84c7696f37bfba6c3e3361aaee89d8391
+  data.tar.gz: 97099eb3b2ac762e79d4aa63da3bc3c6c4c8bcd510f3d846c551bb9ff3312c3e85466bd3edc332cc421be8f9dff319035a59f8ec6195bae91e3780eb36b06200

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG
 
+## 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 +10,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-2021 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,4 +1,4 @@
-# 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:
 
@@ -10,14 +10,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.0**, **2.7**, **2.6**
 
-Unsupported, but might still work: **2.4**, **2.3**, **2.2**, **2.1**, **2.0**
+Unsupported, but might still work: **2.5**, **2.4**, **2.3**, **2.2**, **2.1**, **2.0**
 
 ## 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
@@ -86,6 +86,13 @@ $ 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:
+
+- Wayland support (via FFI?)
+- 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)

data/lib/clipboard/linux.rb

@@ -27,7 +27,7 @@ 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"
     end
 
     def paste(which = nil)

data/lib/clipboard/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Clipboard
-  VERSION = "1.3.5"
+  VERSION = "1.3.6"
 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/spec/clipboard_file_spec.rb

@@ -2,6 +2,8 @@
 
 require_relative "spec_helper"
 
+require "fileutils"
+
 describe 'Clipboard::File' do
   before :all do
     Clipboard.implementation = Clipboard::File

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,13 +63,13 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clipboard
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.3.6
 platform: ruby
 authors:
 - Jan Lelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-05 00:00:00.000000000 Z
+date: 2021-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - 'Linux: You need xclip or xsel. On debian/ubuntu run: sudo apt-get install xsel'
 - 'Windows: You need the ffi gem'
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Access to the clipboard on Linux, MacOS, Windows, and Cygwin.