filetype 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Lee Jarvis
+
+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,38 @@
+Filetype
+========
+
+Find a file type according to a filename or extension
+
+Installation
+------------
+
+### Rubygems
+
+    gem install filetype
+
+### GitHub
+
+    git clone git://github.com/injekt/filetype.git
+    gem build filetype.gemspec
+    gem install filetype-<version>.gem
+
+Usage
+-----
+
+    Filetype.get('foo.rb') #=> :ruby
+    Filetype.all('foo.h')  #=> [:c, :cpp, :objc]
+
+Custom file types
+-----------------
+
+You can of course add your own custom file types
+
+    Filetype.add(:cool, %w[ cool kl ])
+    Filetype.get('hello.kl') #=> :cool
+
+Contributing
+------------
+
+The list of file types Filetype supports can be found
+[here](https://github.com/injekt/filetype/blob/master/lib/filetype.rb#L6).
+This list is of course fairly short. Please feel free to add file types!

data/Rakefile

@@ -0,0 +1,10 @@
+task :test do
+  $LOAD_PATH.unshift './lib'
+  $LOAD_PATH.unshift './test'
+  require 'filetype'
+  require 'minitest/autorun'
+  begin; require 'turn'; rescue LoadError; end
+  Dir.glob("test/**/*_test.rb").each { |test| require "./#{test}" }
+end
+
+task :default => :test

data/filetype.gemspec

@@ -0,0 +1,18 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "filetype"
+
+Gem::Specification.new do |s|
+  s.name        = "filetype"
+  s.version     = Filetype::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Lee Jarvis"]
+  s.email       = ["lee@jarvis.co"]
+  s.homepage    = "http://github.com/injekt/filetype"
+  s.summary     = "Find a files type"
+  s.description = "Find a file type according to a filename or extension"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/filetype.rb

@@ -0,0 +1,95 @@
+module Filetype
+  module_function
+
+  VERSION = '0.1.0'
+
+  FTYPES = {
+    :actionscript => %w[ as mxml ],
+    :ada          => %w[ ada adb ads ],
+    :asm          => %w[ asm s ],
+    :batch        => %w[ bat cmd ],
+    :c            => %w[ c h ],
+    :clojure      => %w[ clj ],
+    :cpp          => %w[ cpp cc cxx m hpp hh h hxx ],
+    :csharp       => %w[ cs ],
+    :css          => %w[ css ],
+    :elisp        => %w[ el ],
+    :erlang       => %w[ erl hrl ],
+    :go           => %w[ go ],
+    :groovy       => %w[ groovy gpp grunit gtmpl ],
+    :haskell      => %w[ hs lhs ],
+    :haml         => %w[ haml ],
+    :html         => %w[ html xhtml shtml htm ],
+    :java         => %w[ java ],
+    :js           => %w[ js ],
+    :lisp         => %w[ lisp lsp ],
+    :lua          => %w[ lua ],
+    :make         => /\A[Mm]akefile\z/,
+    :objc         => %w[ m h ],
+    :ocaml        => %w[ ml mli ],
+    :perl         => %w[ pl pm t pod ],
+    :php          => %w[ php phpt phtml ],
+    :python       => %w[ py pyc ],
+    :rackup       => %w[ ru ],
+    :rake         => /\A[Rr]akefile(?:.rb)?\z/,
+    :ruby         => %w[ rb rhtml erb rake rjs ],
+    :sass         => %w[ sass ],
+    :scala        => %w[ scala ],
+    :scss         => %w[ scss ],
+    :scheme       => %w[ scm ss ],
+    :shell        => %w[ sh bash ksh zsh csh ],
+    :smalltalk    => %w[ st ],
+    :sql          => %w[ sql ctl ],
+    :yaml         => %w[ yaml yml ],
+    :xml          => %w[ xml xsl dtd xslt ],
+  }
+
+  # Fetch a language for this filetype
+  #
+  # @param [String] fname The file name to check
+  # @example
+  #   Filetype.get('foo.rb')   #=> :ruby
+  #   Filetype.get('Rakefile') #=> :rake
+  # @return [Symbol] The language found or nil
+  def get(fname)
+    FTYPES.each do |ftype, rule|
+      case rule
+      when Array
+        ext = File.extname(fname)[1..-1]
+        return ftype if rule.include? ext
+      when Regexp
+        return ftype if fname.match rule
+      when String, Symbol
+        return ftype if fname == rule.to_s
+      end
+    end
+    nil
+  end
+
+  # Fetch a list of possible languages which match this filetype
+  #
+  # @param [String] fname The file name to check
+  # @example
+  #   Filetype.all('foo.h') #=> [:c, :cpp, :objc]
+  # @return [Array] The list of languages found
+  def all(fname)
+    FTYPES.select do |ftype, rule|
+      ext = File.extname(fname)[1..-1]
+      ftype if rule.is_a?(Array) && rule.include?(ext)
+    end.keys
+  end
+
+  # Add a file type and rule
+  #
+  # @param [Symbol] ftype The file type
+  # @param [Object] rule  The rule to match
+  # @example
+  #   Filetype.add(:foo, ['foo', 'bar'])
+  #   Filetype.get('hello.bar') #=> :foo
+  #
+  #   Filetype.add(:bar, /\Ahello/)
+  #   Filetype.get('hellofoo') #=> :bar
+  def add(ftype, rule)
+    FTYPES[ftype] = rule
+  end
+end

data/test/filetype_test.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+class FileTypeTest < TestCase
+
+  test 'fetching the language of a file name' do
+    assert_equal :ruby, Filetype.get('foo.rb')
+    assert_nil Filetype.get('foo.abahaha')
+  end
+
+  test 'fetching multiple languages of a file name' do
+    assert_equal [:c, :cpp, :objc], Filetype.all('foo.h')
+    assert_empty Filetype.all('foo.aahaha')
+  end
+
+  test 'adding filetypes' do
+    Filetype.add(:bar, %w/foo bar/)
+    assert_equal :bar, Filetype.get('hello.foo')
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+class TestCase < MiniTest::Unit::TestCase
+  def self.test(name, &block)
+    test_name = "test_#{name.gsub(/\s+/, '_')}".to_sym
+    defined = instance_method(test_name) rescue false
+    raise "#{test_name} is already defined in #{self}" if defined
+    if block_given?
+      define_method(test_name, &block)
+    else
+      define_method(test_name) do
+        flunk "No implementation provided for #{name}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: filetype
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Lee Jarvis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-26 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Find a file type according to a filename or extension
+email: 
+- lee@jarvis.co
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gemtest
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- filetype.gemspec
+- lib/filetype.rb
+- test/filetype_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/injekt/filetype
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Find a files type
+test_files: 
+- test/filetype_test.rb
+- test/test_helper.rb