zip_tricks 4.4.0 → 4.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b0120891ce2e0dd56729a82b77e629ccef17370
-  data.tar.gz: 1b991e7fed1e10bc6ea477d43bc833913b0092ae
+  metadata.gz: b4fb7180cf39e2f4acbae7edc62614e0d391f5ab
+  data.tar.gz: 88bcc21c47233036a05f5a8cd1d4a99f8eecc1fc
 SHA512:
-  metadata.gz: 76588911904aaa0384621f418215dfe9dc0b7025cccd27ba49ce0260809aed3623240d6859b62f86a4c1a9994ac38a60ca354e770fe87af5a52a5c05970661c9
-  data.tar.gz: b7ffc3a65e09750a8a1458f73329690df3401550b5e31cb1d573c20a807f0f46ba60f21de817281b22201f954e9dc4df5012abbf148cf08db7aa2b213ac1a427
+  metadata.gz: d6fd5a5d297bc276c3f0853561490611bd42dc014d764eb6f9d9e297592703aaf9b5116409589d380f35d25d8f83cfee7217098f808fd07f3b134123c53b9b70
+  data.tar.gz: 29e47a62795eaffd99c2c8e8b17bbedb51cc7f3f470802b6f73412ecbe1751585387c5bdd82e7115600ad06821e5d75bead2d96f9870526a481f228f87c572ad

data/Rakefile

@@ -3,7 +3,9 @@ require "rspec/core/rake_task"
 require 'yard'
 
 YARD::Rake::YardocTask.new(:doc) do |t|
-  t.files = ['lib/**/*.rb', 'README.md', 'LICENSE.txt', 'IMPLEMENTATION_DETAILS.md']
+  # The dash has to be between the two to "divide" the source files and 
+  # miscellaneous documentation files that contain no code
+  t.files = ['lib/**/*.rb', '-', 'LICENSE.txt', 'IMPLEMENTATION_DETAILS.md']
 end
 
 RSpec::Core::RakeTask.new(:spec)

data/lib/zip_tricks/rails_streaming.rb

@@ -1,4 +1,10 @@
+# Should be included into a Rails controller (together with `ActionController::Live`)
+# for easy ZIP output from any action.
 module ZipTricks::RailsStreaming
+  # Opens a {ZipTricks::Streamer} and yields it to the caller. The output of the streamer
+  # gets automatically forwarded to the Rails response stream. When the output completes,
+  # the Rails response stream is going to be closed automatically.
+  # @yield [Streamer] the streamer that can be written to
   def zip_tricks_stream
     response.headers['Content-Type'] = 'application/zip'
     # Create a wrapper for the write call that quacks like something you

data/lib/zip_tricks/version.rb

@@ -1,3 +1,3 @@
 module ZipTricks
-  VERSION = '4.4.0'
+  VERSION = '4.4.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zip_tricks
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.4.1
 platform: ruby
 authors:
 - Julik Tarkhanov