ninja-rake 0.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Akira Hayakawa
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# ninja-rake
+Make your Ninja more powerful with the power of Ruby on Rake Framework!
+
+## Motivation
+Ninja is a build tool brilliant ever however it lacks some paramount functionalities such as script descpriptiveness:
+you can not use typical data structures (for example array, map, set etc) 
+and general algorithms (for example map, filter, sort etc) equipped with the modern scripting languages in your raw Ninja script.
+This makes Ninja hard to be deployed into your projects.
+
+This is the result of the developer of Ninja decided not to provide these functinalities to keep Ninja as simple as possible
+and let users (like you!) to generate Ninja file by your own scripting however,
+I believe there should be some de-facto standard for scripting and I again believe it is Ruby that I love the most.
+
+Using this ninja-rake library you can write Ninja code with Ruby language which enables
+using plenty of data structures and algorithms in Ruby standard library.
+Moreover, your script can easily collaborate with Rake which is
+the state of the art framework for describing daily tasks including building softwares.
+
+## Install
+
+## Usage
+
+```ruby
+rule = Ninja::Rule.new("gcc -c $in -o $out"), # rule have unique ID.
+build1 = Ninja::Build.new(
+  rule,
+  Ninja::Target.new("a.o"),
+  Ninja::Explicitly.new("a.c", "b.c"),
+  Ninja::Implicitly.new("c.c"))
+build2 = Ninja::Build.new(rule, ...)
+Ninja.end_of_ninja(build1, build2)  
+```
+
+will produce a Rake task that create "build.ninja" file that is written as
+
+~~~
+rule ID
+  command = gcc -c $in -o $out
+build1 a.o: ID a.c b.c | c.c
+build2 ...: ID ...
+~~~
+
+## Roadmap
+* Rule generator which enables to build GPGPU project written in CUDA 4.0.
+
+## Contributing to ninja-rake
+ 
+* 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
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+Copyright (c) 2011 Akira Hayakawa (@akiradeveloper). 
+See LICENSE.txt for further details.

data/TODO

@@ -0,0 +1,2 @@
+# TODO
+

data/lib/ninja.rb

@@ -0,0 +1,201 @@
+require "set"
+require "uuidtools"
+
+module Ninja
+
+  DEFAULT_NINJA_FILENAME = "build.ninja"
+  
+  def self.create_UUID
+    UUIDTools::UUID.random_create
+  end
+  
+  class Rule
+    def initialize(rule_desc, depfile="")
+      @rule_desc = rule_desc
+      @depfile = depfile
+      @unique_name = Ninja.create_UUID
+    end
+  
+    def unique_name
+      @unique_name
+    end
+
+    def depfile_line
+      if @depfile == ""
+        ""
+      else
+        "  depfile = #{@depfile}\n"
+      end
+    end 
+
+    def to_ninja_format
+"""
+rule #{unique_name}
+#{depfile_line}  command = #{@rule_desc}
+"""
+    end
+  
+    def name
+      @unique_name
+    end
+  end
+  
+  class Target
+    def initialize(*xs)
+      @dep = xs.flatten
+    end
+  
+    def to_a
+      @dep
+    end
+  
+    def to_ninja_format
+      @dep.join " "
+    end
+  end
+  
+  class Explicitly
+    def initialize(*xs)
+      @dep = xs.flatten
+    end
+  
+    def to_ninja_format
+      "#{@dep.join(" ")}"
+    end
+  end
+  
+  class Implicitly
+    def initialize(*xs)
+      @dep = xs.flatten
+    end
+  
+    def to_ninja_format
+      "| #{@dep.join(" ")}"
+    end
+  end
+  
+  class Build
+    def initialize(rule, target, explicit_dep, implicit_dep=nil)
+      @rule = rule
+      @target = target
+      @explicit_dep = explicit_dep
+      @implicit_dep = implicit_dep
+      # order-only dep is not supported because I do not get how we need it.
+    end
+  
+    def get_target_object
+      @target
+    end
+  
+    def get_rule_object
+      @rule
+    end
+  
+    def implicit_dep_line
+      if @implicit_dep == nil
+        ""
+      else
+        @implicit_dep.to_ninja_format
+      end
+    end
+  
+    def to_ninja_format
+"""
+build #{@target.to_ninja_format}: #{@rule.name} #{@explicit_dep.to_ninja_format} #{implicit_dep_line}
+"""
+    end
+  end
+  
+  def self.__to_ninja_format(xs)
+    xs.map{ |x| x.to_ninja_format }.join "\n\n"
+  end
+  
+  def self.rules(ninjas)
+    __rules = ninjas.map{ |x| x.get_rule_object } 
+    Set.new(__rules).to_a
+  end
+  
+  def self.to_ninja_format(ninjas)
+    xs = (rules(ninjas) + ninjas).flatten
+    __to_ninja_format(xs)
+  end
+  
+  def self.create_ninja_file(ninjas)
+    namespace :ninja do
+      desc("generate ninja file if ninja.rake is changed")
+      file DEFAULT_NINJA_FILENAME => "ninja.rake" do 
+        puts "--- REGENERATING THE NINJA FILE NOW ---"
+        f = File.new(DEFAULT_NINJA_FILENAME, "w")
+	txt = to_ninja_format(ninjas)
+        f.write(txt)
+        f.close
+      end
+    end
+  end
+  
+  def self.make_ninja_task(target) 
+    namespace :ninja do
+      namespace :build do
+        task target =>  DEFAULT_NINJA_FILENAME do 
+          sh "ninja #{target}"
+        end
+        task :all => target
+      end
+      namespace :clean do
+        task target => DEFAULT_NINJA_FILENAME do
+          sh "ninja -t clean #{target}"
+        end
+        task :all => target
+      end 
+    end
+  end
+  
+  def self.end_of_ninja(*ninjas)
+    create_ninja_file(ninjas.flatten)
+
+    ninjas.each do |ninja|
+      ninja.get_target_object.to_a.each do |target|
+        make_ninja_task(target)
+      end
+    end
+  end
+
+  # Facade 
+  # To Hide the implementation 
+  def self.Rule(rule, depfile="") 
+    Ninja::Rule.new(rule, depfile)
+  end
+  
+  def self.Build(rule, target, explicit, implicit=nil)
+    Ninja::Build.new(rule, target, explicit, implicit)
+  end
+  
+  def self.Target(*xs)
+    Ninja::Target.new(xs)
+  end
+  
+  def self.Explicitly(*xs)
+    Ninja::Explicitly.new(xs)
+  end
+  
+  def self.Implicitly(*xs)
+    Ninja::Implicitly.new(xs)
+  end
+end # end of Ninja module
+
+if __FILE__ == $0
+  puts Ninja.Rule("gcc -c $in -o $out").to_ninja_format
+
+  p Ninja.Rule("gcc -MMD -MF $out.d -c $in -o $out", "$out.d")
+  r1 =  Ninja.Rule("gcc -MMD -MF $out.d -c $in -o $out", "$out.d")
+  b0 = Ninja.Build(
+    r1,
+    Ninja.Target("a", ["b", "c"]),
+    Ninja.Explicitly(["d"], "e"), Ninja.Implicitly("f"))
+  b1 = Ninja.Build(r1, Ninja.Target("a", ["b", "c"]), Ninja.Explicitly(["d"], "e"), Ninja.Implicitly("f"))
+  b2 = Ninja.Build(r1, Ninja.Target("a", ["b", "c"]), Ninja.Explicitly(["d"], "e"))
+  puts b1.to_ninja_format
+  puts b2.to_ninja_format
+  puts Ninja.rules([b1, b2])
+  puts Ninja.to_ninja_format([b1, b2])
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification 
+name: ninja-rake
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Akira Hayakawa
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-07 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: uuidtools
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 2
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 3
+        version: 1.6.3
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+description: ninja-rake enables you to play Ninja on the Rake framework
+email: ruby.wktk@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+- TODO
+files: 
+- lib/ninja.rb
+- LICENSE.txt
+- README.md
+- TODO
+has_rdoc: true
+homepage: http://github.com/akiradeveloper/ninja-rake
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 1823693513408219891
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Let your Ninja more powerful with Ruby
+test_files: []
+