imagery 1.0.0.rc1 → 1.0.0.rc2

data/imagery.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = "imagery"
-  s.version           = "1.0.0.rc1"
+  s.version           = "1.0.0.rc2"
   s.summary           = "POROS + GraphicsMagick."
   s.description       = "Clean & light interface around GraphicsMagick."
   s.authors           = ["Cyril David"]

data/lib/imagery.rb

@@ -13,7 +13,7 @@ class Imagery
   attr :prefix
 
   # A unique id for the image.
-  attr :key
+  attr :id
 
   # A hash of name => tuple pairs. The name describes the size, e.g. `small`.
   #
@@ -32,9 +32,9 @@ class Imagery
   # are placed in the `Core` module. Imagery::S3 demonstrates overriding
   # in action.
   module Core
-    def initialize(prefix, key = nil, sizes = {})
+    def initialize(prefix, id = nil, sizes = {})
       @prefix   = prefix.to_s
-      @key      = key.to_s
+      @id       = id.to_s if id
       @sizes    = sizes
       @original = :original      # Used as the filename for the raw image.
       @ext      = :jpg           # We default to jpg for the image format.
@@ -42,16 +42,16 @@ class Imagery
 
     # Returns the url for a given size, which defaults to `:original`.
     #
-    # If the key is nil, a missing path is returned.
+    # If the id is nil, a missing path is returned.
     def url(file = @original)
-      return "/missing/#{prefix}/#{ext(file)}" if key.to_s.empty?
+      return "/missing/#{prefix}/#{ext(file)}" if id.to_s.empty?
 
-      "/#{prefix}/#{key}/#{ext(file)}"
+      "/#{prefix}/#{id}/#{ext(file)}"
     end
 
     # Accepts an `IO` object, typically taken from an input[type=file].
     #
-    # The second optional `key` argument is used when you want to force
+    # The second optional `id` argument is used when you want to force
     # a new resource, useful in conjunction with cloudfront / high cache
     # scenarios where updating an existing image won't suffice.
     #
@@ -68,17 +68,18 @@ class Imagery
     #     { original: im.url, thumb: im.url(:thumb) }.to_json
     #   end
     #
-    def save(io, key = nil)
+    def save(io, id = nil)
       GM.identify(io) or raise(InvalidImage)
 
       # We delete the existing object iff:
-      # 1. A key was passed
-      # 2. The key passed is different from the existing key.
-      delete if key && key != self.key
+      # 1. An id was passed
+      # 2. We have an existing id already.
+      # 3. The id passed is different from the existing id.
+      delete if id && self.id && id != self.id
 
-      # Now we can assign the new key passed, with the assurance that the
-      # old key has been deleted and won't be used anymore.
-      @key = key.to_s if key
+      # Now we can assign the new id passed, with the assurance that the
+      # old id has been deleted and won't be used anymore.
+      @id = id.to_s if id
 
       # Ensure that the path to all images is created.
       FileUtils.mkdir_p(root)
@@ -95,8 +96,10 @@ class Imagery
     end
 
     # A very simple and destructive method. Deletes the entire folder
-    # for the current prefix/key combination.
+    # for the current prefix/id combination.
     def delete
+      return if not id
+
       FileUtils.rm_rf(root)
     end
   end
@@ -109,7 +112,7 @@ class Imagery
   end
 
   def root(*args)
-    self.class.root(prefix, key, *args)
+    self.class.root(prefix, id, *args)
   end
 
   def self.root(*args)

data/lib/imagery/s3.rb

@@ -4,7 +4,7 @@ class Imagery
   module S3
     def self.included(imagery)
       imagery.extend Config
-  
+
       # Set the default host for amazon S3. You can also set this
       # to https://s3.amazon.com if you want to force secure connections
       # on a global scale.
@@ -36,7 +36,7 @@ class Imagery
 
       @keys = [@original] + sizes.keys
     end
-    
+
     # If you specify a distribution domain (i.e. a cloudfront domain,
     # or even an S3 domain with a prefix), that distribution domain is
     # used.
@@ -49,8 +49,8 @@ class Imagery
         "#{self.class.s3_host}/#{self.class.s3_bucket}#{super}"
       end
     end
-  
-    # Returns the complete S3 key used for this object. The S3 key
+
+    # Returns the complete S3 id used for this object. The S3 id
     # is simply composed of the prefix and filename, e.g.
     #
     # - photos/1001/original.jpg
@@ -58,9 +58,9 @@ class Imagery
     # - photos/1001/tiny.jpg
     #
     def s3_key(file)
-      "#{prefix}/#{key}/#{ext(file)}"
+      "#{prefix}/#{id}/#{ext(file)}"
     end
-  
+
     # Deletes all keys defined for this object, which includes `:original`
     # and all keys in `sizes`.
     def delete
@@ -70,11 +70,11 @@ class Imagery
         Gateway.delete(s3_key(file), self.class.s3_bucket)
       end
     end
-  
+
     # Save the object as we normall would, but also upload all resulting
     # files to S3. We set the proper content type and Cache-Control setting
     # optimized for a cloudfront setup.
-    def save(io, key = nil)
+    def save(io, id = nil)
       super
 
       keys.each do |file|
@@ -87,18 +87,18 @@ class Imagery
         )
       end
     end
-  
+
     # Provides a convenience wrapper around AWS::S3::S3Object and
     # serves as an auto-connect module.
     module Gateway
       def self.store(*args)
         execute(:store, *args)
       end
-      
+
       def self.delete(*args)
         execute(:delete, *args)
       end
-    
+
     private
       def self.execute(command, *args)
         begin

data/tests/imagery.rb

@@ -6,18 +6,18 @@ test "defining with a prefix" do
   assert_equal "avatar", i.prefix
 end
 
-test "defining with a key" do
+test "defining with a id" do
   i = Imagery.new(:avatar, "1001")
 
   assert_equal "avatar", i.prefix
-  assert_equal "1001", i.key
+  assert_equal "1001", i.id
 end
 
 test "defining with sizes" do
   i = Imagery.new(:avatar, "1001", small: ["100x100"])
 
   assert_equal "avatar", i.prefix
-  assert_equal "1001", i.key
+  assert_equal "1001", i.id
   assert_equal({ small: ["100x100"] }, i.sizes)
 end
 
@@ -41,18 +41,18 @@ test "allows override of the default Dir.pwd" do
   end
 end
 
-test "url when missing key" do
+test "url when missing id" do
   i = Imagery.new(:avatar)
 
   assert_equal "/missing/avatar/original.jpg", i.url
 end
 
-test "url with a key" do
+test "url with a id" do
   i = Imagery.new(:avatar, "1001")
   assert_equal "/avatar/1001/original.jpg", i.url
 end
 
-test "url with a key and a file" do
+test "url with a id and a file" do
   i = Imagery.new(:avatar, "1001")
   assert_equal "/avatar/1001/small.jpg", i.url(:small)
 end
@@ -73,7 +73,7 @@ scope do
     assert_equal "1024x768", resolution(im.root("original.jpg"))
   end
 
-  test "saving and specifying the key" do |im, io|
+  test "saving and specifying the id" do |im, io|
     assert im.save(io, "GUID")
     assert File.exist?(Imagery.root("avatar/GUID/original.jpg"))
   end
@@ -173,6 +173,27 @@ scope do
     assert File.exist?(s)
   end
 
+  test "no deletion when existing id is nil" do |_, io|
+    im = Imagery.new(:avatar, nil, small: ["100x100^", "100x100"])
+
+    def im.delete
+      raise RuntimeError
+    end
+
+    begin
+      im.save(io, 1)
+    rescue RuntimeError => ex
+    end
+
+    assert_equal nil, ex
+  end
+
+  test "deletion not possible when id is nil" do |_, io|
+    im = Imagery.new(:avatar, nil, small: ["100x100^", "100x100"])
+
+    assert_equal nil, im.delete
+  end
+
   test "inherting imagery" do |im, io|
     class Photo < Imagery
     end

data/tests/s3.rb

@@ -78,7 +78,7 @@ scope do
     assert cmds.empty?
   end
 
-  test "doesn't delete when passing same key" do |im, io|
+  test "doesn't delete when passing same id" do |im, io|
     im.save(io, "1001")
   
     cmds = Imagery::S3::Gateway.commands
@@ -90,7 +90,7 @@ scope do
     assert cmds.empty?
   end
 
-  test "deletes when passing a different key" do |im, io|
+  test "deletes when passing a different id" do |im, io|
     im.save(io, "1002")
   
     cmds = Imagery::S3::Gateway.commands

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imagery
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0.rc2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-03 00:00:00.000000000 Z
+date: 2012-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cutest