Added seeder class to seed sample data for demonstration purposes. Added model factories. Updated readme.

Author: Mario Basic

app/Console/Commands/CreateUser.php

@@ -62,7 +62,9 @@ public function handle()
             'name' => $data['name'],
             'email' => $data['email'],
             'password' => bcrypt($data['password']),
-            'api_token' => bin2hex(openssl_random_pseudo_bytes(16))
+            'api_token' => bin2hex(openssl_random_pseudo_bytes(16)),
+            'email_notifications' =>  true,
+            'preferred_currency' => 'usd'
         ]);
 
         $this->info('User has been created.');

database/factories/ModelFactory.php

@@ -17,5 +17,49 @@
         'email' => $faker->safeEmail,
         'password' => bcrypt(str_random(10)),
         'remember_token' => str_random(10),
+        'api_token' => bin2hex(openssl_random_pseudo_bytes(16)),
+        'email_notifications' => false, //$faker->boolean
+        'preferred_currency' => $faker->randomElement(['hrk', 'usd', 'eur'])
+    ];
+});
+
+$factory->define(App\Category::class, function (Faker\Generator $faker) {
+    return [
+        'name' => $faker->randomElement(['Hosting', 'Maintenance', 'Domain', 'SSL Certificate']),
+    ];
+});
+
+$factory->define(App\Client::class, function (Faker\Generator $faker) {
+    return [
+        'name' => $faker->name,
+        'tax_number' => $faker->randomNumber,
+        'street' => $faker->streetAddress,
+        'city' => $faker->city,
+        'postal_code' => $faker->postcode
+    ];
+});
+
+$factory->define(App\Service::class, function (Faker\Generator $faker) {
+    return [
+        'title' => $faker->sentence(3),
+        'note' => $faker->text(200),
+        'month' => (int) $faker->month,
+        'day' => (int) $faker->dayOfMonth,
+        'cost' => $faker->randomNumber(5),
+        'currency' => $faker->randomElement(['hrk', 'eur', 'usd']),
+        'active' => $faker->boolean,
+        'exchange_rate' => $faker->randomFloat(4, 1, 11),
+        'client_id' => factory(App\Client::class)->create()->id,
+        'category_id' => factory(App\Category::class)->create()->id,
+    ];
+});
+
+$factory->define(App\Occurrence::class, function (Faker\Generator $faker) {
+    return [
+        'occurs_at' => $faker->dateTimeThisYear,
+        'offer_sent' => $faker->boolean,
+        'payment_received' => $faker->boolean,
+        'receipt_sent' => $faker->boolean,
+        'service_id' => factory(App\Service::class)->create()->id
     ];
 });

database/migrations/2016_07_16_212605_create_categories_table.php

@@ -32,8 +32,8 @@ public function up()
     public function down()
     {
         Schema::table('services', function(Blueprint $table) {
-            $table->dropColumn('category_id');
             $table->dropForeign(['category_id']);
+            $table->dropColumn('category_id');
         });
 
         Schema::drop('categories');

database/migrations/2016_07_18_123554_drop_unique_index_for_tax_number_from_clients_table.php

@@ -26,7 +26,7 @@ public function up()
     public function down()
     {
         Schema::table('clients', function (Blueprint $table) {
-            $table->unique('tax_number');
+            // $table->unique('tax_number'); // can cause problems when refreshing db.
         });
     }
 }

database/seeds/DatabaseSeeder.php

@@ -11,6 +11,6 @@ class DatabaseSeeder extends Seeder
      */
     public function run()
     {
-        // $this->call(UsersTableSeeder::class);
+        $this->call(SampleDataSeeder::class);
     }
 }

database/seeds/SampleDataSeeder.php

@@ -0,0 +1,74 @@
+<?php
+
+use Illuminate\Database\Seeder;
+
+/**
+ * Seeds the database with sample data so that the user
+ * can see what the application looks like with data entered.
+ *
+ * 10 clients with 10 services each.
+ * Each service is assigned a category from a pool of categories.
+ */
+class SampleDataSeeder extends Seeder
+{
+    /**
+     * Run the database seeds.
+     *
+     * @return void
+     */
+    public function run()
+    {
+        /**
+         * Just a shortcut for creating occurrences.
+         *
+         * When a service is created we want to trigger a event
+         * `ServiceWasCreated` which then creates an occurrence
+         * for that service.
+         */
+        App\Service::created(function($service) {
+            event(new App\Events\ServiceWasCreated($service));
+        });
+
+        $categories = ['Hosting', 'Maintenance', 'Domain', 'SSL Certificate'];
+
+        array_map(function($category) {
+            return factory(App\Category::class)->create([
+                'name' => $category
+            ]);
+        }, $categories);
+
+        $clients = factory(App\Client::class, 10)->create();
+
+        foreach($clients as $client) {
+            $services = factory(App\Service::class, 10)->create([
+                'client_id' => $client->id,
+                'category_id' => rand(1, count($categories))
+            ]);
+        }
+
+        /**
+         * Sample User for testing purposes:
+         *
+         * email: sample.user@email.com
+         * password: password
+         *
+         */
+        factory(App\User::class)->create([
+            'name' => 'Sample User',
+            'email' => 'sample@user.dev',
+            'password' => bcrypt('password'),
+            'preferred_currency' => 'usd'
+        ]);
+
+        /**
+         * Cleanup
+         *
+         * Because there is a long standing bug in Laravel
+         * with model factories, I need to manually remove extra
+         * records created.
+         */
+        App\Category::has('services', '=', 0)->delete();
+        App\Client::has('services', '=', 0)->delete();
+
+    }
+}

readme.md

@@ -30,6 +30,22 @@ Install by issuing the Composer `create-project` command in your terminal:
 composer create-project --prefer-dist laravelista/kyle
 ```
 
+### Sample data
+
+To populate Kyle with sample data and see how the Overview and Report pages look like, use this command:
+
+```
+php artisan migrate --seed
+```
+
+> Warning! This command will populate the database with a lot of sample data. Use only while testing or if you understand what will happen once this command has triggered.
+
+This will create a sample user with which you can login:
+
+| Email                 | Password |
+|-----------------------|----------|
+| sample@user.dev       | password |
+
 ## Create new user
 
 To create a new user use this command:

resources/assets/js/app.js

@@ -100,7 +100,7 @@ $('#category_id').selectize({
     }
 });
 
-// Categories can be created on-the-fly
+// Clients can be created on-the-fly
 $('#client_id').selectize({
     persist: true,
     create: function (input, callback) {

tests/ExampleTest.php renamed to tests/CategoryTest.php

@@ -4,16 +4,15 @@
 use Illuminate\Foundation\Testing\DatabaseMigrations;
 use Illuminate\Foundation\Testing\DatabaseTransactions;
 
-class ExampleTest extends TestCase
+class CategoryTest extends TestCase
 {
     /**
-     * A basic functional test example.
+     * A basic test example.
      *
      * @return void
      */
-    public function testBasicExample()
+    public function testExample()
     {
-        $this->visit('/')
-             ->see('Kyle');
+        $this->assertTrue(true);
     }
 }

tests/ClientTest.php

@@ -0,0 +1,18 @@
+<?php
+
+use Illuminate\Foundation\Testing\WithoutMiddleware;
+use Illuminate\Foundation\Testing\DatabaseMigrations;
+use Illuminate\Foundation\Testing\DatabaseTransactions;
+
+class ClientTest extends TestCase
+{
+    /**
+     * A basic test example.
+     *
+     * @return void
+     */
+    public function testExample()
+    {
+        $this->assertTrue(true);
+    }
+}

tests/ServiceTest.php

@@ -0,0 +1,18 @@
+<?php
+
+use Illuminate\Foundation\Testing\WithoutMiddleware;
+use Illuminate\Foundation\Testing\DatabaseMigrations;
+use Illuminate\Foundation\Testing\DatabaseTransactions;
+
+class ServiceTest extends TestCase
+{
+    /**
+     * A basic test example.
+     *
+     * @return void
+     */
+    public function testExample()
+    {
+        $this->assertTrue(true);
+    }
+}