mtbuild 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a217788ed422994acb0e8b158ddb179f84298f9f
-  data.tar.gz: 5c385e802f9c2fd223f993a93b0009cfb7d984ce
+  metadata.gz: b0d05d02b66836b1bccc0714228bb5b8ddd3f75b
+  data.tar.gz: 9003247800a677e9c85c3edf17a7aa8c27cc9520
 SHA512:
-  metadata.gz: 0e02b69f8cf243376deaf87e298b5855adbbc0885003ee3e6a9a73adcf5124c011aa4efd4b013db361fcbb092ccd1ba1e68362829f83f0af7cdc7a8f40352df6
-  data.tar.gz: f8f2ff9949627b0216253280b44ccfa7ed9625f5f22e7a921678c09a1c9fb86616902eae46f34f0f33fd03428fc879cdd74ec0c8cf260cf30ad1b9832bcee481
+  metadata.gz: 465655463b2538271833decc1684553d0170f86fea3301383c23fa766262cdd38a119aa6860ba9020300d0085c8e069aecbd6953d16ee830b9b6e9cba45d2105
+  data.tar.gz: 63c20bcf635b5978a934bc2f01f6fedff1214cdc706a8d75f446d6ae08cd303780240a59c373c6860a1012c768cb3310c8791ddc0e1db6df1351d109d3858dc3

data/CHANGES.md

@@ -1,6 +1,15 @@
 # Release Notes #
 
 
+## 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.  
+
+
 ## MTBuild 0.1.3 ##
 
 ### Changes ###

data/README.md

@@ -321,28 +321,6 @@ MTBuild Frameworks contain pre-compiled objects/libraries and their headers. MTB
 
 MTBuild Toolchains generate the individual compile, archival, and link tasks that comprise an application or library. Most of the interesting settings in a project's configuration go in the toolchain. The settings vary based upon the toolchain.
 
-#### Versioners ####
-
-MTBuild Versioners update version information inside a source or header file. Versioner tasks are typically invoked on their own with a separate invocation of MTBuild. Versioners are an optional convenience intended for Continuous Integration servers. They're not strictly related to the build process; however, because it's common for CI servers to stamp version information into a file when building, it is convenient to be able to describe the files that need updating along with the rest of the project inside the mtbuildfile.
-
-For example, the following project is configure to use the Mindtribe Standard Version versioner:
-
-```Ruby
-application_project :MyApp, File.dirname(__FILE__) do |app|
-  app.add_configuration :Debug,
-    sources: ['main.c'],
-    toolchain: toolchain(:gcc),
-    versioner: versioner(:mt_std_version,
-      files: 'src/version.h'
-    )
-end
-```
-
-The following updates the project's "version.h" header. The parameters to this particular versioner are detailed in a later section.
-
-```Shell
-mtbuild MyApp:Debug:Version[1,0,0,465,"1.0.0 (465)","f1e471b49a4bedc9cf5c6aabf88cde478e482a69"]
-```
 
 #### DSL ####
 
@@ -467,8 +445,6 @@ Application Project configurations offer the following optional settings:
 
 * ```:tests``` - The Rake task names of one or more unit test applications. For example, ```'MyLibraryTest:Test'``` or ```['MyLibraryTest1:Test', 'MyLibraryTest2:Test']```
 
-* ```:versioner``` - A versioner hash constructed with the ```versioner``` DSL method (detailed in a later section).
-
 * ```:pre_build``` - A callable object (typically a ```lambda```) that will be invoked before the build of this configuration begins.
 
 * ```:post_build``` - A callable object (typically a ```lambda```) that will be invoked after the build of this configuration completes.
@@ -606,45 +582,3 @@ Define an arm-none-eabi-gcc toolchain by passing ```:arm_none_eabi_gcc``` as the
 
 ##### ToolchainArmNoneEabiGcc settings #####
 The ToolchainArmNoneEabiGcc toolchain uses the same settings as the ToolchainGcc toolchain.
-
-
-### MTBuild::Versioner ###
-Define a Versioner with the following DSL method:
-
-```Ruby
-def versioner(versioner_name, versioner_configuration={})
-```
-
-```versioner_name``` is the name of a valid MTBuild versioner. See following sections for valid versioner names.
-
-```versioner_configuration``` expects a hash that contains settings for the versioner.
-
-### MTBuild::VersionerMTStdVersion ###
-Define a Mindtribe Standard Version versioner by passing ```:mt_std_version``` as the ```versioner_name``` when invoking the ```versioner()``` method.
-
-##### VersionerMTStdVersion settings #####
-The VersionerMTStdVersion versioner requires the following settings:
-
-* ```:files``` - One or more version files to be updated. For example, ```'version.h'``` or ```['src/version.h', 'test/version.h']```.
-
-##### VersionerMTStdVersion invocation #####
-
-Mindtribe Standard Version parameters should be specified when invoking MTBuild to run a VersionerMTStdVersion versioner task. These parameters, in order, are:
-
-* ```major``` - The build's major version number
-
-* ```minor``` - The build's minor version number
-
-* ```revision``` - The build's revision number
-
-* ```build``` - The build's build number
-
-* ```version_string``` - The build's version as a complete string
-
-* ```git_SHA``` - The build's git SHA as a string
-
-For example:
-
-```Shell
-mtbuild MyApp:Debug:Version[1,0,0,465,"1.0.0 (465)","f1e471b49a4bedc9cf5c6aabf88cde478e482a69"]
-```

data/lib/mtbuild.rb

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

data/lib/mtbuild/configuration.rb

@@ -1,7 +1,5 @@
 module MTBuild
 
-  require 'mtbuild/versioner'
-
   # This is the base class for all configuration types.
   class Configuration
 
@@ -29,15 +27,10 @@ module MTBuild
       @post_build = configuration.fetch(:post_build, nil)
 
       @pre_build.call if @pre_build.respond_to? :call
-
-      @versioner = nil
-      @versioner_config = configuration.fetch(:versioner, nil)
-      @versioner = Versioner.create_versioner(@parent_project.project_name, @project_folder, @output_folder, @configuration_name, @versioner_config) unless @versioner_config.nil?
     end
 
     # Create the actual Rake tasks that will perform the configuration's work
     def configure_tasks
-      @versioner.create_version_tasks unless @versioner.nil?
     end
 
     private

data/lib/mtbuild/dsl.rb

@@ -34,13 +34,6 @@ module MTBuild
       return toolchain_configuration
     end
 
-    # Defines a Versioner
-    def versioner(versioner_name, versioner_configuration={})
-      fail "error: the version file configuration is expected to be a hash." unless versioner_configuration.is_a? Hash
-      versioner_configuration[:name] = versioner_name
-      return versioner_configuration
-    end
-
     # Declare an MT file task.
     #
     # Example:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mtbuild
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Jerry Ryle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-14 00:00:00.000000000 Z
+date: 2015-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -128,8 +128,6 @@ files:
 - 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
 - CHANGES.md

data/lib/mtbuild/versioner.rb

@@ -1,54 +0,0 @@
-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

@@ -1,72 +0,0 @@
-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