Module: Grably::Job::ClassMethods

Defined in:
lib/grably/job/class.rb

Overview

:nodoc:

Instance Method Summary collapse

Instance Method Details

#call_as(name) ⇒ Object 



78
79
80
 
# File 'lib/grably/job/class.rb', line 78

def call_as(name)
  @job_call_name = name
end

#job_args ⇒ Object 



66
67
68
 
# File 'lib/grably/job/class.rb', line 66

def job_args
  @job_args ||= {}
end

#job_call_name ⇒ Object 



70
71
72
73
74
75
76
 
# File 'lib/grably/job/class.rb', line 70

def job_call_name
  return unless name # TODO: in runtime some anonymous sublcass instances
  # can be created find out when and why
  # job_call_name by user with call_as method. Yet it is not required
  # if job_call_name empty we'll try to sytetize job name
  @job_call_name ||= synthesize_job_name
end

#opt(name, extras = {}) ⇒ Object

Mark instance variable as option container. When field contains option job will track its value between launches. If value was changed since last run job is considered as changed and will be rebuild. This method also generates attribute_reader for given variable.

Parameters:

  • name (Symbol) —

    attribute name

  • extras (Hash) (defaults to: {}) —

    extra arguments. Now unsued.



55
56
57
58
59
60
 
# File 'lib/grably/job/class.rb', line 55

def opt(name, extras = {})
  class_exec do
    attr_reader name
    register_job_argument(name, :opt, extras)
  end
end

#register_job_argument(name, type, extras) ⇒ Object 



62
63
64
 
# File 'lib/grably/job/class.rb', line 62

def register_job_argument(name, type, extras)
  job_args[name] = [type, extras]
end

#src(name, extras = {}) ⇒ Object

Mark instance variable as source product container. When field contains source product job will track its state between launches. If product was changed since last run job is considered as changed and will be rebuild. This method also generates attribute_reader for given variable.

Parameters:

  • name (Symbol) —

    attribute name

  • extras (Hash) (defaults to: {}) —

    extra arguments. Now unsued.



10
11
12
13
14
15
 
# File 'lib/grably/job/class.rb', line 10

def src(name, extras = {})
  class_exec do
    attr_reader name
    register_job_argument(name, :src, extras)
  end
end

#srcs(name, extras = {}) ⇒ Object

Mark instance variable as multiple source product container. When field contains multiple src products job will track each product state between launches. If any of source products was changed since last run job is considered as changed and will be rebuild. This method also generates attribute_reader for given variable.

Parameters:

  • name (Symbol) —

    attribute name

  • extras (Hash) (defaults to: {}) —

    extra arguments. Now unsued.



24
25
26
27
28
29
 
# File 'lib/grably/job/class.rb', line 24

def srcs(name, extras = {})
  class_exec do
    attr_reader name
    register_job_argument(name, :srcs, extras)
  end
end

#srcs!(name, extras = {}) ⇒ Object

Mark instance variable as incremental sources container. When field contains incremental sources it does not impact on job state. But job setup will generate state delta between two launches. This allows to decide if job should be rebuild completely or only changed files should be rebuild. This method generates two syntatic instance methods:

  • standart attribute accessor which contains current products

  • ! attribute_accessor (i.e. foo! ) which will return delta array in following format: [ modifications, additions, deletions ]

Parameters:

  • name (Symbol) —

    attribute name

  • extras (Hash) (defaults to: {}) —

    extra arguments. Now unsued.



41
42
43
44
45
46
47
 
# File 'lib/grably/job/class.rb', line 41

def srcs!(name, extras = {})
  class_exec do
    attr_reader name
    register_job_argument(name, :isrcs, extras)
    eval("def #{name}!; @deltas[:#{name}]; end") # rubocop:disable Security/Eval
  end
end

#synthesize_job_name ⇒ Object

Try to syntetize job name from class name

  • Strip all parent modules names

  • Cut off Job postfix from class name if any

  • convert class name to snake case



86
87
88
89
90
 
# File 'lib/grably/job/class.rb', line 86

def synthesize_job_name
  klass_name = name.scan(/[^:]+/).last
  klass_name = klass_name[/(.+)Job/, 1] || klass_name
  klass_name.scan(/[A-Z][a-z]+/).map(&:downcase).join('_').to_sym
end