mongoid_paperclip_image_dimension 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,17 @@
+source 'http://rubygems.org'
+
+gem 'mongoid', '~> 2.0.0.beta.20'
+gem "mongoid-paperclip", '~> 0.0.3', :require => "mongoid_paperclip"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'database_cleaner'
+  gem 'bson', '~> 1.2.1'
+  gem 'bson_ext', '~> 1.2.1'
+  gem 'rspec', '~> 2.3.0'
+  gem 'yard', '~> 0.6.0'
+  gem 'bundler', '~> 1.0.0'
+  gem 'jeweler', '~> 1.5.2'
+  gem 'rcov', '>= 0'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Aaron Qian
+
+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,82 @@
+= mongoid_paperclip_image_dimension
+
+This is a simple gem to persist image dimensions of originals and thumbnails for mongoid documents.
+It works for both s3 and filesystem storages.
+This lib is based on this article: http://stackoverflow.com/questions/4065295/paperclip-saving-the-images-dimentions-width-height
+
+== Installation
+
+You can simply install from rubygems:
+
+  gem install mongoid_paperclip_image_dimension
+
+or in Gemfile:
+
+  gem 'mongoid_paperclip_image_dimension'
+  
+== Basic Usage
+
+  class Post
+    include Mongoid::Document
+    include Mongoid::Paperclip
+    include Mongoid::Paperclip::ImageDimension
+    
+    has_mongoid_attached_file :image, :styles => {
+      :large    =>    ['350x350>',     :jpg],
+      :medium   =>    ['150x150>',     :jpg],
+      :small    =>    ['30x30>',       :jpg]
+    }
+    
+    has_mongoid_attached_file :some_other_image, :styles => {
+      :large    =>    ['350x350>',     :jpg],
+      :medium   =>    ['150x150>',     :jpg],
+      :small    =>    ['30x30>',       :jpg]
+    }
+    
+    # This will save all dimensions of images and thumbnails for both :image and :another_image
+    save_image_dimensions_on :image, :another_image
+  end
+  
+  # retrieve image dimensions
+  p = Post.first
+  p.image_dimensions    # If the original image has width of 2048 and height of 1024, the output should be:
+                        #   {
+                        #     'original' => [2048, 1024],
+                        #     'large'    => [350, 175],
+                        #     'medium'   => [150, 75],
+                        #     'small'    => [30, 15]
+                        #   }
+                        
+  p.another_image_dimensions    # If the original image has width of 2048 and height of 1024, the output should be:
+                                #   {
+                                #     'original' => [2048, 1024],
+                                #     'large'    => [350, 175],
+                                #     'medium'   => [150, 75],
+                                #     'small'    => [30, 15]
+                                #   }
+  }
+  
+  # some sugar:
+  p.image_dimension               # [2048, 1024]
+  p.image_dimension(:original)    # [2048, 1024]
+  p.image_dimension(:large)       # [350, 175]
+  
+  p.image_dimension_str             # "2048x1024"
+  p.image_dimension_str(:original)  # "2048x1024"
+  p.image_dimension_str(:large)     # "350x175"
+
+== Contributing to mongoid_paperclip_image_dimension
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Aaron Qian. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "mongoid_paperclip_image_dimension"
+  gem.homepage = "http://github.com/aq1018/mongoid_paperclip_image_dimension"
+  gem.license = "MIT"
+  gem.summary = %Q{A simple plugin to persist image dimensions into mongoid document.}
+  gem.description = %Q{A simple plugin to persist image dimensions into mongoid document.}
+  gem.email = "aq1018@gmail.com"
+  gem.authors = ["Aaron Qian"]
+  
+  # this directory is generated by running the test, and should be ignored...
+  gem.files.exclude 'public'
+
+  gem.add_runtime_dependency 'mongoid', '~> 2.0.0.beta.20'
+  gem.add_runtime_dependency 'mongoid-paperclip', '~> 0.0.3' 
+  gem.add_development_dependency 'database_cleaner'
+  gem.add_development_dependency 'bson', '~> 1.2.1'
+  gem.add_development_dependency 'bson_ext', '~> 1.2.1'
+  gem.add_development_dependency 'rspec', '~> 2.3.0'
+  gem.add_development_dependency 'yard', '~> 0.6.0'
+  gem.add_development_dependency 'bundler', '~> 1.0.0'
+  gem.add_development_dependency 'jeweler', '~> 1.5.2'
+  gem.add_development_dependency 'rcov', '>= 0'
+end
+
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.rspec_opts = "--color --format progress"
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+  spec.rcov_opts = "--exclude ~\/.rvm,spec"
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/mongoid_paperclip_image_dimension.rb

@@ -0,0 +1,47 @@
+require 'active_support/concern'
+
+module Mongoid::Paperclip::ImageDimension
+  extend ActiveSupport::Concern
+  
+  included do
+    class_inheritable_reader :perperclip_image_dimension_fields
+    write_inheritable_attribute(:perperclip_image_dimension_fields, [])
+  end
+  
+  module ClassMethods
+    def save_image_dimensions_on(*args)
+      args.flatten.each do |attachment_field|
+        attachment_field = attachment_field.to_sym
+        dimension_field_name = "#{attachment_field}_dimensions".to_sym
+        perperclip_image_dimension_fields << attachment_field
+        field dimension_field_name, :type => Hash
+        
+        class_eval <<-END
+          def #{attachment_field}_dimension(style=:original)
+            #{attachment_field}_dimensions[style.to_s].map(&:to_i)
+          end
+          
+          def #{attachment_field}_dimension_str(style=:original)
+            #{attachment_field}_dimension(style).join('x')
+          end
+          
+          after_#{attachment_field}_post_process do
+            save_dimensions_for(:"#{attachment_field}")
+          end
+        END
+         
+      end
+    end
+  end
+  
+  def save_dimensions_for(attachment_field)
+    styles = self.class.attachment_definitions[attachment_field][:styles].keys + [:original]
+    dimension_hash = {}
+    styles.each do |style|
+      attachment = self.send attachment_field
+      geo = Paperclip::Geometry.from_file(attachment.queued_for_write[style])
+      dimension_hash[style] = [ geo.width.to_i, geo.height.to_i ]
+    end
+    self.send "#{attachment_field}_dimensions=", dimension_hash
+  end
+end

data/spec/mongoid_paperclip_image_dimension_spec.rb

@@ -0,0 +1,77 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+# mocking Rails.root & Rails.env used in Paperclip::Interploration
+module Rails
+  def self.root
+    File.dirname(__FILE__) + "/.."
+  end
+  
+  def self.env
+    "test"
+  end
+end
+
+class Post
+  include Mongoid::Document
+  include Mongoid::Paperclip
+  include Mongoid::Paperclip::ImageDimension
+  
+  has_mongoid_attached_file :image, :styles => {
+    :large    =>    ['350x350>',     :jpg],
+    :medium   =>    ['150x150>',     :jpg],
+    :small    =>    ['30x30>',       :jpg]
+  }
+  
+  has_mongoid_attached_file :another_image, :styles => {
+    :large    =>    ['350x350>',     :jpg],
+    :medium   =>    ['150x150>',     :jpg],
+    :small    =>    ['30x30>',       :jpg]
+  }
+  
+  # This will save all dimensions of images and thumbnails for both :image and :another_image
+  save_image_dimensions_on :image, :another_image
+end
+
+describe Mongoid::Paperclip::ImageDimension do
+  before(:each) do
+    @p = Post.create!({
+     :image =>File.open(File.dirname(__FILE__) + '/ruby.png'),
+     :another_image => File.open(File.dirname(__FILE__) + '/ruby.png')
+    })
+    @p.reload
+  end
+  
+  it "should save dimensions" do
+    @p.image_dimensions.should_not be_nil
+    @p.another_image_dimensions.should_not be_nil
+  end
+  
+  it "should retreive dimensions correctly" do
+    @p.image_dimension.should == [995, 996]
+    @p.image_dimension(:original).should == [995, 996]
+    @p.image_dimension(:large).should == [350, 350]
+    @p.image_dimension(:medium).should == [150, 150]
+    @p.image_dimension(:small).should == [30, 30]
+    
+    @p.another_image_dimension.should == [995, 996]
+    @p.another_image_dimension(:original).should == [995, 996]
+    @p.another_image_dimension(:large).should == [350, 350]
+    @p.another_image_dimension(:medium).should == [150, 150]
+    @p.another_image_dimension(:small).should == [30, 30]
+  end
+
+  it "should retreive dimension strings correctly" do
+    @p.image_dimension_str.should == "995x996"
+    @p.image_dimension_str(:original).should == "995x996"
+    @p.image_dimension_str(:large).should == "350x350"
+    @p.image_dimension_str(:medium).should == "150x150"
+    @p.image_dimension_str(:small).should == "30x30"
+    
+    @p.another_image_dimension_str.should == "995x996"
+    @p.another_image_dimension_str(:original).should == "995x996"
+    @p.another_image_dimension_str(:large).should == "350x350"
+    @p.another_image_dimension_str(:medium).should == "150x150"
+    @p.another_image_dimension_str(:small).should == "30x30"
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'mongoid'
+require 'mongoid_paperclip'
+require 'mongoid_paperclip_image_dimension'
+require 'database_cleaner'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db("mongoid_paperclip_image_dimension_test")
+end

metadata

@@ -0,0 +1,394 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid_paperclip_image_dimension
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Aaron Qian
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-13 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 62196427
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 20
+        version: 2.0.0.beta.20
+  name: mongoid
+  version_requirements: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 0
+        - 3
+        version: 0.0.3
+  name: mongoid-paperclip
+  version_requirements: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: database_cleaner
+  version_requirements: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 2
+        - 1
+        version: 1.2.1
+  name: bson
+  version_requirements: *id004
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 2
+        - 1
+        version: 1.2.1
+  name: bson_ext
+  version_requirements: *id005
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  name: rspec
+  version_requirements: *id006
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  name: yard
+  version_requirements: *id007
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id008
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  version_requirements: *id009
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id010
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 62196427
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 20
+        version: 2.0.0.beta.20
+  name: mongoid
+  version_requirements: *id011
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 0
+        - 3
+        version: 0.0.3
+  name: mongoid-paperclip
+  version_requirements: *id012
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: database_cleaner
+  version_requirements: *id013
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id014 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 2
+        - 1
+        version: 1.2.1
+  name: bson
+  version_requirements: *id014
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id015 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 2
+        - 1
+        version: 1.2.1
+  name: bson_ext
+  version_requirements: *id015
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id016 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  name: rspec
+  version_requirements: *id016
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id017 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  name: yard
+  version_requirements: *id017
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id018 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id018
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id019 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  version_requirements: *id019
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id020 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id020
+  prerelease: false
+description: A simple plugin to persist image dimensions into mongoid document.
+email: aq1018@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/mongoid_paperclip_image_dimension.rb
+- spec/mongoid_paperclip_image_dimension_spec.rb
+- spec/ruby.png
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/aq1018/mongoid_paperclip_image_dimension
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: A simple plugin to persist image dimensions into mongoid document.
+test_files: 
+- spec/mongoid_paperclip_image_dimension_spec.rb
+- spec/spec_helper.rb