mini_mime 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a17e3917b461405b2d2cbbc1b2d334c91cfce23c
-  data.tar.gz: a3739e8603675783ea2bc00f76bbd06a35f91b6e
+  metadata.gz: 29fa488976dc79f0fb56e06c67ba6bf35bafb827
+  data.tar.gz: 1eeb58e612b54db1e0afd64c6482fbf907ad53fe
 SHA512:
-  metadata.gz: 619ecef721791234a856cda1d310361b001c148f2a7f8d470fb922e591af6b2a8296ec6a630472965dfec537dc97ca20b056a2af93fb03a0a718b80c97b9450d
-  data.tar.gz: b690f059fee37bcef80e4fa3e21151c8bf88080f60b93ed7a41f6ea8ede9174d370bfde2fff74725619cf75191c7aea60d629d4e257184ba107f35c30b7376b1
+  metadata.gz: 1536aebde61795c374f7734347fcc0f41c9772c2cf2994006c0af7f5e4836f587fe61101c27e3658e7a8a5577ec099e819fe70cf1a223c8691b838c5ba88e41f
+  data.tar.gz: 3776428c96d2584faeb2a811628269a41f9e4ab0818f9a156a58b48a5c51ee0ad59e1d1ad7f0b313d26473dab5de92ccab890ab1ecac3b9118931903df383f8c

data/CHANGELOG

@@ -1,4 +1,9 @@
 14-12-2016
 
-   - Version 0.1.0
-   - Initial version
+  - Version 0.1.1
+  - Adjusted API to be more consistent
+
+14-12-2016
+
+  - Version 0.1.0
+  - Initial version

data/README.md

@@ -1,6 +1,6 @@
 # MiniMime
 
-Minimal mime type implementation for use with the mail and rest-client gem
+Minimal mime type implementation for use with the mail and rest-client gem.
 
 ## Installation
 
@@ -20,16 +20,74 @@ Or install it yourself as:
 
 ## Usage
 
+```
+require 'mini_mime'
+
+MiniMime.lookup_by_filename("a.txt").content_type
+# => "text/plain"
+
+MiniMime.lookup_by_content_type("text/plain").extension
+# => "txt"
+
+MiniMime.lookup_by_content_type("text/plain").binary?
+# => false
+
+```
+
+## Performance
+
+MiniMime is optimised to minimize memory usage. It keeps a cache of 100 mime type lookups (and 100 misses). There are benchmarks in the (bench directory)[https://github.com/discourse/mini_mime/bench/bench.rb]
+
+```
+Memory stats for requiring mime/types/columnar
+Total allocated: 9869358 bytes (109796 objects)
+Total retained:  3138198 bytes (31165 objects)
+
+Memory stats for requiring mini_mime
+Total allocated: 58898 bytes (398 objects)
+Total retained:  7784 bytes (62 objects)
+Warming up --------------------------------------
+cached content_type lookup MiniMime
+                        52.136k i/100ms
+content_type lookup Mime::Types
+                        32.701k i/100ms
+Calculating -------------------------------------
+cached content_type lookup MiniMime
+                        641.305k (± 3.2%) i/s -      3.232M in   5.045630s
+content_type lookup Mime::Types
+                        361.041k (± 1.5%) i/s -      1.831M in   5.073290s
+Warming up --------------------------------------
+uncached content_type lookup MiniMime
+                         3.333k i/100ms
+content_type lookup Mime::Types
+                        33.177k i/100ms
+Calculating -------------------------------------
+uncached content_type lookup MiniMime
+                         33.660k (± 1.7%) i/s -    169.983k in   5.051415s
+content_type lookup Mime::Types
+                        364.931k (± 2.8%) i/s -      1.825M in   5.004112s
+```
+
+As a general guideline, cached lookups are 2x faster than MIME::Types equivelent. Uncached lookups are 10x slower.
+
 
 ## Development
 
+MiniMime uses the officially maintained list of mime types at (mime-types-data)[https://github.com/mime-types/mime-types-data] repo to build the internal database.
+
+To update the database run:
+
+```ruby
+bundle exec rake rebuild_db
+```
+
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mini_mime. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/discourse/mini_mime. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/bench/bench.rb

@@ -0,0 +1,52 @@
+require 'memory_profiler'
+require 'benchmark/ips'
+
+$: << File.expand_path('../../lib', __FILE__)
+
+
+puts
+puts "Memory stats for requiring mime/types/columnar"
+result = MemoryProfiler.report do
+  require 'mime/types/columnar'
+end
+
+puts "Total allocated: #{result.total_allocated_memsize} bytes (#{result.total_allocated} objects)"
+puts "Total retained:  #{result.total_retained_memsize} bytes (#{result.total_retained} objects)"
+
+puts
+puts "Memory stats for requiring mini_mime"
+result = MemoryProfiler.report do
+  require 'mini_mime'
+end
+
+puts "Total allocated: #{result.total_allocated_memsize} bytes (#{result.total_allocated} objects)"
+puts "Total retained:  #{result.total_retained_memsize} bytes (#{result.total_retained} objects)"
+
+
+Benchmark.ips do |bm|
+  bm.report 'cached content_type lookup MiniMime' do
+    MiniMime.lookup_by_filename("a.txt").content_type
+  end
+
+  bm.report 'content_type lookup Mime::Types' do
+    MIME::Types.type_for("a.txt")[0].content_type
+  end
+end
+
+module MiniMime
+  class Db
+    class RandomAccessDb
+      alias_method :lookup, :lookup_uncached
+    end
+  end
+end
+
+Benchmark.ips do |bm|
+  bm.report 'uncached content_type lookup MiniMime' do
+    MiniMime.lookup_by_filename("a.txt").content_type
+  end
+
+  bm.report 'content_type lookup Mime::Types' do
+    MIME::Types.type_for("a.txt")[0].content_type
+  end
+end

data/lib/mini_mime.rb

@@ -2,36 +2,18 @@ require "mini_mime/version"
 require "thread"
 
 module MiniMime
-  BINARY_ENCODINGS = %w(base64 8bit)
-
-  # return true if this filename is known to have binary encoding
-  #
-  # puts MiniMime.binary?("file.gif") => true
-  # puts MiniMime.binary?("file.txt") => false
-  def self.binary?(filename)
-    info = Db.lookup_by_filename(filename)
-    !!(info && BINARY_ENCODINGS.include?(info.encoding))
-  end
 
-  # return true if this content type is known to have binary encoding
-  #
-  # puts MiniMime.binary_content_type?("text/plain") => false
-  # puts MiniMime.binary?("application/x-compress") => true
-  def self.binary_content_type?(mime)
-    info = Db.lookup_by_content_type(mime)
-    !!(info && BINARY_ENCODINGS.include?(info.encoding))
+  def self.lookup_by_filename(filename)
+    Db.lookup_by_filename(filename)
   end
 
-  # return first matching content type for a file
-  #
-  # puts MiniMime.content_type("test.xml") => "application/xml"
-  # puts MiniMime.content_type("test.gif") => "image/gif"
-  def self.content_type(filename)
-    info = Db.lookup_by_filename(filename)
-    info && info.content_type
+  def self.lookup_by_content_type(mime)
+    Db.lookup_by_content_type(mime)
   end
 
   class Info
+    BINARY_ENCODINGS = %w(base64 8bit)
+
     attr_accessor :extension, :content_type, :encoding
     def initialize(buffer)
       @extension,@content_type,@encoding = buffer.split(/\s+/).map!(&:freeze)
@@ -46,6 +28,10 @@ module MiniMime
         @encoding
       end
     end
+
+    def binary?
+      BINARY_ENCODINGS.include?(encoding)
+    end
   end
 
   class Db

data/lib/mini_mime/version.rb

@@ -1,3 +1,3 @@
 module MiniMime
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_mime
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-13 00:00:00.000000000 Z
+date: 2016-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,6 +81,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bench/bench.rb
 - bin/console
 - bin/setup
 - lib/db/content_type_mime.db