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

P
Phodal Huang 已提交
3 4 5 6 7 8 9 10
## Usage

install 

```
go get https://github.com/phodal/coca
```

P
Phodal Huang 已提交
11 12 13 14 15 16 17 18 19
help:

```
Usage:
  coca [command]

Available Commands:
  analysis    analysis package
  api         scan api
P
Phodal Huang 已提交
20
  bs          Bad Code Smell
P
Phodal Huang 已提交
21 22
  call        call graph api
  concept     concept api
P
Phodal Huang 已提交
23
  ga          git analysis
P
Phodal Huang 已提交
24 25
  help        Help about any command
  refactor    auto refactor code
P
Phodal Huang 已提交
26 27
  scc         scc [FILE or DIRECTORY]

P
Phodal Huang 已提交
28 29
```

P
Phodal Huang 已提交
30
### Analysis
P
Phodal Huang 已提交
31 32 33 34 35

```
coca analysis -p [PATH]
```

P
Phodal Huang 已提交
36 37 38 39 40 41
### Find Bad Smells

```
coca bs -p examples/api -s type
```

P
Phodal Huang 已提交
42 43 44 45
Examples Result:

```
{
P
Phodal Huang 已提交
46 47 48 49 50 51 52 53 54 55 56 57 58 59
   "dataClass": [
      {
         "File": "examples/api/BookController.java",
         "BS": "dataClass"
      }
      ...
   ],
   "lazyElement": [
      {
         "File": "examples/api/model/BookRepresentaion.java",
         "BS": "lazyElement"
      }
      ...
   ]
P
Phodal Huang 已提交
60 61 62
}
```

P
Phodal Huang 已提交
63 64 65
### Code Line Count

```
P
Phodal Huang 已提交
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
coca scc
```

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 已提交
93 94
```

P
Phodal Huang 已提交
95 96 97 98 99 100
### Build Deps Tree

```
coca call -c com.phodal.pholedge.book.BookController.createBook -d deps.json -r com.phodal.pholedge.
```

P
Phodal Huang 已提交
101 102
Examples Results:

P
Phodal Huang 已提交
103 104 105 106 107 108 109 110
![Call Demo](docs/sample/call_demo.svg)

### Identify Spring API

```
coca api -p examples/api -d deps.json
```

P
Phodal Huang 已提交
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
### Git Analysis

```
coca ga -t -b 
```

```
+----------------------------------------------+-----------+-------------+
|                  ENTITYNAME                  | REVSCOUNT | AUTHORCOUNT |
+----------------------------------------------+-----------+-------------+
| adapter/call/JavaCallListener.go             |        35 |           2 |
| helloworld.go                                |        22 |           1 |
| refactor/base/JavaRefactorListener.go        |        16 |           2 |
| .gitignore                                   |        14 |           2 |
| refactor/rename/rename_method.go             |        12 |           2 |
| bs/BadSmellApp.go                            |        11 |           1 |
| cmd/analysis.go                              |        10 |           2 |
| README.md                                    |        10 |           2 |
| adapter/identifier/JavaIdentifierListener.go |         9 |           2 |
| bs/BadSmellListener.go                       |         8 |           1 |
| adapter/api/JavaApiListener.go               |         8 |           1 |
| cmd/refactor.go                              |         8 |           2 |
| adapter/identifier/JavaIdentifierApp.go      |         8 |           2 |
| refactor/main.go                             |         7 |           2 |
| src/domain/call_graph.go                     |         7 |           1 |
| refactor/base/JavaRefactorApp.go             |         7 |           1 |
| go.mod                                       |         7 |           1 |
| src/domain/concept_analyser.go               |         6 |           1 |
| cmd/root.go                                  |         6 |           2 |
| refactor/move_class_app.go                   |         6 |           1 |
+----------------------------------------------+-----------+-------------+
```

P
Phodal Huang 已提交
144 145 146 147 148 149 150 151
### Refactor

support: 

 - rename
 - move
 - remove unused import
 - remove unused class
P
Phodal Huang 已提交
152 153 154 155 156 157

```
coca refactor -R rename.coca -D deps.json -p src/main
coca refactor -m move.config -p .
```

P
Phodal HUANG 已提交
158 159
## Dev

P
Phodal Huang 已提交
160
Install Go
P
Phodal HUANG 已提交
161 162 163 164 165

```bash
brew install go
```

P
Phodal Huang 已提交
166
Env
P
Phodal HUANG 已提交
167 168 169 170 171 172 173

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

P
Phodal Huang 已提交
174
clone
P
Phodal HUANG 已提交
175 176

```
P
Phodal Huang 已提交
177
go get https://github.com/phodal/coca
P
Phodal HUANG 已提交
178 179
```

P
Phodal Huang 已提交
180
Test Frameworks
P
Phodal HUANG 已提交
181 182 183 184

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

P
Phodal HUANG 已提交
187
### Refs
P
Phodal HUANG 已提交
188

P
Phodal Huang 已提交
189
[https://github.com/MontFerret/ferret](https://github.com/MontFerret/ferret)
P
Phodal Huang 已提交
190 191 192 193 194 195 196

License
---

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

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