storazzo 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a489f7c8e545a123a224850369894e939e8bc541ca2b00ce4f2306493144ec2
-  data.tar.gz: 35f76e4a92849cb0547910ac8f240b38dda4cecaf70ceec0b6d665d6d5d3ce5f
+  metadata.gz: aa13f66b7bfcdf56a065b666c4a256be432bfa8dab74e39eca9b3d6029a7a4a9
+  data.tar.gz: 4efc1c0086cf9a9ad710e47d1ee9e0559d0d3597a79ca21381687f15d0abe163
 SHA512:
-  metadata.gz: 3d69dbf50b340e06833ba28cf4219ee6aca33b5466e442377597c825ae0c2adaef2d8be3b4330adee8dde52d693e84f3f69c5208df767e988268f45359e36f27
-  data.tar.gz: ef9ce00d9af13c84aa2db03996ea383af7494007a2bdd94f799d4720d2cc2aae63106e7bbf74db555c6574180f3948305712d115f757f07a196d96958da74ef5
+  metadata.gz: 02fa0fcdbad9284bb5c26dd1fd284c0c32aee90c317148c981cb8c983346f4e4e093d9a941145a6717f27df23681566c9435e0f5a9a237d3b5e3e5e221a35d44
+  data.tar.gz: 43825ffe96f30ec8e9581f7ef25fc08d36e9636d0cf013bfec7611727d19dd699920a12cf068e516f9eaef78826984310072977af01f740d28b6810dd44cd734

data/Gemfile

@@ -1,7 +1,10 @@
-# useless now
-
+source "https://rubygems.org"
 
 # to troubleshoot/debug things
-#gem 'rubocop'
+gem 'rubocop'
+gem "ruby-lsp", "~> 0.0.4", :group => :development
 gem 'rake'
-gem 'pry'
+# gem 'pry'
+gem 'pry', :group => :development
+# gem 'require_all' # yup I'm lazy: https://stackoverflow.com/questions/735073/best-way-to-require-all-files-from-a-directory-in-ruby
+# gem 'after_do' # To allow AFTER calling instance to do LOAD() automagically. Naah I can do without :)

data/Makefile

@@ -51,4 +51,23 @@ watch-test:
 	watch -c make test
 
 test-gcs-bucket:
-	ruby -I test test/test_gcs_bucket.rb
+	#echo "Warning this uses the INCLUDED gem not the latest one in development'
+	#ruby -I test test/media/test_gcs_bucket.rb
+	rake test TEST=test/media/test_gcs_bucket.rb
+
+test-local-folder:
+	echo "Warning this uses the INCLUDED gem not the latest one in development'
+	ruby -I test test/media/test_local_folder.rb
+# https://medium.com/@tegon/quick-guide-to-minitest-arguments-745bf9fe4b3
+test-media-subfolder:
+	rake test TEST="test/media/*.rb"
+test-verbose:
+	rake test:verbose --verbose 
+test-single-file-continuously:
+	\watch -n 5 --color rake test TEST="test/media/test_local_folder.rb"
+
+test-binary-with-local-gem:
+	ruby -Ilib bin/hello-storazzo
+test-binary-with-system-gem:
+	bin/hello-storazzo
+	

data/README.md

@@ -9,6 +9,29 @@
 
 (Latest version is hosted in https://rubygems.org/gems/storazzo)
 
+# Tests
+
+I still struggle to enforce the include of LOCAL unchecked code rather than latest required system gem (cmon Ruby!)
+but I found loads of interesting ways to test my code by googling and StoackOverflowing:
+
+* `rake test TEST="test/sum_test.rb"`
+* test-gcs-bucket: `ruby -I test test/test_gcs_bucket.rb` (meh - see below)
+* test-media-subfolder: `rake test TEST="test/media/*.rb"`
+
+Single test in single file:
+
+* `rake test TEST="test/sum_test.rb" TESTOPTS="--name=test_returns_two"` (sample)
+* `rake test TEST="test/media/test_local_folder.rb" TESTOPTS="--name=test_1_first_directory_parsing_actually_works"`
+* `ruby -I test test/test_local_folder.rb -n test_first_directory_parsing_actually_works` (note this includes `storazzo` latest gem 
+    and doesnt benefit from LATEST code so its NOT good for testing: use RAKE for that).
+
+**Testing binary files** is hard: by default they 'require storazzo' and use the GEM INSTALLed version which is a few versions away, usually.
+So while developing you might want to include the lib/ folder, like this:
+
+* Use local gem (super latest) for checking latest code: `ruby -Ilib bin/hello-storazzo`
+* This will use the gem installed a few days ago, likely so wont do you any good to test latest code: `bin/hello-storazzo`
+
+Now to toggle verbosity I believe I need to go into Rakefile (bummer)
 # Thanks
 
 Inspiration from:

data/Rakefile

@@ -1,17 +1,44 @@
-#require 'rake'
+# require 'rake'
 
 # from hola: https://guides.rubygems.org/make-your-own-gem/#adding-an-executable
 require "rake/testtask"
 
-Rake::TestTask.new do |t|
+desc "Run Unit tests"
+Rake::TestTask.new(:test) do |t|
   t.libs << "test"
+  t.libs << "test/media"
+  # note this is only useful for this: https://chriskottom.com/articles/command-line-flags-for-minitest-in-the-raw/
   t.verbose = false
-  t.warning = false 
+  t.warning = false
+  # puts "[RiccardoOnly]: t.pattern: #{t.pattern}"
+  t.pattern = 'test/**/test_*.rb'
 end
 
-desc "Run tests"
+desc "By default, Run Unit tests"
 task default: :test
 
+# Adding test/media directory to rake test.
+desc "Test tests/media/* code sobenem"
+namespace :test do
+  desc "Test Verbosely by default since I'm too stupid to toggle via ENV var dammit"
+  Rake::TestTask.new(:verbose) do |t|
+    t.libs << "test"
+    t.libs << "test/media"
+    t.verbose = true
+    t.warning = true
+    t.pattern = 'test/**/test_*.rb'
+    $DEBUG = true
+  end
+end
+# namespace :verbose_test do
+#   desc "Test tests/media/* code"
+#   Rake::TestTask.new do |t|
+#     t.libs << "test/media"
+#     # Rails::TestTask.new(media: 'test:prepare') do |t|
+#     t.pattern = 'test/**/test_*.rb'
+#   end
+# end
+# Rake::Task['test:run'].enhance ["test:media"]
 
 # begin
 #     require 'bundler/setup'
@@ -19,14 +46,14 @@ task default: :test
 #   rescue LoadError
 #     puts 'although not required, bundler is recommended for running the tests'
 #   end
-  
+
 #   task default: :spec
-  
+
 #   require 'rspec/core/rake_task'
 #   RSpec::Core::RakeTask.new(:spec)
-  
+
 #   require 'rubocop/rake_task'
 #   RuboCop::RakeTask.new do |task|
 #     task.requires << 'rubocop-performance'
 #     task.requires << 'rubocop-rspec'
-#   end
+#   end

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.5.0

data/bin/hello-storazzo

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'storazzo'
+
+Storazzo::Main.say_hi(ARGV[0])

data/bin/ricdisk-magic

@@ -1,39 +1,35 @@
 #!/usr/bin/env ruby
 
-
-
-############# ############# ############# ############# ############# ############# ############# ############# 
+############# ############# ############# ############# ############# ############# ############# #############
 # placeholder until i make it work..
 # https://guides.rubygems.org/make-your-own-gem/#adding-an-executable
-#require 'storazzo'
-#require_relative '../lib/storazzo'
+# require 'storazzo'
+# require_relative '../lib/storazzo'
 require 'fileutils'
 require 'yaml'
 require 'socket'
-require 'optparse'       # http://ruby.about.com/od/advancedruby/a/optionparser.htm
+require 'optparse' # http://ruby.about.com/od/advancedruby/a/optionparser.htm
 
 # Including local gem.
-#puts File.expand_path(FileUtils.pwd, "/../")
-#local_gem_path = File.expand_path(FileUtils.pwd, "/../")
-#gem 'storazzo', path: local_gem_path
+# puts File.expand_path(FileUtils.pwd, "/../")
+# local_gem_path = File.expand_path(FileUtils.pwd, "/../")
+# gem 'storazzo', path: local_gem_path
 require 'storazzo'
-#include Storazzo
-#include Storazzo::Colors
+# include Storazzo
+# include Storazzo::Colors
 extend Storazzo::Colors
-include Storazzo::Common #instead
-
-
-#puts "First I need to figure out how to bring in all the libraries in here.."
-#Storazzo::Main.say_hi("ARGV is: #{ ARGV.join ', '}")
-#puts Storazzo.version
-############# ############# ############# ############# ############# ############# ############# ############# 
+include Storazzo::Common # instead
 
+# puts "First I need to figure out how to bring in all the libraries in here.."
+# Storazzo::Main.say_hi("ARGV is: #{ ARGV.join ', '}")
+# puts Storazzo.version
+############# ############# ############# ############# ############# ############# ############# #############
 
 # I believe this is wrong
-#require 'storazzo'
+# require 'storazzo'
 # required to have methods wiothout self.
-#include 'lib/ric_disk'
-#extend Storazzo::Colors
+# include 'lib/ric_disk'
+# extend Storazzo::Colors
 
 if RUBY_VERSION.split('.')[0] == 1
   puts "Refusing to launch a script form Ruby 1. Sorry Ric, its 2020 damn it!"
@@ -41,7 +37,7 @@ if RUBY_VERSION.split('.')[0] == 1
 end
 
 $PROG_VER = '0.4'
-$DEBUG    = ENV['DEBUG'] == 'true'  # (true/false)
+$DEBUG    = ENV['DEBUG'] == 'true' # (true/false)
 # p ENV['DEBUG']
 # p $DEBUG
 
@@ -65,24 +61,24 @@ BIG_LONG_MULTILINE
 
 =end
 
-
 $myconf = {
-    :app_name            => "RicDisk Magic should be sth like #{$0}",
-    :description         => "
+  :app_name => "RicDisk Magic should be sth like #{$0}",
+  :description => "
         This program is loosely inspired to ricdisk-magic.sh but its much better.
-        The idea is: iterate through all ARGV elements and build a DB of all files with length and MD5. 
+        The idea is: iterate through all ARGV elements and build a DB of all files with length and MD5.
         Then if folder is writeable, put this list INSIDE IT as its so conveniente.
-        If not, put in a ENV-var-defined folder which defaults to ./.storazzo/ :) 
-        
+        If not, put in a ENV-var-defined folder which defaults to ./.storazzo/ :)
+
         And maybe someday - add a nice protobuf and an entity in lib/.
 
         Note. This software is part of the Storazzo gem ('sai chi ti saluta un casino?'):
 
             $ gem install storazzo
     ".strip.gsub(/^\s+/, "").gsub(/\s+$/, ""),
-    # TODO move to some class default
-    :media_dirs  => %w{ /media/riccardo/ /Volumes/ /mnt/ ~/git/storazzo/var/test/ /sobenme/giusto/per/imparare/ad/ammutolire/gli/errori/ }, 
-    :mount_types => %w{ vfat ntfs }, 
+  # TODO move to some class default
+  :media_dirs => %w{/media/riccardo/ /Volumes/ /mnt/ ~/git/storazzo/var/test/
+                    /sobenme/giusto/per/imparare/ad/ammutolire/gli/errori/},
+  :mount_types => %w{vfat ntfs},
 }
 $stats_file = "ricdisk_stats_v11.rds" # => RicDiskStatsFile
 $gcs_bucket = 'TODO-CHANGE-CONFIG-palladius'
@@ -92,18 +88,17 @@ $gcs_bucket = 'TODO-CHANGE-CONFIG-palladius'
 # 2022-04-26 2.1.0  Historical momemnt: removed gem 'ric' dependency
 $TEMPLATE_VER = '2.1.1'
 
-
-def usage(comment=nil)
+def usage(comment = nil)
   puts white($optparse.banner)
   puts($optparse.summarize)
   puts("Description: " + gray($myconf[:description]))
   puts red(comment) if comment
-  #puts "Description: #{ $myconf[:description] }"
+  # puts "Description: #{ $myconf[:description] }"
   exit 13
 end
 
 # include it in main if you want a custome one
-def init()    # see lib_autoinit in lib/util.rb
+def init() # see lib_autoinit in lib/util.rb
   $opts = {}
   # setting defaults
   $opts[:verbose] = false
@@ -113,19 +108,19 @@ def init()    # see lib_autoinit in lib/util.rb
 
   $optparse = OptionParser.new do |opts|
     opts.banner = "#{$0} v.#{$PROG_VER}\n Usage: #{File.basename $0} [options] file1 file2 ..."
-    opts.on( '-d', '--debug', 'enables debug (DFLT=false)' )  {  $opts[:debug] = true ; $DEBUG = true }
-    opts.on( '-f', '--force', 'force stuff (DFLT=false)' )  {  $opts[:force] = true  }
-    opts.on( '-h', '--help', 'Display this screen' )          {  usage }
-    #opts.on( '-j', '--jabba', 'Activates my Jabber powerful CLI' ) {  $opts[:jabba] = true  }
-    opts.on( '-n', '--dryrun', "Don't really execute code" ) { $opts[:dryrun] = true }
-    opts.on( '-l', '--logfile FILE', 'Write log to FILE' )    {|file| $opts[:logfile] = file }
-    opts.on( '-v', '--verbose', 'Output more information' )   { $opts[:verbose] = true}
+    opts.on('-d', '--debug', 'enables debug (DFLT=false)') { $opts[:debug] = true; $DEBUG = true }
+    opts.on('-f', '--force', 'force stuff (DFLT=false)') { $opts[:force] = true }
+    opts.on('-h', '--help', 'Display this screen') { usage }
+    # opts.on( '-j', '--jabba', 'Activates my Jabber powerful CLI' ) {  $opts[:jabba] = true  }
+    opts.on('-n', '--dryrun', "Don't really execute code") { $opts[:dryrun] = true }
+    opts.on('-l', '--logfile FILE', 'Write log to FILE')    { |file| $opts[:logfile] = file }
+    opts.on('-v', '--verbose', 'Output more information')   { $opts[:verbose] = true }
   end
   $optparse.parse!
 end
 
 def real_program
-  deb("Hello world from a templated '#{yellow $0 }'")
+  deb("Hello world from a templated '#{yellow $0}'")
   deb "+ Options are:  #{gray $opts}"
   deb "+ Depured args: #{azure ARGV}"
   deb "+ Script-specifig super-cool conf: #{green $prog_conf_d}"
@@ -133,51 +128,49 @@ def real_program
 
   # Your code goes here...
   puts white("Hello world from #{$myconf[:app_name]}!")
-  puts "Description: '''#{white $myconf[:description] }'''"
+  puts "Description: '''#{white $myconf[:description]}'''"
 
-  config =     Storazzo::RicDiskConfig.instance()
+  config = Storazzo::RicDiskConfig.instance()
   config.load
   puts "StorazzoConfig: #{config}"
-  #config.load # auto_sbrodola(ARGV)
+  # config.load # auto_sbrodola(ARGV)
   puts yellow("ARGV: #{ARGV}")
   config.iterate_through_file_list_for_disks(ARGV)
 
   # if ARGV == [] # empty -> ALL
   #   dirs = RicDisk.find_active_dirs()
-  #   dirs.each {|dir| 
+  #   dirs.each {|dir|
   #     RicDisk.sbrodola_ricdisk(dir)
   #     RicDisk.calculate_stats_files(dir) # dir is inutile
   #   } # TODO refactor in option sbrodola_afterwards=true. :)
   # else
   #   deb "I consider ARGV come la lista di directories da parsare :)"
   #   dirs = RicDisk.find_active_dirs()
-  #   ARGV.each{ |dir| 
+  #   ARGV.each{ |dir|
   #     dir = File.expand_path(dir)
   #     if dirs.include?(dir)
   #       deb "Legit dir: #{green dir}"
   #       RicDisk.sbrodola_ricdisk(dir)
   #       RicDisk.calculate_stats_files(dir) # dir is inutile
   #     else
-  #       deb "Figghiu ri buttana: doesnt exist #{red dir}" 
+  #       deb "Figghiu ri buttana: doesnt exist #{red dir}"
   #     end
   #   }
   # end #/if aRGV
-
 end
 
 def main(filename)
   deb "I'm called by #{white filename}"
   deb "HISTORY: #{gray HISTORY}"
-  #deb "To remove this shit, just set $DEBUG=false :)"
-  init        # Enable this to have command line parsing capabilities!
-  puts white("$DEBUG is #{$DEBUG }. Tu turn on, call me with -d") unless $DEBUG
-  #warn "[warn] template v#{$TEMPLATE_VER }: proviamo il warn che magari depreca il DEB"
+  init # Enable this to have command line parsing capabilities!
+  puts white("$DEBUG is #{$DEBUG}. Tu turn on, call me with -d") unless $DEBUG
+  # warn "[warn] template v#{$TEMPLATE_VER }: proviamo il warn che magari depreca il DEB"
   real_program
 
-  if ($DEBUG) 
+  if ($DEBUG)
     puts "First I need to figure out how to bring in all the libraries in here.."
-    Storazzo::Main.say_hi("ARGV is: #{ ARGV.join ', '}")
-    puts Storazzo.version  
+    Storazzo::Main.say_hi("ARGV is: #{ARGV.join ', '}")
+    puts Storazzo.version
   end
 end