stormlib 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5ff524f86ea0c9e2858245236c5a4d4502025a2fe14b41e16b9931023ddb883e
+  data.tar.gz: 4ffdd628e17b275e0808ad71c0b13f1dcd196ec37227e53cecd5853342fcaecc
+SHA512:
+  metadata.gz: adb233f5be9efa2df1605cbda608eb4333aca0d97606b26a902a88af86763df94867ca56e275347dd3394e054a5af18993682b10fd72067b03c3b0fbd9c31911
+  data.tar.gz: e00b1bf12ff95a9ef4e940ae89a7efde73eac922f6d5d4ef75b0907d1813d6c1ca6b03a9f7f1eee01773400a8c426b66c19c2e8b8de4515b29ff8c8bd7614e09

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-09-21
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 sebi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# StormLib 🌪️
+
+StormLib is a Ruby gem that provides a wrapper for the [StormLib C++ library](https://github.com/ladislav-zezula/StormLib), allowing you to work with MPQ (Mo'PaQ) archives in your Ruby projects for World of Warcraft and other Blizzard games.
+
+## 📦 Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stormlib'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install stormlib
+```
+
+## 🛠️ Dependencies
+
+Before installing the gem, make sure you have the following dependencies installed on your system:
+
+- zlib1g-dev
+- libbz2-dev
+- build-essential
+- libstdc++-12-dev
+
+You can install these on Ubuntu or Debian-based systems with:
+
+```
+$ sudo apt-get install zlib1g-dev libbz2-dev build-essential libstdc++-12-dev
+```
+
+## 🚀 Usage
+
+Here are some examples of how to use StormLib:
+
+```ruby
+require 'stormlib'
+
+# Open an existing MPQ archive
+archive = StormLib::Archive.new('game.mpq')
+
+# List files in the archive
+files = archive.list_files
+puts "Files in the archive: #{files.join(', ')}"
+
+# Extract a file from the archive
+archive.extract_file('readme.txt', 'extracted_readme.txt')
+
+# Create a new MPQ archive
+new_archive = StormLib::Archive.new('new_archive.mpq', create: true)
+
+# Add a file to the new archive
+new_archive.add_file('local_file.txt', 'archived_file.txt')
+
+# Don't forget to close the archives when you're done
+archive.close
+new_archive.close
+```
+
+## 🧪 Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 🤝 Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sebyx07/stormlib. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/sebyx07/stormlib/blob/master/CODE_OF_CONDUCT.md).
+
+## 📜 License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 👥 Code of Conduct
+
+Everyone interacting in the StormLib project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sebyx07/stormlib/blob/master/CODE_OF_CONDUCT.md).

data/ext/stormlib/extconf.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+def log(message)
+  puts "[extconf.rb] #{message}"
+end
+
+log 'Checking for StormLib...'
+STORMLIB_DIR = File.expand_path('../StormLib', __FILE__)
+
+if File.directory?(STORMLIB_DIR) && File.exist?(File.join(STORMLIB_DIR, 'src', 'StormLib.h'))
+  log 'StormLib found!'
+else
+  log "Cannot find StormLib directory in #{STORMLIB_DIR}"
+
+  system "git clone https://github.com/ladislav-zezula/StormLib.git #{STORMLIB_DIR}" or raise 'Failed to clone StormLib'
+end
+
+# Compile StormLib
+Dir.chdir(STORMLIB_DIR) do
+  log 'Configuring StormLib with CMake...'
+  system('cmake . -DCMAKE_POSITION_INDEPENDENT_CODE=ON -DCMAKE_C_FLAGS="-Wno-old-style-definition" -DBUILD_SHARED_LIBS=OFF') or raise 'Failed to configure StormLib with CMake'
+
+  log 'Cleaning previous build...'
+  system('make clean') or log 'Warning: make clean failed, but continuing...'
+
+  log 'Building StormLib...'
+  system('make') or raise 'Failed to build StormLib'
+end
+
+# Find the library file
+lib_file = Dir.glob("#{STORMLIB_DIR}/**/{libstorm.a,libstorm.so}").first
+
+if lib_file.nil?
+  raise "Cannot find libstorm.a or libstorm.so in #{STORMLIB_DIR}"
+end
+
+lib_dir = File.dirname(lib_file)
+lib_name = File.basename(lib_file).sub(/^lib/, '').sub(/\.(a|so)$/, '')
+
+log "Found StormLib: #{lib_file}"
+
+require 'mkmf'
+
+# Set up the extension
+$CFLAGS << " -I#{STORMLIB_DIR}/src -fPIC"
+$LDFLAGS << " -L#{lib_dir} -l#{lib_name} -lz -lbz2 -lstdc++"
+
+# Adjust the library path
+$LDFLAGS << " -Wl,-rpath,#{lib_dir}"
+
+# Ensure the compiler can find necessary headers and libraries
+dir_config('stormlib', "#{STORMLIB_DIR}/src", lib_dir)
+
+unless have_library(lib_name)
+  log "Unable to find #{lib_name} library. Contents of #{lib_dir}:"
+  Dir.foreach(lib_dir) { |f| log "  #{f}" }
+  raise "Unable to find #{lib_name} library"
+end
+
+unless have_library('z')
+  log 'Trying to find zlib in system directories...'
+  raise 'Unable to find zlib' unless find_library('z', 'deflate')
+end
+
+unless have_library('bz2')
+  log 'Trying to find bzip2 in system directories...'
+  raise 'Unable to find bzip2 library' unless find_library('bz2', 'BZ2_bzCompress')
+end
+
+# Create the makefile
+log 'Creating Makefile...'
+create_makefile('stormlib/stormlib')
+
+log 'extconf.rb completed successfully'

data/ext/stormlib/stormlib.c

@@ -0,0 +1,92 @@
+#include <ruby.h>
+#include <StormLib.h>
+
+static VALUE rb_SFileCreateArchive(VALUE self, VALUE filename, VALUE flags, VALUE max_file_count) {
+  HANDLE hMpq;
+  const char* szFileName = StringValueCStr(filename);
+  DWORD dwFlags = NUM2ULONG(flags);
+  DWORD dwMaxFileCount = NUM2ULONG(max_file_count);
+
+  if (SFileCreateArchive(szFileName, dwFlags, dwMaxFileCount, &hMpq)) {
+    return ULONG2NUM((uintptr_t)hMpq);
+  } else {
+    rb_raise(rb_eRuntimeError, "Failed to create archive");
+  }
+}
+
+static VALUE rb_SFileOpenArchive(VALUE self, VALUE filename, VALUE priority, VALUE flags) {
+  HANDLE hMpq;
+  const char* szFileName = StringValueCStr(filename);
+  DWORD dwPriority = NUM2ULONG(priority);
+  DWORD dwFlags = NUM2ULONG(flags);
+
+  if (SFileOpenArchive(szFileName, dwPriority, dwFlags, &hMpq)) {
+    return ULONG2NUM((uintptr_t)hMpq);
+  } else {
+    rb_raise(rb_eRuntimeError, "Failed to open archive");
+  }
+}
+
+static VALUE rb_SFileCloseArchive(VALUE self, VALUE handle) {
+  HANDLE hMpq = (HANDLE)NUM2ULONG(handle);
+
+  if (SFileCloseArchive(hMpq)) {
+    return Qtrue;
+  } else {
+    return Qfalse;
+  }
+}
+
+static VALUE rb_SFileAddFileEx(VALUE self, VALUE handle, VALUE filename, VALUE archived_name, VALUE flags) {
+  HANDLE hMpq = (HANDLE)NUM2ULONG(handle);
+  const char* szFileName = StringValueCStr(filename);
+  const char* szArchivedName = StringValueCStr(archived_name);
+  DWORD dwFlags = NUM2ULONG(flags);
+
+  if (SFileAddFileEx(hMpq, szFileName, szArchivedName, dwFlags, MPQ_COMPRESSION_ZLIB, MPQ_COMPRESSION_NEXT_SAME)) {
+    return Qtrue;
+  } else {
+    return Qfalse;
+  }
+}
+
+static VALUE rb_SFileExtractFile(VALUE self, VALUE handle, VALUE archived_name, VALUE filename) {
+  HANDLE hMpq = (HANDLE)NUM2ULONG(handle);
+  const char* szArchivedName = StringValueCStr(archived_name);
+  const char* szFileName = StringValueCStr(filename);
+
+  if (SFileExtractFile(hMpq, szArchivedName, szFileName, SFILE_OPEN_FROM_MPQ)) {
+    return Qtrue;
+  } else {
+    return Qfalse;
+  }
+}
+
+static VALUE rb_SFileListFiles(VALUE self, VALUE handle) {
+  HANDLE hMpq = (HANDLE)NUM2ULONG(handle);
+  SFILE_FIND_DATA findFileData;
+  HANDLE hFind;
+  VALUE fileList = rb_ary_new();
+
+  hFind = SFileFindFirstFile(hMpq, "*", &findFileData, NULL);
+  if (hFind != NULL) {
+    do {
+      rb_ary_push(fileList, rb_str_new_cstr(findFileData.cFileName));
+    } while (SFileFindNextFile(hFind, &findFileData));
+
+    SFileFindClose(hFind);
+  }
+
+  return fileList;
+}
+
+void Init_stormlib() {
+  VALUE mStormLib = rb_define_module("StormLib");
+
+  rb_define_singleton_method(mStormLib, "create_archive", rb_SFileCreateArchive, 3);
+  rb_define_singleton_method(mStormLib, "open_archive", rb_SFileOpenArchive, 3);
+  rb_define_singleton_method(mStormLib, "close_archive", rb_SFileCloseArchive, 1);
+  rb_define_singleton_method(mStormLib, "add_file", rb_SFileAddFileEx, 4);
+  rb_define_singleton_method(mStormLib, "extract_file", rb_SFileExtractFile, 3);
+  rb_define_singleton_method(mStormLib, "list_files", rb_SFileListFiles, 1);
+}

data/lib/stormlib/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Stormlib
+  VERSION = '0.1.0'
+end

data/lib/stormlib.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'stormlib/version'
+require_relative 'stormlib/stormlib'
+
+module StormLib
+  class Archive
+    def initialize(filename, create: false, max_file_count: 1000)
+      if create
+        @handle = StormLib.create_archive(filename, 0, max_file_count)
+      else
+        @handle = StormLib.open_archive(filename, 0, 0)
+      end
+    end
+
+    def close
+      StormLib.close_archive(@handle)
+    end
+
+    def add_file(filename, archived_name, flags = 0)
+      StormLib.add_file(@handle, filename, archived_name, flags)
+    end
+
+    def extract_file(archived_name, filename)
+      StormLib.extract_file(@handle, archived_name, filename)
+    end
+
+    def list_files
+      StormLib.list_files(@handle)
+    end
+  end
+end

data/stormlib.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/stormlib/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'stormlib'
+  spec.version = Stormlib::VERSION
+  spec.authors = ['sebi']
+  spec.email = ['gore.sebyx@yahoo.com']
+
+  spec.summary = 'MPQ library for Ruby using the StormLib C library'
+  spec.description = 'MPQ library for Ruby using the StormLib C library'
+  spec.homepage = 'https://github.com/sebyx07/stormlib'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.extensions = ['ext/stormlib/extconf.rb']
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  gemspec = File.basename(__FILE__)
+  spec.files = Dir.glob('{lib,ext}/**/*') + %w[README.md LICENSE.txt CHANGELOG.md] + [gemspec]
+  spec.files = spec.files.reject do |f|
+    f.end_with?('.o', '.so') || f.include?('ext/stormlib/StormLib')
+  end
+
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rake-compiler', '>= 1.2.7'
+  spec.add_development_dependency 'rake', '>= 13'
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: stormlib
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sebi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.7
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13'
+description: MPQ library for Ruby using the StormLib C library
+email:
+- gore.sebyx@yahoo.com
+executables: []
+extensions:
+- ext/stormlib/extconf.rb
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- ext/stormlib/extconf.rb
+- ext/stormlib/stormlib.c
+- lib/stormlib.rb
+- lib/stormlib/version.rb
+- stormlib.gemspec
+homepage: https://github.com/sebyx07/stormlib
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/sebyx07/stormlib
+  source_code_uri: https://github.com/sebyx07/stormlib
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.17
+signing_key: 
+specification_version: 4
+summary: MPQ library for Ruby using the StormLib C library
+test_files: []