nli_pipeline 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01614a3ab29fb84f8c2f15d17f93ffb1c29ed55a
-  data.tar.gz: 0cf4ad87b1a541b88a18b57ae5e30d1951d9d1d8
+  metadata.gz: 94d6783976cf9ba327368ffc9ecd7081e9499991
+  data.tar.gz: 5c8853eb5884a7b8196ccbebfc0fa91df2d29bff
 SHA512:
-  metadata.gz: 0f11c2ff157f1429f72f47a2b8a0ee78174ce408bd471f3a62dbceddeffd15c55ffc33d27df202f0e3162c5f4934d54836ba750da97a91ecf2106b0ff22c53a2
-  data.tar.gz: edc571570dc7d250bd1b272870a004ff26904c4b9bd2d2a27cafe6ec6d323b492a25bbb5e167e2b0ba5dc7615e6ea445472b3dde6d097d212b8165c9f6d5365f
+  metadata.gz: 6ab3bb4ee792d86473846b2ef7c56c14a677ddfc8de11a01b2f280a9172679e6a847815702db32ddbeba992ddd0390a602911bfd564e1f76f36ce95610d247eb
+  data.tar.gz: 9d65983f9e2bcb845c9f58143f9bd015ad315a4af0604df1bbb94c356386a354df8836eacf22c47ddae43d078ef49298acc8a158cdc8afef58f78dd382146741

data/bin/setup_pipeline

@@ -1,14 +1,4 @@
 #!/usr/bin/env ruby
-
 require 'nli_pipeline'
 
-fm = FileManager.new
-
-if !ARGV[0]
-  dir = File.expand_path(File.dirname(__dir__))
-else 
-  dir = ARGV[0]
-end
-
-puts "setting up pipeline in #{dir}"
-fm.copy_example_files(dir)
+SetupPipeline.new.main()

data/lib/nli_pipeline/file_manager.rb

@@ -0,0 +1,84 @@
+require 'rubygems'
+
+# Manage example files
+#
+# EXAMPLE:
+#   >> FileManager.new.copy_example_files()
+#   => Moving 1 .EXAMPLE files
+class FileManager
+
+  attr_accessor :backup
+  attr_accessor :extension
+
+  # Arguements:
+  #   backup: (boolean)
+  #   extension: (string)
+  def initialize(backup: true, extension: ".EXAMPLE")
+    # puts("config= {backup: #{backup} extension: #{extension}}")
+    @backup = backup
+    @extension = extension
+  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}
+  end
+
+  # Arguements:
+  #   path: (string: filepath)
+  #   command: (string: system command)
+  def copy_example_files(path, command="cp")
+    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")
+    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")}")
+      end
+      # convert the example file to real config
+      system("#{command} #{example_file} #{target_file}")
+    end
+  end
+
+  # Arguements:
+  #   path: (string: filepath)
+  #   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)
+    if backups.empty?
+      raise "\n No backups found \n"
+    end
+    puts "which backup would you like to load? #{backups}"
+    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}"
+      latest_backup_date = STDIN.gets().chomp()
+    end
+
+    puts "loading *.backup#{latest_backup_date}"
+
+    Dir.glob("#{path}/**/*.backup#{latest_backup_date}").each do |backup_file|
+      target_file = backup_file.gsub("\.backup#{latest_backup_date}", "")
+      command = "#{command} #{backup_file} #{target_file}"
+      puts(command)
+      system(command)
+    end
+  end
+
+end

data/lib/nli_pipeline/setup_pipeline.rb

@@ -0,0 +1,64 @@
+require 'optparse' # core gem, no install required
+
+# Class used to parse arguements from bin/setup_pipeline executable
+class SetupPipeline
+  # Commandline Arguements:
+  #   $1 (file path) (required)
+  #   $2 (undo) (not required)
+  #   --version
+  #   --backup
+  #   --no-backup
+  #   --extension=(string: file extension)
+  #
+  # Raises:
+  #   ArgumentError if $1 is missing or is not a valid directory
+
+  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
+
+    end.parse!
+
+
+    if !ARGV[0] || !Dir.exist?(ARGV[0])
+      error_message = "The first arguement 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")
+    else 
+      return [ARGV[0], options]
+    end
+  end
+
+  def main()
+    args = parse_args()
+    if args
+      dir, options = args
+      # pass options hash as keyword arguements
+      fm = FileManager.new(**options)
+      if ARGV[1] == "undo"
+        puts "loading backups in #{dir}"
+        fm.load_from_backup(dir)
+      else
+        puts "setting up pipeline in #{dir}"
+        fm.copy_example_files(dir)
+      end
+    end
+  end
+end

data/lib/nli_pipeline.rb

@@ -1,48 +1,10 @@
-class FileManager
-  attr_accessor :backup
-  attr_accessor :extension
+module NliPipeline
 
-  def initialize(backup=true, extension="\.EXAMPLE")
-    @backup = backup
-    @extension = extension
-  end
-
-  def get_latest_backup_number(backup_files)
-    backup_dates = backup_files.map {|x| x.split(".backup").last.to_i}
-    return "#{backup_dates.max}"
-  end
-
-
-  def copy_example_files(path, command="cp")
-    example_file_path = "#{path}/**/*.EXAMPLE"
-    example_files = Dir.glob(example_file_path)
-    if example_files.empty?
-      raise "No Example Files found at #{example_file_path}"
-    else
-      puts("Moving #{example_files.count} example files")
-    end
-
-    example_files.each do |example_file|
-      target_file = example_file.gsub("\.EXAMPLE", "")
-      # 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")}")
-      end
-      # convert the example file to real config
-      system("#{command} #{example_file} #{target_file}")
-    end
-  end
-
-
-  # to remove backup, use mv
-  # to keep backup, use cp
-  def undo_latest_copy_example_files(path, command="cp")
-    latest_backup_date = get_latest_backup_number(Dir.glob("./**/*.backup*"))
-    Dir.glob("#{path}/**/*.backup#{latest_backup_date}").each do |backup_file|
-      target_file = backup_file.gsub("\.backup#{latest_backup_date}", "")
-      system("#{command} #{backup_file} #{target_file}")
-    end
-  end
+  # 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"
 
+  require_relative 'nli_pipeline/file_manager'
+  require_relative 'nli_pipeline/setup_pipeline'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nli_pipeline
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Conor Sheehan
@@ -19,7 +19,9 @@ extra_rdoc_files: []
 files:
 - bin/setup_pipeline
 - lib/nli_pipeline.rb
-homepage: 
+- lib/nli_pipeline/file_manager.rb
+- lib/nli_pipeline/setup_pipeline.rb
+homepage: https://rubygems.org/gems/nli_pipeline
 licenses:
 - MIT
 metadata: {}