From a49748e6e46ed9dab0e6dbac3e1a9d9bc5a12ddc Mon Sep 17 00:00:00 2001 From: jawira Date: Thu, 29 Aug 2019 07:11:50 +0200 Subject: [PATCH] Update docs --- README.md | 6 ++- docs/images/build.puml | 2 +- docs/images/uml-case-converter.puml | 16 ++++---- docs/images/uml-glue.puml | 64 ++++++++++++++--------------- docs/images/uml-split.puml | 6 +-- phive.xml | 6 ++- 6 files changed, 53 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index 81518fe..408cd59 100644 --- a/README.md +++ b/README.md @@ -21,8 +21,9 @@ Use this library to convert string between: Features: -* 🔁 automatic case detection * 🌐 i18n +* 🔁 [automatic case detection][detection algorithm] +* 🏭 [factory][] [![Latest Stable Version](https://poser.pugx.org/jawira/case-converter/v/stable)](https://packagist.org/packages/jawira/case-converter) [![PHP from Packagist](https://img.shields.io/packagist/php-v/jawira/case-converter.svg)](https://packagist.org/packages/jawira/case-converter) @@ -129,6 +130,9 @@ My other packages
jawira/phing-visualizer (library)
Graphical representation of Phing's buildfile.
+
jawira/phing-open-task (library)
+
Phing task to open files, directories, and URLs with your favorite software.
+
jawira/plantuml (library)
Provides PlantUML integration: plantuml executable and plantuml.jar
diff --git a/docs/images/build.puml b/docs/images/build.puml index 6644a36..310d7d4 100644 --- a/docs/images/build.puml +++ b/docs/images/build.puml @@ -26,7 +26,7 @@ skinparam UseCaseFontColor Black (cc:before-build) (cc:after-build) (plantuml:puml-to-png) -(git:list-tags) +(git:tags-listing) (phing:visualize) (uml-writer:render) (docs:deploy) diff --git a/docs/images/uml-case-converter.puml b/docs/images/uml-case-converter.puml index bdf198e..84343eb 100644 --- a/docs/images/uml-case-converter.puml +++ b/docs/images/uml-case-converter.puml @@ -1,5 +1,13 @@ @startuml namespace Jawira.CaseConverter { + interface CaseConverterInterface << interface >> { + +convert() + } + class CaseConverter << class >> { + +convert() + } + class CaseConverterException << class >> { + } class Convert << class >> { #source #words @@ -19,14 +27,6 @@ namespace Jawira.CaseConverter { +toArray() +forceSimpleCaseMapping() } - class CaseConverter << class >> { - +convert() - } - interface CaseConverterInterface << interface >> { - +convert() - } - class CaseConverterException << class >> { - } } class Exception << class >> { } diff --git a/docs/images/uml-glue.puml b/docs/images/uml-glue.puml index 3b4843f..5d9daa5 100644 --- a/docs/images/uml-glue.puml +++ b/docs/images/uml-glue.puml @@ -1,9 +1,9 @@ @startuml namespace Jawira.CaseConverter.Glue { - class AdaCase << class >> { + class SentenceCase << class >> { +glue() } - abstract UnderscoreGluer << abstract >> { + abstract SpaceGluer << abstract >> { +DELIMITER } abstract Gluer << abstract >> { @@ -21,22 +21,15 @@ namespace Jawira.CaseConverter.Glue { #changeWordsCase() #changeFirstWordCase() } - class SentenceCase << class >> { + class LowerCase << class >> { +glue() } - abstract SpaceGluer << abstract >> { + class DotNotation << class >> { +DELIMITER - } - class SnakeCase << class >> { - +glue() - } - class TitleCase << class >> { - +glue() - } - class CamelCase << class >> { + -- +glue() } - abstract UppercaseGluer << abstract >> { + abstract UnderscoreGluer << abstract >> { +DELIMITER } class TrainCase << class >> { @@ -45,46 +38,53 @@ namespace Jawira.CaseConverter.Glue { abstract DashGluer << abstract >> { +DELIMITER } - class DotNotation << class >> { + abstract UppercaseGluer << abstract >> { +DELIMITER - -- + } + class AdaCase << class >> { +glue() } - class CobolCase << class >> { + class UpperCase << class >> { +glue() } - class PascalCase << class >> { + class TitleCase << class >> { +glue() } - class KebabCase << class >> { + class MacroCase << class >> { +glue() } - class UpperCase << class >> { + class SnakeCase << class >> { +glue() } - class LowerCase << class >> { + class CamelCase << class >> { +glue() } - class MacroCase << class >> { + class PascalCase << class >> { + +glue() + } + class CobolCase << class >> { + +glue() + } + class KebabCase << class >> { +glue() } } -Jawira.CaseConverter.Glue.UnderscoreGluer --|> Jawira.CaseConverter.Glue.Gluer -Jawira.CaseConverter.Glue.AdaCase --|> Jawira.CaseConverter.Glue.UnderscoreGluer Jawira.CaseConverter.Glue.SpaceGluer --|> Jawira.CaseConverter.Glue.Gluer Jawira.CaseConverter.Glue.SentenceCase --|> Jawira.CaseConverter.Glue.SpaceGluer -Jawira.CaseConverter.Glue.SnakeCase --|> Jawira.CaseConverter.Glue.UnderscoreGluer -Jawira.CaseConverter.Glue.TitleCase --|> Jawira.CaseConverter.Glue.SpaceGluer -Jawira.CaseConverter.Glue.UppercaseGluer --|> Jawira.CaseConverter.Glue.Gluer -Jawira.CaseConverter.Glue.CamelCase --|> Jawira.CaseConverter.Glue.UppercaseGluer +Jawira.CaseConverter.Glue.LowerCase --|> Jawira.CaseConverter.Glue.SpaceGluer +Jawira.CaseConverter.Glue.DotNotation --|> Jawira.CaseConverter.Glue.Gluer +Jawira.CaseConverter.Glue.UnderscoreGluer --|> Jawira.CaseConverter.Glue.Gluer Jawira.CaseConverter.Glue.DashGluer --|> Jawira.CaseConverter.Glue.Gluer Jawira.CaseConverter.Glue.TrainCase --|> Jawira.CaseConverter.Glue.DashGluer -Jawira.CaseConverter.Glue.DotNotation --|> Jawira.CaseConverter.Glue.Gluer -Jawira.CaseConverter.Glue.CobolCase --|> Jawira.CaseConverter.Glue.DashGluer -Jawira.CaseConverter.Glue.PascalCase --|> Jawira.CaseConverter.Glue.UppercaseGluer -Jawira.CaseConverter.Glue.KebabCase --|> Jawira.CaseConverter.Glue.DashGluer +Jawira.CaseConverter.Glue.UppercaseGluer --|> Jawira.CaseConverter.Glue.Gluer +Jawira.CaseConverter.Glue.AdaCase --|> Jawira.CaseConverter.Glue.UnderscoreGluer Jawira.CaseConverter.Glue.UpperCase --|> Jawira.CaseConverter.Glue.SpaceGluer -Jawira.CaseConverter.Glue.LowerCase --|> Jawira.CaseConverter.Glue.SpaceGluer +Jawira.CaseConverter.Glue.TitleCase --|> Jawira.CaseConverter.Glue.SpaceGluer Jawira.CaseConverter.Glue.MacroCase --|> Jawira.CaseConverter.Glue.UnderscoreGluer +Jawira.CaseConverter.Glue.SnakeCase --|> Jawira.CaseConverter.Glue.UnderscoreGluer +Jawira.CaseConverter.Glue.CamelCase --|> Jawira.CaseConverter.Glue.UppercaseGluer +Jawira.CaseConverter.Glue.PascalCase --|> Jawira.CaseConverter.Glue.UppercaseGluer +Jawira.CaseConverter.Glue.CobolCase --|> Jawira.CaseConverter.Glue.DashGluer +Jawira.CaseConverter.Glue.KebabCase --|> Jawira.CaseConverter.Glue.DashGluer @enduml diff --git a/docs/images/uml-split.puml b/docs/images/uml-split.puml index fe27381..6cc8f2e 100644 --- a/docs/images/uml-split.puml +++ b/docs/images/uml-split.puml @@ -17,12 +17,12 @@ namespace Jawira.CaseConverter.Split { -- +split() } - class UnderscoreSplitter << class >> { + class DotSplitter << class >> { +PATTERN -- +split() } - class DotSplitter << class >> { + class UnderscoreSplitter << class >> { +PATTERN -- +split() @@ -34,8 +34,8 @@ namespace Jawira.CaseConverter.Split { } Jawira.CaseConverter.Split.DashSplitter --|> Jawira.CaseConverter.Split.Splitter Jawira.CaseConverter.Split.SpaceSplitter --|> Jawira.CaseConverter.Split.Splitter -Jawira.CaseConverter.Split.UnderscoreSplitter --|> Jawira.CaseConverter.Split.Splitter Jawira.CaseConverter.Split.DotSplitter --|> Jawira.CaseConverter.Split.Splitter +Jawira.CaseConverter.Split.UnderscoreSplitter --|> Jawira.CaseConverter.Split.Splitter Jawira.CaseConverter.Split.UppercaseSplitter --|> Jawira.CaseConverter.Split.Splitter @enduml diff --git a/phive.xml b/phive.xml index 6c190c1..6151165 100644 --- a/phive.xml +++ b/phive.xml @@ -1,12 +1,14 @@ + bin - - + + +