guardian-angel 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b756688b60516c6856da9c1cff4576f846f52056
-  data.tar.gz: d896fceb43a6d3291435f69fab862f073c3f1a4e
+  metadata.gz: 1e8a07cc9d415e7805881f31d56576a065f0b0ae
+  data.tar.gz: 60e6055cda8f7621571eca4ba028883553eff487
 SHA512:
-  metadata.gz: 61cea12f91402ba6a541d27a2d8aaa606deea1c2bc954dd0b17f9179cee9ee633179d466283b9428e030156ebb3f0e07087fe708a33369f1304952d3ab7a20b2
-  data.tar.gz: 58148addf0594055fd9a76ccff0b8502781bf72f21ee24f8913d69633adad37a8c308cb1f3bc24688d9bd633dd78276f5e1f4ac1961b182f6059bc06a5d77b0c
+  metadata.gz: 757379efb86edd265634fafbe27d69574c9ee4aae22235e116d433dfa9f1ceaf6ab8f72b3a504cbd4027785f4bd785b69749e1b9e9bdc90b395e1d0a5de8ad15
+  data.tar.gz: f2135736d1d9760211d793a552b776ba3fc0b19e5690e16ba54d4e8b1968ade9c6dba6f1224aaf1e3781046eae7067435a16e75a4b15a59db05c2092cd2d4b92

data/lib/ga_configuration.rb

@@ -6,13 +6,23 @@ class GAConfiguration
   GAConfigurationSuffix = "suffix"
   GAConfigurationReporter = "reporter"
   GAConfigurationXctoolPath = "xctool"
+  GAConfigurationProject = "project"
+  
+  GAConfigurationDefaultReporter = "pretty"
+  GAConfigurationDefaultXctoolPath = "xctool"
+  GAConfigurationDefaultSuffix = "Test"
 
   # @return the configured xcode scheme
   def scheme
     @scheme
   end
   
-  # @return the configured xcode workspace
+  # @return the configured xcode project, if not using workspaces
+  def project
+    @project
+  end
+  
+  # @return the configured xcode workspace, if not using projects
   def workspace
     @workspace
   end
@@ -46,12 +56,29 @@ class GAConfiguration
       GAConfigurationTarget => @target,
       GAConfigurationSuffix => @suffix,
       GAConfigurationReporter => @reporter,
-      GAConfigurationXctoolPath => @xctool_path
+      GAConfigurationXctoolPath => @xctool_path,
+      GAConfigurationProject => @project
     }
     
     return hashForOutput.to_s
   end
   
+  # Creates a sample GAConfiguration instance to instruct the user
+  #
+  # @return [GAConfiguration] an instance that should not be used apart from outputting on the console
+  def self.sample
+    sample = GAConfiguration.new({
+      GAConfigurationWorkspace => 'MyProject',
+      GAConfigurationScheme => 'MyProject-Dev',
+      GAConfigurationTarget => 'MyProjectTests',
+      GAConfigurationSuffix => GAConfigurationDefaultSuffix,
+      GAConfigurationReporter => GAConfigurationDefaultReporter,
+      GAConfigurationXctoolPath => GAConfigurationDefaultXctoolPath
+    })
+        
+    return sample
+  end
+  
   # Creates an instance with the given configuration, or uses a default one if not provided
   # @param configuration [GAConfiguration]
   #
@@ -63,6 +90,7 @@ class GAConfiguration
     @suffix = configuration[GAConfigurationSuffix]
     @reporter = configuration[GAConfigurationReporter]
     @xctool_path = configuration[GAConfigurationXctoolPath]
+    @project = configuration[GAConfigurationProject]
   end
   
   # Merges two GAConfiguration instances
@@ -88,6 +116,9 @@ class GAConfiguration
     unless other.xctool_path.nil?
       @xctool_path = other.xctool_path
     end
+    unless other.project.nil?
+      @project = other.project
+    end
     
     return self
   end

data/lib/ga_loader.rb

@@ -12,8 +12,6 @@ class GALoader
   # @note this also outputs the final GAConfiguration built on the console
   # (see #GAConfiguration)
   def self.readConfiguration()
-    GALogger.log("Reading #{CONFIG_FILENAME}...")
-    
     configuration = GAConfiguration.new
     
     begin
@@ -21,8 +19,6 @@ class GALoader
       configurationMerge = GAConfiguration.new(jsonDictionary)
       configuration = configuration.merge(configurationMerge)
     rescue
-      #Find workspace, scheme and target
-      #merge and return
       GALogger.log("#{CONFIG_FILENAME} not found, using defaults", :Warning)
     end
     
@@ -32,23 +28,72 @@ class GALoader
     return configuration
   end
   
+  # Returns a possible workspace, in case one is not provided in the configuration
+  #
+  # @note this searches only in the current directory
+  def self.findWorkspace
+    workspace = value = `find . -maxdepth 1 -name '*.xcworkspace'`
+    return nil if workspace.empty?
+    
+    return File.basename(workspace, ".*")
+  end
+  
   # Validates a given configuration
   #
   # @param configuration [GAConfiguration] the configuration to validate
-  # @note required attributes are workspace, scheme and target
+  # @note required attribute is workspace/project
+  # @note if scheme is not specified, the same as the workspace/project will be used
+  # @note if target is not specified, '{workspace|project}Tests' will be used
   # @note the method will also make sure that the configured xctool executable can be found, or aborts otherwise 
   def self.validateConfiguration(configuration)
     if configuration.workspace.nil? 
-      GALogger.log("workspace was not specified, exiting", :Error)
-      abort
+      possibleWorkspace = findWorkspace()
+      
+      if !possibleWorkspace
+        if configuration.project.nil?
+          GALogger.log("workspace or project was not specified, exiting", :Error)
+          outputSampleConfiguration()
+          abort
+        end
+      end
+      
+      configurationMerge = GAConfiguration.new(GAConfiguration::GAConfigurationWorkspace => possibleWorkspace)
+      configuration = configuration.merge(configurationMerge)
     end
+    
     if configuration.scheme.nil?
-      GALogger.log("scheme was not specified, exiting", :Error)
-      abort
+      configurationMerge = nil
+      
+      unless configuration.project.nil?
+        configurationMerge = GAConfiguration.new(GAConfiguration::GAConfigurationScheme => configuration.project)
+      end
+      unless configuration.workspace.nil?
+        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
     end
+    
     if configuration.target.nil?
-      GALogger.log("target was not specified, exiting", :Error)
-      abort
+      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
     end
     
     xctoolExists = system("which #{configuration.xctool_path} > /dev/null")
@@ -58,6 +103,13 @@ class GALoader
     end
   end
   
+  # Outputs a sample configuration to let the user know how to create a valid one
+  #
+  # (see #GAConfiguration)
+  def self.outputSampleConfiguration()
+    GALogger.log('Sample configuration JSON: ' + GAConfiguration.sample.to_s, :Warning)
+  end
+  
   # Outputs a given configuration on the console
   # 
   # @param [GAConfiguration] the configuration you want to print

data/lib/ga_runner.rb

@@ -1,5 +1,6 @@
 require 'ga_logger'
 require 'guardian_angel'
+require 'xctool_runner'
 
 # @author Vittorio Monaco
 class GARunner
@@ -11,6 +12,7 @@ class GARunner
   def initialize(configuration, filename)
         @configuration=configuration
         @filename=filename
+        @runner=XctoolRunner.new(configuration)
   end
   
   # Runs unit tests for the given filename, if a tests file exists
@@ -19,26 +21,15 @@ class GARunner
   # @note filename must be a code file, not a tests file. If you're not sure whether the file is a tests file or not, use #test instead
   # @note if a corresponding tests file cannot be found, outputs a warning line
   def testIfAvailable(filename)
-      workspace = @configuration.workspace
-      scheme = @configuration.scheme
-      target = @configuration.target
       suffix = @configuration.suffix
-      reporter = @configuration.reporter
-      xctool = @configuration.xctool_path
       
-      fileExists = system('find . | grep ' + filename + suffix + ' > /dev/null')
+      fileExists = system("find . | grep '" + filename + suffix + "' > /dev/null")
       if !fileExists
-        GALogger.log(filename + " doesn't seem to have associated tests. You may think about it.", :Warning)
+        GALogger.log(filename + " doesn't seem to have associated tests. You should think about creating some.", :Warning)
         return
       end
       
-      GALogger.log("Running tests for file " + filename + '...')
-      system(xctool + ' -workspace -workspace ' + workspace + '.xcworkspace' +
-             ' -scheme ' + scheme +
-             ' -sdk iphonesimulator' +
-             ' run-tests' +
-             ' -reporter ' + reporter
-             ' only ' + target + ':' + filename + suffix, out: $stdout, err: :out)
+      @runner.test(filename)
   end
   
   # Tries to run unit tests for the filename setup during initialization

data/lib/guardian_angel.rb

@@ -1,4 +1,5 @@
 require 'ga_logger'
+require 'xctool_runner'
 
 # @author Vittorio Monaco
 class GuardianAngel
@@ -7,6 +8,7 @@ class GuardianAngel
   # @param configuration [GAConfiguration] the configuration you want to use to run the tests (see #GAConfiguration)
   def initialize(configuration)
     @configuration=configuration
+    @runner=XctoolRunner.new(configuration)
   end
      
   # Convenience method to build tests in a stand-alone fashion
@@ -19,17 +21,10 @@ class GuardianAngel
   
   # Builds the tests target through xctool
   #
+  # (see #XctoolRunner)
   # @note a configuration must be already setup for this method to work
   def buildTests()    
-    workspace = @configuration.workspace
-    scheme = @configuration.scheme
-    xctool = @configuration.xctool_path
-    
-    GALogger.log("Building workspace " + workspace + " with scheme " + scheme + "...")
-    system(xctool + ' -workspace ' + workspace + '.xcworkspace' +
-           ' -scheme ' + scheme +
-           ' -sdk iphonesimulator' +
-           ' build-tests', out: $stdout, err: :out)
+    @runner.build()
   end
   
   # Starts watching for changes to .m or .swift files in the caller directory

data/lib/xctool_runner.rb

@@ -0,0 +1,81 @@
+require 'ga_logger'
+
+# @author Vittorio Monaco
+class XctoolRunner
+  # Creates a new instance given a GAConfiguration object
+  #
+  # @param configuration [GAConfiguration] the configuration you want to use to build and run the tests (see #GAConfiguration)
+  def initialize(configuration)
+    @configuration=configuration
+  end
+    
+  # Builds the tests target through xctool
+  #
+  # @note This method supports both workspace- and project-based environments
+  def build()
+    workspace = @configuration.workspace
+    scheme = @configuration.scheme
+    target = @configuration.target
+    project = @configuration.project
+    xctool = @configuration.xctool_path
+    
+    building = workspace
+    if workspace.nil?
+      building = project
+    end
+    
+    GALogger.log("Building " + building + " with scheme " + scheme + "...")
+    
+    toBuild = buildArgument()
+    system(xctool + toBuild + 
+           ' -scheme ' + scheme +
+           ' -sdk iphonesimulator' +
+           ' build-tests', out: $stdout, err: :out)
+  end
+  
+  # Returns the main argument for xctool to build the project/workspace
+  #
+  # Example:
+  # -workspace 'MyWorkspace.xcworkspace'
+  # or
+  # -project 'MyProject.xcodeproj'
+  def buildArgument()
+     workspace = @configuration.workspace
+     scheme = @configuration.scheme
+     project = @configuration.project
+     
+     toBuild = ''
+     
+     if workspace.nil?
+       toBuild = " -project '" + project + ".xcodeproj'"
+     else  
+       toBuild = " -workspace '" + workspace + ".xcworkspace'"
+     end 
+     
+     return toBuild
+  end
+  
+  # Runs tests for the specified file
+  #
+  # @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
+    
+    GALogger.log("Running tests for file " + filename + '...')
+    
+    toBuild = buildArgument()
+    system(xctool + toBuild +
+           ' -scheme ' + scheme +
+           ' -sdk iphonesimulator' +
+           ' run-tests' +
+           ' only ' + target + ':' + filename + suffix +
+           ' -reporter ' + reporter, out: $stdout, err: :out)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guardian-angel
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Vittorio Monaco
@@ -38,7 +38,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.8'
-description: A file watcher that runs tests for the modified files
+description: A file watcher for iOS developers that runs tests for the modified files
 email: vittorio.monaco1@gmail.com
 executables:
 - guardian-angel
@@ -53,7 +53,8 @@ files:
 - lib/ga_logger.rb
 - lib/ga_runner.rb
 - lib/guardian_angel.rb
-homepage: http://vittoriomonaco.it
+- lib/xctool_runner.rb
+homepage: http://vittoriomonaco.it/guardian-angel
 licenses:
 - MIT
 metadata: {}