rodrigo-brito/gocity

:bar_chart: Code City metaphor for visualizing Go source code in 3D

---

Available here: https://go-city.github.io

Research Paper: 26th International Conference on Software Analysis, Evolution and Reengineering (SANER)
PDF Version: ASERG Page

GoCity is an implementation of the Code City metaphor for visualizing source code. GoCity represents a Go program as a city, as follows:

• Folders are districts
• Files are buildings
• Structs are represented as buildings on the top of their files.

Structures Characteristics

• The Number of Lines of Source Code (LOC) represents the build color (high values makes the building dark)
• The Number of Variables (NOV) correlates to the building's base size.
• The Number of methods (NOM) correlates to the building height.

Installation

• go install github.com/rodrigo-brito/gocity@latest
• Or just head to the releases page and download the latest version for you platform.

Usage:

• Online: https://go-city.github.io
• Commands
  • gocity server - Start server
  • gocity open <GITHUB_IMPORT> - Open a specific Github project from github
  • gocity open ./my-project - Open a local directory

UI / Front-end

The UI is built with React and uses babylon.js to plot 3D structures. The front-end source code is available in the front-end branch.

Related Works

• Code City by Richard Wettel
• JS City by Marcus Viana.

This tool makes part of a scientific research developed at Federal University of Minas Gerais (UFMG)
Student: Rodrigo Brito
Advisor: Marco Tulio Valente

gocity's Issues

Remove Travis badge

Travis is not used in this repository.
The issue consists in remove this badge in the readme.

private repos

how do i view a private / local repo?

Eliminate utils package

This issue consists in move all methods from the utils package to another package.
Suggestion utils -> lib/file.

Receive branch name as parameter

We used master as default branch. Threfore, other branches can be uses. Maybe, it can be informed by a query param when requested.

Ref https://github.com/rodrigo-brito/gocity/blob/master/model/node.go#L167

Create a test file for visitor.go

This file implements a visitor that extract AST elements.
Source File: https://github.com/rodrigo-brito/gocity/blob/master/analyzer/visitor.go

Make it possible to run gocity on a local repository

It would be really helpful to be able to run gocity on a private or local repo.

Page not rendering anything in Firefox

Console has this error:

Error: Cannot instantiate firebase-firestore - be sure to load firebase-app.js first.

Include github actions in frontend branch

Include GitHub actions with eslint and tests (optional)

How to stop rotation

Does anyone know how to stop the scene rotation? Right now it stops for about 2 seconds on mouse click, and then restarts automatically. Gives me a headache when I'm trying to analyze a large codebase, makes it too easy to get lost in the streets. ;-) It would be great if it could be made to stop completely, and then restart on next click. I've been looking through the javascript, and I can't even find the handler that's stopping it for those two seconds or so.

Related -- I also can't find the handlers for drag, rotate, zoom. I'm thinking to add more functionality, like pan.

Upgrade Github Actions

• Set up new versions o Golang CI Lint
• Upgrade Go version in https://github.com/rodrigo-brito/gocity/blob/master/.github/workflows/tests.yml

Update Dockerfile to Go 1.15

Dockerfile is based on golang:1.12.
We need an upgrade to golang:1.15

Include Codecov in github actions

Include Codecov actions in project workflow
More details here: https://github.com/codecov/codecov-action

Incluide WTC for dev environment

Include WTC: https://github.com/rafaelsq/wtc
For command go run main.go server and tests.

Add local storage option

Not everybody want to store potentially private data on Google Cloud.

Travis integration

Include CI for:

• Test (go test ./...)
• Lint
• Coverage (Optional)

Ref https://docs.travis-ci.com/user/languages/go/

How to reset the cache?

I had plot my repo on GoCity before.

Now that I have changed my code, the files and folder structure are completely different, but GoCity shows the same visual as before.

Here's https://go-city.github.io/#/github.com/rohmanhm/go-open-dir
try to Open on Github file main.go it will shows Page Not Found

Create a test file for headers.go

A simple file that handles HTTP headers
https://github.com/rodrigo-brito/gocity/blob/master/handle/middlewares/headers.go

cleanup and refactor

While working on #66 and #76 I'm finding that working on this project is pretty unwieldy due to half of the code being in a different branch -- it really needs to be refactored into one branch. As things stand right now, it's certainly chasing off contributors -- taking a look at the forks makes me think there are a bunch of folks who have done a lot of work but who haven't been able to merge what they've done back into the master repo -- there are some duplicate efforts going on out there as well. I'm finding that the split-branch situation turns what should be a fun set of enhancements into a real chore.

I'm adding a stanza to the Makefile in my own fork to manage the two branches, copying assets over as mentioned in the comments in #66, but it's a horrible kludge.

@rodrigo-brito, you mention in #66 that the split branches was due to getting github to recognize the project as Go rather than javascript, but I'm not following that reasoning -- why do we care what language github shows for the project? Mixed-language projects are common -- any large project is going to be mixed-language. There must be something I'm missing.

Other refactoring that would help:

• better version control of node modules including yarn, e.g. committing package.lock, would help -- I had to do some hunting around to figure out a working combination.
• build instructions -- figuring those out took some time

I'd be happy to submit PRs to clean up any of this, but the split-branch situation makes that extra hard and is likely a prereq.

Include Go Linters in Github Actions

The GitHub actions are running tests but linter are not included.
There are a lot of example of code here: https://github.com/cedrickring/golang-action
Choose some linter and have fun.

Improve Coverage

This issue is valid until we reach 100% of coverage 😄. The current coverage is .
You can help with a simple test case. 👍

Create a test file for fetch.go

A simple file that fetches git repositories
Source file: https://github.com/rodrigo-brito/gocity/blob/master/lib/fetch.go

Add support for private git repo

Model has incorrect color for less than 2000 lines code

Your example on Cobra ( https://go-city.github.io/#/github.com/spf13/cobra ) shows a model rendered in black. According to the legend, black models represent 2000+ lines files, but the represented file is only 1571 lines long.

Ability to exclude files

Repositories like kubernetes have very large generated files that make visualization of other components harder.

The ability to exclude files/directories would be a nice enhancement.

Add badge generator

Hi!
It would be sweet to have beside the star and fork button at the top right corner, a badge generator, that simply link to the repo, like any other badge system it would simple generate a little markdown snippet for those who want to include a link to their code through gocity it in their README.

I think it's a fun idea, I'd like to do the PR myself but I'm really bad at designing anything graphical, so if someone is up for designing a little badge for gocity?

Have a nice day!

Frontend include firebase API key

These probably shouldn't be committed on the public repo:

       var config = {
          apiKey: "AIzaSyBe0Zg96mH5EXPm34yRUTrt9F1ZpJqPyPM",
           authDomain: "gocity-6bbdf.firebaseapp.com",
           databaseURL: "https://gocity-6bbdf.firebaseio.com",
           projectId: "gocity-6bbdf",
           storageBucket: "gocity-6bbdf.appspot.com",
           messagingSenderId: "601884113852"
       };```

Fix codecov badge

The codecov badge is not working, maybe the API changed and it stop to work.

Installation fails

I run go get -v -u github.com/rodrigo-brito/gocity and get this:

github.com/rodrigo-brito/gocity
../../../go/src/github.com/rodrigo-brito/gocity/main.go:29:5: app.Author undefined (type *cli.App has no field or method Author)
../../../go/src/github.com/rodrigo-brito/gocity/main.go:31:15: cannot use []cli.Command literal (type []cli.Command) as type []*cli.Command in assignment
../../../go/src/github.com/rodrigo-brito/gocity/main.go:36:16: cannot use cli.IntFlag literal (type cli.IntFlag) as type cli.Flag in slice literal:
	cli.IntFlag does not implement cli.Flag (Apply method has pointer receiver)
../../../go/src/github.com/rodrigo-brito/gocity/main.go:40:6: unknown field 'EnvVar' in struct literal of type cli.IntFlag

Localhost Redirect

Description

When I start the server using: go run main.go server. The system starts normally and displays the URL: http://localhost:4000. The problem is that when accessing the URL the server loops trying to redirect the client to http://localhost:4000//. This even prevents the use of the open command, which when entering the display URL presents the same problem.

Steps to Problem

1. Clone Repo;
2. Use make to install dep;
3. Run using go run main.go server;
4. Use the URL provided;
5. See server logs in terminal;

Support for Go Module projects

Include a CLI flag to open a project folder outside of $GOPATH.

Replace Pkger with `go:embed`

GoCity uses Pkger to embed static files.
After go 1.16, we can use go:embed: https://pkg.go.dev/embed

Replace in https://github.com/rodrigo-brito/gocity/blob/master/handle/analyzer.go#L1

Create a test file for analyzer.go

It is not necessary to cover all code elements. Just a few methods.
Source file: https://github.com/rodrigo-brito/gocity/blob/master/analyzer/analyzer.go

All my repos return an "Error during plot" error

Is this something on my side or..? Examples:

https://github.com/onodera-punpun/prt
https://github.com/onodera-punpun/sako
https://github.com/onodera-punpun/prt
https://github.com/onodera-punpun/melonbar

Create a test file for cors.go

A simple file that creates a cors middleware
https://github.com/rodrigo-brito/gocity/blob/master/handle/middlewares/cors.go

How can I get my own google credentials

I ran this project , and my ide told me "dialing: google: could not find default credentials. See https://developers.google.com/accounts/docs/application-default-credentials for more information."

Is this project might use google public server ?

thanks
---env---
go version : 1.8
platform : windows7
IDE : vscode

Replace Packer by Pkger

Currently, we are using gobuffalo/packr to embed static files.
Pkger is the successor of packer for static files
More info: https://github.com/markbates/pkger

can the website export city as png?

then I can use it in markdown