imagery 1.0.0.rc2 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 617d676eaacd1c4f9d90ef5f091c133be23b7046
+  data.tar.gz: 73c33e7af9d03b6c049d8821e01630bc788a694d
+SHA512:
+  metadata.gz: 8803b9dab1271092fdcc1a559488796f7e5eaaafd6becb14aad8f72dd6be0e42e19283c00e7831dfd83cbceefac91dc94e2b86590fa6eb34b003205da1663188
+  data.tar.gz: d31402d450fed4979743ede359de64195a68a9be0f5c21a4f6152fdda61b7d6252b08839a2759707f10667fbf462e325b345f90ae41cc02bffda8eb6022e134b

data/README.markdown

@@ -1,211 +1,76 @@
 Imagery
 =======
 
-## Image manipulation should be simple. It should be customizable. It should allow for flexibility. Imagery attempts to solve these.
-
-### Imagery favors:
-
-1. Simplicity and explicitness over magic DSLs.
-2. OOP principles such as inheritance and composition.
-3. Flexibility and extensibility.
-4. Not being tied to any form of ORM.
-
-1. Simplicity and Explicitness
-------------------------------
-To get started using Imagery you only need GraphicsMagick, ruby and Imagery of 
-course.
-    
-    # on debian based systems
-    sudo apt-get install graphicsmagick
-    # or maybe using homebrew
-    brew install graphicsmagick
-    [sudo] gem install imagery
-
-Then you may proceed using it.
-  
-    require 'rubygems'
-    require 'imagery'
-
-    i = Imagery.new(:photo, "1001", thumb: ["48x48^", "48x48"])
-    i.save(File.open('/some/path/to/image.jpg'))
-
-    File.exist?('public/photo/1001/thumb.jpg')
-    # => true
-
-    File.exist?('public/photo/1001/original.jpg')
-    # => true
-
-2. OOP Principles (that we already know)
-----------------------------------------
-
-### Ohm example (See [http://ohm.keyvalue.org](http://ohm.keyvalue.org))
-    
-    class User < Ohm::Model
-      include Ohm::Callbacks
-      
-      after :save, :write_avatar
-
-      def avatar=(fp)
-        @avatar_fp = fp
-      end
-
-      def avatar
-        Imagery.new :avatar, id, 
-          :thumb => ["48x48^", "48x48"],
-          :medium => ["120x120"]
-      end
-
-    protected
-      def write_avatar
-        avatar.save(@avatar_fp[:tempfile]) if @avatar_fp
-      end
-    end
-
-    # Since we're using composition, we can customize the dimensions on an 
-    # instance level.
-    class Collage < Ohm::Model
-      attribute :width
-      attribute :height
-
-      def photo
-        Imagery.new :photo, id, :thumb => ["%sx%s" % [width, height]]
-      end
-    end
-    
-    # For cases where we want to use S3 for some and normal filesystem for others
-    class S3Photo < Imagery
-      include Imagery::S3
-
-      s3_bucket "my-bucket"
-    end
-
-    # then maybe some other files are using cloudfront
-    class CloudfrontPhoto < Imagery
-      include Imagery::S3
-
-      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
---------------------------------
-### Existing plugins: Faking and S3
-
-#### Imagery::S3
-
-As was shown in some examples above you can easily do S3 integration.
-The access credentials are assumed to be stored in
-
-    ENV["AMAZON_ACCESS_KEY_ID"]
-    ENV["AMAZON_SECRET_ACCESS_KEY"]
-
-you can do this by setting it on your .bash_profile / .bashrc or just
-manually setting them somewhere in your appication
-
-    ENV["AMAZON_ACCESS_KEY_ID"] = "_access_key_id_"
-    ENV["AMAZON_SECRET_ACCESS_KEY"] = "_secret_access_key_"
-
-Now you can just start using it:
-  
-    class Imagery
-      include Imagery::S3
-      s3_bucket "my-bucket"
-    end
-
-    i = Imagery.new :photo, 1001
-    i.save(File.open("/some/path/to/image.jpg"))
-
-#### Imagery::Faking
-
-When doing testing, you definitely don't want to run image
-resizing everytime. Enter Faking.
-
-    # in your test_helper / spec_helper
-    Imagery::Model.send :include, Imagery::Faking
-    Imagery::Model.mode = :fake
-  
-    # but what if we want to run it for real on a case to case basis?
-    # sure we can!
-    Imagery::Model.real {
-      # do some imagery testing here
-    }
-
-#### Imagery::Test
-
-There is a module you can include in your test context to automate the pattern
-of testing / faking on an opt-in basis.
-
-    # in your test_helper / spec_helper
-    class Test::Unit::TestCase
-      include Imagery::Test
-    end
-    
-    # now when you do some testing... (User assumes the user example above)
-    imagery do |enabled|
-      user = User.new(:avatar => { tempfile: File.open("avatar.jpg") })
-      user.save
-
-      if enabled
-        assert File.exist?(user.avatar.root("original.jpg"))
-      end
-    end
-
-Running your test suite:
-
-    REAL_IMAGERY=true rake test
-
-It's off by default though, so you don't have to do anything to make sure 
-Imagery doesn't run.
-
-### Extending Imagery
-By making use of standard Ruby idioms, we can easily do lots with it. 
-Exensibility is addressed via Ruby modules for example:
-
-    class Imagery
-      module MogileStore
-        def self.included(base)
-          class << base
-            attr_accessor :mogile_config
-          end
-        end
-
-        def save(io)
-          if super
-            # do some mogie FS stuff here
-          end
-        end
-
-        def delete
-          super
-          # remove the mogile stuff here
-        end
-      end
-    end
-
-    # Now just include the module to use it.
-    class Imagery
-      include Imagery::MogileStore
-      self.mogile_config = { :foo => :bar }
-    end
-
-
-### 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 me a pull request. Bonus points for topic branches.
-
-### Copyright
+Simple image resizing module.
+
+## Prerequisites
+
+You should have graphicsmagick first:
+
+```bash
+# on debian based systems
+$ sudo apt-get install graphicsmagick
+
+# or maybe using homebrew
+$ brew install graphicsmagick
+```
+
+## Installing
+
+```bash
+$ gem install imagery
+```
+
+## Usage
+
+```ruby
+require 'imagery'
+
+# - 48x48^ is the geometry string. This means we're resizing
+#   to a 48x48^ constrained image
+# - 48x48 (second one) means we're cropping the image to an
+#   extent of 48x48 pixels.
+i = Imagery.new(:photo, "1001", thumb: ["48x48^", "48x48"])
+i.save(File.open('/some/path/to/image.jpg'))
+
+File.exist?('public/photo/1001/thumb.jpg')
+# => true
+
+File.exist?('public/photo/1001/original.jpg')
+# => true
+```
+
+## Advanced Usage (S3)
+
+For cases where we want to use S3 for some and normal filesystem for others.
+
+```ruby
+class S3Photo < Imagery
+  include Imagery::S3
+
+  s3_bucket "my-bucket"
+end
+
+# then maybe some other files are using cloudfront
+class CloudfrontPhoto < Imagery
+  include Imagery::S3
+
+  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
+```
+
+## Extending
+
+You can check `Imagery::S3` to see an example of an extension.
+
+## Copyright
 
 Copyright (c) 2010 Cyril David. See LICENSE for details.

data/imagery.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
   s.name              = "imagery"
-  s.version           = "1.0.0.rc2"
-  s.summary           = "POROS + GraphicsMagick."
+  s.version           = "1.0.0"
+  s.summary           = "Simple image resizing"
   s.description       = "Clean & light interface around GraphicsMagick."
   s.authors           = ["Cyril David"]
-  s.email             = ["me@cyrildavid.com"]
+  s.email             = ["cyx@cyx.is"]
   s.homepage          = "http://github.com/cyx/imagery"
 
   s.files = Dir[

data/lib/imagery.rb

@@ -131,8 +131,9 @@ class Imagery
   module GM
     # -size tells GM to only read from a given dimension.
     # -resize is the target dimension, and understands geometry strings.
-    # -quality we force it to 80, which is very reasonable and practical.
-    CONVERT = "gm convert -size '%s' '%s' -resize '%s' %s -quality 80 '%s'"
+    # -quality we force it to 90, which is a bit aggressive, but
+    # we want beautiful photos don't we? :-)
+    CONVERT = "gm convert -size '%s' '%s' -resize '%s' %s -quality 90 '%s'"
 
     # 2 is the file descriptor for stderr, which `gm identify`
     # happily chucks out information to, regardless if the image

data/makefile

@@ -1,2 +1,7 @@
 test:
-	cutest tests/*.rb
+	cutest tests/*_test.rb
+
+tests/%: .PHONY
+	cutest $@
+
+.PHONY:

data/tests/{s3.rb → s3_test.rb}

@@ -20,7 +20,7 @@ end
 
 test "changes url to an S3 hosted one" do
   i = Imagery.new(:avatar)
-  
+
   expect = "http://s3.amazonaws.com/cdn.site.com/missing/avatar/original.jpg"
   assert_equal expect, i.url
 end
@@ -30,7 +30,7 @@ test "allows an s3_host override" do
     Imagery.s3_host "https://foo.com"
 
     i = Imagery.new(:avatar)
-    
+
     expect = "https://foo.com/cdn.site.com/missing/avatar/original.jpg"
     assert_equal expect, i.url
   ensure
@@ -41,7 +41,7 @@ end
 test "allows a distribution domain for cloudfront hosted buckets" do
   begin
     Imagery.s3_distribution_domain "https://cdn.site.com"
-    
+
     i = Imagery.new(:avatar)
     expect = "https://cdn.site.com/missing/avatar/original.jpg"
     assert_equal expect, i.url
@@ -68,7 +68,7 @@ scope do
 
   test "saves all sizes to S3" do |im, io|
     im.save(io)
-  
+
     cmds = Imagery::S3::Gateway.commands
 
     assert_equal [:store, "avatar/1001/original.jpg", "buck"], cmds.shift
@@ -80,7 +80,7 @@ scope do
 
   test "doesn't delete when passing same id" do |im, io|
     im.save(io, "1001")
-  
+
     cmds = Imagery::S3::Gateway.commands
 
     assert_equal [:store, "avatar/1001/original.jpg", "buck"], cmds.shift
@@ -92,7 +92,7 @@ scope do
 
   test "deletes when passing a different id" do |im, io|
     im.save(io, "1002")
-  
+
     cmds = Imagery::S3::Gateway.commands
 
     assert_equal [:delete, "avatar/1001/original.jpg", "buck"], cmds.shift

metadata

@@ -1,51 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: imagery
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc2
-  prerelease: 6
+  version: 1.0.0
 platform: ruby
 authors:
 - Cyril David
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-04 00:00:00.000000000 Z
+date: 2013-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cutest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: aws-s3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Clean & light interface around GraphicsMagick.
 email:
-- me@cyrildavid.com
+- cyx@cyx.is
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -53,37 +48,33 @@ files:
 - LICENSE
 - README.markdown
 - makefile
-- lib/imagery/faking.rb
 - lib/imagery/s3.rb
-- lib/imagery/test.rb
 - lib/imagery.rb
 - imagery.gemspec
-- tests/faking.rb
 - tests/helper.rb
-- tests/imagery.rb
-- tests/s3.rb
+- tests/imagery_test.rb
+- tests/s3_test.rb
 homepage: http://github.com/cyx/imagery
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
-summary: POROS + GraphicsMagick.
+specification_version: 4
+summary: Simple image resizing
 test_files: []

data/lib/imagery/faking.rb

@@ -1,90 +0,0 @@
-class Imagery
-  module Faking
-    def self.included(base)
-      base.extend ClassMethods
-    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
-      ensure
-        @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
-      ensure
-        @mode = @omode
-      end
-    end
-
-    # Implement the stubbed version of save and skips actual operation
-    # if Imagery::Model.mode == :fake
-    def save(io, key = nil)
-      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
-
-      super
-    end
-  end
-end

data/lib/imagery/test.rb

@@ -1,17 +0,0 @@
-class Imagery
-  module Test
-    def self.included(base)
-      Imagery.send :include, Imagery::Faking
-      Imagery.mode = :fake
-    end
-
-  protected
-    def imagery
-      if ENV["REAL_IMAGERY"]
-        Imagery.real { yield true }
-      else
-        Imagery.faked { yield false }
-      end
-    end
-  end
-end

data/tests/faking.rb

@@ -1,71 +0,0 @@
-require File.expand_path("helper", File.dirname(__FILE__))
-require "stringio"
-
-# Imagery::Test hooks
-scope do
-  setup do
-    Object.send :include, Imagery::Test
-  end
-
-  test "auto-includes Imagery::Faking upon inclusion" do
-    assert Imagery.ancestors.include?(Imagery::Faking)
-  end
-
-  test "auto-sets mode to :fake" do
-    assert_equal :fake, Imagery.mode
-  end
-end
-
-
-class Imagery
-  include Faking
-end
-
-test "skips saving when faked" do
-  Imagery.mode = :fake
-
-  i = Imagery.new(:avatar, "1001")
-  i.save(StringIO.new)
-
-  assert ! File.exist?(Imagery.root("avatar", "1001"))
-end
-
-test "skips deleting when faked" do
-  Imagery.mode = :fake
-  
-  FileUtils.mkdir_p(Imagery.root("avatar", "1001"))
-
-  i = Imagery.new(:avatar, "1001")
-  i.delete
-
-  assert File.exist?(Imagery.root("avatar", "1001"))
-end
-
-# Imagery::Test
-scope do
-  extend Imagery::Test
-
-  test "yields true when REAL_IMAGERY is set" do
-    ENV["REAL_IMAGERY"] = "true"
-  
-    enabled = nil
-
-    imagery do |e|
-      enabled = e  
-    end
-
-    assert enabled
-  end
-
-  test "yields false when REAL_IMAGERY is not set" do
-    ENV["REAL_IMAGERY"] = nil
-  
-    enabled = nil
-
-    imagery do |e|
-      enabled = e  
-    end
-
-    assert_equal false, enabled
-  end
-end