Merge pull request #23 from ipvalverde/fix-observable-collection-bug

Fixes #21 for ObservableCollection properties

Author: ipvalverde

src/EPPlus.DataExtractor.Tests/ExpressionHelperTests.cs

@@ -0,0 +1,55 @@
+using System;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using System.Linq.Expressions;
+using System.Text;
+using Xunit;
+
+namespace EPPlus.DataExtractor.Tests
+{
+    public class ExpressionHelperTests
+    {
+        class ModelWithObservableCollection
+        {
+            public ObservableCollection<string> CollectionProp { get; set; }
+        }
+
+        [Fact]
+        public void ValidatePropertyExpressionType_WithIncompatiblePropertyType_ShouldFail()
+        {
+            var collectionPropExpression = GetExpression<ModelWithObservableCollection, string>(m => m.CollectionProp);
+
+            Assert.Throws<ArgumentException>(() =>
+                ExpressionExtensions.ValidatePropertyExpressionType<ModelWithObservableCollection, string, Collection<string>>(collectionPropExpression));
+        }
+
+        class ModelWithCollection
+        {
+            public Collection<string> CollectionProp { get; set; }
+        }
+
+        [Fact]
+        public void ValidatePropertyExpressionType_WithSameCollectionPropertyType()
+        {
+            var collectionPropExpression = GetExpression<ModelWithCollection, string>(m => m.CollectionProp);
+
+            ExpressionExtensions.ValidatePropertyExpressionType<ModelWithCollection, string, Collection<string>>(collectionPropExpression);
+        }
+
+        class ModelWithList
+        {
+            public List<string> CollectionProp { get; set; }
+        }
+
+        [Fact]
+        public void ValidatePropertyExpressionType_WithSameListPropertyType()
+        {
+            var collectionPropExpression = GetExpression<ModelWithList, string>(m => m.CollectionProp);
+
+            ExpressionExtensions.ValidatePropertyExpressionType<ModelWithList, string, List<string>>(collectionPropExpression);
+        }
+
+        private static Expression<Func<TModel, Collection<TItem>>> GetExpression<TModel, TItem>(Expression<Func<TModel, Collection<TItem>>> property) => property;
+        private static Expression<Func<TModel, List<TItem>>> GetExpression<TModel, TItem>(Expression<Func<TModel, List<TItem>>> property) => property;
+    }
+}

src/EPPlus.DataExtractor.Tests/WorksheetExtensionsTests.cs

@@ -1,6 +1,7 @@
 using OfficeOpenXml;
 using System;
 using System.Collections.Generic;
+using System.Collections.ObjectModel;
 using System.IO;
 using System.Linq;
 using Xunit;
@@ -276,7 +277,7 @@ public void ExtractDataTransformingColumnsIntoRows_WithICollectionPropertyNotIni
                     .Extract<RowDataWithColumnBeingRowWithUninitializedICollection>()
                     .WithProperty(p => p.Name, "F")
                     .WithProperty(p => p.Age, "G")
-                    .WithCollectionProperty(p => p.MoneyData,
+                    .WithInitializedCollectionProperty(p => p.MoneyData,
                         item => item.Date, 1,
                         item => item.ReceivedMoney, "H", "S")
                     .GetData(2, 4);
@@ -295,7 +296,7 @@ public void ExtractDataTransformingColumnsIntoRows_WithICollectionProperty()
                     .Extract<RowDataWithColumnBeingRowWithInitializedICollection>()
                     .WithProperty(p => p.Name, "F")
                     .WithProperty(p => p.Age, "G")
-                    .WithCollectionProperty(p => p.MoneyData,
+                    .WithInitializedCollectionProperty(p => p.MoneyData,
                         item => item.Date, 1,
                         item => item.ReceivedMoney, "H", "S")
                     .GetData(2, 4)
@@ -449,7 +450,7 @@ public void ExtractDataTransformingAGroupOfColumnsIntoRows_WithICollectionProper
                     .Extract<CarDealerBranch.CarDealerBranchRevenueWithICollection>()
                     .WithProperty(p => p.BranchName, "A")
                     .WithProperty(p => p.BranchLocation, "B")
-                    .WithCollectionProperty(p => p.RevenueByMonth,
+                    .WithInitializedCollectionProperty(p => p.RevenueByMonth,
                         1,
                         "C",
                         cfg => cfg
@@ -496,7 +497,7 @@ public void ExtractDataTransformingAGroupOfColumnsIntoRows_WithICollectionProper
                     .Extract<CarDealerBranch.CarDealerBranchRevenueWithUninitializedICollection>()
                     .WithProperty(p => p.BranchName, "A")
                     .WithProperty(p => p.BranchLocation, "B")
-                    .WithCollectionProperty(p => p.RevenueByMonth,
+                    .WithInitializedCollectionProperty(p => p.RevenueByMonth,
                         1,
                         "C",
                         cfg => cfg
@@ -556,7 +557,7 @@ public void ExtractSimpleDataCollection_WithICollectionProperty()
                     .Extract<MultiLingualUserDataWithICollection>()
                     .WithProperty(p => p.FirstName, "B")
                     .WithProperty(p => p.LastName, "A")
-                    .WithCollectionProperty(x => x.LanguagesSpoken, "C", "E")
+                    .WithInitializedCollectionProperty(x => x.LanguagesSpoken, "C", "E")
                     // Read from row 2 to 4
                     .GetData(2, 4)
                     .ToList();
@@ -592,12 +593,75 @@ public void ExtractSimpleDataCollection_WithICollectionPropertyNotInitialized_Sh
                     .Extract<MultiLingualUserDataWithUnintializedICollection>()
                     .WithProperty(p => p.FirstName, "B")
                     .WithProperty(p => p.LastName, "A")
-                    .WithCollectionProperty(x => x.LanguagesSpoken, "C", "E")
+                    .WithInitializedCollectionProperty(x => x.LanguagesSpoken, "C", "E")
                     // Read from row 2 to 4
                     .GetData(2, 4);
 
                 Assert.Throws<InvalidOperationException>(() => dataEnumerable.ToList());
             }
         }
+
+        public class MultiLingualUserDataWithObservableCollection :
+            BaseMultiLingualUserData<ObservableCollection<string>>
+        {
+            public MultiLingualUserDataWithObservableCollection()
+            {
+                this.LanguagesSpoken = new ObservableCollection<string>();
+            }
+        }
+
+        [Fact]
+        public void ExtractSimpleDataCollection_WithObservableCollectionPropertyInCollectionOverload_ShouldFail()
+        {
+            var fileInfo = GetSpreadsheetFileInfo();
+            using (var package = new ExcelPackage(fileInfo))
+            {
+                var worksheet = package.Workbook.Worksheets["StringsCollectionWorksheet"];
+
+                var dataExtractorSetup = worksheet
+                    .Extract<MultiLingualUserDataWithObservableCollection>()
+                    .WithProperty(p => p.FirstName, "B")
+                    .WithProperty(p => p.LastName, "A");
+
+                Assert.Throws<ArgumentException>(() =>
+                    dataExtractorSetup.WithCollectionProperty(p => p.LanguagesSpoken, "C", "E"));
+            }
+        }
+
+        [Fact]
+        public void ExtractSimpleDataCollection_WithObservableCollectionProperty()
+        {
+            var fileInfo = GetSpreadsheetFileInfo();
+            using (var package = new ExcelPackage(fileInfo))
+            {
+                var worksheet = package.Workbook.Worksheets["StringsCollectionWorksheet"];
+
+                var items = worksheet
+                    .Extract<MultiLingualUserDataWithObservableCollection>()
+                    .WithProperty(p => p.FirstName, "B")
+                    .WithProperty(p => p.LastName, "A")
+                    .WithInitializedCollectionProperty(x => x.LanguagesSpoken, "C", "E")
+                    // Read from row 2 to 4
+                    .GetData(2, 4)
+                    .ToList();
+
+                // 3 rows should be read.
+                Assert.Equal(3, items.Count);
+
+                // First record should have 2 languages
+                Assert.Equal(2, items[0].LanguagesSpoken.Count);
+                Assert.Contains("Spanish", items[0].LanguagesSpoken);
+                Assert.Contains("Romanian", items[0].LanguagesSpoken);
+
+                // Second record should have 3 languages
+                Assert.Equal(3, items[1].LanguagesSpoken.Count);
+                Assert.Contains("English", items[1].LanguagesSpoken);
+                Assert.Contains("Latin", items[1].LanguagesSpoken);
+                Assert.Contains("Mandarin", items[1].LanguagesSpoken);
+
+                // Third record should have no languages
+                Assert.Empty(items[2].LanguagesSpoken);
+            }
+        }
     }
 }