ricardochimal-ruby-filemagic 0.1.1

data/AUTHORS

@@ -0,0 +1 @@
+Travis Whitton <whitton@atlantic.net>

data/CHANGELOG

@@ -0,0 +1,10 @@
+--------------------------------------------------------------------------------
+7/28/2003 version 0.1.0
+
+o Initial release.
+
+--------------------------------------------------------------------------------
+7/30/2003 version 0.1.1
+
+o Added manual close method
+o Added unit test suite

data/README

@@ -0,0 +1,35 @@
+FileMagic Library Binding
+
+June 27, 2008 Ricardo Chimal, Jr. <ricardo@heroku.com>
+
+	I needed a packaged gem version of this ruby binding so I stuck it in github and created a gemspec.  Enjoy.	
+
+
+July 28, 2003 Travis Whitton <whitton@atlantic.net>
+
+	This is one of my first ruby bindings, so suggestions are welcome. See
+	filemagic.rd and test.rb for usage.
+
+	to install, run these commands:
+
+	ruby extconf.rb
+	make
+	su
+	make install
+
+	the file(1) library and headers are required.
+	I have file 0.4.3.
+
+	Enjoy!
+	Travis
+
+[Copying]
+The filemagic extension library is copywrited free software by Travis Whitton
+<whitton@atlantic.net>. You can redistribute it under the terms specified in
+the COPYING file of the Ruby distribution.
+
+[WARRANTY]
+THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.

data/TODO

@@ -0,0 +1,9 @@
+o Find a better way to handle magic_load than just defaulting to NULL
+o Find a way to make magic_check work on NULL
+o Find a way to make magic_setflags work
+o Refactor code into initialize instead of new
+o Enable blocks for automatic cleanup:
+
+FileMagic.open("somefile.txt") do |file|
+  # close is called at the end of this block
+end

data/extconf.rb

@@ -0,0 +1,8 @@
+require 'mkmf'
+
+dir_config("magic")
+if have_library("magic", "magic_open") and have_header("magic.h")
+  create_makefile("filemagic")
+else
+  print "***  ERROR: missing required library to compile this module\n"
+end

data/filemagic.c

@@ -0,0 +1,137 @@
+/*********************************************************
+
+   filemagic.c
+
+   a Ruby extension to bind Ruby to the libmagic library
+   (ftp://ftp.astron.com/pub/file/)
+
+   patterned very closely off of audiofile.c by jaredj which
+   is patterned very very closely off of gdbm.c by matz ;-)
+
+   $Author: twhitton $
+   $Date: 2003/07/30 13:25:10 $
+
+*********************************************************/
+
+#include "ruby.h"
+#include <magic.h>
+
+static VALUE cFileMagic, rb_FileMagicError;
+
+#define GetMagicCookie(obj, cookie) {\
+    Data_Get_Struct(obj, struct magic_set, cookie);\
+}
+
+/* 
+   GC never seems to happen until the program terminates, but this is called
+   on any unclosed objects
+*/
+static void magick_free(magic_t cookie)
+{
+    magic_close(cookie);
+}
+
+/* This is mainly for subclassing */
+static VALUE magick_init(VALUE self, VALUE flags)
+{
+    /* This isn't used internally, but might as well store it for children */
+    rb_iv_set(self, "@flags", flags);
+    return self;
+}
+
+/* Frees resources allocated */
+static VALUE magick_close(VALUE class)
+{
+    magic_t cookie;
+    GetMagicCookie(class, cookie);
+    magic_close(cookie);
+    /* This keeps magick_free from trying to free closed objects */
+    RDATA(class)->data = NULL;
+    return Qnil;
+}
+
+/* FileMagic.new */
+static VALUE magick_new(VALUE class, VALUE flags)
+{
+    VALUE obj;
+    magic_t cookie;
+    cookie = magic_open(NUM2INT(flags));
+    if (cookie == NULL) {
+        rb_fatal("out of memory");
+    }
+    if (magic_load(cookie, NULL) == -1) {
+        rb_fatal("%s", magic_error(cookie));
+    }
+    rb_FileMagicError = rb_define_class("FileMagicError", rb_eStandardError);
+    obj = Data_Wrap_Struct(class, 0, magick_free, cookie);
+    rb_obj_call_init(obj, 1, &flags);
+    return obj;
+}
+
+/* Return a string describing file */
+static VALUE magick_file(VALUE class, VALUE file)
+{
+    const char *m;
+    magic_t cookie;
+    m = STR2CSTR(file);
+    GetMagicCookie(class, cookie);
+    if ((m = magic_file(cookie, m)) == NULL)
+        rb_raise(rb_FileMagicError, magic_error(cookie));
+    return rb_str_new2(m);
+}
+
+/* Return a string describing the string buffer */
+static VALUE magick_buffer(VALUE class, VALUE buffer)
+{
+    int i = RSTRING(buffer)->len;
+    const char *m;
+    magic_t cookie;
+    m = STR2CSTR(buffer);
+    GetMagicCookie(class, cookie);
+    if ((m = magic_buffer(cookie, m, i)) == NULL)
+        rb_raise(rb_FileMagicError, magic_error(cookie));
+    return rb_str_new2(m);
+}
+
+/* Checks validity of a magic database file */
+static VALUE magick_check(VALUE class, VALUE file)
+{
+    int retval;
+    const char *m;
+    magic_t cookie;
+    GetMagicCookie(class, cookie);
+    m = STR2CSTR(file);
+    retval = magic_check(cookie, m);
+    return INT2FIX(retval);
+}
+
+/* Compiles a magic database file */
+static VALUE magick_compile(VALUE class, VALUE file)
+{
+    int retval;
+    const char *m;
+    magic_t cookie;
+    GetMagicCookie(class, cookie);
+    m = STR2CSTR(file);
+    retval = magic_compile(cookie, m);
+    return INT2FIX(retval);
+}
+
+void Init_filemagic() {
+    cFileMagic = rb_define_class("FileMagic", rb_cObject);
+    rb_define_singleton_method(cFileMagic, "new", magick_new, 1);
+    rb_define_method(cFileMagic, "initialize", magick_init, 1);
+    rb_define_method(cFileMagic, "close", magick_close, 0);
+    rb_define_method(cFileMagic, "file", magick_file, 1);
+    rb_define_method(cFileMagic, "buffer", magick_buffer, 1);
+    rb_define_method(cFileMagic, "check", magick_check, 1);
+    rb_define_method(cFileMagic, "compile", magick_compile, 1);
+    rb_define_const(cFileMagic, "MAGIC_NONE", INT2FIX(MAGIC_NONE));
+    rb_define_const(cFileMagic, "MAGIC_DEBUG", INT2FIX(MAGIC_DEBUG));
+    rb_define_const(cFileMagic, "MAGIC_SYMLINK", INT2FIX(MAGIC_SYMLINK));
+    rb_define_const(cFileMagic, "MAGIC_COMPRESS", INT2FIX(MAGIC_COMPRESS));
+    rb_define_const(cFileMagic, "MAGIC_DEVICES", INT2FIX(MAGIC_DEVICES));
+    rb_define_const(cFileMagic, "MAGIC_MIME", INT2FIX(MAGIC_MIME));
+    rb_define_const(cFileMagic, "MAGIC_CONTINUE", INT2FIX(MAGIC_CONTINUE));
+    rb_define_const(cFileMagic, "MAGIC_CHECK", INT2FIX(MAGIC_CHECK));
+}

data/filemagic.rd

@@ -0,0 +1,36 @@
+=begin
+
+= FileMagic extension module SEE ALSO libmagic(3), file(1) and magic(4)
+== FileMagic
+=== Constants
+: MAGIC_NONE
+     No flags
+: MAGIC_DEBUG
+     Turn on debuggin
+: MAGIC_SYMLINK
+     Follow symlinks
+: MAGIC_COMPRESS
+     Check inside compressed files
+: MAGIC_DEVICES
+     Look at the contents of devices
+: MAGIC_MIME
+     Return a mime string
+: MAGIC_CONTINUE
+     Return all matches, not just the first
+: MAGIC_CHECK
+     Print warnings to stderr
+
+=== Methods
+: file(filename)
+    returns a textual description of the contents of the filename argument
+: buffer(string)
+    returns a textual description of the contents of the string argument
+: check(filename)
+    checks the validity of entries in the colon separated database files
+    passed in as filename
+: compile(filename)
+    compile the the colon separated list of database files passed in as
+    filename
+: close()
+    closes the magic database and frees any memory allocated. if memory
+    is a concern, use this.

data/ruby-filemagic.gemspec

@@ -0,0 +1,37 @@
+Gem::Specification.new do |s|
+	s.required_ruby_version = ">= 1.8.5"
+	s.rubygems_version = "1.1.1"
+	s.platform = "ruby"
+	s.description = "Ruby FileMagic Library Bindings"
+	s.summary = "Ruby FileMagic Library Bindings"
+	s.version = "0.1.1"
+	s.has_rdoc = "false"
+	s.name = "ruby-filemagic"
+	s.authors = ["Travis Whitton", "Ricardo Chimal, Jr."]
+	s.email = "ricardo@heroku.com"
+	s.homepage = "http://github.com/ricardochimal/ruby-filemagic"
+
+	s.extensions = ["extconf.rb"]
+
+	s.files = [
+"AUTHORS",
+"CHANGELOG",
+"extconf.rb",
+"filemagic.c",
+"filemagic.rd",
+"README",
+"test",
+"test/perl",
+"test/pyfile",
+"test/pylink",
+"test/regress.rb",
+"test/leaktest.rb",
+"test/pyfile-compressed.gz",
+"TODO",
+"ruby-filemagic.gemspec",
+]
+
+end
+
+
+

data/test/leaktest.rb

@@ -0,0 +1,15 @@
+require '../filemagic'
+
+# watch -n 1 'ps aux | grep leaktest'
+
+def do_file(filename)
+  fm = FileMagic.new(0)
+  file = fm.file(filename)
+  fm.close
+  return file
+end
+
+loop do
+  puts do_file($0)
+  sleep 1
+end

data/test/perl

@@ -0,0 +1,19 @@
+
+#------------------------------------------------------------------------------
+# perl:  file(1) magic for Larry Wall's perl language.
+#
+# The ``eval'' line recognizes an outrageously clever hack for USG systems.
+# Keith Waclena <keith@cerberus.uchicago.edu>
+# Send additions to <perl5-porters@perl.org>
+0	string/b	#!\ /bin/perl			perl script text executable
+0	string		eval\ "exec\ /bin/perl		perl script text
+0	string/b	#!\ /usr/bin/perl		perl script text executable
+0	string		eval\ "exec\ /usr/bin/perl	perl script text
+0	string/b	#!\ /usr/local/bin/perl		perl script text
+0	string		eval\ "exec\ /usr/local/bin/perl	perl script text executable
+0	string		eval\ '(exit\ $?0)'\ &&\ eval\ 'exec	perl script text
+
+# a couple more, by me
+# XXX: christos matches
+#0	regex		package		Perl5 module source text (via regex)
+0	string		package		Perl5 module source text

data/test/pyfile

@@ -0,0 +1 @@
+"""

data/test/pylink

@@ -0,0 +1 @@
+pyfile

data/test/regress.rb

@@ -0,0 +1,48 @@
+require "test/unit"
+require "../filemagic"
+
+class TestFileMagic < Test::Unit::TestCase
+  def test_file
+    fm = FileMagic.new(FileMagic::MAGIC_NONE)
+    res = fm.file("pyfile")
+    assert_equal("a python script text executable", res)
+    res = fm.file("pylink")
+    assert_equal("symbolic link to `pyfile'", res)
+    fm.close
+    fm = FileMagic.new(FileMagic::MAGIC_SYMLINK)
+    res = fm.file("pylink")
+    assert_equal("a python script text executable", res)
+    fm.close
+    fm = FileMagic.new(FileMagic::MAGIC_SYMLINK | FileMagic::MAGIC_MIME)
+    res = fm.file("pylink")
+    assert_equal("text/plain; charset=us-ascii", res)
+    fm.close
+    fm = FileMagic.new(FileMagic::MAGIC_COMPRESS)
+    res = fm.file("pyfile-compressed.gz")
+    assert_equal("a python script text executable (gzip compressed data, " +
+                 'was "pyfile-compressed", from Unix)', res)
+    fm.close
+  end
+
+  def test_buffer
+    fm = FileMagic.new(FileMagic::MAGIC_NONE)
+    res = fm.buffer("#!/bin/sh\n")
+    fm.close
+    assert_equal("a /bin/sh script text executable", res)
+  end
+
+  def test_check
+    fm = FileMagic.new(FileMagic::MAGIC_NONE)
+    res = fm.check("perl")
+    fm.close
+    assert_equal(res, 0)
+  end
+
+  def test_compile
+    fm = FileMagic.new(FileMagic::MAGIC_NONE)
+    res = fm.compile("perl")
+    fm.close
+    assert_equal(res, 0)
+    File.unlink("perl.mgc")
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: ricardochimal-ruby-filemagic
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Travis Whitton
+- Ricardo Chimal, Jr.
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-25 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Ruby FileMagic Library Bindings
+email: ricardo@heroku.com
+executables: []
+
+extensions: 
+- extconf.rb
+extra_rdoc_files: []
+
+files: 
+- AUTHORS
+- CHANGELOG
+- extconf.rb
+- filemagic.c
+- filemagic.rd
+- README
+- test
+- test/perl
+- test/pyfile
+- test/pylink
+- test/regress.rb
+- test/leaktest.rb
+- test/pyfile-compressed.gz
+- TODO
+- ruby-filemagic.gemspec
+has_rdoc: "false"
+homepage: http://github.com/ricardochimal/ruby-filemagic
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.5
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby FileMagic Library Bindings
+test_files: []
+