Module: Burke

Defined in:
lib/burke.rb

Defined Under Namespace

Classes: GemSettings, GemTaskManager

Constant Summary collapse

VERSION = 
File.read(File.join(File.dirname(File.dirname(__FILE__)), 'VERSION'))

Class Method Summary collapse

Class Method Details

.base_gemspec ⇒ Object 



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/burke.rb', line 187

def base_gemspec
  if @base_gemspec.nil?
    @base_gemspec = Gem::Specification.new
    
    attrs = Gem::Specification.attribute_names
    attrs -= [:dependencies]
    attrs += [:author]
    
    attrs.each do |attr|
      value = @settings.send(attr)
      @base_gemspec.send("#{attr}=", value) if value
    end
    
    @settings.dependencies.each do |gem, version|
      @base_gemspec.add_dependency gem.to_s, version
    end
  end
  
  @base_gemspec
end

.disable(*args) ⇒ Object 



22
23
24
25
 
# File 'lib/burke.rb', line 22

def disable *args
  dis = [*args].map {|t| t.to_sym}
  @tasks.reject! {|t| dis.include? t}
end

.enable(*args) ⇒ Object 



17
18
19
20
 
# File 'lib/burke.rb', line 17

def enable *args
  @tasks.concat([*args].map {|t| t.to_sym})
  @tasks.uniq!
end

.enable_all(opts = {}) ⇒ Object 



12
13
14
15
 
# File 'lib/burke.rb', line 12

def enable_all opts={}
  @tasks = %w[clean yard rdoc rspec rspec_rcov gems install].map {|t| t.to_sym}
  disable opts[:except] if opts[:except]
end

.settings ⇒ Object 



208
209
210
 
# File 'lib/burke.rb', line 208

def settings
  @settings
end

.setup {|@settings| ... } ⇒ Object

Yields:



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
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
95
96
97
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
142
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
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/burke.rb', line 27

def setup
  @settings = Mash[
    :dependencies => Mash[],
    :docs => Mash[],
    :rspec => Mash[:rcov => Mash[]],
    :gems => GemSettings.new,
    :clean => [],
    :clobber => [],
  ]
  
  @settings.files = Dir.glob('{lib,spec}/**/*')
  %w[Rakefile COPYING LICENSE].each do |file|
    @settings.files << file if File.exists?(file)
  end
  
  project_files = Dir['*'].reject! {|f| File.directory? f or !File.readable? f}
  
  version_file = 'VERSION'
  if File.readable?(version_file)
    @settings.version = File.read(version_file).strip
    @settings.files << version_file
  end
  
  license_file = nil
  project_files.each do |f|
    if %w[license licence copying].include? f.downcase.split('.').first
      license_file = f
    end
  end
  
  if license_file
    @settings.docs.license = license_file
    @settings.files << license_file
  end
  
  readme_file = nil
  project_files.each do |f|
    if f.downcase =~ /readme[\..*]?/
      readme_file = f if readme_file.nil? or f.length < readme_file.length
    end
  end
  
  if readme_file
    @settings.docs.readme = File.basename readme_file
    @settings.files << readme_file
    @settings.docs.markup = case File.extname(readme_file).downcase
    when '.rdoc'
      'rdoc'
    when '.md'
      'markdown'
    when '.textile'
      'textile'
    end
  end
  
  @settings.rspec.spec_files = Dir['spec/**/*_spec.rb']
  @settings.rspec.color = true
  
  yield @settings
  
  begin
    require 'rake/clean'
    CLOBBER.include(*@settings.clobber) if @settings.clobber
  rescue LoadError
  end if @tasks.include? :clean
  
  unless @settings.docs.files
    d = @settings.docs
    fl = FileList.new
    fl.include "lib/**/*.rb"
    fl.include d.readme if d.readme
    fl.include d.license if d.license
    d.files = fl.to_a
  end
  
  begin
    require 'yard'
    opts = []
    d = @settings.docs
    opts << "--title" << "#{@settings.name} #{@settings.version}"
    opts << "--readme" << d.readme if d.readme
    opts << "--markup" << d.markup if d.markup
    extra_files = [d.license].compact
    opts << "--files" << extra_files.join(',') unless extra_files.empty?
    YARD::Rake::YardocTask.new 'yard' do |t|
      t.options = opts
    end
  rescue LoadError
  end if @tasks.include? :yard
  
  begin
    require 'rake/rdoctask'
    d = @settings.docs
    Rake::RDocTask.new 'rdoc' do |r|
      r.rdoc_files.include d.files
      r.title = "#{@settings.name} #{@settings.version}"
      r.main = d.readme if d.readme
    end
  rescue LoadError
  end if @tasks.include? :rdoc
  
  if @settings.has_rdoc
    d = @settings.docs
    (@settings.extra_rdoc_files ||= []).concat d.files
    opts = []
    opts << "--title" << "#{@settings.name} #{@settings.version}"
    opts << "--main" << d.readme if d.readme
    @settings.rdoc_options ||= opts
  end
  
  begin
    require 'spec/rake/spectask'
    r = @settings.rspec
    opts = []
    opts << "--colour" if r.color
    opts << "--format" << r.format if r.format
    Spec::Rake::SpecTask.new 'spec' do |t|
      t.spec_files = r.spec_files
      t.spec_opts = opts
    end unless r.empty?
    
    begin
      require 'spec/rake/verify_rcov'
      
      desc "Run specs with RCov"
      Spec::Rake::SpecTask.new('spec:rcov') do |t|
        t.spec_files = r.spec_files
        t.spec_opts = opts
        t.rcov = true
        t.rcov_opts = ['--exclude', 'spec']
      end

      RCov::VerifyTask.new('spec:rcov:verify' => 'spec:rcov') do |t|
        t.threshold = r.rcov.threshold
        t.index_html = 'coverage/index.html'
      end if r.rcov.threshold
    rescue LoadError
    end if @tasks.include? :rspec_rcov
  rescue LoadError
  end if @tasks.include? :rspec
  
  begin
    settings.gems.individuals.each do |conf|
      GemTaskManager.add_task conf
    end
    
    if name
      desc "Build gem for this platform"
      task(:gem => GemTaskManager.task_for_this_platform.task_name)
    end
  rescue LoadError
  end if @tasks.include? :gems
  
  if @tasks.include? :install
    GemTaskManager.install_task unless GemTaskManager::TASKS.empty?
  end
  
  @settings
end