vips-process 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8138e1fa1e52d3b4e2b8dcc77678c1b5e98b3d24
-  data.tar.gz: ea0d7a7528ffffd0d2ee2f873c1e95eeac1c89d8
+  metadata.gz: 8c8e1e34b16c24916ce653fbfe90b964274f682a
+  data.tar.gz: 73aaec174e1753e341b62d09071e1df0fdbacd16
 SHA512:
-  metadata.gz: 9b1747770629763e8dfefb56b4f8306c1e1913586d83c6a5531f020910583f3e41342d5d1cf10ee60dce9ba894226e71ba417e652702edb5a5b669195e8dd4c6
-  data.tar.gz: 782ad36bcd197d06e71be2c2b4d911db552abef3fc0d54406df762baae44fdf70ab8f3111208848504c0763fb0a14592cf581f2c1f7036107566a72dbf997ed8
+  metadata.gz: a3b161ce5417e820d6b41e69174df595119902fea500ccc7c0e18be1c07f058a2583d14b175b209ef406c96c68dca8f298f157227fbeb35239c04eb60ac9de3f
+  data.tar.gz: d4168159430c88bc9a7dab8ad5ff0b5bc17e876900ad5fa5bf11d7c83ddaacfcd27b8f18c203e0cdbe1d9cd313b1e19679b2795d152c5a1ec1075ca0adeb9790

data/README.md

@@ -164,6 +164,78 @@ The first argument is the `format` we'll conver the file to (jpeg or png) and
 the second one is an optional hash of `options` to be passed to the converting function
 (ie, :interlace => true for png).
 
+### Crop
+
+Crop an image in the desired dimentions.
+
+Usage:
+
+Include it in your image class `include Vips::Process::Crop` and
+call it `MyImage.new('/path/to/src.jpg').crop(height: 100, top: 0.5)`.
+
+Because it's arguments can be used in so many different ways I've decided to make them keyword
+arguments with a default that would give you the same image back.
+
+There are four possible arguments in total: `width`, `height`, `left` and `top`.
+
+`width` and `height` do just that: they crop the resulting image in size.
+
+`left` and `top` are slightly different as they operate in two modes: if you use an Integer it's
+the just the offset. However, if a Float between 0 and 1 is passed it's used to position the cropping
+mask accordingly to the `width` and or `height` respectively. This is probable best seen with an
+example:
+
+```
+ Given:
+
+  i=image        cm=crop mask
+ ________        ________
+ |      |        |      |
+ |      |        |      |
+ |      |        --------
+ |      |
+ |      |
+ ________
+
+
+ crop height: cm.height, top: 0.0 will result in:
+
+ ________
+ | final|
+ | img  |
+ --------
+ |      |
+ |  x   |
+ ________
+
+ crop height: cm.height, top: 0.5 will result in:
+
+ ________
+ |  x   |
+ --------
+ | final|
+ | img  |
+ --------
+ |  x   |
+ ________
+
+ crop height: cm.height, top: 1.0 will result in:
+ ________
+ |      |
+ |  x   |
+ --------
+ | final|
+ | img  |
+ ________
+```
+
+It's also very powerful when used together with resize.
+E.g.: say you have an image that is 3000x2000 px.
+`image.resize_to_width(300).crop(height: 150, top: 0.5).process!` will first resize it to
+300x200 px and then it will crop it using a 150 height mask positioned in the middle of the
+resized image. It will give you an image of full width but with height starting at 25px and
+finishing at 175px. Here's a graphical example:
+
 ### Quality
 
 Changes quality of the image (if supported by the file format)

data/lib/vips-process/crop.rb

@@ -0,0 +1,80 @@
+module Vips
+  module Process
+    module Crop
+      ##
+      # Crop an image in the desired dimentions.
+      #
+      # Pretty much all arguments are optional making it very flexible for you to create all
+      # sort of croppings.
+      #
+      # @param  left    Number    if it's a Float between 0 and 1 it will use that to create a band
+      #                           in which it will displace the width of it.
+      #                           if it's an Integer it's the offset from the left.
+      # @param  top     Number    if it's a Float between 0 and 1 it will use that to create a band
+      #                           in which it will displace the height of it.
+      #                           if it's an Integer it's the offset from the top.
+      # @param  width   Integer   the width to crop to
+      # @param  height  Integer   the height to crop to
+      #
+      # It's very powerful when used with resize. E.g.: say you have an image that is 3000x2000 px.
+      # `image.resize_to_width(300).crop(height: 150, top: 0.5).process!` will first resize it to
+      # 300x200 px and then it will crop it using a 150 height mask positioned in the middle of the
+      # resized image. It will give you an image of full width but with height starting at 25px and
+      # finishing at 175px. Here's a graphical example:
+      #
+      # Given:
+      #
+      #  i=image        cm=crop mask
+      # ________        ________
+      # |      |        |      |
+      # |      |        |      |
+      # |      |        --------
+      # |      |
+      # |      |
+      # ________
+      #
+      #
+      # crop height: cm.height, top: 0.0 will result in:
+      #
+      # ________
+      # | final|
+      # | img  |
+      # --------
+      # |      |
+      # |  x   |
+      # ________
+      #
+      # crop height: cm.height, top: 0.5 will result in:
+      #
+      # ________
+      # |  x   |
+      # --------
+      # | final|
+      # | img  |
+      # --------
+      # |  x   |
+      # ________
+      #
+      # crop height: cm.height, top: 1.0 will result in:
+      # ________
+      # |      |
+      # |  x   |
+      # --------
+      # | final|
+      # | img  |
+      # ________
+      #
+      def crop(left: 0, top: 0, width: nil, height: nil)
+        manipulate! do |image|
+          width   ||= image.x_size
+          height  ||= image.y_size
+          top       = top.is_a?(Float)  && top.between?(0,1)  ? (image.y_size - height) * top : top
+          left      = left.is_a?(Float) && left.between?(0,1) ? (image.x_size - width) * left : left
+
+          image.extract_area left, top, width, height
+        end
+        self
+      end
+    end # Crop
+  end # Process
+end # Vips

data/lib/vips-process/quality.rb

@@ -7,7 +7,10 @@ module Vips
       # @param  percent   Integer   quality from 0 to 100
       def quality(percent=75)
         manipulate! do |image|
-          @_format_opts = { quality: percent } if jpeg? || @_format == JPEG
+          if jpeg? || @_format == JPEG
+            @_format_opts ||= {}
+            @_format_opts[:quality]
+          end
           image
         end
         self

data/lib/vips-process/resize.rb

@@ -76,6 +76,18 @@ module Vips
         self
       end
 
+      ##
+      # Resize the image to a certain height. It will keep its width in relation.
+      #
+      # @param  height   Integer   the height to scale the image to
+      def resize_to_height(height)
+        manipulate! do |image|
+          resize_image image, image.x_size, height
+        end
+        self
+      end
+
+
       private def resize_image(image, width, height, min_or_max = :min)
         ratio = get_ratio image, width, height, min_or_max
         return image if ratio == 1

data/lib/vips-process/shrink.rb

@@ -0,0 +1,26 @@
+# module Vips
+#   module Process
+#     module Shrink
+#       def shrink_load()
+#         if jpeg?
+#           image = VIPS::Image.jpeg @src
+
+#           largest_dimension = [image.x_size, image.y_size].max
+
+#           shrink = largest_dimension / size.to_f
+#           @_format_opts[:shrink_factor] = factor
+
+#         end
+#       end
+
+#       def shrink(factor)
+#         manipulate! do |image|
+#           if jpeg? || @_format == JPEG
+#           end
+#           image
+#         end
+#         self
+#       end
+#     end # Shrink
+#   end # Process
+# end # Vips

data/lib/vips-process/version.rb

@@ -1,5 +1,5 @@
 module Vips
   module Process
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/vips-process.rb

@@ -6,26 +6,23 @@ module Vips
     JPEG  = 'jpeg'.freeze
     PNG   = 'png'.freeze
 
+    def sequential(val=true)
+      @_load_opts[:sequential] = val if jpeg? || png?
+      self
+    end
+
     ##
     # Manipulate the image with Vips. Saving of the image is delayed until after
     # all the process blocks have been called. Make sure you always return an
     # VIPS::Image object from the block
     #
     # This method yields VIPS::Image for further manipulation.
-    #
-    # It also raises an Exception if the manipulation failed.
     def manipulate!
+      @_load_opts   ||= {}
       @_on_process  ||= []
-      @_vimage      ||= if jpeg?
-        VIPS::Image.jpeg  @src, sequential: true
-      elsif png?
-        VIPS::Image.png   @src, sequential: true
-      else
-        VIPS::Image.new   @src
-      end
-      @_vimage = yield @_vimage
-    rescue => e
-      raise Exception.new("Failed to manipulate file, maybe it is not a supported image? Original Error: #{e}")
+      @_type        ||= jpeg? ? :jpeg : (png? ? :png : :new)
+      @_vimage      ||= VIPS::Image.send @_type, @src, @_load_opts
+      @_vimage        = yield @_vimage
     end
 
     def process!
@@ -72,8 +69,9 @@ module Vips
     end
 
     private def reset!
+      @_load_opts   = {}
       @_on_process  = []
-      @_format_opts = nil
+      @_format_opts = {}
       @_vimage      = nil
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vips-process
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Darío Javier Cravero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-27 00:00:00.000000000 Z
+date: 2014-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-vips
@@ -96,9 +96,11 @@ files:
 - lib/vips-process/auto-orient.rb
 - lib/vips-process/base.rb
 - lib/vips-process/convert.rb
+- lib/vips-process/crop.rb
 - lib/vips-process/gaussian-blur.rb
 - lib/vips-process/quality.rb
 - lib/vips-process/resize.rb
+- lib/vips-process/shrink.rb
 - lib/vips-process/strip.rb
 - lib/vips-process/version.rb
 - test/helpers.rb