imagery 0.0.2 → 0.0.3

data/README.markdown

@@ -99,14 +99,21 @@ Then you may proceed using it.
     # For cases where we want to use S3 for some and normal filesystem for others
     class S3Photo < Imagery::Model
       include Imagery::S3
-      self.s3_bucket = 'my-bucket'
+      s3_bucket 'my-bucket'
     end
 
     # then maybe some other files are using cloudfront
     class CloudfrontPhoto < Imagery::Model
       include Imagery::S3
-      self.s3_bucket = 'my-bucket'
-      self.s3_distribution_domain = 'assets.site.com'
+      s3_bucket 'my-bucket'
+      s3_distribution_domain 'assets.site.com'
+    end
+
+    # some might be using S3 EU, in which case you can specify the s3_host
+    class CustomS3Host < Imagery::Model
+      include Imagery::S3
+      s3_host 'http://my.custom.host'
+      s3_bucket 'my-bucket-name'
     end
 
 3. Flexibility and Extensibility
@@ -133,7 +140,7 @@ Now you can just start using it:
 
     class Imagery::Model
       include Imagery::S3
-      self.s3_bucket = 'my-bucket'
+      s3_bucket 'my-bucket'
     end
 
     i = Imagery.new(Photo.new(1001))

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/imagery.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{imagery}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cyril David"]
-  s.date = %q{2010-05-31}
+  s.date = %q{2010-06-07}
   s.description = %q{Uses ImageMagick directly underneath. Nuff said.}
   s.email = %q{cyx.ucron@gmail.com}
   s.extra_rdoc_files = [
@@ -26,12 +26,14 @@ Gem::Specification.new do |s|
      "imagery.gemspec",
      "lib/imagery.rb",
      "lib/imagery/faking.rb",
+     "lib/imagery/missing.rb",
      "lib/imagery/model.rb",
      "lib/imagery/s3.rb",
      "lib/imagery/test.rb",
      "test/fixtures/lake.jpg",
      "test/helper.rb",
      "test/test_imagery.rb",
+     "test/test_missing.rb",
      "test/test_with_s3.rb"
   ]
   s.homepage = %q{http://github.com/sinefunc/imagery}
@@ -42,6 +44,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/helper.rb",
      "test/test_imagery.rb",
+     "test/test_missing.rb",
      "test/test_with_s3.rb"
   ]
 

data/lib/imagery.rb

@@ -2,12 +2,13 @@ require 'escape'
 require 'fileutils'
 
 module Imagery
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
   
-  autoload :Model,  "imagery/model"
-  autoload :Faking, "imagery/faking"
-  autoload :S3,     "imagery/s3"
-  autoload :Test,   "imagery/test"
+  autoload :Model,   "imagery/model"
+  autoload :Faking,  "imagery/faking"
+  autoload :S3,      "imagery/s3"
+  autoload :Missing, "imagery/missing"
+  autoload :Test,    "imagery/test"
   
   # Syntactic sugar for Imagery::Model::new
   # @see Imagery::Model#initialize for details

data/lib/imagery/faking.rb

@@ -33,5 +33,11 @@ module Imagery
 
       super
     end
+
+    def delete
+      return true if self.class.mode == :fake
+
+      super
+    end
   end
 end

data/lib/imagery/missing.rb

@@ -0,0 +1,19 @@
+module Imagery
+  module Missing
+    def existing=(existing)
+      @existing = existing
+    end
+
+    def existing
+      @existing
+    end
+
+    def url(size = self.default_size)
+      if existing.to_s.empty?
+        return ['', 'missing', namespace, filename(size)].join('/')
+      else
+        super
+      end
+    end
+  end
+end

data/lib/imagery/model.rb

@@ -1,6 +1,7 @@
 module Imagery
   class Model 
-    UnknownSize = Class.new(StandardError)
+    UnknownSize   = Class.new(StandardError)
+    UndefinedRoot = Class.new(StandardError)
   
     @@directory = 'public/system'
     @@default   = { :original => ["1920x1200>"] }
@@ -90,31 +91,47 @@ module Imagery
 
       root_path(directory, namespace, key, filename(size))
     end
-
-    # Gives the absolute URI path for use in a web context.
+ 
+    # The Web module is basically here to let plugins override
+    # the url as they see fit.
     #
-    #   Photo = Class.new(Struct.new(:id))
-    #   i = Imagery.new(Photo.new(1001))
-    #   i.url(:original) == '/system/photo/1001/original.png
-    #   # => true
-    #
-    #   i.file(:thumb)
-    #   # raise Imagery::Model::UnknownSize
-    #
-    #   i.sizes = { :thumb => ["100x100"] }
-    #   i.file(:thumb) == '/system/photo/1001/thumb.png
-    #   # => true
+    # @example
+    #   module FunkyUrls
+    #     def url(size = default_size)
+    #       super.gsub('/system', '/funky')
+    #     end
+    #   end
     #
-    # @param [Symbol] size the size specific url.
-    # @raise [UnknownSize] if the size is not found in 
-    #                      Imagery::Model#sizes.
-    # @return [String] the absolute URI path of the size specific url e.g.
-    #                  /system/photo/1/thumb.png
-    #                  where photo is the namespace and 1 is the key.
-    def url(size = self.default_size)
-      file(size).split('public').last
+    #   class Imagery::Model
+    #     include FunkyUrls
+    #   end
+    module Web
+      # Gives the absolute URI path for use in a web context.
+      #
+      #   Photo = Class.new(Struct.new(:id))
+      #   i = Imagery.new(Photo.new(1001))
+      #   i.url(:original) == '/system/photo/1001/original.png
+      #   # => true
+      #
+      #   i.file(:thumb)
+      #   # raise Imagery::Model::UnknownSize
+      #
+      #   i.sizes = { :thumb => ["100x100"] }
+      #   i.file(:thumb) == '/system/photo/1001/thumb.png
+      #   # => true
+      #
+      # @param [Symbol] size the size specific url.
+      # @raise [UnknownSize] if the size is not found in 
+      #                      Imagery::Model#sizes.
+      # @return [String] the absolute URI path of the size specific url e.g.
+      #                  /system/photo/1/thumb.png
+      #                  where photo is the namespace and 1 is the key.
+      def url(size = self.default_size)
+        file(size).split('public').last
+      end
     end
-    
+    include Web
+      
     # This module is basically here so that plugins like Imagery::S3
     # can override #save and #delete and call super.
     module Persistence
@@ -190,7 +207,7 @@ module Imagery
     
     def root(root = defined?(ROOT_DIR) && ROOT_DIR)
       @root ||= root if root
-      @root
+      @root || raise(UndefinedRoot, "You must define Imagery::Model#root or have a ROOT_DIR constant present")
     end
    
     def root_path(*args)

data/lib/imagery/s3.rb

@@ -3,13 +3,49 @@ require 'aws/s3'
 module Imagery
   module S3
     def self.included(base)
+      base.extend Configs
       class << base
-        attr_accessor :s3_bucket, :s3_distribution_domain
+        attr_writer :s3_bucket, :s3_distribution_domain, :s3_host
       end
     end
-    
-    S3_HOST = "http://s3.amazonaws.com"
+
+    module Configs
+      def s3_bucket(bucket = nil)
+        @s3_bucket = bucket  if bucket
+        @s3_bucket || raise(UndefinedBucket, BUCKET_ERROR_MSG)
+      end
+
+      BUCKET_ERROR_MSG = (<<-MSG).gsub(/^ {6}/, '')
+
+      You need to define a bucket name. Example:
+
+      class Imagery::Model
+        include Imagery::S3
+
+        s3_bucket 'my-bucket-name'
+      end
+      MSG
+
+      def s3_distribution_domain(domain = nil)
+        @s3_distribution_domain = domain  if domain
+        @s3_distribution_domain
+      end
   
+      # Allows you to customize the S3 host. Usually happens when you use
+      # amazon S3 EU.
+      #
+      # @param [String] host the custom host you want to use instead.
+      # @return [String] the s3 host currently set.
+      def s3_host(host = nil)
+        @s3_host = host  if host
+        @s3_host || S3_HOST
+      end
+    end
+  
+    UndefinedBucket = Class.new(StandardError)
+
+    S3_HOST = "http://s3.amazonaws.com"
+
     # Returns a url publicly accessible. If a distribution domain is set,
     # then the url will be based on that.
     #
@@ -18,7 +54,7 @@ module Imagery
     #   class Imagery::Model
     #     include Imagery::S3
     #
-    #     self.s3_bucket = 'bucket-name'
+    #     s3_bucket 'bucket-name'
     #   end
     #   
     #   Photo = Class.new(Struct.new(:id))
@@ -36,13 +72,13 @@ module Imagery
     #
     #   class CloudFront < Imagery::Model
     #     include Imagery::S3
-    #     self.s3_bucket = 'cloudfront'
-    #     self.s3_distribution_domain = 'assets.site.com'
+    #     s3_bucket 'cloudfront'
+    #     s3_distribution_domain 'assets.site.com'
     #   end
     #
     #   class RegularS3 < Imagery::Model
     #     include Imagery::S3
-    #     self.s3_bucket = 'cloudfront'
+    #     s3_bucket 'cloudfront'
     #   end
     #
     # @param [Symbol] size the preferred size you want for the url.
@@ -51,7 +87,7 @@ module Imagery
       if domain = self.class.s3_distribution_domain
         [domain, namespace, key, filename(size)].join('/')
       else
-        [S3_HOST, self.class.s3_bucket, namespace, key, filename(size)].join('/')
+        [self.class.s3_host, self.class.s3_bucket, namespace, key, filename(size)].join('/')
       end
     end
 

data/test/test_imagery.rb

@@ -16,6 +16,14 @@ class TestImagery < Test::Unit::TestCase
     assert_equal '1001', Imagery.new(Photo.new(1001)).key
   end
 
+  test "root_path when root not defined" do
+    imagery = Imagery.new(Photo.new(1001))
+    
+    assert_raise Imagery::Model::UndefinedRoot do
+      imagery.file
+    end
+  end
+
   test "root_path when no ROOT_DIR" do
     imagery = Imagery.new(Photo.new(1001))
     imagery.root = '/'
@@ -119,7 +127,7 @@ class TestImagery < Test::Unit::TestCase
 
     test "when mode == :fake" do
       time = Benchmark.realtime { 
-        Imagery.faked { 
+        Imagery::Model.faked { 
           assert @imagery.save(File.open(FIXTURES + '/lake.jpg'))
         }
       }

data/test/test_missing.rb

@@ -0,0 +1,30 @@
+require "helper"
+
+class MissingTest < Test::Unit::TestCase
+  Photo = Class.new(Struct.new(:id))
+
+  test "adding it using extend" do
+    imagery = Imagery.new(Photo.new(1001))
+    imagery.extend Imagery::Missing
+    imagery.existing = ""
+    assert_equal '/missing/photo/original.png', imagery.url
+  end
+  
+  class WithMissing < Imagery::Model
+    include Imagery::Missing
+  end
+
+  test "adding it using include" do
+    imagery = WithMissing.new(Photo.new(1001))
+    imagery.existing = ""
+
+    assert_equal '/missing/photo/original.png', imagery.url
+  end
+
+  test "still returns as normal when not missing" do
+    imagery = WithMissing.new(Photo.new(1001))
+    imagery.root = '/tmp'
+    imagery.existing = 'lake.jpg'
+    assert_equal '/system/photo/1001/original.png', imagery.url
+  end
+end

data/test/test_with_s3.rb

@@ -5,12 +5,26 @@ class WithS3Test < Test::Unit::TestCase
     include Imagery::Faking
     include Imagery::S3
 
-    self.s3_bucket = "tmp-bucket-name"
+    s3_bucket "tmp-bucket-name"
   end
 
+  class NoBucket < Imagery::Model
+    include Imagery::Faking
+    include Imagery::S3
+  end
+
+  class WithS3CustomHost < Imagery::Model
+    include Imagery::Faking
+    include Imagery::S3
+
+    s3_bucket "tmp-bucket-name"
+    s3_host   "http://test.host"
+  end
+
+
   SuperSecretPhoto = Class.new(Struct.new(:id))
   
-  test "urls" do
+  test "default urls" do
     imagery = WithS3.new(SuperSecretPhoto.new(1001))
     imagery.root = '/tmp'
     imagery.sizes = {
@@ -28,6 +42,43 @@ class WithS3Test < Test::Unit::TestCase
     assert_equal s % 'large', imagery.url(:large)
   end
 
+  test "customized s3_host urls" do
+    imagery = WithS3CustomHost.new(SuperSecretPhoto.new(1001))
+    imagery.root = '/tmp'
+    imagery.sizes = {
+      :thumb => ["56x56^"],
+      :small => ["100x100^", "100x100"],
+      :large => ["200x200>", "200x200"]
+    }
+    
+    s = 'http://test.host/tmp-bucket-name/supersecretphoto/1001/%s.png'
+
+    assert_equal s % 'original', imagery.url
+    assert_equal s % 'original', imagery.url(:original)
+    assert_equal s % 'thumb', imagery.url(:thumb)
+    assert_equal s % 'small', imagery.url(:small)
+    assert_equal s % 'large', imagery.url(:large)
+  end
+
+  test "url when no bucket" do
+    imagery = NoBucket.new(SuperSecretPhoto.new(1001))
+    imagery.sizes = {
+      :thumb => ["56x56^"],
+      :small => ["100x100^", "100x100"],
+      :large => ["200x200>", "200x200"]
+    }
+
+    assert_raise Imagery::S3::UndefinedBucket do
+      imagery.url 
+    end
+
+    begin
+      imagery.url
+    rescue Imagery::S3::UndefinedBucket => e
+      assert_equal Imagery::S3::Configs::BUCKET_ERROR_MSG, e.message
+    end
+  end
+
   test "urls with a distribution domain" do
     imagery = WithS3.new(SuperSecretPhoto.new(1001))
     imagery.root = '/tmp'
@@ -39,7 +90,7 @@ class WithS3Test < Test::Unit::TestCase
     
     s = 'http://assets.site.com/supersecretphoto/1001/%s.png'
     
-    WithS3.s3_distribution_domain = 'http://assets.site.com'
+    WithS3.s3_distribution_domain 'http://assets.site.com'
 
     assert_equal s % 'original', imagery.url
     assert_equal s % 'original', imagery.url(:original)

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Cyril David
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-31 00:00:00 +08:00
+date: 2010-06-07 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -84,12 +84,14 @@ files:
 - imagery.gemspec
 - lib/imagery.rb
 - lib/imagery/faking.rb
+- lib/imagery/missing.rb
 - lib/imagery/model.rb
 - lib/imagery/s3.rb
 - lib/imagery/test.rb
 - test/fixtures/lake.jpg
 - test/helper.rb
 - test/test_imagery.rb
+- test/test_missing.rb
 - test/test_with_s3.rb
 has_rdoc: true
 homepage: http://github.com/sinefunc/imagery
@@ -124,4 +126,5 @@ summary: Image resizing without all the bloat
 test_files: 
 - test/helper.rb
 - test/test_imagery.rb
+- test/test_missing.rb
 - test/test_with_s3.rb