feat: add helper methods to quickly get custom attribute values from models

Author: ahinkle

src/Models/MagentoProduct.php

@@ -3,6 +3,7 @@
 namespace Grayloon\Magento\Models;
 
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Facades\Storage;
 
 class MagentoProduct extends Model
 {
@@ -63,4 +64,33 @@ public function categories()
     {
         return $this->hasManyThrough(MagentoCategory::class, MagentoProductCategory::class, 'magento_product_id', 'id');
     }
+
+    /**
+     * Helper to quickly get a value from a custom attribute.
+     *
+     * @param  string  $key
+     * @return mixed
+     */
+    public function customAttributeValue($key)
+    {
+        $attribute = $this->customAttributes->where('attribute_type', $key)->first();
+
+        return $attribute ? $attribute->value : null;
+    }
+
+    /**
+     * Helper to easily get the product image.
+     *
+     * @return null|string
+     */
+    public function productImage($key)
+    {
+        $attribute = $this->customAttributes->where('attribute_type', 'image')->first();
+
+        if (Storage::exists('public/product/'. $attribute->value)) {
+            return 'product/'. $attribute->value;
+        }
+
+        return null;
+    }
 }

tests/Models/MagentoProductModelTest.php

@@ -96,4 +96,32 @@ public function test_magento_product_can_get_categories()
         $this->assertNotEmpty($categories);
         $this->assertEquals(10, $categories->count());
     }
+
+    public function test_custom_attribute_value_helper_returns_value_of_custom_attribute()
+    {
+        $product = factory(MagentoProduct::class)->create();
+
+        factory(MagentoCustomAttribute::class)->create([
+            'attributable_type'   => MagentoProduct::class,
+            'attributable_id'     => $product->id,
+            'attribute_type'      => 'foo',
+            'value'               => 'bar',
+        ]);
+
+        $product = $product->with('customAttributes')->first();
+
+        $this->assertEquals(1, $product->customAttributes()->count());
+        $this->assertEquals('bar', $product->customAttributeValue('foo'));
+    }
+
+
+    public function test_custom_attribute_value_helper_returns_null_of_invalid_custom_attribute()
+    {
+        $product = factory(MagentoProduct::class)->create();
+
+        $product = $product->with('customAttributes')->first();
+
+        $this->assertEquals(0, $product->customAttributes()->count());
+        $this->assertNull($product->customAttributeValue('foo'));
+    }
 }