magikku 0.1.0 → 1.0.0

data/.document

@@ -1,5 +1,7 @@
 README.rdoc
+History.txt
 lib/**/*.rb
 bin/*
+ext/**/*.c
 features/**/*.feature
 LICENSE

data/History.txt

@@ -0,0 +1,2 @@
+== 1.0.0 02/22/2011
+* Initial release version

data/README.rdoc

@@ -1,17 +1,87 @@
-= ruby-magic
+= magikku
 
 Ruby bindings for libmagic(3)
 
-Includes FFI bindings as well as native ruby bindings (the latter is coming soon)..
+There are other variations of this binding. This one was written to ensure all features 
+of the library were bound correctly (including compiling and checking magic databases)
+as well as to ensure compatability on different ruby environments.
+
+Magikku includes FFI bindings as well as native ruby bindings.
 
 == Synopsis
 
-(coming soon)
+Here's a basic example identifying file contents.
+
+  #!/usr/bin/env ruby
+
+  require 'rubygems'
+  require 'magikku'
+
+  puts "This file is: " << Magikku.file(__FILE__)
+  puts "Mime Type:    " << Magikku.file(__FILE__, :flags => Magikku::Flags::MIME)
+
+
+... or string contents... 
+
+  #!/usr/bin/env ruby
+
+  require 'rubygems'
+  require 'magikku'
+
+  dat = STDIN.read
+  puts "Data is:   " << Magikku.string(dat)
+  puts "Mime Type: " << Magikku.string(dat, :flags => Magikku::Flags::MIME)
+
+Sometimes it's better to initialize a single object to reuse for lots of files:
+
+  #!/usr/bin/env ruby
+
+  require 'rubygems'
+  require 'magikku'
+
+  def ident(magik, f) 
+    magik.flags = Magikku::Flags::NONE
+    print "#{f} (#{magik.file(f)}) "
+    magik.flags = Magikku::Flags::MIME
+    puts magik.file(f)
+
+    if File.directory?(f)
+      Dir[File.join(f, "*")].each {|f2| ident(magik, f2) }
+    end
+  end
+
+  magik = Magikku.new
+  Dir["*"].each do |f|
+    ident(magik,f)
+  end
+  magik.close
+    
+
+== Requirements
+
+  * libmagic - The dynamic library is generally installed when buliding from 
+    source, but your system may have a package available. 
+    http://www.darwinsys.com/file/ 
+
+Optional:
+
+  * ruby-ffi - If you do not wish to compile the C bindings, or if you want to
+    develop magikku, you will need to have ruby-FFI available. But, this is not
+    needed for basic use under MRI (Matz Ruby Interpreter). http://github.com/ffi/ffi
 
 == Installation
 
-  (sudo)? gem install ruby-magic
+As a gem:
+
+  (sudo)? gem install magikku
+
+From github:
+  # !first ensure you have libmagic installed.
 
+  git clone http://github.com/emonti/magikku.git
+  cd magikku
+  rake compile
+  rake spec # to make sure everything works
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+1.0.0

data/ext/magikku_native/extconf.rb

@@ -21,10 +21,10 @@ require 'rbconfig'
 
 extension_name = "magikku_native"
 
-dir_config(extension_name)
+dir_config(extension_name, '/usr/local/include', '/usr/local/lib')
 
 unless have_library("magic") and
-       find_header("magic.h", "/usr/local/include")
+       find_header("magic.h")
   raise "You must install the libmagic library"
 end
 

data/lib/magikku.rb

@@ -1,12 +1,12 @@
 
 require 'magikku/convenience'
 
-#begin
+begin
   require 'magikku_native'
   Magikku.class_eval{ extend(MagikkuHelpers) }
-#rescue LoadError
-#  require 'magikku_ffi'
-#  Magikku = MagikkuFFI
-#end
+rescue LoadError
+  require 'magikku_ffi'
+  Magikku = MagikkuFFI
+end
 
 

data/samples/mimetype.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+$: << File.expand_path(File.join(File.dirname(__FILE__), "..","lib"))
+
+require 'rubygems'
+require 'magikku'
+include Magikku::Flags
+
+def ident_file(fname)
+  puts "#{fname} (#{Magikku.file(fname)}): "+
+       "#{Magikku.file(fname, :flags => MIME)}"
+  if File.directory?(fname)
+    Dir[File.join(fname, "*")].each {|f| ident_file(f)}
+  end
+end
+
+files = (ARGV.empty?)? [__FILE__] : ARGV
+
+files.each {|file| 
+  ident_file(file)
+}
+

data/samples/mimetype2.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+$: << File.expand_path(File.join(File.dirname(__FILE__), "..","lib"))
+
+require 'rubygems'
+require 'magikku'
+
+def ident(magik, f) 
+  magik.flags = Magikku::Flags::NONE
+  print "#{f} (#{magik.file(f)}) "
+  magik.flags = Magikku::Flags::MIME
+  puts magik.file(f)
+
+  if File.directory?(f)
+    Dir[File.join(f, "*")].each {|f2| ident(magik, f2) }
+  end
+end
+
+magik = Magikku.new
+Dir["*"].each do |f|
+  ident(magik,f)
+end
+magik.close

metadata

@@ -3,10 +3,10 @@ name: magikku
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
-  - 0
   - 1
   - 0
-  version: 0.1.0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Eric Monti
@@ -56,6 +56,7 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
+- History.txt
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -66,6 +67,8 @@ files:
 - lib/magikku.rb
 - lib/magikku/convenience.rb
 - lib/magikku_ffi.rb
+- samples/mimetype.rb
+- samples/mimetype2.rb
 - spec/magikku_behaviors.rb
 - spec/magikku_ffi_spec.rb
 - spec/magikku_spec.rb