core_image 0.0.2 → 0.0.3

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Spencer Rogers
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+## Core Image Gem ##
+Simple image manipulation using Apple's Core Image technology.
+
+### Installation ###
+`gem install core_image`
+
+### Usage ###
+	require 'core_image'
+	image = CoreImage.new(location) # more on this below
+	image.rotate(90)
+	image.scale_to_size(300)
+	image.save
+	
+### Supports Chaining ###
+	image.rotate(90).scale(0.6).save(new_path)
+
+### Extra Bits ###
+	image.flip_horizontally
+	image.flip_vertically
+	image.save # oh no!
+	image.revert #=> reverts to the original image
+	
+### One More Thing! ###
+	image.tint({:red => 0, :green => 0, :blue => 255, :alpha => 1.0})
+	image.crop(x, y, w, h) # starts from lower left
+	image.color_at(x, y) # => RGB Hash of specified pixel
+	image.overlay(another_image) # follows the same instantiation rules
+
+
+### Instantiating ###
+You can instantiate a new Core Image object with the following:  
+*	A path to a file  
+*	A url to a file  
+*	An Apple image object: NSImage, CIImage, CGImage  
+*	Another Core Image object  
+
+### File Types ###
+Core Image can open and save the following formats: jpeg, png, tiff, gif, pct, and bmp.  It can also open pdfs and save them as one of the previously listed image formats.
+
+### Requirements ###
+Requires Mac OS X to run.
+
+### Tests ###
+Core Image testing is done via the [Riot](http://rubygems.org/gems/riot) gem and can be run by typing `rake` from the root directory of this repository (you must have Riot installed to do so).
+
+### Support ###
+Serveral updates are in the works but feel free to report issues, make comments, voice concerns and I'll get to them when I can! Enjoy!

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+
+desc "Run all our tests"
+task :test do
+ Rake::TestTask.new do |t|
+   t.libs << "test"
+   t.pattern = "test/**/*_test.rb"
+   t.verbose = false
+ end
+end
+
+task :default => :test

data/core_image.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |spec|
+  spec.name         = "core_image"
+  spec.version      = "0.0.3"
+  spec.date         = "2012-01-31"
+  spec.summary      = "Manipulate images via Apple's built-in Core Image technology"
+  spec.description  = "Simple image manipulation using Apple's Core Image technology. Scale, rotate, flip, convert, overlay, and more."
+  spec.author       = "Spencer Rogers"
+  spec.email        = "SpencerRogers@gmail.com"  
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = ['test/core_image_test.rb']
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "rubygems"
+  spec.add_development_dependency "riot"
+  spec.homepage     = "https://github.com/serogers/core_image"
+  spec.requirements << ["Mac OS X"]
+end

data/lib/core_image.rb

@@ -4,6 +4,7 @@
 
 class CoreImage
   require 'osx/cocoa'
+  require 'uri'
   
   attr_accessor :image_path
   attr_accessor :original_image
@@ -24,29 +25,31 @@ class CoreImage
     scale(dimensions[:ratio])
   end
   
-  def rotate(degrees = 0)
+  def rotate(degrees = 90)
     radians = degrees_to_radians(degrees)
     transform = OSX::CGAffineTransformMakeRotation(radians)
     self.ciimage = self.ciimage.imageByApplyingTransform(transform)
     self
   end
   
-  def flip_horizontal
+  def flip_horizontally
     transform = OSX::CGAffineTransformMakeScale(-1.0, 1.0)
     self.ciimage = self.ciimage.imageByApplyingTransform(transform)
     self
   end
   
-  def crop(x, y, w, h)
-    # coordinates start in lower left
+  def flip_vertically
+    flip_horizontally.rotate(180)
+  end
+  
+  def crop(x, y, w, h) # coordinates start in lower left
     self.ciimage = self.ciimage.imageByCroppingToRect(OSX::CGRectMake(x, y, w, h))
     self
   end # crop
   
-  def tint(rgb_string)
-    image_size = size
-    context = create_ci_context(image_size[:width], image_size[:height])
-    colored_image = OSX::CIImage.imageWithColor(OSX::CIColor.colorWithString(rgb_string))
+  def tint(rgb)
+    context = set_context
+    colored_image = OSX::CIImage.imageWithColor(OSX::CIColor.colorWithString(rgb_hash_to_string(rgb)))
     filter = OSX::CIFilter.filterWithName("CIMultiplyCompositing")
     filter.setValue_forKey(colored_image, "inputImage")
     filter.setValue_forKey(self.ciimage, "inputBackgroundImage")
@@ -56,10 +59,9 @@ class CoreImage
     self
   end
   
-  def overlay_image(object)
+  def overlay(object)
     image = open_object(object)
-    image_size = size
-    context = create_ci_context(image_size[:width], image_size[:height])    
+    context = set_context
     filter = OSX::CIFilter.filterWithName("CISourceOverCompositing")
     filter.setValue_forKey(image, "inputImage")
     filter.setValue_forKey(self.ciimage, "inputBackgroundImage")
@@ -69,8 +71,15 @@ class CoreImage
     self
   end
   
-  def color_at(x, y)
-    to_bitmap.colorAtX_y(x, y) # returns NSColor
+  def color_at(x, y) # coordinates start in upper left
+    set_context
+    nscolor = to_bitmap.colorAtX_y(x, y)
+    rgb = {}
+    rgb[:red] = (nscolor.redComponent.to_f * 255.0).to_i
+    rgb[:green] = (nscolor.greenComponent.to_f * 255.0).to_i
+    rgb[:blue] = (nscolor.blueComponent.to_f * 255.0).to_i
+    rgb[:alpha] = nscolor.alphaComponent
+    rgb
   end
   
   def to_bitmap
@@ -81,24 +90,31 @@ class CoreImage
     to_bitmap.CGImage
   end
   
+  def to_nsimage
+    image_size = self.size
+    nsimage_rep = OSX::NSCIImageRep.imageRepWithCIImage(self.ciimage)
+    nsimage = OSX::NSImage.alloc.initWithSize(OSX::NSMakeSize(image_size[:width], image_size[:height]))
+    nsimage.addRepresentation(nsimage_rep)
+    nsimage
+  end
+  
   def size
     width, height = 0, 0
     
     begin # sometimes ciimage.extent throws an error
-      size = self.ciimage.extent.size
-      width = size.width
-      height = size.height
+      image_size = self.ciimage.extent.size
+      width = image_size.width
+      height = image_size.height
     rescue
-      # if image.extent fails, use another method for measuring size (by converting to a cgimage)
       begin
         cgimage = self.to_cgimage
       	width = OSX::CGImageGetWidth(cgimage)
       	height = OSX::CGImageGetHeight(cgimage)
-    	rescue # if the second image size function fails set zero
+    	rescue
     	  width = 0
     	  height = 0
-  	  end # begin/rescue
-  	end # begin/rescue
+  	  end
+  	end
   	
   	{:width => width, :height => height}
   end
@@ -136,18 +152,30 @@ class CoreImage
   def open_object(object)
     case object.class.to_s
     when "String"
-      ciimage = File.extname(object).downcase == ".pdf" ? open_from_pdf_path(object) : open_from_path(object)
+      open_from_location(object)
     when "OSX::CIImage"
-      ciimage = object
+      object
+    when "OSX::CGImage", "OSX::NSObject"
+      OSX::CIImage.imageWithCGImage(object)
+    when "OSX::NSImage"
+      tiff_data = object.TIFFRepresentation
+      OSX::CIImage.imageWithData(tiff_data)
+    when "CoreImage"
+      object.ciimage
     end
   end
   
-  def open_from_path(path_to_image)
-    OSX::CIImage.imageWithContentsOfURL(OSX::NSURL.fileURLWithPath(path_to_image))
-  end # open
+  def open_from_location(string)
+    nsurl = valid_url?(string) ? nsurl_from_url(string) : nsurl_from_path(string)
+    File.extname(string).downcase == ".pdf" ? open_from_pdf(nsurl) : open_from_image_file(nsurl)
+  end
+  
+  def open_from_image_file(nsurl)
+    OSX::CIImage.imageWithContentsOfURL(nsurl)
+  end
   
-  def open_from_pdf_path(pdf_path, scale = 1, dpi = 72.0, preserve_alpha = false)
-    data = OSX::NSData.dataWithContentsOfURL(OSX::NSURL.fileURLWithPath(pdfPath))
+  def open_from_pdf(nsurl, scale = 1, dpi = 72.0, preserve_alpha = false)
+    data = OSX::NSData.dataWithContentsOfURL(nsurl)
     pdf_rep = OSX::NSPDFImageRep.imageRepWithData(data)
     nsimage = OSX::NSImage.alloc.initWithData(data)
     nssize = nsimage.size
@@ -174,7 +202,7 @@ class CoreImage
     cgimage = OSX::CGBitmapContextCreateImage(context.graphicsPort)
     
     # return a ciimage
-    OSX::CIImage.initWithCGImage(cgimage)
+    OSX::CIImage.imageWithCGImage(cgimage)
   end
   
   def degrees_to_radians(degrees)
@@ -198,7 +226,11 @@ class CoreImage
     when ".bmp"
       OSX::NSBMPFileType
     end
-    
+  end
+  
+  def set_context
+    image_size = size
+    create_ci_context(image_size[:width], image_size[:height])
   end
   
   def create_ci_context(width, height)
@@ -206,10 +238,30 @@ class CoreImage
   end
   
   def create_ns_context(width, height)
-    blank_bitmap = OSX::NSBitmapImageRep.alloc.initWithBitmapDataPlanes_pixelsWide_pixelsHigh_bitsPerSample_samplesPerPixel_hasAlpha_isPlanar_colorSpaceName_bytesPerRow_bitsPerPixel(nil, width, height, 8, 4, true, false, OSX::NSDeviceRGBColorSpace, 0, 0)
+    blank_bitmap = OSX::NSBitmapImageRep.alloc.initWithBitmapDataPlanes_pixelsWide_pixelsHigh_bitsPerSample_samplesPerPixel_hasAlpha_isPlanar_colorSpaceName_bytesPerRow_bitsPerPixel(nil, width, height, 8, 4, true, false, OSX::NSCalibratedRGBColorSpace, 0, 0)
     context = OSX::NSGraphicsContext.graphicsContextWithBitmapImageRep(blank_bitmap)
     OSX::NSGraphicsContext.setCurrentContext(context)
     context
-  end # createContext
+  end
   
+  def rgb_hash_to_string(rgb)
+    rgb[:alpha] = 1.0 if rgb[:alpha].nil?
+    "#{rgb[:red].to_f / 255.0} #{rgb[:green].to_f / 255.0} #{rgb[:blue].to_f / 255.0} #{rgb[:alpha].to_f}"
+  end
+  
+  def valid_url?(string)
+    uri = URI.parse(string)
+    %w( http https ).include?(uri.scheme) and uri.path.nil? == false
+  rescue URI::BadURIError
+    false
+  end
+  
+  def nsurl_from_path(path)
+    OSX::NSURL.fileURLWithPath(path)
+  end
+  
+  def nsurl_from_url(url)
+    OSX::NSURL.URLWithString(url)
+  end
+
 end

data/test/core_image_test.rb

@@ -0,0 +1,103 @@
+require 'rubygems'
+require 'riot'
+require './lib/core_image.rb'
+
+context 'Core Image' do  
+  setup {CoreImage.new("./test/images/test.png")}
+  helper(:solid_blue_rgb) { {:red => 0, :green => 0, :blue => 255, :alpha => 1.0} }
+  
+  context 'opens file' do
+    asserts("Opens image file") {topic.ciimage.nil? == false}
+    asserts("Opens pdf file") {CoreImage.new("./test/images/test.pdf").ciimage.nil? == false}
+    asserts("Opens file from the internet") {CoreImage.new("http://dl.dropbox.com/u/1848018/core_image_test.png").ciimage.nil? == false}
+  end
+  
+  context 'opens apple image object' do
+    asserts("Opens ciimage") {CoreImage.new(topic.ciimage).ciimage.class.to_s == "OSX::CIImage"}
+    asserts("Opens cgimage") {CoreImage.new(topic.to_cgimage).ciimage.class.to_s == "OSX::CIImage"}
+    asserts("Opens nsimage") {CoreImage.new(topic.to_nsimage).ciimage.class.to_s == "OSX::CIImage"}
+  end
+  
+  context 'opens image from self' do
+    asserts("Opens from core_image instantiation") {CoreImage.new(topic).ciimage.class.to_s == "OSX::CIImage"}
+  end
+  
+  context '.scale(1.5)' do
+    asserts("Image was scaled up by 150%") {topic.scale(1.5).size == {:width => 75, :height => 75}}
+  end
+  
+  context '.scale(0.6)' do
+    asserts("Image was scaled down by 60%") {topic.scale(0.6).size == {:width => 30, :height => 30}}
+  end
+  
+  context '.scale_to_size(300)' do
+    asserts("Image was scaled to fit within 500px") {topic.scale_to_size(300).size == {:width => 300, :height => 300}}
+  end
+  
+  context '.rotate(90)' do
+    setup {topic.rotate(90).color_at(10, 40)}
+    asserts("Image was rotated by 90 degrees") {topic == solid_blue_rgb}
+  end
+  
+  context '.rotate(-90)' do
+    setup {topic.rotate(-90).color_at(40, 10)}
+    asserts("Image was rotated by -90 degrees") {topic == solid_blue_rgb}
+  end
+  
+  context '.flip_horizontally' do
+    setup {topic.flip_horizontally.color_at(40, 10)}
+    asserts("Image was flipped on its x-axis") {topic == solid_blue_rgb}
+  end
+  
+  context '.flip_vertically' do
+    setup {topic.flip_vertically.color_at(10, 40)}
+    asserts("Image was flipped on its y-axis") {topic == solid_blue_rgb}
+  end
+  
+  context '.crop' do
+    setup {topic.crop(0, 0, 25, 25)}
+    asserts("Image was cropped to a 25 pixel box starting in lower left") {topic.size == {:width => 25, :height => 25} and topic.color_at(10, 2) == {:red => 0, :green => 128, :blue => 0, :alpha => 1.0}}
+  end
+  
+  context '.tint' do
+    setup {topic.tint(solid_blue_rgb)}
+    asserts("Image was tinted a dark blue") {topic.color_at(40, 10) == solid_blue_rgb}
+  end
+  
+  context '.overlay' do
+    setup {topic.overlay(CoreImage.new("./test/images/overlay.png")).color_at(40, 10) == solid_blue_rgb}
+  end
+  
+  context '.color_at' do
+    setup {topic.color_at(10, 10)} # select pixel from blue area
+    asserts("Blue equals R:0, G:0, B:255, A:1.0") {topic == solid_blue_rgb}
+  end
+  
+  context '.to_bitmap' do
+    setup {topic.to_bitmap}
+    asserts("Is a bitmap") {topic.class.to_s == "OSX::NSBitmapImageRep"}
+  end
+  
+  context '.to_cgimage' do
+    setup {topic.to_cgimage}
+    asserts("Is a cgimage") {topic.class.to_s == "OSX::NSObject"}
+  end
+  
+  context '.to_nsimage' do
+    setup {topic.to_nsimage}
+    asserts("Is a nsimage") {topic.class.to_s == "OSX::NSImage"}
+  end
+  
+  context '.size' do
+    asserts("Size equals 50x50") {topic.size == {:width => 50, :height => 50}}
+  end
+  
+  context '.size_to_fit_maximum(350)' do
+    asserts("Returns 350x350 ratio of 7.0") {topic.size_to_fit_maximum(350) == {:height=>350, :width=>350, :ratio=>7.0}}
+  end
+  
+  context '.revert' do
+    asserts("Image reverts to original") {topic.ciimage = topic.flip_horizontally.revert.ciimage}
+  end
+  
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: core_image
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Spencer Rogers
@@ -15,10 +15,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-24 00:00:00 -08:00
+date: 2012-01-31 00:00:00 -08:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubygems
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: riot
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
 description: Simple image manipulation using Apple's Core Image technology. Scale, rotate, flip, convert, overlay, and more.
 email: SpencerRogers@gmail.com
 executables: []
@@ -28,9 +55,18 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- core_image.gemspec
 - lib/core_image.rb
+- test/core_image_test.rb
+- test/images/overlay.png
+- test/images/test.pdf
+- test/images/test.png
 has_rdoc: true
-homepage: https://github.com/serogers
+homepage: https://github.com/serogers/core_image
 licenses: []
 
 post_install_message: 
@@ -62,6 +98,6 @@ rubyforge_project:
 rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
-summary: Manipulate images via Apple's Core Image technology
-test_files: []
-
+summary: Manipulate images via Apple's built-in Core Image technology
+test_files: 
+- test/core_image_test.rb