README.md 11.8 KB
Newer Older
P
Phodal HUANG 已提交
1
# Coca
P
Phodal HUANG 已提交
2

P
Phodal Huang 已提交
3
[![Build Status](https://travis-ci.org/phodal/coca.svg?branch=master)](https://travis-ci.org/phodal/coca)
P
Phodal Huang 已提交
4 5
[![Maintainability](https://api.codeclimate.com/v1/badges/d5a5e060522403b1f79b/maintainability)](https://codeclimate.com/github/phodal/coca/maintainability)
[![codecov](https://codecov.io/gh/phodal/coca/branch/master/graph/badge.svg)](https://codecov.io/gh/phodal/coca)
P
Phodal Huang 已提交
6

P
Phodal Huang 已提交
7 8
> Coca 是一个用于遗留系统重构的瑞士军刀。它可以分析代码中的 badsmell,行数统计,分析调用与依赖,进行 Git 分析,以及自动化重构等。

P
Phodal Huang 已提交
9 10 11 12
## Usage

install 

P
Phodal Huang 已提交
13
```bash
P
Phodal Huang 已提交
14
go get -u github.com/phodal/coca
P
Phodal Huang 已提交
15 16
```

P
Phodal Huang 已提交
17 18
help:

P
Phodal Huang 已提交
19
```bash
P
Phodal Huang 已提交
20 21 22
Usage:
  coca [command]

P
Phodal Huang 已提交
23

P
Phodal Huang 已提交
24 25 26
Available Commands:
  analysis    analysis package
  api         scan api
P
Phodal Huang 已提交
27
  bs          bad smell analysis
P
Phodal Huang 已提交
28
  call        call graph api
P
Phodal Huang 已提交
29
  cloc        cloc [FILE or DIRECTORY]
P
Phodal Huang 已提交
30
  concept     concept api
P
Phodal Huang 已提交
31
  count       count code
P
Phodal Huang 已提交
32
  evaluate    evaluate refactor effort
P
Phodal Huang 已提交
33
  git         git analysis
P
Phodal Huang 已提交
34
  help        Help about any command
P
Phodal Huang 已提交
35
  rcall       reverse call
P
Phodal Huang 已提交
36
  refactor    auto refactor code
P
Phodal Huang 已提交
37

P
Phodal Huang 已提交
38 39
```

P
Phodal Huang 已提交
40
### Analysis
P
Phodal Huang 已提交
41 42

```
P
Phodal Huang 已提交
43
coca analysis
P
Phodal Huang 已提交
44 45
```

P
Phodal Huang 已提交
46 47
### Find Bad Smells

P
Phodal Huang 已提交
48
```bash
P
Phodal Huang 已提交
49
coca bs -s type
P
Phodal Huang 已提交
50 51
```

P
Phodal Huang 已提交
52 53
Examples Result:

P
Phodal Huang 已提交
54
```json
P
Phodal Huang 已提交
55
{
P
Phodal Huang 已提交
56 57 58 59 60 61 62 63 64 65 66 67 68 69
   "dataClass": [
      {
         "File": "examples/api/BookController.java",
         "BS": "dataClass"
      }
      ...
   ],
   "lazyElement": [
      {
         "File": "examples/api/model/BookRepresentaion.java",
         "BS": "lazyElement"
      }
      ...
   ]
P
Phodal Huang 已提交
70 71 72
}
```

P
Phodal Huang 已提交
73 74 75
### Code Line Count

```
P
Phodal Huang 已提交
76
coca cloc
P
Phodal Huang 已提交
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
```

Results:

```
───────────────────────────────────────────────────────────────────────────────
Language                 Files     Lines   Blanks  Comments     Code Complexity
───────────────────────────────────────────────────────────────────────────────
Go                          58     31763     7132       890    23741       2847
Java                        44       971      208        21      742         62
Markdown                     8       238       75         0      163          0
Gherkin Specificati…         2        32        2        16       14          0
Document Type Defin…         1       293       36         0      257          0
License                      1       201       32         0      169          0
SQL                          1         2        0         0        2          0
SVG                          1       199        0        34      165          0
Shell                        1         3        1         1        1          0
XML                          1        13        0         0       13          0
gitignore                    1        61        8         4       49          0
───────────────────────────────────────────────────────────────────────────────
Total                      119     33776     7494       966    25316       2909
───────────────────────────────────────────────────────────────────────────────
Estimated Cost to Develop $803,822
Estimated Schedule Effort 14.120551 months
Estimated People Required 6.743156
───────────────────────────────────────────────────────────────────────────────s
P
Phodal Huang 已提交
103 104
```

P
Phodal Huang 已提交
105 106 107 108 109 110
Results to json

```
coca cloc --by-file --format json
```

P
Phodal Huang 已提交
111 112 113
### Build Deps Tree

```
P
Phodal Huang 已提交
114
coca call -c com.phodal.pholedge.book.BookController.createBook -r com.phodal.pholedge.
P
Phodal Huang 已提交
115 116
```

P
Phodal Huang 已提交
117 118
Examples Results:

P
Phodal Huang 已提交
119 120 121 122 123
![Call Demo](docs/sample/call_demo.svg)

### Identify Spring API

```
P
Phodal Huang 已提交
124
coca api -f
P
Phodal Huang 已提交
125 126
```

P
Phodal Huang 已提交
127 128
![API Demo](docs/sample/api.svg)

P
Phodal Huang 已提交
129 130 131
With Count

```
P
Phodal Huang 已提交
132
coca api -r com.phodal.pholedge. -c 
P
Phodal Huang 已提交
133 134
``` 

P
Phodal Huang 已提交
135 136
or multi package:

P
Phodal Huang 已提交
137
`coca api  -r com.macro.mall.demo.controller.,com.zheng.cms.admin.,com.phodal.pholedge -c` 
P
Phodal Huang 已提交
138

P
Phodal Huang 已提交
139
```bash
P
Phodal Huang 已提交
140 141 142 143 144 145 146 147 148 149 150 151 152
+------+--------+------------------------------------------------+------------------------------------------------------------------------+
| SIZE | METHOD |                      URI                       |                                 CALLER                                 |
+------+--------+------------------------------------------------+------------------------------------------------------------------------+
|   36 | GET    | /aliyun/oss/policy                             | controller.OssController.policy                                        |
|   21 | POST   | /aliyun/osscallback                            | controller.OssController.callback                                      |
|   17 | GET    | /subject/list                                  | controller.CmsSubjectController.getList                                |
|   17 | GET    | /esProduct/search                              | search.controller.EsProductController.search                           |
|   17 | GET    | /order/list                                    | controller.OmsOrderController.list                                     |
|   17 | GET    | /productAttribute/list/{cid}                   | controller.PmsProductAttributeController.getList                       |
|   17 | GET    | /productCategory/list/{parentId}               | controller.PmsProductCategoryController.getList                        |
|   17 | GET    | /brand/list                                    | controller.PmsBrandController.getList                                  |
|   17 | GET    | /esProduct/search/simple                       | search.controller.EsProductController.search                           |
+------+--------+------------------------------------------------+------------------------------------------------------------------------+
P
Phodal Huang 已提交
153 154
```

P
Phodal Huang 已提交
155 156 157
### Git Analysis

```
P
Phodal Huang 已提交
158
coca git -t
P
Phodal Huang 已提交
159 160
```

P
Phodal Huang 已提交
161 162 163
Results: 

```bash
P
Phodal Huang 已提交
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
+---------------------------------------------------------------------------------------------------------------------+-----------+-------------+
|                                                     ENTITYNAME                                                      | REVSCOUNT | AUTHORCOUNT |
+---------------------------------------------------------------------------------------------------------------------+-----------+-------------+
| build.gradle                                                                                                        |      1326 |          36 |
| src/asciidoc/index.adoc                                                                                             |       239 |          20 |
| build-spring-framework/resources/changelog.txt                                                                      |       187 |          10 |
| spring-core/src/main/java/org/springframework/core/annotation/AnnotationUtils.java                                  |       170 |          10 |
| spring-beans/src/main/java/org/springframework/beans/factory/support/DefaultListableBeanFactory.java                |       159 |          15 |
| src/docs/asciidoc/web/webmvc.adoc                                                                                   |       121 |          24 |
| spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassParser.java                   |       118 |           9 |
| src/dist/changelog.txt                                                                                              |       118 |           9 |
| spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurationSupport.java       |       116 |          15 |
| spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractAutowireCapableBeanFactory.java        |       113 |          15 |
| spring-web/src/main/java/org/springframework/http/HttpHeaders.java                                                  |       111 |          18 |
| src/docs/asciidoc/web/webflux.adoc                                                                                  |       108 |          21 |
| spring-core/src/main/java/org/springframework/core/annotation/AnnotatedElementUtils.java                            |       107 |           9 |
| spring-test/spring-test.gradle                                                                                      |       105 |           7 |
| spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/RequestMappingHandlerAdapter.java |       105 |          13 |
| spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/StompBrokerRelayMessageHandler.java         |       101 |          12 |
| spring-web/src/main/java/org/springframework/web/client/RestTemplate.java                                           |        98 |          17 |
| spring-webmvc/src/main/java/org/springframework/web/servlet/resource/ResourceHttpRequestHandler.java                |        96 |          14 |
| org.springframework.core/src/main/java/org/springframework/core/convert/TypeDescriptor.java                         |        93 |           4 |
| spring-core/src/main/java/org/springframework/core/ResolvableType.java                                              |        92 |          10 |
+---------------------------------------------------------------------------------------------------------------------+-----------+-------------+
P
Phodal Huang 已提交
188 189
```

P
Phodal Huang 已提交
190 191 192
### Concept Analyser

```
P
Phodal Huang 已提交
193
coca concept
P
Phodal Huang 已提交
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
```

Results Examples:

```
product 874
time 541
member 405
like 404
example 371
order 328
primary 288
criterion 222
price 214
selective 212
promotion 198
list 196
category 184
icon 160
note 159
pic 147
point 143
brand 131
receiver 121
```

P
Phodal Huang 已提交
220 221 222
### Count Refs

```
P
Phodal Huang 已提交
223
coca count
P
Phodal Huang 已提交
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
```

Results:

```
4 study.huhao.demo.domain.contexts.blogcontext.blog.BlogRepository.findById
3 study.huhao.demo.adapters.inbound.rest.handlers.GlobalExceptionHandler.handleDomainException
3 study.huhao.demo.domain.contexts.blogcontext.blog.BlogRepository.save
3 study.huhao.demo.adapters.inbound.rest.resources.blog.BlogDto.of
2 study.huhao.demo.adapters.inbound.rest.resources.publishedblog.PublishedBlogDto.of
2 study.huhao.demo.adapters.outbound.persistence.blog.BlogPO.toDomainModel
2 study.huhao.demo.adapters.outbound.persistence.blog.BlogMapper.findById
2 study.huhao.demo.domain.contexts.blogcontext.blog.Blog.validateTitle
1 study.huhao.demo.application.usecases.QueryBlogUseCase.query
1 study.huhao.demo.domain.contexts.blogcontext.blog.BlogService.get
1 study.huhao.demo.domain.contexts.blogcontext.blog.Blog.saveDraft
1 study.huhao.demo.domain.core.common.Page.getConvertedContent
```

P
Phodal Huang 已提交
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
### Reverse Call Graph

```
coca rcall -c org.bytedeco.javacpp.tools.TokenIndexer.get
```

Results:

```
digraph G { 
edge [dir="back"];

"org.bytedeco.javacpp.tools.Parser.extern" -> "org.bytedeco.javacpp.tools.Parser.declarations";
"org.bytedeco.javacpp.tools.Parser.declarations" -> "org.bytedeco.javacpp.tools.Parser.extern";
...
}
```

![RCall Demo](docs/sample/rcall.svg)

P
Phodal Huang 已提交
263
### Auto Refactor
P
Phodal Huang 已提交
264 265 266 267 268 269 270

support: 

 - rename
 - move
 - remove unused import
 - remove unused class
P
Phodal Huang 已提交
271 272

```
P
Phodal Huang 已提交
273
coca refactor -R rename.coca -p src/main
P
Phodal Huang 已提交
274 275 276
coca refactor -m move.config -p .
```

P
Phodal HUANG 已提交
277 278
## Dev

P
Phodal Huang 已提交
279
Install Go
P
Phodal HUANG 已提交
280 281 282 283 284

```bash
brew install go
```

P
Phodal Huang 已提交
285
Env
P
Phodal HUANG 已提交
286 287 288 289 290 291 292

```bash
export GOROOT=/usr/local/opt/go/libexec
export GOPATH=$HOME/.go
export PATH=$PATH:$GOROOT/bin:$GOPATH/bin
```

P
Phodal Huang 已提交
293
clone
P
Phodal HUANG 已提交
294 295

```
P
Phodal Huang 已提交
296
go get https://github.com/phodal/coca
P
Phodal HUANG 已提交
297 298
```

P
Phodal Huang 已提交
299
Test Frameworks
P
Phodal HUANG 已提交
300 301 302 303

```
go get github.com/onsi/ginkgo
go get github.com/onsi/gomega
P
Phodal HUANG 已提交
304 305
```

P
Phodal Huang 已提交
306 307 308 309 310
License
---

[![Phodal's Idea](http://brand.phodal.com/shields/idea-small.svg)](http://ideas.phodal.com/)

P
Phodal Huang 已提交
311
@ 2019 A [Phodal Huang](https://www.phodal.com)'s [Idea](http://github.com/phodal/ideas).  This code is distributed under the MPL license. See `LICENSE` in this directory.