rodiff 1.0.0-arm64-darwin

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 147c2ce49eeff57ac22b99f8a9ceb322c7879d3cf75dbc8feff5e3935553f210
+  data.tar.gz: 7a630dadb2a689842e6266097d63e84e1eb548ba934f98ddbebd1b4d503fd398
+SHA512:
+  metadata.gz: ca216e80ea6c74da06b7882633c44d6ba5d24f8e2103689d1aa059fdd944b887d849be43691cbafc048925e25b9bbaea55c482ed61151eff8d17056701e90e63
+  data.tar.gz: e7b360f2b055633661900b2e7fcee7e88c41f6c26c2ef5b68d704bd1af8507f4997656cc021c603b3bc61ecff6af85c85e081b39fe42b70d0c45e8db57377035

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ryan Chang
+
+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/LICENSE-DEPENDENCIES

@@ -0,0 +1,25 @@
+rodiff may redistribute executables from the https://github.com/dmtrKovalenko/odiff project
+
+The license for that software can be found at https://github.com/dmtrKovalenko/odiff/blob/main/LICENSE which is reproduced here for your convenience:
+
+  MIT License
+
+  Copyright (c) 2021 Dmitriy Kovalenko
+
+  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

@@ -0,0 +1,96 @@
+# rodiff
+
+A ruby wrapper for [Odiff](https://github.com/dmtrKovalenko/odiff), an image comparison tool written in OCamel.
+
+
+## Motivation
+
+A strong candidate against the veteran players on the internet like [pixelmatch](https://github.com/mapbox/pixelmatch) and [ImageMagick](https://github.com/ImageMagick/ImageMagick)
+
+Impressive [benchmarks](https://github.com/dmtrKovalenko/odiff#benchmarks) from `Odiff`.
+
+
+## Getting Started
+
+Install the gem and add to the application's Gemfile by executing:
+```sh
+bundle add rodiff
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+```sh
+gem install rodiff
+```
+
+This gem wraps the [standalone executable](https://github.com/dmtrKovalenko/odiff#from-binaries) of the `Odiff`. These executables are platform specific, there are separate gems per platform, but the suitable gem will automatically be selected for your machine.
+
+Supported platforms are:
+- arm64-darwin (macos-arm64)
+- x64-mingw32 (windows-x64)
+- x64-mingw-ucr (windows-x64)
+- x86_64-darwin (macos-x64)
+- x86_64-linux (linux-x64)
+
+### Using a local installation of `Odiff`
+
+If you are not able to use the vendored standalone executables, a local installation of the `Odiff` executable can be configured by setting an environment variable named `ODIFF_INSTALL_DIR` to the directory path containing the executable.
+
+For example, if you've installed `odiff` via npm which could be something like `/path/to/node_modules/bin/odiff`, then you should set your environment variable like so:
+
+``` sh
+ODIFF_INSTALL_DIR=/path/to/node_modules/bin
+```
+
+or, for relative paths like `./node_modules/.bin/odiff`:
+
+``` sh
+ODIFF_INSTALL_DIR=node_modules/.bin
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Troubleshooting
+
+### `ERROR: Cannot find the odiff executable` for supported platform
+
+Some users are reporting this error even when running on one of the supported platforms:
+- arm64-darwin
+- x64-mingw32
+- x64-mingw-ucrt
+- x86_64-darwin
+- x86_64-linux
+
+#### Check Bundler PLATFORMS
+
+A possible cause of this is that Bundler has not been told to include gems for your current platform. Please check your `Gemfile.lock` file to see whether your native platform is included in the `PLATFORMS` section. If necessary, run:
+
+``` sh
+bundle lock --add-platform <platform-name>
+```
+
+and re-bundle.
+
+
+#### Check BUNDLE_FORCE_RUBY_PLATFORM
+
+Another common cause of this is that bundler is configured to always use the "ruby" platform via the
+`BUNDLE_FORCE_RUBY_PLATFORM` config parameter being set to `true`. Please remove this configuration:
+
+``` sh
+bundle config unset force_ruby_platform
+# or
+bundle config set --local force_ruby_platform false
+```
+
+and re-bundle.
+
+See https://bundler.io/man/bundle-config.1.html for more information.
+
+## License
+
+Rodiff is released under the [MIT License](https://opensource.org/licenses/MIT).
+Odiff is released under the [MIT License](https://opensource.org/licenses/MIT).

data/exe/rodiff

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+require "rodiff/cli"
+
+begin
+  verbose = ARGV.delete "--verbose"
+  command = [Rodiff::CLI.executable, *ARGV]
+  puts "rodiff: #{command.inspect}" if verbose
+
+  if Gem.win_platform?
+    # use system rather than exec as exec inexplicably fails to find the executable on Windows
+    # see related https://github.com/rubys/sprockets-esbuild/pull/4
+    system(*command, exception: true)
+  else
+    exec(*command)
+  end
+rescue Rodiff::CLI::CommandError => e
+  warn("ERROR: #{e.message}")
+  exit 1
+end

data/lib/rodiff/cli.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "rodiff/odiff"
+
+module Rodiff
+  class CLI
+    DEFAULT_DIR = File.expand_path(File.join(__dir__, "..", "..", "exe"))
+
+    class CommandError < StandardError; end
+
+    class UnsupportedPlatform < CommandError
+      def initialize(platform)
+        super(
+          <<~MSG
+            odiff does not support the #{platform} platform
+            Please install odiff following instructions at https://github.com/dmtrKovalenko/odiff#installation
+          MSG
+        )
+      end
+    end
+
+    class ExecutableNotFound < CommandError
+      def initialize(platform, exe_path)
+        super(
+          <<~MSG
+            Cannot find the odiff executable for #{platform} in #{exe_path}
+
+            If you're using bundler, please make sure you're on the latest bundler version:
+
+                gem install bundler
+                bundle update --bundler
+
+            Then make sure your lock file includes this platform by running:
+
+                bundle lock --add-platform #{platform}
+                bundle install
+
+            See `bundle lock --help` output for details.
+
+            If you're still seeing this message after taking those steps, try running
+            `bundle config` and ensure `force_ruby_platform` isn't set to `true`. See
+            https://github.com/ryancyq/rodiff#check-bundle_force_ruby_platform
+            for more details.
+          MSG
+          )
+      end
+    end
+
+    class InstallDirectoryNotFound < CommandError
+      def initialize(install_dir)
+        super("ODIFF_INSTALL_DIR is set to #{install_dir}, but that directory does not exist.")
+      end
+    end
+
+    class << self
+      def platform
+        %i[cpu os].map { |m| Gem::Platform.local.public_send(m) }.join("-")
+      end
+
+      def supported_platform?(platform = nil)
+        return Gem::Platform.match_gem?(Gem::Platform.new(platform), "rodiff") unless platform.nil?
+
+        Rodiff::Odiff::PLATFORMS.keys.any? { |p| Gem::Platform.match_gem?(Gem::Platform.new(p), "rodiff") }
+      end
+
+      def executable(exe_path: DEFAULT_DIR)
+        if (odiff_install_dir = ENV.fetch("ODIFF_INSTALL_DIR", nil))
+          raise InstallDirectoryNotFound, odiff_install_dir unless File.directory?(odiff_install_dir)
+
+          warn "NOTE: using ODIFF_INSTALL_DIR to find odiff executable: #{odiff_install_dir}"
+          exe_path = odiff_install_dir
+          exe_file = File.expand_path(File.join(odiff_install_dir, "odiff"))
+        else
+          raise UnsupportedPlatform, platform unless supported_platform?
+
+          exe_files_of_platforms = File.expand_path(File.join(exe_path, "*", "odiff"))
+          exe_file = Dir.glob(exe_files_of_platforms).find do |f|
+            supported_platform?(File.basename(File.dirname(f)))
+          end
+        end
+
+        raise ExecutableNotFound.new(platform, exe_path) if exe_file.nil? || !File.exist?(exe_file)
+
+        exe_file
+      end
+    end
+  end
+end

data/lib/rodiff/odiff.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Rodiff
+  module Odiff
+    VERSION = "v3.1.1"
+
+    # rubygems platform name => upstream release filename
+    PLATFORMS = {
+      "arm64-darwin"   => "odiff-macos-arm64.exe",
+      "x64-mingw32"    => "odiff-windows-x64.exe",
+      "x64-mingw-ucrt" => "odiff-windows-x64.exe",
+      "x86_64-darwin"  => "odiff-macos-x64.exe",
+      "x86_64-linux"   => "odiff-linux-x64.exe"
+    }.freeze
+  end
+end

data/lib/rodiff/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Rodiff
+  VERSION = "1.0.0"
+end

data/lib/rodiff.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Rodiff
+end
+
+require_relative "rodiff/version"
+require_relative "rodiff/odiff"
+require_relative "rodiff/cli"

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: rodiff
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: arm64-darwin
+authors:
+- Ryan Chang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-09-08 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- ryancyq@gmail.com
+executables:
+- rodiff
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- LICENSE-DEPENDENCIES
+- README.md
+- exe/arm64-darwin/odiff
+- exe/rodiff
+- lib/rodiff.rb
+- lib/rodiff/cli.rb
+- lib/rodiff/odiff.rb
+- lib/rodiff/version.rb
+homepage: https://github.com/ryancyq/rodiff
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  allowed_push_host: https://rubygems.org
+  changelog_uri: https://github.com/ryancyq/rodiff/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/ryancyq/rodiff
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+requirements:
+- odiff, v3.1.1
+rubygems_version: 3.5.16
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper for odiff
+test_files: []