zipbundler 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0368dd29edd6b16d0591927891ba34bc871cf884'
-  data.tar.gz: 6983437e6e3cc87fd1a713fb7460835d5d39365c
+  metadata.gz: 07ff986041a1dc0f5fed2f0c59858004d6db4d8b
+  data.tar.gz: fe5ad44cf0310e7ae46556b9e8dc14af4775f6c2
 SHA512:
-  metadata.gz: d8fec8fafec3cb56c2757257a2e6c3733f590b102260707bb37ca6ebf108d91d4fc4ff8cfd929d8fa2fe95846b6fa7f2499aa44e6f5f6804cd3fef4f2bb62684
-  data.tar.gz: 62dba7fbb13fc87dd1c7118714025f126fac9dfc436b946949898f412e02f4c7cb2c6857812e626dcbf4a0420171a96630d3d856de5f68aefdb195b312ed301b
+  metadata.gz: 75619a877e38642bfa40f17b01d93a1220e164e56bd76316548c052602fceb154d4ee2923d03606ffaa39574ecd87e0f75c69b32798b92e1e72093d5b27af40c
+  data.tar.gz: a2c261fd7d7813446598853ac83fe9ee1b9c958f1284aa445026fd2ab096ffb30f718390135000ff27cb411e5366979f6e1754feef41f285b56803d72a275544

data/.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug Local",
+            "type": "Ruby",
+            "request": "launch",
+            "program": "${workspaceRoot}/bin/console"
+        }
+    ]
+}

data/README.md

@@ -20,11 +20,11 @@ Or install it yourself as:
 
 ## Usage
 
-First you need to create an instance of `ZipFileGenerator`:
+It is possible to run utility form console:
 
-    ZipFileGenerator.new(json_config)
+    zipbundler zip config.json
 
-`json_config` is a hash variable which can be simply created from a json file. It should has the following structure:
+Configuration file `config.json` should has the following structure:
 
     {
         "name": "out.zip",
@@ -51,6 +51,14 @@ First you need to create an instance of `ZipFileGenerator`:
         ]
     }
 
+Please refer [this link](https://github.com/Le0Michine/zipper/config_schema.json) to find full json schema of the configuration.
+
+Or you can do it from code `ZipFileGenerator`:
+
+    ZipFileGenerator.new(json_config).write
+
+`json_config` is a hash variable which should have the same structure as json config file above.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -59,7 +67,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/zipper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Le0Michine/zipper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/exe/zipbundler

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "zipper"
+
+Zipper::CLI.start( ARGV )

data/lib/zipper/cli.rb

@@ -0,0 +1,18 @@
+require "zipper"
+require "thor"
+require "json"
+require "zipper"
+
+module Zipper
+    class CLI < Thor
+        desc "zip CONFIG [options]", "creates a zip package according to given configuration file"
+        def zip( config )
+            puts "Build with config #{config}"
+            file = File.read(config)
+            json_config = JSON.parse(file)
+
+            generator = Zipper::ZipFileGenerator.new(json_config)
+            generator.write
+        end
+    end
+end

data/lib/zipper/fileEntry.rb

@@ -1,29 +1,24 @@
 module Zipper
     class FileEntry
-        def initialize(file_name, entry_type = FileEntryType::FILE, flatten_structure = false)
-            @type = entry_type
+        def initialize(file_name, flatten_structure = false, file_path = nil)
             @name = file_name
+            @path = file_path
             @flatten = flatten_structure
         end
 
-        def add_buffer(buffer)
-            @buffer = buffer
-        end
-
-        def type
-            @type
-        end
-
+        # Entry name, used as a real path in file system
         def name
             @name
         end
 
+        # True if existing directory structure shouldn't be preserved'
         def flatten
             @flatten
         end
 
-        def buffer
-            @buffer
+        # Path of entry in a zip archive
+        def path
+            @path
         end
     end
 end

data/lib/zipper/version.rb

@@ -1,3 +1,3 @@
 module Zipper
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/zipper.rb

@@ -3,6 +3,7 @@ require "zipper/fileEntryType"
 require "zipper/fileEntry"
 require "zipper/zipEntry"
 require "zipper/JsonConfigKey"
+require "zipper/cli"
 require "zip"
 
 module Zipper
@@ -45,7 +46,7 @@ module Zipper
             if File.directory? directory_or_file
                 get_dir_entries_recursively(directory_or_file, entry_path, ignore_entries)
             else
-                FileEntry.new(directory_or_file, FileEntryType::FILE, false, entry_path)
+                FileEntry.new(directory_or_file, false, entry_path)
             end
         end
 
@@ -61,7 +62,7 @@ module Zipper
                     get_dir_entries_recursively(path, entry_path, ignore_entries, replace_path)
                 else
                     entry_path_in_zip = (entry_path.nil? ? path : path.sub(replace_path, entry_path)).gsub(/^[\/\\]+/, "")
-                    FileEntry.new(path, FileEntryType::FILE, false, entry_path_in_zip)
+                    FileEntry.new(path, false, entry_path_in_zip)
                 end
             }
         end
@@ -71,10 +72,10 @@ module Zipper
         # +entries+:: array of +FileEntry+ and +ZipEntry+ objects
         def compress(entries)
             puts "\nadding the following entries into zip package"
-            puts "#{ entries.map{ |x| x.name + ", " + x.path.to_s + ", " + x.type.to_s }.join("\n")}"
+            puts "#{ entries.map{ |x| x.name }.join("\n")}"
             buffer = Zip::File.add_buffer do |zio|
                 entries.each do |file|
-                    if file.is_a FileEntry
+                    if file.is_a? FileEntry
                         zio.add(file.path == nil ? file.name : file.path, file.name)
                     else
                         zio.get_output_stream(file.name) { |os| os.write file.buffer.string }
@@ -96,7 +97,7 @@ module Zipper
                 elsif x[JsonConfigKey::Type].casecmp(FileEntryType::ZIP) == 0
                     ZipEntry.new(x[JsonConfigKey::Name], create_zip(x[JsonConfigKey::Entries], x[JsonConfigKey::IgnoreEntries]))
                 end
-            }.flatten.select{ |f| filter_entries(f.name, f.type, ignore_entries) }.uniq{ |f| f.name })
+            }.flatten.select{ |f| f.is_a?(ZipEntry) || filter_entries(f.name, FileEntryType::FILE, ignore_entries) }.uniq{ |f| f.name })
         end
     end
 end

data/zipper.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rubyzip"
+  spec.add_dependency "thor"
+  spec.add_dependency "json"
 
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipbundler
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Le0Michine
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -55,11 +83,13 @@ dependencies:
 description: Creates zip packages with complex structure.
 email:
 - leomichine@gmail.com
-executables: []
+executables:
+- zipbundler
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".vscode/launch.json"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -68,7 +98,9 @@ files:
 - bin/console
 - bin/setup
 - config_schema.json
+- exe/zipbundler
 - lib/zipper.rb
+- lib/zipper/cli.rb
 - lib/zipper/fileEntry.rb
 - lib/zipper/fileEntryType.rb
 - lib/zipper/jsonConfigKey.rb