best_type 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0bc9100b57430bc5ccb10f8d42d7a1741aef2bd4
+  data.tar.gz: c80b5b3f2a2d08839878dc5d17fd8cbd22f4c057
+SHA512:
+  metadata.gz: c9c8e54c2295b513cdc768a495acb11c90747455700438c943aa709f8707094273d80dede61b0c6b3e5a8d828ca493f5d2955d72b0b3f824765e57e5652393cc
+  data.tar.gz: bbdde1c4253881cadc2f6a58b041fabe4d9f3ae2805437e34a58b93bc4f1c058a93837a6ab18d85d0b62f3d503830c79bc143183dc7f76103f345bc4405afadd

data/README.md

@@ -0,0 +1,46 @@
+# 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.
+
+### Installation
+
+```bash
+gem install best_type
+```
+
+### Standalone Usage
+
+```ruby
+require 'best_type'
+
+TODO: Provide usage examples
+```
+
+### Rails Usage
+
+Gemfile:
+```ruby
+gem 'best_type'
+```
+
+Adding Custom Overrides via initializer (config/initializers/best_type.rb):
+```ruby
+# via hash
+BestType.configure({
+  extension_to_mime_type_overrides:
+    'ext': 'mime/type'
+  mime_type_to_dc_type_overrides:
+    'mime/type': 'GreatType'
+})
+
+# via YAML file, based on Rails environment:
+BestType.configure(YAML.load_file('config/best_type.yml')[Rails.env])
+```
+
+### Running Tests (for developers):
+
+Tests are great and we should run them.  Here's how:
+
+```sh
+bundle exec rake best_type:ci
+```

data/config/internal_config_options.yml

@@ -0,0 +1,6 @@
+extension_to_mime_type_overrides:
+  'test': 'test/type'
+  'mp4': 'video/mp4'
+mime_type_to_dc_type_overrides:
+  'test/type': 'Test'
+  'application/mxf': 'MovingImage'

data/lib/best_type/config.rb

@@ -0,0 +1,42 @@
+module BestType
+  class Config
+
+    attr_reader :extension_to_mime_type_overrides, :mime_type_to_dc_type_overrides
+
+    def initialize(user_config_options = {})
+      # Get defaults from internal_custom_mapping.yml in gem
+      gem_dir = Gem::Specification.find_by_name('best_type').gem_dir
+      internal_config_file_path = File.join(gem_dir, 'config/internal_config_options.yml')
+      internal_config_options = YAML.load_file(internal_config_file_path)
+
+      @extension_to_mime_type_overrides = internal_config_options['extension_to_mime_type_overrides']
+      @mime_type_to_dc_type_overrides = internal_config_options['mime_type_to_dc_type_overrides']
+
+      stringify_user_config_options_keys!(user_config_options)
+      add_extension_to_mime_type_overrides(user_config_options['extension_to_mime_type_overrides']) if user_config_options.key?('extension_to_mime_type_overrides')
+      add_mime_type_to_dc_type_overrides(user_config_options['mime_type_to_dc_type_overrides']) if user_config_options.key?('mime_type_to_dc_type_overrides')
+    end
+
+    private
+
+    def add_extension_to_mime_type_overrides(overrides)
+      @extension_to_mime_type_overrides.merge!(overrides)
+    end
+
+    def add_mime_type_to_dc_type_overrides(overrides)
+      @mime_type_to_dc_type_overrides.merge!(overrides)
+    end
+
+    def stringify_user_config_options_keys!(user_config_options)
+      user_config_options_keys = user_config_options.keys
+      user_config_options_keys.each do |key|
+        if key.is_a?(Symbol)
+          val = user_config_options.delete(key)
+          user_config_options[key.to_s] = val
+        end
+      end
+      user_config_options_keys
+    end
+
+  end
+end

data/lib/best_type/dc_type_lookup.rb

@@ -0,0 +1,35 @@
+module BestType
+  class DcTypeLookup
+
+    attr_reader :config
+
+    def initialize(mime_type_lookup_instance)
+      @mime_type_lookup = mime_type_lookup_instance
+      @config = @mime_type_lookup.config
+    end
+
+    def for_file_name(file_name_or_path)
+      for_mime_type(@mime_type_lookup.for_file_name(file_name_or_path))
+    end
+
+    def for_mime_type(mime_type)
+      # Check config overrides first
+      dc_type = @config.mime_type_to_dc_type_overrides.fetch(mime_type, nil)
+      return dc_type unless dc_type.nil?
+
+      mimes_to_dc = {
+        /^image/ => 'StillImage',
+        /^video/ => 'MovingImage',
+        /^audio/ => 'Sound',
+        /^text/ => 'Text',
+        /^application\/(pdf|msword)/ => 'Text',
+        /excel|spreadsheet|xls|application\/sql/ => 'Dataset',
+        /^application/ => 'Software'
+      }
+
+      dc_type = mimes_to_dc.find { |pattern, _type_val| mime_type =~ pattern }
+      dc_type.last
+    end
+
+  end
+end

data/lib/best_type/mime_type_lookup.rb

@@ -0,0 +1,30 @@
+require 'mime-types'
+
+module BestType
+  class MimeTypeLookup
+
+    attr_reader :config
+
+    FALLBACK_MIME_TYPE_VALUE = 'application/octet-stream'.freeze
+
+    def initialize(config)
+      @config = config
+    end
+
+    def for_file_name(file_name_or_path)
+      extension = File.extname(file_name_or_path)
+      extension = extension[1..-1] unless extension.empty?
+
+      # Check config overrides first
+      unless extension.empty?
+        mime_type = @config.extension_to_mime_type_overrides.fetch(extension, nil)
+        return mime_type unless mime_type.nil?
+      end
+
+      # Fall back to regular lookup
+      detected_mime_types = MIME::Types.of(file_name_or_path)
+      detected_mime_types.empty? ? FALLBACK_MIME_TYPE_VALUE : detected_mime_types.first.content_type
+    end
+
+  end
+end

data/lib/best_type/version.rb

@@ -0,0 +1,9 @@
+module BestType
+
+  VERSION = '0.0.1'.freeze
+
+  def self.version
+    VERSION
+  end
+
+end

data/lib/best_type.rb

@@ -0,0 +1,33 @@
+require 'best_type/version'
+require 'best_type/config'
+require 'best_type/mime_type_lookup'
+require 'best_type/dc_type_lookup'
+require 'yaml'
+
+module BestType
+  @semaphore = Mutex.new
+
+  def self.mime_type
+    @mime_type ||= BestType::MimeTypeLookup.new(config)
+  end
+
+  def self.dc_type
+    @dc_type ||= BestType::DcTypeLookup.new(mime_type)
+  end
+
+  def self.config(reload = false, user_config_options = {})
+    if @config.nil? || reload
+      @semaphore.synchronize do
+        @config = BestType::Config.new(user_config_options)
+        @mime_type = nil
+        @dc_type = nil
+      end
+    end
+    @config
+  end
+
+  def self.configure(opts = {})
+    config(true, opts)
+  end
+
+end

data/lib/tasks/best_type/ci.rake

@@ -0,0 +1,38 @@
+require 'best_type'
+
+namespace :best_type do
+
+  begin
+    # This code is in a begin/rescue block so that the Rakefile is usable
+    # in an environment where RSpec is unavailable (i.e. production).
+    require 'rspec/core/rake_task'
+
+    RSpec::Core::RakeTask.new(:rspec) do |spec|
+      spec.pattern = FileList['spec/**/*_spec.rb']
+      spec.pattern += FileList['spec/*_spec.rb']
+      spec.rspec_opts = ['--backtrace'] if ENV['CI']
+    end
+
+    require 'rubocop/rake_task'
+
+    desc 'Run style checker'
+    RuboCop::RakeTask.new(:rubocop) do |task|
+      task.requires << 'rubocop-rspec'
+      task.fail_on_error = true
+    end
+  rescue LoadError => e
+    puts "[Warning] Exception creating rspec rake tasks.  This message can be ignored in environments that intentionally do not pull in the RSpec gem (i.e. production)."
+    puts e
+  end
+
+  desc "CI build"
+  task ci: ['best_type:rubocop'] do
+    Rake::Task["best_type:rspec"].invoke
+  end
+
+  desc "CI build"
+  task :ci_nocop do
+    Rake::Task["best_type:rspec"].invoke
+  end
+
+end

data/lib/tasks/best_type.rake

@@ -0,0 +1,8 @@
+namespace :best_type do
+
+  desc "Hello!"
+  task :hello do
+    puts 'Hello!'
+  end
+
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: best_type
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eric O'Hanlon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+description: A library for selecting the best mime type or dc type for a file.
+email: elo2112@columbia.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- config/internal_config_options.yml
+- lib/best_type.rb
+- lib/best_type/config.rb
+- lib/best_type/dc_type_lookup.rb
+- lib/best_type/mime_type_lookup.rb
+- lib/best_type/version.rb
+- lib/tasks/best_type.rake
+- lib/tasks/best_type/ci.rake
+homepage: https://github.com/cul/best_type
+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.6.14
+signing_key: 
+specification_version: 4
+summary: A library for selecting the best mime type or dc type for a file.
+test_files: []