Class: Roger::Release

Inherits:
Object
  • Object
show all
Defined in:
lib/roger/release.rb

Defined Under Namespace

Modules: Finalizers, Processors, Scm Classes: Cleaner, Injector

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(project, config = {}) ⇒ Release

Returns a new instance of Release.

Parameters:

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

    a customizable set of options

Options Hash (config):

  • :scm (Symbol) —

    The SCM to use (default = :git)

  • :target_path (String, Pathname) —

    The path/directory to put the release into

  • :build_path (String, Pathname) —

    Temporary path used to build the release

  • :cleanup_build (Boolean) —

    Wether or not to remove the build_path after we’re done (default = true)



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/roger/release.rb', line 48

def initialize(project, config = {})
  defaults = {
    :scm => :git,
    :source_path  => Pathname.new(Dir.pwd) + "html",
    :target_path => Pathname.new(Dir.pwd) + "releases",
    :build_path => Pathname.new(Dir.pwd) + "build",
    :cleanup_build => true
  }
  
  @config = {}.update(defaults).update(config)
  @project = project
  @stack = []
  @finalizers = []
end

Instance Attribute Details

#cleanups ⇒ Object (readonly)

Returns the value of attribute cleanups.



8
9
10
 
# File 'lib/roger/release.rb', line 8

def cleanups
  @cleanups
end

#config ⇒ Object (readonly)

Returns the value of attribute config.



6
7
8
 
# File 'lib/roger/release.rb', line 6

def config
  @config
end

#finalizers ⇒ Object (readonly)

Returns the value of attribute finalizers.



8
9
10
 
# File 'lib/roger/release.rb', line 8

def finalizers
  @finalizers
end

#injections ⇒ Object (readonly)

Returns the value of attribute injections.



8
9
10
 
# File 'lib/roger/release.rb', line 8

def injections
  @injections
end

#project ⇒ Object (readonly)

Returns the value of attribute project.



6
7
8
 
# File 'lib/roger/release.rb', line 6

def project
  @project
end

#stack ⇒ Object (readonly)

Returns the value of attribute stack.



8
9
10
 
# File 'lib/roger/release.rb', line 8

def stack
  @stack
end

Class Method Details

.default_finalizers ⇒ Object 



16
17
18
 
# File 'lib/roger/release.rb', line 16

def default_finalizers
  [[self.get_callable(:dir, Roger::Release::Finalizers.map), {}]]
end

.default_stack ⇒ Object 



12
13
14
 
# File 'lib/roger/release.rb', line 12

def default_stack
  []
end

.get_callable(callable, map) ⇒ Object

Makes callable into a object that responds to call.

Parameters:

  • callable (#call, Symbol, Class) —

    If callable already responds to #call will just return callable, a Symbol will be searched for in the scope parameter, a class will be instantiated (and checked if it will respond to #call)

  • map, (Hash) —

    Mapping to match symbol to a callable



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/roger/release.rb', line 24

def get_callable(callable, map)
  return callable if callable.respond_to?(:call)

  if callable.kind_of?(Symbol) && map.has_key?(callable)
    callable = map[callable]
  end

  if callable.kind_of?(Class)
    callable = callable.new
  end

  if callable.respond_to?(:call)
    callable
  else
    raise ArgumentError, "Could not resolve #{callable.inspect}. Callable must be an object that responds to #call or a symbol that resolve to such an object or a class with a #call instance method."
  end

end

Instance Method Details

Generates a banner if a block is given, or returns the currently set banner. It automatically takes care of adding comment marks around the banner.

The default banner looks like this:

Version : v1.0.0 =

Date : 2012-06-20 =

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :comment (:css, :js, :html, false) —

    Wether or not to comment the output and in what style. (default=js)



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
 
# File 'lib/roger/release.rb', line 151

def banner(options = {}, &block)
  options = {
    :comment => :js
  }.update(options)
  
  if block_given?
    @_banner = yield.to_s
  elsif !@_banner
    banner = []
    banner << "Version : #{self.scm.version}"
    banner << "Date  : #{self.scm.date.strftime("%Y-%m-%d")}"

    size = banner.inject(0){|mem,b| b.size > mem ? b.size : mem }
    banner.map!{|b| "= #{b.ljust(size)} =" }
    div = "=" * banner.first.size
    banner.unshift(div)
    banner << div
    @_banner = banner.join("\n")
  end
  
  if options[:comment]
    self.comment(@_banner, :style => options[:comment])
  else
    @_banner
  end
end

#build_path ⇒ Object

Accessor for build_path The build_path is a temporary directory where the release will be built

Returns:

  • Pathname the build_path



75
76
77
 
# File 'lib/roger/release.rb', line 75

def build_path
  Pathname.new(self.config[:build_path])      
end

#cleanup(pattern) ⇒ Object

Files to clean up in the build directory just before finalization happens

Parameters:

  • Pattern (String) —

    to glob within build directory



135
136
137
 
# File 'lib/roger/release.rb', line 135

def cleanup(pattern)
  @stack << Cleaner.new(pattern)
end

#debug(part, msg, &block) ⇒ Object 



225
226
227
 
# File 'lib/roger/release.rb', line 225

def debug(part, msg, &block)
  self.log(part, msg, true, &block)
end

#extract(options = {}) ⇒ Object

Deprecated.

Don’t use the extractor anymore, use release.use(:mockup, options) processor

Extract the mockup, this will happen anyway, and will always happen first This method gives you a way to pass options to the extractor.

Parameters:

  • Hash —

    options Options hash passed to extractor



184
185
186
187
 
# File 'lib/roger/release.rb', line 184

def extract(options = {})
  self.warn(self, "Don't use the extractor anymore, use release.use(:mockup, options) and release.use(:url_relativizer, options) processors")
  @extractor_options = options
end

#finalize(finalizer, options = {}) ⇒ Object

Write out the whole release into a directory, zip file or anything you can imagine #finalize can be called multiple times, it just will run all of them.

The default finalizer is :dir

Parameters:

  • Finalizer (Symbol, Proc) —

    to use



125
126
127
 
# File 'lib/roger/release.rb', line 125

def finalize(finalizer, options = {})
  @finalizers << [self.class.get_callable(finalizer, Roger::Release::Finalizers.map), options]
end

#get_files(globs, excludes = []) ⇒ Object

Parameters:

  • globs (Array) —

    an array of file path globs that will be globbed against the build_path

  • excludes (Array) (defaults to: []) —

    an array of regexps that will be excluded from the result



237
238
239
240
241
242
243
244
 
# File 'lib/roger/release.rb', line 237

def get_files(globs, excludes = [])
  files = globs.map{|g| Dir.glob(self.build_path + g) }.flatten
  if excludes.any?
    files.reject{|c| excludes.detect{|e| e.match(c) } }
  else
    files
  end
end

#inject(variables, options) ⇒ Object

Inject variables into files with an optional filter



104
105
106
 
# File 'lib/roger/release.rb', line 104

def inject(variables, options)
  @stack << Injector.new(variables, options)
end

#log(part, msg, verbose = false, &block) ⇒ Object

Write out a log message



211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/roger/release.rb', line 211

def log(part, msg, verbose = false, &block)
  if !verbose || verbose && self.project.options[:verbose]
    self.project.shell.say "\033[37m#{part.class.to_s}\033[0m" + " : " + msg.to_s, nil, true
  end
  if block_given?
    begin
      self.project.shell.padding = self.project.shell.padding + 1
      yield
    ensure
      self.project.shell.padding = self.project.shell.padding - 1
    end
  end
end

#run! ⇒ Object

Actually perform the release



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/roger/release.rb', line 190

def run!
  # Validate paths
  validate_paths!
  
  # Extract mockup
  copy_source_path_to_build_path!
  
  validate_stack!
  
  # Run stack
  run_stack!
  
  # Run finalizers
  run_finalizers!
  
  # Cleanup
  cleanup! if self.config[:cleanup_build]
  
end

#scm(force = false) ⇒ Object

Get the current SCM object



88
89
90
91
92
93
94
95
96
97
 
# File 'lib/roger/release.rb', line 88

def scm(force = false)
  return @_scm if @_scm && !force
  
  case self.config[:scm]
  when :git
    @_scm = Release::Scm::Git.new(:path => self.source_path)
  else
    raise "Unknown SCM #{options[:scm].inspect}"
  end
end

#source_path ⇒ Object

Accessor for source_path The source path is the root of the mockup

Returns:

  • Pathanem the source_path



83
84
85
 
# File 'lib/roger/release.rb', line 83

def source_path
  Pathname.new(self.config[:source_path])
end

#target_path ⇒ Object

Accessor for target_path The target_path is the path where the finalizers will put the release

Returns:

  • Pathname the target_path



67
68
69
 
# File 'lib/roger/release.rb', line 67

def target_path
  Pathname.new(self.config[:target_path])
end

#use(processor, options = {}) ⇒ Object

Use a certain pre-processor



112
113
114
 
# File 'lib/roger/release.rb', line 112

def use(processor, options = {})
  @stack << [self.class.get_callable(processor, Roger::Release::Processors.map), options]
end

#warn(part, msg) ⇒ Object

Write out a warning message



230
231
232
 
# File 'lib/roger/release.rb', line 230

def warn(part, msg)
  self.project.shell.say "\033[37m#{part.class.to_s}\033[0m" + " : " + "\033[31m#{msg.to_s}\033[0m", nil, true
end