Prevent "wrong theme name" bugs in the future

zupo commented 6 years ago

The Story

Handbook documents: User story & Work process

As a Victor, I never want to see wrong theme name bug again, because it is completely preventable.

Problem

Theme names are hardcoded in CartFront theme and not checked against the valid values defined in openapi.yaml schema.

Proposal

Before you start: It's Bookstore, not Books Store or Book Store. Use search & replace to fix all codebase.

Option A:

figure out how to do enums in PHP (here's one idea)
convert the $stores array into an enum
create make codegen command that generates the $stores enum from template values on https://app.woocart.com/api/v1/openapi.yaml.
fail Travis build if make codegen changes files

Option B:

Create make validate command that validates values of $stores array against template values on https://app.woocart.com/api/v1/openapi.yaml
Run make validate on Travis so the build fails if values do not match

Pitfalls

Best practices (DoD)

Documentation is revised: e.g. help articles or technical docs.
Product users are informed. e.g. blog post describing a new feature or bugfix.
Test coverage is 100%.

Expectations (AC)

[ ] Books Store was refactored to Bookstore.
[ ] Travis build fails if theme values in CartFront do not match template values in openapi.yaml spec.
[ ] User story demo uploaded to sprint release.

dz0ny commented 6 years ago

Enums in PHP


<?php

trait EnumHelpers {
    public static function getValues(){
      return (new ReflectionClass(get_called_class()))->getConstants(); 
    }
}

class Themes {
  use EnumHelpers;

  const BookStore = "bookstore";
  const ToyStore = "toystore";

}

var_dump(Themes::BookStore);
var_dump(Themes::getValues());

?>

See https://repl.it/repls/ForestgreenSaneWamp

ikolar commented 5 years ago

@zupo tried option B; would be nice if you could take a look.

zupo commented 5 years ago

What's the next step here?

woocart / cartfront