Class: Squared::Workspace::Project::Base

Inherits:
Object
  • Object
show all
Includes:
Rake::DSL, Shell, Common::Format, System, Utils
Defined in:
lib/squared/workspace/project/base.rb

Direct Known Subclasses

Git

Constant Summary collapse

@@tasks = 
{
  "#{ref}": {
    graph: %i[run print].freeze
  }.freeze
}
0

Constants included from Common

Common::ARG

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Common::Format

#enable_aixterm

Constructor Details

#initialize(workspace, path, name, group: nil, graph: nil, pass: nil, exclude: nil, common: ARG[:COMMON], **kwargs) ⇒ Base

Returns a new instance of Base.



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
 
# File 'lib/squared/workspace/project/base.rb', line 63

def initialize(workspace, path, name, *, group: nil, graph: nil, pass: nil, exclude: nil,
               common: ARG[:COMMON], **kwargs)
  @path = path
  @workspace = workspace
  @name = name.to_s.freeze
  @project = @path.basename.to_s.freeze
  @group = group&.to_s.freeze
  @depend = kwargs[:depend]
  @doc = kwargs[:doc]
  @test = kwargs[:test]
  @copy = kwargs[:copy]
  @clean = kwargs[:clean]
  @exception = kwargs.key?(:exception) ? env_bool(kwargs[:exception]) : workspace.exception
  @pipe = kwargs.key?(:pipe) ? env_pipe(kwargs[:pipe]) : workspace.pipe
  @verbose = kwargs.key?(:verbose) ? kwargs[:verbose] : workspace.verbose
  @theme = if !@verbose
             {}
           elsif common
             workspace.theme
           else
             __get__(:theme)[:project][to_sym] ||= {}
           end
  @output = []
  @ref = []
  @children = []
  @graph = if graph
             as_a(graph, workspace.prefix ? ->(val) { workspace.task_name(val).to_sym } : :to_sym).freeze
           end
  @pass = (pass ? as_a(pass, :to_sym) : []).freeze
  @exclude = (exclude ? as_a(exclude, :to_sym) : []).freeze
  @envname = @name.gsub(/[^\w]+/, '_').upcase.freeze
  @desc = (@name.include?(':') ? @name.split(':').join(ARG[:SPACE]) : @name).freeze
  @parent = nil
  @global = false
  run_set(kwargs[:run], kwargs[:env], opts: kwargs.fetch(:opts, true))
  initialize_ref(Base.ref)
end

Instance Attribute Details

#dependfile ⇒ Object (readonly)

Returns the value of attribute dependfile.



60
61
62
 
# File 'lib/squared/workspace/project/base.rb', line 60

def dependfile
  @dependfile
end

#exception ⇒ Object (readonly)

Returns the value of attribute exception.



60
61
62
 
# File 'lib/squared/workspace/project/base.rb', line 60

def exception
  @exception
end

#group ⇒ Object (readonly)

Returns the value of attribute group.



60
61
62
 
# File 'lib/squared/workspace/project/base.rb', line 60

def group
  @group
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



60
61
62
 
# File 'lib/squared/workspace/project/base.rb', line 60

def name
  @name
end

#parent ⇒ Object (readonly)

Returns the value of attribute parent.



60
61
62
 
# File 'lib/squared/workspace/project/base.rb', line 60

def parent
  @parent
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



60
61
62
 
# File 'lib/squared/workspace/project/base.rb', line 60

def path
  @path
end

#pipe ⇒ Object (readonly)

Returns the value of attribute pipe.



60
61
62
 
# File 'lib/squared/workspace/project/base.rb', line 60

def pipe
  @pipe
end

#project ⇒ Object (readonly)

Returns the value of attribute project.



60
61
62
 
# File 'lib/squared/workspace/project/base.rb', line 60

def project
  @project
end

#theme ⇒ Object (readonly)

Returns the value of attribute theme.



60
61
62
 
# File 'lib/squared/workspace/project/base.rb', line 60

def theme
  @theme
end

#verbose ⇒ Object (readonly)

Returns the value of attribute verbose.



60
61
62
 
# File 'lib/squared/workspace/project/base.rb', line 60

def verbose
  @verbose
end

#workspace ⇒ Object (readonly)

Returns the value of attribute workspace.



60
61
62
 
# File 'lib/squared/workspace/project/base.rb', line 60

def workspace
  @workspace
end

Class Method Details

.aliasargs ⇒ Object 



24
 
# File 'lib/squared/workspace/project/base.rb', line 24

def aliasargs(*); end

.as_path(val) ⇒ Object 



31
32
33
34
35
36
37
38
 
# File 'lib/squared/workspace/project/base.rb', line 31

def as_path(val)
  case val
  when Pathname
    val
  when String
    Pathname.new(val)
  end
end

.bannerargs ⇒ Object 



25
 
# File 'lib/squared/workspace/project/base.rb', line 25

def bannerargs(*); end

.batchargs ⇒ Object 



23
 
# File 'lib/squared/workspace/project/base.rb', line 23

def batchargs(*); end

.config? ⇒ Boolean

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/squared/workspace/project/base.rb', line 44

def config?(*)
  false
end

.populate ⇒ Object 



22
 
# File 'lib/squared/workspace/project/base.rb', line 22

def populate(*); end

.ref ⇒ Object 



40
41
42
 
# File 'lib/squared/workspace/project/base.rb', line 40

def ref
  @ref ||= to_s.downcase.to_sym
end

.tasks ⇒ Object 



27
28
29
 
# File 'lib/squared/workspace/project/base.rb', line 27

def tasks
  %i[build depend graph doc test copy clean].freeze
end

.to_s ⇒ Object 



48
49
50
 
# File 'lib/squared/workspace/project/base.rb', line 48

def to_s
  super.match(/[^:]+\z/)[0]
end

Instance Method Details

#add(path, name = nil, **kwargs, &blk) ⇒ Object 



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/squared/workspace/project/base.rb', line 289

def add(path, name = nil, **kwargs, &blk)
  checkdir = lambda do |val|
    if val.directory? && !val.empty?
      true
    else
      log&.warn "workspace \"#{val}\" (#{val.empty? ? 'empty' : 'not found'})"
      false
    end
  end
  if path.is_a?(String) && (data = %r{^(.+)[\\/]\*+$}.match(path))
    return self unless checkdir.(path = basepath(data[1]))

    path = path.children.select { |val| checkdir.(val) }
  end
  if path.is_a?(Array)
    name = @name if name == true
    path.each { |val| add(val, name && task_join(name, File.basename(val)), **kwargs, &blk) }
    return self
  elsif !projectpath?(path = basepath(path)) || !checkdir.(path)
    return self
  elsif name.is_a?(Symbol)
    name = name.to_s
  elsif !name.is_a?(String)
    name = nil
  end
  if @withargs
    data = @withargs.dup
    data.merge!(kwargs)
    kwargs = data
  end
  kwargs[:group] = group unless kwargs.key?(:group)
  kwargs[:ref] = ref unless kwargs.key?(:ref)
  parent = self
  proj = nil
  workspace.add(path, name || path.basename, **kwargs) do
    variable_set :parent, parent
    proj = self
  end
  @children << proj
  proj.instance_eval(&blk) if block_given?
  self
end

#allref ⇒ Object 



515
516
517
 
# File 'lib/squared/workspace/project/base.rb', line 515

def allref
  @ref.reverse_each
end

#basepath(*args, ascend: nil) ⇒ Object 



519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/squared/workspace/project/base.rb', line 519

def basepath(*args, ascend: nil)
  ret = path.join(*args)
  return ret unless ascend && !ret.exist?

  path.parent.ascend.each do |dir|
    target = dir.join(*args)
    return target if target.exist?
    break if (ascend.is_a?(String) && dir.join(ascend).exist?) || workspace.root == dir || parent&.path == dir
  end
  ret
end

#build(*args, sync: invoked_sync?('build')) ⇒ Object 



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/squared/workspace/project/base.rb', line 332

def build(*args, sync: invoked_sync?('build'), **)
  if args.empty?
    cmd, opts, var, flags = @output
    banner = verbose == 1
  else
    cmd = args.shift
    opts = args.map { |val| shell_quote(val, force: false) }.join(' ')
    banner = verbose
  end
  if cmd
    case opts
    when String
      cmd = "#{cmd} #{opts}"
    when Array
      cmd = as_a(cmd).concat(opts).join(' && ')
    else
      cmd = [cmd, compose(opts, script: false)].compact.join(' ') unless opts == false || !respond_to?(:compose)
    end
  else
    return unless respond_to?(:compose)

    cmd = compose(opts, flags, script: true)
  end
  run(cmd, var, banner: banner, sync: sync)
end

#build? ⇒ Boolean

Returns:

  • (Boolean) 


463
464
465
 
# File 'lib/squared/workspace/project/base.rb', line 463

def build?
  !!@output[0] || script?
end

#clean ⇒ Object 



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
 
# File 'lib/squared/workspace/project/base.rb', line 374

def clean(*)
  case @clean
  when String
    run_s(@clean, sync: invoked_sync?('clean'))
  when Enumerable
    (@clean.is_a?(Hash) ? @clean.values : as_a(@clean)).each do |val|
      val = val.to_s
      path = basepath(val)
      if path.directory? && val =~ %r{[\\/]$}
        log&.warn "rm -rf #{path}"
        path.rmtree
      else
        files = val.include?('*') ? Dir[path] : [path]
        files.each do |file|
          next unless File.file?(file)

          begin
            File.delete(file)
          rescue StandardError => e
            log&.error e
          end
        end
      end
    end
  end
end

#clean? ⇒ Boolean

Returns:

  • (Boolean) 


491
492
493
 
# File 'lib/squared/workspace/project/base.rb', line 491

def clean?
  runnable?(@clean) || workspace.task_defined?(name, 'clean')
end

#copy(sync: invoked_sync?('copy')) ⇒ Object 



362
363
364
 
# File 'lib/squared/workspace/project/base.rb', line 362

def copy(*, sync: invoked_sync?('copy'), **)
  run_s(@copy, sync: sync) if @copy
end

#copy? ⇒ Boolean

Returns:

  • (Boolean) 


479
480
481
 
# File 'lib/squared/workspace/project/base.rb', line 479

def copy?
  runnable?(@copy) || workspace.task_defined?(name, 'copy')
end

#depend(sync: invoked_sync?('depend')) ⇒ Object 



358
359
360
 
# File 'lib/squared/workspace/project/base.rb', line 358

def depend(*, sync: invoked_sync?('depend'), **)
  run(@depend, sync: sync) if @depend
end

#depend? ⇒ Boolean

Returns:

  • (Boolean) 


471
472
473
 
# File 'lib/squared/workspace/project/base.rb', line 471

def depend?
  !!@depend
end

#dependtype ⇒ Object 



505
506
507
 
# File 'lib/squared/workspace/project/base.rb', line 505

def dependtype(*)
  @dependindex ? @dependindex.succ : 0
end

#dev? ⇒ Boolean

Returns:

  • (Boolean) 


495
496
497
 
# File 'lib/squared/workspace/project/base.rb', line 495

def dev?
  @dev != false && workspace.dev?(pat: @dev, **scriptargs)
end

#doc(sync: invoked_sync?('doc')) ⇒ Object 



366
367
368
 
# File 'lib/squared/workspace/project/base.rb', line 366

def doc(*, sync: invoked_sync?('doc'), **)
  build(*as_a(@doc), sync: sync) if @doc
end

#doc? ⇒ Boolean

Returns:

  • (Boolean) 


483
484
485
 
# File 'lib/squared/workspace/project/base.rb', line 483

def doc?
  !!@doc
end

#enabled?(ref = nil) ⇒ Boolean

Returns:

  • (Boolean) 


447
448
449
450
451
 
# File 'lib/squared/workspace/project/base.rb', line 447

def enabled?(ref = nil)
  return false if ref && !ref?(ref)

  path.directory? && !path.empty?
end

#graph(start = [], tasks = nil, sync: invoked_sync?('graph'), pass: [], out: nil) ⇒ Object 



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/squared/workspace/project/base.rb', line 401

def graph(start = [], tasks = nil, sync: invoked_sync?('graph'), pass: [], out: nil)
  if (val = env('GRAPH', strict: true))
    tasks ||= []
    split_escape(val).each do |task|
      if ref?(task.to_sym) && (script = workspace.script_get(:graph, ref: task.to_sym))
        tasks += script[:graph]
      else
        tasks << task
      end
    end
  end
  pass.concat(split_escape(val)) if (val = env('GRAPH_PASS', strict: true))
  data = graph_collect(self, start)
  data[name] << self unless out
  done = run_graph(data, name, tasks, out, sync: sync, pass: pass)
  [out, done] if out
end

#graph? ⇒ Boolean

Returns:

  • (Boolean) 


475
476
477
 
# File 'lib/squared/workspace/project/base.rb', line 475

def graph?
  @graph.is_a?(Array) && !@graph.empty?
end

#has?(meth, ref = nil) ⇒ Boolean

Returns:

  • (Boolean) 


453
454
455
456
457
 
# File 'lib/squared/workspace/project/base.rb', line 453

def has?(meth, ref = nil)
  return false if ref && !ref?(ref)

  respond_to?(meth = :"#{meth}?") && __send__(meth)
end

#initialize_build(ref, **kwargs) ⇒ Object 



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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/squared/workspace/project/base.rb', line 105

def initialize_build(ref, **kwargs)
  initialize_ref(ref)
  if (@script = @workspace.script_get(group: @group, ref: ref))
    if @script[:log] && !kwargs.key?(:log)
      kwargs[:log] = @script[:log]
      @log = nil
    end
    @depend = @script[:depend] if @depend.nil?
    @doc = @script[:doc] if @doc.nil?
    @test = @script[:test] if @test.nil?
    @clean = @script[:clean] if @clean.nil?
    @exclude = @script[:exclude] if @exclude.empty? && @script.key?(:exclude)
  end
  initialize_logger(**kwargs)
  return if @output[0] == false

  data = @workspace.script_find(*@ref, @group)
  if @output[0].nil?
    if (scr = data[:script])
      @global = true
      script_set(scr, prod: kwargs[:prod])
    elsif (run = data[:run])
      @global = true
      run_set run
    end
    unless data[:env]
      if (scr = kwargs[:script])
        @global = false
        script_set scr
      elsif @script && !data[:global]
        if (scr = @script[:script])
          @global = false
          script_set scr
        elsif (run = @script[:run])
          @global = false
          run_set run
        end
      end
    end
  elsif data[:env] && data[:run]
    @global = true
    run_set data[:run]
  end
end

#initialize_env(dev: nil, prod: nil) ⇒ Object 



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/squared/workspace/project/base.rb', line 184

def initialize_env(dev: nil, prod: nil, **)
  pre = "BUILD_#{@envname}"
  @dev = env_match("#{pre}_DEV", dev)
  @prod = env_match("#{pre}_PROD", prod)
  cmd = @output[0]
  unless cmd == false || cmd.is_a?(Array) || (val = env('BUILD', suffix: 'OPTS')).nil?
    @output[cmd ? 1 : 3] = shell_split(val, escape: false, join: true)
  end
  unless @output[2] == false || (val = env('BUILD', suffix: 'ENV')).nil?
    begin
      data = JSON.parse(val)
      raise_error('invalid JSON object', val, hint: "#{prefix}_ENV") unless data.is_a?(Hash)
      @output[2] = data
    rescue StandardError => e
      log&.warn e
    end
  end
  return unless (val = env('BUILD', strict: true))

  @global = false
  if val == '0'
    @output = [false]
  elsif script?
    script_set val
  else
    run_set val
  end
end

#initialize_logger(log: nil) ⇒ Object 



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
 
# File 'lib/squared/workspace/project/base.rb', line 150

def initialize_logger(log: nil, **)
  return if @log

  log = log.is_a?(Hash) ? log.dup : { file: log }
  unless (file = env('LOG_FILE'))
    file = case env('LOG_AUTO')
           when 'y', 'year'
             "#{@name}-#{Date.today.year}.log"
           when 'm', 'month'
             "#{@name}-#{Date.today.strftime('%Y-%m')}.log"
           when 'd', 'day', '1'
             "#{@name}-#{Date.today}.log"
           end
  end
  if file ||= log[:file]
    file = Date.today.strftime(file)
    file = (dir = env('LOG_DIR')) ? @workspace.home.join(dir, file) : @workspace.home.join(file)
    begin
      file = file.realdirpath
    rescue StandardError => e
      raise if @exception

      file = nil
      warn log_message(Logger::WARN, e) if warning?
    end
  end
  log[:progname] ||= @name
  if (val = env('LOG_LEVEL', ignore: false))
    log[:level] = val
  end
  log.delete(:file)
  @log = [file, log]
end

#initialize_ref(ref) ⇒ Object 



101
102
103
 
# File 'lib/squared/workspace/project/base.rb', line 101

def initialize_ref(ref)
  @ref << ref unless @exclude.include?(ref)
end

#inspect ⇒ Object 



531
532
533
 
# File 'lib/squared/workspace/project/base.rb', line 531

def inspect
  "#<#{self.class}: #{name} => #{self}>"
end

#log ⇒ Object 



509
510
511
512
513
 
# File 'lib/squared/workspace/project/base.rb', line 509

def log
  return @log unless @log.is_a?(Array)

  @log = Logger.new(enabled? ? @log[0] : nil, **@log[1])
end

#populate ⇒ Object 



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/squared/workspace/project/base.rb', line 217

def populate(*)
  namespace name do
    workspace.series.each_key do |key|
      next unless workspace.task_include?(self, key)

      s = workspace.series.name_get(key)
      unless workspace.task_defined?(name, s)
        desc message(@desc, s)
        task s do
          __send__(key)
        end
      end
      next if (items = @children.select { |item| workspace.task_include?(item, key) }).empty?

      desc message(@desc, s, 'workspace')
      task task_join(s, 'workspace') => items.map { |item| task_join(item.name, s) }
    end
    next unless ref?(Base.ref)

    @@tasks[Base.ref].each do |action, flags|
      namespace action do
        flags.each do |flag|
          case action
          when :graph
            next unless graph?

            check = lambda do |args|
              next args if (args = args.to_a).empty?

              guard_params(action, flag, args: args.reject { |val| name == val.to_s })
            end

            desc format_desc(action, flag, 'project*')
            if flag == :run
              task flag, [:project] do |_, args|
                graph check.(args)
              end
            else
              task flag, [:project] do |_, args|
                out, done = graph(check.(args), out: [])
                out.map! do |val|
                  done.each_with_index do |proj, i|
                    next unless val.end_with?(" #{proj.name}")

                    val += " (#{i.succ})"
                    break
                  end
                  val
                end
                emphasize(out, title: path, right: true, border: borderstyle, sub: [
                  { pat: /\A(#{Regexp.escape(path.to_s)})(.*)\z/, styles: theme[:header] },
                  { pat: /\A(#{Regexp.escape(name)})(.*)\z/, styles: theme[:active] },
                  { pat: /\A(.+ )(\()(\d+)(\))(.*)\z/, styles: theme[:inline], index: 3 }
                ])
              end
            end
          end
        end
      end
    end
  end
end

#prod? ⇒ Boolean

Returns:

  • (Boolean) 


499
500
501
 
# File 'lib/squared/workspace/project/base.rb', line 499

def prod?
  @prod != false && workspace.prod?(pat: @prod, **scriptargs)
end

#ref ⇒ Object 



213
214
215
 
# File 'lib/squared/workspace/project/base.rb', line 213

def ref
  Base.ref
end

#ref?(val) ⇒ Boolean

Returns:

  • (Boolean) 


459
460
461
 
# File 'lib/squared/workspace/project/base.rb', line 459

def ref?(val)
  @ref.include?(val)
end

#script? ⇒ Boolean

Returns:

  • (Boolean) 


467
468
469
 
# File 'lib/squared/workspace/project/base.rb', line 467

def script?
  @output[0].nil? && !!@output[1] && respond_to?(:compose)
end

#test(sync: invoked_sync?('test')) ⇒ Object 



370
371
372
 
# File 'lib/squared/workspace/project/base.rb', line 370

def test(*, sync: invoked_sync?('test'), **)
  build(*as_a(@test), sync: sync) if @test
end

#test? ⇒ Boolean

Returns:

  • (Boolean) 


487
488
489
 
# File 'lib/squared/workspace/project/base.rb', line 487

def test?
  !!@test
end

#to_s ⇒ Object 



535
536
537
 
# File 'lib/squared/workspace/project/base.rb', line 535

def to_s
  path.to_s
end

#to_sym ⇒ Object 



539
540
541
 
# File 'lib/squared/workspace/project/base.rb', line 539

def to_sym
  name.to_sym
end

#variable_set(key, *val, **kwargs) ⇒ Object 



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/squared/workspace/project/base.rb', line 419

def variable_set(key, *val, **kwargs)
  if variables.include?(key)
    case key
    when :build, :run
      run_set(*val, **kwargs)
    when :script
      script_set(*val, **kwargs)
    when :env
      run_set(output[0], *val, **kwargs)
    when :parent
      @parent = val if (val = val.first).is_a?(Project::Base)
    when :graph
      @graph = case val.first
               when nil, false
                 nil
               else
                 val.flatten.map!(&:to_s).freeze
               end
    when :dependfile
      @dependfile = basepath(*val)
    else
      instance_variable_set :"@#{key}", val.first
    end
  else
    log&.warn "variable_set: @#{key} (private)"
  end
end

#version ⇒ Object 



503
 
# File 'lib/squared/workspace/project/base.rb', line 503

def version(*); end

#with(**kwargs, &blk) ⇒ Object 



280
281
282
283
284
285
286
287
 
# File 'lib/squared/workspace/project/base.rb', line 280

def with(**kwargs, &blk)
  @withargs = kwargs.empty? ? nil : kwargs
  if block_given?
    instance_eval(&blk)
    @withargs = nil
  end
  self
end