zip_dir 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1dc7143713cd26a4cbaf2ca5995e9bc7cf032cea
-  data.tar.gz: 15faeef4d8857ed27ef8096053be6b780cdce1cb
+  metadata.gz: 79209ebb4653e9d8ffa94f40c0a0a8ecd7c94d25
+  data.tar.gz: 15c942c938fe5a8bd953242e0beedb278bb187b9
 SHA512:
-  metadata.gz: e466840b0cbdcb230a3ba12cb37c43f6e1677e83b13358d95e940e36e39326ecbcbbbafcf2683cb78921fb4a7b38f9053569164b3baa722303f7bb7a6ef93b6a
-  data.tar.gz: a8780a73ce554571ed041ead65a875922de9fbd0326b0bafcc224d902e0ab39b091c15f5820054ba9b0b3e449dc48f58314a87e90ff1232744045179d9d397bb
+  metadata.gz: aeccedb4f408d14756c527a519c676ba435ceb6e36644c5bd02df97b8f4d3f67531790e4bf1abf0da3e0a8bbcce2b8f280f1561140b6c7a8f0676cd5d46a6bf6
+  data.tar.gz: 54d959f438c11135d560c058cc8bec7d48b04f429ffe77077ec90b6091d01a92f420cbc48bea1d3a58d655a817c7800a105963a463cbd85ef3bc10f7368b30ac

data/README.md

@@ -38,15 +38,44 @@ end
 
 # to zip __just the paths inside the directory___
 zip_file = zipper.generate("some/path/to/directory", root_directory: true)
-
+# for multiple directories again
 zip_file = zipper.generate do |z|
   z.add_path "some/path/to/directory", root_directory: true
 end
 
+# cleanup temporary directory
+zipper.cleanup
+
 #
 # Unzip
 #
-unzip_path = ZipDir::Unzipper.new(zip_file.path).unzip_path # => "/var/folders/6c/s4snqy051jqdpbjw7f7tsn940000gn/T/d20151127-22683-a9vrnv"
+ZipDir::Unzipper.new(zip_file.path).unzip_path # => "/var/folders/6c/s4snqy051jqdpbjw7f7tsn940000gn/T/d20151127-22683-a9vrnv"
+```
+
+## Dir Interface
+`ZipDir::Zipper` subclasses `ZipDir::Dir`, which copies paths into a temporary directory to zip. There are several options for copying files and directories:
+
+```ruby
+ZipDir::Zipper.superclass # => ZipDir::Dir
+
+dir = ZipDir::Dir.new
+dir.generate("some/path" options_described_below)
+dir.generate do |d|
+  d.add_path "some/path", options_described_below
+end
+
+dir.cleanup
+```
+
+```ruby
+# Directories
+{ root_directory: true } # copies each file and directory path within the given directory path
+{ flatten_directories: true } # copies all file paths with no directory structure copied (may override files)
+{ extension: :gif || ["gif", "txt"] || "*" } # filters file extensions of paths, used with options listed above (:extensions is an alias)
+{ glob: "custom_glob" } # copies the paths resulting from the custom glob
+
+# Files and Directories
+{ rename: "new_name_with_smart_extension_handling" }
 ```
 
 ## dir_model

data/lib/zip_dir/dir.rb

@@ -0,0 +1,83 @@
+module ZipDir
+  class Dir
+    attr_reader :copy_path
+
+    def generated?
+      !!@generated
+    end
+
+    def generate(source_path=nil, options={})
+      cleanup if generated?
+
+      @copy_path = ::Dir.mktmpdir
+      proxy = Proxy.new(copy_path)
+      if source_path
+        raise "Should not give block and source_path: #{source_path}" if block_given?
+        proxy.add_path source_path, options
+      else
+        yield proxy
+      end
+
+      ::Dir.new(copy_path)
+    ensure
+      @generated = true
+    end
+
+    def cleanup
+      FileUtils.remove_entry_secure copy_path if copy_path
+      @copy_path = nil
+      @generated = false
+    end
+
+    class Proxy
+      def initialize(copy_path)
+        @copy_path = copy_path
+      end
+
+      def add_path(source_path, options={})
+        options = options.inject({}){|hash,(k,v)| hash[k.to_sym] = v; hash}
+
+        if File.directory?(source_path)
+          add_directory source_path, options
+        elsif File.file?(source_path)
+          add_simple_path source_path, options
+        else
+          raise "Attempting to add non-existent path: #{source_path}"
+        end
+      end
+      alias_method :<<, :add_path
+
+      protected
+      def add_directory(source_path, options={})
+        options[:extension] = options[:extensions] unless options[:extension]
+        glob = nil
+
+        if options[:glob]
+          glob = options[:glob]
+        elsif options[:flatten_directories]
+          glob = "#{source_path}/**/*"
+          options[:extension] = '*' unless options[:extension]
+        elsif options[:root_directory]
+          glob = "#{source_path}/*"
+        end
+
+        return add_simple_path source_path, options unless glob
+
+        glob += ".{#{Array[options[:extension]].join(",")}}" if options[:extension]
+        ::Dir.glob(glob).each { |path| add_simple_path(path) }
+      end
+
+      def add_simple_path(source_path, options={})
+        copy_path_parts = [@copy_path]
+
+        if options[:rename]
+          rename = options[:rename]
+          rename += File.extname(source_path) if File.extname(rename).empty?
+          copy_path_parts << rename
+        end
+
+        FileUtils.cp_r source_path, copy_path_parts.join("/")
+      end
+    end
+  end
+end

data/lib/zip_dir/unzipper.rb

@@ -2,7 +2,7 @@ module ZipDir
   class Unzipper
     attr_reader :zip_path
     def initialize(zip_path)
-      @zip_path, @unzip_path = zip_path, Dir.mktmpdir
+      @zip_path, @unzip_path = zip_path, ::Dir.mktmpdir
     end
 
     def cleanup
@@ -24,9 +24,7 @@ module ZipDir
         zip_file.each do |entry|
           file_path = "#{@unzip_path}/#{entry.name}"
 
-          # Fixes:
-          # Errno::ENOENT:
-          # No such file or directory @ rb_sysopen - /var/folders/6c/s4snqy051jqdpbjw7f7tsn940000gn/T/d20160209-56123-1o14n5n/Niveaux/Fondations.png
+          # Fixes: spec/fixtures/encoded_differently.zip (in a test)
           dir_path = File.dirname(file_path).to_s
           FileUtils.mkdir_p dir_path unless File.exists?(dir_path)
 

data/lib/zip_dir/version.rb

@@ -1,3 +1,3 @@
 module ZipDir
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

data/lib/zip_dir/zip.rb

@@ -24,7 +24,7 @@ module ZipDir
 
     protected
     def zip_path(zip_io, relative_path="")
-      entries = Dir.entries(relative_path.empty? ? source_path : File.join(source_path, relative_path))
+      entries = ::Dir.entries(relative_path.empty? ? source_path : File.join(source_path, relative_path))
       entries.delete(".")
       entries.delete("..")
       entries.each do |entry|

data/lib/zip_dir/zipper.rb

@@ -1,8 +1,9 @@
+require "zip_dir/dir"
 require "zip_dir/zip"
 
 module ZipDir
-  class Zipper
-    attr_reader :copy_path, :filename
+  class Zipper < Dir
+    attr_reader :filename
 
     DEFAULT_FILENAME = "zipper.zip".freeze
 
@@ -10,51 +11,19 @@ module ZipDir
       @filename = filename
     end
 
-    def generated?
-      !!@generated
-    end
-
     def generate(source_path=nil, root_directory: false)
-      cleanup if generated?
-
-      @copy_path = Dir.mktmpdir
-      proxy = Proxy.new(copy_path)
-      if source_path
-        raise "should not give block and source_path" if block_given?
-        proxy.add_path source_path, root_directory: root_directory
-      else
-        yield proxy
-      end
-
+      super
       @file = ZipDir::Zip.new(copy_path, filename).file
-    ensure
-      @generated = true
-    end
-
-    def file
-      return unless generated?
-      @file
     end
 
     def cleanup
-      FileUtils.remove_entry_secure copy_path if copy_path
-      @file = @copy_path = nil
-      @generated = false
+      super
+      @file = nil
     end
 
-    class Proxy
-      def initialize(copy_path)
-        @copy_path = copy_path
-      end
-
-      def add_path(source_path, root_directory: false)
-        if root_directory
-          Dir.glob("#{source_path}/*").each { |path| add_path(path) }
-        else
-          FileUtils.cp_r source_path, @copy_path
-        end
-      end
-      alias_method :<<, :add_path
+    def file
+      return unless generated?
+      @file
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zip_dir
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Steve Chung
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-09 00:00:00.000000000 Z
+date: 2016-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -41,6 +41,7 @@ files:
 - bin/console
 - bin/setup
 - lib/zip_dir.rb
+- lib/zip_dir/dir.rb
 - lib/zip_dir/unzipper.rb
 - lib/zip_dir/version.rb
 - lib/zip_dir/zip.rb