From b837c8f67b81136359664cb653252f9df92ec401 Mon Sep 17 00:00:00 2001
From: jaiwalker <kora.jayaram@gmail.com>
Date: Mon, 13 Jun 2016 10:19:44 +1000
Subject: [PATCH]  updated read me.md with test cases

---
 .idea/workspace.xml                | 103 +++++++++++++-------------
 packages/jai/Contact/composer.json |   6 +-
 readme.md                          | 111 ++++++++++++++++++++++++-----
 3 files changed, 150 insertions(+), 70 deletions(-)

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index cb0b2be..162c45f 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -61,10 +61,10 @@
           </provider>
         </entry>
       </file>
-      <file leaf-file-name="ContactServiceprovider.php" pinned="false" current-in-tab="false">
+      <file leaf-file-name="ContactServiceprovider.php" pinned="false" current-in-tab="true">
         <entry file="file://$PROJECT_DIR$/packages/jai/Contact/src/ContactServiceprovider.php">
           <provider selected="true" editor-type-id="text-editor">
-            <state vertical-scroll-proportion="-3.7407408">
+            <state vertical-scroll-proportion="0.14407988">
               <caret line="53" column="24" selection-start-line="53" selection-start-column="24" selection-end-line="53" selection-end-column="24" />
               <folding />
             </state>
@@ -74,14 +74,14 @@
       <file leaf-file-name="composer.json" pinned="false" current-in-tab="false">
         <entry file="file://$PROJECT_DIR$/packages/jai/Contact/composer.json">
           <provider selected="true" editor-type-id="text-editor">
-            <state vertical-scroll-proportion="-14.814815">
-              <caret line="16" column="39" selection-start-line="16" selection-start-column="39" selection-end-line="16" selection-end-column="39" />
+            <state vertical-scroll-proportion="-12.037037">
+              <caret line="13" column="5" selection-start-line="13" selection-start-column="5" selection-end-line="13" selection-end-column="5" />
               <folding />
             </state>
           </provider>
         </entry>
       </file>
-      <file leaf-file-name=".env" pinned="false" current-in-tab="true">
+      <file leaf-file-name=".env" pinned="false" current-in-tab="false">
         <entry file="file://$PROJECT_DIR$/.env">
           <provider selected="true" editor-type-id="text-editor">
             <state vertical-scroll-proportion="0.0">
@@ -91,31 +91,31 @@
           </provider>
         </entry>
       </file>
-      <file leaf-file-name="TestPackageCase.php" pinned="false" current-in-tab="false">
-        <entry file="file://$PROJECT_DIR$/packages/jai/Contact/tests/TestPackageCase.php">
+      <file leaf-file-name="readme.md" pinned="false" current-in-tab="false">
+        <entry file="file://$PROJECT_DIR$/readme.md">
           <provider selected="true" editor-type-id="text-editor">
-            <state vertical-scroll-proportion="-2.7777777">
-              <caret line="3" column="40" selection-start-line="3" selection-start-column="40" selection-end-line="3" selection-end-column="40" />
+            <state vertical-scroll-proportion="-40.77778">
+              <caret line="99" column="147" selection-start-line="99" selection-start-column="147" selection-end-line="99" selection-end-column="147" />
               <folding />
             </state>
           </provider>
         </entry>
       </file>
-      <file leaf-file-name="composer.json" pinned="false" current-in-tab="false">
-        <entry file="file://$PROJECT_DIR$/composer.json">
+      <file leaf-file-name="phpunit.xml" pinned="false" current-in-tab="false">
+        <entry file="file://$PROJECT_DIR$/packages/jai/Contact/phpunit.xml">
           <provider selected="true" editor-type-id="text-editor">
-            <state vertical-scroll-proportion="-16.666666">
-              <caret line="29" column="27" selection-start-line="29" selection-start-column="27" selection-end-line="29" selection-end-column="27" />
+            <state vertical-scroll-proportion="-14.814815">
+              <caret line="16" column="10" selection-start-line="16" selection-start-column="10" selection-end-line="16" selection-end-column="10" />
               <folding />
             </state>
           </provider>
         </entry>
       </file>
-      <file leaf-file-name="TestCase.php" pinned="false" current-in-tab="false">
-        <entry file="file://$PROJECT_DIR$/tests/TestCase.php">
+      <file leaf-file-name="TestPackageCase.php" pinned="false" current-in-tab="false">
+        <entry file="file://$PROJECT_DIR$/packages/jai/Contact/tests/TestPackageCase.php">
           <provider selected="true" editor-type-id="text-editor">
-            <state vertical-scroll-proportion="-1.8518518">
-              <caret line="2" column="70" selection-start-line="2" selection-start-column="70" selection-end-line="2" selection-end-column="70" />
+            <state vertical-scroll-proportion="-2.7777777">
+              <caret line="3" column="40" selection-start-line="3" selection-start-column="40" selection-end-line="3" selection-end-column="40" />
               <folding />
             </state>
           </provider>
@@ -137,7 +137,6 @@
         <option value="$PROJECT_DIR$/packages/jai/Contact/phpunit.xml.dist" />
         <option value="$PROJECT_DIR$/packages/jai/composer.json" />
         <option value="$PROJECT_DIR$/packages/jai/Contact/tests/testCase.php" />
-        <option value="$PROJECT_DIR$/packages/jai/Contact/composer.json" />
         <option value="$PROJECT_DIR$/packages/jai/Contact/phpunit.xml" />
         <option value="$PROJECT_DIR$/packages/jai/Contact/tests/DemoTest.php" />
         <option value="$PROJECT_DIR$/packages/jai/Contact/tests/testPackageCase.php" />
@@ -145,6 +144,8 @@
         <option value="$PROJECT_DIR$/composer.json" />
         <option value="$PROJECT_DIR$/packages/jai/Contact/tests/ContactTest.php" />
         <option value="$PROJECT_DIR$/packages/jai/Contact/src/ContactServiceprovider.php" />
+        <option value="$PROJECT_DIR$/packages/jai/Contact/composer.json" />
+        <option value="$PROJECT_DIR$/readme.md" />
       </list>
     </option>
   </component>
@@ -221,6 +222,10 @@
               <option name="myItemId" value="packages" />
               <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" />
             </PATH_ELEMENT>
+            <PATH_ELEMENT>
+              <option name="myItemId" value="jai" />
+              <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" />
+            </PATH_ELEMENT>
           </PATH>
         </subPane>
       </pane>
@@ -284,11 +289,11 @@
   </component>
   <component name="ToolWindowManager">
     <frame x="0" y="0" width="1280" height="800" extended-state="0" />
-    <editor active="true" />
+    <editor active="false" />
     <layout>
       <window_info id="Remote Host" active="false" anchor="right" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" show_stripe_button="true" weight="0.33" sideWeight="0.5" order="-1" side_tool="false" content_ui="tabs" />
       <window_info id="Gulp" active="false" anchor="left" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" show_stripe_button="true" weight="0.33" sideWeight="0.5" order="-1" side_tool="true" content_ui="tabs" />
-      <window_info id="Project" active="false" anchor="left" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="true" show_stripe_button="true" weight="0.25282714" sideWeight="0.5" order="0" side_tool="false" content_ui="tabs" />
+      <window_info id="Project" active="true" anchor="left" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="true" show_stripe_button="true" weight="0.25282714" sideWeight="0.5" order="0" side_tool="false" content_ui="tabs" />
       <window_info id="TODO" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" show_stripe_button="true" weight="0.33" sideWeight="0.5" order="6" side_tool="false" content_ui="tabs" />
       <window_info id="Event Log" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" show_stripe_button="true" weight="0.33" sideWeight="0.5" order="-1" side_tool="true" content_ui="tabs" />
       <window_info id="Database" active="false" anchor="right" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" show_stripe_button="true" weight="0.33" sideWeight="0.5" order="-1" side_tool="false" content_ui="tabs" />
@@ -316,14 +321,6 @@
     <watches-manager />
   </component>
   <component name="editorHistoryManager">
-    <entry file="file://$PROJECT_DIR$/readme.md">
-      <provider selected="true" editor-type-id="text-editor">
-        <state vertical-scroll-proportion="0.0">
-          <caret line="0" column="0" selection-start-line="0" selection-start-column="0" selection-end-line="0" selection-end-column="0" />
-          <folding />
-        </state>
-      </provider>
-    </entry>
     <entry file="file://$PROJECT_DIR$/artisan">
       <provider selected="true" editor-type-id="text-editor">
         <state vertical-scroll-proportion="0.0">
@@ -476,14 +473,6 @@
         </state>
       </provider>
     </entry>
-    <entry file="file://$PROJECT_DIR$/packages/jai/Contact/phpunit.xml">
-      <provider selected="true" editor-type-id="text-editor">
-        <state vertical-scroll-proportion="-14.814815">
-          <caret line="16" column="10" selection-start-line="16" selection-start-column="10" selection-end-line="16" selection-end-column="10" />
-          <folding />
-        </state>
-      </provider>
-    </entry>
     <entry file="file://$PROJECT_DIR$/tests/TestCase.php">
       <provider selected="true" editor-type-id="text-editor">
         <state vertical-scroll-proportion="-1.8518518">
@@ -524,14 +513,6 @@
         </state>
       </provider>
     </entry>
-    <entry file="file://$PROJECT_DIR$/packages/jai/Contact/src/ContactServiceprovider.php">
-      <provider selected="true" editor-type-id="text-editor">
-        <state vertical-scroll-proportion="-3.7407408">
-          <caret line="53" column="24" selection-start-line="53" selection-start-column="24" selection-end-line="53" selection-end-column="24" />
-          <folding />
-        </state>
-      </provider>
-    </entry>
     <entry file="file://$PROJECT_DIR$/packages/jai/Contact/tests/ContactTest.php">
       <provider selected="true" editor-type-id="text-editor">
         <state vertical-scroll-proportion="-16.666666">
@@ -548,18 +529,42 @@
         </state>
       </provider>
     </entry>
-    <entry file="file://$PROJECT_DIR$/packages/jai/Contact/composer.json">
+    <entry file="file://$PROJECT_DIR$/.env">
+      <provider selected="true" editor-type-id="text-editor">
+        <state vertical-scroll-proportion="0.0">
+          <caret line="0" column="0" selection-start-line="0" selection-start-column="0" selection-end-line="0" selection-end-column="0" />
+          <folding />
+        </state>
+      </provider>
+    </entry>
+    <entry file="file://$PROJECT_DIR$/packages/jai/Contact/phpunit.xml">
       <provider selected="true" editor-type-id="text-editor">
         <state vertical-scroll-proportion="-14.814815">
-          <caret line="16" column="39" selection-start-line="16" selection-start-column="39" selection-end-line="16" selection-end-column="39" />
+          <caret line="16" column="10" selection-start-line="16" selection-start-column="10" selection-end-line="16" selection-end-column="10" />
           <folding />
         </state>
       </provider>
     </entry>
-    <entry file="file://$PROJECT_DIR$/.env">
+    <entry file="file://$PROJECT_DIR$/packages/jai/Contact/composer.json">
       <provider selected="true" editor-type-id="text-editor">
-        <state vertical-scroll-proportion="0.0">
-          <caret line="0" column="0" selection-start-line="0" selection-start-column="0" selection-end-line="0" selection-end-column="0" />
+        <state vertical-scroll-proportion="-12.037037">
+          <caret line="13" column="5" selection-start-line="13" selection-start-column="5" selection-end-line="13" selection-end-column="5" />
+          <folding />
+        </state>
+      </provider>
+    </entry>
+    <entry file="file://$PROJECT_DIR$/readme.md">
+      <provider selected="true" editor-type-id="text-editor">
+        <state vertical-scroll-proportion="-40.77778">
+          <caret line="99" column="147" selection-start-line="99" selection-start-column="147" selection-end-line="99" selection-end-column="147" />
+          <folding />
+        </state>
+      </provider>
+    </entry>
+    <entry file="file://$PROJECT_DIR$/packages/jai/Contact/src/ContactServiceprovider.php">
+      <provider selected="true" editor-type-id="text-editor">
+        <state vertical-scroll-proportion="0.14407988">
+          <caret line="53" column="24" selection-start-line="53" selection-start-column="24" selection-end-line="53" selection-end-column="24" />
           <folding />
         </state>
       </provider>
diff --git a/packages/jai/Contact/composer.json b/packages/jai/Contact/composer.json
index 5fd0b0d..b4d0dbc 100644
--- a/packages/jai/Contact/composer.json
+++ b/packages/jai/Contact/composer.json
@@ -11,10 +11,6 @@
     "require": {},
     "require-dev": {
                 "phpunit/phpunit": "4.8.*"
-    },
-    "autoload-dev": {
-        "classmap": [
-            "tests/testPackageCase.php"
-        ]
     }
+
 }
diff --git a/readme.md b/readme.md
index 7f8816d..fe9c68a 100644
--- a/readme.md
+++ b/readme.md
@@ -1,27 +1,106 @@
-# Laravel PHP Framework
+## Laravel 5 package Development from scratch
 
-[![Build Status](https://travis-ci.org/laravel/framework.svg)](https://travis-ci.org/laravel/framework)
-[![Total Downloads](https://poser.pugx.org/laravel/framework/d/total.svg)](https://packagist.org/packages/laravel/framework)
-[![Latest Stable Version](https://poser.pugx.org/laravel/framework/v/stable.svg)](https://packagist.org/packages/laravel/framework)
-[![Latest Unstable Version](https://poser.pugx.org/laravel/framework/v/unstable.svg)](https://packagist.org/packages/laravel/framework)
-[![License](https://poser.pugx.org/laravel/framework/license.svg)](https://packagist.org/packages/laravel/framework)
+Trying to explain Laravel specific package development in Laravel 5 :+1:
 
-Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable, creative experience to be truly fulfilling. Laravel attempts to take the pain out of development by easing common tasks used in the majority of web projects, such as authentication, routing, sessions, queueing, and caching.
+With the new Laravel 5 - `php artisan workbench` is made redundant.
+And technically Laravel packages should not be tightly coupled with Laravel core, so that make sense.
 
-Laravel is accessible, yet powerful, providing tools needed for large, robust applications. A superb inversion of control container, expressive migration system, and tightly integrated unit testing support give you the tools you need to build any application with which you are tasked.
+But for some who wants to build Laravel specific packages I suppose this will help them to have a quick start.
 
-## Official Documentation
+### Step 1 : Install Laravel
 
-Documentation for the framework can be found on the [Laravel website](http://laravel.com/docs).
+http://laravel.com/docs/5.0#install-laravel
 
-## Contributing
+Note : In my above root i haven't added a .env file. You need to configure this.
+Note : Laravel may require some permissions to be configured: folders within storage and vendor require write access by the web server.
 
-Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](http://laravel.com/docs/contributions).
+#### Step 2 :  Create package folder and service provider
+
+In root directory create a folder called `packages/vendorName/packageName/src`
+e.g. `root/packages/jai/Contact/src`
+
+Now navigate to the `src` folder and create a file for your service provider, e.g. `ContactServiceprovider.php`.
+
+Your service provider should extend ServiceProvider and has to implement the `register` method.
+
+Please look into this [file](https://github.com/jaiwalker/Develop-laravel5-package-/blob/master/packages/jai/Contact/src/ContactServiceprovider.php) for an example.
+
+*If you want you can write `dd("testing");` in the boot function and go to step 3, but if you have copied the service provider file you might want to create views, routes, config and controllers.*
+
+#### Creating Routes
+
+In your `src` folder create a new `Http` folder in which you create your `routes.php` file.
+([example file](https://github.com/jaiwalker/Develop-laravel5-package-/blob/master/packages/jai/Contact/src/Http/routes.php))
+
+#### Creating Controllers
+
+In your `Http` folder create a new directory called `Controllers`. In this folder you can create your controllers.
+([example file](https://github.com/jaiwalker/Develop-laravel5-package-/blob/master/packages/jai/Contact/src/Http/Controllers/ContactController.php))
+
+#### Creating Config
+
+In your `src` folder create a new directory and call it `config`. In it create a new file (e.g. `contact.php`) like this [file](https://github.com/jaiwalker/Develop-laravel5-package-/blob/master/packages/jai/Contact/src/config/contact.php)
+
+Note: if you want to access config - you need to publish first - after doing step 5 you can run `php artisan vendor:publish`. This will push you config file (contact.php => project/config/contact.php) and then you can access config.
+
+#### Creating Views
+
+This is a bit different, in your package folder (e.g. `jai/Contact`) create a new folder call `views`.
+([example file 1](https://github.com/jaiwalker/Develop-laravel5-package-/blob/master/packages/jai/Contact/views/contact.blade.php) [example file 2](https://github.com/jaiwalker/Develop-laravel5-package-/blob/master/packages/jai/Contact/views/template.blade.php))
+
+### Step 3: Add package path in root composer.json
+
+In your root composer.json file `"jai\\Contact\\": "packages/jai/Contact/src/"` under psr-4
+
+```
+    "psr-4": {
+        "App\\": "app/",
+        "Jai\\Contact\\": "packages/jai/contact/src/",
+    }
+```
+
+### Step 4: add service provider in app conifg.
+
+In  your `root/config/app.php` under `providers` add your package service provider to hook your package in.
+
+```
+        'Jai\Contact\ContactServiceProvider',
+```
+
+### Step 5: loading your package
+run `composer dump-autoload` - make sure there are no errors.
+
+all done - now you can access  your package via url - "yourwebsite/contact"
+
+## Update Included testing
+
+There are different ways you can write test  for  your package   Global test  which is writing test in Laravel app ( not in Package ) another way is to write tests in package its self , for Global its pretty straight, I will explain how to setup  Package  test case.
+
+## Create a new  composer.json for  your package
+    - On command line navigate to package folder ("contact")  and run run `composer init` and follow the directions .
+    - Add  phpunit in  your created composer.json file and run `composer install`
+
+    ```
+        "require-dev": {
+                        "phpunit/phpunit": "4.8.*"
+            }
+    ```
+
+## Create a phpunit.xml file in your package dir ("Contact") similar to laravel's phpunit.xml  just  without bootstrap.
+
+
+## Create a dir "tests"  in your Package ( "Contact" )
+
+    - Create common TestPackageCase.php which is very similar to TestCase.php file just with few path changes.
+
+    - Create ContactTest.php  which extends TestPackageCase.php , now TestPackageCase.php is the  common extends files for all tests created in package this allows you create very similarly to laravel's test cases without any major changes.
+
+## Running tests.
+
+On command line Navigate to your package folder ("Contact")  and run  `../../../vendor/bin/phpunit` this should give you phpunit test case results.
+
+DO share this repository if you liked it.
 
-## Security Vulnerabilities
 
-If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell at taylor@laravel.com. All security vulnerabilities will be promptly addressed.
 
-## License
 
-The Laravel framework is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).