jeremyboles-graffic 0.1.0

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+== 0.1.0, released 2009-03-16
+
+* Initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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,28 @@
+Graffic
+======
+
+Graffic is an ActiveRecord class that helps you work with and attach images to other ActiveRecord records.
+
+
+Example
+======
+
+  # models/profile_photo.rb
+  class ProfilePhoto < Graffic
+    size :medium, :width => 48, :height => 48, :format => :jpg
+  end
+
+  # models/user.rb
+  class User < ActiveRecord
+    has_one :profile_photo
+  end
+
+  # views/users/_edit.html.erb
+  <% form_for @user do |f| %>
+    <% f.fields_for :profile_photo do |p| %>
+      <%= p.label :file, 'Profile Photo' %>
+      <%= p.field_field :file %>
+    <% end %>
+  <% end %>
+    
+Copyright (c) 2009 Jeremy Boles, released under the MIT license

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Generate RDoc documentation for the Graffic plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_files.include('README.rdoc', 'MIT-LICENSE', 'CHANGELOG.rdoc').include('lib/**/*.rb')
+  
+  rdoc.main = "README.rdoc" # page to start on
+  rdoc.title = "Graffic documentation"
+  
+  rdoc.rdoc_dir = 'doc' # rdoc output folder
+  rdoc.options << '--inline-source' << '--charset=UTF-8'
+  rdoc.options << '--webcvs=http://github.com/jeremyboles/graffic/tree/master/'
+end
+
+desc %{Update ".manifest" with the latest list of project filenames.}
+task :manifest do
+  list = `git ls-files --full-name --exclude=*.gemspec --exclude=.*`.chomp.split("\n")
+  
+  if spec_file = Dir['*.gemspec'].first
+    spec = File.read spec_file
+    spec.gsub! /^(\s* s.(test_)?files \s* = \s* )( \[ [^\]]* \] | %w\( [^)]* \) )/mx do
+      assignment = $1
+      bunch = $2 ? list.grep(/^test\//) : list
+      '%s%%w(%s)' % [assignment, bunch.join(' ')]
+    end
+      
+    File.open(spec_file, 'w') { |f| f << spec }
+  end
+  File.open('.manifest', 'w') { |f| f << list.join("\n") }
+end
+
+desc 'Test the graffic plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+ 
+desc 'Generate documentation for the graffic plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Graffic'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1,5 @@
+require 'rmagick'
+require 'state_machine'
+
+require 'graffic'
+require 'graffic/aws'

data/lib/graffic.rb

@@ -0,0 +1,276 @@
+# Graffic
+class Graffic < ActiveRecord::Base
+  attr_writer :file
+  attr_writer :image
+  cattr_writer :bucket_name
+  cattr_writer :queue_name
+  
+  belongs_to :resource, :polymorphic => true
+  
+  after_create :move
+  after_destroy :delete_s3_file
+  
+  # We're using the state machine to keep track of what stage of photo
+  # processing we're at. Here are the states:
+  # 
+  # received -> moved -> uploaded -> processed
+  #
+  state_machine :state, :initial => :received do
+    before_transition :to => :moved,      :do => :move!
+    before_transition :to => :uploaded,   :do => :save_original!
+    before_transition :from => :moved,    :do => :upload!
+    before_transition :to => :processed,  :do => :process!
+    
+    after_transition :from => :moved,   :do => :remove_moved_file!
+    after_transition :to => :uploaded,  :do => :queue_job!
+    after_transition :to => :processed, :from => :uploaded, :do => :create_sizes!
+    after_transition :to => :processed, :do => :record_dimensions!
+    
+    event :move do
+      transition :to => :moved, :from => :received
+    end
+    
+    event :upload do
+      transition :to => :uploaded, :from => :moved
+    end
+    
+    event :upload_unprocessed do
+      transition :to => :processed, :from => :moved
+    end
+    
+    event :process do
+      transition :to => :processed, :from => :uploaded
+    end
+    
+    # Based on which state we're at, we'll need to pull the image from a different are
+    state :moved do
+      # If it hasn't been moved, we'll need to pull it from the local file system
+      def image
+        @image ||= Magick::Image.read(tmp_file_path).first
+      end
+    end
+    
+    state :uploaded, :processed do
+      # If it's been uploaded and procesed, grab it from S3
+      def image
+        @image ||= Magick::Image.from_blob(bucket.get(uploaded_file_path)).first
+      end
+    end
+  end
+  
+  class << self
+    # Returns the bucket for the model
+    def bucket
+      @bucket ||= Graffic::Aws.s3.bucket(bucket_name, true, 'public-read')
+    end
+    
+    # Change the bucket name from the default
+    def bucket_name(name = nil)
+      @@bucket_name = name unless name == nil
+      @@bucket_name
+    end
+    
+    # Upload all of the files that have been moved.  This will only work on
+    # local files.
+    # TODO: Make this work only on file system that the file was used on
+    def handle_moved!
+      image = first(:conditions => { :state => 'moved' })
+      return if image.nil?
+      image.upload 
+    end
+    
+    # Process all of the the uploaded files that are in the queue
+    def handle_uploaded!
+      message = queue.pop
+      return if message.nil?
+      image = find(message.body)
+      image.process
+      message.body
+    rescue
+      true
+    end
+    
+    def inherited(child)
+      child.has_one(:original, :class_name => 'Graffic', :as => :resource, :dependent => :destroy, :conditions => { :name => 'original' })
+      super
+    end
+    
+    def process(&block)
+      if block_given?
+        @process = block
+      else
+        return @process
+      end
+    end
+    
+    # Change the queue name from the default
+    def queue_name(name = nil)
+      @@queue_name = name unless name == nil
+      @@queue_name || 'graffic'
+    end
+    
+    # Return the model's queue
+    def queue
+      @queue ||= Graffic::Aws.sqs.queue(queue_name, true)
+    end
+    
+    # Create a size of the graphic.
+    def size(name, size={})
+      size[:format] ||= :png
+      size.assert_valid_keys(:width, :height, :format)
+      
+      @sizes ||= {}
+      @sizes[name] = size
+      
+      has_one(name, :class_name => 'Graffic', :as => :resource, :dependent => :destroy, :conditions => { :name => name.to_s })
+    end
+    
+    # Returns all of the version names for the mode
+    def sizes
+      @sizes ||= {}
+    end
+    
+    # Set the image format
+    def format(format = nil)
+      @format = format unless format.nil?
+      @format ||= :png
+    end
+  end
+  
+  # Returns a size string
+  def size
+    "#{width}x#{height}"
+  end
+  
+  # Return the url for displaying the image
+  def url
+    key.public_link
+  end
+  
+private
+  # Connivence method for getting the bucket
+  def bucket
+    self.class.bucket
+  end
+  
+  def create_sizes!
+    self.class.sizes.each do |name, size|
+      logger.debug("***** Sizing: #{name}")
+      file_name = "#{tmp_file_path}.#{name}.#{image_extension(size[:format])}"
+      
+      img = image.crop_resized(size[:width], size[:height])
+      img.write(file_name)
+      
+      i = Graffic.create(:file => file_name, :format => size[:format].to_s, :name => name.to_s)
+      update_attribute(name, i)
+      i.upload_unprocessed
+      
+      FileUtils.rm(file_name)
+    end
+  end
+  
+  # Deletes the file from S3
+  def delete_s3_file
+    key.delete
+  end
+  
+  # The formate of the image
+  def format
+    attributes['format'] || self.class.format
+  end
+  
+  # Returns true if the file has versions
+  def has_sizes?
+    !self.class.sizes.empty?
+  end
+  
+  def image_extension(atype = nil)
+    (atype || format).to_s
+  end
+  
+  # Return the S3 key for the record
+  def key
+    @s3_key ||= bucket.key(uploaded_file_path)
+  end
+  
+  # If the file is a Tempfile, we'll need to move to the app's tmp directory so
+  # we can insure that it is retrained until we can upload it
+  # If its a S3 Key, we'll write that file's date to our tmp directory
+  def move!
+    if @file.is_a?(Tempfile)
+      FileUtils.mv(@file.path, tmp_file_path)
+    elsif @file.is_a?(String)
+      FileUtils.cp(@file, tmp_file_path)
+    end
+  end
+  
+  # Process the image
+  def process!
+    unless self.class.process.nil?
+      @image = self.class.process.call(image)
+      raise 'You need to return an image' unless @image.is_a?(Magick::Image)
+      upload!
+    end
+  end
+  
+  # Connivence method for getting the queue
+  def queue
+    self.class.queue
+  end
+  
+  # Add a job to the queue
+  def queue_job!
+    logger.debug("***** Graffic(#{self.id})#queue_job!")
+    queue.push(self.id)
+  end
+  
+  # Save the image's width and height to the database
+  def record_dimensions!
+    logger.debug("***** Graffic(#{self.id})#record_dimensions!")
+    self.update_attributes(:height => image.rows, :width => image.columns)
+  end
+  
+  # Remove the temp file in the app's temp director
+  def remove_moved_file!
+    logger.debug("***** Graffic(#{self.id})#remove_moved_file!")
+    FileUtils.rm(tmp_file_path) if File.exists?(tmp_file_path)
+  end
+  
+  # Returns a RMagick constant for the type of image
+  def rmagick_type(atype = nil)
+    return case (atype || format).to_sym
+      when :gif then Magick::LZWCompression
+      when :jpg then Magick::JPEGCompression
+      when :png then Magick::ZipCompression
+    end
+  end
+  
+  # Uploads an untouched original
+  def save_original!
+    logger.debug("***** Graffic(#{self.id})#save_original!")
+    if respond_to?(:original)
+      i = Graffic.new(:file => tmp_file_path, :name => 'original')
+      update_attribute(:original, i)
+      i.upload_unprocessed
+    end
+  end
+  
+  # Returns the path to the file in the app's tmp directory
+  def tmp_file_path
+    RAILS_ROOT + "/tmp/images/#{id}.tmp"
+  end
+  
+  # Upload the file to S3
+  def upload!
+    logger.debug("***** Graffic(#{self.id})#upload!")
+    t = rmagick_type
+    data = image.to_blob { |i| i.compression = t }
+    bucket.put(uploaded_file_path, data, {}, 'public-read')
+  end
+  
+  # Return the path on S3 for the file (the key name, essentially)
+  def uploaded_file_path
+    "#{self.class.name.tableize}/#{id}.#{image_extension}"
+  end
+  
+end # Graffic

data/tasks/graffic_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :graffic do
+#   # Task goes here
+# end

data/test/graffic_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class GrafficTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: jeremyboles-graffic
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jeremy Boles
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-16 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: state_machine
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.6.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: right_aws
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.10.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rmagick
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.9.1
+    version: 
+description: Graffic is an ActiveRecord class that helps you work with and attach images to other ActiveRecord records.
+email: jeremy@jeremyboles.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+- CHANGELOG.rdoc
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- init.rb
+- install.rb
+- lib/graffic.rb
+- tasks/graffic_tasks.rake
+- test/graffic_test.rb
+- test/test_helper.rb
+- uninstall.rb
+- README.rdoc
+- LICENSE
+- CHANGELOG.rdoc
+has_rdoc: true
+homepage: http://github.com/jeremyboles/graffic/wikis
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --inline-source
+- --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.2.0
+signing_key: 
+specification_version: 2
+summary: Image asset handing for ActiveRecord and Rails
+test_files: 
+- test/graffic_test.rb
+- test/test_helper.rb