Class: AdminModule::Rake::RuleTasks
- Inherits:
-
Object
- Object
- AdminModule::Rake::RuleTasks
- Includes:
- Rake::DSL
- Defined in:
- lib/admin_module/rake/rule_tasks.rb
Instance Attribute Summary collapse
-
#action ⇒ Object
Returns the value of attribute action.
-
#env ⇒ Object
Returns the value of attribute env.
-
#name ⇒ Object
Returns the value of attribute name.
-
#stop_on_exception ⇒ Object
Returns the value of attribute stop_on_exception.
-
#to ⇒ Object
Returns the value of attribute to.
-
#valid_actions ⇒ Object
readonly
Returns the value of attribute valid_actions.
Class Method Summary collapse
Instance Method Summary collapse
- #assert_env_is_configured(arg) ⇒ Object
- #assert_provided(value, msg) ⇒ Object
- #commit ⇒ Object
-
#define_task ⇒ Object
:nodoc:.
- #delete(client) ⇒ Object
-
#initialize(task_name = 'rule_task', desc = "Modify a guideline rule") {|_self| ... } ⇒ RuleTasks
constructor
A new instance of RuleTasks.
- #install ⇒ Object
- #rename(client) ⇒ Object
- #required_args_for_action ⇒ Object
- #set_vars(args) ⇒ Object
- #validate_params ⇒ Object
Constructor Details
#initialize(task_name = 'rule_task', desc = "Modify a guideline rule") {|_self| ... } ⇒ RuleTasks
Returns a new instance of RuleTasks.
25 26 27 28 29 30 31 32 33 |
# File 'lib/admin_module/rake/rule_tasks.rb', line 25 def initialize(task_name = 'rule_task', desc = "Modify a guideline rule") @valid_actions = ['rename', 'delete'] @task_name, @desc = task_name, desc @stop_on_exception = true yield self if block_given? define_task end |
Instance Attribute Details
#action ⇒ Object
Returns the value of attribute action.
21 22 23 |
# File 'lib/admin_module/rake/rule_tasks.rb', line 21 def action @action end |
#env ⇒ Object
Returns the value of attribute env.
18 19 20 |
# File 'lib/admin_module/rake/rule_tasks.rb', line 18 def env @env end |
#name ⇒ Object
Returns the value of attribute name.
19 20 21 |
# File 'lib/admin_module/rake/rule_tasks.rb', line 19 def name @name end |
#stop_on_exception ⇒ Object
Returns the value of attribute stop_on_exception.
23 24 25 |
# File 'lib/admin_module/rake/rule_tasks.rb', line 23 def stop_on_exception @stop_on_exception end |
#to ⇒ Object
Returns the value of attribute to.
20 21 22 |
# File 'lib/admin_module/rake/rule_tasks.rb', line 20 def to @to end |
#valid_actions ⇒ Object (readonly)
Returns the value of attribute valid_actions.
22 23 24 |
# File 'lib/admin_module/rake/rule_tasks.rb', line 22 def valid_actions @valid_actions end |
Class Method Details
.install ⇒ Object
138 139 140 |
# File 'lib/admin_module/rake/rule_tasks.rb', line 138 def install new.install end |
Instance Method Details
#assert_env_is_configured(arg) ⇒ Object
111 112 113 114 115 116 117 |
# File 'lib/admin_module/rake/rule_tasks.rb', line 111 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
105 106 107 108 109 |
# File 'lib/admin_module/rake/rule_tasks.rb', line 105 def assert_provided value, msg if value.nil? || value.empty? raise msg end end |
#commit ⇒ Object
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/admin_module/rake/rule_tasks.rb', line 61 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 unless client.nil? end |
#define_task ⇒ Object
:nodoc:
35 36 37 38 39 40 41 |
# File 'lib/admin_module/rake/rule_tasks.rb', line 35 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 |
#delete(client) ⇒ Object
84 85 86 |
# File 'lib/admin_module/rake/rule_tasks.rb', line 84 def delete client $stdout << client.rules.delete(name) end |
#install ⇒ Object
143 144 145 146 147 148 149 150 151 152 |
# File 'lib/admin_module/rake/rule_tasks.rb', line 143 def install AdminModule.configuration.credentials.keys.each do |e| valid_actions.each do |action| AdminModule::Rake::RuleTasks.new("am:#{e}:rule:#{action}", "#{action} #{e} rule(s)") do |t| t.env = e t.action = action end end end end |
#rename(client) ⇒ Object
80 81 82 |
# File 'lib/admin_module/rake/rule_tasks.rb', line 80 def rename client $stdout << client.rules.rename(name, to) end |
#required_args_for_action ⇒ Object
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'lib/admin_module/rake/rule_tasks.rb', line 119 def required_args_for_action args = [] case action when 'delete' args << :name when 'rename' args << :name args << :to else # Noop end args end |
#set_vars(args) ⇒ Object
43 44 45 46 47 48 49 |
# File 'lib/admin_module/rake/rule_tasks.rb', line 43 def set_vars args args.each do |arg,val| instance_variable_set "@#{arg}", val end args end |
#validate_params ⇒ Object
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
# File 'lib/admin_module/rake/rule_tasks.rb', line 88 def validate_params assert_provided env, 'Missing "env"' assert_provided action, 'Missing "action"' case action when 'rename' assert_provided name, 'Missing "name"' assert_provided to, 'Missing "to"' when 'delete' assert_provided name, 'Missing "name"' end assert_env_is_configured env end |