refile-filesystem-hashed 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b0387d44a6f8c55cc3743d4fb13da5d2c4108ef
+  data.tar.gz: d07a0d64695431cd0a920b0e5d11abd0afb395a7
+SHA512:
+  metadata.gz: 32a850c81e30212a9d57ba0db4f5d576ea6c61c006213b9867440aa800787f1d68a6cc448077ff7b3f85345b692576ad13a30d0cf5d48599c8076395ee402575
+  data.tar.gz: ed3558cbfa2e9e1f2390264f66a2d3cd523e9aa69eacfec7180ad17e78741fa6edcc9b5a6c98b06a9559030c3064219a8d649354a53f447a481452d413bbd9a1

data/.gitignore

@@ -0,0 +1,2 @@
+tmp
+.DS_Store

data/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gem 'refile', '~> 0.5'
+gem 'rspec', '~> 3.0', group: 'test'
+gem 'webmock', group: 'test'

data/Gemfile.lock

@@ -0,0 +1,62 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    domain_name (0.5.25)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (0.2.3)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    mime-types (2.99)
+    netrc (0.11.0)
+    rack (1.6.4)
+    rack-protection (1.5.3)
+      rack
+    refile (0.6.2)
+      mime-types
+      rest-client (~> 1.8)
+      sinatra (~> 1.4.5)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    safe_yaml (1.0.4)
+    sinatra (1.4.6)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    tilt (2.0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+    webmock (1.22.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  refile (~> 0.5)
+  rspec (~> 3.0)
+  webmock
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 moviepilot.de
+
+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,19 @@
+# Refile::Backend::FileSystemHashed
+
+Refile backend that's based on `Refile::Backend::FileSystem` and stores files in sub-directories based on the given file id instead of storing all files on one directory.
+
+Refile's out-of-the-box backend `Refile::Backend::FileSystem` stores all files within one directory which can get very large and makes maintenance (`ls`, etc.) very slow. This gem extends the default behavior, it splits up the directory in tiny chunks based on the given file id. For example if there is a file with id `0601ae4450cdc210ab9d05da50c392ee1c4b1894e8b2bc9cc5cc9e41e691` it stores the file in the nested directory `06/01/ae/44/0601ae4450cdc210ab9d05da50c392ee1c4b1894e8b2bc9cc5cc9e41e691` within the given directory.
+
+## Usage
+
+Add `refile-filesystem-hashed` to your Gemfile.
+
+    gem 'refile-filesystem-hashed', '~> 1.0.1', require: 'refile/backend/file_system_hashed'
+
+Replace `Refile::Backend::FileSystem` with `Refile::Backend::FileSystemHashed`.
+
+    backend = Refile::Backend::FileSystemHashed.new("/uploads")
+    backend.path('0601ae4450cdc210ab9d05da50c392ee1c4b1894e8b2bc9cc5cc9e41e691')
+    => "/uploads/06/01/ae/44/0601ae4450cdc210ab9d05da50c392ee1c4b1894e8b2bc9cc5cc9e41e691"
+
+You can replace `Refile::Backend::FileSystem` at any time as the gem will automagically move existing files to the new hashed directory structure.

data/Rakefile

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

data/lib/refile/backend/file_system_hashed.rb

@@ -0,0 +1,34 @@
+module Refile
+  module Backend
+    class FileSystemHashed < FileSystem
+      verify_uploadable def upload(uploadable)
+        id = @hasher.hash(uploadable)
+        path = path(id)
+        FileUtils.mkdir_p(::File.dirname(path))
+        IO.copy_stream(uploadable, path)
+
+        Refile::File.new(self, id)
+      end
+
+      verify_id def exists?(id)
+        return true if ::File.exist?(path(id))
+
+        if ::File.exist?(original_path(id))
+          FileUtils.mkdir_p(::File.dirname(path(id)))
+          FileUtils.mv(original_path(id), path(id))
+          return true
+        end
+
+        false
+      end
+
+      verify_id def path(id, create = false)
+        ::File.join(@directory, id.scan(/.{2}/).first(4), id)
+      end
+
+      verify_id def original_path(id)
+        ::File.join(@directory, id)
+      end
+    end
+  end
+end

data/refile-filesystem-hashed.gemspec

@@ -0,0 +1,19 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'refile-filesystem-hashed'
+  spec.version       = '1.0.2'
+  spec.authors       = ['Tim Bleck']
+  spec.email         = ['tim.bleck@webedia-group.com']
+  spec.summary       = %q{Refile backend that's based on `Refile::Backend::FileSystem` and stores files in sub-directories based on the given file id instead of storing all files on one directory.}
+  spec.homepage      = 'https://github.com/francois2metz/refile-filesystem-hashed'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'refile', '~> 0.5'
+end

data/spec/refile/file_system_hashed_spec.rb

@@ -0,0 +1,28 @@
+require 'refile/spec_helper'
+require 'refile/backend/file_system_hashed'
+
+RSpec.describe Refile::Backend::FileSystemHashed do
+  let(:backend) { Refile::Backend::FileSystemHashed.new('tmp', max_size: 100) }
+
+  it_behaves_like :backend
+
+  describe '#path' do
+    let(:orginal_backend) { Refile::Backend::FileSystem.new('tmp', max_size: 100) }
+    let(:uploadable) { Refile::FileDouble.new('hello') }
+
+    it 'generates a hashed path based on the first 8 characters given id' do
+      id = '0601ae4450cdc210ab9d05da50c392ee1c4b1894e8b2bc9cc5cc9e41e691'
+      expect(backend.path(id)).to eq(::File.join(backend.directory, '06', '01', 'ae', '44', id))
+    end
+
+    it 'automagically moves files created with the standard FileSystem backend to the new hashed directory structure' do
+      file = orginal_backend.upload(uploadable)
+
+      backend.path(file.id)
+
+      expect(backend.exists?(file.id)).to be_truthy
+      expect(backend.read(file.id)).to eq('hello')
+      expect(orginal_backend.exists?(file.id)).to be_falsy
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: refile-filesystem-hashed
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Tim Bleck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: refile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: 
+email:
+- tim.bleck@webedia-group.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/refile/backend/file_system_hashed.rb
+- refile-filesystem-hashed.gemspec
+- spec/refile/file_system_hashed_spec.rb
+homepage: https://github.com/francois2metz/refile-filesystem-hashed
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Refile backend that's based on `Refile::Backend::FileSystem` and stores files
+  in sub-directories based on the given file id instead of storing all files on one
+  directory.
+test_files:
+- spec/refile/file_system_hashed_spec.rb