ffi-magic 2011.04

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010 Michael Fellinger
+
+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/MANIFEST

@@ -0,0 +1,18 @@
+LICENSE
+MANIFEST
+README.md
+Rakefile
+doc/AUTHORS
+doc/CHANGELOG
+ffi-magic.gemspec
+lib/ffi-magic.rb
+lib/ffi-magic/version.rb
+spec/ffi-magic.rb
+spec/magic.png
+tasks/authors.rake
+tasks/changelog.rake
+tasks/gem.rake
+tasks/manifest.rake
+tasks/release.rake
+tasks/reversion.rake
+tasks/todo.rake

data/README.md

@@ -0,0 +1,12 @@
+# Ruby FFI bindings for libmagic
+
+## Usage
+
+    require 'ffi-magic'
+    magic = Magic.new
+    magic.file('spec/magic.png')
+    # => "PNG image data, 100 x 67, 8-bit/color RGB, non-interlaced"
+    magic.flags = Magic::MIME
+    # => 1040
+    magic.file('spec/magic.png')
+    # => "image/png; charset=binary"

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'time'
+require 'date'
+
+PROJECT_SPECS = Dir['spec/**/*.rb']
+PROJECT_MODULE = 'Magic'
+PROJECT_VERSION = (ENV['VERSION'] || Date.today.strftime("%Y.%m.%d")).dup
+
+GEMSPEC = Gem::Specification.new{|s|
+  s.name         = 'ffi-magic'
+  s.author       = "Michael 'manveru' Fellinger"
+  s.summary      = "FFI binding for libmagic."
+  s.email        = 'm.fellinger@gmail.com'
+  s.homepage     = 'http://github.com/manveru/ffi-magic'
+  s.platform     = Gem::Platform::RUBY
+  s.version      = PROJECT_VERSION
+  s.files        = `git ls-files`.split("\n").sort
+  s.has_rdoc     = true
+  s.require_path = 'lib'
+  s.executables = []
+  s.bindir = "bin"
+
+  s.add_runtime_dependency('ffi', '~> 1.0.7')
+}
+
+Dir['tasks/*.rake'].each{|f| import(f) }
+
+task :default => [:bacon]
+
+CLEAN.include('')

data/doc/AUTHORS

@@ -0,0 +1,4 @@
+Following persons have contributed to ffi-magic.
+(Sorted by number of submitted patches, then alphabetically)
+
+     3 Michael Fellinger <m.fellinger@gmail.com>

data/doc/CHANGELOG

@@ -0,0 +1,12 @@
+[5a53006 | Fri Apr 22 02:04:14 UTC 2011] Michael Fellinger <m.fellinger@gmail.com>
+
+  * Version 2011.04
+
+[174a767 | Fri Apr 22 01:59:00 UTC 2011] Michael Fellinger <m.fellinger@gmail.com>
+
+  * prepare for release
+
+[cf89376 | Sun Jun 13 22:52:56 UTC 2010] Michael Fellinger <m.fellinger@gmail.com>
+
+  * Initial commit
+

data/ffi-magic.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ffi-magic}
+  s.version = "2011.04"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael 'manveru' Fellinger"]
+  s.date = %q{2011-04-22}
+  s.email = %q{m.fellinger@gmail.com}
+  s.files = ["LICENSE", "MANIFEST", "README.md", "Rakefile", "doc/AUTHORS", "doc/CHANGELOG", "ffi-magic.gemspec", "lib/ffi-magic.rb", "lib/ffi-magic/version.rb", "spec/ffi-magic.rb", "spec/magic.png", "tasks/authors.rake", "tasks/changelog.rake", "tasks/gem.rake", "tasks/manifest.rake", "tasks/release.rake", "tasks/reversion.rake", "tasks/todo.rake"]
+  s.homepage = %q{http://github.com/manveru/ffi-magic}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{FFI binding for libmagic.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ffi>, ["~> 1.0.7"])
+    else
+      s.add_dependency(%q<ffi>, ["~> 1.0.7"])
+    end
+  else
+    s.add_dependency(%q<ffi>, ["~> 1.0.7"])
+  end
+end

data/lib/ffi-magic.rb

@@ -0,0 +1,107 @@
+require 'ffi'
+
+require 'ffi-magic/version'
+
+class Magic
+  extend FFI::Library
+  ffi_lib ['magic', 'libmagic.so.1']
+
+  attach_function :magic_open,     [:int],    :pointer
+  attach_function :magic_error,    [:pointer],            :string
+  attach_function :magic_load,     [:pointer, :string], :int
+  attach_function :magic_file,     [:pointer, :string], :string
+  attach_function :magic_setflags, [:pointer, :int],          :void
+  attach_function :magic_buffer,   [:pointer, :string, :int], :string
+  attach_function :magic_check,    [:pointer, :string], :int
+  attach_function :magic_compile,  [:pointer, :string], :int
+  attach_function :magic_close,    [:pointer], :void
+
+  NONE              = 0x000000
+  DEBUG             = 0x000001
+  SYMLINK           = 0x000002
+  COMPRESS          = 0x000004
+  DEVICES           = 0x000008
+  MIME_TYPE         = 0x000010
+  CONTINUE          = 0x000020
+  CHECK             = 0x000040
+  PRESERVE_ATIME    = 0x000080
+  RAW               = 0x000100
+  ERROR             = 0x000200
+  MIME_ENCODING     = 0x000400
+  MIME              = MIME_TYPE | MIME_ENCODING
+  APPLE             = 0x000800
+  NO_CHECK_COMPRESS = 0x001000
+  NO_CHECK_TAR      = 0x002000
+  NO_CHECK_SOFT     = 0x004000
+  NO_CHECK_APPTYPE  = 0x008000
+  NO_CHECK_ELF      = 0x010000
+  NO_CHECK_TEXT     = 0x020000
+  NO_CHECK_CDF      = 0x040000
+  NO_CHECK_TOKENS   = 0x100000
+  NO_CHECK_ENCODING = 0x200000
+
+  Error = Class.new(StandardError)
+
+  def self.compile(path)
+    cookie = magic_open(NONE)
+
+    unless magic_compile(cookie, path) == 0
+      raise Error, "failed compile: #{magic_error(cookie)}"
+    end
+
+    magic_close(cookie)
+
+    true
+  end
+
+  def initialize(flags = NONE, path = nil)
+    @flags = flags
+    @path = path
+
+    unless @cookie = magic_open(@flags)
+      raise Error, "failed to initialize magic cookie"
+    end
+
+    if magic_load(@cookie, @path) != 0
+      raise Error, "failed to load database: #{magic_error(@cookie)}"
+    end
+
+    begin
+      ObjectSpace.define_finalizer(self){ close }
+    rescue
+    end
+  end
+
+  def file(path)
+    unless msg = magic_file(@cookie, path)
+      raise Error, "failed lookup: #{magic_error(@cookie)}"
+    end
+
+    msg
+  end
+
+  def buffer(input)
+    input.force_encoding(Encoding::BINARY)
+    magic_buffer(@cookie, input, input.bytesize.to_s)
+  end
+
+  def flags=(flags)
+    @flags = flags
+    magic_setflags(@cookie, flags)
+  end
+
+  def valid?(path = nil)
+    magic_check(@cookie, path) == 0
+  end
+
+  def load
+    unless magic_load(@cookie, path) == 0
+      raise Error, "failed load: #{magic_error(@cookie)}"
+    end
+  end
+
+  def close
+    magic_close(@cookie) if @cookie
+    @cookie = nil
+  end
+end

data/lib/ffi-magic/version.rb

@@ -0,0 +1,3 @@
+class Magic
+  VERSION = "2011.04"
+end

data/spec/ffi-magic.rb

@@ -0,0 +1,34 @@
+require 'bacon'
+Bacon.summary_on_exit
+
+require_relative '../lib/ffi-magic'
+
+describe 'Magic' do
+  @m = Magic.new
+
+  file = File.expand_path('../magic.png', __FILE__)
+
+  should 'recognize file' do
+    @m.flags = Magic::NONE
+    @m.file(file).should == "PNG image data, 100 x 67, 8-bit/color RGB, non-interlaced"
+  end
+
+  should 'return MIME' do
+    @m.flags = Magic::MIME
+    @m.file(file).should == "image/png; charset=binary"
+  end
+
+  should 'buffer' do
+    @m.flags = Magic::NONE
+    @m.buffer(File.read(file)).should == "ASCII C++ program text"
+  end
+
+  should 'buffer MIME' do
+    @m.flags = Magic::MIME
+    @m.buffer(File.read(file)).should == "text/x-c++; charset=us-ascii"
+  end
+
+  should 'have a valid database' do
+    @m.should.be.valid
+  end
+end

data/tasks/authors.rake

@@ -0,0 +1,17 @@
+desc 'Update doc/AUTHORS'
+task :authors do
+  authors = Hash.new(0)
+
+  `git shortlog -nse`.scan(/(\d+)\s(.+)\s<(.*)>$/) do |count, name, email|
+    authors[[name, email]] += count.to_i
+  end
+
+  File.open('doc/AUTHORS', 'w+') do |io|
+    io.puts "Following persons have contributed to #{GEMSPEC.name}."
+    io.puts '(Sorted by number of submitted patches, then alphabetically)'
+    io.puts ''
+    authors.sort_by{|(n,e),c| [-c, n.downcase] }.each do |(name, email), count|
+      io.puts("%6d %s <%s>" % [count, name, email])
+    end
+  end
+end

data/tasks/changelog.rake

@@ -0,0 +1,20 @@
+desc 'update changelog'
+task :changelog do
+  File.open('doc/CHANGELOG', 'w+') do |changelog|
+    `git log -z --abbrev-commit`.split("\0").each do |commit|
+      next if commit =~ /^Merge: \d*/
+      ref, author, time, _, title, _, message = commit.split("\n", 7)
+      ref    = ref[/commit ([0-9a-f]+)/, 1]
+      author = author[/Author: (.*)/, 1].strip
+      time   = Time.parse(time[/Date: (.*)/, 1]).utc
+      time   = time.strftime('%a %b %d %H:%M:%S %Z %Y')
+
+      title = title.to_s.strip
+
+      changelog.puts "[#{ref} | #{time}] #{author}"
+      changelog.puts '', "  * #{title}"
+      changelog.puts '', message.rstrip if message
+      changelog.puts
+    end
+  end
+end

data/tasks/gem.rake

@@ -0,0 +1,22 @@
+require 'rake/gempackagetask'
+
+task :gemspec => [:manifest, :changelog] do
+  gemspec_file = "#{GEMSPEC.name}.gemspec"
+  File.open(gemspec_file, 'w+'){|gs| gs.puts(GEMSPEC.to_ruby) }
+end
+
+desc "package and install from gemspec"
+task :install => [:gemspec] do
+  sh "gem build #{GEMSPEC.name}.gemspec"
+  sh "gem install #{GEMSPEC.name}-#{GEMSPEC.version}.gem"
+end
+
+desc "uninstall the gem"
+task :uninstall => [:clean] do
+  sh %{gem uninstall -x #{GEMSPEC.name}}
+end
+
+Rake::GemPackageTask.new(GEMSPEC) do |p|
+  p.need_tar = true
+  p.need_zip = true
+end

data/tasks/manifest.rake

@@ -0,0 +1,4 @@
+desc 'update manifest'
+task :manifest do
+  File.open('MANIFEST', 'w+'){|io| io.puts(*GEMSPEC.files) }
+end

data/tasks/release.rake

@@ -0,0 +1,65 @@
+namespace :release do
+  task :prepare => %w[reversion authors gemspec]
+  task :all => %w[release:github release:rubyforge release:gemcutter]
+
+  desc 'Release on github'
+  task :github => :prepare do
+    name, version = GEMSPEC.name, GEMSPEC.version
+
+    sh('git', 'add',
+       'MANIFEST', 'doc/CHANGELOG', 'doc/AUTHORS',
+       "#{name}.gemspec",
+       "lib/#{name}/version.rb")
+
+    puts <<-INSTRUCTIONS
+================================================================================
+
+I added the relevant files, you can commit them, tag the commit, and push:
+
+git commit -m 'Version #{version}'
+git tag -a -m '#{version}' '#{version}'
+git push
+
+================================================================================
+    INSTRUCTIONS
+  end
+
+  desc 'Release on rubyforge'
+  task :rubyforge => ['release:prepare', :package] do
+    name, version = GEMSPEC.name, GEMSPEC.version
+
+    pkgs = Dir["pkg/#{name}-#{version}.{tgz,zip}"].map{|file|
+      "rubyforge add_file #{name} #{name} '#{version}' '#{file}'"
+    }
+
+    puts <<-INSTRUCTIONS
+================================================================================
+
+To publish to rubyforge do following:
+
+rubyforge login
+rubyforge add_release #{name} #{name} '#{version}' pkg/#{name}-#{version}.gem
+
+To publish the archives for distro packagers:
+
+#{pkgs.join "\n"}
+
+================================================================================
+    INSTRUCTIONS
+  end
+
+  desc 'Release on gemcutter'
+  task :gemcutter => ['release:prepare', :package] do
+    name, version = GEMSPEC.name, GEMSPEC.version
+
+    puts <<-INSTRUCTIONS
+================================================================================
+
+To publish to gemcutter do following:
+
+gem push pkg/#{name}-#{version}.gem
+
+================================================================================
+    INSTRUCTIONS
+  end
+end

data/tasks/reversion.rake

@@ -0,0 +1,8 @@
+desc "update version.rb"
+task :reversion do
+  File.open("lib/#{GEMSPEC.name}/version.rb", 'w+') do |file|
+    file.puts("class #{PROJECT_MODULE}")
+    file.puts('  VERSION = %p' % GEMSPEC.version.to_s)
+    file.puts('end')
+  end
+end

data/tasks/todo.rake

@@ -0,0 +1,27 @@
+desc "show a todolist from all the TODO tags in the source"
+task :todo do
+  Dir.glob('{lib,spec}/**/*.rb') do |file|
+    lastline = todo = comment = long_comment = false
+
+    File.readlines(file).each_with_index do |line, lineno|
+      lineno += 1
+      comment = line =~ /^\s*?#.*?$/
+      long_comment = line =~ /^=begin/
+      long_comment = line =~ /^=end/
+      todo = true if line =~ /TODO|FIXME|THINK/ and (long_comment or comment)
+      todo = false if line.gsub('#', '').strip.empty?
+      todo = false unless comment or long_comment
+      if todo
+        unless lastline and lastline + 1 == lineno
+          puts
+          puts "vim #{file} +#{lineno}"
+        end
+
+        l = line.strip.gsub(/^#\s*/, '')
+        print '  ' unless l =~ /^-/
+        puts l
+        lastline = lineno
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: ffi-magic
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 2011
+  - 4
+  version: "2011.04"
+platform: ruby
+authors: 
+- Michael 'manveru' Fellinger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-22 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ffi
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 7
+        version: 1.0.7
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: m.fellinger@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- MANIFEST
+- README.md
+- Rakefile
+- doc/AUTHORS
+- doc/CHANGELOG
+- ffi-magic.gemspec
+- lib/ffi-magic.rb
+- lib/ffi-magic/version.rb
+- spec/ffi-magic.rb
+- spec/magic.png
+- tasks/authors.rake
+- tasks/changelog.rake
+- tasks/gem.rake
+- tasks/manifest.rake
+- tasks/release.rake
+- tasks/reversion.rake
+- tasks/todo.rake
+has_rdoc: true
+homepage: http://github.com/manveru/ffi-magic
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: FFI binding for libmagic.
+test_files: []
+