paperclip-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,14 @@
+source 'http://rubygems.org'
+
+gem "paperclip", '>= 2.4'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'activerecord'
+  gem 'sqlite3'
+  gem 'rspec'
+  gem 'yard'
+  gem 'bundler'
+  gem 'jeweler'
+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.md

@@ -0,0 +1,132 @@
+paperclip-dimension
+===================
+
+This gem is the improved version of `mongoid_paperclip_image_dimension` that is ORM agnostic.
+If you are using `mongoid_paperclip_image_dimension`, you should upgrade to this gem.
+
+This is a simple gem to persist image dimensions of originals and thumbnails.
+It works for both s3 and filesystem storages.
+This lib is based on [this stackoverflow.com article](http://stackoverflow.com/questions/4065295/paperclip-saving-the-images-dimentions-width-height).
+
+Install
+-------
+
+You can simply install from rubygems:
+
+```ruby
+gem install paperclip-dimension
+require 'paperclip-dimension'
+```
+
+or in Gemfile:
+
+```ruby
+  gem 'paperclip-dimension'
+```
+
+Setup
+-----
+
+You need to make sure the following is in place:
+
+* `Paperclip::Glue` is included in your model.
+* `<attachment>_dimensions` attribute is requried to operate.
+
+
+**Rails & ActiveRecord Migration**
+
+`paperclip` gives you the ability to create migrations with `has_attached_file`.
+For example:
+
+```ruby
+class CreatePosts < ActiveRecord::Migration
+  def up
+    create_table :posts do |t|
+      t.has_attached_file :image
+    end
+  end
+end
+```
+
+This creates the following columns:
+
+* image_file_name
+* image_file_size
+* image_content_type
+* image_updated_at
+
+`paperclip-dimension` will create an extra field for you: `image_dimensions` when the above migration is run.
+
+**Mongoid**
+
+Exmaple Mongoid setup:
+
+```ruby
+class Post
+  include Mongoid::Document
+  include Paperclip::Glue
+
+  # The usual paperclip fields
+  field :image_file_name,     :type => String
+  field :image_file_size,     :type => Integer
+  field :image_content_type,  :type => String
+  field :image_updated_at,    :type => Time
+
+  # The extra paperclip-dimension field
+  field :image_dimensions,    :type => Hash
+
+  # call #has_attached_file like usual
+  has_attached_file :image, :styles => {
+    :large    =>    ['350x350>',     :jpg],
+    :medium   =>    ['150x150>',     :jpg],
+    :small    =>    ['30x30>',       :jpg]
+  }
+end
+```
+
+Usage
+-----
+
+This gem gives your model a few extra helpers:
+
+```ruby
+# suppose we used the example from above
+p = Post.first
+
+# retrieve image dimensions for all sytles
+p.image_dimensions
+#   {
+#     'original' => [2048, 1024],
+#     'large'    => [350, 175],
+#     'medium'   => [150, 75],
+#     'small'    => [30, 15]
+#   }
+
+# get image dimension as an array
+p.image_dimension               # [2048, 1024]
+p.image_dimension(:original)    # [2048, 1024]
+p.image_dimension(:large)       # [350, 175]
+
+# get it now as a string
+p.image_dimension_str             # "2048x1024"
+p.image_dimension_str(:original)  # "2048x1024"
+p.image_dimension_str(:large)     # "350x175"
+```
+
+Contributing to paperclip-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,38 @@
+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.name = "paperclip-dimension"
+  gem.homepage = "http://github.com/aq1018/paperclip-dimension"
+  gem.license = "MIT"
+  gem.summary = %Q{A simple plugin to persist image dimensions.}
+  gem.description = %Q{A simple plugin to persist image dimensions.}
+  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'
+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
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

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

data/lib/paperclip-dimension.rb

@@ -0,0 +1,63 @@
+require 'paperclip'
+
+module Paperclip
+  module Dimension
+    def self.included(klass)
+      klass.extend Paperclip::Dimension::ClassMethods
+    end
+
+    module ClassMethods
+      # override has_attached_file to:
+      # 1). save dimensions on post process
+      # 2). create dimension accessors
+      def has_attached_file name, options={}
+        super
+
+        class_eval <<-END
+          # for ActiveRecord
+          serialize :#{name}_dimensions, Hash if respond_to?(:serialize)
+
+          def #{name}_dimension(style=:original)
+            self.#{name}_dimensions[style]
+          end
+
+          def #{name}_dimension_str(style=:original)
+             dim = #{name}_dimension(style)
+             dim ? dim.join('x') : nil
+          end
+        END
+
+        send "after_#{name}_post_process", lambda { save_dimensions_for(name) }
+      end
+    end
+
+    def save_dimensions_for(name)
+      opts = self.class.attachment_definitions[name]
+
+      styles = opts[:styles].keys + [:original]
+      dimension_hash = {}
+      styles.each do |style|
+        attachment = self.send name
+        geo = ::Paperclip::Geometry.from_file(attachment.queued_for_write[style])
+        dimension_hash[style] = [ geo.width.to_i, geo.height.to_i ]
+      end
+      self.send "#{name}_dimensions=", dimension_hash
+    end
+  end
+
+  module Glue
+    class << self
+      def included_with_dimension(klass)
+        included_without_dimension(klass)
+        klass.send :include, Paperclip::Dimension
+      end
+
+      alias :included_without_dimension :included
+      alias :included :included_with_dimension
+    end
+  end
+
+  module Schema
+    @@columns[:dimensions] = :string
+  end
+end

data/paperclip-dimension.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "paperclip-dimension"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aaron Qian"]
+  s.date = "2012-01-28"
+  s.description = "A simple plugin to persist image dimensions."
+  s.email = "aq1018@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/paperclip-dimension.rb",
+    "paperclip-dimension.gemspec",
+    "spec/paperclip-dimension_spec.rb",
+    "spec/ruby.png",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/aq1018/paperclip-dimension"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "A simple plugin to persist image dimensions."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<paperclip>, [">= 2.4"])
+      s.add_development_dependency(%q<activerecord>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<paperclip>, [">= 2.4"])
+      s.add_dependency(%q<activerecord>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<paperclip>, [">= 2.4"])
+    s.add_dependency(%q<activerecord>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/spec/paperclip-dimension_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Paperclip::Dimension 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,61 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'active_record'
+require 'paperclip'
+require 'paperclip-dimension'
+require 'paperclip/railtie'
+
+# mocking Rails.root & Rails.env used in Paperclip::Interploration
+module Rails
+  def self.root
+    File.dirname(__FILE__) + "/.."
+  end
+
+  def self.env
+    "test"
+  end
+
+  def self.logger
+    nil
+  end
+end
+
+# need to manually call this
+Paperclip::Railtie.insert
+
+# turn off logging
+Paperclip.options[:log] = false
+
+# use sqlite3 memory store
+ActiveRecord::Base.establish_connection({
+  :adapter    =>    'sqlite3',
+  :database   =>    ':memory:'
+})
+
+# create tables
+ActiveRecord::Schema.define do
+  create_table :posts do |t|
+    t.has_attached_file :image
+    t.has_attached_file :another_image
+  end
+end
+
+# define model
+class Post < ActiveRecord::Base
+  extend Paperclip::Dimension::ClassMethods
+  has_attached_file :image, :styles => {
+    :large    =>    ['350x350>',     :jpg],
+    :medium   =>    ['150x150>',     :jpg],
+    :small    =>    ['30x30>',       :jpg]
+  }
+
+  has_attached_file :another_image, :styles => {
+    :large    =>    ['350x350>',     :jpg],
+    :medium   =>    ['150x150>',     :jpg],
+    :small    =>    ['30x30>',       :jpg]
+  }
+end
+
+

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: paperclip-dimension
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Aaron Qian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: &20936760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: *20936760
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &20935780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20935780
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &20934360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20934360
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &20932400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20932400
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &20931660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20931660
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &20931000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20931000
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &20930080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20930080
+description: A simple plugin to persist image dimensions.
+email: aq1018@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/paperclip-dimension.rb
+- paperclip-dimension.gemspec
+- spec/paperclip-dimension_spec.rb
+- spec/ruby.png
+- spec/spec_helper.rb
+homepage: http://github.com/aq1018/paperclip-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
+      version: '0'
+      segments:
+      - 0
+      hash: -1625625660612208703
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A simple plugin to persist image dimensions.
+test_files: []