mtbuild 0.0.1

data/lib/mtbuild/utils.rb

@@ -0,0 +1,46 @@
+module MTBuild
+
+  module Utils
+
+    require 'rake'
+    require 'pathname'
+
+    def self.path_difference(root, subdir)
+      root_path = Pathname.new(root)
+      subdir_path = Pathname.new(subdir)
+      difference_path = subdir_path.relative_path_from(root_path)
+      difference = difference_path.to_path
+      return nil if difference.include? '..'
+      return '' if difference.eql? '.'
+      return difference
+    end
+
+    def self.expand_file_list(included_files, excluded_files, base_folder=nil)
+      file_list = FileList.new()
+
+      included_files = Utils.ensure_array(included_files).flatten.collect{|s| base_folder ? File.join(base_folder, s) : s}
+      file_list.include(included_files)
+
+      excluded_files = Utils.ensure_array(excluded_files).flatten.collect{|e| base_folder ? File.join(base_folder, e) : e}
+      file_list.exclude(excluded_files)
+
+      return file_list.to_ary.collect{|f| File.expand_path(f)}
+    end
+
+    def self.expand_folder_list(included_folders, base_folder=nil)
+      included_folders = Utils.ensure_array(included_folders).flatten.collect{|f| base_folder ? File.join(base_folder, f) : f}
+      return Dir.glob(included_folders).to_ary.reject{|f| !File.directory?f}.collect{|f| File.expand_path(f)}
+    end
+
+    def self.ensure_array(input)
+      input = [input] unless input.respond_to?(:to_ary)
+      return input
+    end
+
+    def self.merge_configurations(default, override)
+      return default.merge(override) {|key, old_value, new_value| if old_value.is_a? Hash and new_value.is_a? Hash then merge_configurations(old_value, new_value) else new_value end}
+    end
+
+  end
+
+end

data/lib/mtbuild/version.rb

@@ -0,0 +1,4 @@
+module MTBuild
+  # The current MTBuild version.
+  VERSION = "0.0.1"
+end

data/lib/mtbuild/versioner.rb

@@ -0,0 +1,54 @@
+module MTBuild
+
+  # This is the base class for all versioner types.
+  class Versioner
+
+    def initialize(project_name, project_folder, output_folder, configuration_name, configuration)
+      @project_name = project_name
+      @project_folder = project_folder
+      @output_folder = output_folder
+      @configuration_name = configuration_name
+
+      check_configuration(configuration)
+
+      @versioner_name = configuration[:name]
+    end
+
+    # Create the actual Rake tasks that will perform the versioner's work
+    def create_version_tasks
+      fail "Versioner didn't provide create_version_tasks"
+    end
+
+    private
+
+    def check_configuration(configuration)
+      fail "error. No name specified for versioner in #{@project_name}:#{@configuration_name}" if configuration.fetch(:name, nil).nil?
+    end
+
+    @registered_versioners = {}
+
+    def self.register_versioner(versioner_name, versioner_class)
+      @registered_versioners[versioner_name] = versioner_class;
+    end
+
+    def self.create_versioner(project_name, project_folder, output_folder, configuration_name, versioner_configuration)
+      versioner_name = versioner_configuration.fetch(:name, nil)
+      fail "error: versioner name not specified for #{project_name}:#{configuration_name}." if versioner_name.nil?
+
+      versioner_class = @registered_versioners.fetch(versioner_name, nil)
+      if !versioner_class
+        versioner = File.join('mtbuild', 'versioners', versioner_name.to_s)
+        begin
+          require versioner
+        rescue LoadError
+        end
+      end
+      versioner_class = @registered_versioners.fetch(versioner_name, nil)
+      fail "error: version file #{versioner_name} could not be found." if versioner_class.nil?
+      return Object::const_get(versioner_class).new(project_name, project_folder, output_folder, configuration_name, versioner_configuration)
+    end
+
+    include Rake::DSL
+  end
+
+end

data/lib/mtbuild/versioners/mt_std_version.rb

@@ -0,0 +1,72 @@
+module MTBuild
+  require 'mtbuild/versioner'
+
+  Versioner.register_versioner(:mt_std_version, 'MTBuild::VersionerMTStdVersion')
+
+  # This Versioner subclass can update files that follow the standard MindTribe version format.
+  class VersionerMTStdVersion < Versioner
+
+    def initialize(project_name, project_folder, output_folder, configuration_name, configuration)
+      super
+      @version_files = Utils.expand_file_list(configuration.fetch(:files, []), [], @project_folder)
+    end
+
+    # Create the actual Rake tasks that will perform the versioner's work
+    def create_version_tasks
+      namespace @configuration_name do
+        desc "Update version for '#{@project_name}' with configuration '#{@configuration_name}'"
+        @version_files.each do |file|
+          version_task = task :Version, [:major, :minor, :revision, :build, :version_string, :git_SHA] => file do |t, args|
+            args.with_defaults(:major => '', :minor => '', :revision => '', :build => '', :version_string => '', :git_SHA => '')
+            update_version(file, args.major, args.minor, args.revision, args.build, args.version_string, args.git_SHA)
+            puts "updated version in '#{file}'"
+          end
+        end
+      end
+    end
+
+    private
+
+    def check_configuration(configuration)
+      super
+      fail "No version files specified for #{@project_name}:#{@configuration_name}" if configuration.fetch(:files, nil).nil?
+    end
+
+    # This method searches through a file for version definitions of roughly the following format:
+    #
+    # #define xxxMAJOR            0
+    # #define xxxMINOR            0
+    # #define xxxREVISION         0
+    # #define xxxBUILD            0
+    # #define xxxVERSIONSTRING    "0"
+    # #define xxxGITSHA           "0000000000000000000000000000000000000000"
+    #
+    # The "xxx" can include almost any valid C/C++ identifier text as needed for the particular application. The spacing
+    # between the identifier and the defined value is flexible. The order of the definitions is not important and
+    # definitions can be repeated or omitted. For more detail on the exact search criteria, review the regular expressions
+    # below.
+    #
+    # When one or more of the above lines is found, the defined value is replaced by the respective value passed into this
+    # method.
+    def update_version(file_name, major=nil, minor=nil, revision=nil, build=nil, version_string=nil, git_SHA=nil)
+      matching_list = []
+
+      matching_list << [/(\s*#define\s.+?MAJOR\s*)(\S+?)(\s*.*$)/,          "\\1#{major}\\3"] unless major.empty?
+      matching_list << [/(\s*#define\s.+?MINOR\s*)(.+?)(\s*$)/,             "\\1#{minor}\\3"] unless minor.empty?
+      matching_list << [/(\s*#define\s.+?REVISION\s*)(.+?)(\s*$)/,          "\\1#{revision}\\3"] unless revision.empty?
+      matching_list << [/(\s*#define\s.+?BUILD\s*)(.+?)(\s*$)/,             "\\1#{build}\\3"] unless build.empty?
+      matching_list << [/(\s*#define\s.+?VERSIONSTRING\s*\")(.+?)(\"\s*$)/, "\\1#{version_string}\\3"] unless version_string.empty?
+      matching_list << [/(\s*#define\s.+?GITSHA\s*\")(.+?)(\"\s*$)/,        "\\1#{git_SHA}\\3"] unless git_SHA.empty?
+
+      fail "Nothing to do. Please specify at least one version component to update." if matching_list.empty?
+
+      file_contents = File.read(file_name)
+      matching_list.each do |matching_expression, replacement_text|
+        file_contents = file_contents.gsub(matching_expression, replacement_text)
+      end
+      File.open(file_name, "w") {|file| file.puts file_contents}
+    end
+
+  end
+
+end

data/lib/mtbuild/workspace.rb

@@ -0,0 +1,112 @@
+module MTBuild
+
+  # Use this class to create a workspace
+	class Workspace
+    require 'mtbuild/utils'
+    require 'rake/clean'
+
+    # The workspace's name
+    attr_reader :workspace_name
+
+    # The workspace's folder. Relative path references are interpreted as
+    # relative to this folder.
+    attr_reader :workspace_folder
+
+    # The workspace's output folder
+    attr_reader :output_folder
+
+		def initialize(workspace_name, workspace_folder, &configuration_block)
+      @workspace_name = workspace_name
+      @workspace_folder = File.expand_path(workspace_folder)
+      @output_folder = File.expand_path(File.join(@workspace_folder, MTBuild.default_output_folder))
+      @projects = []
+      @default_tasks = []
+
+      # Only process the first workspace found.
+      # Subsequent workspaces will be ignored
+      if MTBuild::Workspace.workspace.nil?
+        MTBuild::Workspace.set_workspace(self)
+
+        configuration_block.call(self) if configuration_block
+
+        @projects.each do |project|
+          require project
+        end
+
+        CLOBBER.include(@output_folder)
+
+        task :workspace do
+          puts "built workspace #{@workspace_name}"
+        end
+
+        task :default => @default_tasks+[:workspace]
+      end
+		end
+
+    # Adds a project subfolder
+    def add_project(project_location)
+      new_projects = []
+      Utils.expand_folder_list(project_location, Rake.original_dir).each do |project_path|
+        if File.directory? project_path
+          project_rakefile = File.join(project_path,'Rakefile.rb')
+          new_projects << project_rakefile if File.file? project_rakefile
+        end
+      end
+      $stderr.puts "Could not find a valid project at '#{project_location}'. Ignored." if new_projects.empty?
+      @projects += new_projects
+    end
+
+    # Adds tasks to be run by default when MTBuild is invoked with no arguments.
+    def add_default_tasks(default_tasks)
+      @default_tasks |= Utils.ensure_array(default_tasks).flatten
+    end
+
+    # Sets defaults for all configurations with the specified name
+    def set_configuration_defaults(configuration_name, defaults_hash)
+      Workspace.set_configuration_defaults(configuration_name, defaults_hash)
+    end
+
+    # Sets the build output folder location
+    def set_output_folder(output_folder)
+      @output_folder = File.expand_path(File.join(@workspace_folder,output_folder))
+    end
+
+    @workspace = nil
+
+    # The singleton workspace instance
+    def self.workspace
+      return @workspace
+    end
+
+    # Sets the singleton workspace instance
+    def self.set_workspace(workspace)
+      @workspace = workspace
+    end
+
+    # Queries whether a workspace exists
+    def self.have_workspace?
+      return !@workspace.nil?
+    end
+
+    # Add default tasks to the singleton workspace instance
+    def self.add_default_tasks(default_tasks)
+      @workspace.add_default_tasks(default_tasks) unless @workspace.nil?
+    end
+
+    @configuration_defaults = {}
+
+    # Gets the singleton configuration defaults
+    def self.configuration_defaults
+      return @configuration_defaults
+    end
+
+    # Adds or updates defaults to the singleton configuration defaults
+    def self.set_configuration_defaults(configuration_name, defaults_hash)
+      @configuration_defaults[configuration_name] = defaults_hash
+    end
+
+    include Rake::DSL
+
+	end
+
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: mtbuild
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jerry Ryle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.8
+description: mtbuild is a rake-based build system for C/C++ projects. It provides
+  a DSL for declaring workspaces and projects, which generate rake tasks.
+email:
+- info@mindtribe.com
+executables:
+- mtbuild
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/mtbuild
+- lib/mtbuild/application.rb
+- lib/mtbuild/application_configuration.rb
+- lib/mtbuild/application_project.rb
+- lib/mtbuild/application_task.rb
+- lib/mtbuild/compiled_configuration.rb
+- lib/mtbuild/configuration.rb
+- lib/mtbuild/dsl.rb
+- lib/mtbuild/mtbuild.rb
+- lib/mtbuild/project.rb
+- lib/mtbuild/staticlibrary_configuration.rb
+- lib/mtbuild/staticlibrary_project.rb
+- lib/mtbuild/staticlibrary_task.rb
+- lib/mtbuild/test_application_configuration.rb
+- lib/mtbuild/test_application_project.rb
+- lib/mtbuild/test_application_task.rb
+- lib/mtbuild/toolchain.rb
+- lib/mtbuild/toolchains/arm_none_eabi_gcc.rb
+- lib/mtbuild/toolchains/gcc.rb
+- lib/mtbuild/utils.rb
+- lib/mtbuild/version.rb
+- lib/mtbuild/versioner.rb
+- lib/mtbuild/versioners/mt_std_version.rb
+- lib/mtbuild/workspace.rb
+- lib/mtbuild.rb
+- LICENSE.md
+- README.md
+homepage: https://github.com/MindTribe/MTBuild
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: rake-based build system for C/C++ projects
+test_files: []