rodiff 1.0.0-x86_64-darwin → 1.1.1-x86_64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 305d33904c7b4428386fd7885c0378e628444f51e3bae8941a484763dde4177d
-  data.tar.gz: 7edf103716bb3d477c1b2f6beacba70f82cd36d98fb6f815a20fc4df36779138
+  metadata.gz: f10e1bf56b1b97b42115582357141cfe4804c60be4addc3412d561dc0bad3861
+  data.tar.gz: c85a43e2faad0ff8008a5e09abf16eca2fe0446f29abfba55f8eb892e4f469ed
 SHA512:
-  metadata.gz: c3caa8ddf02c988d74bb4a132c815634ea8261b8428334affbd26f941d0e0551c93c838efc4e07af0cf1d5ee2a1f0338d41646a1d7e3ccfe64db03c18d257a19
-  data.tar.gz: 906dd773513d4673f24102f8c0118af57374927377eca0dcb7b7fcd5c346beddb373509bd01b316416638eff4af40092c9d731f23d943bb04559ef5a413a9d1c
+  metadata.gz: 12997c9b9ec9600352f609eb74b664a4cc74d4a9f376e84ac1d997d133d224286d85f492f817342bbbde2143cb4e3b361523e7c82d520a1ebeb221618b985dc9
+  data.tar.gz: f3e34a61bd4ad6b793bca3397f7efe2c82299e71debca4c3b3d02d6525f4c7077cb562af0c92e606208e2314f5d7d823df24d5f4bde5f99da19907a9c578ecdc

data/README.md

@@ -1,7 +1,11 @@
 # rodiff
 
-A ruby wrapper for [Odiff](https://github.com/dmtrKovalenko/odiff), an image comparison tool written in OCamel.
+[![Version][rubygems_badge]][rubygems]
+[![CI][ci_badge]][ci_workflows]
+[![Coverage][coverage_badge]][coverage]
+[![Maintainability][maintainability_badge]][maintainability]
 
+A ruby image comparison tool powered by [Odiff](https://github.com/dmtrKovalenko/odiff) in OCamel.
 
 ## Motivation
 
@@ -27,7 +31,7 @@ This gem wraps the [standalone executable](https://github.com/dmtrKovalenko/odif
 Supported platforms are:
 - arm64-darwin (macos-arm64)
 - x64-mingw32 (windows-x64)
-- x64-mingw-ucr (windows-x64)
+- x64-mingw-ucrt (windows-x64)
 - x86_64-darwin (macos-x64)
 - x86_64-linux (linux-x64)
 
@@ -35,7 +39,7 @@ Supported platforms are:
 
 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:
+For example, if you've installed the [`odiff-bin`](https://github.com/dmtrKovalenko/odiff#cross-platform) npm package and had the binaries downloaded at `/path/to/node_modules/bin/odiff`, then you should set your environment variable like so:
 
 ``` sh
 ODIFF_INSTALL_DIR=/path/to/node_modules/bin
@@ -93,4 +97,17 @@ 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).
+Odiff is released under the [MIT License](https://opensource.org/licenses/MIT).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/ryancyq/rodiff](https://github.com/ryancyq/rodiff).
+
+[rubygems_badge]: https://img.shields.io/gem/v/rodiff.svg
+[rubygems]: https://rubygems.org/gems/rodiff
+[ci_badge]: https://github.com/ryancyq/rodiff/actions/workflows/ci.yml/badge.svg
+[ci_workflows]: https://github.com/ryancyq/rodiff/actions/workflows/ci.yml
+[coverage_badge]: https://codecov.io/gh/ryancyq/rodiff/graph/badge.svg?token=SYR7FSDWT5
+[coverage]: https://codecov.io/gh/ryancyq/rodiff
+[maintainability_badge]: https://api.codeclimate.com/v1/badges/d5b1002a1a7162f86a7a/maintainability
+[maintainability]: https://codeclimate.com/github/ryancyq/rodiff/maintainability

data/exe/rodiff

@@ -1,23 +1,8 @@
 #!/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
+# set invoked_via_subcommand to ensure default command is used
+Rodiff::CLI.start(ARGV, invoked_via_subcommand: true)

data/lib/rodiff/cli.rb

@@ -1,87 +1,69 @@
 # frozen_string_literal: true
 
-require "rodiff/odiff"
+require "thor"
+require "open3"
+require "shellwords"
 
-module Rodiff
-  class CLI
-    DEFAULT_DIR = File.expand_path(File.join(__dir__, "..", "..", "exe"))
-
-    class CommandError < StandardError; end
+require "rodiff/configuration"
+require "rodiff/error"
+require "rodiff/version"
 
-    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
-        )
+module Rodiff
+  class CLI < Thor
+    package_name "rodiff"
+
+    default_command :compare
+
+    desc "version", "Print version"
+    map ["-v", "--version"] => :version
+    method_option :odiff, type: :boolean, required: false
+    def version
+      if options.odiff?
+        odiff_exec("--version")
+      else
+        say Rodiff::VERSION
       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
+    desc "compare [BASELINE] [VARIANT] [DIFF]", "Compare VARIANT against BASELINE, output to DIFF"
+    method_option :verbose, type: :boolean, default: false
+    def compare(baseline = nil, variant = nil, diff = nil)
+      all_present, all_absent = args_presence(baseline, variant, diff)
+      raise ArgumentError, "BASELINE, VARIANT, DIFF must be provided" unless all_present ^ all_absent
 
-            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
+      odiff_exec(baseline, variant, diff)
+    rescue Rodiff::Error => e
+      raise Thor::Error, "ERROR: #{e.message}"
     end
 
-    class InstallDirectoryNotFound < CommandError
-      def initialize(install_dir)
-        super("ODIFF_INSTALL_DIR is set to #{install_dir}, but that directory does not exist.")
-      end
+    def self.exit_on_failure?
+      true
     end
 
-    class << self
-      def platform
-        %i[cpu os].map { |m| Gem::Platform.local.public_send(m) }.join("-")
-      end
+    private
 
-      def supported_platform?(platform = nil)
-        return Gem::Platform.match_gem?(Gem::Platform.new(platform), "rodiff") unless platform.nil?
+    def config
+      Rodiff.configuration
+    end
 
-        Rodiff::Odiff::PLATFORMS.keys.any? { |p| Gem::Platform.match_gem?(Gem::Platform.new(p), "rodiff") }
+    def args_presence(*args)
+      args.each_with_object([true, true]) do |e, acc|
+        acc[0] = false if e.nil? || e == ""
+        acc[1] = false unless e.nil? || e == ""
       end
+    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
+    def odiff_exec(*cmd)
+      cmd_parts = []
+      cmd_parts << config.odiff_exe_path
+      cmd_parts.push(*cmd)
+
+      stdout, stderr, status = Open3.capture3(*cmd_parts)
+      if block_given?
+        yield stdout, stderr, status
+      else
+        say_error stderr unless stderr.nil? || stderr == ""
+        say stdout unless stdout.nil? || stdout == ""
       end
     end
   end

data/lib/rodiff/configuration.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "rodiff/error"
+require "rodiff/executable"
+
+module Rodiff
+  def self.configuration
+    @configuration ||= Rodiff::Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  class Configuration
+    class UnknownConfiguration < Rodiff::Error; end
+
+    ATTRS = Module.new.tap { |mod| include mod }
+    READER_ATTRS = {
+      default_dir: "/"
+    }.freeze
+
+    ACCESSOR_ATTRS = {
+      include_pattern:       "{*,**/*}.jpg",
+      exclude_pattern:       "",
+      compare_pattern:       "",
+
+      ignore_antialiasing:   false,
+      color_threshold:       0.1,
+      output_diff_mask:      false,
+
+      exit_code_odiff:       ->(code) { code },
+      exit_code_error:       1,
+      fail_if_no_comparison: false
+    }.freeze
+
+    def self.generate_config(mod, path, line, attrs)
+      mod.module_eval(Array(attrs).join(";").to_s, path, line)
+    end
+
+    def self.config_attribute(name, type:)
+      case type
+      when :reader, :writer, :accessor then "attr_#{type} :#{name}"
+      when :proxy
+        <<-RUBY
+          def #{name}
+            value_for(:#{name}) { super() }
+          end
+        RUBY
+      else
+        raise ArgumentError, "unsupported type #{type.inspect}"
+      end
+    end
+
+    generate_config ATTRS, __FILE__, __LINE__, [
+      *READER_ATTRS.keys.map { |key| config_attribute(key, type: :reader) },
+      *ACCESSOR_ATTRS.keys.map { |key| config_attribute(key, type: :accessor) }
+    ]
+
+    generate_config self, __FILE__, __LINE__, [
+      *READER_ATTRS.keys.map { |key| config_attribute(key, type: :proxy) },
+      *ACCESSOR_ATTRS.keys.map { |key| config_attribute(key, type: :proxy) }
+    ]
+
+    def initialize
+      @config_overrides = {}
+
+      READER_ATTRS.each { |key, value| instance_variable_set("@#{key}", value) }
+      ACCESSOR_ATTRS.each { |key, value| instance_variable_set("@#{key}", value) }
+    end
+
+    def odiff_exe_path
+      @odiff_exe_path ||= Rodiff::Executable.resolve
+    end
+
+    def odiff_exe_path=(path)
+      @odiff_exe_path = Rodiff::Executable.resolve(exe_path: path)
+    end
+
+    def overrides(opts = {})
+      opts.each_key { |key| validate_config_key!(key) }
+      @config_overrides.merge!(opts.transform_keys(&:to_sym))
+    end
+
+    private
+
+    def validate_config_key!(key)
+      return if READER_ATTRS.key?(key) || ACCESSOR_ATTRS.key?(key)
+
+      raise UnknownConfiguration, "unknown config #{key.inspect}"
+    end
+
+    def value_for(key, &block)
+      validate_config_key!(key)
+      @config_overrides.fetch(key, &block)
+    end
+  end
+end

data/lib/rodiff/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Rodiff
+  class Error < StandardError; end
+end

data/lib/rodiff/executable.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "rodiff/odiff"
+require "rodiff/error"
+
+module Rodiff
+  class Executable
+    DEFAULT_DIR = File.expand_path(File.join(__dir__, "..", "..", "exe"))
+    LOCAL_INSTALL_DIR_ENV = "ODIFF_INSTALL_DIR"
+
+    class UnsupportedPlatform < Rodiff::Error
+      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 < Rodiff::Error
+      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 < Rodiff::Error
+      def initialize(install_dir)
+        super("#{LOCAL_INSTALL_DIR_ENV} 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 resolve(exe_path: DEFAULT_DIR)
+        if (odiff_install_dir = ENV.fetch(LOCAL_INSTALL_DIR_ENV, nil))
+          exe_path = odiff_install_dir
+          exe_file = expand_local_install_dir(odiff_install_dir)
+        elsif supported_platform?
+          exe_file = expand_bundled_dir(exe_path)
+        else
+          raise UnsupportedPlatform, platform
+        end
+
+        raise ExecutableNotFound.new(platform, exe_path) if exe_file.nil? || !File.exist?(exe_file)
+
+        exe_file
+      end
+
+      private
+
+      def expand_local_install_dir(local_install_dir)
+        raise InstallDirectoryNotFound, local_install_dir unless File.directory?(local_install_dir)
+
+        warn "NOTE: using #{LOCAL_INSTALL_DIR_ENV} to find odiff executable: #{local_install_dir}"
+        exe_files = File.expand_path(File.join(local_install_dir, "odiff{,.exe}"))
+        Dir.glob(exe_files).first
+      end
+
+      def expand_bundled_dir(bundled_dir)
+        exe_files_of_platforms = File.expand_path(File.join(bundled_dir, "*", "odiff"))
+        Dir.glob(exe_files_of_platforms).find do |f|
+          supported_platform?(File.basename(File.dirname(f)))
+        end
+      end
+    end
+  end
+end

data/lib/rodiff/odiff.rb

@@ -2,7 +2,7 @@
 
 module Rodiff
   module Odiff
-    VERSION = "v3.1.1"
+    VERSION = "3.1.1"
 
     # rubygems platform name => upstream release filename
     PLATFORMS = {

data/lib/rodiff/version.rb

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

data/lib/rodiff.rb

@@ -3,6 +3,6 @@
 module Rodiff
 end
 
-require_relative "rodiff/version"
-require_relative "rodiff/odiff"
-require_relative "rodiff/cli"
+require "rodiff/error"
+require "rodiff/configuration"
+require "rodiff/executable"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rodiff
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: x86_64-darwin
 authors:
 - Ryan Chang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-08 00:00:00.000000000 Z
-dependencies: []
+date: 2024-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
 description: 
 email:
 - ryancyq@gmail.com
@@ -25,6 +39,9 @@ files:
 - exe/x86_64-darwin/odiff
 - lib/rodiff.rb
 - lib/rodiff/cli.rb
+- lib/rodiff/configuration.rb
+- lib/rodiff/error.rb
+- lib/rodiff/executable.rb
 - lib/rodiff/odiff.rb
 - lib/rodiff/version.rb
 homepage: https://github.com/ryancyq/rodiff
@@ -50,9 +67,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 3.2.0
 requirements:
-- odiff, v3.1.1
+- odiff, >= 3.0
 rubygems_version: 3.5.16
 signing_key: 
 specification_version: 4
-summary: A ruby wrapper for odiff
+summary: A ruby image comparison tool powered by ODiff in OCamel
 test_files: []