zipbundler 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '0368dd29edd6b16d0591927891ba34bc871cf884'
+  data.tar.gz: 6983437e6e3cc87fd1a713fb7460835d5d39365c
+SHA512:
+  metadata.gz: d8fec8fafec3cb56c2757257a2e6c3733f590b102260707bb37ca6ebf108d91d4fc4ff8cfd929d8fa2fe95846b6fa7f2499aa44e6f5f6804cd3fef4f2bb62684
+  data.tar.gz: 62dba7fbb13fc87dd1c7118714025f126fac9dfc436b946949898f412e02f4c7cb2c6857812e626dcbf4a0420171a96630d3d856de5f68aefdb195b312ed301b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at leomichine@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zipper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Le0Michine
+
+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,68 @@
+# Zipper
+
+Utility intended to simplify zip packages creating.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zipper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zipper
+
+## Usage
+
+First you need to create an instance of `ZipFileGenerator`:
+
+    ZipFileGenerator.new(json_config)
+
+`json_config` is a hash variable which can be simply created from a json file. It should has the following structure:
+
+    {
+        "name": "out.zip",
+        "entries": [
+            "path_to_file",
+            "path_to_directory",            // real path in file system to file or directory
+            {
+                "type": "file",             // type of entry, if absent will be treated as 'file'
+                "name": "test.json",        // real path in file system to file or directory
+                "path": "new_path_in_zip"   // optional
+            },
+            {
+                "type": "zip",              // nested zip archive
+                "name": "test.zip",         // name of nested zip archive, can include directories. 'path' property is being ignored for this kind of entries
+                "entries": [                // array of entries for nested zip file, same format as above
+                    "file",
+                    "dir"
+                ],
+                "ignoreEntries": [ ... ]    // local array of entries to ignore
+            }
+        ],
+        "ignoreEntries": [
+            ".DS_Store"
+        ]
+    }
+
+## 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.
+
+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 tags, 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]/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
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zipper"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config_schema.json

@@ -0,0 +1,96 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "description": "Schema of configuration",
+    "definitions": {
+        "config": {
+            "type": "object",
+            "description": "root configuration object",
+            "properties": {
+                "name": {
+                    "type": "string",
+                    "description": "name of output file, can include relative path"
+                },
+                "entries": {
+                    "type": "array",
+                    "description": "array of items to be compressed",
+                    "items": {
+                        "$ref": ["#/definitions/file_entry", "#/definitions/zip_entry", "#/definitions/string_entry"]
+                    }
+                }
+            }
+        },
+        "string_entry": {
+            "type": "string",
+            "description": "path to file or directory to include into zip package"
+        },
+        "file_entry": {
+            "type": "object",
+            "description": "item which will be included into zip package",
+            "properties": {
+                "type": {
+                    "type": "string",
+                    "description": "type of entry, should be set to 'file' or omitted",
+                    "default": "file",
+                    "enum": [
+                        "zip",
+                        "file"
+                    ]
+                },
+                "name": {
+                    "type": "string",
+                    "description": "path to file or directory to include into zip package"
+                },
+                "path": {
+                    "type": "string",
+                    "description": "path to file or directory which will be used inside zip package"
+                }
+            },
+            "required": [
+                "name",
+                "path"
+            ]
+        },
+        "zip_entry": {
+            "type": "object",
+            "description": "nested zip package",
+            "properties": {
+                "type": {
+                    "type": "string",
+                    "description": "type of entry, should be set to 'zip'"
+                },
+                "name": {
+                    "type": "string",
+                    "description": "path to file or directory to include into zip package"
+                },
+                "entries": {
+                    "type": "array",
+                    "description": "array of items to be compressed",
+                    "items": {
+                        "$ref": ["#/definitions/file_entry", "#/definitions/zip_entry", "#/definitions/string_entry"]
+                    }
+                },
+                "ignoreEntries": {
+                    "type": "array",
+                    "description": "array of items to be ignored",
+                    "items": {
+                        "type": "string",
+                        "description": "path or part of the path to a file or folder which should be ignored"
+                    }
+                }
+            },
+            "ignoreEntries": {
+                "type": "array",
+                "description": "array of items to be ignored",
+                "items": {
+                    "type": "string",
+                    "description": "path or part of the path to a file or folder which should be ignored"
+                }
+            },
+            "required": [
+                "name",
+                "type",
+                "entries"
+            ]
+        }
+    }
+}

data/lib/zipper/fileEntry.rb

@@ -0,0 +1,29 @@
+module Zipper
+    class FileEntry
+        def initialize(file_name, entry_type = FileEntryType::FILE, flatten_structure = false)
+            @type = entry_type
+            @name = file_name
+            @flatten = flatten_structure
+        end
+
+        def add_buffer(buffer)
+            @buffer = buffer
+        end
+
+        def type
+            @type
+        end
+
+        def name
+            @name
+        end
+
+        def flatten
+            @flatten
+        end
+
+        def buffer
+            @buffer
+        end
+    end
+end

data/lib/zipper/fileEntryType.rb

@@ -0,0 +1,6 @@
+module Zipper
+    module FileEntryType
+        ZIP = "ZIP"
+        FILE = "FILE"
+    end
+end

data/lib/zipper/jsonConfigKey.rb

@@ -0,0 +1,10 @@
+module Zipper
+    module JsonConfigKey
+        Type = "type"
+        Name = "name"
+        Path = "path"
+        Flatten = "flatten"
+        Entries = "entries"
+        IgnoreEntries = "ignoreEntries"
+    end
+end

data/lib/zipper/version.rb

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

data/lib/zipper/zipEntry.rb

@@ -0,0 +1,16 @@
+module Zipper
+    class ZipEntry
+        def initialize(file_name, buffer)
+            @name = file_name
+            @buffer = buffer
+        end
+
+        def name
+            @name
+        end
+
+        def buffer
+            @buffer
+        end
+    end
+end

data/lib/zipper.rb

@@ -0,0 +1,102 @@
+require "zipper/version"
+require "zipper/fileEntryType"
+require "zipper/fileEntry"
+require "zipper/zipEntry"
+require "zipper/JsonConfigKey"
+require "zip"
+
+module Zipper
+    class ZipFileGenerator
+        # Initialize with the json config.
+        def initialize(json_config)
+            @entries = json_config[JsonConfigKey::Entries]
+            @ignore_entries = json_config[JsonConfigKey::IgnoreEntries]
+            @output_file = json_config[JsonConfigKey::Name]
+        end
+
+        # Zip the input entries.
+        def write
+            buffer = create_zip(@entries, @ignore_entries)
+
+            puts "\nwrite file #{@output_file}"
+            File.open(@output_file, "wb") {|f| f.write buffer.string }
+        end
+
+        private
+
+        # True if +fileEntry+ isn't included into +ignore_entries+ array
+        # Params:
+        # +file_entry_name+:: name of the entry
+        # +file_entry_type+:: type of the entry
+        # +ignore_entries+:: array of entries for which should be excluded (false returned)
+        def filter_entries(file_entry_name, file_entry_type, ignore_entries)
+            return true if ignore_entries == nil
+            ignore_entries.each do |entry|
+                return false if (file_entry_type.casecmp(FileEntryType::FILE) == 0) && (file_entry_name.include? entry)
+            end
+            return true
+        end
+
+        # Creates +FileEntry+ for file or array of entries for directory and subdirectories
+        # Params:
+        # +directory_or_file+:: path to directory or file
+        # +entry_path+:: path with which the entry should be put into zip
+        def get_entries(directory_or_file, entry_path, ignore_entries)
+            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)
+            end
+        end
+
+        # Collects all files from directory recursively
+        # Params:
+        # +dir+:: start directory
+        # +entry_path+:: path with which file should be placed into zip
+        # +replace_path+:: part of path which is being replaced by +entry_path+
+        def get_dir_entries_recursively(dir, entry_path, ignore_entries, replace_path = nil)
+            replace_path = dir.clone if replace_path.nil?
+            (Dir.entries(dir) - %w(. ..)).map { |v| File.join(dir, v) }.select { |path| filter_entries path, FileEntryType::FILE, ignore_entries }.map { |path|
+                if File.directory? path
+                    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)
+                end
+            }
+        end
+
+        # Creates zip file in memory from passed +FileEntry+ array, returns StringIO as result
+        # Params:
+        # +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")}"
+            buffer = Zip::File.add_buffer do |zio|
+                entries.each do |file|
+                    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 }
+                    end
+                end
+            end
+        end
+
+        # Creates from json array of entries
+        # Params:
+        # +entries+:: input entries to compress
+        # +ignore_entries+:: entries which should be ignored
+        def create_zip(entries, ignore_entries)
+            compress(entries.map { |x|
+                if x.is_a? String
+                    get_entries(x, nil, ignore_entries)
+                elsif x[JsonConfigKey::Type].nil? || x[JsonConfigKey::Type].casecmp(FileEntryType::FILE) == 0
+                    get_entries(x[JsonConfigKey::Name], x[JsonConfigKey::Path], ignore_entries)
+                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 })
+        end
+    end
+end

data/zipper.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zipper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zipbundler"
+  spec.version       = Zipper::VERSION
+  spec.authors       = ["Le0Michine"]
+  spec.email         = ["leomichine@gmail.com"]
+
+  spec.summary       = %q{Creates zip packages with complex structure.}
+  spec.description   = %q{Creates zip packages with complex structure.}
+  spec.homepage      = "https://github.com/Le0Michine/zipper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rubyzip"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: zipbundler
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Le0Michine
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Creates zip packages with complex structure.
+email:
+- leomichine@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config_schema.json
+- lib/zipper.rb
+- lib/zipper/fileEntry.rb
+- lib/zipper/fileEntryType.rb
+- lib/zipper/jsonConfigKey.rb
+- lib/zipper/version.rb
+- lib/zipper/zipEntry.rb
+- zipper.gemspec
+homepage: https://github.com/Le0Michine/zipper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Creates zip packages with complex structure.
+test_files: []