callisto 0.9

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*#
+.#*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in callisto.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Daniel Mircea
+
+MIT License
+
+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,29 @@
+# Callisto
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'callisto'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install callisto
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end

data/callisto.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/callisto/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Daniel Mircea"]
+  gem.email         = ["daniel@thegeek.ro"]
+  gem.description   = "Image thumbnails on the fly"
+  gem.summary       = "Callisto"
+  gem.homepage      = "https://github.com/viseztrance/callisto"
+
+  gem.add_development_dependency "minitest"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "callisto"
+  gem.require_paths = ["lib"]
+  gem.version       = Callisto::VERSION
+end

data/lib/callisto.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH << File.dirname(__FILE__)
+
+require "callisto/version"
+require "callisto/configuration"
+require "callisto/shell"
+require "callisto/pool"
+require "callisto/thumbnail"
+
+module Callisto
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+end

data/lib/callisto/configuration.rb

@@ -0,0 +1,44 @@
+module Callisto
+
+  class Configuration
+
+    module Defaults
+
+      POOL = {
+        :identifier  => proc { |task| task.command },
+        :callback    => proc { |task| task.run },
+        :max_workers => 4
+      }
+
+    end
+
+    attr_accessor :thumbnail_defaults
+
+    def initialize
+      self.thumbnail_defaults = {}
+      load_defaults
+    end
+
+    def load_defaults
+      Pool.settings = Defaults::POOL
+    end
+
+    def max_workers=(val)
+      Pool.settings.max_workers = val
+    end
+
+    def method_missing(method, *args, &block)
+      if /^thumbnail_(?<name>[a-z\_]+)(?<setter>=)?/ =~ method
+        if setter
+          self.thumbnail_defaults[name] = args.first
+        else
+          thumbnail_defaults[name]
+        end
+      else
+        super
+      end
+    end
+
+  end
+
+end

data/lib/callisto/pool.rb

@@ -0,0 +1,65 @@
+require "singleton"
+require "ostruct"
+
+module Callisto
+
+  class Pool
+
+    include Singleton
+
+    attr_accessor :queue, :running, :pending, :workers
+
+    class << self
+
+      def settings=(options)
+        defaults = {
+          :max_workers => 10,
+          :identifier  => proc { |entry| entry.object_id },
+          :callback    => proc { |entry| entry.call }
+        }
+        @@settings = OpenStruct.new(defaults.merge(options))
+      end
+
+      def settings
+        @@settings
+      end
+
+    end
+
+    def initialize
+      self.pending, self.running, self.workers = [], [], []
+      self.queue = Queue.new
+      1.upto(self.class.settings.max_workers) do
+        worker = Thread.new do
+          loop do
+            task = self.queue.pop
+            self.pending.delete self.class.settings.identifier.call(task)
+            self.running << self.class.settings.identifier.call(task)
+            self.class.settings.callback.call(task)
+            self.running.delete self.class.settings.identifier.call(task)
+          end
+        end
+        self.workers << worker
+      end
+    end
+
+    def wait(id = nil)
+      sleep(0.1) while (id ? processes.include?(id) : processes.any?)
+    end
+
+    def <<(task)
+      identifier = self.class.settings.identifier.call(task)
+      if !processes.include?(identifier)
+        self.pending << identifier
+        self.queue << task
+      end
+      identifier
+    end
+
+    def processes
+      pending + running
+    end
+
+  end
+
+end

data/lib/callisto/shell.rb

@@ -0,0 +1,31 @@
+module Callisto
+
+  class Shell
+
+    attr_accessor :executable, :arguments
+
+    def self.bin_path=(path)
+      @@bin_path = path
+    end
+
+    def initialize(executable, arguments)
+      self.executable = executable
+      self.arguments = arguments
+    end
+
+    def command
+      prefix = if defined?(@@bin_path)
+                 File.join(@@bin_path, executable)
+               else
+                 executable
+               end
+      "#{prefix} #{arguments}"
+    end
+
+    def run
+      `#{command}`.chomp
+    end
+
+  end
+
+end

data/lib/callisto/thumbnail.rb

@@ -0,0 +1,80 @@
+require "digest"
+require "fileutils"
+
+module Callisto
+
+  class Thumbnail
+
+    attr_accessor :file_path, :args, :flag
+    attr_reader   :name, :crop
+    attr_writer   :extension, :root_path, :prefix, :public_path, :size, :quality
+
+    def initialize(args = {})
+      args.each do |name, value|
+        self.send("#{name}=", value)
+      end
+      self.name = args
+    end
+
+    def name=(value)
+      token = Digest::MD5.hexdigest(file_path.gsub(root_path.to_s, "") + value.to_s)
+      @name = token + extension
+    end
+
+    def save
+      location = File.join(root_path, prefix)
+      if !File.exist?(save_path)
+        FileUtils.mkdir_p(location) unless File.directory?(location)
+        task = Shell.new("convert", "#{file_path} -strip -quality #{quality || 90} -resize #{size}#{flag} #{crop} #{save_path}")
+        pid = Callisto::Pool.instance << task
+        Callisto::Pool.instance.wait(pid)
+      end
+      public_path
+    end
+
+    def save_path
+      File.join(root_path, prefix, name)
+    end
+
+    def public_path
+      File.join((@public_path || Callisto.configuration.thumbnail_public_path).to_s, name)
+    end
+
+    def crop=(value)
+      @crop = "-gravity Center -crop #{size}+0+0 +repage" if value
+    end
+
+    def extension
+      @extension || Callisto.configuration.thumbnail_extension || File.extname(file_path)
+    end
+
+    %w(root_path prefix size quality).each do |attr|
+      define_method attr do
+        instance_variable_get("@#{attr}") || Callisto.configuration.send("thumbnail_#{attr}")
+      end
+    end
+
+    def fixed_size=(val)
+      self.min_size = val
+      self.crop = true
+    end
+
+    def min_size=(val)
+      self.flag = "^"
+      self.size = val
+    end
+
+    def max_size=(val)
+      self.size = val
+      self.flag = "\\>"
+      self.crop = true
+    end
+
+    def geometry
+      task = Shell.new("identify", "-format \"%wx%h\" #{save_path}")
+      task.run
+    end
+
+  end
+
+end

data/lib/callisto/version.rb

@@ -0,0 +1,3 @@
+module Callisto
+  VERSION = "0.9"
+end

data/spec/callisto_spec.rb

@@ -0,0 +1,20 @@
+require "minitest/autorun"
+require File.expand_path("../minitest_helper", __FILE__)
+
+describe "Callisto" do
+
+  it "should have a configuration" do
+    Callisto.configuration.must_be_instance_of Callisto::Configuration
+  end
+
+  it "must cache configuration" do
+    Callisto.configuration.object_id.must_equal Callisto.configuration.object_id
+  end
+
+  it "yields the current configuration" do
+    Callisto.configure do |config|
+      config.must_equal Callisto.configuration
+    end
+  end
+
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,23 @@
+require "minitest/autorun"
+require File.expand_path("../minitest_helper", __FILE__)
+
+describe "Configuration" do
+
+  it "should assign max workers to pool" do
+    Callisto.configure do |config|
+      config.max_workers = 13
+    end
+    Callisto::Pool.settings.max_workers.must_equal 13
+  end
+
+  it "should assign thumbnail defaults" do
+    Callisto.configure do |config|
+      config.thumbnail_size = "20x45"
+      config.thumbnail_quality = 75
+    end
+
+    Callisto.configuration.thumbnail_size.must_equal "20x45"
+    Callisto.configuration.thumbnail_quality.must_equal 75
+  end
+
+end

data/spec/minitest_helper.rb

@@ -0,0 +1,8 @@
+require File.expand_path("../support/file_creator", __FILE__)
+require File.expand_path("../support/singleton", __FILE__)
+require File.expand_path("../lib/callisto", File.dirname(__FILE__))
+
+def reset_pool
+  Callisto::Pool.settings = {}
+  Callisto::Pool.reset_instance
+end

data/spec/pool_spec.rb

@@ -0,0 +1,157 @@
+require "minitest/autorun"
+require File.expand_path("../minitest_helper", __FILE__)
+
+describe "Pool" do
+
+  before do
+    reset_pool
+  end
+
+  describe "when assigning a task" do
+
+    before do
+      Callisto::Pool.settings = {
+        :max_workers => 10,
+        :identifier => proc { |task| task.path },
+        :callback => proc { |task| task.save }
+      }
+    end
+
+    it "should run a task" do
+      file = FileCreator.new("callback.txt")
+      Callisto::Pool.instance << file
+      Callisto::Pool.instance.wait
+      File.exist?(file.path).must_equal true
+      File.unlink(file.path)
+    end
+
+    it "should run tasks in parallel" do
+      file1 = FileCreator.new("file1.txt")
+      file2 = FileCreator.new("file2.txt")
+      file3 = FileCreator.new("file3.txt")
+      Callisto::Pool.settings.callback = proc { |task| task.save(1.0) }
+      start_time = Time.now
+      Callisto::Pool.instance << file1
+      Callisto::Pool.instance << file2
+      Callisto::Pool.instance << file3
+      Callisto::Pool.instance.wait
+      end_time = Time.now
+      (end_time - start_time).must_be :<, 2
+      File.exist?(file1.path).must_equal true
+      File.exist?(file2.path).must_equal true
+      File.exist?(file3.path).must_equal true
+      File.unlink(file1.path, file2.path, file3.path)
+    end
+
+  end
+
+  describe "when running the same (identical) task more than once" do
+
+    before do
+      Callisto::Pool.settings = {
+        :identifier => proc { |task| task[:id] },
+        :callback => proc { |task| task[:data].call }
+      }
+    end
+
+    it "adding a task should return the id" do
+      id1 = Callisto::Pool.instance << { :id => 1, :data => proc { sleep 1 } }
+      id2 = Callisto::Pool.instance << { :id => 1, :data => proc { sleep 1 } }
+      id3 = Callisto::Pool.instance << { :id => 2, :data => proc { sleep 1 } }
+      sleep 0.1
+      id1.must_equal id2
+      id1.wont_equal id3
+    end
+
+    it "should not run the task" do
+      Callisto::Pool.instance << { :id => 1, :data => proc { sleep 1 } }
+      4.times {
+        Callisto::Pool.instance << { :id => 2, :data => proc { sleep 1 } }
+      }
+      sleep 0.1
+      Callisto::Pool.instance.running.count.must_equal 2
+    end
+
+    it "should not stack duplicates" do
+      Callisto::Pool.instance << { :id => 1, :data => proc { sleep 1 } }
+      4.times {
+        Callisto::Pool.instance << { :id => 2, :data => proc { sleep 1 } }
+      }
+      Callisto::Pool.instance << { :id => 3, :data => proc { sleep 1 } }
+      Callisto::Pool.instance.processes.count.must_equal 3
+    end
+
+  end
+
+  describe "when max tasks reached" do
+
+    before do
+      Callisto::Pool.settings.max_workers = 2
+    end
+
+    it "should not run more than the max allowed processes at the same time" do
+      3.times {
+        Callisto::Pool.instance << proc { sleep 1 }
+      }
+      sleep 0.1
+      Callisto::Pool.instance.running.count.must_equal 2
+    end
+
+    it "should stack incoming tasks" do
+      5.times {
+        Callisto::Pool.instance << proc { sleep 1 }
+      }
+      sleep 0.1
+      Callisto::Pool.instance.pending.count.must_equal 3
+    end
+
+  end
+
+  describe "when task is finished" do
+
+    it "should be removed from the running list" do
+      3.times {
+        Callisto::Pool.instance << proc { sleep 1 }
+      }
+      sleep 0.1
+      Callisto::Pool.instance.running.count.must_equal 3
+      Callisto::Pool.instance.wait
+      Callisto::Pool.instance.running.count.must_equal 0
+    end
+
+    it "should run the first pending task" do
+      Callisto::Pool.settings = {
+        :max_workers => 1,
+        :callback => proc { |task| task.save(0.5) }
+      }
+      file1 = FileCreator.new("file1.txt")
+      file2 = FileCreator.new("file2.txt")
+      Callisto::Pool.instance << file1
+      Callisto::Pool.instance << file2
+      sleep 0.1
+      Callisto::Pool.instance.running.count.must_equal 1
+      Callisto::Pool.instance.wait
+      File.exist?(file1.path).must_equal true
+      File.exist?(file2.path).must_equal true
+      File.unlink(file1.path, file2.path)
+    end
+
+    it "should remove pending task from the stack" do
+      Callisto::Pool.settings = {
+        :max_workers => 1,
+        :identifier => proc { |task| task[:id] },
+        :callback => proc { |task| task[:data].call }
+      }
+      id1 = Callisto::Pool.instance << { :id => 1, :data => proc { sleep 0.4 } }
+      id2 = Callisto::Pool.instance << { :id => 2, :data => proc { sleep 0.4 } }
+      sleep 0.1
+      Callisto::Pool.instance.pending.must_equal([id2])
+      Callisto::Pool.instance.wait(id1)
+      Callisto::Pool.instance.running.must_equal([id2])
+      Callisto::Pool.instance.wait(id2)
+      Callisto::Pool.instance.running.must_equal([])
+    end
+
+  end
+
+end

data/spec/support/file_creator.rb

@@ -0,0 +1,21 @@
+require "tmpdir"
+require "fileutils"
+
+class FileCreator
+
+  attr_accessor :file_name
+
+  def initialize(value)
+    self.file_name = value
+  end
+
+  def save(wait = 0)
+    sleep wait
+    FileUtils.touch path
+  end
+
+  def path
+    File.join(Dir.tmpdir, file_name)
+  end
+
+end

data/spec/support/singleton.rb

@@ -0,0 +1,27 @@
+# Reset singleton
+# http://blog.ardes.com/2006/12/11/testing-singletons-with-ruby
+
+require "singleton"
+
+class << Singleton
+
+  def included_with_reset(klass)
+
+    included_without_reset(klass)
+
+    class << klass
+
+      def reset_instance
+        Singleton.send :__init__, self
+        self
+      end
+
+    end
+
+  end
+
+  alias_method :included_without_reset, :included
+
+  alias_method :included, :included_with_reset
+
+end

data/spec/thumbnail_spec.rb

@@ -0,0 +1,108 @@
+require "minitest/autorun"
+require File.expand_path("../minitest_helper", __FILE__)
+
+def cleanup(path)
+  matcher = File.join(path, "*.*")
+  Dir[matcher].each { |entry| File.unlink(entry) }
+end
+
+describe "Thumbnail" do
+
+  before do
+    reset_pool
+    Callisto.configuration.load_defaults
+  end
+
+  describe "when saving" do
+
+    before do
+      @options = {
+        :file_path   => File.expand_path("fixtures/normal-photo.png", File.dirname(__FILE__)),
+        :root_path   => File.expand_path("../tmp", File.dirname(__FILE__)),
+        :prefix      => "images",
+        :size        => "50x50",
+        :extension   => ".jpg"
+      }
+    end
+
+    after do
+      cleanup(File.join(@options[:root_path], @options[:prefix]))
+    end
+
+    it "should write the file at the specified location" do
+      thumbnail = Callisto::Thumbnail.new(@options)
+      File.exist?(thumbnail.save_path).must_equal false
+      thumbnail.save
+      File.exist?(thumbnail.save_path).must_equal true
+    end
+
+    it "should change file extension to the new value" do
+      @options.merge!(:extension => ".gif")
+      thumbnail = Callisto::Thumbnail.new(@options)
+      File.extname(thumbnail.save_path).must_equal ".gif"
+    end
+
+    it "should preserve file extension" do
+      @options.delete(:extension)
+      thumbnail = Callisto::Thumbnail.new(@options)
+      thumbnail.save
+      File.extname(thumbnail.save_path).must_equal ".png"
+      File.exist?(thumbnail.save_path).must_equal true
+    end
+
+    it "should return the public file path" do
+      @options.merge!({ :public_path => "http://localhost:3000/images" })
+      thumbnail = Callisto::Thumbnail.new(@options)
+      thumbnail.save.must_equal "http://localhost:3000/images/#{thumbnail.name}"
+    end
+
+  end
+
+  describe "resizing the image" do
+
+    before do
+      @options = {
+        :file_path => File.expand_path("fixtures/normal-photo.png", File.dirname(__FILE__)),
+        :root_path => File.expand_path("../tmp", File.dirname(__FILE__)),
+        :prefix    => "images"
+      }
+    end
+
+    after do
+      cleanup(File.join(@options[:root_path], @options[:prefix]))
+    end
+
+    it "should scale image to the specified size" do
+      @options.merge!({ :fixed_size => "50x50" })
+      thumbnail = Callisto::Thumbnail.new(@options)
+      thumbnail.save
+      thumbnail.geometry.must_equal "50x50"
+    end
+
+    it "should scale image within the specified size" do
+      @options.merge!({ :max_size => "50x50" })
+      thumbnail = Callisto::Thumbnail.new(@options)
+      thumbnail.save
+      thumbnail.geometry.must_equal "50x31"
+    end
+
+    it "should scale image larger then specified size" do
+      @options.merge!({ :min_size => "50x50" })
+      thumbnail = Callisto::Thumbnail.new(@options)
+      thumbnail.save
+      thumbnail.geometry.must_equal "80x50"
+    end
+
+  end
+
+  it "should inherit and fallback configuration" do
+    Callisto.configure do |config|
+      config.thumbnail_root_path = "some/path"
+      config.thumbnail_prefix = "img"
+    end
+    thumbnail = Callisto::Thumbnail.new(:fixed_size => "125x125", :file_path => "some_file.txt")
+    thumbnail.root_path.must_equal "some/path"
+    thumbnail.prefix.must_equal "img"
+  end
+
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: callisto
+version: !ruby/object:Gem::Version
+  version: '0.9'
+  prerelease: 
+platform: ruby
+authors:
+- Daniel Mircea
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-25 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &25241560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *25241560
+description: Image thumbnails on the fly
+email:
+- daniel@thegeek.ro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- callisto.gemspec
+- lib/callisto.rb
+- lib/callisto/configuration.rb
+- lib/callisto/pool.rb
+- lib/callisto/shell.rb
+- lib/callisto/thumbnail.rb
+- lib/callisto/version.rb
+- spec/callisto_spec.rb
+- spec/configuration_spec.rb
+- spec/fixtures/normal-photo.png
+- spec/minitest_helper.rb
+- spec/pool_spec.rb
+- spec/support/file_creator.rb
+- spec/support/singleton.rb
+- spec/thumbnail_spec.rb
+homepage: https://github.com/viseztrance/callisto
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Callisto
+test_files:
+- spec/callisto_spec.rb
+- spec/configuration_spec.rb
+- spec/fixtures/normal-photo.png
+- spec/minitest_helper.rb
+- spec/pool_spec.rb
+- spec/support/file_creator.rb
+- spec/support/singleton.rb
+- spec/thumbnail_spec.rb
+has_rdoc: