Module: Eco::Data::Files::ClassMethods

Includes:
Encoding
Included in:
Eco::Data::Files
Defined in:
lib/eco/data/files/helpers.rb

Constant Summary

Constants included from Encoding

Encoding::BOM_BYTES

Instance Attribute Summary

Attributes included from Language::AuxiliarLogger

#logger

Instance Method Summary collapse

Methods included from Encoding

#encoding, #get_file_content_with_encoding, #has_bom?, #remove_bom, #scoped_encoding

Methods included from Language::AuxiliarLogger

#log

Instance Method Details

#copy_file(source_file, dest_file, time_stamp: false) ⇒ Object 



98
99
100
101
 
# File 'lib/eco/data/files/helpers.rb', line 98

def copy_file(source_file, dest_file, time_stamp: false)
  dest_file = timestamp_file(dest_file) if time_stamp
  File.write(dest_file, File.read(source_file))
end

#create_directory(path, includes_file: false) ⇒ Object 



51
52
53
 
# File 'lib/eco/data/files/helpers.rb', line 51

def create_directory(path, includes_file: false)
  Directory.create(path, includes_file: includes_file)
end

#csv_files(folder = ".", regexp: nil, older_than: nil) ⇒ Object 



134
135
136
 
# File 'lib/eco/data/files/helpers.rb', line 134

def csv_files(folder = ".", regexp: nil, older_than: nil)
  folder_files(folder, "*.csv", regexp: regexp, older_than: older_than).sort
end

#dir_exists?(path) ⇒ Boolean

Returns:

  • (Boolean) 


85
86
87
 
# File 'lib/eco/data/files/helpers.rb', line 85

def dir_exists?(path)
  Dir.exist?(path) || Dir.exist?(File.expand_path(path))
end

#file_basename(fullname) ⇒ Object 



67
68
69
70
71
 
# File 'lib/eco/data/files/helpers.rb', line 67

def file_basename(fullname)
  return nil unless fullname

  File.basename(fullname, File.extname(fullname))
end

#file_empty?(path) ⇒ Boolean

Returns:

  • (Boolean) 


103
104
105
106
107
 
# File 'lib/eco/data/files/helpers.rb', line 103

def file_empty?(path)
  return true unless File.file?(path)

  File.empty?(path)
end

#file_exists?(file) ⇒ Boolean

Returns:

  • (Boolean) 


79
80
81
82
83
 
# File 'lib/eco/data/files/helpers.rb', line 79

def file_exists?(file)
  return false unless file

  File.exist?(file) || File.exist?(File.expand_path(file))
end

#file_fullpath(fullname) ⇒ Object 



73
74
75
76
77
 
# File 'lib/eco/data/files/helpers.rb', line 73

def file_fullpath(fullname)
  return nil unless fullname

  File.dirname(File.expand_path(fullname))
end

#file_name(fullname) ⇒ Object 



61
62
63
64
65
 
# File 'lib/eco/data/files/helpers.rb', line 61

def file_name(fullname)
  return nil unless fullname

  File.basename(fullname)
end

#folder_files(folder = ".", pattern = "*", regexp: nil, older_than: nil) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/eco/data/files/helpers.rb', line 115

def folder_files(folder = ".", pattern = "*", regexp: nil, older_than: nil)
  target = File.join(File.expand_path(folder), pattern)
  Dir[target].tap do |dir_files|
    dir_files.select! {|f| File.file?(f)}

    if older_than
      dir_files.select! do |f|
        File.mtime(f) < (Time.now - (60*60*24*older_than))
      end
    end

    if regexp.is_a?(Regexp)
      dir_files.select! do |f|
        File.basename(f).match(regexp)
      end
    end
  end.sort
end

#script_subfolder ⇒ Object 



109
110
111
112
113
 
# File 'lib/eco/data/files/helpers.rb', line 109

def script_subfolder
  basename = File.basename($0, File.extname($0))
  path = File.dirname($0)
  File.join(path, basename)
end

#split(path) ⇒ Object 



55
56
57
58
59
 
# File 'lib/eco/data/files/helpers.rb', line 55

def split(path)
  dir_path, file = File.split(path)
  dir_path = dir_path.gsub(File::SEPARATOR, File::ALT_SEPARATOR || File::SEPARATOR)
  dir_path.split(File::ALT_SEPARATOR || File::SEPARATOR).push(file)
end

#timestamp(timestamp_pattern = DEFAULT_TIMESTAMP_PATTERN, date = Time.now) ⇒ Object 



89
90
91
 
# File 'lib/eco/data/files/helpers.rb', line 89

def timestamp(timestamp_pattern = DEFAULT_TIMESTAMP_PATTERN, date = Time.now)
  date.strftime(timestamp_pattern)
end

#timestamp_file(filename, timestamp_pattern = DEFAULT_TIMESTAMP_PATTERN) ⇒ Object 



93
94
95
96
 
# File 'lib/eco/data/files/helpers.rb', line 93

def timestamp_file(filename, timestamp_pattern = DEFAULT_TIMESTAMP_PATTERN)
  file_pattern = Eco::Data::Files::FilePattern.new(filename)
  file_pattern.resolve(start: timestamp(timestamp_pattern) + '_') # rubocop:disable Style/StringConcatenation
end