libis-rosetta_checker 1.0.0

data/lib/libis/rosetta_checker/options/files_to_ingest_cleanup.rb

@@ -0,0 +1,106 @@
+module Libis
+  module RosettaChecker
+    class FilesToIngestCleanupOptions
+      attr_accessor :command, :quiet, :log_file, :recursive, :report, :report_file, :delete, :dburl, :dbuser, :dbpass
+
+      def initialize(command)
+        self.command = command
+        self.delete = false
+        self.quiet = false
+        self.log_file = nil
+        self.recursive = false
+        self.report = true
+        default_report_file = "#{command.split(' ').last}-#{DateTime.now.strftime('%Y%m%d-%H%M%S')}.csv"
+        self.report_file = default_report_file
+        self.dburl = '//libis-db-rosetta:1551/ROSETTAP.kuleuven.be'
+        self.dbuser = 'V2KU_REP00'
+        self.dbpass = 'V2KU_REP00'
+      end
+
+      # @param [OptionParser] parser
+      def define(parser)
+        parser.banner = "Usage: #{command} [options] [[r_options] [directory|[@]file] ...]"
+        parser.separator ''
+        parser.separator 'This tool will scan directories for files that are/are not ingested in Rosetta.'
+        parser.separator ''
+        parser.separator 'If a file name preceded with a \'@\' is given as an argument, the file is expected to be a'
+        parser.separator 'text file with directory names - one directory per line.'
+        parser.separator ''
+
+        parser.separator 'The tool will compare the file sizes, MD5 checksums and file names with the information in the'
+        parser.separator 'Rosetta database to determine if a possible match is found.'
+        parser.separator 'with [r_options] (can be repeated in between directory/file inputs):'
+        define_quiet parser
+        define_logfile parser
+        define_recursive parser
+        parser.separator ''
+
+        parser.separator 'with [options]:'
+        define_report parser
+        define_report_file parser
+        # define_delete parser
+        define_dbparams parser
+      end
+
+      # @param [OptionParser] parser
+      def define_quiet(parser)
+        parser.on '-q', '--[no-]quiet', "Be quiet - no logging output on screen [#{self.quiet}]" do |flag|
+          self.quiet = flag
+        end
+      end
+
+      # @param [OptionParser] parser
+      def define_logfile(parser)
+        parser.on '-l', '--logfile [FILE]',
+                  "Send logging output to file - appends to existing file [#{self.log_file}]",
+                  '(re)set to empty string for no logging to file' do |file|
+          self.log_file = file
+        end
+      end
+
+      # @param [OptionParser] parser
+      def define_recursive(parser)
+        parser.on '-R', '--[no-]recursive', "Parse through subdirectories [#{self.recursive}]" do |flag|
+          self.recursive = flag
+        end
+      end
+
+      # @param [OptionParser] parser
+      def define_report(parser)
+        parser.on '--[no-]report', "Create a report file - overwrites existing file [#{self.report}]" do |flag|
+          self.report = flag
+        end
+      end
+
+      # @param [OptionParser] parser
+      def define_report_file(parser)
+        parser.on '-o', '--output-file [FILE]',
+                  "File name for the report, if enabled [#{self.report_file}]" do |file|
+          self.report_file = file
+        end
+      end
+
+      # @param [OptionParser] parser
+      def define_delete(parser)
+        parser.on '-D', '--[no-]delete',
+                  "Perform file deletes when file is ingested [#{self.delete}]" do |flag|
+          self.delete = flag
+        end
+      end
+
+      # @param [OptionParser] parser
+      def define_dbparams(parser)
+        parser.on '--db-url [URL]', "Database connection URL [#{self.dburl}]" do |url|
+          self.dburl = url
+        end
+        parser.on '--db-user [USER]', "Database user name [#{self.dbuser}]" do |user|
+          self.dbuser = user
+        end
+        parser.on '--db-pass [PASSWORD]', "Database password [#{self.dbpass}" do |pass|
+          self.dbpass = pass
+        end
+      end
+
+    end
+  end
+end

data/lib/libis/rosetta_checker/sub_command.rb

@@ -0,0 +1,60 @@
+require 'optionparser'
+
+module Libis
+  module RosettaChecker
+    class SubCommand
+      def self.short_desc
+        raise RuntimeError, 'Method should be overwritten'
+      end
+
+      def self.command
+        raise RuntimeError, 'Method should be overwritten'
+      end
+
+      def self.options_class
+        raise RuntimeError, 'Method should be overwritten'
+      end
+
+      def self.help
+        self.options('-h')
+      end
+
+      def self.options(*argv)
+        argv = ARGV if argv.empty?
+        @config ||= self.options_class.new "#{RosettaChecker.main_command} #{self.command}"
+        parse_options(argv)
+      end
+
+      def self.parse_options(argv)
+        OptionParser.new do |opts|
+          @config.define opts
+          opts.on '-h', '--help', 'Show this help' do
+            puts opts
+            exit
+          end
+        end.order!(argv)
+      end
+
+      def self.run
+        self.options
+        instance = self.new(@config)
+        instance.run(ARGV)
+      rescue OptionParser::ParseError => e
+        puts "ERROR: #{e.message}"
+        puts ''
+        self.help
+      rescue StandardError => e
+        $stderr.puts "ERROR: #{e.message} @ #{e.backtrace.first}"
+          ap e.backtrace
+      rescue Interrupt
+        $stderr.puts "ERROR: Interrupted."
+      ensure
+          instance.finalize if instance
+      end
+
+      def self.subcommands
+        Hash[ObjectSpace.each_object(Class).select {|klass| klass < self}.map {|klass| [klass.command, klass]}]
+      end
+    end
+  end
+end

data/lib/libis/rosetta_checker/version.rb

@@ -0,0 +1,5 @@
+module Libis
+  module RosettaChecker
+    VERSION = "1.0.0"
+  end
+end

data/lib/libis/rosetta_checker.rb

@@ -0,0 +1,46 @@
+require "libis/rosetta_checker/version"
+require 'optionparser'
+require 'awesome_print'
+
+require_relative 'rosetta_checker/sub_command'
+require_relative 'rosetta_checker/files_to_ingest_cleanup'
+
+module Libis
+  module RosettaChecker
+
+    def self.main_command
+      @main_command ||= File.basename($0)
+    end
+
+    def self.subcommands
+      @subcommands ||= SubCommand.subcommands
+    end
+
+    def self.help
+      puts "Usage: #{main_command} [command [cmd_options]]"
+      puts ''
+      puts 'Commands are:'
+      puts '  help : Show more help for a specific command'
+      subcommands.each do |k,v|
+        puts "  #{k.to_s} : #{v.short_desc}"
+      end
+      puts ''
+      puts "See '#{main_command} help COMMAND' or '#{main_command} COMMAND --help' for more information."
+      puts "A more detailed discussion on the toolkit is available on-line on the LIBIS teamwork" +
+               " (https://libis.teamwork.com/#/notebooks/168158)."
+      exit
+    end
+
+    def self.run
+
+      first_command = command = ARGV.shift
+      help if command.nil?
+      command = ARGV.shift if command == 'help'
+      cmd_class = subcommands[command]
+      help if cmd_class.nil?
+      cmd_class.help if first_command == 'help'
+      cmd_class.run
+    end
+
+  end
+end

data/libis-rosetta_checker.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "libis/rosetta_checker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "libis-rosetta_checker"
+  spec.version       = Libis::RosettaChecker::VERSION
+  spec.authors       = ["Kris Dekeyser"]
+  spec.email         = ["kris.dekeyser@libis.be"]
+
+  spec.summary       = %q{Rosetta checker toolkit.}
+  spec.description   = %q{A set of command-line tools to check the consistency of the Rosetta preservation system.}
+  spec.homepage      = "https://github.com/libis/rosetta_checker.git"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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_runtime_dependency "ruby-oci8", "~> 2.2"
+  spec.add_runtime_dependency "ruby-progressbar", "~> 1.9"
+  spec.add_runtime_dependency "awesome_print", "~> 1.8"
+  spec.add_runtime_dependency 'bzip2-ffi', '~> 1.0'
+  spec.add_runtime_dependency 'rubyzip', '~> 1.2'
+  spec.add_runtime_dependency 'logging', '~> 2.2'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: libis-rosetta_checker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kris Dekeyser
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-oci8
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bzip2-ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A set of command-line tools to check the consistency of the Rosetta preservation
+  system.
+email:
+- kris.dekeyser@libis.be
+executables:
+- rosetta_checker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/libis-rosetta_checker.iml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/workspace.xml"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/rosetta_checker
+- lib/libis/rosetta_checker.rb
+- lib/libis/rosetta_checker/files_to_ingest_cleanup.rb
+- lib/libis/rosetta_checker/options/files_to_ingest_cleanup.rb
+- lib/libis/rosetta_checker/sub_command.rb
+- lib/libis/rosetta_checker/version.rb
+- libis-rosetta_checker.gemspec
+homepage: https://github.com/libis/rosetta_checker.git
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.14
+signing_key: 
+specification_version: 4
+summary: Rosetta checker toolkit.
+test_files: []