Initial commit

Author: mpociot

.editorconfig

@@ -0,0 +1,15 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://editorconfig.org
+
+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

.gitattributes

@@ -0,0 +1,11 @@
+# Path-based git attributes
+# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
+
+# Ignore all test and documentation with "export-ignore".
+/.gitattributes     export-ignore
+/.gitignore         export-ignore
+/.travis.yml        export-ignore
+/phpunit.xml.dist   export-ignore
+/.scrutinizer.yml   export-ignore
+/tests              export-ignore
+/.editorconfig      export-ignore

.gitignore

@@ -0,0 +1,6 @@
+build
+composer.lock
+docs
+vendor
+coverage
+.idea

.scrutinizer.yml

@@ -0,0 +1,19 @@
+filter:
+    excluded_paths: [tests/*]
+
+checks:
+    php:
+        remove_extra_empty_lines: true
+        remove_php_closing_tag: true
+        remove_trailing_whitespace: true
+        fix_use_statements:
+            remove_unused: true
+            preserve_multiple: false
+            preserve_blanklines: true
+            order_alphabetically: true
+        fix_php_opening_tag: true
+        fix_linefeed: true
+        fix_line_ending: true
+        fix_identation_4spaces: true
+        fix_doc_comments: true
+

.styleci.yml

@@ -0,0 +1,4 @@
+preset: laravel
+
+disabled:
+  - single_class_element_per_statement

.travis.yml

@@ -0,0 +1,20 @@
+language: php
+
+php:
+  - 7.1
+  - 7.2
+
+env:
+  matrix:
+    - COMPOSER_FLAGS="--prefer-lowest"
+    - COMPOSER_FLAGS=""
+
+before_script:
+  - travis_retry composer self-update
+  - travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-source
+
+script:
+  - vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
+
+after_script:
+  - php vendor/bin/ocular code-coverage:upload --format=php-clover coverage.clover

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+All notable changes to `laravel-view-xray` will be documented in this file
+
+## 1.0.0 - 201X-XX-XX
+
+- initial release

CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+Please read and understand the contribution guide before creating an issue or pull request.
+
+## Etiquette
+
+This project is open source, and as such, the maintainers give their free time to build and maintain the source code
+held within. They make the code freely available in the hope that it will be of use to other developers. It would be
+extremely unfair for them to suffer abuse or anger for their hard work.
+
+Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
+world that developers are civilized and selfless people.
+
+It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
+quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
+
+## Viability
+
+When requesting or submitting new features, first consider whether it might be useful to others. Open
+source projects are used by many developers, who may have entirely different needs to your own. Think about
+whether or not your feature is likely to be used by other users of the project.
+
+## Procedure
+
+Before filing an issue:
+
+- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
+- Check to make sure your feature suggestion isn't already present within the project.
+- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
+- Check the pull requests tab to ensure that the feature isn't already in progress.
+
+Before submitting a pull request:
+
+- Check the codebase to ensure that your feature doesn't already exist.
+- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
+
+## Requirements
+
+If the project maintainer has any additional requirements, you will find them listed here.
+
+- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer).
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+**Happy coding**!

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Beyond Code GmbH <hello@beyondco.de>
+
+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.

README.md

@@ -0,0 +1,114 @@
+# Xray - Take a look into your Laravel views
+
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/beyondcode/laravel-view-xray.svg?style=flat-square)](https://packagist.org/packages/beyondcode/laravel-view-xray)
+[![Build Status](https://img.shields.io/travis/beyondcode/laravel-view-xray/master.svg?style=flat-square)](https://travis-ci.org/beyondcode/laravel-view-xray)
+[![Quality Score](https://img.shields.io/scrutinizer/g/beyondcode/laravel-view-xray.svg?style=flat-square)](https://scrutinizer-ci.com/g/beyondcode/laravel-view-xray)
+[![Total Downloads](https://img.shields.io/packagist/dt/beyondcode/laravel-view-xray.svg?style=flat-square)](https://packagist.org/packages/beyondcode/laravel-view-xray)
+
+When your Laravel project grows, so do the Laravel views. Sometimes it might be hard to figure out, which part of the output HTML was rendered using which template.
+With this package, you can take a peek into your Laravel views and find out which template is responsible for which part of the output HTML.
+
+![Example output](https://beyondco.de/github/xray/xray.png)
+
+## Installation
+
+You can install the package via composer:
+
+```bash
+composer require beyondcode/laravel-view-xray --dev
+```
+
+The package is enabled by default - so all you need to do is visit your application in the browser and hit the Xray shortcut.
+
+Windows: CTRL + Shift + X
+OSX: CMD + Shift + X
+
+This toggles the Xray view, where you can see which view (and optionally section) rendered the visual output.
+
+## Disabling Xray
+
+You can disable Xray by setting an environment variable called `XRAY_ENABLED` to `false`.
+
+## Excluding views
+
+If you want to exclude certain views from being processed by Xray, you can do this by adding them to the configuration file.
+
+Publish the configuration file using:
+
+```bash
+php artisan vendor:publish --provider=BeyondCode\\ViewXray\\ViewXrayServiceProvider
+``` 
+
+This will publish a file called `xray.php` in your `config` folder.
+
+This is the content of the configuration file:
+
+```php
+<?php
+
+return [
+
+    /*
+     * Determines if the Xray package should be enabled.
+     */
+    'enabled' => env('XRAY_ENABLED', true),
+
+    /*
+     * If you want to exclude certain views from being processed by Xray,
+     * you can list them here. Be aware that the check only applies to the
+     * root views that you add here. If these views include other views
+     * themselves, they need to be excluded manually.
+     */
+    'excluded' => [
+        //
+    ],
+
+];
+```
+
+Just place the view names that you want to exclude in the `excluded` array.
+
+## FAQ
+
+- Does this work with VueJS too?
+
+Yes, this package does work in combination with VueJS, but you need to enable comments in your VueJS app. This package works by adding specific HTML comments into the rendered views and uses
+these comments to find the bounding boxes of the rendered HTML. VueJS by default removes HTML comments prior to rendering.
+
+You can enable HTML comments in your VueJS app by setting `comments` to `true`:
+
+```javascript
+let app = new Vue({
+    el: '#content',
+    comments: true
+});
+```
+
+### Testing
+
+``` bash
+composer test
+```
+
+### Changelog
+
+Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+### Security
+
+If you discover any security related issues, please email marcel@beyondco.de instead of using the issue tracker.
+
+## Credits
+
+This project is inspired by [xray-rails](https://github.com/brentd/xray-rails).
+
+- [Marcel Pociot](https://github.com/:author_username)
+- [All Contributors](../../contributors)
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.