carrierwave-meta 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in carrierwave-meta.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,98 @@
+= carrierwave-meta
+
+= Installation
+
+Add the following line to your Gemfile:
+  gem 'carrierwave-meta'
+
+= Usage example
+
+  class TestUploader < CarrierWave::Uploader::Base
+    include CarrierWave::RMagick
+    include CarrierWave::Meta
+  
+    def store_dir
+      "tmp/store"
+    end
+
+    def cache_dir
+      "tmp/cache"
+    end
+
+    storage :file
+
+    process :store_meta
+    version :version do
+      process :resize_to_fill => [200, 200]
+      process :store_meta
+    end
+  end
+  
+  file = File.open('test.jpg') # JPEG 500x300, 20000 bytes
+  uploader = TestUploader.new
+  uploader.store!(file)
+  
+  uploader.width        # 500
+  uploader.height       # 300
+  uploader.image_size   # [500, 300]
+  uploader.file_zie     # 20000
+  uploader.content_type # "image/jpeg"
+  
+  uploader.version.width        # 200
+  uploader.version.height       # 200  
+  uploader.version.image_size   # [200, 200]  
+  uploader.version.file_zie     # less than 20000
+  uploader.version.content_type # "image/jpeg"
+
+= Saving values to database
+
+  class TestModel
+    attr_accessor :image_width  
+    attr_accessor :image_height
+    attr_accessor :image_image_size  
+    attr_accessor :image_content_type
+    attr_accessor :image_file_size
+
+    attr_accessor :image_version_width  
+    attr_accessor :image_version_height
+    attr_accessor :image_version_image_size
+    attr_accessor :image_version_content_type
+    attr_accessor :image_version_file_size  
+  end
+
+  file = File.open('test.jpg')
+  model = TestModel.new
+  uploader = TestUploader.new(model, :image)
+  uploader.store!(file)
+  
+  uploader.width      # 500
+  model.image_width   # 500
+  model.image_height  # 300
+  ...
+
+When columns are available in the model instance, metadata is stored in that columns.
+
+= Behind the scenes
+
+After the file is retrieved from store metadata is recalculated for it unless uploader has
+attached model instance.
+
+  uploader = TestUploader.new
+  uploader.retrieve_from_store!('test.jpg')
+
+  uploader.version.width # 200
+
+So, if you are storing width and height in database column and then you decided to store 
+content type.
+
+Uploader tries to retrieve metadata from a model's column first.
+
+= Integrating CarrierWave & JCrop using carrierwave-meta
+
+
+= TODO
+
+1. I do not know how it would work with S3 and other remote storages. Should be tested.
+2. Write integration guide for JCrop.
+3. A notice about content-type.
+4. It works now only with RMagick. Add support for other image libraries. It's easy.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/carrierwave-meta.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "carrierwave-meta/version"
+
+Gem::Specification.new do |s|
+  s.name        = "carrierwave-meta"
+  s.version     = Carrierwave::Meta::VERSION
+  s.authors     = ["Victor Sokolov"]
+  s.email       = ["gzigzigzi@gmail.com"]
+  s.homepage    = "http://github.com/gzigzigzeo/carrierwave-meta"
+  s.summary     = %q{}
+  s.description = %q{}
+
+  s.rubyforge_project = "carrierwave-meta"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency(%q<carrierwave>, [">= 0.5.7"])
+  s.add_dependency(%q<activesupport>, [">= 3.0"])  
+  s.add_development_dependency(%q<rspec-rails>, ">= 2.6")
+  s.add_development_dependency(%q<sqlite3-ruby>)    
+  s.add_development_dependency(%q<rmagick>)
+  s.add_development_dependency(%q<mime-types>)
+end

data/lib/carrierwave-meta.rb

@@ -0,0 +1,4 @@
+require 'active_support/concern'
+require "carrierwave-meta/version"
+require 'carrierwave-meta/model_delegate_attribute'
+require 'carrierwave-meta/meta'

data/lib/carrierwave-meta/meta.rb

@@ -0,0 +1,63 @@
+module CarrierWave
+  module Meta
+    extend ActiveSupport::Concern
+
+    included do
+      include CarrierWave::ModelDelegateAttribute
+      include CarrierWave::MimeTypes
+
+      set_content_type(true)
+      
+      after :retrieve_from_cache, :set_content_type
+      after :retrieve_from_cache, :call_store_meta
+      after :retrieve_from_store, :set_content_type
+      after :retrieve_from_store, :call_store_meta
+
+      model_delegate_attribute :content_type, ''
+      model_delegate_attribute :file_size, 0
+      model_delegate_attribute :image_size, []
+      model_delegate_attribute :width, 0
+      model_delegate_attribute :height, 0
+    end
+
+    module InstanceMethods
+      def store_meta
+        if self.file.present?
+          dimensions = get_dimensions
+          width, height = dimensions
+          self.content_type = self.file.content_type
+          self.file_size = self.file.size
+          self.image_size = dimensions
+          self.width = width
+          self.height = height
+        end
+      end
+      
+      def set_content_type(file = nil)
+        set_content_type(true)
+      end
+      
+      private
+      def call_store_meta(file = nil)
+        # Re-retrieve metadata for a file only if model is not present.
+        store_meta if self.model.nil?
+      end
+      
+      def get_dimensions
+        [].tap do |size|
+          if self.file.content_type =~ /image/
+            manipulate! do |img|
+              if img.is_a?(::Magick::Image)
+                size << img.columns
+                size << img.rows
+              else
+                raise "Only RMagick is supported yet. Fork and update it."
+              end        
+              img
+            end
+          end
+        end
+      end        
+    end
+  end
+end

data/lib/carrierwave-meta/model_delegate_attribute.rb

@@ -0,0 +1,47 @@
+module CarrierWave
+  module ModelDelegateAttribute
+    extend ::ActiveSupport::Concern
+    
+    module ClassMethods
+      def model_delegate_attribute(attribute, default = nil)
+        attr_accessor attribute
+
+        before :remove, :"reset_#{attribute}"
+
+        var_name = :"@#{attribute}"
+
+        define_method :"#{attribute}" do
+          model_accessor = model_getter_name(attribute)
+          value = instance_variable_get(var_name)
+          value ||= self.model.send(model_accessor) if self.model.present? && self.model.respond_to?(model_accessor)
+          value ||= default
+          instance_variable_set(var_name, value)
+        end
+
+        define_method :"#{attribute}=" do |value|
+          model_accessor = model_getter_name(attribute)
+          instance_variable_set(var_name, value)
+          if self.model.present? && self.model.respond_to?(:"#{model_accessor}=") && !self.model.destroyed?
+            self.model.send(:"#{model_accessor}=", value) 
+          end
+        end
+
+        define_method :"reset_#{attribute}" do
+          self.send(:"#{attribute}=", default)
+          send(:"#{attribute}=", default)
+        end
+      end
+    end
+    
+    module InstanceMethods
+      private
+      def model_getter_name(attribute)
+        name = []
+        name << mounted_as if mounted_as.present?
+        name << version_name if version_name.present?
+        name << attribute
+        name.join('_')
+      end
+    end
+  end
+end

data/lib/carrierwave-meta/version.rb

@@ -0,0 +1,5 @@
+module Carrierwave
+  module Meta
+    VERSION = "0.0.1"
+  end
+end

data/spec/modules/meta_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+require 'mime/types'
+
+describe TestUploader do
+  ORIGINAL_SIZE = [600, 277]
+  VERSION_SIZE = [200, 200]
+
+  let(:file) { File.open("spec/fixtures/big.jpg") }  
+  let(:file_name) { File.basename(file.path) }
+  let(:obj) { TestModel.new }  
+
+  def uploader_values_are_correct(uploader)
+    uploader.width.should eq(ORIGINAL_SIZE[0])
+    uploader.height.should eq(ORIGINAL_SIZE[1])
+    uploader.image_size.should eq(ORIGINAL_SIZE)
+    uploader.content_type.should eq(Mime::Types.type_for(file_name).first.to_s)
+    uploader.file_size.should_not be_blank
+
+    uploader.version.width.should eq(VERSION_SIZE[0])
+    uploader.version.height.should eq(VERSION_SIZE[1])
+    uploader.version.image_size.should eq(VERSION_SIZE)
+    uploader.version.content_type.should eq(Mime::Types.type_for(file_name).first.to_s)
+    uploader.version.file_size.should_not be_blank
+  end
+
+  def obj_values_are_correct(obj)
+    obj.image_width.should eq(ORIGINAL_SIZE[0])
+    obj.image_height.should eq(ORIGINAL_SIZE[1])
+    obj.image_image_size.should eq(ORIGINAL_SIZE)
+    obj.image_content_type.should eq(MIME::Types.type_for(file_name).first.to_s)
+    obj.image_file_size.should_not be_blank
+
+    obj.image_version_width.should eq(VERSION_SIZE[0])
+    obj.image_version_height.should eq(VERSION_SIZE[1])
+    obj.image_version_image_size.should eq(VERSION_SIZE)
+    obj.image_version_content_type.should eq(MIME::Types.type_for(file_name).first.to_s)
+    obj.image_version_file_size.should_not be_blank
+  end
+
+  def uploader_values_are_correct(obj)
+    obj.width.should eq(ORIGINAL_SIZE[0])
+    obj.height.should eq(ORIGINAL_SIZE[1])
+  end
+
+  context "detached uploader" do
+    it "stores metadata after cache!" do
+      uploader = TestUploader.new
+      uploader.cache!(file)
+      uploader_values_are_correct(uploader)
+    end
+  
+    it "stores metadata after store!" do
+      uploader = TestUploader.new
+      uploader.store!(file)
+      uploader_values_are_correct(uploader)
+    end
+  
+    it "has metadata after cache!/retrieve_from_cache!" do
+      uploader = TestUploader.new
+      uploader.cache!(file)
+      cache_name = uploader.cache_name
+
+      uploader = TestUploader.new
+      uploader.retrieve_from_cache!(cache_name)
+      uploader_values_are_correct(uploader)
+    end
+    
+    it "has metadata after store!/retrieve_from_store!" do
+      uploader = TestUploader.new
+      uploader.store!(file)
+      uploader_values_are_correct(uploader)
+      
+      uploader = TestUploader.new
+      uploader.retrieve_from_store!(File.basename(file.path))
+      uploader_values_are_correct(uploader)      
+    end    
+  end
+
+  context "attached uploader" do
+    it "stores metadata after cache!" do
+      uploader = TestUploader.new(obj, :image)
+      uploader.cache!(file)
+      uploader_values_are_correct(uploader)
+      obj_values_are_correct(obj)
+    end
+  
+    it "stores metadata after store!" do
+      uploader = TestUploader.new(obj, :image)
+      uploader.store!(file)
+      uploader_values_are_correct(uploader)
+      obj_values_are_correct(obj)      
+    end
+  
+    it "has metadata after cache!/retrieve_from_cache!" do
+      uploader = TestUploader.new(obj, :image)
+      uploader.cache!(file)
+      cache_name = uploader.cache_name
+
+      uploader = TestUploader.new(obj, :image)
+      uploader.retrieve_from_cache!(cache_name)
+      uploader_values_are_correct(uploader)
+    end
+    
+    it "has metadata after store!/retrieve_from_store!" do
+      uploader = TestUploader.new(obj, :image)
+      uploader.store!(file)
+      uploader_values_are_correct(uploader)
+      
+      uploader = TestUploader.new(obj, :image)
+      uploader.retrieve_from_store!(File.basename(file.path))
+      uploader_values_are_correct(uploader)      
+    end    
+  end
+end

data/spec/modules/model_delegate_attribute_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe TestDelegateUploader do
+  let(:values) { subject.class::VALUES }
+  let(:default_values) { subject.class::DEFAULT_VALUES }  
+  let(:file) { File.open("spec/fixtures/big.jpg") }
+  let(:obj) { TestModel.new }
+  
+  before do
+    obj.destroyed = false
+  end
+
+  def uploader_values_are_correct(uploader)
+    uploader.x.should eq(values[:x])
+    uploader.dimensions.should eq(values[:dimensions])    
+    uploader.version.x.should eq(values[:version_x])
+    uploader.version.dimensions.should eq(values[:version_dimensions])    
+  end
+
+  def obj_values_are_correct(obj)
+    obj.image_x.should eq(values[:x])
+    obj.image_dimensions.should eq(values[:dimensions])    
+    obj.image_version_x.should eq(values[:version_x])
+    obj.image_version_dimensions.should eq(values[:version_dimensions])      
+  end
+
+  def uploader_values_are_default(obj)
+    obj.x.should eq(default_values[:x])
+    obj.dimensions.should eq(default_values[:dimensions])    
+    obj.version.x.should eq(default_values[:x])
+    obj.version.dimensions.should eq(default_values[:dimensions])      
+  end
+  
+  it "model receives values after process done" do
+    uploader = TestDelegateUploader.new(obj, :image)
+    uploader.cache!(file)
+
+    uploader_values_are_correct(uploader)
+    obj_values_are_correct(obj)
+  end
+  
+  it "resets values to default after file is removed" do
+    uploader = TestDelegateUploader.new(obj, :image)
+    uploader.store!(file)
+
+    uploader_values_are_correct(uploader)
+
+    # CarrierWave's file is removed in after_destroy callback. Model attributes are freezed after destroy. 
+    # Let mock this case.
+    obj.image_x.freeze
+    obj.destroyed = true
+    uploader.remove!
+
+    uploader_values_are_default(uploader)
+    obj_values_are_correct(obj)
+  end
+  
+  it "tries to receive value from a model when file was not processed at this time" do
+    uploader = TestDelegateUploader.new(obj, :image)
+    uploader.store!(file)
+
+    uploader_values_are_correct(uploader)
+
+    uploader = TestDelegateUploader.new(obj, :image)
+    uploader.retrieve_from_store!(File.basename(file.path))
+
+    obj_values_are_correct(obj)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+$LOAD_PATH << "." unless $LOAD_PATH.include?(".")
+
+begin
+  require "bundler"
+  Bundler.setup
+  Bundler.require  
+rescue Bundler::GemNotFound
+  raise RuntimeError, "Bundler couldn't find some gems." +
+    "Did you run `bundle install`?"
+end
+
+require 'mime/types'
+require 'carrierwave'
+require 'carrierwave-meta'
+require 'support/test_delegate_uploader'
+require 'support/test_uploader'
+require 'support/test_model'
+
+RSpec.configure do |config|
+  config.before do
+    FileUtils.rm_rf('tmp')
+  end
+end
+
+$: << File.join(File.dirname(__FILE__), '..', 'lib')

data/spec/support/schema.rb

@@ -0,0 +1,15 @@
+ActiveRecord::Schema.define :version => 0 do
+  create_table "test_models", :force => true do |t|
+    t.string :image
+    
+    t.integer :image_width
+    t.integer :image_height
+    t.string  :image_content_type
+    t.integer :image_file_size
+
+    t.integer :image_version_width
+    t.integer :image_version_height
+    t.integer :image_version_file_size
+    t.string  :image_version_content_type
+  end
+end

data/spec/support/test_delegate_uploader.rb

@@ -0,0 +1,43 @@
+class TestDelegateUploader < CarrierWave::Uploader::Base
+  VALUES = {
+    :x => 5,
+    :version_x => 10,
+    :dimensions => [1, 1],
+    :version_dimensions => [2, 2]
+  }
+  
+  DEFAULT_VALUES = {
+    :x => 0,
+    :dimensions => []
+  }
+  
+  storage :file
+
+  def store_dir
+    "tmp/store"
+  end
+
+  def cache_dir
+    "tmp/cache"
+  end  
+  
+  include CarrierWave::ModelDelegateAttribute
+  
+  model_delegate_attribute :x, DEFAULT_VALUES[:x]
+  model_delegate_attribute :dimensions, DEFAULT_VALUES[:dimensions]
+  
+  process :set_values
+  version :version do
+    process :set_values_for_version
+  end
+  
+  def set_values
+    self.x = VALUES[:x]
+    self.dimensions = VALUES[:dimensions]
+  end
+  
+  def set_values_for_version
+    self.x = VALUES[:version_x]
+    self.dimensions = VALUES[:version_dimensions]
+  end
+end

data/spec/support/test_model.rb

@@ -0,0 +1,24 @@
+class TestModel
+  attr_accessor :image_x
+  attr_accessor :image_version_x
+  attr_accessor :image_dimensions
+  attr_accessor :image_version_dimensions  
+
+  attr_accessor :image_width  
+  attr_accessor :image_height
+  attr_accessor :image_image_size  
+  attr_accessor :image_content_type
+  attr_accessor :image_file_size
+
+  attr_accessor :image_version_width  
+  attr_accessor :image_version_height
+  attr_accessor :image_version_image_size
+  attr_accessor :image_version_content_type
+  attr_accessor :image_version_file_size
+  
+  attr_accessor :destroyed
+
+  def destroyed?
+    destroyed
+  end
+end

data/spec/support/test_uploader.rb

@@ -0,0 +1,20 @@
+class TestUploader < CarrierWave::Uploader::Base
+  include CarrierWave::RMagick
+  include CarrierWave::Meta
+  
+  def store_dir
+    "tmp/store"
+  end
+
+  def cache_dir
+    "tmp/cache"
+  end
+
+  storage :file
+
+  process :store_meta
+  version :version do
+    process :resize_to_fill => [200, 200]
+    process :store_meta
+  end
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification 
+name: carrierwave-meta
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Victor Sokolov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-09 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: carrierwave
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 5
+        - 7
+        version: 0.5.7
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rmagick
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: ""
+email: 
+- gzigzigzi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- carrierwave-meta.gemspec
+- lib/carrierwave-meta.rb
+- lib/carrierwave-meta/meta.rb
+- lib/carrierwave-meta/model_delegate_attribute.rb
+- lib/carrierwave-meta/version.rb
+- spec/fixtures/big.jpg
+- spec/fixtures/big.zip
+- spec/fixtures/small.png
+- spec/modules/meta_spec.rb
+- spec/modules/model_delegate_attribute_spec.rb
+- spec/spec_helper.rb
+- spec/support/schema.rb
+- spec/support/test_delegate_uploader.rb
+- spec/support/test_model.rb
+- spec/support/test_uploader.rb
+homepage: http://github.com/gzigzigzeo/carrierwave-meta
+licenses: []
+
+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: carrierwave-meta
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: ""
+test_files: 
+- spec/fixtures/big.jpg
+- spec/fixtures/big.zip
+- spec/fixtures/small.png
+- spec/modules/meta_spec.rb
+- spec/modules/model_delegate_attribute_spec.rb
+- spec/spec_helper.rb
+- spec/support/schema.rb
+- spec/support/test_delegate_uploader.rb
+- spec/support/test_model.rb
+- spec/support/test_uploader.rb