wfl_file_base 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b1b56b3c13fa48b7e8c3859d64e8ee75c0d524ab
+  data.tar.gz: 24faf6d8777d3404ff3c625b063c1d1d25f16c1f
+SHA512:
+  metadata.gz: 25c11169c55bfebb6b129cf98ee10ba02dcd25cfe1f53d9d7a01193889921e729a72c69da66eda26da1f62d34274e08d7abbb33bec316980b60a8239287e4c20
+  data.tar.gz: f86afd4c191ecc0975c3fe11a985c57b2fc264b4ab1ee974007fcd26a2a217696bbfeae028267db2fa3b43191e09ebb7a894331a7cdc8a746ee201764f15399b

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wfl_file_base.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 wpzero
+
+MIT License
+
+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,155 @@
+# WflFileBase
+
+this gem is used to map a file to a record based on the activerecord.
+this gem is very simple and small. but I think it can fit most the requests of u.
+this gem is similar to carrierwave. I must admit 'yes'
+before I write this gem, I use the carrierwave in my project, my project has the function network disk. but the carrierwave can not bind the folder to a record(so not fit my request and the carrier is too fat).so I write a gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'wfl_file_base'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wfl_file_base
+
+## Usage
+
+in application.rb
+
+```
+WflFileBase.configure do |config|
+  config.root = APP_ROOT + '/public/'
+  config.tmp_dir = 'tmp'
+end
+```
+is used to set the tmp_dir and the application root folder.
+
+
+
+
+create WflFileBase::Base subclass and override the filename ,  dir_name the method, to set the file location.
+
+such as:
+
+```
+require 'digest/md5'
+require 'carrierwave/processing/mime_types'
+require_relative '../services/file_system/file_path_setting'
+require_relative '../services/file_system/base/md5_process'
+
+class NormalFileBase < WflFileBase::Base
+
+  pre_process :save_content_type_and_size_in_model
+
+  def store_dir
+    FileSys::FilePathSetting.resource_path + '/' + md5init
+  end
+
+  def filename
+      @name ||= md5
+  end
+
+  def filename_was
+      model.send(:"#{column}_was")
+  end
+
+  def md5
+  	# creat process
+  	if self.store
+      puts '---------new'
+      file.rewind
+  		@md5 ||= FileSys::Md5Process.send(:get_md5_name, :content => file.read.to_s, :size => file.size.to_s)
+  	# read process
+  	else
+      puts '---------old'
+  		model.read_attribute(column)
+  	end
+  end
+
+  def md5init
+  	md5[0].upcase
+  end
+
+  def save_content_type_and_size_in_model
+    model.content_type = file.mime_type if file.mime_type
+    model.file_size = file.size
+  end
+end
+```
+
+
+
+use wfl_mount_file_base activereord macro to bind column and WflFileBase::Base subclass.
+
+such as:
+
+```
+require_relative 'md5_process'
+
+module FileSys
+	class FileResource < ActiveRecord::Base
+
+		wfl_mount_file_base :file, NormalFileBase
+
+		before_save :update_file_attributes
+
+		class << self
+			def find_or_create_file_resource file
+				file=file[:tempfile] if file.is_a?(Hash) && file[:tempfile].is_a?(Tempfile)
+				file.rewind
+				file_resource = self.find_by_file(Md5Process.get_md5_name(:content => file.read.to_s, :size => file.size.to_s))
+				if !file_resource
+					file_resource = FileSys::FileResource.create(:file => file)
+				end
+				file_resource
+			end
+
+			def find_by_path url
+				find_by_file File.basename(url)
+			end
+		end
+
+		def read
+			file.read
+		end
+		
+		private
+		def update_file_attributes
+		    if file.present?
+		      self.md5_val  = file.md5
+		    end
+		end
+	end
+end
+```
+
+now we can use FileSys::FileResource simplely.
+
+```
+f = FileSys::FileResource.new
+f.file = File.open('tmp.txt')
+f.save
+f.file  # => <SymbleFileBase>
+f.file.file # => <File>
+f.file.read # => 'String'
+```
+
+
+
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/wfl_file_base/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/wfl_file_base.rb

@@ -0,0 +1,22 @@
+require "wfl_file_base/version"
+
+module WflFileBase
+
+	class << self
+		attr_reader :config
+		def configure
+			@config = WflFileBaseConfig.instance
+			yield(@config) if block_given?
+		end
+	end
+
+
+	class WflFileBaseConfig
+		attr_accessor :root, :tmp_dir
+		include Singleton
+	end
+end
+
+require "wfl_file_base/file"
+require "wfl_file_base/base"
+require "wfl_file_base/record"

data/lib/wfl_file_base/base.rb

@@ -0,0 +1,162 @@
+
+module WflFileBase
+	class Base
+		attr_accessor :column, :model, :file, :store
+
+		def initialize column, model
+			self.column = column
+			self.model = model
+			self.store = false
+			if model.read_attribute(column).is_a? File
+				self.file = model.read_attribute(column)
+			elsif model.read_attribute(column).is_a? Tempfile
+				self.file = model.read_attribute(column)
+			elsif model.read_attribute(column).is_a?(Hash) && model.read_attribute(column)[:tempfile].is_a?(Tempfile)
+				self.file = model.read_attribute(column)[:tempfile]
+			elsif self.filename.is_a?(String) && !self.filename.empty? && File.exist?(self.path)
+				self.file = File.open(self.path)
+			end
+		end
+
+		def store_dir
+			model.id
+		end
+
+		def filename
+			'original'
+		end
+
+		def path
+			"#{WflFileBase.config.root}#{self.url}"
+		end
+
+		def url
+			"#{self.store_dir}/#{self.filename}"
+		end
+
+		def abs_store_dir
+			"#{WflFileBase.config.root}#{self.store_dir}"
+		end
+
+
+		def read
+			if file && !File.directory?(file)
+				file.send(:read)
+			else
+				nil
+			end
+		end
+
+		def method_missing(method, *args)
+			if file
+				file.methods.include?(method) ? file.send(method, *args) : super
+			end
+		end
+
+		def respond_to? method
+			file.methods.include?(method) || super
+		end
+
+		def is_new?
+			model.read_attribute(column).is_a?(File) || model.read_attribute(column).is_a?(Tempfile) || (model.read_attribute(column).is_a?(Hash) && model.read_attribute(column)[:tempfile].is_a?(Tempfile))
+		end
+
+		class << self
+			attr_reader :wfl_process_methods, :wfl_pre_process_methods
+
+			def process method_name
+				@wfl_process_methods ||= []
+				@wfl_process_methods.push method_name
+			end
+
+			def pre_process method_name
+				@wfl_pre_process_methods ||= []
+				@wfl_pre_process_methods.push method_name
+			end
+		end
+
+		private
+
+		def write_column
+			self.store = true
+			model.send(:write_attribute, :"#{column}", self.filename)
+			delete_old_file
+			if self.class.wfl_pre_process_methods
+				self.class.wfl_pre_process_methods.each do |process_method|
+					self.send(process_method)
+				end
+			end
+		end
+
+		def build_file
+			FileUtils.mkdir_p(abs_store_dir) unless File.exists?(abs_store_dir)
+			temple_file = self.file
+			if temple_file.is_a?(Tempfile)
+				FileUtils.copy(tmpfile_to_file(temple_file), path)
+				File.delete(tmp_file_path) if File.exists?(tmp_file_path)
+			elsif temple_file.is_a?(Hash) && temple_file[:tempfile].is_a?(Tempfile)
+				FileUtils.copy(tmpfile_to_file(temple_file[:tempfile]), path)
+				File.delete(tmp_file_path) if File.exists?(tmp_file_path)
+			elsif temple_file.is_a?(File) && File.directory?(temple_file)
+				FileUtils.mkdir_p(path)
+			elsif temple_file.is_a?(File)
+				FileUtils.copy temple_file, path
+			else
+				return nil
+			end
+
+			self.file = File.open(path)
+
+			if self.class.wfl_process_methods
+				self.class.wfl_process_methods.each do |process_method|
+					self.send(process_method)
+				end
+			end
+			self.store = false
+		end
+
+		def delete_old_file
+			if !model.new_record? && !model.send(:"#{column}_was").nil? && !model.send(:"#{column}_was").empty?
+				File.delete(path_was) if File.exist?(path_was) && !File.directory?(path_was)
+			end
+		end
+
+		def path_was
+			"#{WflFileBase.config.root}#{self.store_dir}/#{self.filename_was}"
+		end
+
+		def remove_file
+			if File.exist?(file) && File.directory?(file)
+				FileUtils.remove_dir file
+			elsif File.exist?(file) 
+				File.delete file
+			end
+		end
+
+		def tmpfile_to_file file
+			if file.is_a? Tempfile
+				FileUtils.mkdir_p(tmp_file_dir) unless File.exists?(tmp_file_dir)
+				File.delete(tmp_file_path) if File.exists?(tmp_file_path)
+				file.rewind
+				File.open(tmp_file_path, 'w') do |f|
+					f.write(file.read)
+				end
+				File.open(tmp_file_path)
+			end
+		end
+
+		def tmp_file_path
+			"#{tmp_file_dir}/#{tmp_file_name}"
+		end
+
+		def tmp_file_name
+			@uu_name ||= SecureRandom.uuid
+		end
+
+		def tmp_file_dir
+			"#{WflFileBase.config.root}#{WflFileBase.config.tmp_dir}"
+		end
+
+	end
+
+end

data/lib/wfl_file_base/file.rb

@@ -0,0 +1,44 @@
+
+
+module WflMimeType
+	def self.included(base)
+		base.extend ClassMethods
+		base.class_eval do 
+		    def mime_type
+		        `file --brief --mime-type #{self.path}`.strip
+		    end
+
+		    def charset
+		        `file --brief --mime #{self.path}`.split(';').second.split('=').second.strip
+		    end
+		end
+	end
+
+	module ClassMethods
+		def mime_type file
+			if file.is_a?(String) && File.exist?(file)
+				file = File.open(file)
+				`file --brief --mime-type #{file.path}`.strip
+			elsif (file.is_a?(File) && !File.directory?(file))
+				`file --brief --mime-type #{file.path}`.strip
+			else
+				raise 'the path is useless or the file is useless'
+			end
+		end
+
+		def charset
+			if file.is_a?(String) && File.exist?(file)
+				file = File.open(file)
+				`file --brief --mime #{file.path}`.split(';').second.split('=').second.strip
+			elsif (file.is_a?(File) && !File.directory?(file))
+				`file --brief --mime #{file.path}`.split(';').second.split('=').second.strip
+			else
+				raise 'the path is useless or the file is useless'
+			end
+		end
+	end
+end
+
+class File
+	include WflMimeType
+end

data/lib/wfl_file_base/record.rb

@@ -0,0 +1,32 @@
+class << ActiveRecord::Base
+	def wfl_mount_file_base column, uploader_class
+
+		self.class_eval do
+
+			define_method column.to_sym do
+				@uploader ||= uploader_class.new(column, self)
+			end
+
+			define_method "write_#{column}" do
+				if self.send("#{column}_changed?") && (self.read_attribute(column).is_a?(File) || (self.read_attribute(column).is_a?(Hash) && self.read_attribute(column)[:tempfile].is_a?(Tempfile)) || self.read_attribute(column).is_a?(Tempfile))
+					self.send(column).send(:write_column)
+				end
+			end
+
+			define_method "store_#{column}" do
+				if self.send(column).store
+					self.send(column).send(:build_file)
+				end
+			end
+
+			define_method "remove_#{column}" do
+				self.send(column).send(:remove_file)
+			end
+
+		end
+		self.after_save :"store_#{column}"
+		self.before_save :"write_#{column}"
+		self.after_commit :"remove_#{column}", :on => :destroy
+	end
+
+end

data/lib/wfl_file_base/version.rb

@@ -0,0 +1,3 @@
+module WflFileBase
+  VERSION = "0.0.2"
+end

data/wfl_file_base.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wfl_file_base/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wfl_file_base"
+  spec.version       = WflFileBase::VERSION
+  spec.authors       = ["wpzero"]
+  spec.email         = ["wpcreep@gmail.com"]
+  spec.summary       = %q{map file to a range of ORMs, store them on different backends}
+  spec.description   = %q{map file to a range of ORMs, store them on different backends. it can bind a record to a folder}
+  spec.homepage      = "https://github.com/wpzero/wfl_file_base"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord" 
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: wfl_file_base
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- wpzero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: map file to a range of ORMs, store them on different backends. it can
+  bind a record to a folder
+email:
+- wpcreep@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/wfl_file_base.rb
+- lib/wfl_file_base/base.rb
+- lib/wfl_file_base/file.rb
+- lib/wfl_file_base/record.rb
+- lib/wfl_file_base/version.rb
+- wfl_file_base.gemspec
+homepage: https://github.com/wpzero/wfl_file_base
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: map file to a range of ORMs, store them on different backends
+test_files: []