nauktis_utils 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 567131202960aa60f526851ab99a471f825d41ec
+  data.tar.gz: 955965ab288f72d00717b2c19f19064aa161aac8
+SHA512:
+  metadata.gz: cb75388ea8145c44f36ae874308414591d3c30f1b5d44562c12d15702a053fc0063c383c586f89497148efaa1353ec1f935d43f09ff3c711d505d99843833e52
+  data.tar.gz: 72e74eabb7ac71c16fc48d8b094bc546096f1e685977d1a991903158562d5572cdf1cdedd872c15cd33b8831033599f40da1564e7aeea5d64ecff82272c8763b

data/.gitignore

@@ -0,0 +1,14 @@
+## OSX Stuff
+.DS_Store
+
+*.gem
+
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Nauktis
+
+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,38 @@
+# NauktisUtils
+
+This gem contains a collection of utility classes and executables.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nauktis_utils'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nauktis_utils
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/Nauktis/nauktis_utils.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nauktis_utils"
+
+# 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

data/bin/setup

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

data/exe/datify

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require 'nauktis_utils'
+
+puts "Datify tool."
+raise "First argument must be a file or a directory path." unless ARGV.size == 1
+date_extractor = NauktisUtils::DateExtractor.new
+if File.directory?(ARGV[0])
+	NauktisUtils::FileBrowser.each_file(ARGV[0]) do |entry|
+		begin
+			date_extractor.rename(entry)
+		rescue StandardError => e
+			puts "Error: #{e}"
+		end
+	end
+	puts "Processed #{date_extractor.counters[:total]} files"
+else
+	date_extractor.process(ARGV[0])
+end

data/exe/duplicates

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require 'nauktis_utils'
+
+puts "Duplicates finder tool."
+raise "Provide directory paths to the command line." unless ARGV.size > 0
+
+directories = []
+ARGV.each do |dir|
+  directories << NauktisUtils::FileBrowser.ensure_valid_directory(dir)
+end
+
+handling_strategy = NauktisUtils::Duplicate::HandlingStrategy::Analyse.new
+puts "Finding duplicates in #{directories.join(', ')}"
+
+NauktisUtils::Duplicate.new(handling_strategy).clean(directories)
+puts "Analysis done."
+puts "#{handling_strategy.counters[:pairs].to_s(:delimited)} pairs of duplicates found."
+puts "#{handling_strategy.counters[:duplicates].to_s(:delimited)} files are duplicates and could be deleted."
+puts "#{handling_strategy.counters[:size].to_s(:human_size)} of space could be save."

data/exe/rm_duplicates

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'nauktis_utils'
+
+puts "Duplicates remover tool."
+raise "First argument must be a directory path." unless ARGV.size == 1
+directory = NauktisUtils::FileBrowser.ensure_valid_directory(ARGV[0])
+
+deleting_strategy = NauktisUtils::Duplicate::DeletingStrategy::Simple.new
+handling_strategy = NauktisUtils::Duplicate::HandlingStrategy::KeepOne.new(deleting_strategy)
+puts "Keeping one original for all duplicates in #{directory}"
+
+NauktisUtils::Duplicate.new(handling_strategy).clean([directory])

data/exe/rm_duplicates_in_if_in

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'nauktis_utils'
+
+puts "Duplicates remover tool."
+raise "Two first arguments must be directory paths." unless ARGV.size == 2
+directory_delete = NauktisUtils::FileBrowser.ensure_valid_directory(ARGV[0])
+directory_keep = NauktisUtils::FileBrowser.ensure_valid_directory(ARGV[1])
+
+deleting_strategy = NauktisUtils::Duplicate::DeletingStrategy::Simple.new
+handling_strategy = NauktisUtils::Duplicate::HandlingStrategy::NoDeleteIn.new(deleting_strategy, [directory_keep])
+puts "Deleting duplicates in #{directory_delete} if present in #{directory_keep}"
+
+NauktisUtils::Duplicate.new(handling_strategy).clean([directory_delete, directory_keep])

data/exe/rm_if_in

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+require 'nauktis_utils'
+require 'optparse'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: example.rb [options]"
+
+  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+    options[:verbose] = v
+  end
+
+  opts.on("-a", "--algorithms ALGORITHM", "Adds ALGORITHM to the list of algorithms to use.") do |al|
+    options[:algorithms] ||= []
+    options[:algorithms] << al
+  end
+end.parse!
+
+p options
+p ARGV

data/lib/nauktis_utils.rb

@@ -0,0 +1,24 @@
+require 'date'
+require 'fileutils'
+require 'find'
+require 'logger'
+require 'openssl'
+require 'tmpdir'
+
+require 'active_support'
+require 'active_support/core_ext/numeric'
+require 'json'
+require 'sha3'
+
+require "nauktis_utils/version"
+require "nauktis_utils/logging"
+require "nauktis_utils/file_browser"
+require "nauktis_utils/file_digester"
+require "nauktis_utils/tracer"
+require "nauktis_utils/duplicate"
+require "nauktis_utils/archiver"
+require "nauktis_utils/date_extractor"
+
+module NauktisUtils
+
+end

data/lib/nauktis_utils/archiver.rb

@@ -0,0 +1,153 @@
+module NauktisUtils
+	# Wrapper around TAR
+	class Archiver
+		include Logging
+		attr_reader :options
+
+		def initialize(&block)
+			@options = {
+				paths: [],
+			}
+			if block_given?
+				instance_eval(&block)
+				tar
+			end
+		end
+
+		def tar
+			Tracer.info "Creating archive for #{@options[:paths]}"
+			raise "TAR is not available" unless command_available?('tar')
+			raise "Only one file archiving is supported for now" unless @options[:paths].size == 1
+			source_path = File.expand_path(@options[:paths].first)
+			raise "#{source_path} doesn't exist" unless File.exist?(source_path)
+
+			destination_path = FileBrowser.ensure_valid_directory(@options[:destination])
+			@options[:name] = "#{Time.now.strftime('%Y-%m-%d')}_#{File.basename(source_path)}" if @options[:name].nil?
+			@options[:tar_file] = File.join(destination_path, "#{@options[:name]}#{extension}")
+			r = nil
+			Dir.chdir(File.dirname(source_path)) do
+				r = execute_command("tar #{tar_options.join(' ')} -cf \"#{@options[:tar_file]}\" \"#{File.basename(source_path)}\"")
+			end
+			raise "TAR returned an error" unless r
+			raise "TAR was not created" unless File.exist?(@options[:tar_file])
+			Tracer.debug "#{@options[:tar_file]} created"
+
+			# Check the tar structure.
+			if @options[:check_structure] or @options[:paranoid]
+				Tracer.debug "Checking TAR structure"
+				r = execute_command("tar #{tar_options.join(' ')} -tf \"#{@options[:tar_file]}\" >/dev/null")
+				raise "TAR structure is not correct" unless r
+			end
+
+			if @options[:paranoid]
+				Tracer.debug "Checking TAR content"
+				Dir.mktmpdir do |dir|
+					temp_dir = File.expand_path(dir)
+					Dir.chdir(temp_dir) do
+						r = execute_command("tar #{tar_options.join(' ')} -xf \"#{@options[:tar_file]}\"")
+					end
+					raise "Error while untaring the archive" unless r
+					r = compare(source_path, File.join(temp_dir, File.basename(source_path)))
+					raise "Content doesn't match" unless r
+				end
+			end
+
+			if @options[:generate_hash]
+				Utils::FileDigester.generate_digest_file(@options[:tar_file])
+			end
+		end
+
+		def add(filename)
+			@options[:paths] << File.expand_path(filename)
+		end
+
+		# Sets the name of the archive.
+		def name(filename)
+			@options[:name] = filename
+		end
+
+		# Sets the destination folder for the archive.
+		def destination(filename)
+			@options[:destination] = filename
+		end
+
+		def gzip
+			@options[:compression] = :gzip
+		end
+
+		def bzip2
+			@options[:compression] = :bzip2
+		end
+
+		def verbose
+			@options[:verbose] = true
+		end
+
+		def clever_exclude
+    	# Exclude .DS_Store & .dropbox
+  	end
+
+  	def generate_hash
+	  	@options[:generate_hash] = true
+	  end
+
+		# Untar the archive after creation to make sure everything is there.
+	  def paranoid
+	  	@options[:paranoid] = true
+	  end
+
+	  # Checks the tar structure after creating the archive.
+	  def check_structure
+	  	@options[:check_structure] = true
+	  end
+
+	  private
+
+	  def command_available?(cmd)
+	  	system("which #{cmd} >/dev/null")
+	  end
+
+	  def tar_options
+	  	s = []
+	  	s << '-v' if @options[:verbose]
+	  	s << '-z' if @options[:compression] == :gzip
+	  	s << '-j' if @options[:compression] == :bzip2
+	  	s
+	  end
+
+	  def extension
+	  	s = '.tar'
+	  	s += '.gz' if @options[:compression] == :gzip
+	  	s += '.bz2' if @options[:compression] == :bzip2
+	  	s
+	  end
+
+	  def execute_command(cmd)
+	  	Tracer.debug("Executing: #{cmd}")
+	  	Kernel.system(cmd)
+	  end
+
+	  def compare(original, copy)
+	  	a = File.expand_path(original)
+	  	b = File.expand_path(copy)
+	  	raise "Original file #{original} doesn't exist" unless File.exist?(a)
+	  	if File.directory?(a)
+	  		Dir.chdir(a) do
+	  			Dir.glob('**/*', File::FNM_DOTMATCH) do |f|
+	  				if File.exist?(f) and not File.directory?(f)
+	  					a_file = File.expand_path(File.join(a, f))
+	  					b_file = File.expand_path(File.join(b, f))
+	  					logger.debug("Comparing: #{a_file}, #{b_file}")
+	  					return false unless File.exist?(b_file) and not File.directory?(b_file)
+	  					return false unless Utils::FileDigester.digest(a_file) == Utils::FileDigester.digest(b_file)
+	  				end
+	  			end
+	  		end
+	  	else
+	  		return false unless File.exist?(b) and not File.directory?(b)
+	  		return false unless Utils::FileDigester.digest(a) == Utils::FileDigester.digest(b)
+	  	end
+	  	return true
+	  end
+	end
+end

data/lib/nauktis_utils/date_extractor.rb

@@ -0,0 +1,53 @@
+module NauktisUtils
+	class DateExtractor
+		attr_reader :counters
+    DATETIME_FORMAT = "%Y-%m-%d_%H-%M-%S_"
+    DATETIME_REGEX = /^\d{4}-\d{2}-\d{2}_\d{2}-\d{2}-\d{2}/
+
+    def initialize
+      @counters = Hash.new(0)
+    end
+
+    def extract_datetime(file_path)
+      meta = exiftool(FileBrowser.ensure_valid_file(file_path))
+      ['DateTimeOriginal', 'MediaCreateDate'].each do |tag|
+        return DateTime.parse(meta[tag]) if meta[tag]
+      end
+      Tracer.warn "Could not extract date from #{file_path}"
+      nil
+    end
+
+    def rename(file_path)
+      file_path = FileBrowser.ensure_valid_file(file_path)
+      @counters[:total] += 1
+      unless File.basename(file_path) =~ DATETIME_REGEX
+        prepend_date(file_path)
+      end
+    end
+
+    private
+
+    def prepend_date(file_path)
+      datetime = extract_datetime(file_path)
+      unless datetime.nil?
+        prefix = datetime.strftime(DATETIME_FORMAT)
+        current_name = File.basename(file_path)
+        unless current_name.start_with?(prefix)
+          prefixed_name = File.join(File.dirname(file_path), prefix + current_name)
+          if File.exist?(prefixed_name)
+            Tracer.warn "Cannot rename #{current_name}, #{prefixed_name} already exists."
+          else
+            File.rename(file_path, prefixed_name)
+            Tracer.info "Renamed #{current_name} to #{File.basename(prefixed_name)}."
+          end
+        end
+      end
+    end
+
+    def exiftool(file_path)
+      raise "File #{file_path} does not exist" unless File.exist?(file_path)
+      result = %x(exiftool -u -d "%Y-%m-%d %H:%M:%S" -json "#{file_path}")
+      JSON.parse(result)[0]
+    end
+	end
+end

data/lib/nauktis_utils/duplicate.rb

@@ -0,0 +1,195 @@
+module NauktisUtils
+	# Class to find and handle duplicate files.
+  class Duplicate
+    include Logging
+
+    def self.algorithm(name)
+      key = name.to_sym
+      @@algorithms ||= {}
+      unless @@algorithms.has_key? key
+        @@algorithms[:name] = proc { |file| File.basename(file).downcase }
+        @@algorithms[:size] = proc { |file| File.size(file) }
+        @@algorithms[:md5] = proc { |file| FileDigester.digest(file, :md5) }
+        @@algorithms[:sha1] = proc { |file| FileDigester.digest(file, :sha1) }
+        @@algorithms[:sha3] = proc { |file| FileDigester.digest(file, :sha3) }
+      end
+      @@algorithms.fetch key
+    end
+
+    # ========================================
+    # Handling Strategies
+    # ========================================
+    class HandlingStrategy
+      class BaseHandlingStrategy
+        attr_accessor :deleting_strategy
+        def initialize(deleting_strategy)
+          @deleting_strategy = deleting_strategy
+        end
+      end
+
+      class KeepOne < BaseHandlingStrategy
+        def handle(files)
+          files = files.sort
+          file_kept = files.shift
+          files.each do |duplicate|
+            @deleting_strategy.delete_duplicate(duplicate, file_kept)
+          end
+        end
+      end
+
+      class OriginalFrom < KeepOne
+        def initialize(deleting_strategy, directory)
+          super(deleting_strategy)
+          @directory = File.expand_path(directory)
+        end
+
+        def handle(files)
+          files = files.sort
+          i = files.find_index do |f|
+            f.start_with?(@directory)
+          end
+          unless i.nil?
+            file_kept = files.delete_at(i)
+            files.each do |duplicate|
+              @deleting_strategy.delete_duplicate(duplicate, file_kept)
+            end
+          end
+        end
+      end
+
+      class NoDeleteIn < BaseHandlingStrategy
+        def initialize(deleting_strategy, directories)
+          super(deleting_strategy)
+          @directories = directories.map { |d| File.expand_path(d) }
+        end
+
+        def handle(files)
+          files = files.sort
+          files_kept, files_deleted = files.partition do |e|
+            @directories.any? {|d| e.start_with?(d) }
+          end
+          if files_kept.size > 0
+            files_deleted.each do |duplicate|
+              @deleting_strategy.delete_duplicate(duplicate, files_kept.first)
+            end
+          end
+        end
+      end
+
+      class Analyse
+        attr_reader :counters
+        def initialize
+          @counters = Hash.new(0)
+        end
+
+        def handle(files)
+          @counters[:pairs] += 1
+          @counters[:duplicates] += (files.size - 1)
+          @counters[:size] += ((files.size - 1) * File.size(files.first))
+        end
+      end
+
+      class OnlyDeleteIn < BaseHandlingStrategy
+      # TODO
+      end
+    end
+
+    # ========================================
+    # Deleting Strategies
+    # ========================================
+    class DeletingStrategy
+      class BaseDeletingStrategy
+        include Logging
+      end
+
+      class Simulate < BaseDeletingStrategy
+        def delete_duplicate(duplicate, original)
+          logger.info "#{duplicate} duplicate of #{original}"
+        end
+      end
+
+      class Simple < BaseDeletingStrategy
+        def delete_duplicate(duplicate, original)
+          logger.info "Deleting #{duplicate}, duplicate of #{original}"
+          File.delete(duplicate)
+        end
+      end
+
+      class Safe < Simple
+        def delete_duplicate(duplicate, original)
+          if FileUtils.compare(duplicate, original)
+            super
+          else
+            logger.warn "Duplicate #{duplicate} was a false positive with #{original}"
+          end
+        end
+      end
+    end
+
+    # ========================================
+    attr_accessor :handling_strategy
+
+    def initialize(handling_strategy)
+      @handling_strategy = handling_strategy
+    end
+
+    def clean(directories)
+      logger.info "Searching duplicates in #{directories}"
+      directories.map! { |d| File.expand_path(d) }
+      files = files_in(directories)
+      logger.info "Number of files: #{files.size.to_s(:delimited)}"
+      size_before = size_of(directories)
+      logger.info "Total size: #{size_before.to_s(:human_size)}"
+
+      @groupings = [self.class.algorithm(:size), self.class.algorithm(:md5), self.class.algorithm(:sha3)]
+      multi_group_by(files, 0)
+
+      size_after = size_of(directories)
+      logger.info "Total size: #{size_after.to_s(:human_size)}"
+      reduction_ratio = (100 * (size_before - size_after) / size_before.to_f).round(2)
+      logger.info "Size reduced by #{reduction_ratio}% (#{size_after.to_s(:delimited)}/#{size_before.to_s(:delimited)})"
+    end
+
+    private
+
+    def multi_group_by(files, index)
+      if index >= @groupings.size
+        handle_duplicates(files)
+      else
+        files.group_by(&@groupings[index]).values.each do |sub|
+          multi_group_by(sub, index + 1) if sub.size > 1
+        end
+      end
+    end
+
+    def handle_duplicates(duplicates)
+      # For extra safety we check a file doesn't appear twice.
+      unless duplicates.uniq == duplicates
+        s = "A file appears twice: #{duplicates}"
+        logger.error s
+        raise s
+      end
+      handling_strategy.handle(duplicates)
+    end
+
+    # Returns the list of files in the directories provided
+    def files_in(directories)
+      files = []
+      Find.find(*directories) do |path|
+        unless File.directory?(path) or File.symlink?(path)
+          files << File.expand_path(path)
+        end
+      end
+      files.uniq
+    end
+
+    # Returns the total size of the directories provided
+    def size_of(directories)
+      size = 0
+      files_in(directories).each do |f|
+        size += File.size(f)
+      end
+      size
+    end
+  end
+end

data/lib/nauktis_utils/file_browser.rb

@@ -0,0 +1,94 @@
+module NauktisUtils
+  # Provide some utility methods for file handling.
+  module FileBrowser
+    # Returns true if the file provided is a valid (i.e. existing) file.
+    def self.valid_file?(filename)
+      full_path = File.expand_path(filename)
+      File.exist?(full_path) and not File.directory?(full_path)
+    end
+
+    # Returns true if the file provided is a valid (i.e. existing) directory.
+    def self.valid_directory?(directory)
+      full_path = File.expand_path(directory)
+      File.exist?(full_path) and File.directory?(full_path)
+    end
+
+    # Raises an exception if the path provided is not an existing file.
+    # Returns the expanded path of the file
+    def self.ensure_valid_file(filename)
+      raise "#{filename} is not a valid file." unless self.valid_file?(filename)
+      File.expand_path(filename)
+    end
+
+    # Raises an exception if the path provided is not an existing directory.
+    # Returns the expanded path of the directory
+    def self.ensure_valid_directory(directory)
+      raise "#{directory} is not a valid directory." unless self.valid_directory?(directory)
+      File.expand_path(directory)
+    end
+
+    # Returns true if the string provided contains characters that will be interpreted in a glob operation.
+    def self.contains_glob_character?(path)
+      full_path = File.expand_path(path)
+      ['*', '?', '[', '{'].each do |s|
+        return true if full_path.include?(s)
+      end
+      return false
+    end
+
+    # Recursively goes through all the files contained in a directory.
+    def self.each_file(directory)
+      raise "Can't use glob on #{directory_path}, dangerous character #{s}" if contains_glob_character?(directory)
+      Dir.glob(File.join(File.expand_path(directory), '**', '*'), File::FNM_DOTMATCH).each do |entry|
+        next if File.directory?(entry)
+        yield(File.expand_path(entry))
+      end
+    end
+
+    # Copy a file to destination appending a number if the file already exists at destination.
+    def self.copy_file(file, destination_folder)
+      destination_folder = self.ensure_valid_directory(destination_folder)
+      file_path = self.ensure_valid_file(file)
+
+      file_ext = File.extname(file_path)
+      file_basename = File.basename(file_path)
+      file_base = File.basename(file_path, file_ext)
+      final_file = File.join(destination_folder, file_basename)
+      i = 0
+      while File.exist?(final_file) do
+        i += 1
+        final_file = File.join(destination_folder, "#{file_base}#{i}#{file_ext}")
+      end
+      FileUtils.cp(file_path, final_file)
+    end
+
+    # Deletes all the .DS_Store
+    def self.delete_ds_store(directory)
+      %x(find #{File.expand_path(directory)} -name \.DS_Store -exec rm {} \;)
+    end
+
+    # Recursively remove all empty directories
+    def self.delete_empty_directories(directory)
+      %x(find #{File.expand_path(directory)} -type d -empty -delete)
+    end
+
+    # Only keeps alpha numeric characters in a String. Also replaces spaces by underscores.
+    def self.sanitize_name(name)
+      sanitized = name.strip
+      sanitized.gsub!(/[^\w\s\-\.]+/, '')
+      sanitized.gsub!(/[[:space:]]+/, '_')
+      sanitized
+    end
+
+    def self.sanitize_filename(filename)
+      name = File.basename(filename, File.extname(filename))
+      name = self.sanitize_name(name)
+      dirname = File.dirname(filename)
+      if dirname != '.'
+        File.join(dirname, "#{name}#{File.extname(filename).downcase}")
+      else
+        "#{name}#{File.extname(filename).downcase}"
+      end
+    end
+  end
+end

data/lib/nauktis_utils/file_digester.rb

@@ -0,0 +1,39 @@
+module NauktisUtils
+	module FileDigester
+    ALGORITHMS = [:md5, :sha1, :sha256, :sha512, :sha3]
+
+    # Returns the hexdigest of the file provided.
+    def self.digest(filename, algorithm = :sha1)
+      full_path = FileBrowser.ensure_valid_file(filename)
+      raise "Unknown algorithm #{algorithm}, use #{ALGORITHMS}" unless ALGORITHMS.include?(algorithm.to_sym)
+      if algorithm.to_sym == :sha3
+        SHA3::Digest.file(full_path).hexdigest
+      else
+        OpenSSL::Digest.new(algorithm.to_s).file(full_path).hexdigest
+      end
+    end
+
+    # Generates a file next to the file provided containing its digest
+    def self.generate_digest_file(filename, algorithm = :sha1)
+      digest = self.digest(filename, algorithm)
+      File.write("#{File.expand_path(filename)}.#{algorithm}", digest)
+    end
+
+    # Checks the digest files next to the file provided.
+    # Returns true if all the digest files contain proper digest
+    def self.digest_file_valid?(filename)
+      full_path = FileBrowser.ensure_valid_file(filename)
+      valid = true
+      ALGORITHMS.each do |algorithm|
+        digest_file = "#{full_path}.#{algorithm}"
+        if FileBrowser.valid_file?(digest_file)
+          unless self.digest(filename, algorithm) == File.read(digest_file)
+            valid = false
+            break
+          end
+        end
+      end
+      valid
+    end
+  end
+end

data/lib/nauktis_utils/logging.rb

@@ -0,0 +1,18 @@
+module NauktisUtils
+  # Logger module that can be included in classes
+  module Logging
+    # Method making the logger mixed where needed
+    def logger
+      Logging.logger
+    end
+
+    # Global, memoized, lazy initialized instance of a logger
+    def self.logger
+      @logger ||= Logger.new(STDOUT)
+    end
+
+    def self.logger=(new_logger)
+      @logger = new_logger
+    end
+  end
+end

data/lib/nauktis_utils/tracer.rb

@@ -0,0 +1,27 @@
+module NauktisUtils
+	class Tracer
+    def self.debug(message)
+      log(Logger::DEBUG, message)
+    end
+    
+    def self.info(message)
+      log(Logger::INFO, message)
+    end
+    
+    def self.warn(message)
+      log(Logger::WARN, message)
+    end
+    
+    def self.error(message)
+      log(Logger::ERROR, message)
+    end
+    
+    def self.fatal(message)
+      log(Logger::FATAL, message)
+    end
+
+		def self.log(severity, message)
+      Logging.logger.add(severity, message, caller[1])
+    end
+	end
+end

data/lib/nauktis_utils/version.rb

@@ -0,0 +1,3 @@
+module NauktisUtils
+  VERSION = "0.1.0"
+end

data/nauktis_utils.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nauktis_utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nauktis_utils"
+  spec.version       = NauktisUtils::VERSION
+  spec.authors       = ['Nauktis']
+  spec.email         = ['']
+
+  spec.summary       = %q{Various ruby utility classes.}
+  spec.description   = %q{Various ruby utility classes and tools.}
+  spec.homepage      = 'https://github.com/Nauktis/nauktis_utils'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'json'
+  spec.add_dependency 'sha3'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "tmpdir"
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: nauktis_utils
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nauktis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: sha3
+  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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tmpdir
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Various ruby utility classes and tools.
+email:
+- ''
+executables:
+- datify
+- duplicates
+- rm_duplicates
+- rm_duplicates_in_if_in
+- rm_if_in
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/datify
+- exe/duplicates
+- exe/rm_duplicates
+- exe/rm_duplicates_in_if_in
+- exe/rm_if_in
+- lib/nauktis_utils.rb
+- lib/nauktis_utils/archiver.rb
+- lib/nauktis_utils/date_extractor.rb
+- lib/nauktis_utils/duplicate.rb
+- lib/nauktis_utils/file_browser.rb
+- lib/nauktis_utils/file_digester.rb
+- lib/nauktis_utils/logging.rb
+- lib/nauktis_utils/tracer.rb
+- lib/nauktis_utils/version.rb
+- nauktis_utils.gemspec
+homepage: https://github.com/Nauktis/nauktis_utils
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Various ruby utility classes.
+test_files: []