icon_for 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 462ea8d6dc050153f96dcce76fc1c9eb83d7c7ba
-  data.tar.gz: 0f6e5a2b376f97798e44dc3101d9f678bc8f058d
+  metadata.gz: e7bcb5635acd0e370dde93b68b176ef82d23bc3d
+  data.tar.gz: 70e8bad3195e7ada12c79c5d1f9611e3da5b97d0
 SHA512:
-  metadata.gz: 527dd8bcc4d44e8cd3c3d907f1f92f5970d3996ae833be6940caf50eb6f969726b0bb0a7aca5610cd66dbd50a45cbb2f5267bafcd8ffe259defedd3e7945e148
-  data.tar.gz: 1494c481de70c0b1cb2c492ab6d510f2599767095d103acb8e9423118096d4087a1deebdc0ee77d2199b288a76296b70e0dae083f80db19ec5498dd3a972077b
+  metadata.gz: c4085a5912761ef2eb756d63d218fdcadbf49fdbdc042ec899af97e434bce46bfe392ce1c22298520fe66d5e90877ac443684693e75ec3fbc2538e2381bc06e0
+  data.tar.gz: 09983f27cf9f554c4923c62d4febea2aeb67aace3974f61e79d0ecea2eecd78edaa2f073428839df0c9aaa7c9431d335e67a4a59e053ef627b6337697de6baa3

data/.gitignore

@@ -7,3 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at orgodemir.v@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Global Women's Institute
+Copyright (c) 2017 phi2dao
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -26,13 +26,13 @@ TODO: Write usage instructions here
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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]/icon_for.
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/icon_for. 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/Rakefile

@@ -1,2 +1,10 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
 task :default => :spec
+
+task :console do
+  exec "irb -r icon_for -I ./lib"
+end

data/data/fa.json

@@ -1,44 +1,61 @@
 {
-    "media": {
-        "application": "application",
-        "audio": "audio",
-        "image": "image",
-        "text": "code",
-        "video": "video"
-    },
-    "extensions": {
-        "7z": "archive",
-        "gz": "archive",
-        "rar": "archive",
-        "zip": "archive",
-        "css": "code",
-        "html": "code",
-        "tex": "code",
-        "xml": "code",
-        "doc": "document",
-        "docx": "document",
-        "odt": "document",
-        "rtf": "document",
-        "pdf": "pdf",
-        "odp": "slideshow",
-        "ppt": "slideshow",
-        "pptx": "slideshow",
-        "csv": "spreadsheet",
-        "odc": "spreadsheet",
-        "xls": "spreadsheet",
-        "xlsx": "spreadsheet",
-        "txt": "text"
+    "types": {
+        "application/*": "application",
+        "application/msword": "document",
+        "application/gzip": "archive",
+        "application/pdf": "pdf",
+        "application/vnd.ms-excel": "spreadsheet",
+        "application/vnd.ms-excel.addin.macroEnabled.12": "spreadsheet",
+        "application/vnd.ms-excel.sheet.macroEnabled.12": "spreadsheet",
+        "application/vnd.ms-excel.sheet.binary.macroEnabled.12": "spreadsheet",
+        "application/vnd.ms-excel.template.macroEnabled.12": "spreadsheet",
+        "application/vnd.ms-powerpoint": "presentation",
+        "application/vnd.ms-powerpoint.addin.macroEnabled.12": "presentation",
+        "application/vnd.ms-powerpoint.presentation.macroEnabled.12": "presentation",
+        "application/vnd.ms-powerpoint.slideshow.macroEnabled.12": "presentation",
+        "application/vnd.ms-powerpoint.template.macroEnabled.12": "presentation",
+        "application/vnd.ms-word.document.macroEnabled.12": "document",
+        "application/vnd.ms-word.template.macroEnabled.12": "document",
+        "application/vnd.oasis.opendocument.chart": "image",
+        "application/vnd.oasis.opendocument.formula": "code",
+        "application/vnd.oasis.opendocument.graphics": "image",
+        "application/vnd.oasis.opendocument.graphics-template": "image",
+        "application/vnd.oasis.opendocument.image": "image",
+        "application/vnd.oasis.opendocument.presentation": "presentation",
+        "application/vnd.oasis.opendocument.presentation-template": "presentation",
+        "application/vnd.oasis.opendocument.spreadsheet": "spreadsheet",
+        "application/vnd.oasis.opendocument.spreadsheet-template": "spreadsheet",
+        "application/vnd.oasis.opendocument.text": "document",
+        "application/vnd.oasis.opendocument.text-master": "document",
+        "application/vnd.oasis.opendocument.text-template": "document",
+        "application/vnd.oasis.opendocument.text-web": "document",
+        "application/vnd.openxmlformats-officedocument.presentationml.presentation": "presentation",
+        "application/vnd.openxmlformats-officedocument.presentationml.slideshow": "presentation",
+        "application/vnd.openxmlformats-officedocument.presentationml.template": "presentation",
+        "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": "spreadsheet",
+        "application/vnd.openxmlformats-officedocument.spreadsheetml.template": "spreadsheet",
+        "application/vnd.openxmlformats-officedocument.wordprocessingml.document": "document",
+        "application/vnd.openxmlformats-officedocument.wordprocessingml.template": "document",
+        "application/x-7z-compressed": "archive",
+        "application/x-rar-compressed": "archive",
+        "application/zip": "archive",
+        "audio/*": "audio",
+        "image/*": "image",
+        "text/*": "code",
+        "text/csv": "spreadsheet",
+        "text/plain": "text",
+        "video/*": "video"
     },
     "icons": {
         "application": "file-o",
         "audio": "file-audio-o",
         "archive": "file-archive-o",
         "code": "file-code-o",
-        "document": "file-word-o",
+        "document": "file-document-o",
         "fallback": "file-o",
         "image": "file-image-o",
         "pdf": "file-pdf-o",
-        "slideshow": "file-powerpoint-o",
+        "presentation": "file-powerpoint-p",
         "spreadsheet": "file-excel-o",
         "text": "file-text-o",
         "video": "file-video-o"

data/icon_for.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["phi2dao"]
   spec.email         = ["orgodemir.v@gmail.com"]
 
-  spec.summary       = %q{Turns mime types into icon names. Automatically works with FontAwesome.}
+  spec.summary       = %q{Translates mime types into icon strings for use with other libraries. Works with Font Awesome out of the box.}
   spec.homepage      = "https://github.com/phi2dao/icon_for"
   spec.license       = "MIT"
 
@@ -31,6 +31,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
-
-  spec.add_dependency "mime-types", "~> 3.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/icon_for/engine.rb

@@ -0,0 +1,20 @@
+module IconFor
+  def self.register const, data, options = {}
+    IconFor.const_set const, IconFor::IconSet.new(data)
+    @default = const if options[:default]
+  end
+
+  def self.[] mime
+    if @default
+      IconFor.const_get(@default)[mime]
+    end
+  end
+
+  def self.default
+    @default
+  end
+
+  def self.default= const
+    @default = const
+  end
+end

data/lib/icon_for/icon_set.rb

@@ -0,0 +1,27 @@
+require "json"
+
+module IconFor
+  class IconSet
+    def initialize data
+      if data.is_a? File
+        @data = JSON.load data
+      else
+        @data = data
+      end
+    end
+
+    def [] mime
+      if @data["types"].key? mime
+        icon = @data["types"][mime]
+      else
+        mime.match /(\w*)\/.*/
+        if @data["types"].key? $1 + '/*'
+          icon = @data["types"][$1 + '/*']
+        else
+          icon = "fallback"
+        end
+      end
+      @data["icons"][icon]
+    end
+  end
+end

data/lib/icon_for/path.rb

@@ -0,0 +1,3 @@
+module IconFor
+  PATH = File.expand_path('../../../data', __FILE__)
+end

data/lib/icon_for/version.rb

@@ -1,3 +1,3 @@
 module IconFor
-  VERSION = "0.1.8"
+  VERSION = "0.2.0"
 end

data/lib/icon_for.rb

@@ -1,7 +1,10 @@
+require "icon_for/engine"
+require "icon_for/icon_set"
+require "icon_for/path"
 require "icon_for/version"
-require "icon_for/core"
-require "icon_for/data"
 
 module IconFor
-  # Your code goes here...
+  File.open IconFor::PATH + "/fa.json" do |file|
+    IconFor.register :FA, file, default: Kernel.const_defined?(:FontAwesome)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: icon_for
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - phi2dao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-17 00:00:00.000000000 Z
+date: 2017-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,13 +39,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: mime-types
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -60,6 +60,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -69,9 +72,9 @@ files:
 - data/fa.json
 - icon_for.gemspec
 - lib/icon_for.rb
-- lib/icon_for/core.rb
-- lib/icon_for/data.rb
-- lib/icon_for/fa.rb
+- lib/icon_for/engine.rb
+- lib/icon_for/icon_set.rb
+- lib/icon_for/path.rb
 - lib/icon_for/version.rb
 homepage: https://github.com/phi2dao/icon_for
 licenses:
@@ -97,5 +100,6 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Turns mime types into icon names. Automatically works with FontAwesome.
+summary: Translates mime types into icon strings for use with other libraries. Works
+  with Font Awesome out of the box.
 test_files: []

data/lib/icon_for/core.rb

@@ -1,39 +0,0 @@
-require "mime-types"
-require "json"
-
-module IconFor
-  @config = Struct.new(:source, :data).new(:data, nil)
-
-  if defined? FontAwesome
-    @config.source = :fa
-  end
-
-  def self.config
-    block_given? ? yield(@config) : @config
-  end
-
-  def self.[] mime_type
-    case @config.source.downcase
-    when :fa
-      require "icon_for/fa"
-      FA[mime_type]
-    when :data
-      self.icon_from_source mime_type, @config.data
-    else
-      raise "Unknown icon source `#{@config.source.downcase}'"
-    end
-  end
-
-  def self.icon_from_source mime_type, data
-    raise "Invalid data object" unless data&.key?('media') and data&.key?('extensions') and data&.key?('icons')
-    return data['icons']['fallback'] unless mime = MIME::Types[mime_type].first
-    if data['extensions'].key? mime.preferred_extension
-      icon = data['extensions'][mime.preferred_extension]
-    elsif data['media'].key? mime.media_type
-      icon = data['media'][mime.media_type]
-    else
-      icon = 'fallback'
-    end
-    data['icons'][icon]
-  end
-end

data/lib/icon_for/data.rb

@@ -1,5 +0,0 @@
-module IconFor
-  module Data
-    PATH = File.expand_path('../../../data', __FILE__)
-  end
-end

data/lib/icon_for/fa.rb

@@ -1,11 +0,0 @@
-module IconFor
-  module FA
-    File.open IconFor::Data::PATH + '/fa.json' do |file|
-      @data = JSON.load file
-    end
-
-    def self.[] mime_type
-      IconFor.icon_from_source mime_type, @data
-    end
-  end
-end