Class: Squared::Repo::Project::Base

Inherits:
Object
  • Object
show all
Extended by:
Forwardable, Rake::DSL, Common::Task
Includes:
Rake::DSL, Shell, Common, System, Task
Defined in:
lib/squared/repo/project/base.rb

Direct Known Subclasses

Git

Constant Summary collapse 

0
@@tasks = 
{}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Common::Task

collect_args, invoke, invoked?

Methods included from Common

#__get__, #__set__, #as_a, #finalize!, #message

Constructor Details

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

Returns a new instance of Base.



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

def initialize(name, path, workspace, *, group: nil, log: nil, common: true, **kwargs)
  @name = name.to_s
  @path = workspace.root_path(path.to_s)
  @project = @path.basename.to_s
  @workspace = workspace
  @group = group&.to_s
  @depend = kwargs[:depend]
  @doc = kwargs[:doc]
  @test = kwargs[:test]
  @output = [kwargs[:run], nil]
  @copy = kwargs[:copy]
  @clean = kwargs[:clean]
  @theme = if common
             workspace.theme
           else
             __get__(:theme)[:project][to_sym] ||= {}
           end
  @warning = workspace.warning
  log = { file: log } unless log.is_a?(::Hash)
  if (logfile = env('LOG_FILE')).nil? && (auto = env('LOG_AUTO'))
    logfile = case 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 logfile ||= log[:file]
    logfile = Date.today.strftime(logfile)
    logfile = (dir = env('LOG_DIR')) ? Pathname.new(dir).join(logfile) : Pathname.new(logfile)
    begin
      logfile.realdirpath
    rescue StandardError => e
      logfile = nil
      __warn__ e if @warning
    end
  end
  @logger = Logger.new(logfile, progname: @name, level: env('LOG_LEVEL') || log[:level] || Logger::INFO)
end

Instance Attribute Details

#group ⇒ Object (readonly)

Returns the value of attribute group.



47
48
49
 
# File 'lib/squared/repo/project/base.rb', line 47

def group
  @group
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



47
48
49
 
# File 'lib/squared/repo/project/base.rb', line 47

def name
  @name
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



47
48
49
 
# File 'lib/squared/repo/project/base.rb', line 47

def path
  @path
end

#project ⇒ Object (readonly)

Returns the value of attribute project.



47
48
49
 
# File 'lib/squared/repo/project/base.rb', line 47

def project
  @project
end

#theme ⇒ Object (readonly)

Returns the value of attribute theme.



47
48
49
 
# File 'lib/squared/repo/project/base.rb', line 47

def theme
  @theme
end

#warning ⇒ Object

Returns the value of attribute warning.



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

def warning
  @warning
end

#workspace ⇒ Object (readonly)

Returns the value of attribute workspace.



47
48
49
 
# File 'lib/squared/repo/project/base.rb', line 47

def workspace
  @workspace
end

Class Method Details

.as_path(val) ⇒ Object 



27
28
29
30
31
 
# File 'lib/squared/repo/project/base.rb', line 27

def as_path(val)
  return val if val.is_a?(::Pathname)

  val.is_a?(::String) ? Pathname.new(val) : nil
end

.populate ⇒ Object 



21
 
# File 'lib/squared/repo/project/base.rb', line 21

def populate(*); end

.tasks ⇒ Object 



23
24
25
 
# File 'lib/squared/repo/project/base.rb', line 23

def tasks
  [].freeze
end

.to_s ⇒ Object 



33
34
35
 
# File 'lib/squared/repo/project/base.rb', line 33

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

.to_sym ⇒ Object 



37
38
39
 
# File 'lib/squared/repo/project/base.rb', line 37

def to_sym
  to_s.downcase.to_sym
end

Instance Method Details

#base_path(*args) ⇒ Object 



220
221
222
 
# File 'lib/squared/repo/project/base.rb', line 220

def base_path(*args)
  path.join(*args)
end

#build(*args) ⇒ Object 



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/squared/repo/project/base.rb', line 142

def build(*args)
  if args.empty?
    cmd, opts = @output
    opts &&= shell_escape(opts)
  else
    cmd = args.shift
    opts = sanitize_args(*args)
  end
  if cmd
    if opts
      cmd = "#{cmd} #{opts}"
    elsif cmd.is_a?(::Array)
      cmd = cmd.join(' && ')
    end
    banner = verbose?
  else
    return unless respond_to?(:compose)

    cmd = compose(opts)
    banner = env('REPO_BUILD') == 'verbose'
  end
  run(cmd, exception: workspace.exception, banner: banner)
end

#build? ⇒ Boolean

Returns:

  • (Boolean) 


244
245
246
 
# File 'lib/squared/repo/project/base.rb', line 244

def build?
  !!@output[0]
end

#clean ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/squared/repo/project/base.rb', line 192

def clean
  return unless @clean

  if @clean.is_a?(::String)
    run_s @clean
  else
    @clean.each do |val|
      if (val = val.to_s).match?(%r{[\\/]$})
        dir = Pathname.new(val)
        dir = base_path(dir) unless dir.absolute?
        next unless dir.directory?

        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
            error e
          end
        end
      end
    end
  end
end

#clean? ⇒ Boolean

Returns:

  • (Boolean) 


268
269
270
 
# File 'lib/squared/repo/project/base.rb', line 268

def clean?
  !!@clean
end

#copy ⇒ Object 



180
181
182
 
# File 'lib/squared/repo/project/base.rb', line 180

def copy(*)
  run_s @copy
end

#copy? ⇒ Boolean

Returns:

  • (Boolean) 


264
265
266
 
# File 'lib/squared/repo/project/base.rb', line 264

def copy?
  @copy.is_a?(::String)
end

#depend ⇒ Object 



176
177
178
 
# File 'lib/squared/repo/project/base.rb', line 176

def depend(*)
  run(@depend, exception: workspace.exception) if @depend
end

#depend? ⇒ Boolean

Returns:

  • (Boolean) 


252
253
254
 
# File 'lib/squared/repo/project/base.rb', line 252

def depend?
  !!@depend
end

#doc ⇒ Object 



184
185
186
 
# File 'lib/squared/repo/project/base.rb', line 184

def doc
  build @doc if @doc
end

#doc? ⇒ Boolean

Returns:

  • (Boolean) 


256
257
258
 
# File 'lib/squared/repo/project/base.rb', line 256

def doc?
  !!@doc
end

#enabled? ⇒ Boolean

Returns:

  • (Boolean) 


236
237
238
 
# File 'lib/squared/repo/project/base.rb', line 236

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

#has?(method) ⇒ Boolean

Returns:

  • (Boolean) 


240
241
242
 
# File 'lib/squared/repo/project/base.rb', line 240

def has?(method)
  respond_to?(m = :"#{method}?") && __send__(m)
end

#initialize_build(ref, **kwargs) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/squared/repo/project/base.rb', line 96

def initialize_build(ref, **kwargs)
  initialize_script(ref)
  if (val = env('BUILD', strict: true))
    @output[0] = val
  elsif @script && @output[0] != false
    @output[0] ||= @script[:run]
  end
  if env('BUILD', suffix: 'DEV', equals: '0')
    @dev = false
  else
    @dev = kwargs.delete(:dev)
    if env('BUILD', suffix: 'DEV')
      @dev = true
    elsif @dev.nil?
      @dev = workspace.dev?
    end
  end
end

#initialize_script(ref) ⇒ Object 



115
116
117
118
119
120
121
122
123
 
# File 'lib/squared/repo/project/base.rb', line 115

def initialize_script(ref)
  return unless (script = workspace.script(group: group, ref: ref))

  @depend = script[:depend] if @depend.nil?
  @doc = script[:doc] if @doc.nil?
  @test = script[:test] if @test.nil?
  @clean = script[:clean] if @clean.nil?
  @script = script
end

#inspect ⇒ Object 



224
225
226
 
# File 'lib/squared/repo/project/base.rb', line 224

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

#populate ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/squared/repo/project/base.rb', line 125

def populate(*)
  namespace name do
    workspace.series.each_key do |key|
      case key
      when :build, :refresh, :depend, :outdated, :doc, :test, :copy, :clean
        next unless has?(key)
      else
        next unless workspace.task_defined?(self, key)
      end
      desc message(name, key)
      task key do
        __send__(key)
      end
    end
  end
end

#refresh ⇒ Object 



166
167
168
169
170
171
172
173
174
 
# File 'lib/squared/repo/project/base.rb', line 166

def refresh(*)
  build
  key = "#{name}:copy"
  if ::Rake::Task.task_defined?(key)
    invoke key
  else
    copy
  end
end

#refresh? ⇒ Boolean

Returns:

  • (Boolean) 


248
249
250
 
# File 'lib/squared/repo/project/base.rb', line 248

def refresh?
  build? && (copy? || ::Rake::Task.task_defined?("#{name}:copy"))
end

#test ⇒ Object 



188
189
190
 
# File 'lib/squared/repo/project/base.rb', line 188

def test
  build @test if @test
end

#test? ⇒ Boolean

Returns:

  • (Boolean) 


260
261
262
 
# File 'lib/squared/repo/project/base.rb', line 260

def test?
  !!@test
end

#to_s ⇒ Object 



228
229
230
 
# File 'lib/squared/repo/project/base.rb', line 228

def to_s
  path.to_s
end

#to_sym ⇒ Object 



232
233
234
 
# File 'lib/squared/repo/project/base.rb', line 232

def to_sym
  name.to_sym
end