font_awesome_file_icons 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f236224f2cda5d3c6d245a892924260d1cadd68
+  data.tar.gz: d49ff95ba3f4382bd0a3eed3238728398e299670
+SHA512:
+  metadata.gz: 4c49d10a8cc9be5fba6cc6023f0d149d5f5670d3a17ba1753310339b16d4e95f8e055a89c884b80dd00541f5e7d807030ba0d0217027676b294e2f57348a51ea
+  data.tar.gz: 7b64f6e2db691ad7a15adbf6699697ef22bb18e2e6039619a9606666efcb38bb3805f5c3b058e32661da690ae1ce18f27a736bbac71994a8ae13beace34a943d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Igor Kasyanchuk
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# Font Awesome file icons
+
+Sometimes you need to output filename with an icon from font-awesome. And you need to take an extension of file and use some mapping.
+
+This gem is doing this for you, so you can focus on more important things.
+
+## Usage
+
+Gem is adding method-wrapper `fa_file_icon` which behaves very similar to `fa_icon` and can receive same arguments as `fa_icon`.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'font_awesome_file_icons'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Gem depends on `font-awesome-rails` and `mimemagic` gems.
+
+## Contributing
+
+* Fork
+* git clone
+* cd test/dummy
+* rails s
+* open localhost:3000
+* make fixes in lib folder, restart server
+* push changes & send a PR
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'FontAwesomeFileIcons'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/font_awesome_file_icons/railtie.rb

@@ -0,0 +1,9 @@
+module FontAwesomeFileIcons
+  class Railtie < ::Rails::Railtie
+    initializer 'font_awesome_file_icons.helpers' do
+      ActiveSupport.on_load :action_view do
+        ActionView::Base.send :include, FontAwesomeFileIcons::Helpers
+      end
+    end
+  end
+end

data/lib/font_awesome_file_icons/version.rb

@@ -0,0 +1,3 @@
+module FontAwesomeFileIcons
+  VERSION = '0.1.0'
+end

data/lib/font_awesome_file_icons.rb

@@ -0,0 +1,72 @@
+require 'mimemagic'
+require 'font-awesome-rails'
+require "font_awesome_file_icons/railtie"
+
+module FontAwesomeFileIcons
+  module Helpers
+    DEFAULT_ICON = 'file-o'
+    FILE_ICONS_MAPPING = {
+      /image/ => 'file-image-o',
+      /audio/ => 'file-audio-o',
+      /video/ => 'file-video-o',
+      'application/pdf'         => 'file-pdf-o',
+      'application/msword'      => 'file-word-o',
+      'application/vnd.ms-word' => 'file-word-o',
+      'application/vnd.oasis.opendocument.text' => 'file-word-o',
+      'application/vnd.openxmlformats-officedocument.wordprocessingml' => 'file-word-o',
+      'application/vnd.openxmlformats-officedocument.wordprocessingml.document' => 'file-word-o',
+      'application/vnd.ms-excel' => 'file-excel-o',
+      'application/vnd.openxmlformats-officedocument.spreadsheetml' => 'file-excel-o',
+      'application/vnd.openxmlformats-officedocument.spreadsheetml.document' => 'file-excel-o',
+      'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' => 'file-excel-o',
+      'text/csv' => 'file-excel-o',
+      'application/vnd.oasis.opendocument.spreadsheet' => 'file-excel-o',
+      'application/vnd.ms-powerpoint' => 'file-powerpoint-o',
+      'application/vnd.openxmlformats-officedocument.presentationml' => 'file-powerpoint-o',
+      'application/vnd.openxmlformats-officedocument.presentationml.document' => 'file-powerpoint-o',
+      'application/vnd.openxmlformats-officedocument.presentationml.presentation' => 'file-powerpoint-o',
+      'application/vnd.oasis.opendocument.presentation' => 'file-powerpoint-o',
+      'text/plain'             => 'file-text-o',
+      'text/html'              => 'file-code-o',
+      'application/json'       => 'file-code-o',
+      'application/sql'        => 'file-code-o',
+      'application/javascript' => 'file-code-o',
+      'text/css'               => 'file-code-o',
+      'application/x-ruby'     => 'file-code-o',
+      'text/x-python'          => 'file-code-o',
+      'text/x-c++src'          => 'file-code-o',
+      'text/x-java'            => 'file-code-o',
+      'application/gzip'       => 'file-archive-o',
+      'application/zip'        => 'file-archive-o',
+      'application/x-tar'      => 'file-archive-o',
+      'application/x-rar'      => 'file-archive-o',
+      /compressed/             => 'file-archive-o',
+      nil => DEFAULT_ICON,
+      ''  => DEFAULT_ICON
+    }.freeze
+
+    FILE_ICONS_MAPPING_REGEXP = FILE_ICONS_MAPPING.keys.select{|e| e.is_a?(Regexp)}.freeze
+
+    def fa_file_icon(filename, *options)
+      icon = get_icon(filename)
+      fa_icon(icon, *options)
+    end
+
+    private
+    
+    def get_icon(filename)
+      extension = File.extname(filename.to_s)
+      mime_type = MimeMagic.by_extension(extension)&.type
+      icon      = FILE_ICONS_MAPPING[mime_type]
+
+      if icon.nil?
+        key  = FILE_ICONS_MAPPING_REGEXP.detect{|e| e =~ mime_type }
+        icon = FILE_ICONS_MAPPING[key] if key
+      end
+
+      #puts "#{extension}  -> #{mime_type}  ->  #{icon}"
+      icon ||= DEFAULT_ICON
+    end
+    
+  end
+end

data/lib/tasks/font_awesome_file_icons_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :font_awesome_file_icons do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: font_awesome_file_icons
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Kasyanchuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: font-awesome-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Return font awesome icon based on filename.
+email:
+- igorkasyanchuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/font_awesome_file_icons.rb
+- lib/font_awesome_file_icons/railtie.rb
+- lib/font_awesome_file_icons/version.rb
+- lib/tasks/font_awesome_file_icons_tasks.rake
+homepage: https://github.com/igorkasyanchuk/font_awesome_file_icons
+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.8
+signing_key: 
+specification_version: 4
+summary: Return font awesome icon based on filename.
+test_files: []