file_model 0.0.1

data/Rakefile

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

data/lib/file_model/file_model.rb

@@ -0,0 +1,120 @@
+module FileModel
+  attr_reader :name
+
+  def read name
+    self.name = name
+  end
+
+  attr_reader :original
+  def original= something
+    @original = something.to_file
+    raise "file #{original.name} not exist!" if original and !original.exist?
+    original
+  end
+
+  def save
+    return false unless original
+
+    # validating
+    validate
+    raise "can't save invalid file!" unless errors.empty?
+
+    # deleting old files
+    destroy validate: false
+
+    # saving
+    self.name = build_name original.name
+    process do |file|
+      path = build_path name
+      file.copy_to self.class.box[path]
+    end
+
+    self.class.versions.each do |version_name, klass|
+      version = send version_name
+      version.process do |file|
+        path = build_path name, version_name
+        file.copy_to self.class.box[path]
+      end
+    end
+
+    true
+  end
+
+  def destroy options = {}
+    return false unless name
+
+    unless options[:validate] == false
+      self.validate
+      raise "can't save invalid file!" unless errors.empty?
+    end
+
+    path = build_path name
+    self.class.box[path].destroy
+
+    self.class.versions.each do |version_name, klass|
+      path = build_path name, version_name
+      self.class.box[path].destroy
+    end
+
+    true
+  end
+
+  def url
+    name && build_url(name)
+  end
+
+  def file
+    name && self.class.box[build_path(name)]
+  end
+
+  def process &block
+    block.call original
+  end
+
+  def build_path name, version = nil
+    base, extension = name.rsplit('.', 2)
+    %(/#{base}#{".#{version}" if version}#{".#{extension}" if extension})
+  end
+
+  def build_url name, version = nil
+    base, extension = name.rsplit('.', 2)
+    %(/#{base}#{".#{version}" if version}#{".#{extension}" if extension})
+  end
+
+  def build_name name
+    name
+  end
+
+  def errors
+    @errors ||= []
+  end
+
+  def validate
+    errors.clear
+    # errors << "file #{original.name} not exist!" if original and !original.file?
+  end
+
+  protected
+    attr_writer :name
+
+  module ClassMethods
+    inheritable_accessor :versions, {}
+
+    def version name, &block
+      klass = Class.new FileModel::Version, &block
+      versions[name] = klass
+
+      iv_name = :"@#{name}"
+      define_method name do
+        unless version = instance_variable_get(iv_name)
+          version = klass.new self, name
+          instance_variable_set iv_name, version
+        end
+        version
+      end
+    end
+
+    attr_accessor :box
+    attr_required :box
+  end
+end

data/lib/file_model/gems.rb

@@ -0,0 +1,5 @@
+respond_to? :fake_gem do
+  gem 'ruby_ext'
+  gem 'vfs'
+  gem 'vos'
+end

data/lib/file_model/helper.rb

@@ -0,0 +1,28 @@
+module FileModel::Helper
+  module ClassMethods
+    def mount_file attr_name, file_model_class
+      attr_name.must_be.a Symbol
+      iv_name = :"@_#{attr_name}"
+
+      define_method attr_name do
+        unless file_model = instance_variable_get(iv_name)
+          file_name = attribute_get attr_name
+
+          file_model = file_model_class.new
+          file_model.read file_name
+
+          instance_variable_set iv_name, file_model
+        end
+        file_model
+      end
+
+      define_method :"#{attr_name}=" do |file|
+        file_model = send(attr_name)
+        file_model.original = file
+
+        file_name = file_model.build_name file_model.original.name
+        attribute_set attr_name, file_name
+      end
+    end
+  end
+end

data/lib/file_model/spec/shared_crud.rb

@@ -0,0 +1,93 @@
+require 'vos'
+
+shared_examples_for 'file model crud' do
+  describe "file model crud" do
+    before :all do
+      class ImageFile
+        inherit FileModel
+
+        def build_path name, version = nil
+          '/storage/images' + super
+        end
+
+        def build_url name, version = nil
+          '/images' + super
+        end
+
+        def validate
+          super
+          errors << 'invalid name' if original and (original.name =~ /invalid/)
+        end
+      end
+    end
+    after(:all){remove_constants :ImageFile}
+
+    before do
+      require 'tempfile'
+      @tmp_dir = Dir.tmpdir.to_dir.dir('/shard_crud').create.path
+      @shared_dir = __FILE__.to_entry.parent.dir(:shared_crud).path
+
+      ImageFile.box = Vos::Box.new(Vos::Drivers::Local.new(@tmp_dir))
+    end
+    after do
+      @tmp_dir.to_dir.destroy
+    end
+
+    it 'CRUD' do
+      # read
+      model = @model_class.new
+      model.image.class.should == ImageFile
+      model.image.url.should be_nil
+      model.image.file.should be_nil
+
+      # preserving
+      file = "#{@shared_dir}/ship.jpg"
+      model.image = file
+      model.image.original.path.should == "#{@shared_dir}/ship.jpg"
+      model.instance_variable_get(:@image).should == 'ship.jpg'
+      model.image.url.should be_nil
+      model.image.file.should be_nil
+
+      # saving
+      model.save.should be_true
+      model.instance_variable_get(:@image).should == 'ship.jpg'
+      model.image.url.should == '/images/ship.jpg'
+      model.image.file.path.should == "/storage/images/ship.jpg"
+      "#{@tmp_dir}/storage/images/ship.jpg".to_file.exist?.should be_true
+
+      # reading
+      model = @model_class.new
+      model.instance_variable_set(:@image, 'ship.jpg')
+      model.image.url.should == '/images/ship.jpg'
+      model.image.file.path.should == "/storage/images/ship.jpg"
+
+      # updating
+      file2 = "#{@shared_dir}/ship2.jpg".to_file
+      model.image = file2
+      model.instance_variable_get(:@image).should == 'ship2.jpg'
+      model.image.original.path.should == "#{@shared_dir}/ship2.jpg"
+      model.image.url.should == '/images/ship.jpg'
+      model.image.file.path.should == "/storage/images/ship.jpg"
+
+      model.save.should be_true
+      model.instance_variable_get(:@image).should == 'ship2.jpg'
+      model.image.url.should == '/images/ship2.jpg'
+      model.image.file.path.should == "/storage/images/ship2.jpg"
+      "#{@tmp_dir}/storage/images/ship.jpg".to_file.exist?.should be_false
+      "#{@tmp_dir}/storage/images/ship2.jpg".to_file.exist?.should be_true
+
+      # destroying
+      model.destroy.should be_true
+      "#{@tmp_dir}/storage/images/ship2.jpg".to_file.exist?.should be_false
+    end
+
+    it "should be able to submit errors and interrupt model saving" do
+      file = "#{@shared_dir}/invalid.txt".to_file
+      model = @model_class.new
+      model.image = file
+      model.image.should_not_receive(:save)
+      model.save.should be_false
+      model.errors[:image].should == ['invalid name']
+    end
+  end
+end

data/lib/file_model/version.rb

@@ -0,0 +1,22 @@
+class FileModel::Version
+  def initialize model, version_name
+    @model, @version_name = model, version_name
+  end
+
+  def url
+    name && build_url(name, version_name)
+  end
+
+  def file
+    name && model.class.box[build_path(name, version_name)]
+  end
+
+  def process &block
+    block.call original
+  end
+
+  protected
+    attr_reader :model, :version_name
+
+    delegate :original, :name, :build_path, :build_url, to: :model
+end

data/lib/file_model.rb

@@ -0,0 +1,11 @@
+module FileModel; end
+
+require 'vfs'
+require 'ruby_ext'
+
+%w(
+  gems
+  version
+  helper
+  file_model
+).each{|f| require "file_model/#{f}"}

data/readme.md

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

data/spec/abstract_model_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'file_model/spec/shared_crud'
+
+describe 'Model Integration' do
+  it_should_behave_like "file model crud"
+
+  before :all do
+    class ImageFile; end
+
+    class TheModel < ModelStub
+      inherit FileModel::Helper
+
+      mount_file :image, ImageFile
+
+      def attribute_get name
+        instance_variable_get :"@#{name}"
+      end
+      def attribute_set name, value
+        instance_variable_set :"@#{name}", value
+      end
+
+      before_validate.push -> _self {
+        self.image.validate
+        self.errors[:image] = image.errors unless image.errors.empty?
+      }
+
+      after_save.push -> _self {self.image.save}
+
+      after_destroy.push -> _self {self.image.destroy}
+    end
+  end
+  after(:all){remove_constants :TheModel}
+
+  before{@model_class = TheModel}
+end

data/spec/file_model_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/file_model_spec.rb

@@ -0,0 +1,174 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe "File Model" do
+  with_tmp_spec_dir
+
+  before :all do
+    class ImageFile
+      inherit FileModel
+
+      def process &block
+        block.call original
+      end
+
+      version :icon do
+        def process &block
+          block.call original
+        end
+      end
+
+      def build_path name, version = nil
+        '/storage/images' + super
+      end
+
+      def build_url name, version = nil
+        '/images' + super
+      end
+
+      def build_name name
+        name.gsub '+', ' '
+      end
+
+      def validate
+        super
+        errors << 'invalid name' if original and original.name =~ /invalid/
+      end
+    end
+  end
+  after(:all){remove_constants :ImageFile, :AvatarFile}
+
+  before do
+    ImageFile.box = Vos::Box.new(Vos::Drivers::Local.new(spec_dir))
+    @file = "#{spec_dir}/ship.jpg".to_file
+  end
+
+  it "CRUD" do
+    # blank
+    image = ImageFile.new
+    image.name.should be_nil
+    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.name.should be_nil
+    image.file.should be_nil
+    image.url.should == nil
+
+    image.icon.original.should == image.original
+    image.icon.name.should be_nil
+    image.icon.file.should be_nil
+    image.icon.url.should == nil
+
+    # writing
+    image.save.should be_true
+    image.name.should == 'ship.jpg'
+    image.file.name.should == 'ship.jpg'
+    image.file.path.should == "/storage/images/ship.jpg"
+    image.file.exist?.should be_true
+    image.url.should == '/images/ship.jpg'
+
+    image.icon.name.should == 'ship.jpg'
+    image.icon.file.name.should == 'ship.icon.jpg'
+    image.icon.file.path.should == "/storage/images/ship.icon.jpg"
+    image.icon.file.exist?.should be_true
+    image.icon.url.should == '/images/ship.icon.jpg'
+
+    # reading
+    image = ImageFile.new
+    image.read 'ship.jpg'
+    image.name.should == 'ship.jpg'
+
+    image.file.name.should == 'ship.jpg'
+    image.file.path.should == "/storage/images/ship.jpg"
+    image.file.exist?.should be_true
+    image.url.should == '/images/ship.jpg'
+
+    image.name.should == 'ship.jpg'
+    image.icon.file.name.should == 'ship.icon.jpg'
+    image.icon.file.path.should == "/storage/images/ship.icon.jpg"
+    image.icon.file.exist?.should be_true
+    image.icon.url.should == '/images/ship.icon.jpg'
+
+    # updating
+    image.original = "#{spec_dir}/ship2.jpg".to_file
+    image.original.name.should == 'ship2.jpg'
+    image.original.path.should == "#{spec_dir}/ship2.jpg"
+
+    image.save.should be_true
+
+    "#{spec_dir}/storage/images/ship.jpg".to_file.exist?.should be_false
+    "#{spec_dir}/storage/images/ship.icon.jpg".to_file.exist?.should be_false
+
+    image.name.should == 'ship2.jpg'
+    image.file.name.should == 'ship2.jpg'
+    image.file.path.should == "/storage/images/ship2.jpg"
+    image.file.exist?.should be_true
+    image.url.should == '/images/ship2.jpg'
+
+    image.icon.name.should == 'ship2.jpg'
+    image.icon.file.name.should == 'ship2.icon.jpg'
+    image.icon.file.path.should == "/storage/images/ship2.icon.jpg"
+    image.icon.file.exist?.should be_true
+    image.icon.url.should == '/images/ship2.icon.jpg'
+
+    # destroying
+    image = ImageFile.new
+    image.read 'ship2.jpg'
+    image.destroy
+    "#{spec_dir}/storage/images/ship2.jpg".to_file.exist?.should be_false
+    "#{spec_dir}/storage/images/ship2.icon.jpg".to_file.exist?.should be_false
+  end
+
+  it "should preserve spaces and unicode characters in filename" do
+    image = ImageFile.new
+    image.original = "#{spec_dir}/файл с пробелами.txt".to_file
+    image.save.should be_true
+    image.url.should =~ /\/файл с пробелами\.txt/
+    image.file.path.should =~ /\/файл с пробелами\.txt/
+  end
+
+  it "should escape + sign" do
+    image = ImageFile.new
+    image.original = "#{spec_dir}/file+name.txt".to_file
+    image.save.should be_true
+    image.url.should =~ /\/file name\.txt/
+    image.file.path.should =~ /\/file name\.txt/
+  end
+
+  it 'should raise error if file not exists' do
+    image = ImageFile.new
+    -> {image.original = "#{spec_dir}/non existing file.jpg".to_file}.should raise_error(/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.txt".to_file
+    image.validate
+    image.errors.should == ['invalid name']
+
+    -> {image.save}.should raise_error(/invalid/)
+  end
+
+  it 'should accept anything responding to :to_file' do
+    file = "#{spec_dir}/ship.jpg".to_file
+
+    obj = mock
+    obj.should_receive(:to_file).and_return(file)
+
+    image = ImageFile.new
+    image.original = obj
+    image.original.should == file
+  end
+end

data/spec/spec_helper/model_stub.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'file_model'
+require 'vos'
+
+require 'rspec_ext'
+require 'spec_helper/model_stub'

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: file_model
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alexey Petrushin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-30 00:00:00.000000000Z
+dependencies: []
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- readme.md
+- lib/file_model/file_model.rb
+- lib/file_model/gems.rb
+- lib/file_model/helper.rb
+- lib/file_model/spec/shared_crud/invalid.txt
+- lib/file_model/spec/shared_crud/ship.jpg
+- lib/file_model/spec/shared_crud/ship2.jpg
+- lib/file_model/spec/shared_crud.rb
+- lib/file_model/version.rb
+- lib/file_model.rb
+- spec/abstract_model_spec.rb
+- spec/file_model_spec/file+name.txt
+- spec/file_model_spec/invalid.txt
+- spec/file_model_spec/ship.jpg
+- spec/file_model_spec/ship2.jpg
+- spec/file_model_spec/файл с пробелами.txt
+- spec/file_model_spec.rb
+- spec/spec_helper/model_stub.rb
+- spec/spec_helper.rb
+homepage: http://github.com/alexeypetrushin/file_model
+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: []