tinyimg 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a953ed5351abc1984d8739f8ec3d91a1bed9654a
-  data.tar.gz: c73c4110056238bc19a1c6e7ae6204b4c98a9968
+  metadata.gz: 167b894e73f7dad09bfff8a20d4374d2dcd822f2
+  data.tar.gz: f92b7f089edb704b6d60cc0c3d58420b444b9d10
 SHA512:
-  metadata.gz: 810f4ae575ca67c08c7a1551eb0abf4f16ca6fb12c77d4d9dd9227bd448856644d063424c0d34a6251aa2a52ef0be38ad9180e29f05d3e2a81ccb487d7c260b3
-  data.tar.gz: f7021348faf7e950ed87c51c12383684238bdfef806fb9f11d36bdb0c1e51c600576bb7fe7ac2ef48f31361d6769ffb50b988166ffabbb625cdf6983e7142560
+  metadata.gz: 56d0aa8dd6ca5fab4572ee9bf04416c8d6a90b0a0c5046f23f45fd9d03008aa71acabec8f5c10a5d702e3c0190a42b758e22438189ecb934d5c8d938a1f852f1
+  data.tar.gz: 5533db6f10236e0eff9a4edb42758a354779ccf5339b22184a24c853a02d37f512bd0d03a4af5f0d41ffa095a0e7930c3bc1f89b2b66fa0c5e6b0f0e3804a9c8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    timyimg (0.1.0)
+    tinyimg (0.1.1)
 
 GEM
   remote: http://rubygems.org/
@@ -26,4 +26,7 @@ PLATFORMS
 
 DEPENDENCIES
   rspec (~> 3.0)
-  timyimg!
+  tinyimg!
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -1,6 +1,6 @@
 # Tinyimg
 
-Load a JPEG or PNG, get its dimensions, resize it, and extract it again as either a JPEG or PNG.
+Load a JPEG or PNG, get its dimensions, crop it, resize it, and extract it again as either a JPEG or PNG.
 
 This gem can work from image data stored in memory, as well as from a file or IO stream.
 It's been coded to be as efficient as possible, so doesn't use temporary files.
@@ -28,46 +28,71 @@ Then add tinyimg to your project's Gemfile
 
 Load the image with the method that fits your use case:
 
-    image = Tinyimg.from_string(an_image_that_is_already_loaded)
-    image = Tinyimg.from_file("some_image.png")
-    image = Tinyimg.from_io(params[:uploaded_file])
+```ruby
+image = Tinyimg.from_string(an_image_that_is_already_loaded)
+image = Tinyimg.from_file("some_image.png")
+image = Tinyimg.from_io(params[:uploaded_file])
+```
 
-Manipulate it by using one of the resize commands:
+Resize it by using one of these methods:
 
-    image.resize_to_fit!(100, 100)  # image will be 100x100 maximum
-    image.resize_to_fill!(100, 100) # image will be 100x100 minimum
-    image.resize!(100, 100)         # forces image to be exactly 100x100
+```ruby
+image.resize_exact!(100, 100)   # forces image to be exactly 100x100
+image.resize!(width: 100)       # width = 100 and aspect ratio maintained
+image.resize!(height: 50)       # height = 50 and aspect ratio maintained
+image.resize_to_fit!(100, 100)  # image will be 100x100 maximum
+image.resize_to_fill!(100, 100) # image will be 100x100 minimum
+```
+
+Crop it using this method:
+
+```ruby
+# Crops the image from (20, 20) to (70, 70), resulting in a 50x50 image.
+image.crop!(x: 20, y: 20, width: 50, height: 50)
+
+# By default, x and y arguments are zero, and width and height arguments
+# are the width and height of the original image.
+image.crop!(width: image.height)
+```
 
 Then get an image back:
 
-    image.to_png                 # returns a string
-    image.to_jpeg                # returns a string
-    image.save("some_image.jpg") # file type auto-determined by extension
+```ruby
+image.to_png                 # returns a string
+image.to_jpeg                # returns a string
+image.save("some_image.jpg") # file type auto-determined by extension
+```
 
 You can ask for the image's dimensions:
 
-    image.width       # => 120
-    image.height      # => 80
-    image.dimensions  # => [120, 80]
+```ruby
+image.width       # => 120
+image.height      # => 80
+image.dimensions  # => [120, 80]
+```
 
-You can also use the non-! versions of the resize methods: `resize`, `resize_to_fit` and `resize_to_fill`.
+You can also use the non-! versions of the operation methods: `resize_exact`, `resize`, `resize_to_fit`, `resize_to_fill` and `crop`.
 These create a new image in memory and return it, leaving the old image untouched.  This is useful if you want
 to resize an original image to multiple sizes.  Using these methods will take more memory.
 
 ## Examples
 
-Take an uploaded file, save the original as a JPEG, then resize to create a thumbnail and save that too:
+Take an uploaded file that's a PNG or JPEG, save the original as a JPEG, then resize to create a thumbnail and save that too:
 
-    Tinyimg
-      .from_io(params[:uploaded_file])
-      .save("#{path}/full_size.jpg")
-      .resize_to_fit!(100, 100)
-      .save("#{path}/thumbnail.jpg")
+```ruby
+Tinyimg
+  .from_io(params[:uploaded_file])
+  .save("#{path}/full_size.jpg")
+  .resize_to_fit!(100, 100)
+  .save("#{path}/thumbnail.jpg")
+```
 
 Load a file from disk, make a thumbnail, and return it as a JPEG so we can save it into our database:
 
-    data = Tinyimg.from_file(image_filename).resize_to_fit!(100, 100).to_jpeg
-    user.update!(thumbnail_image: data)
+```ruby
+data = Tinyimg.from_file(image_filename).resize_to_fit!(100, 100).to_jpeg
+user.update!(thumbnail_image: data)
+```
 
 ## Author and licence
 

data/ext/tinyimg/tinyimg.c

@@ -203,7 +203,7 @@ VALUE to_png(int argc, VALUE *argv, VALUE self)
   return output;
 }
 
-VALUE resize_bang(VALUE self, VALUE width_value, VALUE height_value)
+VALUE resize_exact_bang(VALUE self, VALUE width_value, VALUE height_value)
 {
   gdImagePtr image_in, image_out;
   int width, height;
@@ -214,7 +214,7 @@ VALUE resize_bang(VALUE self, VALUE width_value, VALUE height_value)
   width = FIX2INT(width_value);
   height = FIX2INT(height_value);
 
-  if (width < 0 || height < 0) {
+  if (width <= 0 || height <= 0) {
     rb_raise(rb_eArgError, "width and height must both be positive integers");
   }
 
@@ -235,17 +235,63 @@ VALUE resize_bang(VALUE self, VALUE width_value, VALUE height_value)
   return self;
 }
 
+VALUE internal_crop_bang(VALUE self, VALUE x_value, VALUE y_value, VALUE width_value, VALUE height_value)
+{
+  gdImagePtr image_in, image_out;
+  int x, y, width, height;
+
+  Check_Type(x_value, T_FIXNUM);
+  Check_Type(y_value, T_FIXNUM);
+  Check_Type(width_value, T_FIXNUM);
+  Check_Type(height_value, T_FIXNUM);
+
+  x = FIX2INT(x_value);
+  y = FIX2INT(y_value);
+  width = FIX2INT(width_value);
+  height = FIX2INT(height_value);
+
+  if (x < 0 || y < 0) {
+    rb_raise(rb_eArgError, "x, y must both be zero or positive integers");
+  }
+
+  if (width <= 0 || height <= 0) {
+    rb_raise(rb_eArgError, "width and height must both be positive integers");
+  }
+
+  image_in = get_image_data(self);
+
+  if (x + width > gdImageSX(image_in)) {
+    rb_raise(rb_eArgError, "x + width is greater than the original image's width");
+  }
+
+  if (y + height > gdImageSY(image_in)) {
+    rb_raise(rb_eArgError, "y + height is greater than the original image's height");
+  }
+
+  image_out = gdImageCreateTrueColor(width, height);
+  set_alpha(image_out);
+
+  gdImageCopy(image_out, image_in, 0, 0, x, y, width, height);
+
+  set_image_data(self, image_out);
+
+  retrieve_image_dimensions(self);
+
+  return self;
+}
+
 void Init_tinyimg()
 {
   VALUE cTinyimg = rb_define_class("Tinyimg", rb_cObject);
   rb_define_class_under(cTinyimg, "Image", rb_cObject);
 
-  rb_define_method(cTinyimg, "resize!", resize_bang, 2);
+  rb_define_method(cTinyimg, "resize_exact!", resize_exact_bang, 2);
   rb_define_method(cTinyimg, "to_jpeg", to_jpeg, -1);
   rb_define_method(cTinyimg, "to_png", to_png, -1);
   rb_define_private_method(cTinyimg, "initialize_copy", initialize_copy, -1);
   rb_define_private_method(cTinyimg, "load_from_string", load_from_string, 2);
   rb_define_private_method(cTinyimg, "retrieve_image_dimensions", retrieve_image_dimensions, 0);
+  rb_define_private_method(cTinyimg, "internal_crop!", internal_crop_bang, 4);
 #ifdef HAVE_GDIMAGECREATEFROMFILE
   rb_define_private_method(cTinyimg, "load_from_file", load_from_file, 1);
 #endif

data/lib/tinyimg.rb

@@ -21,12 +21,28 @@ class Tinyimg
     [width, height]
   end
 
-  def resize(width, height)
-    dup.resize!(width, height)
+  def resize(*args)
+    dup.resize!(*args)
+  end
+
+  def resize!(*args)
+    case args.map(&:class)
+    when [Fixnum, Fixnum]
+      resize_exact!(*args)
+    when [Hash]
+      width, height = convert_hash_to_exact_dimensions(args.first)
+      resize_exact!(width, height)
+    else
+      raise ArgumentError, "#resize and #resize! accept either (width, height) or a hash with :width and/or :height keys"
+    end
+  end
+
+  def resize_exact(width, height)
+    dup.resize_exact!(width, height)
   end
 
   # Implemented in C
-  # def resize!(width, height)
+  # def resize_exact!(width, height)
   # end
 
   def resize_to_fit(new_width, new_height)
@@ -49,6 +65,17 @@ class Tinyimg
     end
   end
 
+  def crop(**kwargs)
+    dup.crop!(**kwargs)
+  end
+
+  def crop!(x: 0, y: 0, width: nil, height: nil)
+    width ||= self.width
+    height ||= self.height
+
+    internal_crop!(x, y, width, height)
+  end
+
   def save(filename)
     if respond_to?(:save_to_file)
       save_to_file(filename)
@@ -60,6 +87,8 @@ class Tinyimg
 
       File.write(filename, data)
     end
+
+    self
   end
 
   # Implemented in C
@@ -100,7 +129,7 @@ class Tinyimg
       resize_height = new_height
     end
 
-    resize!(resize_width, resize_height)
+    resize_exact!(resize_width, resize_height)
   end
 
   def determine_type(data)
@@ -122,10 +151,34 @@ class Tinyimg
     end
   end
 
+  def convert_hash_to_exact_dimensions(opts)
+    if opts.empty? || !(opts.keys - [:width, :height]).empty?
+      raise ArgumentError, "expected either :width or :height or both keys"
+    end
+
+    if opts.values.any? { |v| !v.is_a?(Fixnum) }
+      raise ArgumentError, ":width and :height values must be integers"
+    end
+
+    new_width, new_height = opts[:width], opts[:height]
+
+    if new_height.nil?
+      new_height = height * new_width / width
+    elsif new_width.nil?
+      new_width = width * new_height / height
+    end
+
+    [new_width, new_height]
+  end
+
   # Implemented in C
   # def load_from_string(data, type)
   # end
 
+  # Implemented in C
+  # def internal_crop!(x, y, width, height)
+  # end
+
   # Implemented in C
   # Only available with libgd 2.1.1+
   # def load_from_file(filename)

data/spec/tinyimg_spec.rb

@@ -33,23 +33,83 @@ RSpec.describe Tinyimg do
     end
   end
 
-  describe "#resize" do
+  describe "#resize_exact" do
     it "resizes the image as requested, creating a new image" do
-      result = sample.resize(100, 100)
+      result = sample.resize_exact(100, 100)
       expect(result).to_not eql sample
       expect(sample.dimensions).to eq [200, 153]
       expect(result.dimensions).to eq [100, 100]
     end
   end
 
-  describe "#resize!" do
+  describe "#resize_exact!" do
     it "resizes the image as requested" do
-      result = sample.resize!(100, 100)
+      result = sample.resize_exact!(100, 100)
       expect(result).to eql sample
       expect(sample.dimensions).to eq [100, 100]
     end
   end
 
+  describe "#resize" do
+    it "takes an exact width and height and resizes" do
+      result = sample.resize(100, 100)
+      expect(result.dimensions).to eq [100, 100]
+    end
+
+    it "takes a width and height as a hash and resizes" do
+      result = sample.resize(width: 100, height: 100)
+      expect(result.dimensions).to eq [100, 100]
+    end
+
+    it "takes just a width and resizes, calculating the height" do
+      result = sample.resize(width: 100)
+      expect(result.dimensions).to eq [100, 76]
+    end
+
+    it "takes just a height and resizes, calculating the width" do
+      result = sample.resize(height: 100)
+      expect(result.dimensions).to eq [130, 100]
+    end
+  end
+
+  describe "#resize!" do
+    it "takes an exact width and height and resizes" do
+      result = sample.resize!(100, 100)
+      expect(sample.dimensions).to eq [100, 100]
+    end
+
+    it "takes a width and height as a hash and resizes" do
+      result = sample.resize!(width: 100, height: 100)
+      expect(sample.dimensions).to eq [100, 100]
+    end
+
+    it "takes just a width and resizes, calculating the height" do
+      result = sample.resize!(width: 100)
+      expect(sample.dimensions).to eq [100, 76]
+    end
+
+    it "takes just a height and resizes, calculating the width" do
+      result = sample.resize!(height: 100)
+      expect(sample.dimensions).to eq [130, 100]
+    end
+
+    it "raises if other keys are provided" do
+      expect { sample.resize!(something: 123) }.to raise_error(ArgumentError)
+    end
+
+    it "raises if non-integer values are provided" do
+      expect { sample.resize!(width: "123") }.to raise_error(ArgumentError)
+    end
+
+    it "raises if no keys are provided" do
+      expect { sample.resize! }.to raise_error(ArgumentError)
+    end
+
+    it "raises if only one argument is provided" do
+      expect { sample.resize!(123) }.to raise_error(ArgumentError)
+    end
+  end
+
   describe "#resize_to_fit!" do
     it "calculates the image dimensions so it fits the width and resizes" do
       sample.resize_to_fit!(100, 100)
@@ -74,6 +134,31 @@ RSpec.describe Tinyimg do
     end
   end
 
+  describe "#crop" do
+    it "crops the image to the specified size and offset" do
+      result = sample.crop(x: 10, y: 20, width: 30, height: 40)
+      expect(result.dimensions).to eq [30, 40]
+    end
+  end
+
+  describe "#crop!" do
+    it "crops the image to the specified size and offset" do
+      sample.crop!(x: 10, y: 20, width: 30, height: 40)
+      expect(sample.dimensions).to eq [30, 40]
+    end
+
+    it "defaults x and y to zero and width and height to the original width and height" do
+      sample.crop!
+      expect(sample.dimensions).to eq [200, 153]
+    end
+
+    it "raises if the requested area is not inside the original image" do
+      expect { sample.crop!(x: 10, y: 20, width: 195, height: 40) }.to raise_error(ArgumentError)
+      expect { sample.crop!(x: 10, y: 20, width: 95, height: 140) }.to raise_error(ArgumentError)
+      expect { sample.crop!(width: 95, height: 160) }.to raise_error(ArgumentError)
+    end
+  end
+
   describe "#save" do
     it "saves a JPEG" do
       begin

data/tinyimg.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |gem|
   gem.name = 'tinyimg'
-  gem.version = '0.1.0'
-  gem.summary = "Tiny and fast JPEG/PNG resizer and converter"
-  gem.description = "Convert between JPEG/PNG and resize images, either all in memory or via disk.  Only required libgd to function."
+  gem.version = '0.1.1'
+  gem.summary = "Tiny and fast JPEG/PNG cropping and resizing"
+  gem.description = "Convert between JPEG/PNG, crop and resize images, either all in memory or via disk.  Only requires libgd to function."
   gem.has_rdoc = false
   gem.author = "Roger Nesbitt"
   gem.email = "roger@seriousorange.com"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tinyimg
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Roger Nesbitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-08 00:00:00.000000000 Z
+date: 2015-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,8 +24,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Convert between JPEG/PNG and resize images, either all in memory or via
-  disk.  Only required libgd to function.
+description: Convert between JPEG/PNG, crop and resize images, either all in memory
+  or via disk.  Only requires libgd to function.
 email: roger@seriousorange.com
 executables: []
 extensions:
@@ -64,10 +64,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Tiny and fast JPEG/PNG resizer and converter
+summary: Tiny and fast JPEG/PNG cropping and resizing
 test_files:
 - spec/samples/duck.png
 - spec/tinyimg_spec.rb