Module: Coolkit

Defined in:
lib/coolkit.rb,
lib/coolkit/time.rb,
lib/coolkit/error.rb,
lib/coolkit/paths.rb,
lib/coolkit/symbolize.rb,
lib/coolkit/filesystem.rb

Overview

Useful ruby code with no dependencies

Defined Under Namespace

Classes: Error

Constant Summary collapse

VERSION = 
"0.2.2".freeze

Class Method Summary collapse

Class Method Details

.data_dir ⇒ String

Directory for writing out files.

Returns:



10
11
12
 
# File 'lib/coolkit/paths.rb', line 10

def self.data_dir
  return File.join(self.root_dir, "data")
end

.root_dir ⇒ String

Directory where the gem is located.

Returns:



4
5
6
 
# File 'lib/coolkit/paths.rb', line 4

def self.root_dir
  return File.expand_path("../../..", __FILE__)
end

.symbolize_keys(arg) ⇒ Hash, Array

Recursively convert keys in a Hash or Array to symbols.

See:

Parameters:

Returns:



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/coolkit/symbolize.rb', line 10

def self.symbolize_keys(arg)
  if arg.is_a?(Hash)
    arg.inject({}) do |result, (key, value)|
      new_key = case key
                when String then key.to_sym()
                else key
                end
      new_value = case value
                  when Hash then symbolize_keys(value)
                  when Array then symbolize_keys(value)
                  else value
                  end
      result[new_key] = new_value
      result
    end
  elsif arg.is_a?(Array)
    arg.map { |e| symbolize_keys(e) }
  else
    arg
  end
end

.tmp_dir ⇒ String

Directory for writing out files.

Returns:



16
17
18
 
# File 'lib/coolkit/paths.rb', line 16

def self.tmp_dir
  return File.join(self.root_dir, "tmp")
end

.to_est(time) ⇒ Time

Convert a UTC Time object to EST.

Parameters:

  • time (Time)

Returns:

  • (Time)

Raises:

  • (ArgumentError) —

    Unless passed a UTC formatted Time object.



9
10
11
12
 
# File 'lib/coolkit/time.rb', line 9

def self.to_est(time)
  raise ArgumentError "argument is not in UTC format" unless time.utc?()
  return time + Time.zone_offset("EST")
end

.write_to_file(file, data) ⇒ void

This method returns an undefined value.

Append data to the end of a file. The file is created if it doesn"t exist.

Parameters:

  • file (String) —

    Path to the file.

  • data (String, #to_s) —

    Data to write to the file.



10
11
12
13
 
# File 'lib/coolkit/filesystem.rb', line 10

def self.write_to_file(file, data)
  FileUtils.mkdir_p(File.dirname(file))
  File.open(file, "a") { |f| f.write(data) }
end