nli_pipeline 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 329ec7c4876dc475fe0e9d0eb862c9e15b29830b
-  data.tar.gz: bc8d1987fe622155eab3a81fda27a380a242ea87
+  metadata.gz: 5803338257515506b32dc63259908d23d660e701
+  data.tar.gz: b5a12fbcf9b2e604464bd3c99c6b9f3101e34539
 SHA512:
-  metadata.gz: 85810852a714380b3e98b01556091ab2f11f71eb31388584c2cb670ed333d5b71c5ca0a429eae73d8a4aabdf942245e87d31f1f3decfc57ef32c43b761f3d13e
-  data.tar.gz: 2213f5c125ec40836b213db87beb94f1a9df7b1fee73cc233f0117363e5e5731cc99fec16e865072a3777b0a6122a6938c8783de012df2820d4773197754a9c5
+  metadata.gz: b547fd4c73d957517ca8b8cc0b30f189d042188e025d37f9ad42238bdbeae976efede708a6229f9b64a39c4fe353d9e611cdd983393830f45025ef0525b4d77a
+  data.tar.gz: 6ec520a89825c94223381bff4169f807a24d29988c7207f27d0fdbef385c5c581542a751f2ccd49b2888da274f4614e5810e13301e5ebaa544466ec1d6160baf

data/History.txt

@@ -0,0 +1,52 @@
+# coding: UTF-8
+
+=== 0.1.2 / 2018-06-08
+Features:
+* --help               show help screen
+* --show-commands      show available commands
+* --show-flags         show available arguments
+* show_last_created    show file created by last setup_pipeline command
+
+Slight improvement on doc and test coverage
+
+
+
+=== 0.1.1 / 2018-05-14
+
+Bug Fixes
+
+* Include runtime and development dependencies
+
+
+
+=== 0.1.0 / 2018-05-11
+
+Breaking changes:
+
+* Remove --backup and --no-backup flags (should always backup if file already exists)
+
+
+Features:
+
+* Add color output
+* Add --debug flag to show all system commands and config
+* Add no_output option to suppress all output during tests
+
+
+=== 0.0.1 / 2018-05-11
+
+Features:
+
+* Add RDOC
+* Add --version flag to show current version
+* Add --backup flag and --no-backup to handle backups
+* Add --extension= flag to use custom example file extenstions
+* Add undo option to load backup files from setup_pipeline executable
+* Slightly better testing, still unfinished / not using fake file system
+
+
+=== 0.0.0 / 2018-04-26
+
+Features:
+
+* Basic setup_pipeline executable which moves all .EXAMPLE to non .EXAMPLE location

data/lib/nli_pipeline/file_manager.rb

@@ -8,8 +8,11 @@ require 'colorize'
 #   => Moving 1 .EXAMPLE files
 class FileManager
 
+  # String: must be valid file path
   attr_reader :path
+  # String: file extension default: .EXAMPLE
   attr_accessor :extension
+  # Bool: show all system commands run by ruby
   attr_accessor :debug
 
   # Arguments:
@@ -23,37 +26,63 @@ class FileManager
     @extension = extension
     @debug = debug
     @no_output = no_output
+    @log_dir = "#{path}/.pipeline_logs"
+    @created_log_name = "created_files_"
+
+    unless File.directory?(@log_dir)
+      Dir.mkdir(@log_dir)
+    end 
   end
 
+  # get backup dates in order from newest to oldest
   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
 
-  # Arguments:
-  #   command: (string: system command)
-  def copy_example_files(command="cp")
-    puts("Setting up pipeline in #{@path}".yellow()) unless @no_output
+  # find all example files under @path
+  def get_all_example_files()
     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}"
+      raise ArgumentError.new("No #{extension} Files found at #{example_file_path}")
     else
       puts("Moving #{example_files.count} #{extension} files".green()) unless @no_output
     end
+    return example_files
+  end
 
+  # read latest log in .pipeline_logs 
+  # @return [String] files created by last setup_pipeline
+  def get_last_created_files()
+    logs = Dir.glob("#{@log_dir}/*")
+    if logs.empty?
+      raise ArgumentError.new("No logs found in #{@log_dir}")
+    end
+    log_numbers = logs.map {|x| x.split("#{@created_log_name}").last}
+    latest_log_number = log_numbers.uniq.sort.first
+    return File.readlines("#{@log_dir}/#{@created_log_name}#{latest_log_number}")
+  end
+
+  # Arguments:
+  #   command: (string: system command)
+  def copy_example_files(command="cp")
+    time_stamp = Time.now.strftime("%Y%m%d%H%M")
+    puts("Setting up pipeline in #{@path}".yellow()) unless @no_output
+    example_files = get_all_example_files
     files_to_backup = example_files.map {|f| f.gsub(@extension, "")}.select {|file| File.exists?(file) }
+    # raise ArgumentError.new("#{files_to_backup.to_s} #{example_files.to_s}")
+
     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}"
+        full_command = "#{command} #{file_to_backup} #{file_to_backup}.backup#{time_stamp}"
         puts("\t#{full_command}") if @debug
         system(full_command)
       end
-    end        
+    end
 
     example_files.each do |example_file|
       target_file = example_file.gsub(@extension, "")
@@ -61,7 +90,13 @@ class FileManager
       full_command = "#{command} #{example_file} #{target_file}"
       puts("\t#{full_command}") if @debug
       system(full_command)
+
+      if File.exists?(target_file)
+        add_to_log(target_file, time_stamp)
+        puts("\t add #{target_file} to log #{get_log_name(time_stamp)}") if @debug
+      end
     end
+
   end
 
   # Arguments:
@@ -97,4 +132,13 @@ class FileManager
     end
   end
 
+  private
+    def get_log_name(date)
+      return "#{@log_dir}/#{@created_log_name}#{date}"
+    end
+
+    def add_to_log(line, date)
+      File.open(get_log_name(date), "a") {|file| file.write(line)}
+    end
+
 end

data/lib/nli_pipeline/setup_pipeline.rb

@@ -12,42 +12,111 @@ class SetupPipeline
   # Raises:
   #   ArgumentError if $1 is missing or is not a valid directory
 
-  def parse_args()
+  # commands available from setup_pipeline (hash of proc)
+  attr_reader :commands   
+  # custom error message for when dir is not provided as arg (string)
+  attr_reader :dir_error
+
+  # Set up class attributes
+  def initialize()
+    @commands = {
+      undo: Proc.new {|fm| fm.load_from_backup()}, 
+      show_last_created: Proc.new {|fm| puts(fm.get_last_created_files().to_s())}, 
+    }
+
+    @dir_error = "
+      The first argument to setup_pipeline must be a valid directory.
+      For example, setting up a pipeline in the current directory: 
+        
+        setup_pipeline $PWD
+      
+      The exceptions to this are:\n 
+        setup_pipeline --version
+        setup_pipeline --help
+        setup_pipeline --show-commands
+        setup_pipeline --show-flags
+    "
+  end
+
+  # simple formatter
+  def show_commands()
+    puts(@commands.keys)
+  end
+
+  # print help screen to console
+  def help(opts)
+    how_to_use = "HOW TO USE:\n
+      setup_pipeline $PWD
+      
+      #{opts}
+
+      other commands:\n
+      #{@commands.keys}
+
+    "
+
+    errors = "COMMON ERRORS:\n
+      #{@dir_error}
+    "
+
+    docs = "FOR MORE INFORMATION PLEASE READ THE DOCS:\n
+      on bitbucket:\t\thttps://bitbucket.org/nlireland/nli-pipeline-gem\n
+      or on ruby gems:\t\thttps://rubygems.org/gems/nli_pipeline\n
+    "
+
+    puts("#{how_to_use}\n#{errors}\n#{docs}")
+  end
+
+  # parse flags (and check if first argument if not valid directory)
+  def parse_flags()
     options = {}
     OptionParser.new do |opts|
-      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("--extension=[\w+]") do |v|
         options[:extension] = v
       end
       opts.on("--debug") do |v|
         options[:debug] = v
       end
+
+      # break out of function, don't throw exception about passing directory path
+      opts.on("-v", "--version") do |v|
+        puts NliPipeline::VERSION
+        return false
+      end
+      opts.on("--show-commands") do |v|
+        show_commands()
+        return false
+      end
+      opts.on("--show-flags") do |v|
+        puts(opts)
+        return false
+      end
+      opts.on("-h", "--help") do |v|
+        help(opts)
+        return false
+      end
     end.parse!
 
     if !ARGV[0] || !Dir.exist?(ARGV[0])
-      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"
-      exception = "The only exception to this is: setup_pipeline --version"
-      raise ArgumentError.new("\n\n#{error_message}\n#{example}\n#{exception}\n\n")
+      raise ArgumentError.new("\n\n#{@dir_error}\n\n")
     else 
       return [ARGV[0], options]
     end
   end
 
   # Method called by bin/setup_pipeline
-  # TODO: move undo arg handling to parse_args?
+  # Parse commands (command line arguments) and pass flags / flags to parse_flags
+  # TODO: move undo arg handling to parse_flags?
   def main()
-    args = parse_args()
-    if args
-      dir, options = args
+    flags = parse_flags()
+
+    if flags
+      dir, options = flags
       # pass options hash as keyword arguments
       fm = FileManager.new(dir, **options)
-      if ARGV[1] == "undo"
-        fm.load_from_backup()
+      command = ARGV[1].to_sym unless ARGV[1].nil? || ARGV[1].empty?
+      if @commands.keys.include?(command)
+        @commands[command].call(fm)
       else
         fm.copy_example_files()
       end

data/lib/nli_pipeline.rb

@@ -1,9 +1,10 @@
+# used to defined constants and include requirements for /bin/setup_pipeline
 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.1.1"
+  VERSION = "0.1.2"
 
   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.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Conor Sheehan
@@ -55,8 +55,10 @@ email: csheehan@nli.ie
 executables:
 - setup_pipeline
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- History.txt
 files:
+- History.txt
 - bin/setup_pipeline
 - lib/nli_pipeline.rb
 - lib/nli_pipeline/file_manager.rb