webloc 0.0.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8ff9f7c12df7756811c14678b08b8ab6e42839dbb687b802ad37addf372f82d
+  data.tar.gz: 71f8eec3e245afe13e755127b519999255547829f3903f7d70b90099434a7493
+SHA512:
+  metadata.gz: 82233db761cc8a120f29e0f98f6a285cf2184f3ec9c865feaef060deb1b6021682a604dc1f352ea9af3b9d81fc2dd7fab04a3d3f18e8b923e0f310eeb3e680ae
+  data.tar.gz: ce6d621dda047bd22bbc68353f031bcc91d579f3a46c0c2e049606bf9f778fbcb9d3a0ee03d87eef5c4ac3699ba351eb2be99d60a06500c9cef3cd95c036f2d7

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in webloc.gemspec
 gemspec

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 OS X.
+*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 both Ruby 1.9.2 and 1.8.7 (though development is focused on 1.9.2).
+It works on Ruby 2.7 and up, including Ruby 3.x, and supports URLs of up to 255 characters in length.
 
 ## Installation
 
@@ -10,18 +10,21 @@ It works on both Ruby 1.9.2 and 1.8.7 (though development is focused on 1.9.2).
     
 ## Usage
 
-It's pretty simple.
-
 Reading a .webloc file:
 
     Webloc.load(ARGV.first).url
 
 Writing to a .webloc file:
 
-    Webloc.new('http://peterc.org/').save('peterc.webloc')
+    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 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.0.1"
+  VERSION = "0.2.0"
 end

data/lib/webloc.rb

@@ -25,14 +25,39 @@ 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 += "\x53URL".bytes        # object 2 is an ASCII string of length 3
+    @data += "\x5f\x10".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!)
+    @data += @url.length.chr.bytes  # and here is that one byte..
+    @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\x00".bytes + (@url.length + 18).chr.bytes
+
+    @data = @data.pack('C*')
   end
   
   def save(filename)
-    File.open(filename, 'w:binary') { |f| f.print data }
+    File.open(filename, 'wb') { |f| f.write data }
   end
 end

data/test/webloc_test.rb

@@ -1,5 +1,6 @@
 require 'test/unit'
 require 'webloc'
+require 'tempfile'
 
 class WeblocTest < Test::Unit::TestCase
   def test_webloc_object_requires_url
@@ -19,8 +20,23 @@ class WeblocTest < Test::Unit::TestCase
   end
   
   def test_webloc_generates_valid_data
-    data = File.read(File.dirname(__FILE__) + '/oldstyle.webloc')
-    data = data.force_encoding('binary') rescue data
+    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-indeed-it-should-easily-go-over-110-characters-for-our-testing-purposes"
+    assert_nothing_raised { Webloc.new(url).data }
+  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).b
+    ensure
+      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,47 +1,39 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: webloc
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Peter Cooper
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-
-date: 2011-01-26 00:00:00 +00:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2024-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: plist
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-description: Webloc reads and writes .webloc files on OS X
-email: 
-- peter@petercooper.co.uk
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Webloc reads and writes .webloc files on macOS
+email:
+- git@peterc.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".gitignore"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - lib/webloc.rb
@@ -50,39 +42,29 @@ files:
 - test/pliststyle.webloc
 - test/webloc_test.rb
 - webloc.gemspec
-has_rdoc: true
-homepage: http://github.com/peterc/webloc
+homepage: https://github.com/peterc/webloc
 licenses: []
-
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: webloc
-rubygems_version: 1.3.7
-signing_key: 
-specification_version: 3
-summary: Reads and writes .webloc files on OS X
-test_files: 
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Reads and writes .webloc files on macOS
+test_files:
 - test/oldstyle.webloc
 - test/pliststyle.webloc
 - test/webloc_test.rb