first commit

runthis · runthis · commit 650cfd4531ab · 2022-06-28T17:39:30.000-05:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml,js,scss,css}]
+indent_size = 2
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,5 @@
+/.github            export-ignore
+/.editorconfig      export-ignore
+/.gitattributes     export-ignore
+/.gitignore         export-ignore
+/phpcs.xml          export-ignore
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,12 @@
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    labels:
+      - "dependencies"
diff --git a/.github/workflows/dependabot-auto-merge.yml b/.github/workflows/dependabot-auto-merge.yml
@@ -0,0 +1,32 @@
+name: dependabot-auto-merge
+on: pull_request_target
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+    
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v1.3.1
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+          
+      - name: Auto-merge Dependabot PRs for semver-minor updates
+        if: ${{steps.metadata.outputs.update-type == 'version-update:semver-minor'}}
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          
+      - name: Auto-merge Dependabot PRs for semver-patch updates
+        if: ${{steps.metadata.outputs.update-type == 'version-update:semver-patch'}}
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
diff --git a/.github/workflows/update-changelog.yml b/.github/workflows/update-changelog.yml
@@ -0,0 +1,28 @@
+name: "Update Changelog"
+
+on:
+  release:
+    types: [released]
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          ref: main
+
+      - name: Update Changelog
+        uses: stefanzweifel/changelog-updater-action@v1
+        with:
+          latest-version: ${{ github.event.release.name }}
+          release-notes: ${{ github.event.release.body }}
+
+      - name: Commit updated CHANGELOG
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          branch: main
+          commit_message: Update CHANGELOG
+          file_pattern: CHANGELOG.md
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,6 @@
+.idea
+.php_cs
+.php_cs.cache
+.php-cs-fixer.cache
+composer.lock
+vendor
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,3 @@
+# Changelog
+
+All notable changes to will be documented in this file.
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 runthis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,66 @@
+# Laravel Media
+
+A tiny laravel package to conveniently handle single file media uploads with little configuration.
+
+
+
+## Installation
+
+    composer require runthis/laravel-media
+
+
+
+## Usage
+
+Add to the file you want to process uploads in, such as a controller.
+
+    use Runthis\Media\Facades\Media;
+    use Runthis\Media\Requests\MediaRequest;
+
+
+Include the `MediaRequest` class in the function parameter and execute the `create` method on the `Media` facade.
+
+Example:
+
+    public function upload(MediaRequest $request) {
+        $test = Media::create($request);
+        dd($test);
+    }
+
+Inside the `dd()` you can see the complete object details and process these as you see fit (such as keeping track of these uploads in a database if you like).
+
+Within the object results is a `size` key. You can simply echo this out to get the bytes, or you can add `->pretty()` to get a prettier output.
+You can also pass a string parameter to the `pretty()` method.
+
+Options:
+
+    l: lowercase suffix (12.45 mb instead of 12.45 MB)
+    s: spacing omitted (12.45MB instead of 12.45 MB)
+    b: Ending "B" removed (12.45 M instead of 12.45 MB)
+
+Examples:
+
+    $test->size->pretty('sb'); // 12.45M
+    $test->size->pretty('ls'); // 12.45m
+    $test->size->pretty('l'); // 12.45 mb
+    $test->size->pretty('bl'); // 12.45 m
+
+
+*The `Media::create` method expects a file with the key named file.*
+
+
+
+## Publish Config
+
+If you want, run the below command to add a media.php file to your config folder.
+
+    php artisan vendor:publish --tag="media-config"
+
+From the media config file you can change the storage disk name and the rules for the media (such as file types, size limit, etc).
+
+
+
+## Changelog
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
diff --git a/composer.json b/composer.json
@@ -0,0 +1,50 @@
+{
+    "name": "runthis/laravel-media",
+    "version": "1.0.0",
+    "license": "MIT",
+    "description": "Handle media in laravel packages",
+    "keywords": [
+        "laravel",
+        "media"
+    ],
+    "homepage": "https://github.com/runthis/laravel-media",
+    "authors": [
+        {
+            "name": "runthis"
+        }
+    ],
+    "require": {
+        "php": "^8.0",
+        "guzzlehttp/guzzle": "^7.4",
+        "illuminate/contracts": "^9.0",
+        "illuminate/http": "^9.9",
+        "illuminate/support": "^9.9",
+        "spatie/laravel-package-tools": "^1.9.2"
+    },
+    "require-dev": {
+        "nunomaduro/collision": "^6.0",
+        "orchestra/testbench": "^7.0",
+        "spatie/laravel-ray": "^1.26",
+        "squizlabs/php_codesniffer": "^3.6"
+    },
+    "autoload": {
+        "psr-4": {
+            "Runthis\\Media\\": "src"
+        }
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Runthis\\Media\\MediaServiceProvider"
+            ],
+            "aliases": {
+                "Media": "Runthis\\Media\\Facades\\Media"
+            }
+        }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
+}
diff --git a/config/media.php b/config/media.php
@@ -0,0 +1,6 @@
+<?php
+
+return [
+    'disk' => 'public',
+    'rules' => 'mimes:jpeg,jpg,png,gif,webp,svg,image/svg+xml|max:1024',
+];
diff --git a/phpcs.xml b/phpcs.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0"?>
+<ruleset name="Laravel Standards">
+    <description>The Laravel Coding Standards</description>
+
+    <arg name="report" value="summary"/>
+    <arg name="colors"/>
+    <arg value="p"/>
+
+    <ini name="memory_limit" value="512M"/>
+
+    <exclude-pattern>*/node_modules/*</exclude-pattern>
+    <exclude-pattern>*/resources/*</exclude-pattern>
+    <exclude-pattern>*/tests/*</exclude-pattern>
+    <exclude-pattern>*/vendor/*</exclude-pattern>
+    <exclude-pattern>*/src/Commands/*</exclude-pattern>
+
+    <rule ref="PSR12">
+        <exclude name="PSR12.Files.FileHeader.SpacingInsideBlock"/>
+        <exclude name="Generic.Files.LineLength"/>
+        <exclude name="Squiz.WhiteSpace.ControlStructureSpacing.SpacingAfterOpen"/>
+    </rule>
+	<rule ref="Generic.WhiteSpace.ScopeIndent">
+		<properties>
+			<property name="indent" value="4"/>
+			<property name="tabIndent" value="false"/>
+		</properties>
+	</rule>
+</ruleset>
diff --git a/src/Attributes/Size.php b/src/Attributes/Size.php
@@ -0,0 +1,63 @@
+<?php
+
+namespace Runthis\Media\Attributes;
+
+use function floor;
+use function in_array;
+use function log;
+use function pow;
+use function sprintf;
+use function str_ireplace;
+use function str_replace;
+use function str_split;
+use function strtolower;
+
+class Size
+{
+    /**
+     * Set the bytes.
+     */
+    public function __construct(public int $bytes)
+    {
+    }
+
+    /**
+     * Format file size provided from bytes.
+     *
+     * Options:
+     *     l: lowercase suffix (12.45 mb instead of 12.45 MB)
+     *     s: spacing omitted (12.45MB instead of 12.45 MB)
+     *     b: Ending "B" removed (12.45 M instead of 12.45 MB)
+     */
+    public function pretty(string $options = ''): string
+    {
+        $format = '%.02F %sB';
+        $suffix = 'BKMGTPEZY';
+        $options = str_split($options);
+
+        // Set byte formatting
+        $format = $this->bytes < 1024 ? (in_array('b', $options, true) ? '%.0F' : '%.0F %s') : $format;
+
+        // Lowercase
+        $suffix = in_array('l', $options, true) ? strtolower($suffix) : $suffix;
+        $format = in_array('l', $options, true) ? str_replace('B', 'b', $format) : $format;
+
+        // No ending "b"
+        $format = in_array('b', $options, true) ? str_ireplace('b', '', $format) : $format;
+
+        // No spacing
+        $format = in_array('s', $options, true) ? str_replace(' ', '', $format) : $format;
+
+        $index = floor(log($this->bytes) / log(1024));
+
+        return sprintf($format, $this->bytes / pow(1024, $index), str_split($suffix)[$index]);
+    }
+
+    /**
+     * Just send back the bytes.
+     */
+    public function __toString(): string
+    {
+        return (string) $this->bytes;
+    }
+}
diff --git a/src/Contracts/Media.php b/src/Contracts/Media.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace Runthis\Media\Contracts;
+
+use Runthis\Media\Requests\MediaRequest;
+
+interface Media
+{
+    /**
+     * Create the media.
+     *
+     * @return array{
+     *  file: \Illuminate\Http\UploadedFile,
+     *  storage: \Illuminate\Contracts\Filesystem\Filesystem,
+     *  size: string | \Runthis\Media\Attributes\Size,
+     *  url: string
+     * }
+     */
+    public function create(MediaRequest $request, string $directory = ''): object;
+}
diff --git a/src/Facades/Media.php b/src/Facades/Media.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace Runthis\Media\Facades;
+
+use Illuminate\Support\Facades\Facade;
+
+/**
+ * @method static object{ file: \Illuminate\Http\UploadedFile, storage: \Illuminate\Contracts\Filesystem\Filesystem, size: string | \Runthis\Media\Attributes\Size, url: string, path: string } create(\Runthis\Media\Requests\MediaRequest $request, string $directory = '') Create media and return object.
+ */
+class Media extends Facade
+{
+    protected static function getFacadeAccessor(): string
+    {
+        return 'media';
+    }
+}
diff --git a/src/Media.php b/src/Media.php
diff --git a/src/MediaServiceProvider.php b/src/MediaServiceProvider.php
diff --git a/src/Requests/MediaRequest.php b/src/Requests/MediaRequest.php
diff --git a/src/Test.php b/src/Test.php

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Changelog`
	`2`	`+`
	`3`	`+All notable changes to will be documented in this file.`