koboldy 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ddb5c7b0e1e855cf5a413bd6dcbe28e9ceb4517
-  data.tar.gz: 7708cec25453bbafc8dcc1f776e9895df5ac45cc
+  metadata.gz: 16bb73985a58efb484265c6e308722b6c514e266
+  data.tar.gz: 5835567a7136f4ce107bbeaa51a3f537ef3f1a61
 SHA512:
-  metadata.gz: 70a7305f92ab33d36138c8bf34ca3159ac5c214d68aea9e660d4e0350190cbc7f2a470447639dae33883d28481558fe7ce613eb3a924df79f3d1dba72a9ef234
-  data.tar.gz: 291046c04e81623ec0ca5ebaaaceab37b8b725ef2e4ac4376b0ebc405de47e3bb4382094026183feb6e7747e955ec69f314fb5e97c32c47339777f97deee7407
+  metadata.gz: 934563242bc1d5bd970cbac371c806f178b18b7111d3932d573da6bb50531ea739ae9babde9c700829fc0ce2f365069815b5eccdd4ff0060e9f979abb5e700f9
+  data.tar.gz: 9f88ef948d9fcb8d1b8af1fce62c944cd0ef3ed6eb5c8c717b43effe2f741336d5da009eca55d245c9137ed3296e7c8739c518ee06d6b9c80c9fe7961b2dab06

data/lib/koboldy/conf.rb

@@ -13,6 +13,53 @@ class Koboldy
       @config = OpenStruct.new
     end
 
+    # @param [String] path Defines the path to the second image that should be compared
+    # @return [OpenStruct]
+    def add_image_a_path(path)
+      @config.imageAPath = path
+      self
+    end
+
+    # @param [String] path Defines the path to the first image that should be compared
+    # @return [OpenStruct]
+    def add_image_b_path(path)
+      @config.imageBPath = path
+      self
+    end
+
+    # @param [String] path imageOutputPath Defines the path to the output-file. If you leaves this one off, then this feature is turned-off.
+    # @return [OpenStruct]
+    def add_image_output_path(path)
+      @config.imageOutputPath = path
+      self
+    end
+
+    # @param [String] difference imageOutputLimit Defines when an image output should be created.
+    #                            This can be for different images("different"),
+    #                            similar or different images("similar"),
+    #                            or all comparisons. (default: all)
+    # @return [OpenStruct]
+    def add_image_output_limit(difference)
+      @config.imageOutputLimit = begin
+        case difference
+        when "different"
+          "BlinkDiff.OUTPUT_DIFFERENT"
+        when "similar"
+          "BlinkDiff.OUTPUT_SIMILAR"
+        else
+          "BlinkDiff.OUTPUT_ALL"
+        end
+      end
+      self
+    end
+
+    # @param [Boolean] boolean Verbose output (default: false)
+    # @return [OpenStruct]
+    def add_verbose(boolean = false)
+      @config.verbose = boolean
+      self
+    end
+
     # @param [Integer] x Base x-coordinate
     # @param [Integer] y Base y-coordinate
     # @param [Integer] width Width of blockOut
@@ -25,11 +72,73 @@ class Koboldy
       param.width = width.to_i
       param.height = height.to_i
 
-      @config.blockOut =  [] if @config.blockOut.nil?
+      @config.blockOut = [] if @config.blockOut.nil?
       @config.blockOut.push param.to_h
       self
     end
 
+    # @param [Integer] value Red intensity for the block-out in the output file (default: 0)
+    #                        This color will only be visible in the result when debug-mode is turned on.
+    # @return [OpenStruct]
+    def add_block_out_red(value)
+      @config.blockOutRed = color_value(value)
+      self
+    end
+
+    # @param [Integer] value Green intensity for the block-out in the output file (default: 0)
+    #                        This color will only be visible in the result when debug-mode is turned on.
+    # @return [OpenStruct]
+    def add_block_out_green(value)
+      @config.blockOutGreen = color_value(value)
+      self
+    end
+
+    # @param [Integer] value Blue intensity for the block-out in the output file (default: 0)
+    #                        This color will only be visible in the result when debug-mode is turned on.
+    # @return [OpenStruct]
+    def add_block_out_blue(value)
+      @config.blockOutBlue = color_value(value)
+      self
+    end
+
+    # @param [Integer] value Alpha intensity for the block-out in the output file (default: 255)
+    # @return [OpenStruct]
+    def add_block_out_alpha(value)
+      @config.blockOutAlpha = value.to_i
+      self
+    end
+
+    # @param [Integer] value Opacity of the pixel for the block-out in the output file (default: 1.0)
+    # @return [OpenStruct]
+    def add_block_out_opacity(value)
+      @config.blockOutOpacity = value.to_f
+      self
+    end
+
+    # @param [Integer] boolean  Copies the first image to the output image before the comparison begins.
+    #                           This will make sure that the output image will highlight the differences on the first image. (default)
+    # @return [OpenStruct]
+    def add_copy_image_a_to_output(boolean = true)
+      @config.copyImageAToOutput = boolean
+      self
+    end
+
+    # @param [Integer] boolean  Copies the second image to the output image before the comparison begins.
+    #                           This will make sure that the output image will highlight the differences on the second image.
+    # @return [OpenStruct]
+    def add_copy_image_b_to_output(boolean = false)
+      @config.copyImageBToOutput = boolean
+      self
+    end
+
+    # @param [String] filter_set  Filters that will be applied before the comparison.
+    #                             Available filters are: blur, grayScale, lightness, luma, luminosity, sepia
+    # @return [OpenStruct]
+    def add_filter(filter_set)
+      @config.filter = filter_set
+      self
+    end
+
     # @param [Boolean] boolean You can set true/false. Only for blockOut config
     # @return [OpenStruct]
     def add_block_out_debug(boolean)
@@ -37,6 +146,41 @@ class Koboldy
       self
     end
 
+    # @param [Boolean] boolean Creates as output a composition of all three images (approved, highlight, and build) (default: true)
+    # @return [OpenStruct]
+    def add_composition(boolean = true)
+      @config.composition = boolean
+      self
+    end
+
+    # @param [Boolean] boolean Creates comparison-composition from left to right, otherwise it lets decide the app on what is best
+    # @return [OpenStruct]
+    def add_compose_left_to_right(boolean = true)
+      @config.composeLeftToRight = boolean
+      self
+    end
+
+    # @param [Boolean] boolean Creates comparison-composition from top to bottom, otherwise it lets decide the app on what is best
+    # @return [OpenStruct]
+    def add_compose_top_to_bottom(boolean = true)
+      @config.composeTopToBottom = boolean
+      self
+    end
+
+    # @param [Integer] value hShift Horizontal shift for possible antialiasing (default: 2) Set to 0 to turn this off.
+    # @return [OpenStruct]
+    def add_h_shift(value = 2)
+      @config.hShift = value.to_i
+      self
+    end
+
+    # @param [Integer] value vShift Vertical shift for possible antialiasing (default: 2) Set to 0 to turn this off.
+    # @return [OpenStruct]
+    def add_v_shift(value = 2)
+      @config.vShift = value.to_i
+      self
+    end
+
     # @param [Boolean] boolean You can set true/false
     # @return [OpenStruct]
     def add_hide_shift(boolean)
@@ -44,31 +188,71 @@ class Koboldy
       self
     end
 
-    # @param [Boolean] boolean You can set true/false
+    # cropImageA Cropping for first image (default: no cropping) - Format: { x:, y:, width:, height: }
+    # @param [Integer] x Base x-coordinate
+    # @param [Integer] y Base y-coordinate
+    # @param [Integer] width Width of blockOut
+    # @param [Integer] height Height of blockOut
     # @return [OpenStruct]
-    def add_compose_left_to_right(boolean)
-      @config.composeLeftToRight = boolean
+    def add_crop_image_a(x, y, width, height)
+      param = OpenStruct.new
+      param.x = x.to_i
+      param.y = y.to_i
+      param.width = width.to_i
+      param.height = height.to_i
+      @config.cropImageA.push param.to_h
       self
     end
 
-    # @param [Integer] value You can set value from 0 to 255
+    # cropImageB Cropping for second image (default: no cropping) - Format: { x:, y:, width:, height: }
+    # @param [Integer] x Base x-coordinate
+    # @param [Integer] y Base y-coordinate
+    # @param [Integer] width Width of blockOut
+    # @param [Integer] height Height of blockOut
     # @return [OpenStruct]
-    def add_block_out_red(value)
-      @config.blockOutRed = color_value(value)
+    def add_crop_image_b(x, y, width, height)
+      param = OpenStruct.new
+      param.x = x.to_i
+      param.y = y.to_i
+      param.width = width.to_i
+      param.height = height.to_i
+      @config.cropImageB.push param.to_h
       self
     end
 
-    # @param [Integer] value You can set value from 0 to 255
+    # @param [Boolean] boolean Turn the perceptual comparison mode on. See below for more information.
     # @return [OpenStruct]
-    def add_block_out_blue(value)
-      @config.blockOutBlue = color_value(value)
+    def add_perceptual(boolean = true)
+      @config.perceptual = boolean
       self
     end
 
-    # @param [Integer] value You can set value from 0 to 255
+    # @param [Float] value gamma Gamma correction for all colors (will be used as base) (default: none)
+    #                      - Any value here will turn the perceptual comparison mode on
     # @return [OpenStruct]
-    def add_block_out_green(value)
-      @config.blockOutGreen = color_value(value)
+    def add_gamma(value)
+      @config.gamma = value.to_f
+      self
+    end
+
+    # @param [Float] value gammaR Gamma correction for red - Any value here will turn the perceptual comparison mode on
+    # @return [OpenStruct]
+    def add_gamma_r(value)
+      @config.gammaR = value.to_f
+      self
+    end
+
+    # @param [Float] value gammaG Gamma correction for green - Any value here will turn the perceptual comparison mode on
+    # @return [OpenStruct]
+    def add_gamma_g(value)
+      @config.gammaG = value.to_f
+      self
+    end
+
+    # @param [Float] value gammaB Gamma correction for blue - Any value here will turn the perceptual comparison mode on
+    # @return [OpenStruct]
+    def add_gamma_b(value)
+      @config.gammaB = value.to_f
       self
     end
 

data/lib/koboldy/version.rb

@@ -1,3 +1,3 @@
 class Koboldy
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: koboldy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-06 00:00:00.000000000 Z
+date: 2015-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit