miso 0.1.0

data/lib/miso/processor.rb

@@ -0,0 +1,61 @@
+module Miso
+  class Processor
+    autoload :CoreImage,   'miso/processor/core_image'
+    autoload :ImageMagick, 'miso/processor/image_magick'
+    
+    class NotImplementedError < StandardError; end
+    
+    class << self
+      # Sets the default processor class.
+      attr_writer :processor_class
+      
+      # Sets the default processor classes list.
+      attr_writer :processor_classes
+      
+      # The default processor class.
+      #
+      # Returns either the assigned processor, or otherwise finds the first
+      # processor, that is available on the machine, from the processor_classes
+      # array.
+      def processor_class
+        @processor_class ||= processor_classes.find { |c| c.available? }
+        raise "None of the Miso::Processor classes is available." unless @processor_class
+        @processor_class
+      end
+      
+      # The list of processor classes.
+      #
+      # When no explicit processor_class is set this list is iterated, from
+      # first to last, and the first available processor on the machine is used.
+      def processor_classes
+        @processor_classes ||= [CoreImage, ImageMagick]
+      end
+      
+      def available?
+        raise NotImplementedError, "The class `#{name}' does not implement ::available?."
+      end
+    end
+    
+    attr_reader :input_file
+    
+    def initialize(input_file)
+      @input_file = input_file
+    end
+    
+    def crop(width, height)
+      raise NotImplementedError, "The class `#{self.class.name}' does not implement #crop."
+    end
+    
+    def fit(width, height)
+      raise NotImplementedError, "The class `#{self.class.name}' does not implement #fit."
+    end
+    
+    def dimensions
+      raise NotImplementedError, "The class `#{self.class.name}' does not implement #dimensions."
+    end
+    
+    def write(output_file)
+      raise NotImplementedError, "The class `#{self.class.name}' does not implement #write."
+    end
+  end
+end

data/lib/miso/processor/core_image.rb

@@ -0,0 +1,27 @@
+module Miso
+  class Processor
+    class CoreImage < Processor
+      def self.available?
+        available = $:.any? { |path| File.exist? File.join(path, 'osx/cocoa.rb') }
+        require 'osx/cocoa'
+        available
+      end
+      
+      def crop(width, height)
+        # ...
+      end
+      
+      def fit(width, height)
+        # ...
+      end
+      
+      def dimensions
+        # ...
+      end
+      
+      def write(output_file)
+        # ...
+      end
+    end
+  end
+end

data/lib/miso/processor/image_magick.rb

@@ -0,0 +1,59 @@
+begin
+  require 'rubygems'
+  gem 'executioner', '>= 0.2'
+rescue LoadError
+end
+require 'executioner'
+require 'fileutils'
+
+module Miso
+  class Processor
+    class ImageMagick < Processor
+      def self.available?
+        `which convert`
+        $?.success
+      end
+      
+      def crop(width, height)
+        dimensions = "#{width}x#{height}"
+        operations << "-resize #{dimensions}^ -gravity center -crop #{dimensions}+0+0!"
+      end
+      
+      def fit(width, height)
+        operations << "-resize #{width}x#{height}"
+      end
+      
+      def dimensions
+        if info = identify(input_file) and match = /\s(\d+)x(\d+)\+/.match(info)
+          match.to_a[1..2].map { |d| d.to_i }
+        end
+      end
+      
+      def write(output_file)
+        options = operations.join(' ')
+        operations.clear
+        convert(input_file, output_file, options)
+      end
+      
+      include Executioner
+      executable :convert
+      executable :identify
+      
+      alias_method :_convert, :convert
+      def convert(source_path, output_path, options)
+        ensure_output_directory(output_path)
+        _convert "'#{source_path}' #{options} '#{output_path}'"
+      end
+      
+      private
+      
+      def operations
+        @operations ||= []
+      end
+      
+      def ensure_output_directory(path)
+        FileUtils.mkdir_p(File.dirname(path))
+      end
+    end
+  end
+end

data/spec/api/factory_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../../start', __FILE__)
+
+describe "A Miso::Factory instance" do
+  before do
+    Miso::Processor.processor_class = Miso::Processor
+    
+    Miso::Processor.any_instance.stubs(:write)
+    
+    @input_file  = '/image.png'
+    @output_file = '/output_image.png'
+    @image       = Miso::Image.new(@input_file)
+    
+    Miso::Image.stubs(:new).with(@input_file, Miso::Processor).returns(@image)
+    Miso::Image.stubs(:new).with(@output_file, Miso::Processor)
+    
+    @factory = Miso::Factory.new
+  end
+  
+  after do
+    Miso::Processor.processor_class = nil
+  end
+  
+  it "should store operations that are to be applied later on" do
+    @factory.crop(123, 456).fit(123, 456)
+    
+    @image.expects(:crop).with(123, 456)
+    @image.expects(:fit).with(123, 456)
+    
+    @factory.apply(@input_file, @output_file)
+  end
+end

data/spec/api/image_spec.rb

@@ -0,0 +1,115 @@
+require File.expand_path('../../start', __FILE__)
+
+describe "Miso::Image, concerning initialization" do
+  class FakeProcessor; end
+  
+  before do
+    Miso::Processor.processor_class = nil
+  end
+  
+  after do
+    Miso::Processor.processor_class = nil
+  end
+  
+  it "should initialize with only a file argument and use the default processor class" do
+    Miso::Processor.processor_class = Miso::Processor::ImageMagick
+    image = Miso::Image.new('/image.png')
+    
+    image.processor.input_file.should == '/image.png'
+    image.processor.class.should == Miso::Processor::ImageMagick
+  end
+  
+  it "should initialize with a file and processor class" do
+    image = Miso::Image.new('/image.png', Miso::Processor::ImageMagick)
+    
+    image.processor.input_file.should == '/image.png'
+    image.processor.class.should == Miso::Processor::ImageMagick
+  end
+end
+
+describe "An instance of Miso::Image, concerning forwarding calls to the processor" do
+  before do
+    Miso::Processor.any_instance.stubs(:fit)
+    Miso::Processor.any_instance.stubs(:crop)
+    
+    @image = Miso::Image.new('/image.png', Miso::Processor)
+  end
+  
+  it "should forward #crop to the processor" do
+    @image.processor.expects(:crop).with(123, 456)
+    @image.crop(123, 456)
+  end
+  
+  it "should return self when calling #crop" do
+    @image.crop(123, 456).should.be @image
+  end
+  
+  it "should forward #fit to the processor" do
+    @image.processor.expects(:fit).with(123, 456)
+    @image.fit(123, 456)
+  end
+  
+  it "should return self instance when calling #fit" do
+    @image.fit(123, 456).should.be @image
+  end
+  
+  it "should forward #dimensions to the processor and return the result" do
+    @image.processor.expects(:dimensions).returns([123, 456])
+    @image.dimensions.should == [123, 456]
+  end
+  
+  it "should forward #write to the processor and forward its output file to the new instance of Miso::Image" do
+    @image.processor.expects(:write).with('/output_image.png')
+    output_image = @image.write('/output_image.png')
+    output_image.processor.input_file.should == '/output_image.png'
+  end
+end
+
+describe "An instance of Miso::Image, concerning combined methods" do
+  before do
+    Miso::Processor.any_instance.stubs(:fit)
+    Miso::Processor.any_instance.stubs(:crop)
+    
+    @image = Miso::Image.new('/image.png', Miso::Processor)
+  end
+  
+  it "should call #fit to scale and preserve aspect ratio, then call #crop" do
+    @image.expects(:fit).with(123, 456).returns(@image)
+    @image.expects(:crop).with(123, 456).returns(@image)
+    
+    @image.crop_fitting(123, 456)
+  end
+  
+  it "should return self when calling #crop_fitting" do
+    @image.crop_fitting(123, 456).should.be @image
+  end
+end
+
+describe "Miso::Image, concerning shortcut class methods" do
+  before do
+    @input_file = fixture_file('120x100.png')
+    @output_file = temp_file('cropped_to_40x30.png')
+    @image = Miso::Image.new(@input_file, Miso::Processor)
+    
+    Miso::Image.stubs(:new).with(@input_file, nil).returns(@image)
+  end
+  
+  it "should crop to specified dimensions" do
+    @image.expects(:crop).with(40, 30).returns(@image)
+    @image.expects(:write).with(@output_file)
+    
+    Miso::Image.crop(@input_file, @output_file, 40, 30)
+  end
+  
+  it "should fit to specified dimensions, conserving the original aspect ratio" do
+    @image.expects(:fit).with(40, 30).returns(@image)
+    @image.expects(:write).with(@output_file)
+    
+    Miso::Image.fit(@input_file, @output_file, 40, 30)
+  end
+  
+  it "should return its dimensions" do
+    @image.expects(:dimensions).returns([120, 100])
+    Miso::Image.dimensions(@input_file).should == [120, 100]
+  end
+end

data/spec/api/processor/image_magick_spec.rb

@@ -0,0 +1,22 @@
+require File.expand_path('../../../start', __FILE__)
+
+describe "An instance of Miso::Processor::ImageMagick" do
+  before do
+    @image_120_x_100 = Miso::Image.new(fixture_file('120x100.png'), Miso::Processor::ImageMagick)
+    @output_file = temp_file('temp.png')
+  end
+  
+  it "should crop to specified dimensions" do
+    @image_120_x_100.crop(40, 30).write(@output_file).dimensions.should == [40, 30]
+    @image_120_x_100.crop(40, 33).write(@output_file).dimensions.should == [40, 33]
+  end
+  
+  it "should fit to specified dimensions, conserving the original aspect ratio" do
+    @image_120_x_100.fit(40, 30).write(@output_file).dimensions.should == [36, 30]
+    @image_120_x_100.fit(40, 34).write(@output_file).dimensions.should == [40, 33]
+  end
+  
+  it "should return its dimensions" do
+    @image_120_x_100.dimensions.should == [120, 100]
+  end
+end

data/spec/api/processor_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path('../../start', __FILE__)
+
+describe "Miso::Processor" do
+  before do
+    Miso::Processor.processor_class = nil
+  end
+  
+  after do
+    Miso::Processor.processor_class = nil
+  end
+  
+  it "should assign the processor class to use" do
+    Miso::Processor.processor_class = Miso::Processor::ImageMagick
+    Miso::Processor.processor_class.should.be Miso::Processor::ImageMagick
+  end
+  
+  it "should find the first available processor class" do
+    Miso::Processor.processor_classes = [
+      stub(:available? => false),
+      stub(:available? => true),
+      stub(:available? => false)
+    ]
+    
+    Miso::Processor.processor_class.should.be Miso::Processor.processor_classes[1]
+  end
+  
+  it "should raise if no available processor class is found" do
+    Miso::Processor.processor_classes = [
+      stub(:available? => false),
+      stub(:available? => false)
+    ]
+    
+    lambda {
+      Miso::Processor.processor_class
+    }.should.raise
+  end
+  
+  it "should initialize with an input file" do
+    Miso::Processor.new('/image.png').input_file.should == '/image.png'
+  end
+end

data/spec/start.rb

@@ -0,0 +1,30 @@
+require 'rubygems' rescue LoadError
+require 'test/spec'
+require 'mocha'
+
+require 'fileutils'
+
+$:.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'miso'
+require 'miso/processor'
+
+class Test::Unit::TestCase
+  TMP_DIR = File.expand_path('../tmp', __FILE__)
+  
+  def setup
+    FileUtils.mkdir_p(TMP_DIR)
+  end
+  
+  def teardown
+    FileUtils.rm_rf(TMP_DIR)
+  end
+  
+  def fixture_file(name)
+    File.expand_path("../fixtures/#{name}", __FILE__)
+  end
+  
+  def temp_file(filename)
+    File.join(TMP_DIR, filename)
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: miso
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Manfred Stienstra
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-20 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Miso is a unified API for simple image operations commonly used on the web.
+email: manfred@fngtps.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- LICENSE
+- README
+- Rakefile
+- TODO
+- VERSION
+- html/classes/Miso.html
+- html/classes/Miso/Factory.html
+- html/classes/Miso/Image.html
+- html/classes/Miso/Processor.html
+- html/classes/Miso/Processor/CoreImage.html
+- html/classes/Miso/Processor/ImageMagick.html
+- html/classes/Miso/Processor/NotImplementedError.html
+- html/created.rid
+- html/files/LICENSE.html
+- html/files/README.html
+- html/files/lib/miso/factory_rb.html
+- html/files/lib/miso/image_rb.html
+- html/files/lib/miso/processor/core_image_rb.html
+- html/files/lib/miso/processor/image_magick_rb.html
+- html/files/lib/miso/processor_rb.html
+- html/files/lib/miso_rb.html
+- html/fr_class_index.html
+- html/fr_file_index.html
+- html/fr_method_index.html
+- html/index.html
+- html/rdoc-style.css
+- lib/miso.rb
+- lib/miso/factory.rb
+- lib/miso/image.rb
+- lib/miso/processor.rb
+- lib/miso/processor/core_image.rb
+- lib/miso/processor/image_magick.rb
+- spec/api/factory_spec.rb
+- spec/api/image_spec.rb
+- spec/api/processor/image_magick_spec.rb
+- spec/api/processor_spec.rb
+- spec/fixtures/120x100.png
+- spec/start.rb
+has_rdoc: true
+homepage: http://github.com/Fingertips/miso
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Miso is a unified API for simple image operations commonly used on the web.
+test_files: 
+- spec/api/factory_spec.rb
+- spec/api/image_spec.rb
+- spec/api/processor/image_magick_spec.rb
+- spec/api/processor_spec.rb
+- spec/start.rb