jitsu 0.1.3 → 0.2.0

data/README.rdoc

@@ -1,13 +1,18 @@
-= jitsu
+= Jitsu
 
 Ninja (https://github.com/martine/ninja) is an excellent build system, but
 Ninja files are hard to write, by design. Jitsu is a simple meta build system
 that writes Ninja files for you from YAML project descriptions.
 
-For now, simple executables and static libraries are supported. See the
-features dir for examples and http://ilkka.github.com/jitsu for docs.
+For now, only C++ and simple executables and static and dynamic libraries are
+supported. See the features dir for examples and http://ilkka.github.com/jitsu
+for docs.
 
-== Contributing to jitsu
+== Using Jitsu
+
+See the howto[link:howto.html].
+
+== Contributing to Jitsu
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it

data/Rakefile

@@ -45,4 +45,5 @@ Cucumber::Rake::Task.new(:features)
 task :default => :spec
 
 require 'yard'
-YARD::Rake::YardocTask.new
+yardtask = YARD::Rake::YardocTask.new
+yardtask.after = Proc.new { system "cucumber -f html -o doc/howto.html" }

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.2.0

data/features/jitsu.feature

@@ -58,7 +58,7 @@ Feature: Build C++ programs
           dependencies:
             - lib.a
         lib.a:
-          type: library
+          type: static_library
           sources:
             - lib.cpp
       """
@@ -67,3 +67,49 @@ Feature: Build C++ programs
     And I run "./hello"
     Then the output should be "Hello World" with a newline
 
+  Scenario: Build a dynamic library
+    Given a directory
+    And a file "lib.h" with contents
+      """
+      #include <string>
+
+      std::string greeting();
+      """
+    And a file "lib.cpp" with contents
+      """
+      #include "lib.h"
+
+      std::string greeting() {
+        return std::string("Hello World");
+      }
+      """
+    And a file "main.cpp" with contents
+      """
+      #include <iostream>
+      
+      extern std::string greeting();
+
+      int main(int argc, char* argv[]) {
+        std::cout << greeting() << std::endl;
+        return 0;
+      }
+      """
+    And a file "build.jitsu" with contents
+      """
+      ---
+      targets:
+        lib.so:
+          type: dynamic_library
+          sources:
+            - lib.cpp
+        blah:
+          type: executable
+          sources:
+            - main.cpp
+          dependencies:
+            - lib.so
+      """
+    When I run jitsu
+    And I run "ninja all"
+    And I run "env LD_PRELOAD=./lib.so ./blah"
+    Then the output should be "Hello World" with a newline

data/features/step_definitions/jitsu_steps.rb

@@ -2,6 +2,7 @@ require 'tmpdir'
 
 Given /^a directory$/ do
   @tmpdir = Dir.mktmpdir
+  puts "Tempdir for this scenario: #{@tmpdir}"
 end
 
 Given /^a file "([^"]*)" with contents$/ do |filename, contents|
@@ -23,6 +24,7 @@ When /^I run "([^"]*)"$/ do |command|
   Dir.chdir @tmpdir do |dir|
     parts[0] = File.expand_path(parts[0]) if parts[0].index(/\//)
     @output = `#{parts.join(' ')}`
+    $?.should == 0
   end
 end
 

data/jitsu.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jitsu}
-  s.version = "0.1.3"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ilkka Laukkanen"]
-  s.date = %q{2011-02-14}
+  s.date = %q{2011-02-15}
   s.default_executable = %q{jitsu}
   s.description = %q{Jitsu is a frontend or meta build system for Ninja
 (http://github.com/martine/ninja), a lightning-fast but
@@ -42,7 +42,8 @@ buildfiles.
     "jitsu.gemspec",
     "lib/jitsu.rb",
     "spec/jitsu_spec.rb",
-    "spec/spec_helper.rb"
+    "spec/spec_helper.rb",
+    "watchr_srcipt.rb"
   ]
   s.homepage = %q{http://github.com/ilkka/jitsu}
   s.licenses = ["GPLv3"]

data/lib/jitsu.rb

@@ -64,29 +64,90 @@ EOS
       data['targets'].each do |target,conf|
         f.write "\n"
         sources = conf['sources']
-        sources.each do |src|
-          f.write "build #{source_to_object src}: cxx #{src}\n"
-          if conf['cxxflags']
-            f.write "  cxxflags = #{conf['cxxflags']}\n"
-          end
-        end
-        f.write "build #{target}: "
-        case conf['type']
-        when 'executable'
-          f.write "link #{sources_to_objects(sources).join(' ')}"
-          f.write(' ' + conf['dependencies'].join(' ')) if conf['dependencies']
-        when 'library'
-          f.write "archive #{sources_to_objects(sources).join(' ')}"
-        end
-        f.write "\n"
+        objects = sources_to_objects(sources).join(' ')
+        Jitsu.send "handle_#{conf['type']}".to_sym, f, target, sources, objects, conf
       end
+      f.write("\nbuild all: phony || #{data['targets'].keys.join(' ')}\n")
+    end
+  end
+
+  # Output build rules for a list of sources.
+  #
+  # @param out [IO] the output stream where output is written.
+  # @param sources [Enumerable] a list of sourcefile names to output rules
+  # for.
+  # @param conf [Hash] the entire build spec hash for this target.
+  def self.output_sources(out, sources, conf)
+    cxxflags = conf['cxxflags']
+    sources.each do |src|
+      out.write "build #{source_to_object src}: cxx #{src}\n"
+      out.write "  cxxflags = #{cxxflags}\n" if cxxflags
     end
   end
 
+  # Output build rules for one executable target.
+  #
+  # @param out [IO] the output stream where output is written.
+  # @param target [String] the filename of the target.
+  # @param sources [Enumerable] a list of sourcefile names to output rules
+  # for.
+  # @param objects [Enumerable] a list of all object files for the target.
+  # @param conf [Hash] the entire build spec hash for this target.
+  def self.handle_executable(out, target, sources, objects, conf)
+    output_sources(out, sources, conf)
+    out.write "build #{target}: link #{objects}"
+    out.write " #{conf['dependencies'].join(' ')}" if conf['dependencies']
+    out.write "\n"
+    out.write "  ldflags = #{conf['ldflags']}\n" if conf['ldflags']
+  end
+
+  # Output build rules for one static library target.
+  #
+  # @param out [IO] the output stream where output is written.
+  # @param target [String] the filename of the target.
+  # @param sources [Enumerable] a list of sourcefile names to output rules
+  # for.
+  # @param objects [Enumerable] a list of all object files for the target.
+  # @param conf [Hash] the entire build spec hash for this target.
+  def self.handle_static_library(out, target, sources, objects, conf)
+    output_sources(out, sources, conf)
+    out.write "build #{target}: archive #{objects}"
+    out.write " #{conf['dependencies'].join(' ')}" if conf['dependencies']
+    out.write "\n"
+  end
+
+  # Output build rules for one dynamic library target.
+  #
+  # @param out [IO] the output stream where output is written.
+  # @param target [String] the filename of the target.
+  # @param sources [Enumerable] a list of sourcefile names to output rules
+  # for.
+  # @param objects [Enumerable] a list of all object files for the target.
+  # @param conf [Hash] the entire build spec hash for this target.
+  def self.handle_dynamic_library(out, target, sources, objects, conf)
+    conf['cxxflags'] ||= '${cxxflags}'
+    conf['cxxflags'] += ' -fPIC'
+    output_sources(out, sources, conf)
+    out.write "build #{target}: link #{objects}"
+    out.write " #{conf['dependencies'].join(' ')}" if conf['dependencies']
+    out.write "\n"
+    conf['ldflags'] ||= '${ldflags}'
+    conf['ldflags'] += " -shared -Wl,-soname,#{target}"
+    out.write "  ldflags = #{conf['ldflags']}\n"
+  end
+
+  # Convert sourcefile name to corresponding object file name.
+  #
+  # @param src [String] source file path.
+  # @return [String] object file path.
   def self.source_to_object(src)
     src.gsub /\.[Cc]\w+$/, '.o'
   end
 
+  # Convert a list of sourcefile names to corresponding object file names.
+  #
+  # @param srcs [Enumerable] source file paths.
+  # @return [Enumerable] object file paths.
   def self.sources_to_objects(srcs)
     srcs.map { |src| source_to_object src }
   end

data/spec/jitsu_spec.rb

@@ -59,7 +59,7 @@ targets:
     dependencies:
       - test2
   test2:
-    type: library
+    type: static_library
     sources:
       - test2.cpp
     cxxflags: -ansi -pedantic
@@ -84,7 +84,7 @@ targets:
     dependencies:
       - aaa2
   aaa2:
-    type: library
+    type: dynamic_library
     sources:
       - aaa2.cpp
     cxxflags: -ansi -pedantic
@@ -108,14 +108,18 @@ targets:
     sources:
       - aaa1a.cpp
       - aaa1b.cpp
-    cxxflags: -g -Wall
     dependencies:
       - aaa2.a
+      - aaa3.so
   aaa2.a:
-    type: library
+    type: static_library
     sources: 
       - aaa2.cpp
     cxxflags: -ansi -pedantic
+  aaa3.so:
+    type: dynamic_library
+    sources:
+      - aaa3.cpp
 EOS
         end
         data = Jitsu.read Jitsu.jitsufile
@@ -145,27 +149,37 @@ EOS
         # the targets are reversed on 1.8.7 :p
         if RUBY_VERSION.start_with? '1.8'
           ninjafile += <<-EOS
+build aaa3.o: cxx aaa3.cpp
+  cxxflags = ${cxxflags} -fPIC
+build aaa3.so: link aaa3.o
+  ldflags = ${ldflags} -shared -Wl,-soname,aaa3.so
+
 build aaa2.o: cxx aaa2.cpp
   cxxflags = -ansi -pedantic
 build aaa2.a: archive aaa2.o
 
 build aaa1a.o: cxx aaa1a.cpp
-  cxxflags = -g -Wall
 build aaa1b.o: cxx aaa1b.cpp
-  cxxflags = -g -Wall
-build aaa1: link aaa1a.o aaa1b.o aaa2.a
+build aaa1: link aaa1a.o aaa1b.o aaa2.a aaa3.so
+
+build all: phony || aaa3.so aaa2.a aaa1
 EOS
         else
           ninjafile += <<-EOS
 build aaa1a.o: cxx aaa1a.cpp
-  cxxflags = -g -Wall
 build aaa1b.o: cxx aaa1b.cpp
-  cxxflags = -g -Wall
-build aaa1: link aaa1a.o aaa1b.o aaa2.a
+build aaa1: link aaa1a.o aaa1b.o aaa2.a aaa3.so
 
 build aaa2.o: cxx aaa2.cpp
   cxxflags = -ansi -pedantic
 build aaa2.a: archive aaa2.o
+
+build aaa3.o: cxx aaa3.cpp
+  cxxflags = ${cxxflags} -fPIC
+build aaa3.so: link aaa3.o
+  ldflags = ${ldflags} -shared -Wl,-soname,aaa3.so
+
+build all: phony || aaa1 aaa2.a aaa3.so
 EOS
         end
         File.open('build.ninja', 'r').read.should == ninjafile

data/watchr_srcipt.rb

@@ -0,0 +1,12 @@
+def run_specs
+  system("rake spec")
+end
+
+def run_features
+  system("rake features")
+end
+
+watch('(lib|bin|spec|features)/(.*\.rb|[^.])') do |md|
+  run_specs && run_features
+end
+

metadata

@@ -2,7 +2,7 @@
 name: jitsu
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors: 
 - Ilkka Laukkanen
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-14 00:00:00 +02:00
+date: 2011-02-15 00:00:00 +02:00
 default_executable: jitsu
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -125,6 +125,7 @@ files:
 - lib/jitsu.rb
 - spec/jitsu_spec.rb
 - spec/spec_helper.rb
+- watchr_srcipt.rb
 has_rdoc: true
 homepage: http://github.com/ilkka/jitsu
 licenses: 
@@ -139,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -901234259
+      hash: 564580019
       segments: 
       - 0
       version: "0"