miso 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009
+  Manfred Stienstra, Fingertips <manfred@fngtps.com>
+  Eloy Duran, Fingertips <eloy@fngtps.com>
+
+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

@@ -0,0 +1,55 @@
+(...) Miso
+
+Miso is a unified API for simple image operations commonly used on the web. It
+provides backends for often used graphic libraries, but it's also pretty easy
+to plug in your own backend.
+
+A unified API is helpful when you run your code on a number of different boxes
+and architectures. For instance, you could develop your web application on your
+Mac with the Core Image backend [1] and deploy to your Linux server with an
+ImageMagick backend. You could even have the API talk to your custom
+distributed image processing backend.
+
+[1] Note how this means you will never have to install ImageMagick again (;
+
+
+: INSTALL
+
+  $ gem install miso --source http://gemcutter.org
+
+
+: EXAMPLES
+
+Miso can be used in three different ways, each useful in different situations.
+
+  1. For the quick crop
+  
+    Miso::Image.crop('input.jpg', 'output.jpg', 120, 100)
+  
+  2. For the elaborate business logic
+  
+    @image = Miso::Image.new('input.jpg')
+    @image.crop(120, 100) if options[:crop]
+    @image.fit(120, 100) if options[:fit]
+    @image.write('output.jpg')
+  
+  3. As an option
+  
+    class Attachment
+      has_variant :avatar,
+        :processor => Miso::Image.factory.crop(120, 100).fit(60, 40)
+    end
+    
+  Which works like this;
+    
+    factory = Miso::Image.factory.crop(123, 456)
+    factory.apply('input.jpg', 'output.jpg')
+
+But wait, there is more! Read the API documentation for more goodies.
+
+
+: SUPPORTED BACKENDS
+
+Currently supported backends are: Core Image and ImageMagick, because those
+are the ones we use. If you want to contribute backends we're happy to
+accept patches!

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake/rdoctask'
+
+desc "Run all specs by default"
+task :default => :spec
+
+namespace :spec do
+  desc "Run all API specs"
+  task :api do
+    Dir[File.dirname(__FILE__) + '/spec/api/**/*_spec.rb'].each do |file|
+      load file
+    end
+  end
+  
+  desc "Run all functional specs"
+  task :functional do
+    Dir[File.dirname(__FILE__) + '/spec/functional/*_spec.rb'].each do |file|
+      load file
+    end
+  end
+end
+
+desc "Run all specs"
+task :spec => [:'spec:api', :'spec:functional'] do
+end
+  
+namespace :docs do
+  Rake::RDocTask.new(:generate) do |rd|
+    rd.main = "README"
+    rd.rdoc_files.include("README", "LICENSE", "lib/**/*.rb")
+    rd.options << "--all" << "--charset" << "utf-8"
+  end
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name     = "miso"
+    s.homepage = "http://github.com/Fingertips/miso"
+    s.email    = ["eloy@fngtps.com", "manfred@fngtps.com"]
+    s.authors  = ["Eloy Duran", "Manfred Stienstra"]
+    s.summary  = s.description = "Miso is a unified API for simple image operations commonly used on the web."
+    s.files    = FileList['**/**'] # tmp until we've patched Jeweler to be able to easily add files to defaults
+  end
+rescue LoadError
+end
+ 
+begin
+  require 'jewelry_portfolio/tasks'
+  JewelryPortfolio::Tasks.new do |p|
+    p.account = 'Fingertips'
+  end
+rescue LoadError
+end

data/TODO

@@ -0,0 +1,2 @@
+- Add Miso::Image#add(image, 10, 10), which adds another image on top of the image. This should be implemented by the processor as well.
+- Add Miso::Image#watermark(image, :southwest, 10, 10), which uses Miso::Image#add to add an image in one of the corners.

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/html/classes/Miso.html

@@ -0,0 +1,133 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: Miso</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">Miso</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/miso/factory_rb.html">
+                lib/miso/factory.rb
+                </a>
+        <br />
+                <a href="../files/lib/miso/image_rb.html">
+                lib/miso/image.rb
+                </a>
+        <br />
+                <a href="../files/lib/miso/processor/core_image_rb.html">
+                lib/miso/processor/core_image.rb
+                </a>
+        <br />
+                <a href="../files/lib/miso/processor/image_magick_rb.html">
+                lib/miso/processor/image_magick.rb
+                </a>
+        <br />
+                <a href="../files/lib/miso/processor_rb.html">
+                lib/miso/processor.rb
+                </a>
+        <br />
+                <a href="../files/lib/miso_rb.html">
+                lib/miso.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Class <a href="Miso/Factory.html" class="link">Miso::Factory</a><br />
+Class <a href="Miso/Image.html" class="link">Miso::Image</a><br />
+Class <a href="Miso/Processor.html" class="link">Miso::Processor</a><br />
+
+    </div>
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/html/classes/Miso/Factory.html

@@ -0,0 +1,278 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Miso::Factory</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Miso::Factory</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/miso/factory_rb.html">
+                lib/miso/factory.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+A <a href="Factory.html">Miso::Image::Factory</a> can be used to define
+multiple operations which are to be applied to an image.
+</p>
+<p>
+A typical use case would be:
+</p>
+<pre>
+  class Member &lt; ActiveRecord::Base
+    has_variant :avatar, :processor =&gt; Miso::Image.factory.crop(123, 456).watermark(WATERMARK, :southwest, 10, 10)
+  end
+</pre>
+<p>
+In this example, the resulting <a href="Factory.html">Miso::Factory</a>
+instance would be used by the attachment library to <a
+href="Factory.html#M000026">apply</a> the operations. Eg:
+</p>
+<pre>
+  module HasVariant
+    def process_variant(name)
+      variant = self.class.variants[name]
+      variant.processor.apply(upload_file, output_file)
+    end
+  end
+</pre>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000026">apply</a>&nbsp;&nbsp;
+      <a href="#M000023">crop</a>&nbsp;&nbsp;
+      <a href="#M000025">crop_fitting</a>&nbsp;&nbsp;
+      <a href="#M000024">fit</a>&nbsp;&nbsp;
+      <a href="#M000022">new</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000022" class="method-detail">
+        <a name="M000022"></a>
+
+        <div class="method-heading">
+          <a href="#M000022" class="method-signature">
+          <span class="method-name">new</span><span class="method-args">(processor_class = Processor.processor_class)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000022-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000022-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/miso/factory.rb, line 27</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">processor_class</span> = <span class="ruby-constant">Processor</span>.<span class="ruby-identifier">processor_class</span>)
+      <span class="ruby-ivar">@processor_class</span> = <span class="ruby-identifier">processor_class</span>
+      <span class="ruby-ivar">@operations</span> = []
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000026" class="method-detail">
+        <a name="M000026"></a>
+
+        <div class="method-heading">
+          <a href="#M000026" class="method-signature">
+          <span class="method-name">apply</span><span class="method-args">(input_file, output_file)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000026-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000026-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/miso/factory.rb, line 47</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">apply</span>(<span class="ruby-identifier">input_file</span>, <span class="ruby-identifier">output_file</span>)
+      <span class="ruby-identifier">image</span> = <span class="ruby-constant">Image</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">input_file</span>, <span class="ruby-ivar">@processor_class</span>)
+      <span class="ruby-ivar">@operations</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">method</span>, <span class="ruby-identifier">args</span><span class="ruby-operator">|</span> <span class="ruby-identifier">image</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">method</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>) }
+      <span class="ruby-identifier">image</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">output_file</span>)
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000023" class="method-detail">
+        <a name="M000023"></a>
+
+        <div class="method-heading">
+          <a href="#M000023" class="method-signature">
+          <span class="method-name">crop</span><span class="method-args">(width, height)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000023-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000023-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/miso/factory.rb, line 32</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">crop</span>(<span class="ruby-identifier">width</span>, <span class="ruby-identifier">height</span>)
+      <span class="ruby-ivar">@operations</span> <span class="ruby-operator">&lt;&lt;</span> [<span class="ruby-identifier">:crop</span>, [<span class="ruby-identifier">width</span>, <span class="ruby-identifier">height</span>]]
+      <span class="ruby-keyword kw">self</span>
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000025" class="method-detail">
+        <a name="M000025"></a>
+
+        <div class="method-heading">
+          <a href="#M000025" class="method-signature">
+          <span class="method-name">crop_fitting</span><span class="method-args">(width, heigth)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000025-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000025-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/miso/factory.rb, line 42</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">crop_fitting</span>(<span class="ruby-identifier">width</span>, <span class="ruby-identifier">heigth</span>)
+      <span class="ruby-ivar">@operations</span> <span class="ruby-operator">&lt;&lt;</span> [<span class="ruby-identifier">:crop_fitting</span>, [<span class="ruby-identifier">width</span>, <span class="ruby-identifier">height</span>]]
+      <span class="ruby-keyword kw">self</span>
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000024" class="method-detail">
+        <a name="M000024"></a>
+
+        <div class="method-heading">
+          <a href="#M000024" class="method-signature">
+          <span class="method-name">fit</span><span class="method-args">(width, height)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000024-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000024-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/miso/factory.rb, line 37</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fit</span>(<span class="ruby-identifier">width</span>, <span class="ruby-identifier">height</span>)
+      <span class="ruby-ivar">@operations</span> <span class="ruby-operator">&lt;&lt;</span> [<span class="ruby-identifier">:fit</span>, [<span class="ruby-identifier">width</span>, <span class="ruby-identifier">height</span>]]
+      <span class="ruby-keyword kw">self</span>
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>