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

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

Direct Known Subclasses

Git

Constant Summary collapse

SEM_VER = 
/(\d+)(?:(\.)(\d+))?(?:(\.)(\d+)(\S+)?)?/.freeze
0
@@tasks = 
{}

Constants included from Common

Common::ARG

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(workspace, path, name, group: nil, pass: nil, exclude: nil, common: , **kwargs) ⇒ Base

Returns a new instance of Base.



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

def initialize(workspace, path, name, *, group: 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 = []
  @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

#exception ⇒ Object (readonly)

Returns the value of attribute exception.



58
59
60
 
# File 'lib/squared/workspace/project/base.rb', line 58

def exception
  @exception
end

#group ⇒ Object (readonly)

Returns the value of attribute group.



58
59
60
 
# File 'lib/squared/workspace/project/base.rb', line 58

def group
  @group
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



58
59
60
 
# File 'lib/squared/workspace/project/base.rb', line 58

def name
  @name
end

#parent ⇒ Object (readonly)

Returns the value of attribute parent.



58
59
60
 
# File 'lib/squared/workspace/project/base.rb', line 58

def parent
  @parent
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



58
59
60
 
# File 'lib/squared/workspace/project/base.rb', line 58

def path
  @path
end

#pipe ⇒ Object (readonly)

Returns the value of attribute pipe.



58
59
60
 
# File 'lib/squared/workspace/project/base.rb', line 58

def pipe
  @pipe
end

#project ⇒ Object (readonly)

Returns the value of attribute project.



58
59
60
 
# File 'lib/squared/workspace/project/base.rb', line 58

def project
  @project
end

#theme ⇒ Object (readonly)

Returns the value of attribute theme.



58
59
60
 
# File 'lib/squared/workspace/project/base.rb', line 58

def theme
  @theme
end

#verbose ⇒ Object (readonly)

Returns the value of attribute verbose.



58
59
60
 
# File 'lib/squared/workspace/project/base.rb', line 58

def verbose
  @verbose
end

#workspace ⇒ Object (readonly)

Returns the value of attribute workspace.



58
59
60
 
# File 'lib/squared/workspace/project/base.rb', line 58

def workspace
  @workspace
end

Class Method Details

.aliasargs ⇒ Object 



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

def aliasargs(*); end

.as_path(val) ⇒ Object 



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

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

.batchargs ⇒ Object 



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

def batchargs(*); end

.config? ⇒ Boolean

Returns:

  • (Boolean) 


50
51
52
 
# File 'lib/squared/workspace/project/base.rb', line 50

def config?(*)
  false
end

.populate ⇒ Object 



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

def populate(*); end

.ref ⇒ Object 



42
43
44
 
# File 'lib/squared/workspace/project/base.rb', line 42

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

.tasks ⇒ Object 



29
30
31
 
# File 'lib/squared/workspace/project/base.rb', line 29

def tasks
  [].freeze
end

.to_s ⇒ Object 



46
47
48
 
# File 'lib/squared/workspace/project/base.rb', line 46

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

Instance Method Details

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



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

def add(path, name = nil, **kwargs, &blk)
  if path.is_a?(::String) && (data = %r{^(.+)[\\/]\*+$}.match(path))
    path = base_path(data[1]).children.select(&:directory?)
  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 !source_path?(path = base_path(path))
    return self
  elsif !name.is_a?(::String) && !name.is_a?(::Symbol)
    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 



385
386
387
 
# File 'lib/squared/workspace/project/base.rb', line 385

def allref
  @ref.reverse_each
end

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



345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/squared/workspace/project/base.rb', line 345

def base_path(*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 



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/squared/workspace/project/base.rb', line 270

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 = cmd.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) 


419
420
421
 
# File 'lib/squared/workspace/project/base.rb', line 419

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

#clean ⇒ Object 



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/squared/workspace/project/base.rb', line 312

def clean(*)
  case @clean
  when ::String
    run_s(@clean, sync: invoked_sync?('clean'))
  when ::Enumerable
    as_a(@clean).each do |val|
      if (val = val.to_s) =~ %r{[\\/]$}
        dir = Pathname.new(val)
        dir = base_path(dir) unless dir.absolute?
        next unless dir.directory?

        log.warn "rm -rf #{dir}"
        dir.rmtree(verbose: true)
      else
        files = val.include?('*') ? Dir[base_path(val)] : [base_path(val)]
        files.each do |file|
          begin
            File.delete(file) if File.file?(file)
          rescue StandardError => e
            log.error e
          end
        end
      end
    end
  end
end

#clean? ⇒ Boolean

Returns:

  • (Boolean) 


443
444
445
 
# File 'lib/squared/workspace/project/base.rb', line 443

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

#color(val) ⇒ Object 



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

def color(val)
  ret = theme[val]
  ret && !ret.empty? ? ret : [val]
end

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



300
301
302
 
# File 'lib/squared/workspace/project/base.rb', line 300

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

#copy? ⇒ Boolean

Returns:

  • (Boolean) 


431
432
433
 
# File 'lib/squared/workspace/project/base.rb', line 431

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

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



296
297
298
 
# File 'lib/squared/workspace/project/base.rb', line 296

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

#depend? ⇒ Boolean

Returns:

  • (Boolean) 


427
428
429
 
# File 'lib/squared/workspace/project/base.rb', line 427

def depend?
  !!@depend
end

#dev? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

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



304
305
306
 
# File 'lib/squared/workspace/project/base.rb', line 304

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

#doc? ⇒ Boolean

Returns:

  • (Boolean) 


435
436
437
 
# File 'lib/squared/workspace/project/base.rb', line 435

def doc?
  !!@doc
end

#enabled?(ref = nil) ⇒ Boolean

Returns:

  • (Boolean) 


403
404
405
406
407
 
# File 'lib/squared/workspace/project/base.rb', line 403

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

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

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

Returns:

  • (Boolean) 


409
410
411
412
413
 
# File 'lib/squared/workspace/project/base.rb', line 409

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

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

#initialize_build(ref, **kwargs) ⇒ Object 



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
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/squared/workspace/project/base.rb', line 98

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 



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

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, 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 



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

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 



94
95
96
 
# File 'lib/squared/workspace/project/base.rb', line 94

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

#inspect ⇒ Object 



391
392
393
 
# File 'lib/squared/workspace/project/base.rb', line 391

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

#log ⇒ Object 



339
340
341
342
343
 
# File 'lib/squared/workspace/project/base.rb', line 339

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

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

#populate ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/squared/workspace/project/base.rb', line 210

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

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

      desc message(@desc, alt, 'workspace')
      task task_join(alt, 'workspace') => items.map { |item| task_join(item.name, alt) }
    end
  end
end

#prod? ⇒ Boolean

Returns:

  • (Boolean) 


451
452
453
 
# File 'lib/squared/workspace/project/base.rb', line 451

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

#ref ⇒ Object 



206
207
208
 
# File 'lib/squared/workspace/project/base.rb', line 206

def ref
  Base.ref
end

#ref?(val) ⇒ Boolean

Returns:

  • (Boolean) 


415
416
417
 
# File 'lib/squared/workspace/project/base.rb', line 415

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

#script? ⇒ Boolean

Returns:

  • (Boolean) 


423
424
425
 
# File 'lib/squared/workspace/project/base.rb', line 423

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

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



308
309
310
 
# File 'lib/squared/workspace/project/base.rb', line 308

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

#test? ⇒ Boolean

Returns:

  • (Boolean) 


439
440
441
 
# File 'lib/squared/workspace/project/base.rb', line 439

def test?
  !!@test
end

#to_s ⇒ Object 



395
396
397
 
# File 'lib/squared/workspace/project/base.rb', line 395

def to_s
  path.to_s
end

#to_sym ⇒ Object 



399
400
401
 
# File 'lib/squared/workspace/project/base.rb', line 399

def to_sym
  name.to_sym
end

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



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/squared/workspace/project/base.rb', line 362

def variable_set(key, *val, **kwargs)
  if variables.include?(key)
    case key
    when :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)
    else
      instance_variable_set :"@#{key}", val.first
    end
  else
    log.warn "variable_set: @#{key} (private)"
  end
end

#variables ⇒ Object 



381
382
383
 
# File 'lib/squared/workspace/project/base.rb', line 381

def variables
  VAR_SET
end

#version ⇒ Object 



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

def version(*); end

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



230
231
232
233
234
235
236
237
 
# File 'lib/squared/workspace/project/base.rb', line 230

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