Skip to content

Commit 0737331

Browse files
committed
docs: update docs for beacon-hq migration
1 parent a95c06d commit 0737331

28 files changed

+470
-470
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ Bag is an open-source project and we welcome contributions. Whether you're fixin
44

55
## Getting Started
66

7-
To get started, fork the repository and clone it to your local machine. You can find the repository at <https://github.com/dshafik/bag>.
7+
To get started, fork the repository and clone it to your local machine. You can find the repository at <https://github.com/beacon-hq/bag>.
88

99
```shell
10-
git clone https://github.com/dshafik/bag.git
10+
git clone https://github.com/beacon-hq/bag.git
1111
```
1212

1313
## Installation

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Bag requires PHP 8.3+, and supports Laravel 11.x.
4444
You can install the package via composer:
4545

4646
```bash
47-
composer require dshafik/bag
47+
composer require beacon-hq/bag
4848
```
4949

5050
## Usage

docs/how-bag-works.md

Lines changed: 57 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Each pipeline is detailed below.
1616
1717
## The Input Pipeline
1818

19-
The [`InputPipeline`](https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/InputPipeline.php) is responsible for processing the input data so that the `Bag` object can be created. The pipeline
19+
The [`InputPipeline`](https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/InputPipeline.php) is responsible for processing the input data so that the `Bag` object can be created. The pipeline
2020
consists of the following steps:
2121

2222
```mermaid
@@ -49,20 +49,20 @@ class missingError,extraError,valid,initialized mermaid-decision
4949
class bag mermaid-end
5050
class errorMissingParameters,errorExtraParameters,errorValidation,errorInitialization mermaid-error
5151
52-
click start "https://github.com/dshafik/bag/blob/main/src/Bag/Bag.php" _blank
53-
click transform "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/Transform.php" _blank
54-
click process "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/ProcessParameters.php" _blank
55-
click variadic "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/IsVariadic.php" _blank
56-
click fillNull "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/FillNulls.php" _blank
57-
click mapInput "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/MapInput.php" _blank
58-
click laravelParams "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/LaravelRouteParameters.php" _blank
59-
click missing "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/MissingParameters.php" _blank
60-
click extra "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/ExtraParameters.php" _blank
61-
click strip "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/StripExtraParameters.php" _blank
62-
click validate "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/Validate.php" _blank
63-
click cast "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/CastInputValues.php" _blank
64-
click construct "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/FillBag.php" _blank
65-
click computed "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/ComputedValues.php" _blank
52+
click start "https://github.com/beacon-hq/bag/blob/main/src/Bag/Bag.php" _blank
53+
click transform "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/Transform.php" _blank
54+
click process "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/ProcessParameters.php" _blank
55+
click variadic "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/IsVariadic.php" _blank
56+
click fillNull "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/FillNulls.php" _blank
57+
click mapInput "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/MapInput.php" _blank
58+
click laravelParams "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/LaravelRouteParameters.php" _blank
59+
click missing "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/MissingParameters.php" _blank
60+
click extra "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/ExtraParameters.php" _blank
61+
click strip "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/StripExtraParameters.php" _blank
62+
click validate "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/Validate.php" _blank
63+
click cast "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/CastInputValues.php" _blank
64+
click construct "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/FillBag.php" _blank
65+
click computed "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/ComputedValues.php" _blank
6666
```
6767

6868
## The Output Pipeline
@@ -91,19 +91,19 @@ class toArray,toCollection,toJson,jsonEncode,get,unwrapped mermaid-start
9191
class output mermaid-end
9292
class hide,hideJson,wrap mermaid-conditional
9393
94-
click toArray "https://github.com/dshafik/bag/blob/main/src/Bag/Concerns/WithArrayable.php" _blank
95-
click toCollection "https://github.com/dshafik/bag/blob/main/src/Bag/Concerns/WithCollections.php" _blank
96-
click toJson "https://github.com/dshafik/bag/blob/main/src/Bag/Concerns/WithJson.php" _blank
97-
click get "https://github.com/dshafik/bag/blob/main/src/Bag/Concerns/WithOutput.php" _blank
98-
click unwrapped "https://github.com/dshafik/bag/blob/main/src/Bag/Concerns/WithOutput.php" _blank
99-
click processParameters "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/ProcessParameters.php" _blank
100-
click processProperties "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/ProcessProperties.php" _blank
101-
click getValues "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/GetValues.php" _blank
102-
click hide "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/HideValues.php" _blank
103-
click hideJson "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/HideJsonValues.php" _blank
104-
click cast "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/CastOutputValues.php" _blank
105-
click mapOutput "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/MapOutput.php" _blank
106-
click wrap "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/Wrap.php" _blank
94+
click toArray "https://github.com/beacon-hq/bag/blob/main/src/Bag/Concerns/WithArrayable.php" _blank
95+
click toCollection "https://github.com/beacon-hq/bag/blob/main/src/Bag/Concerns/WithCollections.php" _blank
96+
click toJson "https://github.com/beacon-hq/bag/blob/main/src/Bag/Concerns/WithJson.php" _blank
97+
click get "https://github.com/beacon-hq/bag/blob/main/src/Bag/Concerns/WithOutput.php" _blank
98+
click unwrapped "https://github.com/beacon-hq/bag/blob/main/src/Bag/Concerns/WithOutput.php" _blank
99+
click processParameters "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/ProcessParameters.php" _blank
100+
click processProperties "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/ProcessProperties.php" _blank
101+
click getValues "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/GetValues.php" _blank
102+
click hide "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/HideValues.php" _blank
103+
click hideJson "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/HideJsonValues.php" _blank
104+
click cast "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/CastOutputValues.php" _blank
105+
click mapOutput "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/MapOutput.php" _blank
106+
click wrap "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/Wrap.php" _blank
107107
```
108108

109109
> [!NOTE]
@@ -136,21 +136,21 @@ class missingError,extraError,valid mermaid-decision
136136
class success mermaid-end
137137
class errorMissingParameters,errorExtraParameters,errorValidation mermaid-error
138138
139-
click start "https://github.com/dshafik/bag/blob/main/src/Bag/Concerns/WithValidation.php" _blank
140-
click transform "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/Transform.php" _blank
141-
click process "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/ProcessParameters.php" _blank
142-
click variadic "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/IsVariadic.php" _blank
143-
click fillNulls "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/FillNulls.php" _blank
144-
click mapInput "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/MapInput.php" _blank
145-
click missing "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/MissingParameters.php" _blank
146-
click extra "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/ExtraParameters.php" _blank
147-
click strip "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/StripExtraParameters.php" _blank
148-
click validate "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/Validate.php" _blank
139+
click start "https://github.com/beacon-hq/bag/blob/main/src/Bag/Concerns/WithValidation.php" _blank
140+
click transform "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/Transform.php" _blank
141+
click process "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/ProcessParameters.php" _blank
142+
click variadic "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/IsVariadic.php" _blank
143+
click fillNulls "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/FillNulls.php" _blank
144+
click mapInput "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/MapInput.php" _blank
145+
click missing "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/MissingParameters.php" _blank
146+
click extra "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/ExtraParameters.php" _blank
147+
click strip "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/StripExtraParameters.php" _blank
148+
click validate "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/Validate.php" _blank
149149
```
150150

151151
## The Without Validate Pipeline
152152

153-
The [`WithoutValidationPipeline`](https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/WithoutValidationPipeline.php) is identical to the `InputPipeline` but does not perform validation. The pipeline
153+
The [`WithoutValidationPipeline`](https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/WithoutValidationPipeline.php) is identical to the `InputPipeline` but does not perform validation. The pipeline
154154
consists of the following steps:
155155

156156
```mermaid
@@ -177,19 +177,19 @@ class missingError,extraError,valid,initialized mermaid-decision
177177
class bag mermaid-end
178178
class errorMissingParameters,errorExtraParameters,errorValidation,errorInitialization mermaid-error
179179
180-
click start "https://github.com/dshafik/bag/blob/main/src/Bag/Bag.php" _blank
181-
click transform "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/Transform.php" _blank
182-
click process "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/ProcessParameters.php" _blank
183-
click variadic "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/IsVariadic.php" _blank
184-
click fillNulls "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/FillNulls.php" _blank
185-
click mapInput "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/MapInput.php" _blank
186-
click laravelParams "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/LaravelRouteParameters.php" _blank
187-
click missing "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/MissingParameters.php" _blank
188-
click strip "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/StripExtraParameters.php" _
189-
click validate "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/Validate.php" _blank
190-
click cast "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/CastInputValues.php" _blank
191-
click construct "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/FillBag.php" _blank
192-
click computed "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/ComputedValues.php" _blank
180+
click start "https://github.com/beacon-hq/bag/blob/main/src/Bag/Bag.php" _blank
181+
click transform "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/Transform.php" _blank
182+
click process "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/ProcessParameters.php" _blank
183+
click variadic "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/IsVariadic.php" _blank
184+
click fillNulls "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/FillNulls.php" _blank
185+
click mapInput "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/MapInput.php" _blank
186+
click laravelParams "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/LaravelRouteParameters.php" _blank
187+
click missing "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/MissingParameters.php" _blank
188+
click strip "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/StripExtraParameters.php" _
189+
click validate "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/Validate.php" _blank
190+
click cast "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/CastInputValues.php" _blank
191+
click construct "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/FillBag.php" _blank
192+
click computed "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/ComputedValues.php" _blank
193193
```
194194

195195
## The Output Collection Pipeline
@@ -208,11 +208,11 @@ wrap(Wrap Collection*)
208208
class toArray,toJson,jsonEncode,unwrapped mermaid-start
209209
class output mermaid-end
210210
211-
click toArray "https://github.com/dshafik/bag/blob/main/src/Bag/Collection.php" _blank
212-
click toJson "https://github.com/dshafik/bag/blob/main/src/Bag/Collection.php" _blank
213-
click jsonEncode "https://github.com/dshafik/bag/blob/main/src/Bag/Collection.php" _blank
214-
click unwrapped "https://github.com/dshafik/bag/blob/main/src/Bag/Collection.php" _blank
215-
click wrap "https://github.com/dshafik/bag/blob/main/src/Bag/Pipelines/Pipes/WrapCollection.php" _blank
211+
click toArray "https://github.com/beacon-hq/bag/blob/main/src/Bag/Collection.php" _blank
212+
click toJson "https://github.com/beacon-hq/bag/blob/main/src/Bag/Collection.php" _blank
213+
click jsonEncode "https://github.com/beacon-hq/bag/blob/main/src/Bag/Collection.php" _blank
214+
click unwrapped "https://github.com/beacon-hq/bag/blob/main/src/Bag/Collection.php" _blank
215+
click wrap "https://github.com/beacon-hq/bag/blob/main/src/Bag/Pipelines/Pipes/WrapCollection.php" _blank
216216
```
217217

218218
> [!NOTE]

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ layout: home
55
hero:
66
name: "Bag"
77
text: "Immutable Value Objects for PHP"
8-
tagline: "<code>composer require dshafik/bag</code>"
8+
tagline: "<code>composer require beacon-hq/bag</code>"
99
image: /assets/images/bag.png
1010
actions:
1111
- theme: brand

docs/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ Bag requires PHP 8.2+, and supports Laravel 10+.
1111
To install Bag, use [Composer](https://getcomposer.org):
1212

1313
```bash
14-
composer require dshafik/bag
14+
composer require beacon-hq/bag
1515
```

0 commit comments

Comments
 (0)