storazzo 0.5.1 → 0.6.1

data/lib/storazzo/media/abstract_ric_disk.rb

@@ -1,165 +1,194 @@
-module Storazzo::Media
-  class Storazzo::Media::AbstractRicDisk
-    # include Storazzo::Common
-    extend Storazzo::Common
-
-    # DefaultStatsFilename = Storazzo::RicDiskStatsFile.default_name
-
-    # looks like there's not Abstract Class in Ruby, but also SO says he best
-    # way to do this is this:
-
-    #    attr_accessor :name, :description, :ricdisk_file, :local_mountpoint, :wr, :path, :ricdisk_file_empty, :size, :active_dirs
-    attr_accessor :description
-
-    ########################
-    # Abstract methods START
-    ########################
-    def initialize(local_mount)
-      deb "[AbstractRicDisk.init()] Some child of AbstractRicDisk (#{self}) called me! Yummie." # disable when you dont need me anymore..
-      @description ||= "Not provided"
-      # validate
-    end
-
-    def self.list_all
-      raise "[AbstractRicDiskc::self.list_all] You should override this, says StackOverflow and Riccardo"
-    end
-
-    def self.list_all_with_type
-      raise "[AbstractRicDiskc::self.list_all_with_type] You should override this, says StackOverflow and Riccardo"
-    end
-
-    def self.super_duper_list_all_with_type
-      deb "Would be cool to be able to enumerate them all.."
-      GcsBucket.list_all_with_type +
-        MountPoint.list_all_with_type +
-        LocalFolder.list_all_with_type
-    end
-
-    def parse(opts = {})
-      raise "[AbstractRicDiskc::parse] You should override this, says StackOverflow and Riccardo"
-    end
-
-    def writeable?
-      raise "[AbstractRicDiskc::writeable] You should override this in #{self.class}, says StackOverflow and Riccardo"
-    end
-
-    def get_local_mountpoint
-      # raise "[AbstractRicDiskc::get_local_mountpoint] You should override this, says StackOverflow and Riccardo"
-      raise "You forgot to set local_mountpoint in the constructor for your class, you cheeky little one!" if local_mountpoint.nil?
-
-      local_mountpoint
-    end
-
-    def check_implemented_correctly
-      #            raise "[AbstractRicDiskc] You should override this, says StackOverflow and Riccardo"
-      raise "no @local_mountpoint" unless exists?(@local_mountpoint)
-    end
-    ########################
-    # Abstract methods END
-    ########################
-
-    ########################
-    # Automated methods now...
-    ########################
-    def stats_file_smart_fullpath # stats_file_default_location()
-      # if its writeable... if not we'll think about it later.
-      if writeable?
-        return "#{get_local_mountpoint}/#{self.default_stats_filename}"
-      else
-        # if not writeable, I will:
-        # 1. create a dir based on its unique format.
-        # 2. create a file of same look and feel (alternative - used a DASH)
-        return "TODO FIXME {get_local_folder}/#{unique_id}::#{self.default_stats_filename}"
-        # "{get_local_folder}"/#{unique_id}/#{Storazzo::RicDiskStatsFile.default_name}"
-      end
-    end
-
-    # Needs to be some unique id based on its thingy, but might change in the future:
-    # Solutions:
-    # {PHILOSOPHY}::{ID}
-    def unique_id
-      # Expand path to make it as unique as possible...
-      hash = Digest::MD5.hexdigest(File.expand_path(get_local_mountpoint))
-      "MD5::v1::#{hash}"
-    end
-
-    def to_s(verbose = false)
-      return to_verbose_s() if verbose
-
-      readable_class = self.class.to_s.split('::').last # Storazzo::Media::LocalFolder => LocalFolder
-      my_keys = self.instance_variables # wow!
-      "S:M:#{readable_class}(path=#{path}, r/w=#{wr}, keys=#{my_keys})"
-    end
-
-    def to_verbose_s
-      h = {}
-      h[:class] = self.class
-      h[:unique_id] = self.unique_id
-      h[:inspect] = self.inspect
-      h[:to_s] = self.to_s
-      h[:local_mountpoint] = local_mountpoint
-      h[:writeable] = self.writeable?
-      h[:stats_file_smart_fullpath] = stats_file_smart_fullpath
-      return h
-    end
-
-    # # Todo check on instances these 3 methods exist
-    def self.abstract_class_mandatory_methods
-      %W{
-        self.list_all
-        self.list_all_with_type
-        local_mountpoint
-        parse
-        writeable?
-      }
-    end
-
-    # Putting here since its same code for MountPoint or generic folder.
-    def parse_block_storage_folder(opts = {})
-      # Storazzo::RicDiskUgly.calculate_stats_files(get_local_mountpoint)
-      rd = Storazzo::RicDisk.new(self)
-      # Storazzo::RicDisk
-      rd.compute_stats_files(opts)
-      # return "42"
-    end
-
-    def self.default_stats_filename
-      raise "Unknown Storazzo::RicDiskStatsFile.default_name  1!!" if Storazzo::RicDiskStatsFile.default_name.nil?
-
-      Storazzo::RicDiskStatsFile.default_name
-    end
-
-    def stats_filename_default_fullpath # if not writeable we need to pick another from stats_file_smart_fullpath()
-      # REDUNDANT, should use stats_file_smart_fullpath instead except on the writeable? part since it would go recursive otherwise.
-      my_stats_filename = self.default_stats_filename
-      # raise "Unknown Storazzo::RicDiskStatsFile.default_name 2 !!" if Storazzo::RicDiskStatsFile.default_name.nil?
-      "#{local_mountpoint}/#{my_stats_filename}"
-    end
-
-    def validate(opts = {})
-      verbose = opts.fetch(:verbose, true)
-      puts "[VERBOSE] validate(): We're trying to see if your object is valid, across 3 possible sub-classes." if verbose
-      # 1. check for
-      raise "Unknown local mount " unless local_mount.is_a?(String)
-
-      # 2. check thaty writeable? is true or false
-      my_writeable = wr
-      raise "Writeable is not boolean" unless (my_writeable.is_a? TrueClass or my_writeable.is_a? FalseClass)
-    end
-
-    # TODO use a proper Factory pattern.
-    def self.DirFactory(path)
-      raise "I need a path/directory string: #{path}" unless path.is_a?(String)
-
-      deb "TODO: if coincides with MountPoint, instance THAT"
-      # if path in Storazzo::Media::MountPoint.list_all_mount_points
-      # then return ...
-      if path =~ /^gs:\/\//
-        deb "Smells like GCS"
-        return GcsBucket.new(path)
+# frozen_string_literal: true
+
+# require "storazzo/ric_disk/abstract_ric_disk"
+# require "storazzo/ric_disk/gcs_bucket"
+# require "gcs_bucket"
+# require "abstract_ric_disk"
+
+#  This class is an Abstract Class which forces its 3 inquilines to implement
+#  a number of functions, namely:
+#
+#    def self.list_all()
+#    def self.list_all_with_type()
+#
+#   Note this needs to work without weird overrides, like:
+#
+#      def self.list_all_with_type(config=nil) # BAD
+#      def self.list_all_with_type()           # GOOD
+#
+#
+
+module Storazzo
+  module Media
+    module Storazzo
+      module Media
+        class AbstractRicDisk
+          # include Storazzo::Common
+          extend Storazzo::Common
+
+          # DefaultStatsFilename = Storazzo::RicDiskStatsFile.default_name
+
+          # looks like there's not Abstract Class in Ruby, but also SO says he best
+          # way to do this is this:
+
+          #    attr_accessor :name, :description, :ricdisk_file, :local_mountpoint, :wr, :path, :ricdisk_file_empty, :size, :active_dirs
+          attr_accessor :description
+
+          ########################
+          # Abstract methods START
+          ########################
+          def initialize(_local_mount)
+            deb "[AbstractRicDisk.init()] Some child of AbstractRicDisk (#{self}) called me! Yummie." # disable when you dont need me anymore..
+            @description ||= 'Not provided'
+            # validate
+          end
+
+          def self.list_all
+            raise "[AbstractRicDiskc::self.list_all] You should override this, says StackOverflow and Riccardo. Class=#{self.class}. Self=#{self}"
+          end
+
+          def self.list_all_with_type
+            raise "[AbstractRicDisk::self.list_all_with_type] You should override this, says StackOverflow and Riccardo. Class=#{self.class}. Self=#{self}"
+          end
+
+          def self.super_duper_list_all_with_type
+            deb 'Would be cool to be able to enumerate them all..'
+            GcsBucket.list_all_with_type +
+              MountPoint.list_all_with_type +
+              LocalFolder.list_all_with_type
+          end
+
+          def parse(_opts = {})
+            raise "[AbstractRicDiskc::parse] You should override this, says StackOverflow and Riccardo. Class=#{self.class}."
+          end
+
+          def writeable?
+            raise "[AbstractRicDiskc::writeable] You should override this in class=#{self.class}, says StackOverflow and Riccardo"
+          end
+
+          def get_local_mountpoint
+            # raise "[AbstractRicDiskc::get_local_mountpoint] You should override this, says StackOverflow and Riccardo"
+            raise 'You forgot to set local_mountpoint in the constructor for your class, you cheeky little one!' if local_mountpoint.nil?
+
+            local_mountpoint
+          end
+
+          def check_implemented_correctly
+            #            raise "[AbstractRicDiskc] You should override this, says StackOverflow and Riccardo"
+            raise 'no @local_mountpoint' unless exists?(@local_mountpoint)
+          end
+          ########################
+          # Abstract methods END
+          ########################
+
+          ########################
+          # Automated methods now...
+          ########################
+          # stats_file_default_location()
+          def stats_file_smart_fullpath
+            # if its writeable... if not we'll think about it later.
+            if writeable?
+              "#{get_local_mountpoint}/#{default_stats_filename}"
+            else
+              # if not writeable, I will:
+              # 1. create a dir based on its unique format.
+              # 2. create a file of same look and feel (alternative - used a DASH)
+              "TODO FIXME {get_local_folder}/#{unique_id}::#{default_stats_filename}"
+              # "{get_local_folder}"/#{unique_id}/#{Storazzo::RicDiskStatsFile.default_name}"
+            end
+          end
+
+          # Needs to be some unique id based on its thingy, but might change in the future:
+          # Solutions:
+          # {PHILOSOPHY}::{ID}
+          def unique_id
+            # Expand path to make it as unique as possible...
+            hash = Digest::MD5.hexdigest(File.expand_path(get_local_mountpoint))
+            "MD5::v1::#{hash}"
+          end
+
+          def to_s(verbose = false)
+            return to_verbose_s if verbose
+
+            readable_class = self.class.to_s.split('::').last # Storazzo::Media::LocalFolder => LocalFolder
+            my_keys = instance_variables # wow!
+            "S:M:#{readable_class}(path=#{path}, r/w=#{wr}, keys=#{my_keys})"
+          end
+
+          def to_verbose_s
+            h = {}
+            h[:class] = self.class
+            h[:unique_id] = unique_id
+            h[:inspect] = inspect
+            h[:to_s] = to_s
+            h[:local_mountpoint] = local_mountpoint
+            h[:writeable] = writeable?
+            h[:stats_file_smart_fullpath] = stats_file_smart_fullpath
+            h
+          end
+
+          # # Todo check on instances these 3 methods exist
+          def self.abstract_class_mandatory_methods
+            %w[
+              self.list_all
+              self.list_all_with_type
+              local_mountpoint
+              parse
+              writeable?
+            ]
+          end
+
+          # Putting here since its same code for MountPoint or generic folder.
+          def parse_block_storage_folder(opts = {})
+            # Storazzo::RicDiskUgly.calculate_stats_files(get_local_mountpoint)
+            rd = Storazzo::RicDisk.new(self)
+            # Storazzo::RicDisk
+            rd.compute_stats_files(opts)
+            # return "42"
+          end
+
+          def self.default_stats_filename
+            raise 'Unknown Storazzo::RicDiskStatsFile.default_name  1!!' if Storazzo::RicDiskStatsFile.default_name.nil?
+
+            Storazzo::RicDiskStatsFile.default_name
+          end
+
+          # if not writeable we need to pick another from stats_file_smart_fullpath()
+          def stats_filename_default_fullpath
+            # REDUNDANT, should use stats_file_smart_fullpath instead except on the writeable? part since it would go recursive otherwise.
+            my_stats_filename = default_stats_filename
+            # raise "Unknown Storazzo::RicDiskStatsFile.default_name 2 !!" if Storazzo::RicDiskStatsFile.default_name.nil?
+            "#{local_mountpoint}/#{my_stats_filename}"
+          end
+
+          def validate(opts = {})
+            opt_verbose = opts.fetch :verbose, false
+            pverbose opt_verbose,
+                     "validate(): [BROKEN] We're trying to see if your object is valid, across 3 possible sub-classes."
+            # 1. check for
+            raise 'Unknown local mount ' unless local_mount.is_a?(String)
+
+            # 2. check thaty writeable? is true or false
+            my_writeable = wr
+            raise 'Writeable is not boolean' unless my_writeable.is_a?(TrueClass) || my_writeable.is_a?(FalseClass)
+          end
+
+          # TODO: use a proper Factory pattern.
+          def self.DirFactory(path)
+            raise "I need a path/directory string: #{path}" unless path.is_a?(String)
+
+            deb 'TODO: if coincides with MountPoint, instance THAT'
+            # if path in Storazzo::Media::MountPoint.list_all_mount_points
+            # then return ...
+            if path =~ %r{^gs://}
+              deb 'Smells like GCS'
+              return GcsBucket.new(path)
+            end
+            deb 'Smells like LocalFolder :)'
+            LocalFolder.new(path)
+          end
+        end
       end
-      deb "Smells like LocalFolder :)"
-      return LocalFolder.new(path)
     end
   end
 end

data/lib/storazzo/media/gcs_bucket.rb

@@ -1,58 +1,89 @@
-module Storazzo::Media
-  class Storazzo::RicDisk::GcsBucket
-    extend Storazzo::Common
+# frozen_string_literal: true
 
-    attr_accessor :project_id
+require 'English'
 
-    def initialize(local_mount, project_id = nil)
-      deb "[Storazzo::Media::GcsBucket] initialize"
+module Storazzo
+  module Media
+    #  class Storazzo::Media::AbstractRicDisk
+    module Storazzo
+      module Media
+        class GcsBucket < Storazzo::Media::AbstractRicDisk
+          extend Storazzo::Common
 
-      @local_mountpoint = File.expand_path(local_mount)
-      @description = "MountPoint in '#{local_mount}' pointing at TODO with mount options = TODO"
-      @project_id = project_id
-      raise "Sorry local mount doesnt exist!" unless File.exist?(@local_mountpoint)
+          attr_accessor :project_id
 
-      @wr = writeable? # File.writable?(stats_filename_default_fullpath) # .writeable? stats_file_smart_fullpath
-      super(local_mount) rescue "SUPER_ERROR(#{local_mount}): #{$!}"
-    end
+          def initialize(local_mount, project_id = nil)
+            deb '[Storazzo::Media::GcsBucket] initialize'
 
-    def self.list_all(config = nil)
-      # get lisrts from Config singletone
-      # puts " self.list_all: loading config "
-      config ||= Storazzo::RicDiskConfig.instance # # ).get_config
-
-      config.load # in case I need to load it for the first time
-      # puts config['Config']['AdditionalMountDirs']
-      # puts "TODO see config: #{config}"
-      # [42, 43]
-      # deb config.get_local_folders
-      # TODO
-      pverbose true,
-               "TODO(ricc): also add gsutil ls. For that please use the new 'list_all_with_type' (Id refactor it but Im afraid of leaving bad code dangling so before a proper refactor lets implement both side by side"
-      config.get_bucket_paths
-    end
+            @local_mountpoint = File.expand_path(local_mount)
+            @description = "MountPoint in '#{local_mount}' pointing at TODO with mount options = TODO"
+            project_id ||= _autodetect_project_id
+            @project_id = project_id
+            raise 'Sorry local mount doesnt exist!' unless File.exist?(@local_mountpoint)
 
-    def self.list_all_with_type(config = nil)
-      config ||= Storazzo::RicDiskConfig.instance
-      config.load # in case I need to load it for the first time
-      deb "TODO(ricc): also add gsutil ls"
-      # getFromConfig
-      deb "I'm now returning a 'complex' array to tell the caller what kind of element they're getting, eg: GCS from Config Yaml, vs GCS from gsutil ls "
-      list_from_config_with_type = config.get_bucket_paths.map { |path| [:config_gcs_bucket, path] }
-      if (config.project_id)
-        # so I concatenate Apples with Bananas with names
-        return list_from_config_with_type + list_available_buckets(config.project_id).map { |path|
-                                              [:gsutil_ls_gcs_bucket, path]
-                                            }
-      end
+            @wr = writeable? # File.writable?(stats_filename_default_fullpath) # .writeable? stats_file_smart_fullpath
+            begin
+              super(local_mount)
+            rescue StandardError
+              "SUPER_ERROR(#{local_mount}): #{$ERROR_INFO}"
+            end
+          end
 
-      return list_from_config_with_type
-    end
+          def _autodetect_project_id
+            'todo-my-project-id-123' # TODO: fix
+          end
+
+          # (config = nil)
+          def self.list_all
+            # get lisrts from Config singletone
+            # puts " self.list_all: loading config "
+            config ||= Storazzo::RicDiskConfig.instance # # ).get_config
 
-    def self.list_available_buckets(project_id, opts = {})
-      list_of_buckets = `gsutil ls --project '#{project_id}'`.chomp.split("\n")
-      deb "list_of_buckets: #{list_of_buckets}"
-      list_of_buckets
+            config.load # in case I need to load it for the first time
+            # puts config['Config']['AdditionalMountDirs']
+            # puts "TODO see config: #{config}"
+            # [42, 43]
+            # deb config.get_local_folders
+            # TODO
+            pverbose true,
+                     "TODO(ricc): also add gsutil ls. For that please use the new 'list_all_with_type' (Id refactor it but Im afraid of leaving bad code dangling so before a proper refactor lets implement both side by side"
+            config.get_bucket_paths
+          end
+
+          # (config = nil)
+          def self.list_all_with_type
+            deb 'GCS::list_all_with_type() -- pull config'
+            config ||= Storazzo::RicDiskConfig.instance
+            config.load # in case I need to load it for the first time
+            # puts "GCS::list_all_with_type() -- TODO(ricc): also add gsutil ls"
+            # getFromConfig
+            deb "I'm now returning a 'complex' array to tell the caller what kind of element they're getting, eg: GCS from Config Yaml, vs GCS from gsutil ls "
+            list_from_config_with_type = config.get_bucket_paths.map do |path|
+              [:config_gcs_bucket, path]
+            end
+            ret_list = list_from_config_with_type
+            if config.gcs_enabled? # should be if GCS enabled :) project_id
+              # so I concatenate Apples with Bananas with names
+              # ret_list += list_available_buckets(config.project_id).map { |path|
+              ret_list += list_available_buckets.map do |path|
+                [:gsutil_ls_gcs_bucket, path]
+              end
+            else
+              deb 'list_all_with_type(): empty project id. Skipping'
+            end
+
+            ret_list
+          end
+
+          def self.list_available_buckets(_opts = {})
+            # project_id = opts.fetch :project_id, nil
+            # list_of_buckets = `gsutil ls --project '#{project_id}'`.chomp.split("\n")
+            list_of_buckets = `gsutil ls`.chomp.split("\n")
+            deb "list_of_buckets: #{list_of_buckets}"
+            list_of_buckets
+          end
+        end
+      end
     end
   end
 end

data/lib/storazzo/media/local_folder.rb

@@ -1,48 +1,62 @@
+# frozen_string_literal: true
+
 # require "storazzo/ric_disk/abstract_ric_disk"
 # require "abstract_ric_disk"
 
-module Storazzo::Media
-  class Storazzo::Media::LocalFolder < Storazzo::Media::AbstractRicDisk
-    # extend Storazzo::Common
-    include Storazzo::Common
-
-    attr_accessor :local_mountpoint, :wr
-
-    def initialize(local_mount)
-      deb "[Storazzo::Media::LocalFolder] initialize"
-
-      @local_mountpoint = File.expand_path(local_mount)
-      @description = "Local Folder originally in '#{local_mount}'"
-      raise "Sorry local mount doesnt exist!" unless File.exist?(@local_mountpoint)
-
-      @wr = writeable? # File.writable?(stats_filename_default_fullpath) # .writeable? stats_file_smart_fullpath
-      # super.initialize(local_mount) rescue "SUPER_ERROR: #{$!}"
-      super(local_mount) rescue "SUPER_ERROR(#{local_mount}): #{$!}"
-    end
-
-    def self.list_all(config = nil)
-      # get lists from Config singleton
-      config ||= Storazzo::RicDiskConfig.instance # # ).get_config
-      config.load
-      config.get_local_folders
-    end
-
-    def parse(opts = {})
-      puts "LF.parse(#{opts}): TODO Sbrodola inside the dir: #{local_mountpoint}"
-      parse_block_storage_folder()
-    end
-
-    def path
-      @local_mountpoint
-    end
-
-    def writeable?
-      File.writable?(@local_mountpoint)
-    end
-
-    def default_stats_filename
-      # '42'
-      Storazzo::RicDiskStatsFile.default_name
+require 'English'
+module Storazzo
+  module Media
+    module Storazzo
+      module Media
+        class LocalFolder < Storazzo::Media::AbstractRicDisk
+          # extend Storazzo::Common
+          include Storazzo::Common
+
+          attr_accessor :local_mountpoint, :wr
+
+          def initialize(local_mount)
+            deb '[Storazzo::Media::LocalFolder] initialize'
+
+            @local_mountpoint = File.expand_path(local_mount)
+            @description = "Local Folder originally in '#{local_mount}'"
+            raise 'Sorry local mount doesnt exist!' unless File.exist?(@local_mountpoint)
+
+            @wr = writeable? # File.writable?(stats_filename_default_fullpath) # .writeable? stats_file_smart_fullpath
+            # super.initialize(local_mount) rescue "SUPER_ERROR: #{$!}"
+            begin
+              super(local_mount)
+            rescue StandardError
+              "SUPER_ERROR(#{local_mount}): #{$ERROR_INFO}"
+            end
+          end
+
+          # WRONG: config = nil
+          def self.list_all
+            # get lists from Config singleton
+            config = Storazzo::RicDiskConfig.instance # # ).get_config
+            config.load
+            config.get_local_folders
+          end
+
+          def parse(opts = {})
+            puts "LF.parse(#{opts}): TODO Sbrodola inside the dir: #{local_mountpoint}"
+            parse_block_storage_folder
+          end
+
+          def path
+            @local_mountpoint
+          end
+
+          def writeable?
+            File.writable?(@local_mountpoint)
+          end
+
+          def default_stats_filename
+            # '42'
+            Storazzo::RicDiskStatsFile.default_name
+          end
+        end
+      end
     end
   end
 end

data/lib/storazzo/media/mount_point.rb

@@ -1,11 +1,27 @@
+# frozen_string_literal: true
+
 # TODO
-module Storazzo::Media
-  class Storazzo::Media::MountPoint < Storazzo::Media::AbstractRicDisk
-    # puts "[REMOVEME] Storazzo::Media::MountPoint being read. REMOVEME when you see this :)"
+module Storazzo
+  module Media
+    module Storazzo
+      module Media
+        class MountPoint < Storazzo::Media::AbstractRicDisk
+          # puts "[REMOVEME] Storazzo::Media::MountPoint being read. REMOVEME when you see this :)"
+
+          def self.list_local_mount_points
+            deb 'Maybe its abuot time you refactor that method here :)'
+            RicDisk.interesting_mount_points
+          end
+
+          def self.list_all
+            RicDisk.interesting_mount_points
+          end
 
-    def self.list_local_mount_points()
-      deb "Maybe its abuot time you refactor that method here :)"
-      RicDisk.interesting_mount_points()
+          def self.list_all_with_type
+            list_all.map { |x| [:mount_point_todo_less_generic, x] }
+          end
+        end
+      end
     end
   end
 end