nli_pipeline 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94d6783976cf9ba327368ffc9ecd7081e9499991
-  data.tar.gz: 5c8853eb5884a7b8196ccbebfc0fa91df2d29bff
+  metadata.gz: 8d8bf060accfdf2aab9524b1c876e39cc6727b36
+  data.tar.gz: 2604f60e3bb6dd5b8871aa69373b4e8a18a8b390
 SHA512:
-  metadata.gz: 6ab3bb4ee792d86473846b2ef7c56c14a677ddfc8de11a01b2f280a9172679e6a847815702db32ddbeba992ddd0390a602911bfd564e1f76f36ce95610d247eb
-  data.tar.gz: 9d65983f9e2bcb845c9f58143f9bd015ad315a4af0604df1bbb94c356386a354df8836eacf22c47ddae43d078ef49298acc8a158cdc8afef58f78dd382146741
+  metadata.gz: 797f7b480c8d9b2521110993c62955662b9ab7be228cb84663db0700b21e9486d0de13b75317ecb6e7eb2722df4f79c77359ffa0ef867b844002b184080a27fe
+  data.tar.gz: 8d884eb2bd4713aee5e879f57e788d0697a55c0b951f8b8dc4ce9decf7688caf323a90cfbc2ce6258584cf3802f54c746c7326a26bacfc31b5da39d744494963

data/lib/nli_pipeline/file_manager.rb

@@ -1,4 +1,5 @@
 require 'rubygems'
+require 'colorize'
 
 # Manage example files
 #
@@ -7,77 +8,92 @@ require 'rubygems'
 #   => Moving 1 .EXAMPLE files
 class FileManager
 
-  attr_accessor :backup
+  attr_reader :path
   attr_accessor :extension
+  attr_accessor :debug
 
-  # Arguements:
-  #   backup: (boolean)
+  # Arguments:
+  #   path: (string: path to directory)
   #   extension: (string)
-  def initialize(backup: true, extension: ".EXAMPLE")
-    # puts("config= {backup: #{backup} extension: #{extension}}")
-    @backup = backup
+  #   debug: (boolean)
+  #   no_output: (boolean: used for suppressing output during tests)
+  def initialize(path, extension: ".EXAMPLE", debug: false, no_output: false)
+    puts("config = {path: '#{path}', extension: '#{extension}', debug: #{debug}, no_output: #{no_output}}".yellow()) if debug 
+    @path = path
     @extension = extension
+    @debug = debug
+    @no_output = no_output
   end
 
-  # Arguements:
-  #   path: (string: filepath)
-  def get_all_backups(path)
-    backup_files = Dir.glob("#{path}/**/*.backup*")
-    return backup_files.map {|x| x.split(".backup").last.to_i}
+  def get_all_backups()
+    backup_files = Dir.glob("#{@path}/**/*.backup*")
+    backup_numbers = backup_files.map {|x| x.split(".backup").last}
+    return backup_numbers.uniq.sort
   end
 
-  # Arguements:
-  #   path: (string: filepath)
+  # Arguments:
   #   command: (string: system command)
-  def copy_example_files(path, command="cp")
-    example_file_path = "#{path}/**/*#{extension}"
+  def copy_example_files(command="cp")
+    puts("Setting up pipeline in #{@path}".yellow()) unless @no_output
+    example_file_path = "#{@path}/**/*#{extension}"
     example_files = Dir.glob(example_file_path)
     if example_files.empty?
       raise "No #{extension} Files found at #{example_file_path}"
     else
-      puts("Moving #{example_files.count} #{extension} files")
+      puts("Moving #{example_files.count} #{extension} files".green()) unless @no_output
     end
 
-    example_files.each do |example_file|
-      target_file = example_file.gsub(extension, "")
-      # backup configuration if it already exists
-      if File.exists?(target_file)
-        puts("backing up #{target_file}")
-        system("#{command} #{target_file} #{target_file}.backup#{Time.now.strftime("%Y%m%d%H%M")}")
+    files_to_backup = example_files.map {|f| f.gsub(@extension, "")}.select {|file| File.exists?(file) }
+    if !files_to_backup.empty?
+      # preset backup time so all backups fomr same batch have the same timestamp
+      backup_time_stamp = Time.now.strftime("%Y%m%d%H%M")
+      puts("Backing up #{files_to_backup.count} files".green()) unless @no_output
+      files_to_backup.each do |file_to_backup|
+        full_command = "#{command} #{file_to_backup} #{file_to_backup}.backup#{backup_time_stamp}"
+        puts("\t#{full_command}") if @debug
+        system(full_command)
       end
+    end        
+
+    example_files.each do |example_file|
+      target_file = example_file.gsub(@extension, "")
       # convert the example file to real config
-      system("#{command} #{example_file} #{target_file}")
+      full_command = "#{command} #{example_file} #{target_file}"
+      puts("\t#{full_command}") if @debug
+      system(full_command)
     end
   end
 
-  # Arguements:
-  #   path: (string: filepath)
+  # Arguments:
   #   command: (string: system command)
   #
   # to remove backup, use mv
   # to keep backup, use cp
-  def load_from_backup(path, command="cp")
-    backups = get_all_backups(path)
+  def load_from_backup(command="cp")
+    puts("loading backup in #{@path}".yellow())
+    backups = get_all_backups()
     if backups.empty?
+      # TODO: better exception class here?
       raise "\n No backups found \n"
     end
-    puts "which backup would you like to load? #{backups}"
+
+    puts "which backup would you like to load?\n#{backups}".yellow()
     latest_backup_date = STDIN.gets().chomp()
 
-    # backups are integers, comapre as strings
-    while !backups.map {|b| b.to_s} .include?(latest_backup_date)
-      puts "#{latest_backup_date} is not in backups"
-      puts "please choose from: #{backups}"
+    while !backups.include?(latest_backup_date)
+      puts "#{latest_backup_date} is not in backups".red()
+      puts "please choose from: #{backups}".yellow()
       latest_backup_date = STDIN.gets().chomp()
     end
 
-    puts "loading *.backup#{latest_backup_date}"
+    files_to_load = Dir.glob("#{@path}/**/*.backup#{latest_backup_date}")
+    puts "loading #{files_to_load.count} files from #{@path}/**/*.backup#{latest_backup_date}".green()
 
-    Dir.glob("#{path}/**/*.backup#{latest_backup_date}").each do |backup_file|
+    files_to_load.each do |backup_file|
       target_file = backup_file.gsub("\.backup#{latest_backup_date}", "")
-      command = "#{command} #{backup_file} #{target_file}"
-      puts(command)
-      system(command)
+      full_command = "#{command} #{backup_file} #{target_file}"
+      puts("\t#{full_command}") if @debug
+      system(full_command)
     end
   end
 

data/lib/nli_pipeline/setup_pipeline.rb

@@ -1,14 +1,13 @@
 require 'optparse' # core gem, no install required
 
-# Class used to parse arguements from bin/setup_pipeline executable
+# Class used to parse arguments from bin/setup_pipeline executable
 class SetupPipeline
-  # Commandline Arguements:
+  # Commandline Arguments:
   #   $1 (file path) (required)
   #   $2 (undo) (not required)
   #   --version
-  #   --backup
-  #   --no-backup
   #   --extension=(string: file extension)
+  #   --debug (show system commands when enabled)
   #
   # Raises:
   #   ArgumentError if $1 is missing or is not a valid directory
@@ -16,48 +15,41 @@ class SetupPipeline
   def parse_args()
     options = {}
     OptionParser.new do |opts|
-      usage = "Usage: setup_pipeline [directory:str (backup:bool) (extension:str)]"
-      usage_example = "Example: setup_pipeline $PWD"
-      opts.banner = "#{usage}\n#{usage_example}"
-
       opts.on("-v", "--version") do |v|
         puts NliPipeline::VERSION
         # break out of function, don't throw exception about passing directory path
         return false
       end
-
-      opts.on("--[no-]backup") do |v|
-        options[:backup] = v
-      end
-
       opts.on("--extension=[\w+]") do |v|
         options[:extension] = v
       end
-
+      opts.on("--debug") do |v|
+        options[:debug] = v
+      end
     end.parse!
 
-
     if !ARGV[0] || !Dir.exist?(ARGV[0])
-      error_message = "The first arguement to setup_pipeline must be a valid directory."
+      error_message = "The first argument to setup_pipeline must be a valid directory."
       example = "For example, setting up a pipeline in the current directory: setup_pipeline $PWD"
-      raise ArgumentError.new("\n\n#{error_message}\n#{example}\n\n")
+      exception = "The only exception to this is: setup_pipeline --version"
+      raise ArgumentError.new("\n\n#{error_message}\n#{example}\n#{exception}\n\n")
     else 
       return [ARGV[0], options]
     end
   end
 
+  # Method called by bin/setup_pipeline
+  # TODO: move undo arg handling to parse_args?
   def main()
     args = parse_args()
     if args
       dir, options = args
-      # pass options hash as keyword arguements
-      fm = FileManager.new(**options)
+      # pass options hash as keyword arguments
+      fm = FileManager.new(dir, **options)
       if ARGV[1] == "undo"
-        puts "loading backups in #{dir}"
-        fm.load_from_backup(dir)
+        fm.load_from_backup()
       else
-        puts "setting up pipeline in #{dir}"
-        fm.copy_example_files(dir)
+        fm.copy_example_files()
       end
     end
   end

data/lib/nli_pipeline.rb

@@ -3,7 +3,7 @@ module NliPipeline
   # constant use in nli_pipeline.gemspec and bin/setup_pipeline
   # to determine current version of gem
   # should also match tag on bitbucket
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 
   require_relative 'nli_pipeline/file_manager'
   require_relative 'nli_pipeline/setup_pipeline'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nli_pipeline
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Conor Sheehan
@@ -24,7 +24,8 @@ files:
 homepage: https://rubygems.org/gems/nli_pipeline
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://bitbucket.org/nlireland/nli-pipeline-gem
 post_install_message: 
 rdoc_options: []
 require_paths: