guardian-angel 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b756688b60516c6856da9c1cff4576f846f52056
+  data.tar.gz: d896fceb43a6d3291435f69fab862f073c3f1a4e
+SHA512:
+  metadata.gz: 61cea12f91402ba6a541d27a2d8aaa606deea1c2bc954dd0b17f9179cee9ee633179d466283b9428e030156ebb3f0e07087fe708a33369f1304952d3ab7a20b2
+  data.tar.gz: 58148addf0594055fd9a76ccff0b8502781bf72f21ee24f8913d69633adad37a8c308cb1f3bc24688d9bd633dd78276f5e1f4ac1961b182f6059bc06a5d77b0c

data/bin/guardian-angel

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'ga_loader'
+require 'guardian_angel'
+require 'ga_logger'
+
+trap("INT") { exit }
+
+configuration = GALoader.readConfiguration()
+
+watcher = GuardianAngel.new(configuration)
+watcher.buildTests()
+watcher.watch()

data/bin/xctestfile

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'ga_loader'
+require 'ga_runner'
+
+trap("INT") { exit }
+
+fileToTest = GALoader.getFileFromArgv(ARGV)
+configuration = GALoader.readConfiguration()
+
+runner = GARunner.new(configuration, fileToTest)
+runner.test()

data/lib/ga_configuration.rb

@@ -0,0 +1,94 @@
+# @author Vittorio Monaco
+class GAConfiguration
+  GAConfigurationScheme = "scheme"
+  GAConfigurationWorkspace = "workspace"
+  GAConfigurationTarget = "target"
+  GAConfigurationSuffix = "suffix"
+  GAConfigurationReporter = "reporter"
+  GAConfigurationXctoolPath = "xctool"
+
+  # @return the configured xcode scheme
+  def scheme
+    @scheme
+  end
+  
+  # @return the configured xcode workspace
+  def workspace
+    @workspace
+  end
+  
+  # @return the configured suffix for tests files
+  def suffix
+    @suffix
+  end
+  
+  # @return the configured xcode tests target
+  def target
+    @target
+  end
+  
+  # @return the configured xctool reporter
+  def reporter
+    @reporter
+  end
+  
+  # @return the configured xctool executable path
+  def xctool_path
+    @xctool_path
+  end
+  
+  # Prints the configuration instance
+  # @return a [String] representation of the instance 
+  def to_s
+    hashForOutput = {
+      GAConfigurationScheme => @scheme,
+      GAConfigurationWorkspace => @workspace,
+      GAConfigurationTarget => @target,
+      GAConfigurationSuffix => @suffix,
+      GAConfigurationReporter => @reporter,
+      GAConfigurationXctoolPath => @xctool_path
+    }
+    
+    return hashForOutput.to_s
+  end
+  
+  # Creates an instance with the given configuration, or uses a default one if not provided
+  # @param configuration [GAConfiguration]
+  #
+  # @note by default the #suffix is implied as "Test", the #reporter as "pretty" and the #xctool_path as "xctool"
+  def initialize(configuration = { GAConfigurationSuffix => "Test", GAConfigurationReporter => "pretty", GAConfigurationXctoolPath => "xctool" })
+    @scheme = configuration[GAConfigurationScheme]
+    @workspace = configuration[GAConfigurationWorkspace]
+    @target = configuration[GAConfigurationTarget]
+    @suffix = configuration[GAConfigurationSuffix]
+    @reporter = configuration[GAConfigurationReporter]
+    @xctool_path = configuration[GAConfigurationXctoolPath]
+  end
+  
+  # Merges two GAConfiguration instances
+  #
+  # @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
+    
+    return self
+  end
+end

data/lib/ga_loader.rb

@@ -0,0 +1,87 @@
+require 'json'
+require 'ga_logger'
+require 'ga_configuration'
+
+CONFIG_FILENAME = 'guardian_angel.json'
+
+# @author Vittorio Monaco
+class GALoader
+  # Reads the configuration from the file guardian_angel.json
+  #
+  # @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()
+    GALogger.log("Reading #{CONFIG_FILENAME}...")
+    
+    configuration = GAConfiguration.new
+    
+    begin
+      jsonDictionary = JSON.parse(File.read(CONFIG_FILENAME))
+      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
+    
+    validateConfiguration(configuration)
+    outputConfiguration(configuration)
+    
+    return configuration
+  end
+  
+  # Validates a given configuration
+  #
+  # @param configuration [GAConfiguration] the configuration to validate
+  # @note required attributes are workspace, scheme and target
+  # @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
+    end
+    if configuration.scheme.nil?
+      GALogger.log("scheme was not specified, exiting", :Error)
+      abort
+    end
+    if configuration.target.nil?
+      GALogger.log("target was not specified, exiting", :Error)
+      abort
+    end
+    
+    xctoolExists = system("which #{configuration.xctool_path} > /dev/null")
+    if !xctoolExists
+      GALogger.log(configuration.xctool_path + " can't be found. Aborting.", :Error)
+      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
+  end
+  
+  # Returns a filename from a given array
+  #
+  # @param argv [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
+
+    if fileToTest.nil?
+      GALogger.log('Failed to get file', :Error)
+      abort
+    end
+    
+    return fileToTest
+  end
+end

data/lib/ga_logger.rb

@@ -0,0 +1,32 @@
+# @author Vittorio Monaco
+class GALogger
+  :Error
+  :Warning
+  :Success
+  :Default
+  
+  # Logs a message on the console
+  #
+  # @param message [String] a string to log
+  # @param type [Symbol] specifies the type of message. This can be :Error, :Warning, :Success or :Default
+  # @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)
+  end
+  
+  # Returns the character code to print with the right color given a message type
+  #
+  # @param type [Symbol] the message type. This can be :Error, :Warning, :Success or :Default
+  def self.sequenceForType(type)
+    case type
+    when :Success
+      return "\033[32m"
+    when :Error
+      return "\033[31m"
+    when :Warning
+      return "\033[33m"
+    else
+      return "\033[0m"
+    end
+  end
+end

data/lib/ga_runner.rb

@@ -0,0 +1,74 @@
+require 'ga_logger'
+require 'guardian_angel'
+
+# @author Vittorio Monaco
+class GARunner
+  # Creates a new instance given a GAConfiguration object and a filename to run tests
+  #
+  # @param configuration [GAConfiguration] the configuration you want to use to run the tests (see #GAConfiguration)
+  # @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
+  end
+  
+  # Runs unit tests for the given filename, if a tests file exists
+  # 
+  # @param filename [String] the file you want to run tests for
+  # @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')
+      if !fileExists
+        GALogger.log(filename + " doesn't seem to have associated tests. You may think about it.", :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)
+  end
+  
+  # Tries to run unit tests for the filename setup during initialization
+  # 
+  # @note if the filename is a tests file, this method strips the tests suffix and runs the tests for the right file instead, after having built the tests project first
+  # (see #buildIfNeeded)
+  # (see #testIfAvailable)
+  def test()    
+    filename = @filename
+    suffix = @configuration.suffix
+    
+    buildIfNeeded()
+    if isTest()
+      filename = @filename.slice(/(?<file>.*)#{suffix}$/, "file")
+    end
+    
+    testIfAvailable(filename)
+  end
+  
+  # @return true if the filename is a tests file
+  def isTest()
+    return @filename.end_with? @configuration.suffix
+  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
+  end
+end

data/lib/guardian_angel.rb

@@ -0,0 +1,42 @@
+require 'ga_logger'
+
+# @author Vittorio Monaco
+class GuardianAngel
+  # Creates a new instance given a GAConfiguration object
+  #
+  # @param configuration [GAConfiguration] the configuration you want to use to run the tests (see #GAConfiguration)
+  def initialize(configuration)
+    @configuration=configuration
+  end
+     
+  # Convenience method to build tests in a stand-alone fashion
+  #
+  # @param configuration [GAConfiguration] the configuration you want to use to run the tests (see #GAConfiguration)
+  def self.buildWithConfiguration(configuration)
+    watcher = GuardianAngel.new(configuration)
+    watcher.buildTests()
+  end
+  
+  # Builds the tests target through xctool
+  #
+  # @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)
+  end
+  
+  # Starts watching for changes to .m or .swift files in the caller directory
+  #
+  # @note this uses the gem filewatcher
+  def watch()
+    GALogger.log("Watching...")
+    system("filewatcher '*.{m,swift}' 'xctestfile $FILENAME'", out: $stdout, err: :out)
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: guardian-angel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vittorio Monaco
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: A file watcher that runs tests for the modified files
+email: vittorio.monaco1@gmail.com
+executables:
+- guardian-angel
+- xctestfile
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/guardian-angel
+- bin/xctestfile
+- lib/ga_configuration.rb
+- lib/ga_loader.rb
+- lib/ga_logger.rb
+- lib/ga_runner.rb
+- lib/guardian_angel.rb
+homepage: http://vittoriomonaco.it
+licenses:
+- MIT
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Guardian Angel
+test_files: []