mtbuild 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0d05d02b66836b1bccc0714228bb5b8ddd3f75b
-  data.tar.gz: 9003247800a677e9c85c3edf17a7aa8c27cc9520
+  metadata.gz: 187145809f7658bc92518be6863f4bdb610f9e62
+  data.tar.gz: 748518274ed38a3d00de5c1912ee7e225a1e3255
 SHA512:
-  metadata.gz: 465655463b2538271833decc1684553d0170f86fea3301383c23fa766262cdd38a119aa6860ba9020300d0085c8e069aecbd6953d16ee830b9b6e9cba45d2105
-  data.tar.gz: 63c20bcf635b5978a934bc2f01f6fedff1214cdc706a8d75f446d6ae08cd303780240a59c373c6860a1012c768cb3310c8791ddc0e1db6df1351d109d3858dc3
+  metadata.gz: 5c3d17fad767c18324de6c7920774f960d4e8ce03a75514f7f56e9129168963b911cbb41ccc7d6c2ebd76313bfdacef9d9cc4c1ab17aa36b0050f375fca16ed3
+  data.tar.gz: d8c2fda21efca90b2db2c35c85fdd8958e7c949ee1b6d6d47444d9dbe73639b2f4911c879dc321eaf9d618bdb2f25bf29ba3de0e93226831c47e2f0678dad22f

data/CHANGES.md

@@ -1,13 +1,23 @@
 # Release Notes #
 
 
+## MTBuild 0.1.5 ##
+
+### Changes ###
+
+* Projects no longer need to explicitly specify each desired configuration.
+  Instead, they can provide a default configuration which is used as a base
+  to automatically create specific configurations from defaults set in the
+  parent workspace.
+
+
 ## MTBuild 0.1.4 ##
 
 ### Changes ###
 
-* Made minor changes to examples to fix style.  
-* Removed "versioners" because the concept was stupid.  
-* Added example of using environment variables.  
+* Made minor changes to examples to fix style.
+* Removed "versioners" because the concept was stupid.
+* Added example of using environment variables.
 
 
 ## MTBuild 0.1.3 ##
@@ -15,12 +25,12 @@
 ### Changes ###
 
 * Changed 'default' task to 'all' task to be more compatible with 'make'
-  conventions.  
+  conventions.
 * Fixed bug where source files couldn't be excluded with 'excludes'
   configuration property.
 * Renamed the 'excludes' property to 'source_excludes' and documented it.
   (Source file exclusion was previously undocumented--probably because it
-  didn't work.)  
+  didn't work.)
 
 
 ## MTBuild 0.1.2 ##
@@ -29,7 +39,7 @@
 
 * Fixed issue where executables and libraries are generated with colons in
   their names due to workspace prefix.
-* Added pre-build and post-build project tasks. 
+* Added pre-build and post-build project tasks.
 
 
 ## MTBuild 0.1.1 ##

data/README.md

@@ -352,7 +352,7 @@ The optional, named parameter, ```pull_default_tasks``` determines whether the p
 
 The optional, named parameter ```pull_configurations``` specifies a list of configurations to pull up from the child workspace. Pulling up configurations makes them available to other projects included by the parent workspace.
 
-The optional, named parameter ```push_configurations``` specifies a list of configurations to push down to the child workspace. Pushing down configurations allows you to add to a child workspace's configuration settings. Note that pushing a configuration down to a child cannot be used to create a new configuration for that child. It only lets you add configuration settings to child configurations that already exist. MTBuild ignores pushed configurations that do not exist in the child workspace's projects. Pushing down a configuration is intended to allow a parent workspace to override or add to a child's build settings. This should be used rarely and with caution since it's generally assumed that projects in a child workspace have been tested with the settings provided by that workspace.
+The optional, named parameter ```push_configurations``` specifies a list of configurations to push down to the child workspace. Pushing down configurations allows you to add to a child workspace's configuration settings or, if the child has a default configuration set via ```set_default_configuration()```, you can auto-generate a new configuration.
 
 #### add_default_tasks ####
 Use ```add_default_tasks(default_tasks)``` inside of a workspace configuration block to add tasks that run when you invoke MTBuild with no arguments. The ```default_tasks``` parameter expects one or more (in an array) project task names. The project tasks should be qualified relative to the current workspace. For example, if a workspace includes a project called ```MyApp```, which has a configuration called ```Debug```, you can add this by referring to it as ```MyApp:Debug```. If no default tasks are specified, then invoking MTBuild with no arguments will effectively do nothing.
@@ -412,6 +412,9 @@ This is a base class for projects. You won't typically use it directly, but it p
 #### task_for_configuration ####
 Use ```task_for_configuration(config_name)``` to get the fully qualified task name for the project configuration called ```config_name```. This is useful for getting fully qualified task names to register as default tasks using ```MTBuild::Workspace.add_default_tasks```
 
+#### tasks_for_all_configurations ####
+Use ```tasks_for_all_configurations``` to get a list of the fully qualified task names for all of the project's configurations. This is useful for getting fully qualified task names to register as default tasks using ```MTBuild::Workspace.add_default_tasks```
+
 
 ### MTBuild::ApplicationProject ###
 
@@ -427,6 +430,11 @@ application_project(application_name, project_folder, &configuration_block)
 
 For ```configuration_block```, you supply a block that takes one parameter. When MTBuild invokes the block, it will pass an ApplicationProject object as this parameter. Inside the block, you can make ApplicationProject calls on this object to add configurations.
 
+#### set_default_configuration #### 
+Use ```set_default_configuration(configuration)``` inside of an application project configuration block to add a default build configuration for the application. The ```configuration``` parameter expects a hash that contains settings for the configuration. Default project configurations allow you to specify a base set of toolchain settings, source files, dependencies, etc. for a project. Any project configurations that are explicitly added with ```add_configuration()``` will be merged with the project default.
+ 
+You can also use ```set_default_configuration()``` in a project along with ```set_configuration_defaults()``` in the parent workspace to auto-generate project configurations without needing to explicitly add each configuration to a project with ```add_configuration()```. If a project contains a default configuration, then any configurations added with ```set_configuration_defaults()``` in a parent workspace will be auto-generated for the project by merging the workspace configuration with the default configuration. Note that you can use all three mechanisms together: ```set_default_configuration()```, ```set_configuration_defaults()```, and ```add_configuration()```. When you do so, the configuration results from the merging of all three tiers of settings.      
+
 #### add_configuration ####
 Use ```add_configuration(configuration_name, configuration)``` inside of an application project configuration block to add a build configuration for the application. The ```configuration_name``` parameter expects a symbol that serves as a human-readable name for the configuration. Rake tasks related to this configuration will be namespaced with this symbol. For example, the top-level Rake task for building the "Debug" configuration of "MyApplication" would be "MyApplication:Debug". The ```configuration``` parameter expects a hash that contains settings for the configuration.
 
@@ -437,7 +445,7 @@ Application Project configurations require the following settings:
 
 Application Project configurations offer the following optional settings:
 
-* ```:dependencies``` - The Rake task names of one or more dependencies. For example, ```'MyLibrary:Debug'``` or ```['MyLibrary1:Debug', 'MyLibrary2:Debug']```
+* ```:dependencies``` - The Rake task names of one or more dependencies. For example, ```'MyLibrary:Debug'``` or ```['MyLibrary1:Debug', 'MyLibrary2:Debug']```. You can use the special character '.' to specify the current configuration. For example, ```'MyLibrary:.'``` would expand to ```'MyLibrary:Debug'``` if listed as a dependency in a configuration called 'Debug'.
 
 * ```:sources``` - Source files to build in this configuration. Specified as one or more source file names or source file glob patterns. For example, ```'main.c'``` or ```['main.c', 'startup.c']``` or ```['src/main.c', 'src/*.cpp']```. Note that the source file paths should be relative to the project folder.
 

data/lib/mtbuild.rb

@@ -1,6 +1,6 @@
 module MTBuild
   # The current MTBuild version.
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end
 
 require 'rake'

data/lib/mtbuild/application_project.rb

@@ -6,15 +6,11 @@ module MTBuild
   # and link phases that produce a binary executable.
   class ApplicationProject < Project
 
-    # Adds a named ApplicationConfiguration to the project.
-    def add_configuration(configuration_name, configuration)
-      super
-      default_configuration = {}
-      default_configuration = @parent_workspace.configuration_defaults.fetch(configuration_name, {}) unless @parent_workspace.nil?
-      merged_configuration = Utils.merge_configurations(default_configuration, configuration)
-      cfg = ApplicationConfiguration.new(self, effective_output_folder, configuration_name, merged_configuration)
-      @configurations << cfg
-      cfg
+    private
+
+    # Create an application configuration
+    def create_configuration(configuration_name, configuration)
+      ApplicationConfiguration.new(self, effective_output_folder, configuration_name, configuration)
     end
 
   end

data/lib/mtbuild/compiled_configuration.rb

@@ -17,7 +17,7 @@ module MTBuild
 
     def initialize(parent_project, output_folder, configuration_name, configuration)
       super
-      @dependencies = namespace_tasks(configuration.fetch(:dependencies, []))
+      @dependencies = expand_configuration_wildcards(namespace_tasks(configuration.fetch(:dependencies, [])))
       @dependencies |= configuration.fetch(:rake_dependencies, [])
       @default_toolchain_config = configuration[:toolchain]
       @default_toolchain = Toolchain.create_toolchain(self, @default_toolchain_config)

data/lib/mtbuild/configuration.rb

@@ -43,6 +43,10 @@ module MTBuild
       return task_list
     end
 
+    def expand_configuration_wildcards(task_list)
+      return task_list.collect {|task| task.sub(':.', ":#{@configuration_name}") }
+    end
+
     include Rake::DSL
   end
 

data/lib/mtbuild/framework_project.rb

@@ -13,22 +13,18 @@ module MTBuild
       super
     end
 
-    # Adds a named FrameworkConfiguration to the project.
-    def add_configuration(configuration_name, configuration)
-      super
-      default_configuration = {}
-      default_configuration = @parent_workspace.configuration_defaults.fetch(configuration_name, {}) unless @parent_workspace.nil?
-      merged_configuration = Utils.merge_configurations(default_configuration, configuration)
-      cfg = FrameworkConfiguration.new(self, effective_output_folder, configuration_name, merged_configuration, @api_headers)
-      @configurations << cfg
-      return cfg
-    end
-
     # Specifies API header locations
     def add_api_headers(api_headers)
       @api_headers += Utils.expand_folder_list(api_headers, @project_folder)
     end
 
+    private
+
+    # Create a framework configuration
+    def create_configuration(configuration_name, configuration)
+      FrameworkConfiguration.new(self, effective_output_folder, configuration_name, configuration, @api_headers)
+    end
+
   end
 
 end

data/lib/mtbuild/project.rb

@@ -24,7 +24,8 @@ module MTBuild
     # If supplied, the configuration_block will be passed the
     # newly-constructed Project object.
     def initialize(project_name, project_folder, &configuration_block)
-      @configurations = []
+      @default_configuration = nil
+      @configurations = {}
       @project_folder = File.expand_path(project_folder)
       @output_folder = File.expand_path(File.join(@project_folder, MTBuild.default_output_folder))
       @project_name, @parent_workspace = MTBuild::BuildRegistry.enter_project(project_name, self)
@@ -32,8 +33,10 @@ module MTBuild
 
       configuration_block.call(self) if configuration_block
 
+      generate_implicit_workspace_configurations
+
       namespace @project_name do
-        @configurations.each do |configuration|
+        @configurations.each_value do |configuration|
           configuration.configure_tasks
         end
 
@@ -48,6 +51,11 @@ module MTBuild
       "#{@project_name}:#{config_name}"
     end
 
+    # Get the list of fully-qualified task names for all configurations
+    def tasks_for_all_configurations
+      @configurations.keys.collect{ |name| "#{@project_name}:#{name}"}
+    end
+
     # Set the project's output folder.
     def set_output_folder(output_folder)
       @output_folder = File.expand_path(File.join(@project_folder, output_folder))
@@ -70,9 +78,37 @@ module MTBuild
       end
     end
 
+    def add_configuration(configuration_name, configuration)
+      merged_configuration = {}
+      unless @default_configuration.nil?
+        merged_configuration = @default_configuration
+      end
+      unless @parent_workspace.nil?
+        configuration_defaults = @parent_workspace.configuration_defaults.fetch(configuration_name, {})
+        merged_configuration = Utils.merge_configurations(configuration_defaults, merged_configuration)
+      end
+      merged_configuration = Utils.merge_configurations(merged_configuration, configuration)
+      cfg = create_configuration(configuration_name, merged_configuration)
+      @configurations[configuration_name] = cfg
+      cfg
+    end
+
+    def set_default_configuration(configuration)
+      @default_configuration = configuration
+    end
+
     private
 
-    def add_configuration(configuration_name, configuration)
+    def create_configuration(configuration_name, configuration)
+      nil
+    end
+
+    def generate_implicit_workspace_configurations
+      if not @default_configuration.nil? and not @parent_workspace.nil?
+        @parent_workspace.configuration_defaults.each do |configuration_name, configuration|
+          add_configuration(configuration_name, configuration) unless @configurations.has_key? configuration_name
+        end
+      end
     end
 
     include Rake::DSL

data/lib/mtbuild/staticlibrary_project.rb

@@ -16,17 +16,6 @@ module MTBuild
       end
     end
 
-    # Adds a named static library configuration to the project.
-    def add_configuration(configuration_name, configuration)
-      super
-      default_configuration = {}
-      default_configuration = @parent_workspace.configuration_defaults.fetch(configuration_name, {}) unless @parent_workspace.nil?
-      merged_configuration = Utils.merge_configurations(default_configuration, configuration)
-      cfg = StaticLibraryConfiguration.new(self, effective_output_folder, configuration_name, merged_configuration, @api_headers)
-      @configurations << cfg
-      return cfg
-    end
-
     # Provides a framework package target that builds a framework package with the specified configurations
     def build_framework_package(configuration_names)
       @framework_configurations += Utils.ensure_array(configuration_names)
@@ -39,6 +28,11 @@ module MTBuild
 
     private
 
+    # Create a static library configuration
+    def create_configuration(configuration_name, configuration)
+      StaticLibraryConfiguration.new(self, effective_output_folder, configuration_name, configuration, @api_headers)
+    end
+
     def configure_framework_tasks
       namespace @project_name do
         framework_task = OrganizedPackageTask.new("#{@project_name}", :noversion) do |t|

data/lib/mtbuild/test_application_project.rb

@@ -7,17 +7,14 @@ module MTBuild
   # executable is invoked after building successfully.
   class TestApplicationProject < Project
 
-    # Adds a named test application configuration to the project.
-    def add_configuration(configuration_name, configuration)
-      super
-      default_configuration = {}
-      default_configuration = @parent_workspace.configuration_defaults.fetch(configuration_name, {}) unless @parent_workspace.nil?
-      merged_configuration = Utils.merge_configurations(default_configuration, configuration)
-      cfg = TestApplicationConfiguration.new(self, effective_output_folder, configuration_name, merged_configuration)
-      @configurations << cfg
-      return cfg
+    private
+
+    # Create a test application configuration
+    def create_configuration(configuration_name, configuration)
+      TestApplicationConfiguration.new(self, effective_output_folder, configuration_name, configuration)
     end
 
+
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mtbuild
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Jerry Ryle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-28 00:00:00.000000000 Z
+date: 2015-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake