mspack_rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b07279e9c4e97916854a86935c3e76358e6c0aa
+  data.tar.gz: 58541deec596d6386c6a7899ade3d0497964d095
+SHA512:
+  metadata.gz: 36db54a01cc0b420f6ecd1907a44a4294948d591a67d625647060db8ed4f7d0ec85ce29940c202b743cd7c8ea4076bea6b79fd66235d24bceb76dcf761a3bb45
+  data.tar.gz: 4bf5a16eef7b01be7ebacd12b3638127b3702598fe054212008cc2e0d433586cf893cbb7b28a12d772201eb8ba24deee6b6274642743bd9b20c11aa11cb4e1df

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mspack_rb.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{^ext/(.+)$})
+end

data/README.md

@@ -0,0 +1,21 @@
+# MspackRb
+
+### A simple Ruby native extension gem wrapper for [libmspack](https://www.cabextract.org.uk/libmspack/)
+
+Requires libmspack to be installed.
+
+Currently, only (very) basic CHM extraction has been implemented.
+
+### Usage:
+    require 'mspack_rb'
+
+    dcom = Mspack::ChmDecompressor.new
+    header = dcom.open('path/to/a/chm/file')
+    file = header.files
+    out_dir = 'some/output/directory'
+
+    while !file.nil?
+      out_path = "#{out_dir}/#{file.filename}"
+      dcom.extract(file, out_path)
+      file = file.next
+    end

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rake/extensiontask'
+require 'rspec/core/rake_task'
+
+Rake::ExtensionTask.new 'mspack' do |ext|
+  ext.lib_dir = 'lib/mspack'
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [ :compile, :spec ]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mspack_rb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/mspack/extconf.rb

@@ -0,0 +1,25 @@
+require 'mkmf'
+
+LIB_NAME = 'mspack'
+
+LIB_FUNCTION = 'mspack_version'
+
+HEADER_DIRS = [
+  '/usr/local/include',         # homebrew / from source
+  RbConfig::CONFIG['includedir'], # ruby install locations
+  '/usr/include'                # fallback
+]
+
+LIB_DIRS = [
+  '/usr/local/lib',             # homebrew / from source
+  RbConfig::CONFIG['libdir'],     # ruby install locations
+  '/usr/lib'                    # fallback
+]
+
+dir_config(LIB_NAME, HEADER_DIRS, LIB_DIRS)
+
+unless find_header("#{LIB_NAME}.h") && find_library(LIB_NAME, LIB_FUNCTION)  
+  abort "lib#{LIB_NAME} not found"
+end
+
+create_makefile(LIB_NAME)

data/ext/mspack/mspack.c

@@ -0,0 +1,113 @@
+#include <mspack.h>
+#include <ruby.h>
+
+VALUE Mspack = Qnil;
+VALUE ChmDecom = Qnil;
+VALUE ChmDHeader = Qnil;
+VALUE ChmDFile = Qnil;
+
+VALUE mspack_test() {
+  int result;
+  MSPACK_SYS_SELFTEST(result);
+  return result == MSPACK_ERR_OK ? Qtrue : Qfalse;
+}
+
+void chmd_deallocate(void *decom) {
+  mspack_destroy_chm_decompressor(decom);
+}
+
+static VALUE chmd_allocate(VALUE self) {
+  struct mschm_decompressor *decom = mspack_create_chm_decompressor(NULL);
+  return Data_Wrap_Struct(self, NULL, chmd_deallocate, decom);
+}
+
+static 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));
+
+  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);
+}
+
+static VALUE chmd_close(VALUE self, VALUE header) {
+  struct mschm_decompressor *decom;
+  Data_Get_Struct(self, struct mschm_decompressor, decom);
+
+  struct mschmd_header *headerPtr;
+  Data_Get_Struct(header, struct mschmd_header, headerPtr);
+
+  decom->close(decom, headerPtr);
+  return Qnil;
+}
+
+static VALUE chmd_extract(VALUE self, VALUE file, VALUE outputPath) {
+  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;
+}
+
+static VALUE chmd_header_filename(VALUE self) {
+  struct mschmd_header *header;
+  Data_Get_Struct(self, struct mschmd_header, header);
+  return rb_str_new2(header->filename);
+}
+
+static 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);
+}
+
+static VALUE chmd_file_filename(VALUE self) {
+  struct mschmd_file *file;
+  Data_Get_Struct(self, struct mschmd_file, file);
+  return rb_str_new2(file->filename);
+}
+
+static 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 == NULL) {
+    return Qnil;
+  }
+
+  VALUE nextObj = rb_obj_alloc(ChmDFile);
+  rb_obj_call_init(nextObj, 0, NULL);
+  return Data_Wrap_Struct(ChmDFile, NULL, NULL, next);
+}
+
+void Init_mspack() {
+  Mspack = rb_define_module("Mspack");
+  rb_define_singleton_method(Mspack, "test", mspack_test, 0);
+
+  ChmDecom = rb_define_class_under(Mspack, "ChmDecompressor", rb_cObject);
+  rb_define_alloc_func(ChmDecom, chmd_allocate);
+  rb_define_method(ChmDecom, "open", chmd_open, 1);
+  rb_define_method(ChmDecom, "close", chmd_close, 1);
+  rb_define_method(ChmDecom, "extract", chmd_extract, 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);
+}

data/lib/mspack/version.rb

@@ -0,0 +1,3 @@
+module Mspack
+  VERSION = "0.1.0"
+end

data/lib/mspack.rb

@@ -0,0 +1,12 @@
+require "mspack/mspack"
+require "mspack/version"
+
+module Mspack
+  class ChmDecompressor
+    class Header
+    end
+
+    class File
+    end
+  end
+end

data/mspack.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mspack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mspack_rb"
+  spec.version       = Mspack::VERSION
+  spec.authors       = ["Ben Williams"]
+  spec.email         = ["8enwilliams@gmail.com"]
+
+  spec.summary       = 'A ruby gem wrapper for libmspack'
+  spec.description   = 'A ruby gem wrapper for libmspack'
+  spec.homepage      = 'https://github.com/benjineering/mspack_rb'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.extensions    << 'ext/mspack/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"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: mspack_rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Williams
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+description: A ruby gem wrapper for libmspack
+email:
+- 8enwilliams@gmail.com
+executables: []
+extensions:
+- ext/mspack/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/mspack/extconf.rb
+- ext/mspack/mspack.c
+- lib/mspack.rb
+- lib/mspack/version.rb
+- mspack.gemspec
+homepage: https://github.com/benjineering/mspack_rb
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A ruby gem wrapper for libmspack
+test_files: []