octo-technology · akshaysyaduvanshi · Jul 19, 2012 · Jul 19, 2012 · Jul 19, 2012 · Jul 20, 2012
diff --git a/.travis.yml b/.travis.yml
@@ -1,6 +1,3 @@
 language: java
 jdk:
   - oraclejdk8
-  - oraclejdk7
-  - openjdk7
-  - openjdk6
diff --git a/README.md b/README.md
@@ -1,88 +1,162 @@
-SonarQube Plugin for Objective C
-================================
+# Important : this plugin is not maintained anymore. Please switch to our (Swift plugin)[https://github.com/Backelite/sonar-swift] which now supports Swift and Objective-C
+
 
-This repository hosts the Objective-C plugin for [SonarQube](http://www.sonarqube.org/). This plugin enables to analyze and track the quality of iOS (iPhone, iPad) and MacOS developments.
 
-This plugin is not supported by SonarSource. SonarSource offers a [commercial SonarSource Objective-C plugin](http://www.sonarsource.com/products/plugins/languages/objective-c/) as well. Both plugins do not offer the same functionalities/support.
+<p align="left">
+  <img src="https://www.backelite.com/wp-content/uploads/2016/09/logo-backelite-square.png" width="100"/>
+</p>
 
-The development of this plugin has always been done thanks to the community. If you wish to contribute, check the [Contributing](https://github.com/octo-technology/sonar-objective-c/wiki/Contributing) wiki page.
+| Branch   |      Status                                                                                                                                |
+|----------|:------------------------------------------------------------------------------------------------------------------------------------------:|
+| master | [![Build Status](https://travis-ci.org/Backelite/sonar-objective-c.svg?branch=master)](https://travis-ci.org/Backelite/sonar-objective-c)  |
+| develop| [![Build Status](https://travis-ci.org/Backelite/sonar-objective-c.svg?branch=develop)](https://travis-ci.org/Backelite/sonar-objective-c) |
+
+SonarQube Plugin for Objective-C
+================================
 
-Find below an example of an iOS SonarQube dashboard:
+This repository is a fork of the open source [SonarQube Plugin for Objective-C](https://github.com/octo-technology/sonar-objective-c). It provides modifications and extra features needed for our internal use.
+
+A SonarQube 5.0 dashboard of the iOS open source project [GreatReader](https://github.com/semweb/GreatReader):
 <p align="center">
-  <img src="sample/screen%20shot%20SonarQube%20dashboard.png" alt="Example iOS SonarQube dashboard" width="80%"/>
+  <img src="sample/screen%20shot%20SonarQube%20dashboard.png" alt="Example iOS SonarQube dashboard" width="100%"/>
 </p>
 
-###Features
+### Features
 
-- [ ] Complexity
-- [ ] Design
-- [x] Documentation
-- [x] Duplications
-- [x] Issues
-- [x] Size
-- [x] Tests
+| Feature 		| Supported	| Details	|
+|---------------|----------|:-----------:|
+| Complexity	|YES			| Uses [Lizard](https://github.com/terryyin/lizard)			|
+| Design		|NO			|			|
+| Documentation	|YES		|			|
+| Duplications	|YES		|			|
+| Issues		|YES		| Uses [OCLint](http://docs.oclint.org/en/dev/intro/installation.html): 71 rules, and [Faux Pas](http://fauxpasapp.com/): 102 rules|
+| Size			|YES		|			|
+| Tests			|YES		| Uses [xctool](https://github.com/facebook/xctool), will probably switch to xcodebuild + [xcpretty](https://github.com/supermarin/xcpretty) soon			|
+| Code coverage	|YES		| With [gcovr](http://gcovr.com) for project before Xcode 7, otherwise [slather](https://github.com/venmo/slather)|
 
-For more details, see the list of [SonarQube metrics](https://github.com/octo-technology/sonar-objective-c/wiki/Features) implemented or pending.
 
-###Compatibility
+### Compatibility
 
-- Use 0.3.x releases for SonarQube 3.x
-- Use 0.4.x releases for SonarQube 4.x
+Releases available from this repository are compliant with SonarQube 4.3.x and above.
 
-###Download
+In order not to break compatibility with the original plugin, plugin releases are numbered with 4 digits.
 
-The latest version is the 0.4.x is not yet released and is available as a snapshot [here](https://rfelden.ci.cloudbees.com/job/sonar-objective-c/lastSuccessfulBuild/artifact/target/). 
-The latest SonarQube 3.x release is the 0.3.1, and it's available [here](http://bit.ly/1fSwd5I).
-
-You can also download the latest build of the plugin from [Cloudbees](https://rfelden.ci.cloudbees.com/job/sonar-objective-c/lastSuccessfulBuild/artifact/target/).
-
-In the worst case, the Maven repository with all snapshots and releases is available here: http://repository-rfelden.forge.cloudbees.com/
+### Faux Pas support
+
+[Faux Pas](http://fauxpasapp.com/) is a wonderful tool to analyse iOS or Mac applications source code, however it is not free. A 30 trial version is available [here](http://fauxpasapp.com/try/).
+
+The plugin runs fine even if Faux Pas is not installed (Faux Pas analysis will be skipped).
+
+### Download
+
+Binary packages are available in the release section.
+
+
+### Release history
+
+### 0.6.3
+- SonarQube 7.0 support
+
+### 0.6.2
+- SonarQube 6.7 support
+- FauxPas 1.7.2 support (4 new rules added)
+- OCLint 0.13 support (1 new rule added)
+- Update run-sonar.sh : xcodebuild optimization (see https://github.com/Backelite/sonar-objective-c/pull/26 thanks to [davidy4ng](https://github.com/davidy4ng)).
+- Fix for properties with space (see https://github.com/Backelite/sonar-objective-c/pull/29 thanks to [Branlute](https://github.com/Branlute))
+
+
+### 0.6.1
+- Replaced oclint-xcodebuild by xcpretty (see https://github.com/Backelite/sonar-objective-c/pull/25 thanks to [davidy4ng](https://github.com/davidy4ng)).
+- Added -nounittests and -usesonarscanner parameters to run-sonar.sh script (see https://github.com/Backelite/sonar-objective-c/pull/23 thanks to [davidy4ng](https://github.com/davidy4ng)).
+- Sonar 6 fix for Faux Pas (see https://github.com/Backelite/sonar-objective-c/pull/20 thanks to [macostea](https://github.com/macostea)).
+
+### 0.6.0
+- SonarQube 6 support. Important : will work with SonarQube 5.x and above only. Will not work anymore with SonarQube 4.5.x anymore.
 
-###Prerequisites
+### 0.5.2
+- OCLint 0.11.0 support (see https://github.com/Backelite/sonar-objective-c/pull/13)
+- Removed required gcovr check in run-sonar.sh (see https://github.com/Backelite/sonar-objective-c/pull/10)
+- Fixed issued in run-sonar.sh (see https://github.com/Backelite/sonar-objective-c/pull/2)
+- Better test file detection pattern (see https://github.com/Backelite/sonar-objective-c/pull/3/files)
 
-- a Mac with Xcode...
+#### 0.5.1
+- Complexity with Lizard !
+
+#### 0.5.0 (detached from octo project)
+- Detached from octo project (to hard to maintain compatibility)
+- Removed deprecated API usages for Sonarube 5.3 support
+
+#### 0.4.0.3 (based on 0.4.0)
+- Xcode 7 coverage support (profdata)
+
+#### 0.4.0.2 (based on 0.4.0)
+- Faux Pas support for release 1.5 and 1.6
+- Support for multiple projects in a same workspace
+
+#### 0.4.0.1 (based on 0.4.0)
+- Faux Pas support
+- Moved OCLint long line threshold to 250
+- Add the `plain` reporter at build step to get more information in case of build failure
+- Capitalized OCLint rule names
+
+
+### Prerequisites
+
+- a Mac with Xcode
 - [SonarQube](http://docs.codehaus.org/display/SONAR/Setup+and+Upgrade) and [SonarQube Runner](http://docs.codehaus.org/display/SONAR/Installing+and+Configuring+SonarQube+Runner) installed ([HomeBrew](http://brew.sh) installed and ```brew install sonar-runner```)
+- [xcpretty](https://github.com/supermarin/xcpretty) (see instructions below)
 - [xctool](https://github.com/facebook/xctool) ([HomeBrew](http://brew.sh) installed and ```brew install xctool```). If you are using Xcode 6, make sure to update xctool (```brew upgrade xctool```) to a version > 0.2.2.
-- [OCLint](http://docs.oclint.org/en/dev/intro/installation.html) installed. Version 0.8.1 recommended  ([HomeBrew](http://brew.sh) installed and ```brew install https://gist.githubusercontent.com/TonyAnhTran/e1522b93853c5a456b74/raw/157549c7a77261e906fb88bc5606afd8bd727a73/oclint.rb```). 
-- [gcovr](http://gcovr.com) installed
+- [OCLint](http://oclint-docs.readthedocs.io/en/stable/) installed. Version 0.11.0 recommended (0.13.0 since Xcode 9). 
+- [gcovr](http://gcovr.com) installed for legacy (pre Xcode 7 coverage)
+- [slather](https://github.com/SlatherOrg/slather) (```gem install slather```). Version 2.1.0 or above (2.4.4 since Xcode 9).
+- [lizard](https://github.com/terryyin/lizard) ([PIP](https://pip.pypa.io/en/stable/installing/) installed and ```sudo pip install lizard```)
+- [Faux Pas](http://fauxpasapp.com/) command line tools installed (optional)
+
+### Installation of xcpretty with JUnit reports fix
+
+At the time, xcpretty needs to be fixed to work with SonarQube. 
 
-###Installation (once for all your Objective-C projects)
-- Install [the plugin](http://bit.ly/1fSwd5I) through the Update Center (of SonarQube) or download it into the $SONARQUBE_HOME/extensions/plugins directory
-- Copy [run-sonar.sh](https://rawgithub.com/octo-technology/sonar-objective-c/master/src/main/shell/run-sonar.sh) somewhere in your PATH
+To install the fixed version, follow those steps :
+
+	git clone https://github.com/Backelite/xcpretty.git
+	cd xcpretty
+	git checkout fix/duration_of_failed_tests_workaround
+	gem build xcpretty.gemspec
+	sudo gem install --both xcpretty-0.2.2.gem
+
+### Code coverage data format
+
+Since Xcode 7, Apple changed its coverage data format to a new format called 'profdata'.
+By default this format will be used by the plugin, except if you explicitly force it to legacy mode (for Xcode 6 and below) in your *sonar-project.properties* with this line:
+
+    sonar.objectivec.coverageType=legacy
+
+
+### Installation (once for all your Objective-C projects)
+- Download the plugin binary into the $SONARQUBE_HOME/extensions/plugins directory
+- Copy [run-sonar.sh](https://rawgithub.com/Backelite/sonar-objective-c/master/src/main/shell/run-sonar.sh) somewhere in your PATH
 - Restart the SonarQube server.
 
-###Configuration (once per project)
-- Copy [sonar-project.properties](https://rawgithub.com/octo-technology/sonar-objective-c/master/sample/sonar-project.properties) in your Xcode project root folder (along your .xcodeproj file)
-- Edit the *sonar-project.properties* file to match your Xcode iOS/MacOS project
+### Configuration (once per project)
+- Copy [sonar-project.properties](https://rawgithub.com/Backelite/sonar-objective-c/master/sample/sonar-project.properties) in your Xcode project root folder (along your .xcodeproj file)
+- Edit the ```sonar-project.properties``` file to match your Xcode iOS/MacOS project
 
 **The good news is that you don't have to modify your Xcode project to enable SonarQube!**. Ok, there might be one needed modification if you don't have a specific scheme for your test target, but that's all.
 
-###Analysis
+### Analysis
 - Run the script ```run-sonar.sh``` in your Xcode project root folder
 - Enjoy or file an issue!
 
-###Update (once per plugin update)
-- Install the [latest plugin](http://bit.ly/1fSwd5I) version
-- Copy [run-sonar.sh](https://rawgithub.com/octo-technology/sonar-objective-c/master/src/main/shell/run-sonar.sh) somewhere in your PATH
+### Update (once per plugin update)
+- Install the lastest plugin version
+- Copy ```run-sonar.sh``` somewhere in your PATH
 
 If you still have *run-sonar.sh* file in each of your project (not recommended), you will need to update all those files.
 
-###Credits
-* **Cyril Picat**
-* **Denis Bregeon**
-* **Gilles Grousset**
-* **François Helg**
-* **Romain Felden**
-* **Mete Balci**
-
-###History
-- v0.4.0 (SOON): support for SonarQube 4.x
-- v0.3.1 (2013/10): fix release
-- v0.3 (2013/10): added support for OCUnit tests and test coverage
-- v0.2 (2013/10): added OCLint checks as SonarQube violations
-- v0.0.1 (2012/09): v0 with basic metrics such as nb lines of code, nb lines of comment, nb of files, duplications
-
-###License
-
-SonarQube Plugin for Objective C is released under the GNU LGPL 3 license:  
-http://www.gnu.org/licenses/lgpl.txt
+### Contributing
+
+Feel free to contribute to this plugin by issuing pull requests to this repository or to the [original one](https://github.com/octo-technology/sonar-objective-c).
+
+### License
+
+SonarQube Plugin for Objective-C is released under the [GNU LGPL 3 license](http://www.gnu.org/licenses/lgpl.txt).
diff --git a/build-and-deploy.sh b/build-and-deploy.sh
@@ -8,17 +8,13 @@ if [ "$?" != 0 ]; then
 	exit $?
 fi
 
-# Run shell tests
-#shelltest src/test/shell --execdir --diff
-#if [ "$?" != 0 ]; then
-#	echo "ERROR - Shell tests failed!" 1>&2
-#	exit $?
-#fi
-
 # Deploy new verion of plugin in Sonar dir
-cp target/*.jar $SONARQUBE_HOME/extensions/plugins
+rm -rf $SONARQUBE_HOME/extensions/plugins/*sonar-objective-c-*
+cp sonar-objective-c-plugin/target/*.jar $SONARQUBE_HOME/extensions/plugins
+rm $SONARQUBE_HOME/extensions/plugins/*sources.jar
 
 # Stop/start Sonar
+unset GEM_PATH GEM_HOME
 $SONARQUBE_HOME/bin/macosx-universal-64/sonar.sh stop
 $SONARQUBE_HOME/bin/macosx-universal-64/sonar.sh start