morandi.rb in morandi-0.99.03

- old
+ new
@@ -1,20 +1,42 @@
-require "morandi/version"
-require 'gtk2/base'
-require 'cairo'
-require 'gdk_pixbuf2'
-require 'pixbufutils'
-require 'redeye'
+# frozen_string_literal: true
 
+require 'morandi/version'
+require 'morandi_native'
+
+require 'morandi/cairo_ext'
+require 'morandi/pixbuf_ext'
 require 'morandi/image_processor'
-require 'morandi/utils'
-require 'morandi/image-ops'
+require 'morandi/image_operation'
 require 'morandi/redeye'
+require 'morandi/crop_utils'
 
+# Morandi namespace should contain all the functionality of the gem
 module Morandi
   module_function
-  def process(file_in, options, out_file, local_options = {})
+
+  # The main entry point for the libray
+  #
+  # @param in_file [String|GdkPixbuf::Pixbuf] source image
+  # @param settings [Hash]
+  # @param out_file [String] target location for image
+  # @param local_options [Hash]
+  #
+  # Settings Key | Values | Description
+  # -------------|--------|---------------
+  # brighten     | Integer -20..20 | Change image brightness
+  # gamma        | Float  | Gamma correct image
+  # contrast     | Integer -20..20  | Change image contrast
+  # sharpen      | Integer -5..5  | Sharpen / Blur (negative value)
+  # redeye       | Array[[Integer,Integer],...]  | Apply redeye correction at point
+  # angle        | Integer 0,90,180,270  | Rotate image
+  # crop         | Array[Integer,Integer,Integer,Integer] | Crop image
+  # fx           | String greyscale,sepia,bluetone | Apply colour filters
+  # border-style  | String square,retro | Set border style
+  # background-style  | String retro,black,white | Set border colour
+  # quality       | String '1'..'100' | Set JPG compression value, defaults to 97%
+  def process(file_in, options, file_out, local_options = {})
     pro = ImageProcessor.new(file_in, options, local_options)
-    pro.process!
-    pro.write_to_jpeg(out_file)
+    pro.result
+    pro.write_to_jpeg(file_out)
   end
 end