swoop_report 0.2.1 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/README.md +16 -10
- data/lib/swoop/project.rb +1 -0
- data/lib/swoop/version.rb +1 -1
- data/swoop.gemspec +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1965a15f5a1155a260cfd4743d46da63ad415ae7
|
4
|
+
data.tar.gz: 20fca146129aa5856d657e1b3fd9ec402027b17e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 31d3697117e100ea08eab62d3d0fea9f93d26a002666773105641221cb9d2c0978fb49fa188f7e019948fda7c3e65e6b60f730a7e382e3cc5de214a5e7e1f969
|
7
|
+
data.tar.gz: 2744fe86cf6e87d6d2cbab3cf278e09f1d2f5e200281622308b08da26c4b6ca52a7807b2c30d56a6327fdfaec2efd4b2acab96393566284b68d707ac638fab36
|
data/CHANGELOG.md
CHANGED
data/README.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
# Swoop : Swift
|
1
|
+
# Swoop : Swift and Objective-C comparison reporter
|
2
2
|
|
3
3
|
[][rubygems]
|
4
4
|
[][travis]
|
@@ -58,13 +58,13 @@ Say you have your awesome project inside `YourAwesomeProject` folder called `Awe
|
|
58
58
|
Say, you want to compare all of the classes then run :
|
59
59
|
|
60
60
|
```bash
|
61
|
-
$ swoop --path
|
61
|
+
$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes'
|
62
62
|
```
|
63
63
|
|
64
64
|
Or, if you want to compare only files inside `Controller`, run :
|
65
65
|
|
66
66
|
```bash
|
67
|
-
$ swoop --path
|
67
|
+
$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes/Controller'
|
68
68
|
```
|
69
69
|
|
70
70
|
### Options
|
@@ -82,21 +82,27 @@ Specify which directory where the files that you want to compare based on Xcode
|
|
82
82
|
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:
|
83
83
|
|
84
84
|
```bash
|
85
|
-
$ swoop --path
|
85
|
+
$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes' --tags 10
|
86
86
|
```
|
87
87
|
|
88
88
|
#### Filter Tag (`--filter_tag`)
|
89
89
|
|
90
|
-
Specify a regular expression that will be applied to tag names. This only applies if tags is used. For example, if
|
90
|
+
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:
|
91
|
+
|
92
|
+
```bash
|
93
|
+
$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes' --tags 10 --filter_tag 'v\d+.\d+.\d+'
|
94
|
+
```
|
91
95
|
|
92
96
|
#### Weeks (`--weeks`)
|
93
97
|
|
94
98
|
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 :
|
95
99
|
|
96
100
|
```bash
|
97
|
-
$ swoop --path
|
101
|
+
$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes' --weeks 30
|
98
102
|
```
|
99
103
|
|
104
|
+
Note: If both `--tags` and `--weeks` are specified, weeks will take priority.
|
105
|
+
|
100
106
|
#### Renderer (`--render`)
|
101
107
|
|
102
108
|
Specify how do you render the reports. Available renderers are `table`, `csv` and `chart`
|
@@ -106,9 +112,9 @@ Specify how do you render the reports. Available renderers are `table`, `csv` an
|
|
106
112
|
This renders a table in your console. Table is used if `--render` is not specified.
|
107
113
|
|
108
114
|
```bash
|
109
|
-
$ swoop --path
|
115
|
+
$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes'
|
110
116
|
# or
|
111
|
-
$ swoop --path
|
117
|
+
$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes' --render table
|
112
118
|
```
|
113
119
|
|
114
120
|
will output this table in your console
|
@@ -121,7 +127,7 @@ will output this table in your console
|
|
121
127
|
This will export your report as a csv file in root.
|
122
128
|
|
123
129
|
```bash
|
124
|
-
$ swoop --path
|
130
|
+
$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes' --render csv
|
125
131
|
```
|
126
132
|
|
127
133
|
##### Chart
|
@@ -129,7 +135,7 @@ $ swoop --path "~/YourAwesomeProject/AwesomeProject.xcodeproj" --dir 'Classes' -
|
|
129
135
|
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.
|
130
136
|
|
131
137
|
```bash
|
132
|
-
$ swoop --path
|
138
|
+
$ swoop --path '~/YourAwesomeProject/AwesomeProject.xcodeproj' --dir 'Classes' --render chart
|
133
139
|
```
|
134
140
|
|
135
141
|
will output a chart in `./html/index.html`
|
data/lib/swoop/project.rb
CHANGED
data/lib/swoop/version.rb
CHANGED
data/swoop.gemspec
CHANGED
@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
|
|
9
9
|
spec.authors = ["Ikhsan Assaat"]
|
10
10
|
spec.email = ["ikhsan.assaat@songkick.com"]
|
11
11
|
|
12
|
-
spec.summary = "
|
12
|
+
spec.summary = "Swift and Objective-C comparison reporter"
|
13
13
|
spec.license = "MIT"
|
14
14
|
|
15
15
|
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: swoop_report
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.2.
|
4
|
+
version: 0.2.2
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Ikhsan Assaat
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2016-08-
|
11
|
+
date: 2016-08-31 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: bundler
|
@@ -194,5 +194,5 @@ rubyforge_project:
|
|
194
194
|
rubygems_version: 2.4.8
|
195
195
|
signing_key:
|
196
196
|
specification_version: 4
|
197
|
-
summary:
|
197
|
+
summary: Swift and Objective-C comparison reporter
|
198
198
|
test_files: []
|