Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@jawira
jawira committed Aug 29, 2019
1 parent 3522513 commit a49748e
Show file tree
Hide file tree
Showing 6 changed files with 53 additions and 47 deletions.
6 changes: 5 additions & 1 deletion README.md
View file
Expand Up @@ -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)
Expand Down Expand Up @@ -129,6 +130,9 @@ My other packages
<dt><a href="https://packagist.org/packages/jawira/phing-visualizer">jawira/phing-visualizer</a> (library)</dt>
<dd>Graphical representation of Phing's buildfile.</dd>

<dt><a href="https://packagist.org/packages/jawira/phing-open-task">jawira/phing-open-task</a> (library)</dt>
<dd>Phing task to open files, directories, and URLs with your favorite software.</dd>

<dt><a href="https://packagist.org/packages/jawira/plantuml">jawira/plantuml</a> (library)</dt>
<dd>Provides PlantUML integration: plantuml executable and plantuml.jar</dd>

Expand Down
2 changes: 1 addition & 1 deletion docs/images/build.puml
View file
Expand Up @@ -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)
Expand Down
16 changes: 8 additions & 8 deletions docs/images/uml-case-converter.puml
View file
@@ -1,5 +1,13 @@
@startuml
namespace Jawira.CaseConverter {
interface CaseConverterInterface << interface >> {
+convert()
}
class CaseConverter << class >> {
+convert()
}
class CaseConverterException << class >> {
}
class Convert << class >> {
#source
#words
Expand All @@ -19,14 +27,6 @@ namespace Jawira.CaseConverter {
+toArray()
+forceSimpleCaseMapping()
}
class CaseConverter << class >> {
+convert()
}
interface CaseConverterInterface << interface >> {
+convert()
}
class CaseConverterException << class >> {
}
}
class Exception << class >> {
}
Expand Down
64 changes: 32 additions & 32 deletions docs/images/uml-glue.puml
View file
@@ -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 >> {
Expand All @@ -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 >> {
Expand All @@ -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

6 changes: 3 additions & 3 deletions docs/images/uml-split.puml
View file
Expand Up @@ -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()
Expand All @@ -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

6 changes: 4 additions & 2 deletions phive.xml
View file
@@ -1,12 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<phive xmlns="https://phar.io/phive">
<!-- Use option: &#45;&#45;force-accept-unsigned-->
<configuration>
<targetDirectory>bin</targetDirectory>
</configuration>
<phar name="phpunit" version="^7.4.4" installed="7.5.14" location="./bin/phpunit" copy="false"/>
<phar name="phpstan" version="^0.10.5" installed="0.11.12" location="./bin/phpstan" copy="false"/>
<phar name="phpunit" version="^7.4.4" installed="7.5.15" location="./bin/phpunit" copy="false"/>
<phar name="phpstan" version="^0.10.5" installed="0.11.15" location="./bin/phpstan" copy="false"/>
<phar name="behat/behat" version="^3.3.0" installed="3.3.0" location="./bin/behat" copy="false"/>
<phar name="phing" version="^3.0.0-alpha2" installed="3.0.0-alpha2" location="./bin/phing" copy="false"/>
<phar name="phploc" version="^5.0.0" installed="5.0.0" location="./bin/phploc" copy="false"/>
<phar name="phpcs" version="^3.4.2" installed="3.4.2" location="./bin/phpcs" copy="false"/>
<phar name="composer/composer" version="^1.9.0" installed="1.9.0" location="./bin/composer" copy="false"/>
</phive>

0 comments on commit a49748e

Please sign in to comment.