Swoop : Swift and Objective-C comparison reporter

Track your swift code in your Xcode codebase through time. It can go back in time from your git repository and make a comparison report.

Add this line to your application's Gemfile:

gem 'swoop_report'

And then execute:

$ bundle

Or install it yourself as:

$ gem install swoop_report

To print the comparison report inside your console, just run swoop command with two required options:

$ swoop --path <path> --dir <dir>

• path is your path to your .xcodeproj and
• dir is your directory inside your Xcode project

As default options, this will list the last 8 tags, collect information from each tag, collate it into a report, and then present it as a table inside your console.

Say you have your awesome project inside YourAwesomeProject folder called AwesomeProject.xcodeproj. You open the project, and you have organised your files in Xcode project navigator to look something like this :

+ AwesomeProject
+- Classes
+--- Model
+--- View
+--- Controller
+--- Network
+- Assets
+- Frameworks
+- Products

Say, you want to compare all of the classes then run :

$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes'

Or, if you want to compare only files inside Controller, run :

$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes/Controller'

Specify the path to the .xcodeproj file. (This is required)

Specify which directory where the files that you want to compare based on Xcode project navigator. (This is required)

Specify a number of how many tags you want to include for comparison. For example, if you want to include the last 10 tags you would run:

$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes' --tags 10

Specify a regular expression that will be applied to tag names. This only applies if tags is used. For example, if you only want to include tags that look like v1.0.0, then you would run:

$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes' --tags 10 --filter_tag 'v\d+.\d+.\d+'

Specify a number of how many weeks you want to include for comparison. For example, if you want to include the last 30 weeks, run :

$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes' --weeks 30

Note: If both --tags and --weeks are specified, weeks will take priority.

Specify how do you render the reports. Available renderers are table, csv and chart

This renders a table in your console. Table is used if --render is not specified.

$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes'
# or
$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes' --render table

will output this table in your console

This will export your report as a csv file in root.

$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes' --render csv

This will export your report as a chart in a webpage. It creates an html folder in root with the page index.html inside of it.

$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes' --render chart

will output a chart in ./html/index.html

Feel free to put any ideas, questions or bug reports by creating issues. If you think you have a great idea for any improvement we'd be really happy to receive any pull request (refer to Development section to setup in your local machine).

Clone this repository and get into the directory.

# Install dependencies
$ bin/setup
# Run the tests
$ rake spec
# (Optional) run interactive console for experimentation
$ bin/console

The gem is available as open source under the terms of the MIT License.