mspack_rb 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c69d841d0a58a91453d2b8ebd9f3a91030b67c64
-  data.tar.gz: c087616dcf7d380e2c635f9e07d056b77c632c85
+  metadata.gz: 7f9c40d23c5867b56e2fa1b1960fd31309cfa799
+  data.tar.gz: 642ae95857d11d712c584a11b2f20ba0b2daeca3
 SHA512:
-  metadata.gz: 86224b683f84c19b88445c65587d9cbca548a20e398b0681f1fb9fecf2d4467f4711abcb410b4c85cc4eec42895f28ba229425a4ff5d8a0052258be199385a03
-  data.tar.gz: 67bba4649f8e0be72c7fbe2791e35c65f3ffcd8321d69564639ef358335e7a31363c0ce71fed9fe98ff1281ff6fbbc23f21b4d166a1bb2839b42b8f54774d7cc
+  metadata.gz: 508fd382485b88754746f25ff1bae5006a68306c5ced69a141e52c053470a2c89d6014cb8999f2ea7a261f5e9a535eb4cf5fffd40b46322ef013ca0bc7199f68
+  data.tar.gz: 64dd35882e4fa5fbfa80c147ad422ec30d83caf27d89df1ea130ec743d2e2bb02889b64287b9855375ebbda35851bf155f095b66b8dae948a10beb83b6ad564b

data/.gitignore

@@ -1,10 +1,14 @@
 /.bundle/
 /.yardoc
+/.byebug_history
+
 /Gemfile.lock
 /_yardoc/
+
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
 /tmp/
-/lib/mspack/mspack.bundle
+
+/lib/mspack_native.bundle

data/README.md

@@ -2,14 +2,24 @@
 
 ### A simple Ruby native extension gem wrapper for [libmspack](https://www.cabextract.org.uk/libmspack/)
 
-Requires libmspack to be installed, and currently, only basic CHM 
-extraction has been implemented.
+Requires libmspack to be installed, and currently, only CHM extraction has been
+implemented.
 
 The gem is available over at [https://rubygems.org/gems/mspack_rb](https://rubygems.org/gems/mspack_rb).
 
 ### Usage:
     require 'mspack'
 
+    # Extract all files to disk
     dcom = Mspack::ChmDecompressor.new
     header = dcom.open('path/to/a/chm/file')
     header.each_file { |file| dcom.extract(file, out_path) }
+    dcom.close(header)
+
+    # Extract a specific file by name
+    fast_open_header = dcom.fast_open('path/to/a/chm/file')
+    file = dcom.fast_find(fast_open_header, '/index.html')
+    dcom.extract(file) unless file.nil?
+
+    # check last error
+    p 'w00t' if dcom.last_error == :ok

data/ext/mspack_native/chm_decompressor.c

@@ -1,35 +1,109 @@
 #include "chm_decompressor.h"
+#include "mspack_native.h"
+#include "chm_decompressor_header.h"
+#include "chm_decompressor_file.h"
 
 #include <mspack.h>
 
-VALUE ChmDecom = Qnil;
-VALUE ChmDHeader = Qnil;
-VALUE ChmDFile = Qnil;
+/*
+ * utility methods
+ */
+
+static inline VALUE _error_code_sym(int code) {
+  const char *str;
+
+  switch (code) {
+  case MSPACK_ERR_OK:
+    str = "ok";
+    break;
+  case MSPACK_ERR_ARGS:
+    str = "args";
+    break;
+  case MSPACK_ERR_OPEN:
+    str = "open";
+    break;
+  case MSPACK_ERR_READ:
+    str = "read";
+    break;
+  case MSPACK_ERR_WRITE:
+    str = "write";
+    break;
+  case  MSPACK_ERR_SEEK:
+    str = "seek";
+    break;
+  case MSPACK_ERR_NOMEMORY:
+    str = "no_memory";
+    break;
+  case MSPACK_ERR_SIGNATURE:
+    str = "signature";
+    break;
+  case MSPACK_ERR_DATAFORMAT:
+    str = "data_format";
+    break;
+  case MSPACK_ERR_CHECKSUM:
+    str = "checksum";
+    break;
+  case MSPACK_ERR_CRUNCH:
+    str = "crunch";
+    break;
+  case MSPACK_ERR_DECRUNCH:
+    str = "decrunch";
+    break;
+  default:
+    str = "unknown";
+  }
 
-void chmd_deallocate(void *decom) {
-  mspack_destroy_chm_decompressor(decom);
+  return ID2SYM(rb_intern(str));
 }
 
-VALUE chmd_allocate(VALUE self) {
-  struct mschm_decompressor *decom = mspack_create_chm_decompressor(NULL);
-  return Data_Wrap_Struct(self, NULL, chmd_deallocate, decom);
-}
+static inline VALUE _open(VALUE self, VALUE path, int fast_bool) {
+  Check_Type(path, T_STRING);
 
-VALUE chmd_open(VALUE self, VALUE path) {
   struct mschm_decompressor *decom;
   Data_Get_Struct(self, struct mschm_decompressor, decom);
-  struct mschmd_header *header = decom->open(decom, StringValueCStr(path));
+
+  struct mschmd_header *header;
+
+  if (fast_bool) {
+    header = decom->fast_open(decom, StringValueCStr(path));
+  }
+  else {
+    header = decom->open(decom, StringValueCStr(path));
+  }
 
   if (!header) {
     return Qnil;
   }
 
-  VALUE headerObj = rb_obj_alloc(ChmDHeader);
-  rb_obj_call_init(headerObj, 0, NULL);
-  return Data_Wrap_Struct(ChmDHeader, NULL, NULL, header);
+  VALUE headerObj = Data_Wrap_Struct(ChmDHeader, NULL, NULL, header);
+  VALUE is_fast_open = fast_bool ? Qtrue : Qfalse;
+  rb_iv_set(headerObj, "is_fast_open", is_fast_open);
+
+  return headerObj;
+}
+
+/*
+ * decompressor
+ */
+
+void chmd_deallocate(void *decom) {
+  mspack_destroy_chm_decompressor(decom);
+}
+
+VALUE chmd_allocate(VALUE self) {
+  struct mschm_decompressor *decom = mspack_create_chm_decompressor(NULL);
+  return Data_Wrap_Struct(self, NULL, chmd_deallocate, decom);
+}
+
+VALUE chmd_open(VALUE self, VALUE path) {
+  return _open(self, path, 0);
 }
 
 VALUE chmd_close(VALUE self, VALUE header) {
+  if (!CLASS_OF(header) == ChmDHeader) {
+    rb_raise(rb_eTypeError, "Parameter must be a CHM decompression header");
+  }
+
   struct mschm_decompressor *decom;
   Data_Get_Struct(self, struct mschm_decompressor, decom);
 
@@ -41,50 +115,61 @@ VALUE chmd_close(VALUE self, VALUE header) {
 }
 
 VALUE chmd_extract_to_path(VALUE self, VALUE file, VALUE outputPath) {
+  if (!CLASS_OF(file) == ChmDFile) {
+    rb_raise(rb_eTypeError, "First parameter must be a CHM decompression file");
+  }
+
+  Check_Type(outputPath, T_STRING);
+
   struct mschm_decompressor *decom;
   Data_Get_Struct(self, struct mschm_decompressor, decom);
 
   struct mschmd_file *filePtr;
   Data_Get_Struct(file, struct mschmd_file, filePtr);
-
   const char *pathStr = StringValueCStr(outputPath);
-  return decom->extract(decom, filePtr, pathStr) == MSPACK_ERR_OK ? 
-    Qtrue : Qfalse;
-}
 
-VALUE chmd_header_filename(VALUE self) {
-  struct mschmd_header *header;
-  Data_Get_Struct(self, struct mschmd_header, header);
-  return rb_str_new2(header->filename);
+  int result = decom->extract(decom, filePtr, pathStr);
+  return result == MSPACK_ERR_OK ? Qtrue : Qfalse;
 }
 
-VALUE chmd_header_files(VALUE self) {
-  struct mschmd_header *header;
-  Data_Get_Struct(self, struct mschmd_header, header);
-  
-  VALUE fileObj = rb_obj_alloc(ChmDFile);
-  rb_obj_call_init(fileObj, 0, NULL);
-  return Data_Wrap_Struct(ChmDFile, NULL, NULL, header->files);
+VALUE chmd_last_error(VALUE self) {
+  struct mschm_decompressor *decom;
+  Data_Get_Struct(self, struct mschm_decompressor, decom);
+
+  int error = decom->last_error(decom);
+  return _error_code_sym(error);
 }
 
-VALUE chmd_file_filename(VALUE self) {
-  struct mschmd_file *file;
-  Data_Get_Struct(self, struct mschmd_file, file);
-  return rb_str_new2(file->filename);
+VALUE chmd_fast_open(VALUE self, VALUE path) {
+  return _open(self, path, 1);
 }
 
-VALUE chmd_file_next(VALUE self) {
-  struct mschmd_file *file;
-  Data_Get_Struct(self, struct mschmd_file, file);  
-  struct mschmd_file *next = file->next;
+VALUE chmd_fast_find(VALUE self, VALUE header, VALUE filename) {
+  struct mschm_decompressor *decom;
+  Data_Get_Struct(self, struct mschm_decompressor, decom);
+
+  struct mschmd_header *headerPtr;
+  Data_Get_Struct(header, struct mschmd_header, headerPtr);
+
+  const char *filenameStr = StringValueCStr(filename);
 
-  if (next == NULL) {
+  int structSize = sizeof(struct mschmd_file);
+  struct mschmd_file *file = malloc(structSize);
+
+  int result = 
+    decom->fast_find(decom, headerPtr, filenameStr, file, structSize);
+
+  if (result != MSPACK_ERR_OK || file->length == 0) {
+    free(file);
     return Qnil;
-  }
+  }  
 
-  VALUE nextObj = rb_obj_alloc(ChmDFile);
-  rb_obj_call_init(nextObj, 0, NULL);
-  return Data_Wrap_Struct(ChmDFile, NULL, NULL, next);
+  file->filename = malloc(sizeof(char) * strlen(filenameStr) + 1);
+  strcpy(file->filename, filenameStr);
+
+  VALUE fileObj = Data_Wrap_Struct(ChmDFile, NULL, NULL, file);
+  rb_iv_set(fileObj, "is_fast_find", Qtrue);
+  return fileObj;
 }
 
 void Init_chm_decompressor() {
@@ -93,12 +178,7 @@ void Init_chm_decompressor() {
   rb_define_method(ChmDecom, "open", chmd_open, 1);
   rb_define_method(ChmDecom, "close", chmd_close, 1);
   rb_define_method(ChmDecom, "extract_to_path", chmd_extract_to_path, 2);
-
-  ChmDHeader = rb_define_class_under(ChmDecom, "Header", rb_cObject);
-  rb_define_method(ChmDHeader, "filename", chmd_header_filename, 0);
-  rb_define_method(ChmDHeader, "files", chmd_header_files, 0);
-
-  ChmDFile = rb_define_class_under(ChmDecom, "File", rb_cObject);
-  rb_define_method(ChmDFile, "filename", chmd_file_filename, 0);
-  rb_define_method(ChmDFile, "next", chmd_file_next, 0);
+  rb_define_method(ChmDecom, "last_error", chmd_last_error, 0);
+  rb_define_method(ChmDecom, "fast_open", chmd_fast_open, 1);
+  rb_define_method(ChmDecom, "fast_find", chmd_fast_find, 2);
 }

data/ext/mspack_native/chm_decompressor.h

@@ -1,11 +1,7 @@
 #ifndef CHM_DECOMPRESSOR_H
 #define CHM_DECOMPRESSOR_H
 
-#include "mspack_native.h"
-
-extern VALUE ChmDecom;
-extern VALUE ChmDHeader;
-extern VALUE ChmDFile;
+#include <ruby.h>
 
 void Init_chm_decompressor();
 

data/ext/mspack_native/chm_decompressor_file.c

@@ -0,0 +1,52 @@
+#include "chm_decompressor_file.h"
+#include "mspack_native.h"
+
+#include <mspack.h>
+
+void chmd_file_free(void *ptr) {
+  struct mschmd_file *file = (struct mschmd_file *)ptr;
+
+  if (file->length == 0) { // only free if it was created in fast_find
+    //if (file->filename) {
+    //  free(file->filename);
+    //}
+
+    free(file);
+  }
+}
+
+VALUE chmd_file_filename(VALUE self) {
+  struct mschmd_file *file;
+  Data_Get_Struct(self, struct mschmd_file, file);
+
+  if (!file->filename) {
+    return Qnil;
+  }
+
+  return rb_str_new2(file->filename);
+}
+
+VALUE chmd_file_next(VALUE self) {
+  struct mschmd_file *file;
+  Data_Get_Struct(self, struct mschmd_file, file);  
+  struct mschmd_file *next = file->next;
+
+  if (!next) {
+    return Qnil;
+  }
+
+  VALUE nextObj = Data_Wrap_Struct(ChmDFile, NULL, chmd_file_free, next);
+  rb_iv_set(nextObj, "is_fast_find", Qfalse);
+  return nextObj;
+}
+
+VALUE chmd_file_is_fast_find(VALUE self) {
+  return rb_iv_get(self, "is_fast_find");
+}
+
+void Init_chm_decompressor_file() {
+  ChmDFile = rb_define_class_under(ChmDecom, "File", rb_cObject);
+  rb_define_method(ChmDFile, "filename", chmd_file_filename, 0);
+  rb_define_method(ChmDFile, "next", chmd_file_next, 0);
+  rb_define_method(ChmDFile, "fast_find?", chmd_file_is_fast_find, 0);
+}

data/ext/mspack_native/chm_decompressor_file.h

@@ -0,0 +1,8 @@
+#ifndef CHM_DECOMPRESSOR_FILE_H
+#define CHM_DECOMPRESSOR_FILE_H
+
+#include <ruby.h>
+
+void Init_chm_decompressor_file();
+
+#endif

data/ext/mspack_native/chm_decompressor_header.c

@@ -0,0 +1,34 @@
+#include "chm_decompressor_header.h"
+#include "mspack_native.h"
+
+#include <mspack.h>
+
+VALUE chmd_header_filename(VALUE self) {
+  struct mschmd_header *header;
+  Data_Get_Struct(self, struct mschmd_header, header);
+  return rb_str_new2(header->filename);
+}
+
+VALUE chmd_header_files(VALUE self) {
+  struct mschmd_header *header;
+  Data_Get_Struct(self, struct mschmd_header, header);
+
+  if (!header->files) {
+    return Qnil;
+  }
+  
+  VALUE file = Data_Wrap_Struct(ChmDFile, NULL, NULL, header->files);
+  rb_iv_set(file, "is_fast_find", Qfalse);
+  return file;
+}
+
+VALUE chmd_header_is_fast_open(VALUE self) {
+  return rb_iv_get(self, "is_fast_open");
+}
+
+void Init_chm_decompressor_header() {
+  ChmDHeader = rb_define_class_under(ChmDecom, "Header", rb_cObject);
+  rb_define_method(ChmDHeader, "filename", chmd_header_filename, 0);
+  rb_define_method(ChmDHeader, "files", chmd_header_files, 0);
+  rb_define_method(ChmDHeader, "fast_open?", chmd_header_is_fast_open, 0);
+}

data/ext/mspack_native/chm_decompressor_header.h

@@ -0,0 +1,8 @@
+#ifndef CHM_DECOMPRESSOR_HEADER_H
+#define CHM_DECOMPRESSOR_HEADER_H
+
+#include <ruby.h>
+
+void Init_chm_decompressor_header();
+
+#endif

data/ext/mspack_native/mspack_native.c

@@ -1,9 +1,14 @@
 #include "mspack_native.h"
 #include "chm_decompressor.h"
+#include "chm_decompressor_file.h"
+#include "chm_decompressor_header.h"
 
 #include <mspack.h>
 
 VALUE Mspack = Qnil;
+VALUE ChmDecom = Qnil;
+VALUE ChmDHeader = Qnil;
+VALUE ChmDFile = Qnil;
 
 VALUE mspack_test() {
   int result;
@@ -16,4 +21,6 @@ void Init_mspack_native() {
   rb_define_singleton_method(Mspack, "test", mspack_test, 0);
 
   Init_chm_decompressor();
+  Init_chm_decompressor_header();
+  Init_chm_decompressor_file();
 }

data/ext/mspack_native/mspack_native.h

@@ -4,5 +4,8 @@
 #include <ruby.h>
 
 extern VALUE Mspack;
+extern VALUE ChmDecom;
+extern VALUE ChmDHeader;
+extern VALUE ChmDFile;
 
 #endif

data/lib/mspack/chm_decompressor.rb

@@ -36,7 +36,6 @@ module Mspack
           index += 1
         end
       end
-
     end
 
 

data/lib/mspack/version.rb

@@ -1,3 +1,3 @@
 module Mspack
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/lib/mspack.rb

@@ -12,6 +12,10 @@ module Mspack
   # Raises an error if the final, expanded path is outside of dir.
   # Returns the expanded file path.
   def self.ensure_path(filename, dir)
+    unless filename.is_a?(String) && dir.is_a?(String)
+      raise TypeError, 'both parameters must be strings'
+    end
+
     raise PathError, "#{dir} is not a directory" unless ::File.directory?(dir)
     raise PathError, "#{dir} is not writable" unless ::File.writable?(dir)
 

data/mspack.gemspec

@@ -23,9 +23,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.extensions    << 'ext/mspack_native/extconf.rb'
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rake-compiler", "~> 1.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency 'bundler', '~> 1.13'
+
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake-compiler', '~> 1.0'
+
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'guard-rspec','~> 4.7'
+
+  spec.add_development_dependency 'byebug'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mspack_rb
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Ben Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-04 00:00:00.000000000 Z
+date: 2017-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A ruby gem wrapper for libmspack
 email:
 - 8enwilliams@gmail.com
@@ -99,13 +113,16 @@ files:
 - bin/setup
 - ext/mspack_native/chm_decompressor.c
 - ext/mspack_native/chm_decompressor.h
+- ext/mspack_native/chm_decompressor_file.c
+- ext/mspack_native/chm_decompressor_file.h
+- ext/mspack_native/chm_decompressor_header.c
+- ext/mspack_native/chm_decompressor_header.h
 - ext/mspack_native/extconf.rb
 - ext/mspack_native/mspack_native.c
 - ext/mspack_native/mspack_native.h
 - lib/mspack.rb
 - lib/mspack/chm_decompressor.rb
 - lib/mspack/version.rb
-- lib/mspack_native.bundle
 - mspack.gemspec
 homepage: https://github.com/benjineering/mspack_rb
 licenses: