vips-process 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28664d855e6a202bf807e8d88369d9033c5a2161
-  data.tar.gz: 5d784293a361981a59145d388c46107cac41703d
+  metadata.gz: 8138e1fa1e52d3b4e2b8dcc77678c1b5e98b3d24
+  data.tar.gz: ea0d7a7528ffffd0d2ee2f873c1e95eeac1c89d8
 SHA512:
-  metadata.gz: 9473e1b51f4011cad6387e3c2994c36936ceb6cae84421e76fbea7230863c27c52f90e2b0f6475c6e516bc426c8214ee44e7b09c323d3af6780a499839d5494c
-  data.tar.gz: 60445478ea6e610c7c59b008eacdcda359fdd9b6a34c96889a3891dcc8b2614994387acc3894f1c121d866c10acd83932e1b2ac409400c0cf363ed0c209d0828
+  metadata.gz: 9b1747770629763e8dfefb56b4f8306c1e1913586d83c6a5531f020910583f3e41342d5d1cf10ee60dce9ba894226e71ba417e652702edb5a5b669195e8dd4c6
+  data.tar.gz: 782ad36bcd197d06e71be2c2b4d911db552abef3fc0d54406df762baae44fdf70ab8f3111208848504c0763fb0a14592cf581f2c1f7036107566a72dbf997ed8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vips-process (0.0.1)
+    vips-process (0.1.0)
       ruby-vips (~> 0.3.9)
 
 GEM

data/README.md

@@ -74,6 +74,57 @@ class MyImage < Vips::Process::Base
 end
 ```
 
+### Working with versions
+
+Version dependencies are recursive. I.e., if you have:
+
+```
+class MyImage < Vips::Process::Base
+  # ...
+
+  version(:a) { ... }
+  version(:b, [:a])
+  version(:c, [:b])
+
+  # ...
+end
+```
+Calling `image.c_version` will actually call `image.b_version` which will in turn call
+`image.a_version` and then run version `b`'s code.
+
+
+`MyImage.versions` will return an array with the list of versions your image supports.
+
+
+Calling `image.versions!` will process all versions at once and will return an array with tuples
+like `[version_name, output_path]`. E.g. with the image class above:
+
+```
+image = MyImage.new('/path/to/src.jpg')
+image.versions! #=> [[:a, '/path/to/src-a.jpg'], [:b, '/path/to/src-b.jpg'], [:c, '/path/to/src-c.jpg']]
+```
+
+`versions!` takes one optional argument: the `base` destination. This could be either a directory
+or a filename.
+
+If you use a directory, all new files will be written to that directory
+(which will be created recursively if it doesn't exist) with the version's name followed by the `src`
+file extension. E.g.:
+```
+image = MyImage.new('/path/to/src.jpg')
+image.versions!('/path/to/dir/') #=> [[:a, '/path/to/dir/a.jpg'], [:b, '/path/to/dir/b.jpg'], [:c, '/path/to/dir/c.jpg']]
+```
+
+If you use a filename, all new files will be written next to that file prepending the version's name
+and using its extension. E.g.:
+
+```
+image = MyImage.new('/path/to/src.jpg')
+image.versions!('/path/to/dst.jpeg') #=> [[:a, '/path/to/dst-a.jpeg'], [:b, '/path/to/dest-b.jpeg'], [:c, '/path/to/dest-c.jpg']]
+```
+
+By default we use the `src`'s filename.
+
 ## Supported processes
 
 All examples live in the [/examples](https://github.com/dariocravero/vips-process/tree/master/examples)

data/lib/vips-process.rb

@@ -55,6 +55,22 @@ module Vips
       self
     end
 
+    ##
+    # Process all versions using and output them in a directory
+    #
+    # @param  base  String  the base filename/path where the versions will be saved
+    def versions!(base=@dst)
+      base_dir, base_ext, base_filename = File.file?(base) ?
+        [File.dirname(base), File.extname(base), "#{File.basename(base, File.extname(base))}-"] :
+        [base, File.extname(@src), nil]
+
+      FileUtils.mkdir_p base_dir unless File.directory?(base_dir) && File.exist?(base_dir)
+
+      self.class.versions.map do |name|
+        [name, send("#{name}_version", File.join(base_dir, "#{base_filename}#{name}#{base_ext}"))]
+      end
+    end
+
     private def reset!
       @_on_process  = []
       @_format_opts = nil
@@ -80,6 +96,11 @@ module Vips
       ##
       # Define a version
       #
+      # A version will then take optional arguments: `new_dst` which sets the output for
+      # the version (and reverts back to the previous dt) and `should_process` which tells
+      # whether we should process the version after running its code or not - comes in handy to
+      # stack them up.
+      #
       # @param  name    String  the version's name
       # @param  deps    []      the version's dependencies, it's a list of version names
       # @param  &block  block   if you send a block to it
@@ -89,13 +110,31 @@ module Vips
         @@_versions ||= {}
         @@_versions[name] = {deps: deps, block: block}
 
-        define_method "#{name}_version" do |new_dst=nil|
-          @dst = new_dst if new_dst
-          @@_versions[name][:deps].each { |dep| instance_eval &@@_versions[dep][:block] }
+        define_method "#{name}_version" do |new_dst=nil, should_process=true|
+          # Make sure we have a reference to the old version if it's being changed
+          if new_dst
+            old_dst = @dst
+            @dst = new_dst
+          end
+
+          # Recursively call dependencies but don't process them yet
+          @@_versions[name][:deps].each { |dep| send "#{dep}_version", new_dst, false }
+
+          # Run the version's block
           instance_eval &@@_versions[name][:block]
-          process!
+
+          # Process if we were explicitly told to do so
+          version_dst = process! if should_process
+
+          # Revert to the old destination if we changed it during the version
+          @dst = old_dst if old_dst
+
+          version_dst
         end
       end
+
+      # Get all the version keys
+      def versions; @@_versions.keys; end
     end
   end
 end

data/lib/vips-process/gaussian-blur.rb

@@ -12,7 +12,7 @@ module Vips
       ##
       # Apply gaussian blur to an image.
       #
-      # @param  sigma      Integer  roughly the radius
+      # @param  sigma      Float    roughly the radius
       # @param  min_ampl   Float    minimium amplitude we consider, it sets how far out the mask goes
       def gaussian_blur(sigma, min_ampl=0.2)
         manipulate! do |image|

data/lib/vips-process/resize.rb

@@ -65,6 +65,17 @@ module Vips
         self
       end
 
+      ##
+      # Resize the image to a certain width. It will keep its height in relation.
+      #
+      # @param  width   Integer   the width to scale the image to
+      def resize_to_width(width)
+        manipulate! do |image|
+          resize_image image, width, image.y_size
+        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
@@ -83,7 +94,7 @@ module Vips
         image
       end
 
-      private def get_ratio(image, width,height, min_or_max = :min)
+      private def get_ratio(image, width, height, min_or_max = :min)
         width_ratio = width.to_f / image.x_size
         height_ratio = height.to_f / image.y_size
         [width_ratio, height_ratio].send min_or_max

data/lib/vips-process/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vips-process
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Darío Javier Cravero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-26 00:00:00.000000000 Z
+date: 2014-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-vips