yara 1.4.2 → 1.4.3

data/.document

@@ -1,5 +1,6 @@
 lib/**/*.rb
 bin/*
+ext/**/*.c
 - 
 features/**/*.feature
 LICENSE.txt

data/History.txt

@@ -1,3 +1,8 @@
+== 1.4.3 / 2011-02-21
+  * Improved documentation 
+  * More intuitive 'inspect' features for testing in IRB.
+  * Also may have fixed memory leaks with Match and MatchString objects.
+
 == 1.4.2 / 2011-02-17
   * Polished release version
 

data/Rakefile

@@ -22,18 +22,20 @@ Jeweler::Tasks.new do |gem|
   gem.authors = ["Eric Monti"]
 
   gem.extensions = FileList['ext/**/extconf.rb']
+  gem.extra_rdoc_files += Dir['ext/**/*.c']
 
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
-  #  gem.add_development_dependency 'rspec', '> 1.2.3'
 end
+
 Jeweler::RubygemsDotOrgTasks.new
 
 Rake::ExtensionTask.new("yara_native")
 
 CLEAN.include("lib/*.bundle")
 CLEAN.include("lib/*.so")
+CLEAN.include("tmp/")
+CLEAN.include("doc/")
+CLEAN.include("rdoc/")
+CLEAN.include("coverage/")
 
 require 'rspec/core'
 require 'rspec/core/rake_task'

data/VERSION

@@ -1 +1 @@
-1.4.2
+1.4.3

data/ext/yara_native/Match.c

@@ -76,22 +76,28 @@ typedef struct {
 static VALUE 
 MatchString_NEW(int offset, char *ident, char *buf, size_t buflen) {
   match_string *ms;
+  VALUE rb_ms = Qnil;
 
   ms = (match_string *) malloc(sizeof(match_string));
 
   if (! ms)
-    rb_raise(rb_eNoMemError, "Can't allocate MatchString");
+    rb_sys_fail("Can't allocate MatchString");
 
-  ms->offset      = INT2NUM(offset);
-  ms->identifier  = rb_obj_freeze(rb_str_new2(ident));
-  ms->buffer      = rb_obj_freeze(rb_str_new(buf, buflen));
+  rb_ms = Data_Wrap_Struct(class_MatchString, 0, free, ms);
 
-  return rb_obj_freeze(Data_Wrap_Struct(class_MatchString, 0, free, ms));
+  ms->offset      = rb_iv_set(rb_ms, "@offset", INT2NUM(offset));
+  ms->identifier  = rb_iv_set(rb_ms, "@identifier", 
+                      rb_obj_freeze(rb_str_new2(ident)));
+  ms->buffer      = rb_iv_set(rb_ms, "@buffer", 
+                      rb_obj_freeze(rb_str_new(buf, buflen)));
+
+  return rb_obj_freeze(rb_ms);
 }
 
 int 
 Match_NEW_from_rule(RULE *rule, unsigned char *buffer, VALUE *match) {
   match_info *mi;
+  VALUE rb_mi = Qnil;
 
   TAG *tag;
   STRING *string;
@@ -105,11 +111,13 @@ Match_NEW_from_rule(RULE *rule, unsigned char *buffer, VALUE *match) {
   if (! mi )
     return 1;
 
-  mi->rule      = rb_obj_freeze(rb_str_new2(rule->identifier));
-  mi->namespace = rb_obj_freeze(rb_str_new2(rule->namespace->name));
-  mi->tags      = rb_ary_new();
-  mi->strings   = rb_ary_new();
-  mi->meta      = rb_hash_new();
+  rb_mi = Data_Wrap_Struct(class_Match, 0, free, mi);
+
+  mi->rule      = rb_iv_set(rb_mi, "@rule", rb_obj_freeze(rb_str_new2(rule->identifier)));
+  mi->namespace = rb_iv_set(rb_mi, "@namespace", rb_obj_freeze(rb_str_new2(rule->namespace->name)));
+  mi->tags      = rb_iv_set(rb_mi, "@tags", rb_ary_new());
+  mi->strings   = rb_iv_set(rb_mi, "@strings", rb_ary_new());
+  mi->meta      = rb_iv_set(rb_mi, "@meta", rb_hash_new());
 
   tag = rule->tag_list_head;
   while (tag) {
@@ -158,7 +166,7 @@ Match_NEW_from_rule(RULE *rule, unsigned char *buffer, VALUE *match) {
   }
   rb_obj_freeze(mi->meta);
 
-  *(match) = rb_obj_freeze(Data_Wrap_Struct(class_Match, 0, free, mi));
+  *(match) = rb_obj_freeze(rb_mi);
 
   return 0;
 }
@@ -169,7 +177,7 @@ Match_NEW_from_rule(RULE *rule, unsigned char *buffer, VALUE *match) {
  * call-seq:
  *      match.rule() -> String
  *
- * Returns the rule identifier string for this match.
+ * @return String The rule identifier string for this match.
  */
 static VALUE match_rule(VALUE self) {
   match_info *mi;
@@ -183,7 +191,7 @@ static VALUE match_rule(VALUE self) {
  * call-seq:
  *      match.namespace() -> String
  *
- * Returns the namespace for this match.
+ * @return String The namespace for this match.
  */
 static VALUE match_namespace(VALUE self) {
   match_info *mi;
@@ -197,7 +205,7 @@ static VALUE match_namespace(VALUE self) {
  * call-seq:
  *      match.tags() -> Array
  *
- * Returns an array of tag Strings for this match.
+ * @return [String]   An array of tags for this match.
  */
 static VALUE match_tags(VALUE self) {
   match_info *mi;
@@ -211,7 +219,7 @@ static VALUE match_tags(VALUE self) {
  * call-seq:
  *      match.strings() -> Array
  *
- * Returns an array of MatchString objects for this match.
+ * @return [Yara::MatchString]   An array of MatchString objects for this match.
  */
 static VALUE match_strings(VALUE self) {
   match_info *mi;
@@ -225,7 +233,7 @@ static VALUE match_strings(VALUE self) {
  * call-seq:
  *      match.meta() -> Hash
  *
- * Returns a hash of metadata for the match object.
+ * @return Hash   Keyed values of metadata for the match object.
  */
 static VALUE match_meta(VALUE self) {
   match_info *mi;
@@ -239,7 +247,7 @@ static VALUE match_meta(VALUE self) {
  * call-seq:
  *      matchstring.identifier() -> String
  *
- * Returns the identification label for the string.
+ * @return String   The identification label for the string.
  */
 static VALUE matchstring_identifier(VALUE self) {
   match_string *ms;
@@ -251,9 +259,9 @@ static VALUE matchstring_identifier(VALUE self) {
  * Document-method: offset
  *
  * call-seq:
- *      matchstring.offset() -> fixnum
+ *      matchstring.offset() -> Fixnum
  *
- * Returns the offset where the match occurred.
+ * @return Fixnum   The offset where the match occurred.
  */
 static VALUE matchstring_offset(VALUE self) {
   match_string *ms;
@@ -267,7 +275,7 @@ static VALUE matchstring_offset(VALUE self) {
  * call-seq:
  *      matchstring.buffer() -> String
  *
- * Returns the data matched.
+ * @return String   The data matched in the buffer.
  */
 static VALUE matchstring_buffer(VALUE self) {
   match_string *ms;

data/ext/yara_native/Rules.c

@@ -48,6 +48,10 @@ VALUE rules_allocate(VALUE klass) {
  *
  * To avoid namespace conflicts, you can use set_namespace
  * before compiling rules.
+ *
+ * @param String filename The name of a yara rules file to compile.
+ *
+ * @raise Yara::CompileError An exception is raised if a compile error occurs.
  */
 VALUE rules_compile_file(VALUE self, VALUE rb_fname) {
   FILE * file;
@@ -87,6 +91,10 @@ VALUE rules_compile_file(VALUE self, VALUE rb_fname) {
  *
  * To avoid namespace conflicts, you can use set_namespace
  * before compiling rules.
+ *
+ * @param String rules_string A string containing yara rules text.
+ *
+ * @raise Yara::CompileError An exception is raised if a compile error occurs.
  */
 VALUE rules_compile_string(VALUE self, VALUE rb_rules) {
   YARA_CONTEXT *ctx;
@@ -109,9 +117,10 @@ VALUE rules_compile_string(VALUE self, VALUE rb_rules) {
  * Document-method: weight
  *
  * call-seq:
- *      rules.weight() -> fixnum
+ *      rules.weight() -> Fixnum
  *
- * Returns a weight value for the compiled rules.
+ * @return Fixnum 
+ *      returns a weight value for the compiled rules.
  */
 
 VALUE rules_weight(VALUE self) {
@@ -126,7 +135,7 @@ VALUE rules_weight(VALUE self) {
  * call-seq:
  *      rules.current_namespace() -> String
  *
- * Returns the name of the currently active namespace.
+ * @return String Returns the name of the currently active namespace.
  */
 VALUE rules_current_namespace(VALUE self) {
   YARA_CONTEXT *ctx;
@@ -143,7 +152,7 @@ VALUE rules_current_namespace(VALUE self) {
  * call-seq:
  *      rules.namespaces() -> Array
  *
- * Returns the namespaces available in this rules context.
+ * @return [String] Returns the namespaces available in this rules context.
  */
 VALUE rules_namespaces(VALUE self) {
   YARA_CONTEXT *ctx;
@@ -182,6 +191,8 @@ NAMESPACE * find_namespace(YARA_CONTEXT *ctx, const char *name) {
  *
  * To avoid namespace conflicts, you can use set_namespace
  * before compiling rules.
+ *
+ * @param String name The namespace to set.
  */
 VALUE rules_set_namespace(VALUE self, VALUE rb_namespace) {
   YARA_CONTEXT *ctx;
@@ -205,6 +216,7 @@ VALUE rules_set_namespace(VALUE self, VALUE rb_namespace) {
 
 }
 
+/* an internal callback function used with scan_file and scan_string */
 static int 
 scan_callback(RULE *rule, unsigned char *buffer, unsigned int buffer_size, void *data) {
   int match_ret;
@@ -224,10 +236,16 @@ scan_callback(RULE *rule, unsigned char *buffer, unsigned int buffer_size, void
  * Document-method: scan_file
  *
  * call-seq:
- *      rules.scan_file(filename) -> nil
+ *      rules.scan_file(filename) -> Array
  *
  * Scans a file using the compiled rules supplied
  * with either compile_file or compile_string (or both).
+ *
+ * @param String filename The name of a file to scan with yara.
+ *
+ * @return [Yara::Match] An array of Yara::Match objects found in the file.
+ *
+ * @raise Yara::ScanError Raised if an error occurs while scanning the file.
  */
 VALUE rules_scan_file(VALUE self, VALUE rb_fname) {
   YARA_CONTEXT *ctx;
@@ -255,10 +273,16 @@ VALUE rules_scan_file(VALUE self, VALUE rb_fname) {
  * Document-method: scan_file
  *
  * call-seq:
- *      rules.scan_string(data) -> nil
+ *      rules.scan_string(buf) -> Array
  *
  * Scans a ruby string using the compiled rules supplied
  * with either compile_file or compile_string (or both).
+ *
+ * @param String buf The string buffer to scan with yara.
+ *
+ * @return [Yara::Match] An array of Yara::Match objects found in the string.
+ *
+ * @raise Yara::ScanError Raised if an error occurs while scanning the string.
  */
 VALUE rules_scan_string(VALUE self, VALUE rb_dat) {
   YARA_CONTEXT *ctx;

data/lib/yara.rb

@@ -30,10 +30,6 @@ module Yara
         :strings => self.strings }
     end
 
-    def inspect
-      h=to_hash
-      h.inspect
-    end
   end
 
   class MatchString
@@ -52,10 +48,6 @@ module Yara
       { :offset => self.offset, :identifier => self.ident, :buffer => self.buffer}
     end
 
-    def inspect
-      h=to_a
-      h.inspect
-    end
   end
 
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 4
-  - 2
-  version: 1.4.2
+  - 3
+  version: 1.4.3
 platform: ruby
 authors: 
 - Eric Monti
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-17 00:00:00 -06:00
+date: 2011-02-21 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -106,6 +106,9 @@ extensions:
 extra_rdoc_files: 
 - LICENSE.txt
 - README.rdoc
+- ext/yara_native/Match.c
+- ext/yara_native/Rules.c
+- ext/yara_native/Yara_native.c
 files: 
 - .document
 - .rspec