rodiff 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfe33a330e01762950e63f01ab0aa8483ab977fd2f8bf877569d3316d123a485
-  data.tar.gz: f55f992a4d310079ef48662e18ed3c1263737e5d819f218327428ab285e0e907
+  metadata.gz: 864417eae37667c26264ea7de3365d12511c4069d89e83c859641de7c00c22cc
+  data.tar.gz: 5cc69618a1b4893e10d428a387e85f813b26278496f2601abc5315113726e3a3
 SHA512:
-  metadata.gz: c1fe536f649c2d11ab3a40d9f4dc1eb1697e04c9fa281553e4eb9663f0ab2fef0e575b461a5535c81a639014ad74a2a7727ac54b50d26235b7299f0d78c624ce
-  data.tar.gz: 4fd2a372a6e419ecd9fd660704d210f33bdc6a82c09be655475607086bc9f0f7da828d35839e75862f7aa1eaa062986ea64c2a095d22ca5bd91c5e3406020e8c
+  metadata.gz: f77b00f02f5f934de75c153c82c8000641a8e1f6e8edebab6f56c0f42af3a34179ca3796a49f82506747934d6f1cc1d34fed2e027290febad530ca92e5630321
+  data.tar.gz: 3551ea66e08e3c8f65bd7ed32fc47f5a3b0681ebd08646edc313284dc9260e04c855a7a9c2cb7d3c7fc1e878f56d40c8fe1b95c06a51a9076a52296bec778357

data/README.md

@@ -9,10 +9,9 @@ A ruby image comparison tool powered by [Odiff](https://github.com/dmtrKovalenko
 
 ## 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`.
 
+A strong candidate against the veteran players like [pixelmatch](https://github.com/mapbox/pixelmatch) and [ImageMagick](https://github.com/ImageMagick/ImageMagick)
 
 ## Getting Started
 
@@ -51,6 +50,63 @@ or, for relative paths like `./node_modules/.bin/odiff`:
 ODIFF_INSTALL_DIR=node_modules/.bin
 ```
 
+## Configuration
+
+Rodiff automatically discovers and loads configuration from `.rodiff.yml` files in your project.
+
+### Configuration File Discovery
+
+Rodiff searches for `.rodiff.yml` starting from the current directory and traversing upward to your home directory:
+
+```
+/home/username/projects/myapp/src/tests/.rodiff.yml  ← checks here first
+/home/username/projects/myapp/src/.rodiff.yml
+/home/username/projects/myapp/.rodiff.yml            ← typically found here
+/home/username/projects/.rodiff.yml
+/home/username/.rodiff.yml                            ← stops here (home directory)
+```
+
+### Configuration Options
+
+Create a `.rodiff.yml` file in your project root:
+
+```yaml
+# File patterns for image comparison (supports glob patterns)
+include_pattern: "screenshots/**/*.png"
+exclude_pattern: "screenshots/archived/**"
+
+# Comparison settings
+color_threshold: 0.1          # 0.0 - 1.0 (lower = stricter)
+ignore_antialiasing: false    # Ignore antialiasing differences
+output_diff_mask: false       # Output black/white mask instead of diff image
+
+# Error handling
+fail_if_no_comparison: false  # Exit with error if no images found
+exit_code_error: 1           # Exit code for errors (not image differences)
+```
+
+### Programmatic Configuration
+
+You can also configure Rodiff programmatically:
+
+```ruby
+Rodiff.configure do |config|
+  config.include_pattern = "**/*.png"
+  config.color_threshold = 0.15
+  config.ignore_antialiasing = true
+end
+```
+
+Or override specific values:
+
+```ruby
+config = Rodiff::Configuration.new
+config.overrides(
+  color_threshold: 0.2,
+  output_diff_mask: true
+)
+```
+
 ## 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.

data/lib/rodiff/configuration.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+require "yaml"
 require "rodiff/error"
 require "rodiff/executable"
+require "rodiff/helpers/file_finder"
 
 module Rodiff
   def self.configuration
@@ -15,6 +17,15 @@ module Rodiff
   class Configuration
     class UnknownConfiguration < Rodiff::Error; end
 
+    DOTFILE = ".rodiff.yml"
+    GEM_ROOT = if RUBY_VERSION >= "3.1"
+                 File.dirname(__FILE__, 3).freeze
+               else
+                 File.expand_path(File.join(File.dirname(__FILE__), "..", "..")).freeze
+               end
+    DEFAULT_CONFIG = File.join(GEM_ROOT, "config", "default.yml").freeze
+    SEARCH_ROOT = Dir.home.freeze
+
     ATTRS = Module.new.tap { |mod| include mod }
     READER_ATTRS = {
       default_dir: "/"
@@ -67,6 +78,9 @@ module Rodiff
 
       READER_ATTRS.each { |key, value| instance_variable_set("@#{key}", value) }
       ACCESSOR_ATTRS.each { |key, value| instance_variable_set("@#{key}", value) }
+
+      load_from_file(DEFAULT_CONFIG)
+      load_from_file(config_file_override) if config_file_override
     end
 
     def odiff_exe_path
@@ -84,6 +98,38 @@ module Rodiff
 
     private
 
+    def config_file_override(start_dir: Dir.pwd)
+      @config_file_override ||= begin
+        finder = Helpers::FileFinder.new("/")
+        finder.find_upwards(DOTFILE, start_dir, SEARCH_ROOT)
+      end
+    end
+
+    def load_from_file(path)
+      yml_config = YAML.load_file(path) if File.exist?(path)
+
+      if yml_config.is_a?(Hash)
+        yml_config.each do |key, value|
+          validate_config_key!(key.to_sym)
+          public_send("#{key}=", value) if respond_to?("#{key}=")
+        end
+      elsif empty_yml?(yml_config)
+        warn "Configuration file #{path} is empty"
+      else
+        warn "Configuration file #{path} must contain a Hash, got #{yml_config.class}"
+      end
+    rescue Psych::SyntaxError => e
+      raise Rodiff::Error, "Invalid YAML in #{path}: #{e.message}"
+    end
+
+    def empty_yml?(data)
+      # Ruby 2.7-3.0 with Psych 3.x
+      return data == false if RUBY_VERSION < "3.1"
+
+      # Ruby 3.1+ with Psych 4.x
+      data.nil?
+    end
+
     def validate_config_key!(key)
       return if READER_ATTRS.key?(key) || ACCESSOR_ATTRS.key?(key)
 
@@ -94,5 +140,40 @@ module Rodiff
       validate_config_key!(key)
       @config_overrides.fetch(key, &block)
     end
+
+    def files_from_dir(dir)
+      included_files = files_from_glob(file_glob_pattern(dir, include_pattern))
+      excluded_files = files_from_glob(file_glob_pattern(dir, exclude_pattern))
+      (included_files - excluded_files).uniq
+    end
+
+    def files_from_glob(file_glob)
+      files = Dir.glob(file_glob)
+      files.map { |file| File.expand_path(file) }.sort
+    end
+
+    def file_glob_pattern(path, pattern)
+      trimmed = "{#{pattern.gsub(%r{\s*,\s*}, ",")}}"
+      return trimmed if pattern =~ %r{^(\./)?#{Regexp.escape(path)}} || absolute_pattern?(pattern)
+
+      File.join(path, trimmed)
+    end
+
+    def absolute_pattern?(pattern)
+      return pattern.start_with?(File::Separator) unless windows?
+      return false unless File::ALT_SEPARATOR
+
+      win_absolute_pattern = %r{\A\w+:#{Regexp.escape(File::ALT_SEPARATOR)}}.match?(pattern)
+      win_network_pattern = pattern.start_with?(File::ALT_SEPARATOR * 2)
+      win_absolute_pattern || win_network_pattern
+    end
+
+    def windows?
+      @windows ||= begin
+        require "rbconfig"
+        os = RbConfig::CONFIG["host_os"]
+        os.match?(%r{mingw})
+      end
+    end
   end
 end

data/lib/rodiff/helpers/file_finder.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Rodiff
+  module Helpers
+    class FileFinder
+      attr_reader :root_dir
+
+      def initialize(root)
+        @root_dir = root
+      end
+
+      def find_upwards(filename, start_dir, stop_dir = nil)
+        traverse_upwards(filename, start_dir, stop_dir) { |file| return file if file } # return first result
+      end
+
+      def find_top_most(filename, start_dir, stop_dir = nil)
+        top_most_file = nil
+        traverse_upwards(filename, start_dir, stop_dir) { |file| top_most_file = file }
+        top_most_file
+      end
+
+      private
+
+      def traverse_upwards(filename, start_dir, stop_dir)
+        start = Pathname.new(start_dir).expand_path
+        root = Pathname.new(root_dir).expand_path
+        return unless start.to_s.start_with?(root.to_s)
+
+        stop = Pathname.new(stop_dir).expand_path if stop_dir
+        start.ascend do |dir|
+          file = File.join(dir, filename)
+          yield(file) if File.exist?(file)
+
+          break if dir == stop || dir == root
+        end
+      end
+    end
+  end
+end

data/lib/rodiff/version.rb

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

metadata

@@ -1,30 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: rodiff
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Ryan Chang
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-27 00:00:00.000000000 Z
+date: 1980-01-02 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
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.2
-description: 
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
 email:
 - ryancyq@gmail.com
 executables:
@@ -41,6 +45,7 @@ files:
 - lib/rodiff/configuration.rb
 - lib/rodiff/error.rb
 - lib/rodiff/executable.rb
+- lib/rodiff/helpers/file_finder.rb
 - lib/rodiff/odiff.rb
 - lib/rodiff/version.rb
 homepage: https://github.com/ryancyq/rodiff
@@ -51,7 +56,6 @@ metadata:
   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
@@ -67,8 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 3.2.0
 requirements:
 - odiff, >= 3.0
-rubygems_version: 3.5.16
-signing_key: 
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A ruby image comparison tool powered by ODiff in OCamel
 test_files: []