show a backtrace when when an error occurs on gem load; close #1243
[mruby.git] / tasks / mrbgem_spec.rake
blob2ed72c3ffc926da18ce471b786c0b9345e702130
1 require 'pathname'
2 require 'forwardable'
4 module MRuby
5   module Gem
6     class << self
7       attr_accessor :current
8     end
9     LinkerConfig = Struct.new(:libraries, :library_paths, :flags, :flags_before_libraries, :flags_after_libraries) 
11     class Specification
12       include Rake::DSL
13       extend Forwardable
14       def_delegators :@build, :filename, :objfile, :libfile, :exefile
16       attr_accessor :name, :dir, :build
17       alias mruby build
18       attr_accessor :build_config_initializer
20       attr_accessor :version
21       attr_accessor :description, :summary
22       attr_accessor :homepage
23       attr_accessor :licenses, :authors
24       alias :license= :licenses=
25       alias :author= :authors=
27       attr_accessor :rbfiles, :objs
28       attr_accessor :test_objs, :test_rbfiles, :test_args
29       attr_accessor :test_preload
31       attr_accessor :bins
33       attr_accessor :requirements
34       attr_reader :dependencies
36       attr_block MRuby::Build::COMMANDS
38       def initialize(name, &block)
39         @name = name
40         @initializer = block
41         @version = "0.0.0"
42         MRuby::Gem.current = self
43       end
45       def setup
46         MRuby::Gem.current = self
47         @build.compilers.each do |compiler|
48           compiler.include_paths << "#{dir}/include"
49         end
50         MRuby::Build::COMMANDS.each do |command|
51           instance_variable_set("@#{command}", @build.send(command).clone)
52         end
53         @linker = LinkerConfig.new([], [], [], [])
55         @rbfiles = Dir.glob("#{dir}/mrblib/*.rb").sort
56         @objs = Dir.glob("#{dir}/src/*.{c,cpp,m,asm,S}").map do |f|
57           objfile(f.relative_path_from(@dir).to_s.pathmap("#{build_dir}/%X"))
58         end
59         @objs << objfile("#{build_dir}/gem_init")
61         @test_rbfiles = Dir.glob("#{dir}/test/*.rb")
62         @test_objs = Dir.glob("#{dir}/test/*.{c,cpp,m,asm,S}").map do |f|
63           objfile(f.relative_path_from(dir).to_s.pathmap("#{build_dir}/%X"))
64         end
65         @test_preload = 'test/assert.rb'
66         @test_args = {}
68         @bins = []
70         @requirements = []
71         @dependencies = []
73         instance_eval(&@initializer)
75         if !name || !licenses || !authors
76           fail "#{name || dir} required to set name, license(s) and author(s)"
77         end
79         build.libmruby << @objs
81         instance_eval(&@build_config_initializer) if @build_config_initializer
83         compilers.each do |compiler|
84           compiler.define_rules build_dir, "#{dir}/"
85         end
87         define_gem_init_builder
88       end
90       def add_dependency(name, *requirements)
91         requirements = ['>= 0.0.0'] if requirements.empty?
92         requirements.flatten!
93         @dependencies << {:gem => name, :requirements => requirements}
94       end
96       def self.bin=(bin)
97         @bins = [bin].flatten
98       end
100       def build_dir
101         "#{build.build_dir}/mrbgems/#{name}"
102       end
104       def test_rbireps
105         "#{build_dir}/gem_test.c"
106       end
108       def funcname
109         @funcname ||= @name.gsub('-', '_')
110       end
112       def compilers
113         MRuby::Build::COMPILERS.map do |c|
114           instance_variable_get("@#{c}")
115         end
116       end
118       def define_gem_init_builder
119         file objfile("#{build_dir}/gem_init") => "#{build_dir}/gem_init.c"
120         file "#{build_dir}/gem_init.c" => [build.mrbcfile] + [rbfiles].flatten do |t|
121           FileUtils.mkdir_p build_dir
122           generate_gem_init("#{build_dir}/gem_init.c")
123         end
124       end
126       def generate_gem_init(fname)
127         open(fname, 'w') do |f|
128           print_gem_init_header f
129           build.mrbc.run f, rbfiles, "gem_mrblib_irep_#{funcname}" unless rbfiles.empty?
130           f.puts %Q[void mrb_#{funcname}_gem_init(mrb_state *mrb);]
131           f.puts %Q[void mrb_#{funcname}_gem_final(mrb_state *mrb);]
132           f.puts %Q[]
133           f.puts %Q[void GENERATED_TMP_mrb_#{funcname}_gem_init(mrb_state *mrb) {]
134           f.puts %Q[  int ai = mrb_gc_arena_save(mrb);]
135           f.puts %Q[  mrb_#{funcname}_gem_init(mrb);] if objs != [objfile("#{build_dir}/gem_init")]
136           unless rbfiles.empty?
137             f.puts %Q[  mrb_load_irep(mrb, gem_mrblib_irep_#{funcname});]
138             f.puts %Q[  if (mrb->exc) {]
139             f.puts %Q[    mrb_print_backtrace(mrb);]
140             f.puts %Q[    mrb_p(mrb, mrb_obj_value(mrb->exc));]
141             f.puts %Q[    exit(EXIT_FAILURE);]
142             f.puts %Q[  }]
143           end
144           f.puts %Q[  mrb_gc_arena_restore(mrb, ai);]
145           f.puts %Q[}]
146           f.puts %Q[]
147           f.puts %Q[void GENERATED_TMP_mrb_#{funcname}_gem_final(mrb_state *mrb) {]
148           f.puts %Q[  mrb_#{funcname}_gem_final(mrb);] if objs != [objfile("#{build_dir}/gem_init")]
149           f.puts %Q[}]
150         end
151       end # generate_gem_init
153       def print_gem_init_header(f)
154         f.puts %Q[/*]
155         f.puts %Q[ * This file is loading the irep]
156         f.puts %Q[ * Ruby GEM code.]
157         f.puts %Q[ *]
158         f.puts %Q[ * IMPORTANT:]
159         f.puts %Q[ *   This file was generated!]
160         f.puts %Q[ *   All manual changes will get lost.]
161         f.puts %Q[ */]
162         f.puts %Q[#include <stdlib.h>]
163         f.puts %Q[#include "mruby.h"]
164         f.puts %Q[#include "mruby/irep.h"]
165         f.puts %Q[#include "mruby/dump.h"]
166         f.puts %Q[#include "mruby/string.h"]
167         f.puts %Q[#include "mruby/proc.h"]
168         f.puts %Q[#include "mruby/variable.h"]
169         f.puts %Q[#include "mruby/array.h"]
170         f.puts %Q[#include "mruby/hash.h"]
171       end
173       def version_ok?(req_versions)
174         req_versions.map do |req|
175           cmp, ver = req.split
176           cmp_result = Version.new(version) <=> Version.new(ver)
177           case cmp
178           when '=' then cmp_result == 0
179           when '!=' then cmp_result != 0
180           when '>' then cmp_result == 1
181           when '<' then cmp_result == -1
182           when '>=' then cmp_result >= 0
183           when '<=' then cmp_result <= 0
184           when '~>'
185             Version.new(version).twiddle_wakka_ok?(Version.new(ver))
186           else
187             fail "Comparison not possible with '#{cmp}'"
188           end
189         end.all?
190       end
191     end # Specification
193     class Version
194       include Comparable
195       include Enumerable
197       def <=>(other)
198         ret = 0
199         own = to_enum
201         other.each do |oth|
202           begin
203             ret = own.next <=> oth
204           rescue StopIteration
205             ret = 0 <=> oth
206           end
208           break unless ret == 0
209         end
211         ret
212       end
214       # ~> compare algorithm
215       # 
216       # Example:
217       #    ~> 2.2   means >= 2.2.0 and < 3.0.0
218       #    ~> 2.2.0 means >= 2.2.0 and < 2.3.0
219       def twiddle_wakka_ok?(other)
220         gr_or_eql = (self <=> other) >= 0
221         still_minor = (self <=> other.skip_minor) < 0
222         gr_or_eql and still_minor
223       end
225       def skip_minor
226         a = @ary.dup
227         a.slice!(-1)
228         a[-1] = a[-1].succ
229         a
230       end
232       def initialize(str)
233         @str = str
234         @ary = @str.split('.').map(&:to_i)
235       end
237       def each(&block); @ary.each(&block); end
238       def [](index); @ary[index]; end
239       def []=(index, value)
240         @ary[index] = value
241         @str = @ary.join('.')
242       end
243       def slice!(index)
244         @ary.slice!(index)
245         @str = @ary.join('.')
246       end
247     end # Version
249     class List
250       include Enumerable
252       def initialize
253         @ary = []
254       end
256       def each(&b)
257         @ary.each(&b)
258       end
260       def <<(gem)
261         unless @ary.detect {|g| g.dir == gem.dir }
262           @ary << gem
263         else
264           # GEM was already added to this list
265         end
266       end
268       def empty?
269         @ary.empty?
270       end
272       def check
273         each do |g|
274           g.dependencies.each do |dep|
275             name = dep[:gem]
276             req_versions = dep[:requirements]
278             # check each GEM dependency against all available GEMs
279             each do |dep_g|
280               if name == dep_g.name
281                 unless dep_g.version_ok?(req_versions)
282                   fail "#{name} version should be #{req_versions.join(' and ')} but was '#{dep_g.version}'"
283                 end
284               end
285             end
286           end
287         end
288       end
289     end # List
290   end # Gem
292   GemBox = Object.new
293   class << GemBox
294     def new(&block); block.call(self); end
295     def config=(obj); @config = obj; end
296     def gem(gemdir, &block); @config.gem(gemdir, &block); end
297   end # GemBox
298 end # MRuby