Sign upLogin

Kerrigan29a/recipe

View on GitHub
Star
state.go

Summary

Maintainability
B
4 hrs
Test Coverage

Similar blocks of code found in 3 locations. Consider refactoring.
Open

func (s *State) serialize(indent bool) *bytes.Buffer {
    s.mu.Lock()
    defer s.mu.Unlock()
    b := bytes.Buffer{}
    e := json.NewEncoder(&b)
Severity: Major
Found in state.go and 2 other locations - About 1 hr to fix
recipe.go on lines 295..308
task.go on lines 210..223

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 143.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 5 locations. Consider refactoring.
Open

func (s *State) MustSetWaiting(taskName string) {
    s.mu.Lock()
    defer s.mu.Unlock()
    if s.States[taskName] != Enabled {
        panic(fmt.Errorf("Current state must be Enabled, not %s", s.States[taskName].String()))
Severity: Major
Found in state.go and 4 other locations - About 45 mins to fix
state.go on lines 149..156
state.go on lines 164..171
state.go on lines 179..186
state.go on lines 194..201

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 113.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 5 locations. Consider refactoring.
Open

func (s *State) MustSetRunning(taskName string) {
    s.mu.Lock()
    defer s.mu.Unlock()
    if s.States[taskName] != Waiting {
        panic(fmt.Errorf("Current state must be Waiting, not %s", s.States[taskName].String()))
Severity: Major
Found in state.go and 4 other locations - About 45 mins to fix
state.go on lines 134..141
state.go on lines 164..171
state.go on lines 179..186
state.go on lines 194..201

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 113.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 5 locations. Consider refactoring.
Open

func (s *State) MustSetCancelled(taskName string) {
    s.mu.Lock()
    defer s.mu.Unlock()
    if s.States[taskName] != Running {
        panic(fmt.Errorf("Current state must be Running, not %s", s.States[taskName].String()))
Severity: Major
Found in state.go and 4 other locations - About 45 mins to fix
state.go on lines 134..141
state.go on lines 149..156
state.go on lines 179..186
state.go on lines 194..201

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 113.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 5 locations. Consider refactoring.
Open

func (s *State) MustSetSuccess(taskName string) {
    s.mu.Lock()
    defer s.mu.Unlock()
    if s.States[taskName] != Running {
        panic(fmt.Errorf("Current state must be Running, not %s", s.States[taskName].String()))
Severity: Major
Found in state.go and 4 other locations - About 45 mins to fix
state.go on lines 134..141
state.go on lines 149..156
state.go on lines 164..171
state.go on lines 194..201

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 113.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 5 locations. Consider refactoring.
Open

func (s *State) MustSetFailure(taskName string) {
    s.mu.Lock()
    defer s.mu.Unlock()
    if s.States[taskName] != Running {
        panic(fmt.Errorf("Current state must be Running, not %s", s.States[taskName].String()))
Severity: Major
Found in state.go and 4 other locations - About 45 mins to fix
state.go on lines 134..141
state.go on lines 149..156
state.go on lines 164..171
state.go on lines 179..186

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 113.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

exported method State.MustSetFailure should have comment or be unexported
Open

func (s *State) MustSetFailure(taskName string) {
Severity: Minor
Found in state.go by golint

exported method State.SetDisabled should have comment or be unexported
Open

func (s *State) SetDisabled(taskName string) {
Severity: Minor
Found in state.go by golint

exported method State.MustSetRunning should have comment or be unexported
Open

func (s *State) MustSetRunning(taskName string) {
Severity: Minor
Found in state.go by golint

exported method State.IsEnabled should have comment or be unexported
Open

func (s *State) IsEnabled(taskName string) bool {
Severity: Minor
Found in state.go by golint

exported method State.IsFailure should have comment or be unexported
Open

func (s *State) IsFailure(taskName string) bool {
Severity: Minor
Found in state.go by golint

exported method State.MustSetSuccess should have comment or be unexported
Open

func (s *State) MustSetSuccess(taskName string) {
Severity: Minor
Found in state.go by golint

exported method State.IsWaiting should have comment or be unexported
Open

func (s *State) IsWaiting(taskName string) bool {
Severity: Minor
Found in state.go by golint

exported method State.IsRunning should have comment or be unexported
Open

func (s *State) IsRunning(taskName string) bool {
Severity: Minor
Found in state.go by golint

exported method State.MustSetCancelled should have comment or be unexported
Open

func (s *State) MustSetCancelled(taskName string) {
Severity: Minor
Found in state.go by golint

exported method State.Save should have comment or be unexported
Open

func (s *State) Save() error {
Severity: Minor
Found in state.go by golint

exported method State.IsCancelled should have comment or be unexported
Open

func (s *State) IsCancelled(taskName string) bool {
Severity: Minor
Found in state.go by golint

exported type TaskState should have comment or be unexported
Open

type TaskState int
Severity: Minor
Found in state.go by golint

exported type State should have comment or be unexported
Open

type State struct {
Severity: Minor
Found in state.go by golint

exported method State.IsSuccess should have comment or be unexported
Open

func (s *State) IsSuccess(taskName string) bool {
Severity: Minor
Found in state.go by golint

exported method State.MustSetEnabled should have comment or be unexported
Open

func (s *State) MustSetEnabled(taskName string) {
Severity: Minor
Found in state.go by golint

exported method State.IsDone should have comment or be unexported
Open

func (s *State) IsDone(taskName string) bool {
Severity: Minor
Found in state.go by golint

exported const Disabled should have comment (or a comment on this block) or be unexported
Open

    Disabled TaskState = iota
Severity: Minor
Found in state.go by golint

exported method State.Remove should have comment or be unexported
Open

func (s *State) Remove() error {
Severity: Minor
Found in state.go by golint

exported function OpenState should have comment or be unexported
Open

func OpenState(path string, logger *Logger) (*State, error) {
Severity: Minor
Found in state.go by golint

exported method State.PrettyString should have comment or be unexported
Open

func (s *State) PrettyString() string {
Severity: Minor
Found in state.go by golint

exported method State.SetEnabled should have comment or be unexported
Open

func (s *State) SetEnabled(taskName string) error {
Severity: Minor
Found in state.go by golint

exported method State.MustSetWaiting should have comment or be unexported
Open

func (s *State) MustSetWaiting(taskName string) {
Severity: Minor
Found in state.go by golint

There are no issues that match your filters.

Category
Status