master_splitter 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d7a1e7298a56c92fc9eb2c6fc64fa91527cfae8
-  data.tar.gz: be9c96e1c33f54f1f9c8211ab215fddc3bc53ff1
+  metadata.gz: 7ff938e1683589dfa9e407dc4ebd8c5b44426fa2
+  data.tar.gz: 97a5f462c949934eb44a52a7321dda784fe067ad
 SHA512:
-  metadata.gz: 0626cef0959779687722e3ab970b5f8b3e5e0131454dd2225fa61023c01815f56a2c6e1b432b7561cce17ab14e857d21bd918af88c3e01732d4c77d2104b9e05
-  data.tar.gz: 2c7374a0dc4beef073b05c4463c39139477da9008d9833cb91c4551cb10352f7e03c0ac4e04a15f745c461672883d91c989beebacae35dd0e4d1704be2faa8da
+  metadata.gz: 1e28e3e325b49e5238468b5d9aa7833526d4904eb65af709162fb0b011725ace9acee4f5361a4a4bb3ddf7c70e3682c7cb6e5d1573bde365703e2069713c8e17
+  data.tar.gz: d0e0d2da2df75355881667a5adc043958d0414a7b048a705937e40b504aa0af06af2f44a1b63cddaa87e334a6cfd184e246dc9b52c3ce8e3650ba2cdf856fe6e

data/README.md

@@ -22,7 +22,7 @@ Or install it yourself as:
 
 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 
+You can also include it as a library and use it's methods 
 directly, like this:
 
 ```ruby

data/lib/master_splitter.rb

@@ -1,13 +1,17 @@
+##
+# 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
 require "master_splitter/version"
 require "master_splitter/constants"
 require "master_splitter/joiner"
 require "master_splitter/splitter"
 
+##
+# This module holds everything.
+# It includes 6 methods and 4 constants.
 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

@@ -1,5 +1,8 @@
 module MasterSplitter
+  # Max size of each read/write from/to files.
   MAX_CHUNK_SIZE = 1024 * 1024
+  # Naming format of a sliced file.
   STANDARD_SLICE_NAMING_FORMAT = /^(.*)\.(\d{3,})$/i
+  # For capturing only name of a file.
   FILE_NAME_FINDER = /^.*\/(.*)$/i
 end

data/lib/master_splitter/joiner.rb

@@ -1,17 +1,17 @@
 module MasterSplitter
+  ##
+  # 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) 
+  # 
   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|
@@ -27,19 +27,19 @@ module MasterSplitter
     join(output_file_name, slice_names)
   end
 
+  ##
+  # 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) 
+  # 
   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 = []
@@ -73,18 +73,18 @@ module MasterSplitter
     end
   end #end of standard_joiner
 
+  ##
+  # 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) 
+  # 
   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|

data/lib/master_splitter/splitter.rb

@@ -1,19 +1,20 @@
 module MasterSplitter
+  
+  ##
+  # 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) 
+  # 
   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(&:+)
@@ -39,19 +40,19 @@ module MasterSplitter
     split(source_file_name, slice_names, slice_sizes)
   end #end of custom_splitter
 
+  ##
+  # 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) 
+  #
   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]
@@ -79,18 +80,18 @@ module MasterSplitter
     split(source_file_name, slice_names, slice_sizes)
   end #end of standard_splitter
 
+  ##
+  # 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)
+  # 
   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|

data/lib/master_splitter/version.rb

@@ -1,3 +1,4 @@
 module MasterSplitter
-  VERSION = "1.0.0"
+  # For holding the gems version.
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: master_splitter
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Pouya Gharib Pour
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-17 00:00:00.000000000 Z
+date: 2015-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: File spliter and joiner.