guard-xctool-test 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1784e9f38e9085bfb1c1385ab806671fbb85c1c2
+  data.tar.gz: 06f2ba6dc15c8e24dec0126d4fd93fc3d28631c9
+SHA512:
+  metadata.gz: 347d74162692a7468167fa1070c3c243c7cb2b60b4f070fb3c6686d984d51432b0664b6f4560f7a22aeeed7ca61f86ed03db8d6deefab9c10236c71664def933
+  data.tar.gz: ab96309cf9564946cf3e0df3a0fc3629bd8fdf4242a73b2099b7ad31a7cbb3c92afd8bb4bf0a4f03415bb19f172e8f08ad45690c6510f536fb3db4e3bac806dc

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+bundler_args: --without development
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+  - rbx-19mode
+  - rbx-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-head

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in guard-xctool-test.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Francis Chong
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+# guard-xctool-test
+
+Xctool test guard allows you to automically & intelligently aunch specs when files are modified.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'guard-xctool-test'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install guard-xctool-test
+
+## Dependency
+
+- Ruby 1.9.3 or above
+- [xctool](https://github.com/facebook/xctool)
+
+
+## Guardfile
+
+```ruby
+guard 'xctool-test' do
+  watch(%r{YourApp/(.+)\.(m|mm)$})
+  watch(%r{YourAppTests/(.+)\.(m|mm)$})
+end
+```
+
+## Options
+
+By default, xctool-test find the folder for projects and find a target that look like test.
+You can supply your target by using ```test_target``` option.
+
+```ruby
+guard 'xctool-test', :test_target => 'YourAppTests' do
+  watch(%r{YourApp/(.+)\.(m|mm)$})
+  watch(%r{YourAppTests/(.+)\.(m|mm)$})
+end
+```
+
+By default, xctool-test check all files under current folder for tests. You can specify a
+specific folder, or array of folders, as test path.
+
+```ruby
+guard 'xctool-test', :test_paths => 'YourAppTests' do
+  watch(%r{YourApp/(.+)\.(m|mm)$})
+  watch(%r{YourAppTests/(.+)\.(m|mm)$})
+end
+```
+
+```ruby
+guard 'xctool-test', :test_paths => ['YourAppUITests', 'YourAppTests'] do
+  watch(%r{YourApp/(.+)\.(m|mm)$})
+  watch(%r{YourAppTests/(.+)\.(m|mm)$})
+end
+```
+
+You can pass any of the standard xctool CLI options using the ```:cli``` option:
+
+```ruby
+guard 'xctool-test', :cli => '-workspace A.workspace' do
+  watch(%r{YourApp/(.+)\.(m|mm)$})
+  watch(%r{YourAppTests/(.+)\.(m|mm)$})
+end
+```
+
+You might specify the full path to the xctool with ```:xctool```  option:
+
+```ruby
+guard 'xctool-test', :xctool => '/usr/local/bin/xctool' do
+  watch(%r{YourApp/(.+)\.(m|mm)$})
+  watch(%r{YourAppTests/(.+)\.(m|mm)$})
+end
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/guard-xctool-test.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'guard/xctool-test/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "guard-xctool-test"
+  spec.version       = Guard::XctoolTestVersion::VERSION
+  spec.authors       = ["Francis Chong"]
+  spec.email         = ["francis@ignition.hk"]
+  spec.description   = %q{Xctool test guard allows you to automically & intelligently aunch specs when files are modified. This gem use xctool to build and run tests, and xcodeproj gem to parse project file.}
+  spec.summary       = %q{Xctool test guard allows you to automically & intelligently aunch specs when files are modified.}
+  spec.homepage      = "https://github.com/siuying/guard-xctool-test"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.add_dependency "guard"
+  spec.add_dependency "xcodeproj"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/guard/xctool-test.rb

@@ -0,0 +1,77 @@
+require_relative './xctool_helper'
+require 'guard/guard'
+require 'guard'
+module Guard
+  class XctoolTest < ::Guard::Guard
+    include XctoolHelper
+
+    attr_reader :xctool, :test_paths, :test_target, :cli
+
+    # Initializes a Guard plugin.
+    # Don't do any work here, especially as Guard plugins get initialized even if they are not in an active group!
+    #
+    # @param [Array<Guard::Watcher>] watchers the Guard plugin file watchers
+    # @param [Hash] options the custom Guard plugin options
+    # @option options [Symbol] group the group this Guard plugin belongs to
+    # @option options [Boolean] any_return allow any object to be returned from a watcher
+    #
+    def initialize(watchers = [], options = {})
+      super
+
+      @cli = options[:cli] || ""
+      @test_paths = options[:test_paths]    || "."
+      @test_target = options[:test_target]  || find_test_target
+      @xctool = options[:xctool_command]    || "xctool"
+    end
+
+    # Called once when Guard starts. Please override initialize method to init stuff.
+    #
+    # @raise [:task_has_failed] when start has failed
+    # @return [Object] the task result
+    #
+    def start
+      # required user having xctool to start
+      unless system("which #{xctool}")
+        UI.info "xctool not found, please specify :xctool_command option"
+        throw :task_has_failed
+      end
+
+      unless test_target
+        UI.info "Cannot find test target, please specify :test_target option"
+        throw :task_has_failed
+      end
+    end
+
+    # Called when just `enter` is pressed
+    # This method should be principally used for long action like running all specs/tests/...
+    #
+    # @raise [:task_has_failed] when run_all has failed
+    # @return [Object] the task result
+    #
+    def run_all
+      UI.info "Running all tests..."
+      xctool_command("test")
+    end
+
+    def run_on_changes(paths)
+      test_files = test_classes_with_paths(paths, test_paths)
+
+      if test_files.size > 0
+        filenames = test_files.join(",")
+
+        UI.info "Running tests on classes: #{filenames}"
+        xctool_command("test -only #{test_target}:#{filenames}")
+      else
+        run_all
+      end
+    end
+
+    def xctool_command(command)
+      commands = []
+      commands << xctool
+      commands << cli if cli && cli.strip != ""
+      commands << command
+      system(commands.join(" "))
+    end
+  end
+end

data/lib/guard/xctool-test/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module XctoolTestVersion
+    VERSION = "0.1.0"
+  end
+end

data/lib/guard/xctool_helper.rb

@@ -0,0 +1,63 @@
+require 'xcodeproj'
+
+module Guard
+  module XctoolHelper
+    TEST_FILE_REGEXP = /(Test|Spec)\.(m|mm)$/
+
+    # Find test class from input paths.
+    # 
+    # - if the path is end with Test.m/Test.mm/Spec.m/Spec.mm, then it is a test class, return the class name of it
+    #
+    # @param [Array<String>] paths
+    # @param [Array<String>] test_path
+    #
+    def test_classes_with_paths(paths, test_path=[])
+      test_classes = paths.select{|path| path =~ TEST_FILE_REGEXP }   # get only Test/Spec
+        .collect {|path| classname_with_file(path) }
+
+      non_test_classes = paths.select{|path| path !=~ TEST_FILE_REGEXP }
+        .collect {|path| test_file(path, test_path) }
+        .compact
+        .collect {|path| classname_with_file(path) }
+
+      test_classes = non_test_classes + test_classes
+
+      test_classes.uniq
+    end
+
+    # Give a file and a test path, find the test for the given file in the test path.
+    # return nil if the test do not exists.
+    #
+    def test_file(file, test_paths=[])
+      test_paths = [] unless test_paths
+      test_paths = [test_paths] unless test_paths.is_a?(Array)
+      class_name = classname_with_file(file)
+
+      # for each test path, check if we can find corresponding test file
+      test_paths.each do |path|
+        files = Dir.glob("#{path}/**/#{class_name}*.*").select {|file| file =~ /#{class_name}(Test|Spec)\.(m|mm)$/ }
+        first_file = files.first
+        return first_file if first_file
+      end
+      return nil
+    end
+
+    # Find first project and first Test target from current folder
+    def find_test_target
+      project_name = Dir["*.xcodeproj"].first
+      if project_name
+        project = Xcodeproj::Project.new(project_name)
+
+        # find first targets with name ends with Spec or Target
+        return project.targets.collect(&:name).find {|f| f =~ /(Spec|Test)s?$/}
+      end
+      nil
+    end
+
+    protected
+    # Given a path of m or mm file, and return the class name
+    def classname_with_file(path)
+      path.split("/").last.gsub(/(\.(.+))$/, "")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH << "./lib"
+require 'guard/xctool-test'

data/spec/xctool-test_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe "Guard::XctoolTest" do
+  let(:options) {
+    {
+      :test_target => 'MyTests'
+    }
+  }
+  subject {
+    watcher = stub(:watcher).as_null_object
+    Guard::XctoolTest.new([watcher], options)
+  }
+
+  describe "new" do
+    it "should set default option" do
+      subject.test_target.should == "MyTests"
+      subject.cli.should == ""
+    end
+  end
+
+  describe "run_all" do
+    it "should run all test" do
+      subject.should_receive(:xctool_command).with("test")
+      subject.run_all
+    end
+  end
+
+  describe "run_on_changes" do
+    it "should run test of the change files" do
+      subject.stub(:test_classes_with_paths).and_return(["MyFirstFileSpec", "MySecondSpec"])
+      subject.should_receive(:xctool_command).with("test -only MyTests:MyFirstFileSpec,MySecondSpec")
+      subject.run_on_changes(["A/B/C/MyFirstFile.m", "B/D/F/MySecondSpec.m"])
+    end
+  end
+end

data/spec/xctool_helper_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe "Guard::XctoolHelper" do
+  subject {
+    object = Object.new
+    object.send :extend, Guard::XctoolHelper
+  }
+  describe "::test_classes_with_paths" do
+    it "should return list of file name that ends with Spec or Test" do
+      files  = ["ProjectTests/A/B/C/File1Test.m", "ProjectTests/A/B/C/File2Spec.m", "Project/A/B/C/File3.h", "Project/A/B/C/File2.m"]
+      test_files = subject.test_classes_with_paths(files, "ProjectTests")
+      test_files.should be_include("File1Test")
+      test_files.should be_include("File2Spec")
+      test_files.should_not be_include("File2")
+      test_files.should_not be_include("File3")
+    end
+
+    it "should return test file of non-test classes" do
+      # mock glob op, pretent we have File3Spec on disk
+      Dir.stub(:glob).and_return(["ProjectTests/A/File3Spec.m"])
+
+      files  = ["ProjectTests/A/B/C/File1Test.m", "ProjectTests/A/B/C/File2Spec.m", "Project/A/B/C/File3.h", "Project/A/B/C/File2.m"]
+      test_files = subject.test_classes_with_paths(files, "ProjectTests")
+      test_files.should be_include("File1Test")
+      test_files.should be_include("File2Spec")
+      test_files.should be_include("File3Spec")
+      test_files.should_not be_include("File2")
+      test_files.should_not be_include("File3")
+    end
+  end
+
+  describe "::test_file" do 
+    it "should use glob to find the target file" do
+      Dir.should_receive(:glob).with("ProjectTests/**/MyFile*.*").and_return(["ProjectTests/A/MyFileSpec.m"])
+      test_file = subject.test_file("Project/A/MyFile.m", "ProjectTests")
+      test_file.should == "ProjectTests/A/MyFileSpec.m"
+    end
+
+    it "should find correct test file if glob return two files having same prefix" do
+      Dir.stub(:glob).and_return(["ProjectTests/A/MyFile2Spec.m", "ProjectTests/A/MyFileSpec.m"])
+      test_file = subject.test_file("Project2/A/MyFile.m", ["ProjectTests"])
+      test_file.should == "ProjectTests/A/MyFileSpec.m"
+    end
+
+    it "should accept array of paths" do
+      Dir.stub(:glob).and_return([], ["ProjectTests2/A/MyFileSpec.m"])
+      test_file = subject.test_file("Project2/A/MyFile.m", ["ProjectTests", "ProjectTests2"])
+      test_file.should == "ProjectTests2/A/MyFileSpec.m"
+    end
+
+    it "should return nil if one does not exists" do
+      Dir.stub(:glob).and_return([])
+      test_file = subject.test_file("Project/A/MyFile.m", "ProjectTests")
+      test_file.should be_nil
+    end
+  end
+
+  describe "::find_test_target" do
+    it "should use xcodeproj to find test target" do
+      Dir.stub(:'[]').and_return(["MyProject.xcodeproj"])
+      stub_target = stub(:target)
+      stub_target.stub(:name).and_return("MyProjectSpec")
+      stub_project = stub(:project)
+      stub_project.stub(:targets).and_return([stub_target])
+      Xcodeproj::Project.stub(:new).and_return(stub_project)
+
+      target = subject.find_test_target
+      target.should == "MyProjectSpec"
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: guard-xctool-test
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Francis Chong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: xcodeproj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Xctool test guard allows you to automically & intelligently aunch specs
+  when files are modified. This gem use xctool to build and run tests, and xcodeproj
+  gem to parse project file.
+email:
+- francis@ignition.hk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- guard-xctool-test.gemspec
+- lib/guard/xctool-test.rb
+- lib/guard/xctool-test/version.rb
+- lib/guard/xctool_helper.rb
+- spec/spec_helper.rb
+- spec/xctool-test_spec.rb
+- spec/xctool_helper_spec.rb
+homepage: https://github.com/siuying/guard-xctool-test
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Xctool test guard allows you to automically & intelligently aunch specs when
+  files are modified.
+test_files:
+- spec/spec_helper.rb
+- spec/xctool-test_spec.rb
+- spec/xctool_helper_spec.rb