Class: Raykit::Environment

Inherits:
Object
  • Object
show all
Defined in:
lib/raykit/environment.rb

Overview

Provides functionality related to the development environment

Class Method Summary collapse

Class Method Details

.admin? ⇒ Boolean

Returns:

  • (Boolean) 


94
95
96
97
 
# File 'lib/raykit/environment.rb', line 94

def self.admin?
  rights = `whoami /priv`
  rights.include?("SeCreateGlobalPrivilege")
end

.get_dev_dir(name) ⇒ Object

Get, and create if it does not exist, a specific development directory



57
58
59
60
61
62
63
64
65
 
# File 'lib/raykit/environment.rb', line 57

def self.get_dev_dir(name)
  dir = Pathname.new("#{Environment.root_dir}/#{name}")
  dir.mkpath
  if (dir.to_s.include?("https:") || dir.to_s.include?("http:"))
    normalize_path(dir.to_s.gsub("https://", ".").gsub("http://", ".").gsub("//", "/"))
  else
    normalize_path(dir.to_s)
  end
end

.get_dir_size(dir) ⇒ Object

Get the size of a directory and its contents



72
73
74
75
76
 
# File 'lib/raykit/environment.rb', line 72

def self.get_dir_size(dir)
  Dir.glob(File.join(dir, "**", "*"))
     .map { |f| File.size(f) }
     .inject(:+)
end

.get_work_dir(url) ⇒ Object 



67
68
69
 
# File 'lib/raykit/environment.rb', line 67

def self.get_work_dir(url)
  "#{Raykit::Environment.get_dev_dir("work")}/#{url.gsub(".git", "").gsub("://", ".")}"
end

.home_dir ⇒ Object

The user home directory



47
48
49
50
 
# File 'lib/raykit/environment.rb', line 47

def self.home_dir
  return normalize_path(ENV["USERPROFILE"]) if ENV.include?("USERPROFILE")
  normalize_path(ENV["HOME"])
end

.local_application_data ⇒ Object 



90
91
92
 
# File 'lib/raykit/environment.rb', line 90

def self.local_application_data
  "#{ENV["USERPROFILE"]}/AppData/Local".gsub('\\', "/")
end

.log_dir ⇒ Object 



52
53
54
 
# File 'lib/raykit/environment.rb', line 52

def self.log_dir
  get_dev_dir("log")
end

.machine ⇒ Object 



78
79
80
81
82
83
84
 
# File 'lib/raykit/environment.rb', line 78

def self.machine
  return ENV["COMPUTERNAME"] unless ENV["COMPUTERNAME"].nil?

  machine = `hostname`
  machine = machine.split(".")[0] if machine.include?(".")
  machine.strip
end

.normalize_path(name) ⇒ Object

Normalize a directory or filename to use forward slashes



9
10
11
12
13
14
15
 
# File 'lib/raykit/environment.rb', line 9

def self.normalize_path(name)
  if (windows?)
    normalize_windows(name)
  else
    normalize_unix(name)
  end
end

.normalize_unix(name) ⇒ Object 



17
18
19
 
# File 'lib/raykit/environment.rb', line 17

def self.normalize_unix(name)
  name.gsub('\\', "/")
end

.normalize_windows(name) ⇒ Object 



21
22
23
 
# File 'lib/raykit/environment.rb', line 21

def self.normalize_windows(name)
  name.gsub("/", '\\')
end

.root_dir ⇒ Object

The root directory for the development environment. May be set using the environment variable DEV_ROOT, otherwise defaults to the user home directory



32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/raykit/environment.rb', line 32

def self.root_dir
  if ENV["DEV_ROOT"].nil?
    config = Raykit::Configuration.new
    if (config.root_dir.nil? || config.root_dir.empty?)
      root = Environment.home_dir
    else
      root = Environment.home_dir + File::SEPARATOR + config.root_dir
    end
  else
    root = ENV["DEV_ROOT"].gsub("\\", "/").chomp("/")
    normalize_path(root)
  end
end

.user ⇒ Object 



86
87
88
 
# File 'lib/raykit/environment.rb', line 86

def self.user
  ENV["USERNAME"]
end

.which(name) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/raykit/environment.rb', line 99

def self.which(name)
  return name if File.exist?(name)

  ["", ".exe", ".bat", ".cmd"].each do |ext|
    aname = name + ext
    return aname if File.exist?(aname)

    ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
      apath = "#{path.gsub('\\', "/")}/#{aname}".gsub("//", "/")
      return apath if File.exist?(apath)
    end
  end
  ""
end

.windows? ⇒ Boolean

Returns:

  • (Boolean) 


25
26
27
 
# File 'lib/raykit/environment.rb', line 25

def self.windows?
  Gem.win_platform?
end