Class: Clir::DataManager::Property

Inherits:
Object
  • Object
show all
Includes:
ClirDataManagerConstants
Defined in:
lib/clir/data_manager/Property.rb

Constant Summary collapse

BOOLEAN_VALUES = 
[
  {name: MSG[:yes]    , value: true   },
  {name: MSG[:no]     , value: false  },
  {name: MSG[:cancel] , value: nil    }
]

Constants included from ClirDataManagerConstants

ClirDataManagerConstants::ALL_SPECS, ClirDataManagerConstants::DISPLAYABLE, ClirDataManagerConstants::EDITABLE, ClirDataManagerConstants::REMOVABLE, ClirDataManagerConstants::REQUIRED, ClirDataManagerConstants::TABLEIZABLE

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(manager, data = nil) ⇒ Property

Returns a new instance of Property.

Parameters:



11
12
13
14
 
# File 'lib/clir/data_manager/Property.rb', line 11

def initialize(manager, data = nil)
  @manager  = manager
  @data     = data || {}
end

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.



7
8
9
 
# File 'lib/clir/data_manager/Property.rb', line 7

def data
  @data
end

#manager ⇒ Object (readonly)

Returns the value of attribute manager.



6
7
8
 
# File 'lib/clir/data_manager/Property.rb', line 6

def manager
  @manager
end

Instance Method Details

#current_value(instance) ⇒ Object 



278
279
280
 
# File 'lib/clir/data_manager/Property.rb', line 278

def current_value(instance)
  instance.send(prop)
end

#default(instance) ⇒ Object 



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/clir/data_manager/Property.rb', line 405

def default(instance)
  d = data[:default]
  d = d.call(instance) if d.is_a?(Proc)
  if d.is_a?(Symbol)
    if instance.respond_to?(d)
      instance.send(d)
    elsif instance.class.respond_to?(d)
      nargs = instance.class.method(d).arity
      puts "Nombre d'arguments attendus : #{nargs}".orange
      puts 10
      begin
        d = instance.class.send(d)
      rescue ArgumentError
        d = instance.class.send(d, instance)
      end
    else
      # La garder telle quelle
    end
  end
  d
end

#default_select_value(instance, vals) ⇒ Object

propriété courante, lorsque c’est un select (tty-prompt, en valeur par défaut, ne supporte que l’index, ou le :name du menu) Si la valeur n’est pas définie ou si elle est introuvable, on retourne nil



269
270
271
272
273
274
275
 
# File 'lib/clir/data_manager/Property.rb', line 269

def default_select_value(instance, vals)
  cvalue = current_value(instance) || default(instance) || return
  vals.each_with_index do |dchoix, idx|
    return idx + 1 if dchoix[:value] == cvalue
  end
  return nil
end

#displayable?(instance) ⇒ Boolean

Returns:

  • (Boolean) 


298
299
300
301
 
# File 'lib/clir/data_manager/Property.rb', line 298

def displayable?(instance)
  if_able?(instance) || return
  :TRUE == @isdisplayable ||= true_or_false(specs & DISPLAYABLE > 0)
end

#edit(instance, options = nil) ⇒ Object

Méthode principale de l’édition de la propriété pour l’instance instance avec les options éventuelles options

contraire.

Returns:

  • TRUE si la donnée a été modifiée, FALSE dans le cas



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/clir/data_manager/Property.rb', line 25

def edit(instance, options = nil)
  # 
  # La valeur par défaut
  # Soit la valeur actuelle de l'instance, soit la valeur définie
  # par :default dans les propriétés, qui peut être soit une procé-
  # dure soit une méthode de classe ou d'instance.
  # 
  defvalue = instance.send(prop) || default(instance)
  # 
  # On utilise une édition différente en fonction du type de la
  # donnée
  # 
  error     = nil
  question  = question(instance).jaune
  while true
    puts error.rouge if error
    new_value =
      case type
      when :id
        # [N0001]
        # Cas spécial d'une propriété <>_id. Si tout a bien été
        # défini, DataManager a mis dans l'attribut relative_class
        # la classe de l'élément.
        if relative_class
          item = relative_class.choose({create: true, filter: values_filter})
          item&.id
        else
          raise ERRORS[:require_relative_class] % [prop.to_s, relative_class.to_s]
        end
      when :ids
        # Cf. [N0001] ci-dessus
        if relative_class
          multi_choose(instance, options)
        else
          raise ERRORS[:require_relative_class] % [prop.to_s, relative_class.to_s]
        end
      when :date
        defvalue ||= Time.now.strftime(MSG[:date_format])
        Q.ask(question, {default: defvalue})&.strip
      when :string, :email, :prix, :url, :people, :number, :float
        nval = Q.ask(question, {help:"'---' = nul", default: defvalue})
        nval = nil if nval == '---'
        unless nval.nil?
          nval = nval.to_s.force_encoding('UTF-8').strip
          case type
          when :number, :float
            if nval.sub(/,/,'.').match?(/\./)
              nval = nval.to_f
            else
              nval = nval.to_i
            end
          when :prix
            nval = nval.to_f
          when :url
            nval = "https://#{nval}" unless nval.start_with?('http')
          end
        end
        nval
      when :select
        # 
        # Type :select
        # 
        choices = select_values_with_precedences(instance)
        if multi?
          vals = Q.multi_select(question, choices, {default:default_select_value(instance, choices), per_page:choices.count})
          vals.each { |val| values(instance).set_last(val) }
          vals
        else
          value = Q.select(question, choices, {default:default_select_value(instance, choices), per_page:choices.count, show_help:false})
          values(instance).set_last(value)
          value
        end
      when :bool
        Q.select(question, BOOLEAN_VALUES, {default: boolean_default_value(instance), per_page:BOOLEAN_VALUES.count, show_help:false})
      else
        puts "Je ne sais pas encore éditer une donnée de type #{type.inspect}.".orange
        sleep 3
        break
      end
    #
    # Si la propriété définit une méthode de transformation de
    # l'entrée, on l'utilise
    if new_value && itransform
      new_value = transform_new_value(instance, new_value)
    end
    #
    # On vérifie la validité de la donnée, si une méthode de 
    # validation a été définie. Si la donnée est valide, on la 
    # consigne, sinon non demande à la modifier.
    # 
    error = valid?(new_value, instance)
    break if error.nil?

  end #/while invalid
  # 
  # La donnée a-t-elle changée ?
  # 
  modified = new_value != current_value(instance)
  #
  # S'il y a eu modification, on affecte la nouvelle valeur
  # 
  instance.send("#{prop}=".to_sym, new_value) if modified
  # 
  # On indique si la donnée a été modifiée
  # 
  return modified
end

#editable?(instance) ⇒ Boolean

Returns:

  • (Boolean) 


303
304
305
306
 
# File 'lib/clir/data_manager/Property.rb', line 303

def editable?(instance)
  if_able?(instance) || return
  :TRUE == @iseditable ||= true_or_false(specs & EDITABLE > 0)
end

#format_method ⇒ Object 



429
 
# File 'lib/clir/data_manager/Property.rb', line 429

def format_method;    @format_method  ||= data[:mformat]||data[:mformate]||data[:format_method] end

#formated_value_in(instance) ⇒ Object

— Helpers Methods —



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/clir/data_manager/Property.rb', line 143

def formated_value_in(instance)
  curval = instance.send(prop)
  if curval.nil?
    # 
    # Value non définie
    # 
    return '---'
  elsif format_method # :mformat dans la définition de la propriété
    # 
    # Si la propriété définit une valeur de formatage explicitement
    # 
    if format_method.is_a?(Proc)
      format_method.call(current_value(instance), instance)
    else
      instance.send(format_method)
    end
  elsif instance.respond_to?("f_#{prop}".to_sym)
    # 
    # Si l'instance définit la méthode de formatage
    # 
    instance.send("f_#{prop}".to_sym)
  elsif prop == :name && instance.respond_to?(:best_name)
    instance.best_name
  elsif prop.match?(/_ids?$/) && [:id, :ids].include?(type)
    # 
    # Propriété avec classe relative
    # 
    if relative_class
      dmanager = relative_class.data_manager
      if type == :id
        # inst = relative_class.get(current_value(instance))
        inst = relative_class.get(curval)
        return dmanager.tty_name_for(inst, nil)
      elsif type == :ids
        return curval.map do |id|
          inst = relative_class.get(id)
          dmanager.tty_name_for(inst, nil)
        end.join(', ')
      end
    else
      raise ERRORS[:require_relative_class]
    end
  elsif type == :select && data[:values]
    #
    # Propriété avec des values (on renvoie :full_name ou :name
    # du choix correspondant)
    # 
    values_for_instance = values(instance)
    values_for_instance.each do |dchoix|
      if dchoix[:value] == curval
        return dchoix[:full_name]||dchoix[:name]
      end
    end
    raise ERRORS[:choice_unfound_in_choices_list] % [curval.inspect, self.name(instance), values_for_instance.inspect]
  else
    # 
    # En dernier recours, la valeur telle quelle
    # 
    curval
  end
end

#if_able?(instance) ⇒ Boolean

retourne la valeur true (donc elle retourne true quand la propriété existe pour l’instance donnée)

Returns:

  • (Boolean) —

    TRUE si la propriété :if n’est pas définie ou si elle



334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/clir/data_manager/Property.rb', line 334

def if_able?(instance)
  specs || raise(ERRORS[:specs_undefined] % prop)
  return true if if_attr.nil?
  case if_attr
  when Symbol
    instance.send(if_attr)
  when Proc
    if_attr.call(instance)
  when TrueClass, FalseClass
    if_attr
  else
    raise ERRORS[:unknown_if_attribut] % "#{if_attr.inspect}:#{if_attr.class}"
  end
end

#if_attr ⇒ Object 



356
 
# File 'lib/clir/data_manager/Property.rb', line 356

def if_attr;    @ifattr       ||= data[:if]         end

#index ⇒ Object

— Hard Coded Properties —



351
 
# File 'lib/clir/data_manager/Property.rb', line 351

def index;      @index        ||= data[:index]      end

#itransform ⇒ Object 



427
 
# File 'lib/clir/data_manager/Property.rb', line 427

def itransform;       @itransform     ||= data[:itransform]     end

#multi? ⇒ Boolean

Returns true si property can have multi_select values.

Returns:

  • (Boolean) —

    true si property can have multi_select values.



327
328
329
 
# File 'lib/clir/data_manager/Property.rb', line 327

def multi?
  :TRUE == @ismultiselect ||= true_or_false(data[:multi] == true)
end

#multi_choose(instance, options) ⇒ Object

Permet de choisir des valeurs multiples, pour le moment plusieurs identifiants d’une classe relative.

La méthode doit être appelée après avoir vérifié que la relative_class existait bien.



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/clir/data_manager/Property.rb', line 214

def multi_choose(instance, options)
  curvalue = current_value(instance) || []
  # 
  # La valeur propre du filtre
  filter_for_instance = nil
  if values_filter
    filter_for_instance = {}
    values_filter.each do |key, value|
      if value.is_a?(Symbol) # => propriété de l'instance
        value = instance.send(value)
      end
      filter_for_instance.merge!(key => value)
    end
  end
  # 
  # On demande toutes les instances choisies
  # 
  insts = relative_class.choose({multi:true, create: false, filter: filter_for_instance, default: curvalue})
  curvalue = insts.map(&:id)
  # puts "curvalue : #{curvalue.inspect}"
  # 
  # Valeur finale à retourner
  # 
  curvalue = nil if curvalue.empty?
  return curvalue
end

#name(instance = nil) ⇒ Object 



359
360
361
362
363
364
365
366
 
# File 'lib/clir/data_manager/Property.rb', line 359

def name(instance = nil)
  @name ||= data[:name]
  if @name.is_a?(Proc)
    @name.call(instance)
  else
    @name
  end
end

#prop ⇒ Object 



353
 
# File 'lib/clir/data_manager/Property.rb', line 353

def prop;       @prop         ||= data[:prop]       end

#quest ⇒ Object 



355
 
# File 'lib/clir/data_manager/Property.rb', line 355

def quest;      @quest        ||= data[:quest]      end

#question(instance) ⇒ Object 



283
284
285
286
287
288
289
 
# File 'lib/clir/data_manager/Property.rb', line 283

def question(instance)
  if quest
    quest % instance.data
  else
    "Nouvelle valeur pour #{name.inspect} : "
  end
end

#relative_class ⇒ Object 



428
 
# File 'lib/clir/data_manager/Property.rb', line 428

def relative_class;   @relative_class ||= data[:relative_class] end

#removable?(instance) ⇒ Boolean

Returns:

  • (Boolean) 


308
309
310
311
 
# File 'lib/clir/data_manager/Property.rb', line 308

def removable?(instance)
  if_able?(instance) || return
  :TRUE == @isremovable ||= true_or_false(specs & REMOVABLE > 0)
end

#required?(instance) ⇒ Boolean

— Predicate Methods —

Returns:

  • (Boolean) 


293
294
295
296
 
# File 'lib/clir/data_manager/Property.rb', line 293

def required?(instance)
  if_able?(instance) || return
  :TRUE == @isrequired ||= true_or_false(specs & REQUIRED > 0)
end

#select_values_with_precedences(instance) ⇒ Object 



260
261
262
 
# File 'lib/clir/data_manager/Property.rb', line 260

def select_values_with_precedences(instance)
  return values(instance).to_prec
end

#short_name ⇒ Object 



358
 
# File 'lib/clir/data_manager/Property.rb', line 358

def short_name; @short_name   ||= data[:short_name] end

#specs ⇒ Object 



352
 
# File 'lib/clir/data_manager/Property.rb', line 352

def specs;      @specs        ||= data[:specs]      end

#tablizable? ⇒ true, false

Note:

Contrairement aux autres méthodes predicate de même type (cf ci-dessus), on ne teste pas le if_able car cette valeur doit être utilisée dans la table même pour les items qui ne la défi- nissent pas (sinon il y aurait des “trous” dans la table)

dans une table Clir::Table

Returns:

  • (true, false) —

    true si la propriété doit être affichée



321
322
323
324
 
# File 'lib/clir/data_manager/Property.rb', line 321

def tablizable?
  specs || raise(ERRORS[:specs_undefined] % prop)
  :TRUE == @isremovable ||= true_or_false(specs & TABLEIZABLE > 0)    
end

#transform_new_value(instance, new_value) ⇒ Object

Si la propriété définit :itransform (méthode de transformation de la donnée entrée), cette méthode est appelée pour transformer la donnée.



245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/clir/data_manager/Property.rb', line 245

def transform_new_value(instance, new_value)
  case itransform
  when Symbol
    if instance.respond_to?(itransform)
      instance.send(itransform, new_value)
    elsif new_value.respond_to?(itransform)
      new_value.send(itransform)
    else
      raise ERRORS[:value_doesnt_respond_to] % [new_value.inspect, "#{new_value.class}", itransform.inspect]
    end
  when Proc
    itransform.call(instance, new_value)
  end
end

#type ⇒ Object 



354
 
# File 'lib/clir/data_manager/Property.rb', line 354

def type;       @type         ||= data[:type]       end

#valid?(new_value, instance) ⇒ Boolean

Returns Nil si OK ou le message d’erreur à afficher.

Returns:

  • (Boolean) —

    Nil si OK ou le message d’erreur à afficher



136
137
138
139
 
# File 'lib/clir/data_manager/Property.rb', line 136

def valid?(new_value, instance)
  return if new_value && (new_value == current_value(instance))
  return manager.validator.valid?(self, new_value, instance)
end

#valid_if ⇒ Object 



357
 
# File 'lib/clir/data_manager/Property.rb', line 357

def valid_if;   @valid_if     ||= data[:valid_if]   end

#values(instance = nil) ⇒ Object 



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/clir/data_manager/Property.rb', line 369

def values(instance = nil)
  vs = 
  vs = case (vs = data[:values])
  when Symbol
    if manager.classe.respond_to?(vs)
      begin
        manager.classe.send(vs)
      rescue ArgumentError
        manager.classe.send(vs, instance)
      end
    elsif manager.respond_to?(vs)
      nargs = manager.method(d).arity        
      puts "Nombre d'arguments attendus par (#{vs}) : #{nargs}".orange
      puts 10
      if nargs == 0
        manager.send(vs)
      else
        manager.send(vs, instance)
      end
      # begin
      #   manager.send(vs)
      # rescue ArgumentError
      #   manager.send(vs, instance)
      # end
    else
      raise ERRORS[:unknown_values_method] % vs.inspect
    end
  when Proc
    vs.call(instance)
  else
    vs
  end
  uniq_name = "#{manager.classe.class.to_s.gsub(/::/,'-')}-#{prop}".downcase
  return PrecedencedList.new(vs, uniq_name)
end

#values_filter ⇒ Object 



426
 
# File 'lib/clir/data_manager/Property.rb', line 426

def values_filter;    @values_filter  ||= data[:values_filter]  end