best_type 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d0a354dd631cb8c8c051dcb86a5ce63b8921dec
-  data.tar.gz: 57fe2ddc45928bbd3d18f9d3350f414d4de30147
+  metadata.gz: 9b2371da6f225b1bd22acd81086ea29b9e219f02
+  data.tar.gz: 27b8760b8632f7716eece5a0889327ae57c3da9a
 SHA512:
-  metadata.gz: 72876496600f945fbbf2f6faf8145592dfb4eefe856afc8587feb51f29b3aa920e9477489e25d6b78600edaaffb4fe9ff01e04f97b782013e187a88829239184
-  data.tar.gz: 93534fa26253ee1d95940af36f884e7f1856fd690812c41dfba399d2a62d54e3dc4812d4f35ad607527a72dbb7277534680de5833802626dbf012fe15c5f0782
+  metadata.gz: 7d8a536b778ade2b05994d6e958975a5672ffd6953946e8f677faa801d014c1ab4c13399a3b4678d2fd9c8c3477716b14867f2dd5620fc3e5d14e5cf8650da6e
+  data.tar.gz: a6f9920f32d467b5f9f18e5598da3363cbc85e62981639ec99e64ea98b7068146f7729207c588d35a2a419250f9834dce1cd11b1b16ca2711b35580df06f14bd

data/README.md

@@ -1,6 +1,6 @@
 # best_type
 
-A pure-ruby library for selecting the best MIME type for a file name, or DC type for a file name / MIME type.
+A pure-ruby library for selecting the best MIME type for a file name or DC type (http://dublincore.org/2012/06/14/dctype) for a file name / MIME type.
 
 ### Installation
 
@@ -8,33 +8,91 @@ A pure-ruby library for selecting the best MIME type for a file name, or DC type
 gem install best_type
 ```
 
-### Standalone Usage
+### Usage
 
 ```ruby
+# require the gem
 require 'best_type'
 
-TODO: Provide usage examples
+# detect mime type for file names
+BestType.mime_type.for_file_name('myfile.jpg') # 'image/jpeg'
+
+# detect mime type for file names (including full file path)
+BestType.mime_type.for_file_name('/path/to/some/file.jpg') # 'image/jpeg'
+
+# detect dc type for file names
+BestType.dc_type.for_file_name('myfile.jpg') # 'StillImage'
+
+# detect dc type for file names (including full file path)
+BestType.dc_type.for_file_name('/path/to/some/file.jpg') # 'StillImage'
+
+# detect dc type for mime types
+BestType.dc_type.for_mime_type('image/jpeg') # 'StillImage'
 ```
 
-### Rails Usage
+### Add Custom Overrides
+```ruby
+BestType.configure({
+  extension_to_mime_type_overrides:
+    'custom': 'custom/type'
+  mime_type_to_dc_type_overrides:
+    'custom/type': 'Custom'
+})
+
+BestType.mime_type.for_file_name('myfile.custom') # 'custom/type'
+BestType.dc_type.for_file_name('myfile.custom') # 'Custom'
+BestType.dc_type.for_mime_type('custom/type') # 'Custom'
+
+```
 
-Gemfile:
+### Recommended Setup For Rails
+
+Add best_type to your Gemfile:
 ```ruby
 gem 'best_type'
 ```
 
-Adding Custom Overrides via initializer (config/initializers/best_type.rb):
+And then call it from anywhere!
+
+If you want to set custom overrides, the best place to do so is in a Rails initializer:
 ```ruby
-# via hash
+# config/initializers/best_type.rb
+
 BestType.configure({
   extension_to_mime_type_overrides:
-    'ext': 'mime/type'
+    'custom': 'custom/type'
   mime_type_to_dc_type_overrides:
-    'mime/type': 'GreatType'
+    'custom/type': 'Custom'
 })
+```
+
+You may also want to consider using a YAML file for configuration:
+```ruby
+# config/initializers/best_type.rb
+
+BestType.configure(YAML.load_file(File.join(Rails.root, 'config/best_type.yml'))[Rails.env])
+```
+
+```yaml
+# config/initializers/best_type.rb
+
+development:
+  extension_to_mime_type_overrides:
+    'good': 'good/type'
+  mime_type_to_dc_type_overrides:
+    'good/type': 'Good'
+    
+test:
+  extension_to_mime_type_overrides:
+    'better': 'better/type'
+  mime_type_to_dc_type_overrides:
+    'better/type': 'Better'
 
-# via YAML file, based on Rails environment:
-BestType.configure(YAML.load_file('config/best_type.yml')[Rails.env])
+production:
+  extension_to_mime_type_overrides:
+    'best': 'best/type'
+  mime_type_to_dc_type_overrides:
+    'best/type': 'Best'
 ```
 
 ### Running Tests (for developers):
@@ -49,4 +107,4 @@ bundle exec rake best_type:ci
 
 ```sh
 bundle exec rake release
-```
+```

data/lib/best_type/dc_type_lookup.rb

@@ -3,6 +3,8 @@ module BestType
 
     attr_reader :config
 
+    FALLBACK_DC_TYPE = 'Software'.freeze
+
     def initialize(mime_type_lookup_instance)
       @mime_type_lookup = mime_type_lookup_instance
       @config = @mime_type_lookup.config
@@ -28,7 +30,7 @@ module BestType
       }
 
       dc_type = mimes_to_dc.find { |pattern, _type_val| mime_type =~ pattern }
-      dc_type.last
+      dc_type.nil? ? FALLBACK_DC_TYPE : dc_type.last
     end
 
   end

data/lib/best_type/version.rb

@@ -1,6 +1,6 @@
 module BestType
 
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.3'.freeze
 
   def self.version
     VERSION

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: best_type
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Eric O'Hanlon