master_splitter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d7a1e7298a56c92fc9eb2c6fc64fa91527cfae8
+  data.tar.gz: be9c96e1c33f54f1f9c8211ab215fddc3bc53ff1
+SHA512:
+  metadata.gz: 0626cef0959779687722e3ab970b5f8b3e5e0131454dd2225fa61023c01815f56a2c6e1b432b7561cce17ab14e857d21bd918af88c3e01732d4c77d2104b9e05
+  data.tar.gz: 2c7374a0dc4beef073b05c4463c39139477da9008d9833cb91c4551cb10352f7e03c0ac4e04a15f745c461672883d91c989beebacae35dd0e4d1704be2faa8da

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pouya Gharib Pour
+
+MIT License
+
+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,47 @@
+# MasterSplitter
+
+A simple file splitter and joiner.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'master_splitter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install master_splitter
+
+## Usage
+
+You can use executables 'master_join' and 'master_split'. 
+For more imformation just use them with a -h flag.
+You can also include it as a library and use if methods 
+directly, like this:
+
+```ruby
+include MasterSplitter
+
+standard_split("path/to/file.pdf", 5)
+# splits the file to 5 slices.
+
+standard_join("path/to/slice.pdf.001")
+```
+
+
+## Contributing
+
+The best way you can contribute now is to teach me a way
+to write specs for file interactions. Or you can help as the following:
+
+1. Fork it ( https://github.com/psparabara/master_splitter/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/master_join

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'master_splitter'
+include MasterSplitter
+
+help = %q{here are the valid flags and switches:
+  -f, --first-slice-file      Name of the first slice that you want to join. Can't be nil.
+  -o, --output-dir            The directory you want the final file to be.
+  -n, --name-final-file       The name you wish for the output file.
+  -h, --help                  You see this help.
+}
+options = {}
+options[:join_options] = {}
+option_parser = OptionParser.new do |opts|
+  opts.on("-f FIRST", "--first-slice-file FIRST") do |first|
+    options[:first_slice_name] = first
+  end
+
+  opts.on("-o DIRECTORY", "--output-dir DIRECTORY") do |output_dir|
+    options[:join_options][:output_dir] = output_dir
+  end
+
+  opts.on("-n NAME", "--name-final-file NAME") do |name|
+    options[:join_options][:output_file_name] = name
+  end
+
+  opts.on("-h", "--help") do
+    options[:needs_help?] = true
+  end
+end
+
+option_parser.parse!
+if options[:needs_help?]
+  puts help
+else
+  standard_joiner(options[:first_slice_name], options[:join_options])
+end

data/bin/master_split

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'master_splitter'
+include MasterSplitter
+
+help = %q{here are the valid flags and switches:
+  -s, --source-file           Name of file you want to split. Can't be nil.
+  -n, --number-of-slices      Number of the slices you wish the file to be splitted to. Can't be nil. 
+  -o, --output-dir            The directory you want the slices to be.
+  -h, --help                  You see this help.
+}
+options = {}
+options[:split_options] = {}
+option_parser = OptionParser.new do |opts|
+  opts.on("-s SOURCE", "--source-file SOURCE") do |source|
+    options[:source_file] = source
+  end
+
+  opts.on("-n NUMBER", "--number-of-slices NUMBER") do |number|
+    options[:number_of_slices] = number
+  end
+
+  opts.on("-o DIRECTORY", "--output-dir DIRECTORY") do |output_dir|
+    options[:split_options][:output_dir] = output_dir
+  end
+
+  opts.on("-h", "--help") do
+    options[:needs_help?] = true
+  end
+end
+
+option_parser.parse!
+if options[:needs_help?]
+  puts help
+else
+  standard_splitter(options[:source_file], options[:number_of_slices].to_i, options[:split_options])
+end

data/lib/master_splitter.rb

@@ -0,0 +1,13 @@
+require "master_splitter/version"
+require "master_splitter/constants"
+require "master_splitter/joiner"
+require "master_splitter/splitter"
+
+module MasterSplitter
+  ##
+  # This gem can take file and splite it in to many slices,
+  # or join the slices of a splited file.
+  #
+  # Authour:: Pouya Gharib Pour
+  # License:: p.gharibpour@gmail.com
+end

data/lib/master_splitter/constants.rb

@@ -0,0 +1,5 @@
+module MasterSplitter
+  MAX_CHUNK_SIZE = 1024 * 1024
+  STANDARD_SLICE_NAMING_FORMAT = /^(.*)\.(\d{3,})$/i
+  FILE_NAME_FINDER = /^.*\/(.*)$/i
+end

data/lib/master_splitter/joiner.rb

@@ -0,0 +1,105 @@
+module MasterSplitter
+  def custom_joiner(slice_names, options={})
+    ##
+    # With this method you can join a couple of file
+    # which their names does not follow the standard format.
+    # You can pass it a name for the output file and a directory
+    # to store it.
+    # Example: 
+    #   >> custom_joiner(["first.pdf", "second.pdf"], 
+    #                     output_file_name: "book.pdf", output_dir: "Desktop/")
+    # Arguments:
+    #     slice_names: (Array)
+    #     options:     (Hash) 
+    # 
+    output_dir = options[:output_dir]
+    output_file_name = options[:output_file_name]
+    slice_names.each do |slice_name|
+      unless File.exists? slice_name
+        raise Exception, "file '#{slice_name}' does not exist."
+      end
+    end
+
+    output_file_name ||= slice_names[0]
+    if output_dir
+        output_file_name = File.join(output_dir, output_file_name)
+    end
+    join(output_file_name, slice_names)
+  end
+
+  def standard_joiner(first_slice_name, options={})
+    ##
+    # This method joins slices of a splitted file which
+    # their names follow the standard format.
+    # You just have to pass it the name of the first slice.
+    # Remember that all slices must be in the same directory.
+    # Example: 
+    #   >> standard_joiner("path/to/first_slice.pdf.001", 
+    #                     output_file_name: "book.pdf", output_dir: "Desktop/")
+    # Arguments:
+    #     first_slice_name: (String)
+    #     options:          (Hash) 
+    # 
+    output_dir = options[:output_dir]
+    output_file_name = options[:output_file_name]
+    slice_names = []
+    match_result = STANDARD_SLICE_NAMING_FORMAT.
+      match(first_slice_name)
+
+    if match_result
+      if match_result[1].include?("/") && output_dir
+        output_file_name ||= FILE_NAME_FINDER.match(match_result[1])[1]
+      else
+        output_file_name ||= match_result[1]
+      end
+      slice_number = match_result[2].to_i
+      while true
+        temp = ("%3d"%[slice_number]).gsub(" ", "0")
+        slice_name = [match_result[1], temp].join('.')
+        if File.exists?(slice_name)
+          slice_names << slice_name
+          slice_number += 1
+        else
+          break
+        end
+      end #end of while
+
+      if output_dir
+        output_file_name = File.join(output_dir, output_file_name)
+      end
+      join(output_file_name, slice_names)
+    else
+      raise Exception, %q{Wrong naming format for the first slice!}
+    end
+  end #end of standard_joiner
+
+  def join(output_file_name, slice_names)
+    ##
+    # This method does the actual joining of slices.
+    # It gets an Array of slice names and name of the 
+    # output file.
+    #
+    # Example: 
+    #   >> join("book.pdf", ["book.pdf.001", "book.pdf.002"])
+    # Arguments:
+    #     output_file_name: (String)
+    #     slice_names:      (Array) 
+    # 
+    output_file = File.open(output_file_name, 'wb')
+
+    slice_names.each do |slice_name|
+      slice = File.open(slice_name, 'rb')
+      bytes_to_read = slice.size
+
+      while bytes_to_read > 0
+        chunk = MAX_CHUNK_SIZE
+        chunk = bytes_to_read if (bytes_to_read < MAX_CHUNK_SIZE)
+        output_file.write(slice.read(chunk))
+        bytes_to_read -= chunk
+      end #end of while
+      slice.close
+    end #end of each
+
+    output_file.close
+  end #end of join
+end #end of module

data/lib/master_splitter/splitter.rb

@@ -0,0 +1,111 @@
+module MasterSplitter
+  def custom_splitter(source_file_name, slice_sizes, options={})
+    ##
+    # With this method you can split a file to slices which
+    # you can specify size of each slice.
+    # Sum of all slice sizes must be equal to the size of the
+    # orginal fille.
+    # Needless to say, sizes must be in bytes.
+    # Example: 
+    #   >> custom_splitter("file.pdf", 
+    #                      [1232, 5432], output_dir: "Desktop/")
+    # Arguments:
+    #     source_file_name: (String)
+    #     slice_sizes:      (Array)
+    #     options:          (Hash) 
+    # 
+    slice_names = []
+    output_dir = options[:output_dir]
+    sum_of_sizes = slice_sizes.each(&:+)
+    source = File.open(source_file_name, 'rb')
+    if sum_of_sizes != source.size
+      source.close
+      raise Exception, "sum of slice sizes does not equal size of source file."
+    end
+    source.close
+    slice_sizes.count.times do |i|
+      temp = ("%3d"%[i + 1]).gsub(" ", "0")
+
+      if output_dir
+        slice_name = source_file_name
+        if source_file_name.include?("/")
+          slice_name = FILE_NAME_FINDER.match(source_file_name)[1]
+        end
+        slice_names << File.join(output_dir, [slice_name, temp].join('.'))
+      else
+        slice_names << [source_file_name, temp].join('.')
+      end
+    end #end of iteration
+    split(source_file_name, slice_names, slice_sizes)
+  end #end of custom_splitter
+
+  def standard_splitter(source_file_name, number_of_slices, options={})
+    ##
+    # This method splits a given file to a specified 
+    # number of slices, equally.
+    # Example: 
+    #   >> standard_splitter("file.pdf", 
+    #                         number_of_slices: 5, 
+    #                         output_dir: "Desktop/")
+    # Arguments:
+    #     source_file_name: (String)
+    #     number_of_slices: (Fixnum)
+    #     options:          (Hash) 
+    #
+    slice_sizes = []
+    slice_names = []
+    output_dir = options[:output_dir]
+    source = File.open(source_file_name, 'rb')
+    source_size = source.size
+    slice_size = source_size / number_of_slices
+    slice_name = source_file_name
+    if source_file_name.include?('/')
+      slice_name = FILE_NAME_FINDER.match(source_file_name)[1]
+    end
+
+    number_of_slices.times do |n|
+      slice_sizes << slice_size
+      temp = ("%3d"%[n + 1]).gsub(" ", "0")
+      if output_dir
+        slice_names << File.join(output_dir, [slice_name, temp].join('.'))
+      else
+        slice_names << [source_file_name, temp].join('.')
+      end
+    end
+    remain_bytes = source_size - (slice_size * number_of_slices)
+    slice_sizes[-1] +=  remain_bytes
+
+    source.close
+    split(source_file_name, slice_names, slice_sizes)
+  end #end of standard_splitter
+
+  def split(source_file_name, slice_names, slice_sizes)
+    ##
+    # This method does the actual splitting of file.
+    # It gets the name of the source file and two arrays.
+    # One contains names of the slices and the other their sizes.
+    # Example: 
+    #   >> split("book.pdf", ["book.pdf.001", "book.pdf.002"], [6456, 6456])
+    # Arguments:
+    #     source_file_name: (String)
+    #     slice_names:      (Array) 
+    #     slice_sizes:      (Array)
+    # 
+    source = File.open(source_file_name, 'rb')
+
+    slice_names.size.times do |i|
+      slice = File.open(slice_names[i], 'wb')
+      bytes_to_write = slice_sizes[i]
+
+      while bytes_to_write > 0
+        chunk = MAX_CHUNK_SIZE
+        chunk = bytes_to_write if(bytes_to_write < MAX_CHUNK_SIZE)
+        slice.write(source.read(chunk))
+        bytes_to_write -= chunk
+      end #end of while
+      slice.close
+    end #end of iteration
+
+    source.close
+  end #end of split
+end #end of module

data/lib/master_splitter/version.rb

@@ -0,0 +1,3 @@
+module MasterSplitter
+  VERSION = "1.0.0"
+end

data/master_splitter.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'master_splitter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "master_splitter"
+  spec.version       = MasterSplitter::VERSION
+  spec.authors       = ["Pouya Gharib Pour"]
+  spec.email         = ["p.gharibpour@gmail.com"]
+  spec.summary       = %q{File spliter and joiner.}
+  spec.description   = %q{Simple file spliter and joiner. But not compressor.}
+  spec.homepage      = "https://www.github.com/psparabara/master_splitter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: master_splitter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pouya Gharib Pour
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: Simple file spliter and joiner. But not compressor.
+email:
+- p.gharibpour@gmail.com
+executables:
+- master_join
+- master_split
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/master_join
+- bin/master_split
+- lib/master_splitter.rb
+- lib/master_splitter/constants.rb
+- lib/master_splitter/joiner.rb
+- lib/master_splitter/splitter.rb
+- lib/master_splitter/version.rb
+- master_splitter.gemspec
+homepage: https://www.github.com/psparabara/master_splitter
+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.4.4
+signing_key: 
+specification_version: 4
+summary: File spliter and joiner.
+test_files: []