Module: Card::Model::SaveHelper
- Included in:
- Card::Migration
- Defined in:
- lib/card/model/save_helper.rb
Overview
API to create and update cards. It is intended as a helper for "external" scripts (seeding, testing, migrating, etc) and not for internal application code. The general pattern is: All methods use the ActiveRecord !-methods that throw exceptions if somethings fails. All !-methods in this module rename existing cards to resolve name conflicts)
Instance Method Summary collapse
- #add_coderule_item(name, prefix, type_id, to) ⇒ Object
- #add_name(name, content_or_args) ⇒ Object
- #add_script(name, opts = {}) ⇒ Object
- #add_style(name, opts = {}) ⇒ Object
- #as_user(user_name) ⇒ Object
- #create_card(name_or_args, content_or_args = nil) ⇒ Object (also: #create)
-
#create_card!(name_or_args, content_or_args = nil) ⇒ Object
(also: #create!)
if card with same name exists move it out of the way.
- #create_or_update_card(name_or_args, content_or_args = nil) ⇒ Object (also: #create_or_update)
- #create_or_update_card!(name_or_args, content_or_args = nil) ⇒ Object (also: #create_or_update!)
- #delete_card(name) ⇒ Object (also: #delete)
- #delete_code_card(name) ⇒ Object
- #ensure_attributes(card, args) ⇒ Object
-
#ensure_card(name_or_args, content_or_args = nil) ⇒ Object
(also: #ensure)
create if card doesn't exist updates existing card only if given attributes are different except the name.
-
#ensure_card!(name_or_args, content_or_args = nil) ⇒ Object
(also: #ensure!)
create if card doesn't exist updates existing card only if given attributes are different including the name For example if a card with name "under_score" exists then
ensure_card "Under Score"
renames it to "Under Score". -
#ensure_trait(name, codename, args = {}) ⇒ Object
Creates or updates a trait card with codename and right rules.
- #ensure_trait_rule(trait, setting, value) ⇒ Object
- #name_from_args(name_or_args) ⇒ Object
- #normalize_trait_rule_args(setting, value) ⇒ Object
- #resolve_name_conflict(args) ⇒ Object
-
#standardize_args(name_or_args, content_or_args) ⇒ Object
Args.
- #standardize_update_args(name_or_args, content_or_args) ⇒ Object
- #update_card(name, content_or_args) ⇒ Object (also: #update)
- #update_card!(name, content_or_args) ⇒ Object (also: #update!)
- #validate_setting(setting) ⇒ Object
Instance Method Details
#add_coderule_item(name, prefix, type_id, to) ⇒ Object
211 212 213 214 215 216 217 218 |
# File 'lib/card/model/save_helper.rb', line 211 def add_coderule_item name, prefix, type_id, to codename = "#{prefix}_#{name.tr(' ', '_').underscore}" name = "#{prefix}: #{name}" ensure_card name, type_id: type_id, codename: codename Card[to].add_item! name end |
#add_name(name, content_or_args) ⇒ Object
161 162 163 164 165 166 167 |
# File 'lib/card/model/save_helper.rb', line 161 def add_name name, content_or_args if content_or_args.is_a?(String) { content: content_or_args, name: name } else content_or_args.reverse_merge name: name end end |
#add_script(name, opts = {}) ⇒ Object
201 202 203 204 205 206 207 208 |
# File 'lib/card/model/save_helper.rb', line 201 def add_script name, opts={} name.sub!(/^script\:?\s?/, '') # in case name is given with prefix # remove it so that we don't double it add_coderule_item name, "script", opts[:type_id] || Card::CoffeeScriptID, opts[:to] || "*all+*script" end |
#add_style(name, opts = {}) ⇒ Object
192 193 194 195 196 197 198 199 |
# File 'lib/card/model/save_helper.rb', line 192 def add_style name, opts={} name.sub!(/^style\:?\s?/, '') # in case name is given with prefix # remove it so that we don't double it add_coderule_item name, "style", opts[:type_id] || Card::ScssID, opts[:to] || "*all+*style" end |
#as_user(user_name) ⇒ Object
12 13 14 15 16 17 18 |
# File 'lib/card/model/save_helper.rb', line 12 def as_user user_name current = Card::Auth.current_id Card::Auth.current_id = Card.fetch_id user_name result = yield Card::Auth.current_id = current result end |
#create_card(name_or_args, content_or_args = nil) ⇒ Object Also known as: create
20 21 22 23 24 |
# File 'lib/card/model/save_helper.rb', line 20 def create_card name_or_args, content_or_args=nil args = standardize_args name_or_args, content_or_args resolve_name_conflict args Card.create! args end |
#create_card!(name_or_args, content_or_args = nil) ⇒ Object Also known as: create!
if card with same name exists move it out of the way
124 125 126 127 |
# File 'lib/card/model/save_helper.rb', line 124 def create_card! name_or_args, content_or_args=nil args = standardize_args name_or_args, content_or_args create_card args.reverse_merge(rename_if_conflict: :old) end |
#create_or_update_card(name_or_args, content_or_args = nil) ⇒ Object Also known as: create_or_update
32 33 34 35 36 37 38 39 40 41 42 |
# File 'lib/card/model/save_helper.rb', line 32 def create_or_update_card name_or_args, content_or_args=nil name = name_from_args name_or_args if Card[name] args = standardize_update_args name_or_args, content_or_args update_card(name, args) else args = standardize_args name_or_args, content_or_args create_card(args) end end |
#create_or_update_card!(name_or_args, content_or_args = nil) ⇒ Object Also known as: create_or_update!
134 135 136 137 |
# File 'lib/card/model/save_helper.rb', line 134 def create_or_update_card! name_or_args, content_or_args=nil args = standardize_args name_or_args, content_or_args create_or_update args.reverse_merge(rename_if_conflict: :new) end |
#delete_card(name) ⇒ Object Also known as: delete
44 45 46 47 |
# File 'lib/card/model/save_helper.rb', line 44 def delete_card name return unless (card = Card[name]) card.delete! end |
#delete_code_card(name) ⇒ Object
49 50 51 52 |
# File 'lib/card/model/save_helper.rb', line 49 def delete_code_card name update name, codename: nil delete name end |
#ensure_attributes(card, args) ⇒ Object
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/card/model/save_helper.rb', line 175 def ensure_attributes card, args args = args.with_indifferent_access subcards = card.extract_subcard_args! args update_args = args.select do |key, value| if key =~ /^\+/ subfields[key] = value false else card.send(key) != value end end return if update_args.empty? && subcards.empty? # FIXME: use ensure_attributes for subcards card.update_attributes! update_args.merge(subcards: subcards) end |
#ensure_card(name_or_args, content_or_args = nil) ⇒ Object Also known as: ensure
create if card doesn't exist updates existing card only if given attributes are different except the name
61 62 63 64 65 66 67 68 69 70 |
# File 'lib/card/model/save_helper.rb', line 61 def ensure_card name_or_args, content_or_args=nil args = standardize_args name_or_args, content_or_args name = args.delete(:name) if (card = Card[name]) ensure_attributes card, args card else Card.create! args.merge(name: name) end end |
#ensure_card!(name_or_args, content_or_args = nil) ⇒ Object Also known as: ensure!
create if card doesn't exist
updates existing card only if given attributes are different including
the name
For example if a card with name "under_score" exists
then ensure_card "Under Score"
renames it to "Under Score"
77 78 79 80 81 82 83 84 |
# File 'lib/card/model/save_helper.rb', line 77 def ensure_card! name_or_args, content_or_args=nil args = standardize_args name_or_args, content_or_args if (card = Card[args[:name]]) ensure_attributes card, args else Card.create! args end end |
#ensure_trait(name, codename, args = {}) ⇒ Object
Creates or updates a trait card with codename and right rules. Content for rules that are pointer cards by default is converted to pointer format.
95 96 97 98 99 100 |
# File 'lib/card/model/save_helper.rb', line 95 def ensure_trait name, codename, args={} ensure_card name, codename: codename args.each do |setting, value| ensure_trait_rule name, setting, value end end |
#ensure_trait_rule(trait, setting, value) ⇒ Object
102 103 104 105 106 |
# File 'lib/card/model/save_helper.rb', line 102 def ensure_trait_rule trait, setting, value validate_setting setting card_args = normalize_trait_rule_args setting, value ensure_card [trait, :right, setting], card_args end |
#name_from_args(name_or_args) ⇒ Object
157 158 159 |
# File 'lib/card/model/save_helper.rb', line 157 def name_from_args name_or_args name_or_args.is_a?(Hash) ? name_or_args[:name] : name_or_args end |
#normalize_trait_rule_args(setting, value) ⇒ Object
115 116 117 118 119 120 121 |
# File 'lib/card/model/save_helper.rb', line 115 def normalize_trait_rule_args setting, value return value if value.is_a? Hash if Card.fetch_type_id([setting, :right, :default]) == PointerID value = Array(value).to_pointer_content end { content: value } end |
#resolve_name_conflict(args) ⇒ Object
169 170 171 172 173 |
# File 'lib/card/model/save_helper.rb', line 169 def resolve_name_conflict args rename = args.delete :rename_if_conflict return unless args[:name] && rename args[:name] = Card.uniquify_name args[:name], rename end |
#standardize_args(name_or_args, content_or_args) ⇒ Object
Returns args.
140 141 142 143 144 145 146 |
# File 'lib/card/model/save_helper.rb', line 140 def standardize_args name_or_args, content_or_args if name_or_args.is_a?(Hash) name_or_args else add_name name_or_args, content_or_args || {} end end |
#standardize_update_args(name_or_args, content_or_args) ⇒ Object
148 149 150 151 152 153 154 155 |
# File 'lib/card/model/save_helper.rb', line 148 def standardize_update_args name_or_args, content_or_args return name_or_args if name_or_args.is_a?(Hash) if content_or_args.is_a?(String) { content: content_or_args } else content_or_args end end |
#update_card(name, content_or_args) ⇒ Object Also known as: update
26 27 28 29 30 |
# File 'lib/card/model/save_helper.rb', line 26 def update_card name, content_or_args args = standardize_update_args name, content_or_args resolve_name_conflict args Card[name].update_attributes! args end |
#update_card!(name, content_or_args) ⇒ Object Also known as: update!
129 130 131 132 |
# File 'lib/card/model/save_helper.rb', line 129 def update_card! name, content_or_args args = standardize_update_args name, content_or_args update_card name, args.reverse_merge(rename_if_conflict: :new) end |