carrierwave-hex-prefix-for-file-storage 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed34f82b2cf8085d4a3e41070d038fc99f839634
+  data.tar.gz: d9ea3e422629a6a4107037f8837a3cc3545969d5
+SHA512:
+  metadata.gz: e128fa9e19af5271a1a806d60b65790b026029c90c0cbcb8c85b49c5cfb4575806005b6b75baef49ff0017d81032751efca41bf964150579426a71e324c0d403
+  data.tar.gz: 0d431e49b2af1bd308105a8171d9f77356d3fd75df11dba3fedb53f7cb18ccbde2a17ff2f36300b3af3af2ff1aaf05128951311ad769fad55e10fcbc3c2fc48a

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright 2014 Marcin Lewandowski
+
+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,63 @@
+# Introduction
+
+This is a simple Ryby gem that just enscapsulates directory naming scheme for [carrierwave's](https://github.com/carrierwaveuploader/carrierwave) file storage, enabling creation of directory structure that will be efficient and survive subdirectories limit.
+
+
+## Problem
+
+If you have plenty of attachments you can encounter slowdowns or OS will reject creating next subdirectory at some point. 
+
+It is due to the fact that some filesystems have limit of subdirectories (for example: 64000 in ext4, until you enable the file system feature flag dir_nlink). Moreover, having a flat subdirectories structure can be suboptimal.
+
+## Solution
+
+Create directory structure of following syntax:
+
+    (ROOT_PATH)/(model class)/(mounted as)/(record's ID in hex split into groups of max 3 characters)/(file name)
+
+For example:
+
+    /home/myrailsapp/public/system/User/Avatar/af7/233/1a3/12/whatever.mp3
+
+
+# Installation
+
+Add to your Gemfile:
+
+    gem "carrierwave-hex-prefix-for-file-storage"
+
+and then type:
+
+    bundle install
+
+Then include it in your Uploader:
+
+    class SourceBodyUploader < CarrierWave::Uploader::Base
+      include CarrierWave::Uploader::HexPrefixForFileStorage
+      
+      storage :file
+
+      def store_dir
+        store_dir_with_hex_prefix 
+      end
+    end
+
+Optionally, you can pass a parameter to `store_dir_with_hex_prefix` in order to change root path (by default it is `RAILS_ROOT/public/system`):
+
+    class SourceBodyUploader < CarrierWave::Uploader::Base
+      include CarrierWave::Uploader::HexPrefixForFileStorage
+      
+      storage :file
+
+      def store_dir
+        store_dir_with_hex_prefix Rails.root.join("my_directory")
+      end
+    end
+
+# Changelog
+
+0.0.1 - Initial release
+
+# License
+
+MIT

data/lib/carrierwave-hex-prefix-for-file-storage.rb

@@ -0,0 +1,19 @@
+module CarrierWave
+  module Uploader
+    module HexPrefixForFileStorage
+      def store_dir_with_hex_prefix(root_path = nil)
+        if root_path.nil?
+          path = [ Rails.root.join("public", "system").to_s ]
+        else
+          path = [ root_path.to_s ]
+        end
+
+        path << model.class.to_s.underscore
+        path << mounted_as.to_s
+        model.id.to_s(16).split("").each_slice(3) { |x| path << x.join }
+
+        File.join *path
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: carrierwave-hex-prefix-for-file-storage
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marcin Lewandowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  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'
+description: Enscapsulates directory naming scheme for carrierwave's file storage,
+  enabling creation of directory structure that will be efficient and survive subdirs
+  limit.
+email:
+- marcin@saepia.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/carrierwave-hex-prefix-for-file-storage.rb
+homepage: http://github.com/mspanc/carrierwave-hex-prefix-for-file-storage
+licenses: []
+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: Creates efficient directory structure for carrierwave attachments
+test_files: []