shrine-gridfs 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0c54bce081cf7e9ddfb91319ea7c7f2b87dce4d
-  data.tar.gz: 218dee27bac26e562c22ceaf8e1694dc221a90c2
+  metadata.gz: 6e8fabfa3388d58c758b30e733442cc7391abe20
+  data.tar.gz: 52f633d0fbf668df2275c4b238af1954ecf77c87
 SHA512:
-  metadata.gz: a4246aab41aa653b47c554990252302e94998e530390bffe9dacce31d2d7cfc9a5520babd5c0fb5bc4947bf400311920de9c9c4e4453c1f2cbc2471401871fb4
-  data.tar.gz: f61d44f87bbd1aa65da985d90964924a81a50d6c9e819113a645d353738c86abf851f0f217b80b066c86f81a5334d453f0c6cc682a3c4122e5c4cbbb54b6a7d4
+  metadata.gz: fe629ee33d419e92a360dbec5236a9d57f11b239f5e1ef54942341cc70d0692e83e930421143a653f4b1d1e7773ddfcb081c032cb920f31c996dd3035a35e1aa
+  data.tar.gz: ebf937d63144034f7354cc26f656a0a4f9bfadf18d36625911d1ad00e3adee8abc71c5d8f3de3a08b3f89080ffeac5ca47910388bdade63a4f25fbec433c8e00

data/README.md

@@ -22,6 +22,8 @@ client = Mongo::Client.new("mongodb://127.0.0.1:27017/mydb")
 Shrine::Storage::Gridfs.new(client: client)
 ```
 
+### Prefix
+
 The default prefix (bucket name) is "fs", you can change it with the `:prefix`
 option:
 
@@ -29,6 +31,15 @@ option:
 Shrine::Storage::Gridfs.new(client: client, prefix: "foo")
 ```
 
+### Chunk size
+
+By default the Gridfs storage will store files in chunks of 256KB, you can
+change that via `:chunk_size`:
+
+```rb
+Shrine::Storage::Gridfs.new(client: client, chunk_size: 1*1024*1024) # 1MB
+```
+
 ### URLs
 
 You can generate URLs through which the GridFS files will be streamed with the
@@ -56,7 +67,7 @@ $ bundle exec rake test
 
 ## Inspiration
 
-This gem has been inspired by [refile-gridfs].
+This gem was inspired by [refile-gridfs].
 
 ## License
 

data/lib/shrine/storage/gridfs.rb

@@ -1,30 +1,50 @@
 require "shrine"
 require "mongo"
 require "down"
-
-require "stringio"
+require "digest"
 
 class Shrine
   module Storage
     class Gridfs
-      attr_reader :client, :prefix, :bucket
+      attr_reader :client, :prefix, :bucket, :chunk_size
+
+      BATCH_SIZE = 5 * 1024 * 1024
+
+      def initialize(client:, prefix: "fs", chunk_size: 256*1024, **options)
+        @client     = client
+        @prefix     = prefix
+        @chunk_size = chunk_size
+        @bucket     = @client.database.fs(bucket_name: @prefix)
 
-      def initialize(client:, prefix: "fs", **options)
-        @client = client
-        @prefix = prefix
-        @bucket = @client.database.fs(bucket_name: @prefix)
         @bucket.send(:ensure_indexes!)
       end
 
-      def upload(io, id, shrine_metadata: {}, **upload_options)
-        filename = shrine_metadata["filename"] || id
-        file = Mongo::Grid::File.new(io, filename: filename, metadata: shrine_metadata)
-        result = bucket.insert_one(file)
-        id.replace(result.to_s + File.extname(id))
+      def upload(io, id, shrine_metadata: {}, **)
+        file = create_file(id, shrine_metadata: shrine_metadata)
+
+        until io.eof?
+          chunk = io.read([BATCH_SIZE, chunk_size].max, buffer ||= "")
+          grid_chunks = Mongo::Grid::File::Chunk.split(chunk, file.info, offset ||= 0)
+
+          chunks_collection.insert_many(grid_chunks)
+
+          offset += grid_chunks.count
+          grid_chunks.each { |grid_chunk| grid_chunk.data.data.clear } # deallocate strings
+          chunk.clear # deallocate string
+        end
+
+        files_collection.find(_id: file.id).update_one("$set" => {md5: file.info.md5.hexdigest})
+      end
+
+      def move(io, id, shrine_metadata: {}, **)
+        file = create_file(id, shrine_metadata: shrine_metadata)
+
+        chunks_collection.find(files_id: bson_id(io.id)).update_many("$set" => {files_id: file.id})
+        files_collection.delete_one(_id: bson_id(io.id))
       end
 
-      def download(id)
-        Down.copy_to_tempfile(id, open(id))
+      def movable?(io, id)
+        io.is_a?(UploadedFile) && io.storage.is_a?(Storage::Gridfs)
       end
 
       def open(id)
@@ -38,45 +58,53 @@ class Shrine
         )
       end
 
-      def read(id)
-        stringio = StringIO.new
-        bucket.download_to_stream(bson_id(id), stringio)
-        stringio.string
-      end
-
       def exists?(id)
         !!bucket.find(_id: bson_id(id)).first
       end
 
       def delete(id)
         bucket.delete(bson_id(id))
+      rescue Mongo::Error::FileNotFound
       end
 
       def multi_delete(ids)
         ids = ids.map { |id| bson_id(id) }
-        bucket.files_collection.find(_id: {"$in" => ids}).delete_many
-        bucket.chunks_collection.find(files_id: {"$in" => ids}).delete_many
+        files_collection.find(_id: {"$in" => ids}).delete_many
+        chunks_collection.find(files_id: {"$in" => ids}).delete_many
       end
 
-      def url(id, **options)
+      def url(id, **)
       end
 
       def clear!
-        bucket.files_collection.find.delete_many
-        bucket.chunks_collection.find.delete_many
+        files_collection.find.delete_many
+        chunks_collection.find.delete_many
       end
 
-      def method_missing(name, *args)
-        if name == :stream
-          warn "Shrine::Storage::Gridfs#stream is deprecated over calling #each_chunk on result of Gridfs#open."
-          content_length = bucket.find(_id: bson_id(*args)).first["length"]
-          bucket.open_download_stream(bson_id(*args)) do |stream|
-            stream.each { |chunk| yield chunk, content_length }
-          end
-        end
+      private
+
+      def create_file(id, shrine_metadata: {})
+        file = Mongo::Grid::File.new("",
+          filename:     shrine_metadata["filename"] || id,
+          content_type: shrine_metadata["mime_type"],
+          metadata:     shrine_metadata,
+          chunk_size:   chunk_size,
+        )
+        id.replace(file.id.to_s + File.extname(id))
+
+        bucket.insert_one(file)
+
+        file.info.document[:md5] = Digest::MD5.new
+        file
       end
 
-      private
+      def files_collection
+        bucket.files_collection
+      end
+
+      def chunks_collection
+        bucket.chunks_collection
+      end
 
       def bson_id(id)
         BSON::ObjectId(File.basename(id, ".*"))

data/shrine-gridfs.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "shrine-gridfs"
-  gem.version       = "0.2.1"
+  gem.version       = "0.3.0"
 
   gem.required_ruby_version = ">= 2.1"
 
@@ -13,7 +13,7 @@ Gem::Specification.new do |gem|
   gem.files        = Dir["README.md", "LICENSE.txt", "lib/**/*.rb", "shrine-gridfs.gemspec"]
   gem.require_path = "lib"
 
-  gem.add_dependency "shrine", "~> 2.0"
+  gem.add_dependency "shrine", "~> 2.2"
   gem.add_dependency "mongo", ">= 2.2.2", "< 3"
   gem.add_dependency "down", ">= 2.3.3"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine-gridfs
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-24 00:00:00.000000000 Z
+date: 2017-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shrine
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: mongo
   requirement: !ruby/object:Gem::Requirement
@@ -136,4 +136,3 @@ signing_key:
 specification_version: 4
 summary: Provides MongoDB's GridFS storage for Shrine.
 test_files: []
-has_rdoc: