pictopus 0.0.1 → 0.1.0

data/README.rdoc

@@ -1,8 +1,8 @@
 = Pictopus
 
-Pictopus is a Rails developer tool that allows you to use ImageMagick to
+Pictopus is a Rack developer tool that allows you to use ImageMagick to
 automatically generate gradient images to use in your design. It is 
-implemented using Rails Engines for the routing and simply runs ImageMagick
+implemented using Rack middleware for the routing and simply runs ImageMagick
 through the command line (using the 'convert' command).
 
 == Installation
@@ -16,10 +16,16 @@ file (NOTE: It is <b>not</b> recommended to include the Pictopus gem in
 your production environment).
 
     config.gem 'pictopus'
+    
+To include it in your Rack application, simply add these lines to your
+rackup:
+
+    require 'rack/pictopus'
+    use Rack::Pictopus, '/path/to/your/static/dir'
 
 == Usage
 
-If you have ImageMagick installed in your Rails app, you can create
+If you have ImageMagick installed in your system, you can create
 arbitrary gradient images just by naming them as a URL. They will
 automatically be created by ImageMagick and cached to your public
 directory, meaning that the generation happens once. You can then
@@ -64,10 +70,10 @@ similar sites to create additional "commands".
  
 * Fork the project.
 * Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* <b>Add tests for it.</b> This is important so I don't break it in a future version unintentionally.
 * Commit, do not mess with Rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send us a pull request. Bonus points for topic branches.
 
 == Copyright
 
-Copyright (c) 2009 Michael Bleigh. See LICENSE for details.
+Copyright (c) 2009 Intridea, Inc. and Michael Bleigh See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/lib/pictopus.rb

@@ -2,7 +2,7 @@ module Pictopus
   class CommandLineError < StandardError; end
   
   class << self
-    def options
+    def default_options
       @options ||= {
         :command_path => nil,
         :log => true,
@@ -11,18 +11,20 @@ module Pictopus
       }
     end
     
-    def run(cmd, params="", expected_outcodes = 0)
+    def run(cmd, params="", options = {})
+      options[:expected_outcodes] ||= 0
       command = %Q[#{path_for_command(cmd)} #{params}].gsub(/\s+/, " ")
-      command = "#{command} 2>#{bit_bucket}" if Pictopus.options[:swallow_stderr]
-      Rails.logger.info(command) if Pictopus.options[:log_command]
-      output = `#{command}`
-      unless Array(expected_outcodes).include?($?.exitstatus)
+      command = "#{command} 2>#{bit_bucket}" if Pictopus.default_options[:swallow_stderr]
+      #Rails.logger.info(command) if Pictopus.default_options[:log_command]
+      puts command
+      output = system(command)
+      unless Array(options[:expected_outcodes]).include?($?.exitstatus)
         raise Pictopus::CommandLineError, "Error while running #{cmd}"
       end
     end
     
     def path_for_command(command)
-      path = [options[:command_path], command].compact!
+      path = [default_options[:command_path], command].compact!
       File.join(*path)
     end
     
@@ -30,4 +32,6 @@ module Pictopus
       File.exists?("/dev/null") ? "/dev/null" : "NUL"
     end
   end
-end
+end
+
+require 'pictopus/gradient'

data/lib/pictopus/gradient.rb

@@ -39,6 +39,7 @@ module Pictopus
     # Run the actual command to generate the image
     # for this instance.
     def run!
+      FileUtils.mkdir_p(output_directory) unless File.directory?(File.dirname(output_directory))
       Pictopus.run('convert', self.to_args)
     end
     
@@ -65,7 +66,7 @@ module Pictopus
     end
     
     def output_directory # :nodoc:
-      File.join(Rails.root, 'public', 'images', 'pictopus', 'gradient')
+      File.join(@options[:output_path], 'images', 'pictopus', 'gradient')
     end
     
     def file_name # :nodoc:

data/lib/rack/pictopus.rb

@@ -0,0 +1,36 @@
+require 'pictopus'
+
+module Rack
+  class Pictopus
+    def initialize(app, output_path)
+      @app = app
+      @root = ::File.expand_path(output_path)
+      raise ArgumentError, "#{output_path} is not a directory." unless ::File.directory?(@root)
+    end
+    
+    def call(env)
+      unless env["PATH_INFO"] =~ /.*\/images\/pictopus\/.*\/.*/
+        return @app.call(env)
+      end
+      
+      request = ::Rack::Request.new(env)
+      kind, command = env["PATH_INFO"].match(/images\/pictopus\/(.*)\/(.*)/i)[1..-1]
+      
+      if ::File.exist?(@root + env["PATH_INFO"])
+        return ::Rack::File.new(@root).call(env)
+      end
+      
+      case kind
+        when "gradient"
+          opts = {
+            :output_path => @root
+          }
+          opts[:start_color], opts[:end_color], opts[:orientation], opts[:size], opts[:format] = command.split('.')
+          ::Pictopus::Gradient.new(opts).run!
+          
+          # Redirect to this URL since it will now be served.
+          [301, {'Location' => request.url}, 'Redirecting to created image.']
+      end
+    end
+  end
+end

data/pictopus.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pictopus}
-  s.version = "0.0.1"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Bleigh"]
-  s.date = %q{2009-10-27}
+  s.date = %q{2009-11-15}
   s.description = %q{A Rails Engine to dynamically generate images for your application while in development mode.}
   s.email = %q{michael@intridea.com}
   s.extra_rdoc_files = [
@@ -23,15 +23,14 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
-     "app/controllers/pictopus_controller.rb",
-     "config/pictopus_routes.rb",
      "lib/pictopus.rb",
      "lib/pictopus/gradient.rb",
+     "lib/rack/pictopus.rb",
      "pictopus.gemspec",
      "rails/init.rb",
-     "spec/controllers/pictopus_controller_spec.rb",
      "spec/pictopus/gradient_spec.rb",
      "spec/pictopus_spec.rb",
+     "spec/rack/pictopus_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
   ]
@@ -41,9 +40,9 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{A Rails Engine for dynamically generating images for your application design.}
   s.test_files = [
-    "spec/controllers/pictopus_controller_spec.rb",
-     "spec/pictopus/gradient_spec.rb",
+    "spec/pictopus/gradient_spec.rb",
      "spec/pictopus_spec.rb",
+     "spec/rack/pictopus_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/rails/init.rb

@@ -1,19 +1,3 @@
-class ActionController::Routing::RouteSet
-  def load_routes_with_pictopus!
-    pictopus_routes = File.join(File.dirname(__FILE__), 
-                       *%w[.. config pictopus_routes.rb])
-    unless configuration_files.include? pictopus_routes
-      add_configuration_file(pictopus_routes)
-    end
-    load_routes_without_pictopus!
-  end
+require 'rack/pictopus'
 
-  alias_method_chain :load_routes!, :pictopus
-end
-
-require 'pictopus'
-
-if Rails.env == 'test'
-  config.gem 'rspec', :lib => false
-  config.gem 'remarkable', :lib => false
-end
+config.middleware.use(::Rack::Pictopus, File.join(RAILS_ROOT, 'public'))

data/spec/pictopus/gradient_spec.rb

@@ -20,7 +20,8 @@ describe Pictopus::Gradient do
         :end_color => 'bb33ff',
         :orientation => 'v',
         :size => '30x40',
-        :format => 'gif'
+        :format => 'gif',
+        :output_path => "/dev/null"
       )
     end
     
@@ -46,5 +47,9 @@ describe Pictopus::Gradient do
       @g.orientation = 'horizontal'
       @g.to_args.should be_include('-rotate -90')
     end
+    
+    it 'should add the output path' do
+      @g.to_args.should match(/\/dev\/null\/images\/pictopus\/gradient\/aaa\.bb33ff\.v\.30x40\.gif$/)
+    end
   end
 end

data/spec/rack/pictopus_spec.rb

@@ -0,0 +1,53 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+require 'rack/pictopus'
+
+describe Rack::Pictopus do
+  include Rack::Test::Methods
+  
+  def app
+    Rack::Pictopus.new(nil, File.expand_path(File.dirname(__FILE__) + '/../'))
+  end
+  
+  describe '#gradient' do
+    before do
+      @opts = {
+        :start_color => 'f00',
+        :end_color => '00f',
+        :size => '50',
+        :orientation => 'h',
+        :format => 'jpg',
+        :output_path => File.expand_path(File.dirname(__FILE__) + '/../')
+      }
+    end
+    
+    it 'should create a Pictopus::Gradient for the provided params' do
+      Pictopus::Gradient.should_receive(:new).with(@opts).and_return(mock('Pictopus::Gradient', :run! => true))
+      get '/images/pictopus/gradient/f00.00f.h.50.jpg'
+    end
+    
+    it 'should call run! on the gradient' do
+      @g = Pictopus::Gradient.new(@opts)
+      Pictopus::Gradient.stub!(:new).and_return(@g)
+      @g.should_receive(:run!).and_return(true)
+      get '/images/pictopus/gradient/f00.00f.h.50.jpg'
+    end
+    
+    it 'should redirect to itself (since the image will be generated)' do
+      get '/images/pictopus/gradient/f00.00f.h.50.jpg'
+            
+      last_response.status.should == 301
+      last_response.headers['location'].should be_include('/images/pictopus/gradient/f00.00f.h.50.jpg')
+    end
+    
+    it 'should serve up the file if it already exists' do
+      get '/images/pictopus/gradient/f00.00f.h.50.jpg'
+      get '/images/pictopus/gradient/f00.00f.h.50.jpg'
+      last_response.status.should == 200
+    end
+  end
+  
+  after do
+    FileUtils.rm_rf(File.dirname(__FILE__) + '/../images')
+  end
+end

data/spec/spec_helper.rb

@@ -1,15 +1,8 @@
-begin
-  require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
-rescue LoadError
-  puts "You need to install rspec in your base app"
-  exit
-end
-
+require 'rubygems'
 require 'pictopus'
 require 'spec'
 require 'spec/autorun'
-
-require 'remarkable_rails'
+require 'rack/test'
 
 Spec::Runner.configure do |config|
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pictopus
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Michael Bleigh
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-27 00:00:00 -04:00
+date: 2009-11-15 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,15 +48,14 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
-- app/controllers/pictopus_controller.rb
-- config/pictopus_routes.rb
 - lib/pictopus.rb
 - lib/pictopus/gradient.rb
+- lib/rack/pictopus.rb
 - pictopus.gemspec
 - rails/init.rb
-- spec/controllers/pictopus_controller_spec.rb
 - spec/pictopus/gradient_spec.rb
 - spec/pictopus_spec.rb
+- spec/rack/pictopus_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
@@ -88,7 +87,7 @@ signing_key:
 specification_version: 3
 summary: A Rails Engine for dynamically generating images for your application design.
 test_files: 
-- spec/controllers/pictopus_controller_spec.rb
 - spec/pictopus/gradient_spec.rb
 - spec/pictopus_spec.rb
+- spec/rack/pictopus_spec.rb
 - spec/spec_helper.rb

data/app/controllers/pictopus_controller.rb

@@ -1,10 +0,0 @@
-class PictopusController < ApplicationController
-  def gradient
-    @opts = {}
-    Pictopus::Gradient::OPTION_KEYS.each{|k| @opts[k] = params[k]}    
-    
-    Pictopus::Gradient.new(@opts).run!
-    redirect_to request.request_uri
-  end
-end
-  

data/config/pictopus_routes.rb

@@ -1,5 +0,0 @@
-ActionController::Routing::Routes.draw do |map|
-  map.with_options(:name_prefix => 'pictopus_', :controller => 'pictopus') do |pictopus|
-    pictopus.gradient '/images/pictopus/gradient/:start_color.:end_color.:orientation.:size.:format', :action => 'gradient'
-  end
-end

data/spec/controllers/pictopus_controller_spec.rb

@@ -1,41 +0,0 @@
-require File.dirname(__FILE__) + '/../spec_helper'
-
-describe PictopusController do
-  should_route :get, '/images/pictopus/gradient/fff.000.v.100.png', 
-               :controller => 'pictopus', 
-               :action => 'gradient',
-               :start_color => 'fff',
-               :end_color => '000',
-               :orientation => 'v',
-               :size => '100',
-               :format => 'png'
-               
-  describe '#gradient' do
-    before do
-      @opts = {
-        :start_color => 'f00',
-        :end_color => '00f',
-        :size => '50',
-        :orientation => 'h',
-        :format => 'jpg'
-      }
-    end
-    
-    it 'should create a Pictopus::Gradient for the provided params' do
-      Pictopus::Gradient.should_receive(:new).with(@opts).and_return(mock('Pictopus::Gradient', :run! => true))
-      get :gradient, @opts.dup
-    end
-    
-    it 'should call run! on the gradient' do
-      @g = Pictopus::Gradient.new(@opts)
-      Pictopus::Gradient.stub!(:new).and_return(@g)
-      @g.should_receive(:run!).and_return(true)
-      get :gradient, @opts.dup
-    end
-    
-    it 'should redirect to itself (since the image will be generated)' do
-      get :gradient, @opts.dup
-      response.should redirect_to request.request_uri
-    end
-  end
-end