guardian-angel 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e448d846f7832faaf993bc66da560f47df9f9e7
-  data.tar.gz: 7ee0374d51306fcba167848fcec8adf014e7cdca
+  metadata.gz: aa1d8955513a660d1b1d388fd12325528fa3f392
+  data.tar.gz: a4cf0ea6e13f48e6bdc59dd79d6146cbca6447c5
 SHA512:
-  metadata.gz: 25fc3c497a2a8f6ef1b36aeb962deea5343b4da4294e0b7fcc9e076e64866751e9d489306e278fedf7e64953f7785cc662570fc61b4da0a43dade895eb394241
-  data.tar.gz: ab080ed038aea304e99ee068414c7315193b58d69074ccc2e273dd48bb8b5e0c4471c4f331ffba64acb803ce4a33f07dc332b0f271b341cd98447c2691312a9e
+  metadata.gz: 5a091afeeb1b9a16f63df72fe85a19ed1f119371dfef0a48ecc500da3cf59db2d7565bcd7d1d89591ce97f69a90fa03aab44c08d6b1cab6d78efcdebf2517203
+  data.tar.gz: 0e6e83763a3f99afb4a1d64b75faea84661d35a6724b28d9b2c78f1892956fb5979b5ad891156f2db846540ff012210db381c4cbb821aded36521235a8685f7d

data/bin/xctestfile

@@ -5,8 +5,8 @@ require 'ga_runner'
 
 trap("INT") { exit }
 
-fileToTest = GALoader.getFileFromArgv(ARGV)
-configuration = GALoader.readConfiguration()
+fileToTest = GALoader.getFileFromArray(ARGV)
+configuration = GALoader.readConfiguration(silent = true)
 
 runner = GARunner.new(configuration, fileToTest)
 runner.test()

data/lib/ga_configuration.rb

@@ -98,27 +98,13 @@ class GAConfiguration
   # @param other [GAConfiguration] another instance of GAConfiguration you want to merge
   # @note nil values will not overwrite valid values of self
   def merge(other)
-    unless other.scheme.nil?
-      @scheme = other.scheme
-    end
-    unless other.workspace.nil?
-      @workspace = other.workspace
-    end
-    unless other.target.nil?
-      @target = other.target
-    end
-    unless other.suffix.nil?
-      @suffix = other.suffix
-    end
-    unless other.reporter.nil?
-      @reporter = other.reporter
-    end
-    unless other.xctool_path.nil?
-      @xctool_path = other.xctool_path
-    end
-    unless other.project.nil?
-      @project = other.project
-    end
+    @scheme = other.scheme unless other.scheme.nil?
+    @workspace = other.workspace unless other.workspace.nil?
+    @target = other.target unless other.target.nil?
+    @suffix = other.suffix unless other.suffix.nil?
+    @reporter = other.reporter unless other.reporter.nil?
+    @xctool_path = other.xctool_path unless other.xctool_path.nil?
+    @project = other.project unless other.project.nil?
     
     return self
   end

data/lib/ga_loader.rb

@@ -11,7 +11,7 @@ class GALoader
   # @note if the file is not found, it will try to build with default values instead
   # @note this also outputs the final GAConfiguration built on the console
   # (see #GAConfiguration)
-  def self.readConfiguration()
+  def self.readConfiguration(silent = false)
     configuration = GAConfiguration.new
     
     begin
@@ -19,11 +19,11 @@ class GALoader
       configurationMerge = GAConfiguration.new(jsonDictionary)
       configuration = configuration.merge(configurationMerge)
     rescue
-      GALogger.log("#{CONFIG_FILENAME} not found, using defaults", :Warning)
+      GALogger.log("#{CONFIG_FILENAME} not found or not a valid JSON, using defaults", :Warning) unless silent
     end
     
     validateConfiguration(configuration)
-    outputConfiguration(configuration)
+    outputConfiguration(configuration) unless silent
     
     return configuration
   end
@@ -32,20 +32,25 @@ class GALoader
   #
   # @note this searches only in the top level directory
   def self.findWorkspace
-    workspace = `find . -maxdepth 1 -name '*.xcworkspace'`
-    return nil if workspace.empty?
-    
-    return File.basename(workspace, ".*")
+    return findFile("xcworkspace")
   end
   
   # Returns a possible project, in case one is not provided in the configuration
   #
   # @note this searches only in the top level directory
   def self.findProject
-    project = `find . -maxdepth 1 -name '*.xcodeproj'`
-    return nil if project.empty?
+    return findFile("xcodeproj")
+  end
+  
+  # Returns the first file with the given extension
+  #
+  # @param extension [String] the file extension you want to search
+  # @return nil if no file is found, the first file with the given extension otherwise
+  def self.findFile(extension)
+    files = Dir.glob("*.#{extension}")
+    return nil if files.empty?
     
-    return File.basename(project, ".*")
+    return File.basename(files.first, ".*")
   end
   
   # Validates a given configuration
@@ -60,17 +65,17 @@ class GALoader
       possibleWorkspace = findWorkspace()
       
       if !possibleWorkspace
-        if configuration.project.nil?
+        possibleProject = configuration.project
+        if possibleProject.nil?
           possibleProject = findProject()
           
           if !possibleProject
-            GALogger.log("workspace or project was not specified, exiting", :Error)
-            outputSampleConfiguration()
-            abort
-          else
-            configurationMerge = GAConfiguration.new(GAConfiguration::GAConfigurationProject => possibleProject)
+            GALogger.log("workspace or project was not specified and cannot be found, exiting", :Error)
+            outputSampleConfiguration(eventuallyAbort = true)
           end
         end
+        
+        configurationMerge = GAConfiguration.new(GAConfiguration::GAConfigurationProject => possibleProject)
       else
         configurationMerge = GAConfiguration.new(GAConfiguration::GAConfigurationWorkspace => possibleWorkspace)
       end
@@ -79,8 +84,6 @@ class GALoader
     end
     
     if configuration.scheme.nil?
-      configurationMerge = nil
-      
       unless configuration.project.nil?
         configurationMerge = GAConfiguration.new(GAConfiguration::GAConfigurationScheme => configuration.project)
       end
@@ -88,29 +91,12 @@ class GALoader
         configurationMerge = GAConfiguration.new(GAConfiguration::GAConfigurationScheme => configuration.workspace)
       end
       
-      if configurationMerge.nil?
-        GALogger.log("scheme was not specified, exiting", :Error)
-        outputSampleConfiguration()
-        abort
-      else
-        configuration = configuration.merge(configurationMerge)
-      end
+      configuration = configuration.merge(configurationMerge)
     end
     
     if configuration.target.nil?
-      configurationMerge = nil
-      
-      unless configuration.scheme.nil?
-        configurationMerge = GAConfiguration.new(GAConfiguration::GAConfigurationTarget => configuration.scheme + 'Tests')
-      end
-      
-      if configurationMerge.nil?
-        GALogger.log("target was not specified, exiting", :Error)
-        outputSampleConfiguration()
-        abort
-      else
-        configuration = configuration.merge(configurationMerge)
-      end
+      configurationMerge = GAConfiguration.new(GAConfiguration::GAConfigurationTarget => configuration.scheme + 'Tests')      
+      configuration = configuration.merge(configurationMerge)
     end
     
     xctoolExists = system("which #{configuration.xctool_path} > /dev/null")
@@ -121,36 +107,38 @@ class GALoader
   end
   
   # Outputs a sample configuration to let the user know how to create a valid one
+  # 
+  # @param eventuallyAbort [Bool] pass true if you want to abort after printing out the sample configuration. Default is false.
   #
   # (see #GAConfiguration)
-  def self.outputSampleConfiguration()
-    GALogger.log('Sample configuration JSON: ' + GAConfiguration.sample.to_s, :Warning)
+  def self.outputSampleConfiguration(eventuallyAbort = false)
+    GALogger.log('Sample configuration JSON: ' + GAConfiguration.sample.to_s, :Warning, '')
+    if eventuallyAbort
+      abort
+    end
   end
   
   # Outputs a given configuration on the console
   # 
   # @param [GAConfiguration] the configuration you want to print
   def self.outputConfiguration(configuration)
-    puts configuration.to_s
+    GALogger.log(configuration.to_s, :Default, '')
   end
   
   # Returns a filename from a given array
   #
-  # @param argv [Array<String>] an array of strings
+  # @param files [Array<String>] an array of strings
   #
   # @note the method will take the last element of the array
   # @note the method will take only the filename if the element of the array is a file, removing the extension and the path
-  def self.getFileFromArgv(argv) 
-    fileToTest = nil
-    argv.each do|a| 
-      fileToTest = File.basename(a, ".*")
-    end
-
+  def self.getFileFromArray(files) 
+    fileToTest = files.first
+    
     if fileToTest.nil?
       GALogger.log('Failed to get file', :Error)
       abort
+    else
+      return File.basename(fileToTest, ".*")
     end
-    
-    return fileToTest
   end
 end

data/lib/ga_logger.rb

@@ -9,9 +9,11 @@ class GALogger
   #
   # @param message [String] a string to log
   # @param type [Symbol] specifies the type of message. This can be :Error, :Warning, :Success or :Default
+  # @param padding [String] the padding to put before and after the message
+  #
   # @note depending on the message type, a different color will be used to print the message on the console
-  def self.log(message, type = :Default)
-    puts sequenceForType(type) + '### ' + message + ' ###' + sequenceForType(:Default)
+  def self.log(message, type = :Default, padding = ' ### ')
+    puts sequenceForType(type) + padding + message + padding + sequenceForType(:Default)
   end
   
   # Returns the character code to print with the right color given a message type

data/lib/ga_runner.rb

@@ -10,9 +10,9 @@ class GARunner
   # @param filename [String] the name of the file you want to run the tests for
   # @note filename can also be a tests file
   def initialize(configuration, filename)
-        @configuration=configuration
-        @filename=filename
-        @runner=XctoolRunner.new(configuration)
+      @configuration=configuration
+      @filename=filename
+      @runner=XctoolRunner.new(configuration)
   end
   
   # Runs unit tests for the given filename, if a tests file exists
@@ -38,15 +38,8 @@ class GARunner
   # (see #buildIfNeeded)
   # (see #testIfAvailable)
   def test()    
-    filename = @filename
-    suffix = @configuration.suffix
-    
     buildIfNeeded()
-    if isTest()
-      filename = @filename.slice(/(?<file>.*)#{suffix}$/, "file")
-    end
-    
-    testIfAvailable(filename)
+    testIfAvailable(codeFilename())
   end
   
   # @return true if the filename is a tests file
@@ -54,12 +47,24 @@ class GARunner
     return @filename.end_with? @configuration.suffix
   end
   
+  # @return [String] the code file corresponding to @filename, stripping the suffix if @filename is a test file
+  def codeFilename() 
+    suffix = @configuration.suffix
+    stripped = @filename
+    if isTest()
+      stripped = @filename.slice(/(?<file>.*)#{suffix}$/, "file")
+    end
+    
+    return stripped
+  end
+  
   # This method builds the tests project if the filename setup during initialization is a tests file
   # (see #isTest)
   def buildIfNeeded()
     if isTest()
        GALogger.log(@filename + ' is a test, building all the tests...')
-       GuardianAngel.buildWithConfiguration(@configuration)
     end
+    
+    GuardianAngel.buildWithConfiguration(@configuration)
   end
 end

data/lib/xctool_runner.rb

@@ -20,9 +20,7 @@ class XctoolRunner
     xctool = @configuration.xctool_path
     
     building = workspace
-    if workspace.nil?
-      building = project
-    end
+    building = project if workspace.nil?
     
     GALogger.log("Building " + building + " with scheme " + scheme + "...")
     
@@ -45,7 +43,6 @@ class XctoolRunner
      project = @configuration.project
      
      toBuild = ''
-     
      if workspace.nil?
        toBuild = " -project '" + project + ".xcodeproj'"
      else  
@@ -60,10 +57,8 @@ class XctoolRunner
   # @param filename [String] the file you wish to run the tests for
   # @note This method supports both workspace- and project-based environments
   def test(filename)
-    workspace = @configuration.workspace
     scheme = @configuration.scheme
     target = @configuration.target
-    project = @configuration.project
     xctool = @configuration.xctool_path
     reporter = @configuration.reporter
     suffix = @configuration.suffix

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guardian-angel
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Vittorio Monaco