ninja-build-helpers 0.2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ce48a426f3d6d879ffad5d0fab0c82a33c8e990
+  data.tar.gz: 897ee4091f2f345b94d63ad740dcce329b5559db
+SHA512:
+  metadata.gz: c76c826622bbd9dc59c106afb0eea96b6267b2d9ff5793534f95e2f81224f7b795e5b45600c4857dbf7ad3b85d8c5a648832c9a1534247018b1de696cec35969
+  data.tar.gz: cc25f5b95fad38d4de197136e765f9829845d5e3668392969c183b4a2bc60ea1a6e4b0daa2de59e8210bb4f88b9c9736a900e556c2257b9fec516677f52a8b04

data/.gitignore

@@ -0,0 +1,5 @@
+# Sublime Text 2/3
+*.sublime-workspace
+
+# RubyGems
+*.gem

data/AUTHORS

@@ -0,0 +1,2 @@
+Michael Williams <m.t.williams@live.com>
+Phillip Cao <ftechz@gmail.com>

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

data/README.md

@@ -0,0 +1,5 @@
+# Ninja Build Helpers
+
+[![Gem Version](https://img.shields.io/gem/v/ninja.svg)](https://rubygems.org/gems/ninja-build-helpers)
+
+Helpers for generating Ninja build files using Ruby.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/ninja.rb

@@ -0,0 +1,21 @@
+# ===-- lib/ninja.rb -------------------------------------*- mode: Ruby -*-=== #
+#
+#                            _____ _       _
+#                           |   | |_|___  |_|___
+#                           | | | | |   | | | .'|
+#                           |_|___|_|_|_|_| |__,|
+#                                       |___|
+#
+#        This file is distributed under the terms described in LICENSE.
+#
+# ===----------------------------------------------------------------------=== #
+
+module Ninja
+  require_relative 'ninja/version'
+  require_relative 'ninja/delegator'
+  require_relative 'ninja/variable'
+  require_relative 'ninja/response_file'
+  require_relative 'ninja/rule'
+  require_relative 'ninja/build'
+  require_relative 'ninja/file'
+end

data/lib/ninja/build.rb

@@ -0,0 +1,36 @@
+module Ninja
+  class Build
+    attr_reader :rule,
+                :inputs,
+                :implicit_inputs,
+                :output,
+                :variables
+
+    def initialize(desc={})
+      Description.validate!(desc)
+
+      @rule = desc[:rule]
+      @inputs = [*desc[:inputs]]
+      @implicit_inputs = [*desc[:implicit_inputs]]
+      @output = desc[:output]
+      @variables = desc[:variables]
+    end
+
+    module Description #:nodoc:
+      def self.validate!(desc)
+        # This might be overkill, but we want this to be idiot-proof.
+        raise "Rule not specified." unless desc.include?(:rule)
+         raise "Expected rule to be a string composed of [a-Z,0-9,-,_] characters." unless /\A([-\w]+?)+\z/.match(desc[:rule])
+
+        raise "Inputs not specified." unless desc.include?(:inputs)
+         # TODO(mtwilliams): Check type of elements.
+         raise "Expected inputs to be an array of paths." unless desc[:inputs].is_a?(Array)
+        raise "Output not specified." unless desc.include?(:output)
+         # TODO(mtwilliams): Check if paths exist.
+         raise "Expected output to be a path." unless desc[:output].is_a?(String)
+        raise "Variables not specified." unless desc.include?(:variables)
+         raise "Expected variables to be an array of variables." unless desc[:variables].is_a?(Array)
+      end
+    end
+  end
+end

data/lib/ninja/delegator.rb

@@ -0,0 +1,21 @@
+module Ninja
+  class Delegator
+    def initialize(context, opts={})
+      @context = context
+      # TODO(mtwilliams): Hide standard methods, too.
+      @hidden = ((opts[:except] || []).map(&:to_sym))
+      @hooks = Hash[((opts.select{|k,_| /^on_.+/.match(k)}).map{|k,v| [k[3..-1].to_sym, v]})]
+    end
+
+    def method_missing(name, *args, &block)
+      name = name.to_sym
+      super if @hidden.include? name
+      if @context.respond_to? name
+        response = @context.send(name, *args, &block)
+        @hooks[name].call(response) if @hooks.include? name
+      else
+        super
+      end
+    end
+  end
+end

data/lib/ninja/file.rb

@@ -0,0 +1,115 @@
+module Ninja
+  class File
+    def initialize(path=nil, &block)
+      @variables = []
+      @rules = []
+      @builds = []
+      @subninjas = []
+      @defaults = []
+      Delegator.new(self, :except => [:save]).instance_eval(&block) if block_given?
+      self.save(path) if path
+    end
+
+    def variable(name, value)
+      @variables.push(Ninja::Variable.new(name, value))
+    end
+
+    def rule(name, command, opts={})
+      additional = {}
+
+      if opts[:response_file]
+        additional[:response_file] = Ninja::ResponseFile.new("$out.rsp", opts[:response_file])
+      end
+
+      @rules.push(Ninja::Rule.new(:name => name,
+                                  :command => command,
+                                  :dependencies => opts[:dependencies],
+                                  :description => opts[:description],
+                                  **additional))
+    end
+
+    def build(rule, outputs_to_inputs={}, variables={}, implicit_inputs=[])
+      buildVariables = []
+      variables.each do |name, value|
+        buildVariables.push Ninja::Variable.new(name, value)
+      end
+      outputs_to_inputs.each do |output, inputs|
+        @builds.push(Ninja::Build.new(:rule => rule, :inputs => [*inputs], :implicit_inputs => [*implicit_inputs], :output => output, :variables => buildVariables))
+      end
+    end
+
+    def subninja(filename)
+      @subninjas.push(filename)
+    end
+
+    def alias(from, to)
+      # Pretty clever, huh?
+      @builds.push(Ninja::Build.new(:rule => 'phony', :inputs => [*to], :output => from))
+    end
+
+    def defaults(outputs)
+      # TODO(mtwilliams): Accept variables (\$[\w]|\$\{[\w]\}).
+      # raise "Expected output(s) to be paths." unless [*outputs].all?{|output| /\A(?:[-\w\.]+\/?)+\z/.match(output)}
+      @defaults.push(*outputs)
+    end
+
+    def save(path)
+      raise "Path not specified!" unless path
+       # TODO(mtwilliams): Check if everything up to |path| exists.
+      ::File.open(path, 'w') do |f|
+        f.write "# This file was auto-generated by \"#{::File.basename($PROGRAM_NAME, ::File.extname($0))}\".\n"
+        f.write "# Do not modify! Instead, modify the aforementioned program.\n\n"
+        f.write "# We require Ninja >= 1.3 for `deps` and >= 1.5 for `msvc_deps_prefix`.\n"
+        f.write "ninja_required_version = 1.5\n\n"
+
+        @subninjas.each do |subninja|
+          f.write "subninja #{subninja}\n"
+        end
+        f.write "\n" unless @subninjas.empty?
+
+        @variables.each do |variable|
+          # TODO(mtwilliams): Escape.
+          f.write "#{variable.name} = #{variable.value}\n"
+        end
+        f.write "\n" unless @variables.empty?
+
+        @rules.each do |rule|
+          f.write "rule #{rule.name}\n"
+          if rule.dependencies
+            if (rule.dependencies == :gcc) or (rule.dependencies == :clang)
+              f.write "  depfile = $out.d\n"
+              f.write "  deps = gcc\n"
+            elsif rule.dependencies == :msvc
+              # TODO(mtwilliams): Handle non-English output.
+              # f.write "  msvc_deps_prefix = Note: including file: \n"
+              f.write "  deps = msvc\n"
+            else
+              f.write "  depfile = #{rule.dependencies}\n"
+            end
+          end
+          f.write "  command = #{rule.command}\n"
+          if rule.response_file
+            f.write "  rspfile = #{rule.response_file.name}\n"
+            f.write "  rspfile_content = #{rule.response_file.contents}\n"
+          end
+          f.write "\n"
+        end
+
+        @builds.each do |build|
+          f.write "build #{build.output}: #{build.rule} #{build.inputs.join(' ')} #{'| ' + build.implicit_inputs.join(' ') unless build.implicit_inputs.empty?}\n"
+          build.variables.each do |variable|
+            f.write "  #{variable.name} = #{variable.value}\n"
+          end
+        end
+
+        unless @defaults.empty?
+          f.write "\n" unless @builds.empty?
+          f.write "default #{@defaults.join(' ')}\n" unless @defaults.empty?
+        end
+
+        # TODO(mtwilliams): Execute other files (via 'subninja').
+        # TODO(mtwilliams): Specify pools, to optimize compilation times.
+      end
+    end
+  end
+end

data/lib/ninja/response_file.rb

@@ -0,0 +1,13 @@
+module Ninja
+  class ResponseFile
+    attr_reader :name,
+                :contents
+
+    def initialize(name, contents)
+      raise "Name not specified." unless name
+
+      @name = name
+      @contents = contents
+    end
+  end
+end

data/lib/ninja/rule.rb

@@ -0,0 +1,43 @@
+module Ninja
+  class Rule
+    attr_reader :name,
+                :command,
+                :dependencies,
+                :response_file
+
+    def initialize(desc={})
+      Description.validate!(desc)
+
+      @name = desc[:name]
+      @command = desc[:command]
+      @dependencies = desc[:dependencies]
+      @response_file = desc[:response_file]
+    end
+
+    module Description #:nodoc:
+      def self.validate!(desc)
+        # This might be overkill, but we want this to be idiot-proof.
+        raise "Name not specified." unless desc.include?(:name)
+         raise "Expected name to be a string composed of [a-Z,0-9,-,_] characters." unless /\A([-\w]+?)+\z/.match(desc[:name])
+
+        raise "Command not specified." unless desc.include?(:command)
+         # TODO(mtwilliams): Check response file.
+         # raise "Input not used by the command." unless desc[:command].include? '$in'
+         # raise "Output not used by the command." unless desc[:command].include? '$out'
+
+        if desc[:dependencies]
+          if desc[:dependencies].is_a?(String)
+          elsif desc[:dependencies].is_a?(Symbol)
+            raise "Unknown or unsupported dependency auto-detection method: '#{desc[:dependencies]}'." unless [:gcc, :clang, :msvc].include?(desc[:dependencies])
+          else
+            raise "Expected dependencies to be name or auto-detection method."
+          end
+        end
+
+        if desc[:response_file]
+          raise "Expected a `Ninja::Responsefile`." unless desc[:response_file].is_a?(ResponseFile)
+        end
+      end
+    end
+  end
+end

data/lib/ninja/variable.rb

@@ -0,0 +1,14 @@
+module Ninja
+  class Variable
+    attr_reader :name,
+                :value
+
+    def initialize(name, value)
+      raise "Name not specified." unless name
+       raise "Expected name to be a string made of [a-Z,_,-,0-9] characters." unless /\w/.match(name)
+
+      @name = name
+      @value = value
+    end
+  end
+end

data/lib/ninja/version.rb

@@ -0,0 +1,11 @@
+module Ninja
+  module VERSION #:nodoc:
+    MAJOR, MINOR, PATCH, PRE = [0, 2, 0, 0]
+    STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
+  end
+
+  # Returns the semantic version of Ninja.
+  def self.version
+    Ninja::VERSION::STRING
+  end
+end

data/ninja-build-helpers-rb.gemspec

@@ -0,0 +1,26 @@
+$:.push File.expand_path(File.join(File.dirname(__FILE__), 'lib'))
+require 'ninja/version'
+
+Gem::Specification.new do |s|
+  s.name              = 'ninja-build-helpers'
+  s.version           = Ninja.version
+  s.platform          = Gem::Platform::RUBY
+  s.author            = 'Phillip Cao'
+  s.email             = 'ftechz@gmail.com'
+  s.homepage          = 'https://github.com/ftechz/ninja-build-helpers-rb'
+  s.summary           = 'Helpers to generate Ninja build files.'
+  s.description       = 'Ninja is a simple Ruby DSL for generating ninja build files.'
+  s.license           = 'Public Domain'
+
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  # TODO(mtwilliams): Handle this gracefuly in `bin/ninja'.
+  s.require_paths = %w(lib)
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'cucumber'
+  s.add_development_dependency 'aruba'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: ninja-build-helpers
+version: !ruby/object:Gem::Version
+  version: 0.2.0.0
+platform: ruby
+authors:
+- Phillip Cao
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ninja is a simple Ruby DSL for generating ninja build files.
+email: ftechz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- AUTHORS
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/ninja.rb
+- lib/ninja/build.rb
+- lib/ninja/delegator.rb
+- lib/ninja/file.rb
+- lib/ninja/response_file.rb
+- lib/ninja/rule.rb
+- lib/ninja/variable.rb
+- lib/ninja/version.rb
+- ninja-build-helpers-rb.gemspec
+homepage: https://github.com/ftechz/ninja-build-helpers-rb
+licenses:
+- Public Domain
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Helpers to generate Ninja build files.
+test_files: []