Class: AdminModule::Rake::LockTasks

Inherits:
Object
  • Object
show all
Includes:
Rake::DSL
Defined in:
lib/admin_module/rake/lock_tasks.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(task_name = 'locks_task', desc = "Modify a lock or locks") {|_self| ... } ⇒ LockTasks

Returns a new instance of LockTasks.

Yields:

  • (_self)

Yield Parameters:



27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 27

def initialize(task_name = 'locks_task', desc = "Modify a lock or locks")
  @valid_actions = ['import', 'export', 'read', 'list', 'rename']
  @task_name, @desc = task_name, desc

  @stop_on_exception = true
  @allow_create = false

  yield self if block_given?

  define_task
end

Instance Attribute Details

#action ⇒ Object

Returns the value of attribute action.



23
24
25
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 23

def action
  @action
end

#allow_create ⇒ Object

Returns the value of attribute allow_create.



22
23
24
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 22

def allow_create
  @allow_create
end

#env ⇒ Object

Returns the value of attribute env.



18
19
20
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 18

def env
  @env
end

#name ⇒ Object

Returns the value of attribute name.



19
20
21
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 19

def name
  @name
end

#path ⇒ Object

Returns the value of attribute path.



21
22
23
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 21

def path
  @path
end

#stop_on_exception ⇒ Object

Returns the value of attribute stop_on_exception.



25
26
27
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 25

def stop_on_exception
  @stop_on_exception
end

#to ⇒ Object

Returns the value of attribute to.



20
21
22
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 20

def to
  @to
end

#valid_actions ⇒ Object (readonly)

Returns the value of attribute valid_actions.



24
25
26
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 24

def valid_actions
  @valid_actions
end

Class Method Details

.install ⇒ Object 



170
171
172
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 170

def install
  new.install
end

Instance Method Details

#assert_env_is_configured(arg) ⇒ Object 



136
137
138
139
140
141
142
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 136

def assert_env_is_configured arg
  unless AdminModule.configuration.credentials.key? arg
    init_msg = "Have you initialized your config file?\n Try: admin_module config init <filedir>"
    env_msg = "Have you configured your environments?\n Try: admin_module config add env <envname> <url>"
    raise "Unknown environment: #{arg}\n#{init_msg}\n\n#{env_msg}"
  end
end

#assert_provided(value, msg) ⇒ Object 



130
131
132
133
134
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 130

def assert_provided value, msg
  if value.nil? || value.empty?
    raise msg
  end
end

#commit ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 65

def commit
  validate_params

  client = AdminModule::Client.new
  client.env = env

  if self.respond_to? action
    self.send(action, client)
    return
  else
    raise "Unknown action - #{action}"
  end

rescue Exception => e
  raise e if stop_on_exception == true
ensure
  client.quit
end

#define_task ⇒ Object

:nodoc:



39
40
41
42
43
44
45
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 39

def define_task #:nodoc:
  desc @desc
  task(@task_name, required_args_for_action) do |t,args|
    set_vars args
    commit  # Call method to perform when invoked.
  end
end

#export(client) ⇒ Object 



99
100
101
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 99

def export client
  $stdout << client.locks.export(path)
end

#import(client) ⇒ Object 



95
96
97
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 95

def import client
  $stdout << client.locks.import(path, allow_create)
end

#install ⇒ Object 



175
176
177
178
179
180
181
182
183
184
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 175

def install
  AdminModule.configuration.credentials.keys.each do |e|
    valid_actions.each do |action|
      AdminModule::Rake::LockTasks.new("am:#{e}:lock:#{action}", "#{action} #{e} lock(s)") do |t|
        t.env = e
        t.action = action
      end
    end
  end
end

#list(client) ⇒ Object 



84
85
86
87
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 84

def list client
  $stdout << client.locks.list.join("\n")
  $stdout << "\n"
end

#read(client) ⇒ Object 



89
90
91
92
93
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 89

def read client
  result = {}
  result[name] = client.locks.read(name)
  $stdout << result.to_yaml
end

#rename(client) ⇒ Object 



103
104
105
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 103

def rename client
  $stdout << client.locks.rename(name, to)
end

#required_args_for_action ⇒ Object 



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 144

def required_args_for_action
  args = []

  case action
  when 'read'
    args << :name

  when 'rename'
    args << :name
    args << :to

  when 'import'
    args << :path
    args << :allow_create

  when 'export'
    args << :path

  else
    # Noop
  end

  args
end

#set_vars(args) ⇒ Object 



47
48
49
50
51
52
53
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 47

def set_vars args
  args.each do |arg,val|
    instance_variable_set "@#{arg}", val
  end

  args
end

#validate_params ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/admin_module/rake/lock_tasks.rb', line 107

def validate_params
  assert_provided env, 'Missing "env"'
  assert_provided action, 'Missing "action"'

  case action
  when 'import'
    assert_provided path, 'Missing "path"'

  when 'export'
    assert_provided path, 'Missing "path"'

  when 'read'
    assert_provided name, 'Missing "name"'

  when 'rename'
    assert_provided name, 'Missing "name"'
    assert_provided to, 'Missing "to"'

  end

  assert_env_is_configured env
end