ruzip 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 005b429739ebd855ccaf9d9f26860daf965afad15b204f421b8783feca5214ee
-  data.tar.gz: 7a5599f4510de29b3f177a08318fb7c0371f5a568ffc7312ba0f052d6157e577
+  metadata.gz: 1a3933d33701a2ef5266034395c9d150def3302051cc5e58cfec95e0c8781f26
+  data.tar.gz: 483047dd80f31be198c1123ee28f93c316d7041ea48c640936fe584d9573b9c8
 SHA512:
-  metadata.gz: d7dd75900ab1db49783d0560f8a711f31df8a6366e62a7d4fa8cbbe5f3d79655f36ff0516c8cde456c972683053220b412dc3f49ab18bbdb8fee7696d314fe51
-  data.tar.gz: 8d8a1d3ba72c469168424fb1072a4c4f8ecfcf151932bf9668ecf860908d2b4bb26e7e4177cd2029e17857a03b62869917a0005a0af8ab2714053f2007ee31fb
+  metadata.gz: de64677667aabcf0f6d6246af4bb7ff0653f8c49b26f2b0b412ba68590c211865e64af5bf64ff2ebd18030c8d93aeb575e2963e3c3df5943a4bb295cb66f5090
+  data.tar.gz: 8fca9556da607ca7661457baf087c5f9063855538051142aad32452f770074d9879389ff8a1479a8d2ebb0fe8c16809ee12f30a6febee2d447b1e5d6ba190ec6

data/.gitignore

@@ -14,3 +14,4 @@ mkmf.log
 target/
 Gemfile.lock
 /test/fixtures/accessible_epub_3.epub
+html/

data/.gitlab-ci.yml

@@ -1,12 +1,11 @@
 default:
-  image: ruby:3.4.7
+  image: ruby:4.0.0
 
   before_script:
     - apt-get update && apt-get install -y clang
     - curl https://sh.rustup.rs -sSf | sh -s -- -y
     - . "$HOME/.cargo/env"
     - gem update --system
-    - gem install bundler
     - bundle install
 
 test:

data/.rdoc_options

@@ -0,0 +1,9 @@
+main_page: README.md
+
+include:
+- CHANGELOG.md
+- sig
+
+exclude:
+- ext/target
+- vendor

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.2.0] - 2026-01-04
+
+* Return binary from {File#read}
+* Raise exception safely
+* Update zip crate to v7.0.0
+
 ## [0.1.0] - 2023-12-08
 
 - Initial release

data/README.md

@@ -1,35 +1,41 @@
 # RuZip
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ruzip`. To experiment with that code, run `bin/console` for an interactive prompt.
+Library to support the reading and writing of zip files. A wrapper of Rust's [zip](https://github.com/zip-rs/zip2?tab=readme-ov-file) crate.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add ruzip
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install ruzip
 
 ## Usage
 
-TODO: Write usage instructions here
+    require "ruzip"
+    
+    archive = RuZip::Archive.new("path/to/archive.zip")
+    archive.length #=> Integer, the number of files the archive holds
+    
+    archive.length.times do |i|
+      file = archive.by_index(i) #=> RuZip::File
+      file.name # => String
+      file.size # => Integer, the size of decompressed file
+      file.last_modified # => Time
+      content = file.read # => ASCII-8BIT String (BINARY)
+      content.force_encoding("UTF-8") # If it's text, it is in UTF-8.
+    end
+    
+    archive.by_name("path/in/zip/archive") # => RuZip::File
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test-unit` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rake test` to run the tests. You can also run `bundle exec rake 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).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `ext/Cargo.toml`, run `cargo update --manifest-path=ext/Cargo.toml`, 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/[USERNAME]/ruzip. 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/[USERNAME]/ruzip/blob/main/CODE_OF_CONDUCT.md).
-
-## Code of Conduct
-
-Everyone interacting in the RuZip project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ruzip/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitLab at https://gitlab.com/KitaitiMakoto/ruzip. This project is intended to be a safe, welcoming space for collaboration.

data/Rakefile

@@ -3,19 +3,18 @@ require "rake/testtask"
 require "rubygems/ext"
 require "rubygems/tasks"
 require "kar/dsl"
+require "rdoc/task"
 
 cargo "ruzip"
 
 Gem::Tasks.new
 task build: "cargo:check"
 
-Rake::TestTask.new
-
-directory "test/fixtures"
 TEST_FIXTURE = "test/fixtures/accessible_epub_3.epub"
-file TEST_FIXTURE => "test/fixtures"
 download TEST_FIXTURE => "https://github.com/IDPF/epub3-samples/releases/download/20230704/accessible_epub_3.epub"
 
-task test: [:cargo, TEST_FIXTURE]
+Rake::TestTask.new test: [:cargo, TEST_FIXTURE]
+
+RDoc::Task.new
 
 task default: :test