webloc 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9a56c2bca20e777c569936514d7ee8bc96fb683a7a2bd2f22b4cd5b031b6aaf
-  data.tar.gz: 3021c05bc2d572d30e7733ba046564be363631d563be0308aa07ee109ee0eaa7
+  metadata.gz: 498d11e48961e5843a3a25fafb71f4738ebc10733037145ea30a17f176abcaa2
+  data.tar.gz: 78beeadfdafd1a7f414fc6f7b69c6fd24819ed79bb39a9148e72e1bc38089416
 SHA512:
-  metadata.gz: f559ba319ffe258097182613651c7b700d828635ef70dab3bb38f0d0fba29892425e42af10a90bd955d21ca18744e9498dc9146f63bf59d7ef09b233ccc22b29
-  data.tar.gz: 8a5f22e11f55d1f80875bb471a095bbcd8348baeecc0c50ae8f5dad3e115cc04f22270b1055bf247e43698d4fae120001dc3dcb58eb6ae1d359c13d968bdf8b2
+  metadata.gz: 99b273c4af784bdafe2cde8166da2c3672a263d2e412f0f1547e70ef4b8bf8de74185a13b1050e5c16b713e3f7b8c67baabe9f25b1366ee4e86876a95a368740
+  data.tar.gz: fdbd68bb1239b9b35b1eb8c3d3ef8302d69d8a48eca6830bf636eb693f6e8c9a35e19af02148fda21a2d5a2ce3be1e3b7bef8186d7917dd8c40f73a699557e60

data/.gitignore

@@ -1,3 +1,4 @@
 pkg/*
 *.gem
 .bundle
+.DS_Store

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2011-2024 Peter Cooper
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,8 +1,8 @@
 # webloc
 
-*webloc* is a Ruby library that can read from and write to <tt>.webloc</tt> files as used on macOS.
+*webloc* is a Ruby library that can read from and write to <tt>.webloc</tt> files as used on macOS. These are a variant of 'plist' format files, specifically used for storing links to URLs.
 
-It works on Ruby 1.8.7 and up, including Ruby 3.x. It appears to still work on macOS Monterey too, so I have made a quick tidy up and release for 2022!
+It works on Ruby 2.7 and up, including Ruby 3.x, and supports URLs of up to 2048 characters in length (and probably longer, but this is around the de facto limit for URLs in most systems).
 
 ## Installation
 
@@ -18,8 +18,13 @@ Writing to a .webloc file:
 
     Webloc.new('https://rubyweekly.com/').save('rubyweekly.webloc')
 
+## Thanks
+
+Thanks is due to Christos Karaiskos for [this article](https://medium.com/@karaiskc/understanding-apples-binary-property-list-format-281e6da00dbd
+) which helped me understand the plist format a bit more when fixing a bug in 2024.
+
 ## License
 
-Copyright (C) 2011-2022 Peter Cooper
+Copyright (C) 2011-2024 Peter Cooper
 
 webloc is licensed under the terms of the MIT License

data/lib/webloc/version.rb

@@ -1,3 +1,3 @@
 class Webloc
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/webloc.rb

@@ -13,9 +13,16 @@ class Webloc
     
     if data !~ /\<plist/
       offset = (data =~ /SURL_/)
-      length = data[offset + 6]
-      length = length.ord rescue length
-      url = data[offset + 7,length]  
+      length_offset = 7
+      if data[offset + 5] == "\x10"
+        length = data[offset + 6]
+        length = length.unpack('C')[0]  
+      elsif data[offset + 5] == "\x11"
+        length_offset = 8
+        length = data[offset + 6] + data[offset + 7]
+        length = length.unpack('S>')[0]  
+      end
+      url = data[offset + length_offset,length]
     else
       url = Plist::parse_xml(filename)['URL'] rescue nil
     end
@@ -25,11 +32,44 @@ class Webloc
   end
 
   def data
-    @data = "\x62\x70\x6C\x69\x73\x74\x30\x30\xD1\x01\x02\x53\x55\x52\x4C\x5F\x10"
-    @data += @url.length.chr
-    @data += @url
-    @data += "\x08\x0B\x0F\x00\x00\x00\x00\x00\x00\x01\x01\x00\x00\x00\x00\x00\x00\x00\x03\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
-    @data += (@url.length + 18).chr
+    # PLIST HEADER
+    @data = "bplist\x30\x30".bytes
+
+    # PLIST OBJECT TABLE
+    @data += "\xD1\x01\x02".bytes   # object 1 is a dictionary
+    @data += "SURL".bytes           # object 2
+
+    length_suffix = @url.length > 255 ? "\x11" : "\x10"
+    @data += ("\x5f" + length_suffix).bytes       # object 3 is an ASCII string with a variable length length encoding (I know..)
+                              #   .. the '0' in \x10 denotes the length can be encoded within 2**0 bytes (i.e. 1)
+                              #   .. the '1' in \x11 denotes the length can be encoded within 2**1 bytes (i.e. 2)
+    
+    if @url.length > 255
+      @data += [@url.length].pack('S>').bytes
+    else
+      @data += [@url.length].pack('C').bytes
+    end
+    @data += @url.bytes             # and finally the URL itself
+
+    # This is the offset table
+    @data += "\x08\x0B\x0F".bytes   # so objects at 0x08, 0x0b and 0x0f
+
+    # PLIST TRAILER
+    # Bytes 0-4 are unused
+    @data += "\x00\x00\x00\x00\x00".bytes
+    # Byte 5 is the sort version
+    @data += "\x00".bytes
+    # Byte 6 is how many bytes are needed for each offset table offset
+    @data += "\x01".bytes
+    @data += "\x01".bytes
+    # Bytes 8-15 are how many objects are contained in the plist
+    @data += "\x00\x00\x00\x00\x00\x00\x00\x03".bytes
+    # Bytes 16-23 are for an offset from the offset table
+    @data += "\x00\x00\x00\x00\x00\x00\x00\x00".bytes
+    # Bytes 24-31 denote the position of the offset table from the start of the file
+    @data += "\x00\x00\x00\x00\x00\x00".bytes + [@url.length + 18].pack('S>').bytes
+
+    @data = @data.pack('C*')
   end
   
   def save(filename)

data/test/webloc_test.rb

@@ -20,18 +20,31 @@ class WeblocTest < Test::Unit::TestCase
   end
   
   def test_webloc_generates_valid_data
-    data = File.read(File.dirname(__FILE__) + '/oldstyle.webloc')
+    data = File.read(File.dirname(__FILE__) + '/oldstyle.webloc').b
     assert_equal data, Webloc.new('https://github.com/peterc/webloc').data
   end
 
+  def test_webloc_can_handle_long_urls
+    url = "http://example.com/this-is-a-very-long-url-abcde" + ('a' * 2000)
+    assert_nothing_raised { Webloc.new(url).data }
+    file = Tempfile.new('test-long-webloc')
+    begin
+      Webloc.new(url).save(file.path)
+      assert_equal url, Webloc.load(file.path).url
+    ensure
+      file.close
+      file.unlink
+    end
+  end
+
   def test_webloc_can_write_file
     file = Tempfile.new('test-webloc')
     begin
       Webloc.new('https://github.com/peterc/webloc').save(file.path)
-      assert_equal Webloc.new('https://github.com/peterc/webloc').data, File.read(file.path)
+      assert_equal Webloc.new('https://github.com/peterc/webloc').data, File.read(file.path).b
     ensure
-       file.close
-       file.unlink
+      file.close
+      file.unlink
     end    
   end
 end

data/webloc.gemspec

@@ -7,10 +7,10 @@ Gem::Specification.new do |s|
   s.version     = Webloc::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Peter Cooper"]
-  s.email       = ["peter@petercooper.co.uk"]
-  s.homepage    = "http://github.com/peterc/webloc"
-  s.summary     = %q{Reads and writes .webloc files on OS X}
-  s.description = %q{Webloc reads and writes .webloc files on OS X}
+  s.email       = ["git@peterc.org"]
+  s.homepage    = "https://github.com/peterc/webloc"
+  s.summary     = %q{Reads and writes .webloc files on macOS}
+  s.description = %q{Webloc reads and writes .webloc files on macOS}
 
   s.rubyforge_project = "webloc"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webloc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Peter Cooper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-04 00:00:00.000000000 Z
+date: 2024-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
@@ -24,15 +24,16 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Webloc reads and writes .webloc files on OS X
+description: Webloc reads and writes .webloc files on macOS
 email:
-- peter@petercooper.co.uk
+- git@peterc.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - lib/webloc.rb
@@ -41,7 +42,7 @@ files:
 - test/pliststyle.webloc
 - test/webloc_test.rb
 - webloc.gemspec
-homepage: http://github.com/peterc/webloc
+homepage: https://github.com/peterc/webloc
 licenses: []
 metadata: {}
 post_install_message:
@@ -59,10 +60,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
-summary: Reads and writes .webloc files on OS X
+summary: Reads and writes .webloc files on macOS
 test_files:
 - test/oldstyle.webloc
 - test/pliststyle.webloc