file_storage 0.0.1

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake_ext'
+
+project(
+  name: "file_storage",
+  gem: true,
+  summary: "File storage for Models",
+
+  author: "Alexey Petrushin",
+  homepage: "http://github.com/alexeypetrushin/file_storage"
+)

data/lib/carrierwave_ext.rb

@@ -0,0 +1,11 @@
+require 'carrierwave'
+
+%w(
+  fixes
+  miscellaneous
+  mongo_model
+).each{|f| require "carrierwave_ext/#{f}"}
+
+CarrierWave::Uploader::Base.class_eval do
+  def name; model.send("#{mounted_as}_filename") end
+end

data/lib/carrierwave_ext/fixes.rb

@@ -0,0 +1,12 @@
+CarrierWave::SanitizedFile.class_eval do
+  def sanitize_regexp
+    /[^[:word:]\.\-\+\s_]/i
+  end
+end
+
+CarrierWave::Uploader::Cache.class_eval do
+  def original_filename=(filename)
+    raise CarrierWave::InvalidParameter, "invalid filename" unless filename =~ /\A[[:word:]\.\-\+\s_]+\z/i
+    @original_filename = filename
+  end
+end

data/lib/carrierwave_ext/miscellaneous.rb

@@ -0,0 +1,26 @@
+# 
+# Changing filename format from <version>_<filename_with_extension> to <name>.<version>.<extension>
+# 
+CarrierWave::Uploader::Versions.class_eval do
+  def full_filename(for_file)
+    name = super
+    if version_name
+      ext = File.extname name
+      base = File.basename name, ext
+      "#{base}.#{version_name}#{ext}"
+    else
+      name
+    end    
+  end
+
+  def full_original_filename
+    name = super
+    if version_name
+      ext = File.extname name
+      base = File.basename name, ext
+      "#{base}.#{version_name}#{ext}"
+    else
+      name
+    end
+  end
+end

data/lib/carrierwave_ext/mongo_model.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+require 'mongo_db/model'
+
+module CarrierWave
+  module MongoModel
+    def read_uploader name
+      send name
+    end
+    
+    def write_uploader name, value
+      send :"#{name}=", value
+    end    
+    
+    module ClassMethods
+      include CarrierWave::Mount
+      ##
+      # See +CarrierWave::Mount#mount_uploader+ for documentation
+      #
+      def mount_uploader(column, uploader, options={}, &block)
+        fname_attribute = :"#{column}_filename"
+        attr_accessor fname_attribute
+        
+        options[:mount_on] ||= fname_attribute
+
+        super
+      
+        # include CarrierWave::Validations::ActiveModel
+        # validates_integrity_of  column if uploader_option(column.to_sym, :validate_integrity)
+        # validates_processing_of column if uploader_option(column.to_sym, :validate_processing)
+
+        after_save "store_#{column}!".to_sym
+        before_save "write_#{column}_identifier".to_sym
+        after_destroy "remove_#{column}!".to_sym
+      end
+    end
+  end
+end
+
+Mongo::Model.inherit CarrierWave::MongoModel

data/lib/carrierwave_ext/spec.rb

@@ -0,0 +1,23 @@
+module CarrierWaveExtSpecHelper
+  TEST_PATH, TEST_CACHE_PATH = '/tmp/spec_fs', '/tmp/spec_fs_cache'
+  
+  def with_files
+    before do
+      CarrierWave.configure do |config|          
+        config.storage = :file
+        config.enable_processing = false
+        
+        config.cache_dir = TEST_CACHE_PATH
+        config.root = TEST_PATH
+      end
+    end
+    
+    before do 
+      [TEST_PATH, TEST_CACHE_PATH].each{|p| FileUtils.rm_r(p) if File.exist?(p)}
+    end
+    before do 
+      [TEST_PATH, TEST_CACHE_PATH].each{|p| FileUtils.rm_r(p) if File.exist?(p)}
+    end
+  end    
+end
+rspec.extend CarrierWaveExtSpecHelper

data/readme.md

@@ -0,0 +1 @@
+File storage for Models

data/spec/file_storage_spec.rb

@@ -0,0 +1,145 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require 'mini_magick'
+
+describe "File Storage" do   
+  before :all do
+    class ImageFile
+      include FileStorage
+      
+      process do
+      end
+    
+      version :icon do
+        process do
+        end
+        # process convert: :png
+        # process resize_to_fit: [50, 50]
+      end
+      
+      def path_prefix
+        self.class.path_prefix
+      end
+      
+      def url_prefix
+        '/'
+      end
+      
+      def validate
+        errors << 'invalid name' if original and original.name =~ /invalid/
+      end
+      
+      class << self
+        attr_accessor :path_prefix
+      end
+    end        
+  end
+  after(:all){remove_constants :ImageFile}
+  
+  before do
+    ImageFile.path_prefix = "#{spec_dir}/storage"    
+    @file = "#{spec_dir}/ship.jpg".to_file
+  end
+  
+  it "CRUD" do
+    # blank
+    image = ImageFile.new
+    image.file.should be_nil
+    image.url.should == nil    
+    image.icon.file.should be_nil
+    image.icon.url.should == nil
+    
+    # preserving
+    image.original = @file
+    image.original.name.should == 'ship.jpg'
+    image.original.path.should == "#{spec_dir}/ship.jpg"
+        
+    image.file.should be_nil
+    image.url.should == nil    
+    image.icon.file.should be_nil
+    image.icon.url.should == nil
+    
+    # writing
+    image.save
+    image.file.name.should == 'ship.jpg'
+    image.file.path.should == "#{spec_dir}/storage/ship.jpg"
+    image.file.exist?.should be_true
+    image.url.should == '/ship.jpg'
+    
+    image.icon.file.name.should == 'ship.jpg'    
+    image.icon.file.path.should == "#{spec_dir}/storage/ship.icon.jpg"
+    image.icon.file.exist?.should be_true
+    image.icon.url.should == '/ship.icon.jpg'
+    
+    # reading
+    image = ImageFile.new
+    image.read 'ship.jpg'
+    
+    image.file.name.should == 'ship.jpg'
+    image.file.path.should == "#{spec_dir}/storage/ship.jpg"
+    image.file.exist?.should be_true
+    image.url.should == '/ship.jpg'
+    
+    image.icon.file.name.should == 'ship.jpg'    
+    image.icon.file.path.should == "#{spec_dir}/storage/ship.icon.jpg"
+    image.icon.file.exist?.should be_true
+    image.icon.url.should == '/ship.icon.jpg'
+    
+    # updating
+    image.original = @file
+    image.original.name.should == 'ship2.jpg'
+    image.original.path.should == "#{spec_dir}/ship2.jpg"
+    
+    image.save            
+    
+    "#{spec_dir}/storage/ship.jpg".to_file.exist?.should be_false
+    "#{spec_dir}/storage/ship.icon.jpg".to_file.exist?.should be_false
+    
+    image.file.name.should == 'ship2.jpg'
+    image.file.path.should == "#{spec_dir}/storage/ship2.jpg"
+    image.file.exist?.should be_true
+    image.url.should == '/ship2.jpg'
+    
+    image.icon.file.name.should == 'ship2.jpg'    
+    image.icon.file.path.should == "#{spec_dir}/storage/ship2.icon.jpg"
+    image.icon.file.exist?.should be_true
+    image.icon.url.should == '/ship.icon2.jpg'
+    
+    # destroying
+    image = ImageFile.new
+    image.read 'ship.jpg'
+    image.destroy
+    "#{spec_dir}/storage/ship2.jpg".to_file.exist?.should be_false
+    "#{spec_dir}/storage/ship2.icon.jpg".to_file.exist?.should be_false
+  end
+  
+  it "should preserve spaces and unicode characters in filename" do
+    file = "#{spec_dir}/файл с пробелами.txt".to_file
+    
+    image = ImageFile.new
+    image.save file
+    image.url.should =~ /\/файл с пробелами\.txt/
+    image.file.path.should =~ /\/файл с пробелами\.txt/
+  end
+  
+  it 'should raise error if file not exists' do
+    image = ImageFile.new
+    image.original = "#{spec_dir}/non existing file.jpg".to_file
+    image.validate
+    image.errors.first.should =~ /not exist/
+  end
+  
+  it 'should validate and not save invalid files' do
+    image = ImageFile.new
+    image.original = "#{spec_dir}/ship.jpg".to_file
+    image.validate
+    image.errors.should == []
+    
+    image.original == "#{spec_dir}/invalid.jpg".to_file
+    image.validate
+    image.errors.should == ['invalid filename']
+    
+    -> {image.save}.should raise_error(/invalid/)
+  end
+end

data/spec/file_storage_spec//321/204/320/260/320/270/314/206/320/273 /321/201 /320/277/321/200/320/276/320/261/320/265/320/273/320/260/320/274/320/270.txt"

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

data/spec/model_integration_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe 'Model Integration' do  
+  before :all do
+    class ImageFile
+      inherit FileStorage
+      
+      def validate
+        errors << 'invalid name' if original and (original.name =~ /invalid/)
+      end
+    end
+    
+    class TheModel < ModelStub
+      inherit FileStorage::Helper
+      
+      mount_file :image, ImageFile
+      
+      alias_method :attribute_get, :instance_variable_get
+      alias_method :attribute_set, :instance_variable_set
+      
+      before_validate.push -> {|_self|
+        self.image.validate
+        self.errors[:image] = image.errors unless image.errors.empty?
+      end
+      
+      after_save.push -> {|_self| self.image.save}
+      
+      after_destroy.push -> {|_self| self.image.destroy}
+    end
+  end
+  
+  after(:all){remove_constants :ImageFile, :TheModel}
+  
+  it 'CRUD' do        
+    # read
+    model = TheModel.new
+    model.image.class.should == ImageStorage
+    model.image.url.should be_nil
+    model.image.file.should be_nil
+        
+    # preserving
+    file = spec_dir.to_dir / 'ship.jpg'
+    model.image = file
+    model.image.original.path.should == "#{spec_dir}/ship.jpg"
+    model.instance_variable_get(:@image).should == 'ship.jpg'
+    model.image.url.should be_nil
+    model.image.file.path.should be_nil
+        
+    # saving
+    model.save.should be_true
+    model.instance_variable_get(:@image).should == 'ship.jpg'
+    model.image.url.should == '/ship.jpg'
+    model.image.file.path.should == "#{spec_dir}/ship.jpg"
+    "#{spec_dir}/ship.jpg".to_file.exist?.should be_true
+    
+    # reading
+    model = TheModel.new    
+    model.instance_variable_set(:@image, 'ship.jpg')
+    model.image.url.should == '/ship.jpg'
+    model.image.file.path.should == "#{spec_dir}/ship.jpg"
+    
+    # updating
+    file2 = spec_dir.to_dir / 'ship2.jpg'
+    model.image = file2
+    model.instance_variable_get(:@image).should == 'ship2.jpg'
+    model.image.original.path.should == "#{spec_dir}/ship2.jpg"
+    model.image.url.should == '/ship.jpg'
+    model.image.file.path.should == "#{spec_dir}/ship.jpg"
+        
+    model.save.should be_true
+    model.instance_variable_get(:@image).should == 'ship2.jpg'
+    model.image.url.should == '/ship2.jpg'
+    model.image.file.path.should == "#{spec_dir}/ship2.jpg"        
+    "#{spec_dir}/ship.jpg".to_file.exist?.should be_false
+    "#{spec_dir}/ship2.jpg".to_file.exist?.should be_true
+    
+    # destroying
+    model.destroy.should be_false
+    "#{spec_dir}/ship2.jpg".to_file.exist?.should be_false
+  end
+  
+  it "should be able to submit errors and interrupt model saving" do
+    file = spec_dir.to_dir / 'invalid.txt'
+    model.image = file
+    model.image.should_not_receive(:save)
+    model.save.should be_false
+    model.errors[:image].should == ['invalid name']
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rspec_ext'
+
+require 'spec_helper/model_stub'

data/spec/spec_helper/model_stub.rb

@@ -0,0 +1,43 @@
+class ModelStub
+  def errors
+    @errors ||= {}
+  end
+  
+  def save
+    before_validate.each{|m| send m}
+    
+    if errors.empty?
+      # save
+      after_save.each{|m| send m}
+      true
+    else
+      false
+    end
+  end
+  
+  def destroy        
+    before_validate.each{|b| instance_eval &b}
+    
+    if errors.empty?
+      # save
+      after_destroy.each{|b| instance_eval &b}
+      true
+    else
+      false
+    end
+  end
+  
+  class << self
+    def before_validate
+      @before_validate ||= []
+    end
+    
+    def before_save
+      @before_save ||= []
+    end
+    
+    def before_destroy
+      @before_destroy ||= []
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: file_storage
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alexey Petrushin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-27 00:00:00.000000000Z
+dependencies: []
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- readme.md
+- lib/carrierwave_ext/fixes.rb
+- lib/carrierwave_ext/miscellaneous.rb
+- lib/carrierwave_ext/mongo_model.rb
+- lib/carrierwave_ext/spec.rb
+- lib/carrierwave_ext.rb
+- spec/file_storage_spec/invalid.txt
+- spec/file_storage_spec/ship.jpg
+- spec/file_storage_spec/ship2.jpg
+- spec/file_storage_spec/файл с пробелами.txt
+- spec/file_storage_spec.rb
+- spec/model_integration_spec/invalid.txt
+- spec/model_integration_spec/ship.jpg
+- spec/model_integration_spec/ship2.jpg
+- spec/model_integration_spec.rb
+- spec/spec_helper/model_stub.rb
+- spec/spec_helper.rb
+homepage: http://github.com/alexeypetrushin/file_storage
+licenses: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: File storage for Models
+test_files: []