imagery 0.0.5 → 0.0.6

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/imagery.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{imagery}
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cyril David"]
-  s.date = %q{2010-06-30}
+  s.date = %q{2010-07-06}
   s.description = %q{Uses ImageMagick directly underneath. Nuff said.}
   s.email = %q{cyx.ucron@gmail.com}
   s.extra_rdoc_files = [

data/lib/imagery.rb

@@ -2,7 +2,7 @@ require 'escape'
 require 'fileutils'
 
 module Imagery
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
   
   autoload :Model,   "imagery/model"
   autoload :Faking,  "imagery/faking"

data/lib/imagery/faking.rb

@@ -3,16 +3,41 @@ module Imagery
     def self.included(base)
       base.extend ClassMethods
     end
-      
-    module ClassMethods
-      def mode=(mode)
-        @mode = mode
-      end
 
-      def mode
-        @mode
-      end
+    module ClassMethods
+      # Allows you to define the current mode. The only special value here is
+      # `:fake`. If the mode is :fake, then Imagery::Model#save and
+      # Imagery::Model#delete will not actually run.
+      #
+      # @example
+      #
+      #   Photo = Class.new(Struct.new(:id))
+      #
+      #   i = Imagery.new(Photo.new(1001))
+      #   i.root = '/tmp'
+      #
+      #   Imagery::Model.faked {
+      #     assert i.save(File.open('/path/to/image.png'))
+      #   }
+      #
+      # @see Imagery::Test
+      #
+      attr_accessor :mode
 
+      # Switches the current mode to :fake.
+      #
+      # @example
+      #   Imagery::Model.mode == nil
+      #   # => true
+      #
+      #   Imagery::Model.faked {
+      #     Imagery::Model.mode == :fake
+      #     # => true
+      #   }
+      #
+      #   Imagery::Model.mode = nil
+      #   # => true
+      #
       def faked
         @omode, @mode = @mode, :fake
         yield
@@ -20,6 +45,24 @@ module Imagery
         @mode = @omode
       end
 
+      # Switches the current mode to nil. Useful for forcing real saves
+      # in your test.
+      #
+      # You should do this at least once in your project just to know
+      # that all your Imagery::Model#save and Imagery::Model#delete
+      # operations actually work.
+      #
+      # @example
+      #   Imagery::Model.mode = :fake
+      #
+      #   Imagery::Model.faked {
+      #     Imagery::Model.mode == nil
+      #     # => true
+      #   }
+      #
+      #   Imagery::Model.mode = :fake
+      #   # => true
+      #
       def real
         @omode, @mode = @mode, nil
         yield
@@ -28,12 +71,16 @@ module Imagery
       end
     end
 
+    # Implement the stubbed version of save and skips actual operation
+    # if Imagery::Model.mode == :fake
     def save(io)
       return true if self.class.mode == :fake
 
       super
     end
 
+    # Implement the stubbed version of save and skips actual operation
+    # if Imagery::Model.mode == :fake
     def delete
       return true if self.class.mode == :fake
 

data/lib/imagery/missing.rb

@@ -1,12 +1,23 @@
 module Imagery
   module Missing
-    def existing=(existing)
-      @existing = existing
-    end
-
-    def existing
-      @existing
-    end
+    # Allows you to set the current filename of your photo.
+    # Much of Imagery::Missing is hinged on this.
+    #
+    # @example
+    #
+    #   Photo = Class.new(Struct.new(:id))
+    #   i = Imagery::Model.new(Photo.new(1001))
+    #   i.extend Imagery::Missing
+    #   i.url == "/photo/1001/original.png"
+    #   # => true
+    #
+    #   i.existing = "Filename"
+    #   i.url == "/missing/photo/original.png"
+    #   # => true
+    #
+    # @see Imagery::Missing#url
+    #
+    attr_accessor :existing
 
     def url(size = self.default_size)
       if existing.to_s.empty?

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Cyril David
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-30 00:00:00 +08:00
+date: 2010-07-06 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency