pictopus 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Intridea, Inc.
+
+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.rdoc

@@ -0,0 +1,73 @@
+= Pictopus
+
+Pictopus is a Rails 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
+through the command line (using the 'convert' command).
+
+== Installation
+
+Pictopus is available as a gem on Gemcutter.
+
+    gem install pictopus
+    
+To include it in your Rails application, add this to your <tt>development.rb</tt>
+file (NOTE: It is <b>not</b> recommended to include the Pictopus gem in
+your production environment).
+
+    config.gem 'pictopus'
+
+== Usage
+
+If you have ImageMagick installed in your Rails app, 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
+check them into your repository and your production environment
+will treat them like any other image.
+
+To create a gradient using Pictopus, just query a path like this:
+
+    /images/pictopus/gradient/fff.000.v.100.png
+    
+In this case, a 1x100 image with a vertical white to black gradient
+would be created. The structure of the image filename is:
+
+    :start_color.:end_color.:orientation.:size.:format
+
+For a more complete description of the options:
+
+* <tt>:start_color</tt> - The color for the top (or left) of the gradient.
+* <tt>:end_color</tt> - The color for the bottom (or right) of the gradient.
+* <tt>:orientation</tt> - "v" for a vertical gradient (top to bottom) or
+  "h" for a horizontal one.
+* <tt>:size</tt> - The size of the image. If only one number is supplied,
+  the image will be 1 pixel wide or high depending on orientation. To create
+  a multi-dimensional image simply specify it in <tt>wxh</tt> for example
+  <tt>50x100</tt>.
+
+== Colors
+
+Colors are described in web hex code, with acceptable formats including
+<tt>RRGGBB</tt>, <tt>RGB</tt>, and <tt>RRGGBBAA</tt> (for <tt>.png</tt>
+images only).
+
+== Future
+
+While this is a ridiculously simple tool for the time being, it is helpful
+for me in rapidly prototyping websites without getting bogged down in
+Photoshop. In the future, I hope to bring together more powerful functionality,
+perhaps drawing inspiration from the AJAX Spinner Generator and other
+similar sites to create additional "commands".
+
+== Note on Patches/Pull Requests
+ 
+* 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.
+* 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.

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "pictopus"
+    gem.summary = %Q{A Rails Engine for dynamically generating images for your application design.}
+    gem.description = %Q{A Rails Engine to dynamically generate images for your application while in development mode.}
+    gem.email = "michael@intridea.com"
+    gem.homepage = "http://github.com/intridea/pictopus"
+    gem.authors = ["Michael Bleigh"]
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "remarkable"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "pictopus #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/app/controllers/pictopus_controller.rb

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,5 @@
+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/lib/pictopus.rb

@@ -0,0 +1,33 @@
+module Pictopus
+  class CommandLineError < StandardError; end
+  
+  class << self
+    def options
+      @options ||= {
+        :command_path => nil,
+        :log => true,
+        :swallow_stderr => true,
+        :log_command => true
+      }
+    end
+    
+    def run(cmd, params="", 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)
+        raise Pictopus::CommandLineError, "Error while running #{cmd}"
+      end
+    end
+    
+    def path_for_command(command)
+      path = [options[:command_path], command].compact!
+      File.join(*path)
+    end
+    
+    def bit_bucket #:nodoc:
+      File.exists?("/dev/null") ? "/dev/null" : "NUL"
+    end
+  end
+end

data/lib/pictopus/gradient.rb

@@ -0,0 +1,98 @@
+require 'pictopus'
+
+module Pictopus
+  class Gradient
+    OPTION_KEYS = [:start_color, :end_color, :orientation, :size, :format]
+    
+    # Provide some default options for
+    # generating gradients. You shouldn't
+    # ever really see this unless you're
+    # hacking on something custom.
+    def self.default_options
+      @options ||= {
+        :size => '100x100',
+        :format => 'png',
+        :orientation => 'vertical',
+        :start_color => 'fff',
+        :end_color => '000'
+      }
+    end
+    
+    # Create a new Gradient object and provide
+    # options. The available options are enumerated
+    # in OPTION_KEYS.
+    def initialize(options = {})
+      @options = self.class.default_options.merge(options)
+    end
+    
+    # Convert this object to a string of command line arguments
+    # acceptable by ImageMagick.
+    def to_args
+      args = []
+      args << "-size #{parse_size(size)}"
+      args << "gradient:#{parse_color(start_color)}-#{parse_color(end_color)}"
+      args << "-rotate -90" if horizontal?
+      args << File.join(output_directory, file_name)
+      args.join(' ')
+    end
+    
+    # Run the actual command to generate the image
+    # for this instance.
+    def run!
+      Pictopus.run('convert', self.to_args)
+    end
+    
+    OPTION_KEYS.each do |opt|
+      class_eval <<-RUBY
+      def #{opt}
+        @options[#{opt.inspect}]
+      end
+      
+      def #{opt}=(value)
+        @options[#{opt.inspect}] = value
+      end
+      RUBY
+    end
+    
+    # True if the image is set to be a vertical gradient.
+    def vertical?
+      %w(v vertical).include?(orientation)
+    end
+
+    # True if the image is set to be a horizontal gradient.    
+    def horizontal?
+      %w(h horizontal).include?(orientation)
+    end
+    
+    def output_directory # :nodoc:
+      File.join(Rails.root, 'public', 'images', 'pictopus', 'gradient')
+    end
+    
+    def file_name # :nodoc:
+      [start_color, end_color, orientation, size, format].join('.')
+    end
+    
+    protected
+    
+    def parse_color(color_string)
+      if color_string =~ /[0-9a-f]{3}/i || 
+         color_string =~ /[0-9a-f]{6}/i || 
+         color_string =~ /[0-9a-f]{8}/i
+         "##{color_string}".downcase
+      end
+    end
+    
+    def parse_size(size_string)
+      dimensions = size_string.split('x')
+      
+      case dimensions.size
+        when 2
+          dimensions.reverse! if horizontal?
+        when 1
+          dimensions.unshift('1')
+      end
+
+      dimensions.join('x')
+    end
+  end
+end

data/pictopus.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pictopus}
+  s.version = "0.0.1"
+
+  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.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 = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "app/controllers/pictopus_controller.rb",
+     "config/pictopus_routes.rb",
+     "lib/pictopus.rb",
+     "lib/pictopus/gradient.rb",
+     "pictopus.gemspec",
+     "rails/init.rb",
+     "spec/controllers/pictopus_controller_spec.rb",
+     "spec/pictopus/gradient_spec.rb",
+     "spec/pictopus_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/intridea/pictopus}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  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_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<remarkable>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<remarkable>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<remarkable>, [">= 0"])
+  end
+end
+

data/rails/init.rb

@@ -0,0 +1,19 @@
+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
+
+  alias_method_chain :load_routes!, :pictopus
+end
+
+require 'pictopus'
+
+if Rails.env == 'test'
+  config.gem 'rspec', :lib => false
+  config.gem 'remarkable', :lib => false
+end

data/spec/controllers/pictopus_controller_spec.rb

@@ -0,0 +1,41 @@
+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

data/spec/pictopus/gradient_spec.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Pictopus::Gradient do
+  it 'should have setters and getters for each of the options' do
+    @g = Pictopus::Gradient.new
+    
+    Pictopus::Gradient::OPTION_KEYS.each do |opt|
+      @g.should respond_to(opt)
+      @g.should respond_to("#{opt}=")
+      
+      @g.send("#{opt}=", 'test')
+      @g.send(opt).should == 'test'
+    end
+  end
+  
+  describe '#to_args' do
+    before do
+      @g = Pictopus::Gradient.new(
+        :start_color => 'aaa', 
+        :end_color => 'bb33ff',
+        :orientation => 'v',
+        :size => '30x40',
+        :format => 'gif'
+      )
+    end
+    
+    it 'should add the colors to the gradient commands' do
+      @g.to_args.should be_include('gradient:#aaa-#bb33ff')
+    end
+    
+    it 'should add the size to the options' do
+      @g.to_args.should be_include('-size 30x40')
+    end
+    
+    it 'should set size correctly for vertical' do
+      @g.size = '50'
+      @g.to_args.should be_include('-size 1x50')
+    end
+    
+    it 'should flip dimensions for horizontal' do
+      @g.orientation = 'horizontal'
+      @g.to_args.should be_include('-size 40x30')
+    end
+    
+    it 'should add -rotate for horizontal' do
+      @g.orientation = 'horizontal'
+      @g.to_args.should be_include('-rotate -90')
+    end
+  end
+end

data/spec/pictopus_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Pictopus" do
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: pictopus
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael Bleigh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-27 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: remarkable
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A Rails Engine to dynamically generate images for your application while in development mode.
+email: michael@intridea.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- app/controllers/pictopus_controller.rb
+- config/pictopus_routes.rb
+- lib/pictopus.rb
+- lib/pictopus/gradient.rb
+- pictopus.gemspec
+- rails/init.rb
+- spec/controllers/pictopus_controller_spec.rb
+- spec/pictopus/gradient_spec.rb
+- spec/pictopus_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/intridea/pictopus
+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: 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/spec_helper.rb