Skip to content

Commit

Permalink
Change @ReadCell annotation and @ReadColumn annotations to omit the R…
Browse files Browse the repository at this point in the history
…ead prefix
  • Loading branch information
wjsrobertson committed Jul 5, 2016
1 parent ba924bb commit f545c63
Show file tree
Hide file tree
Showing 15 changed files with 55 additions and 59 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@

import org.junit.Rule;
import org.junit.Test;
import org.unitsheet.annotations.ReadCell;
import org.unitsheet.annotations.ReadColumn;
import org.unitsheet.annotations.Column;
import org.unitsheet.annotations.Workbook;
import org.unitsheet.junit.SpreadsheetRule;

Expand All @@ -14,12 +13,12 @@
import static org.unitsheet.utils.Collections.listOf;

@Workbook("classpath:spreadsheets/SumOfColumn.ods")
public class SpreadsheetRuleReadColumnTest {
public class SpreadsheetRuleColumnTest {

@Rule
public SpreadsheetRule spreadsheetRule = new SpreadsheetRule();

@ReadColumn(from = "B2", to = "B6")
@Column(from = "B2", to = "B6")
private List<Integer> listOfNumbers;

@Test
Expand Down
4 changes: 2 additions & 2 deletions all/src/test/java/org/unitsheet/SpreadsheetRuleTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import org.junit.Rule;
import org.junit.Test;
import org.unitsheet.annotations.ReadCell;
import org.unitsheet.annotations.Cell;
import org.unitsheet.annotations.Workbook;
import org.unitsheet.junit.SpreadsheetRule;

Expand All @@ -14,7 +14,7 @@ public class SpreadsheetRuleTest {
@Rule
public SpreadsheetRule spreadsheetRule = new SpreadsheetRule();

@ReadCell("C2")
@Cell("C2")
private long privateStringField = 0l;

@Test
Expand Down
10 changes: 5 additions & 5 deletions all/src/test/java/org/unitsheet/SpreadsheetRunnerTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

import org.junit.Test;
import org.junit.runner.RunWith;
import org.unitsheet.annotations.ForceWorkbookType;
import org.unitsheet.annotations.ReadCell;
import org.unitsheet.annotations.Cell;
import org.unitsheet.annotations.WorkbookType;
import org.unitsheet.annotations.Workbook;
import org.unitsheet.junit.SpreadsheetRunner;
import org.unitsheet.poi.XlsType;
Expand All @@ -12,10 +12,10 @@

@RunWith(SpreadsheetRunner.class)
@Workbook("classpath:spreadsheets/AverageOfTwoIntegers.xls")
@ForceWorkbookType(XlsType.class)
@WorkbookType(XlsType.class)
public class SpreadsheetRunnerTest {

@ReadCell("C2")
@Cell("C2")
private long privateStringField = 50L;

@Test
Expand All @@ -24,7 +24,7 @@ public void testField() {
}

@Test
public void testParameters(@ReadCell("C2") long param1, @ReadCell("C2") long param2) {
public void testParameters(@Cell("C2") long param1, @Cell("C2") long param2) {
assertEquals(100L, param1);
assertEquals(100L, param2);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.PARAMETER})
public @interface ReadCell {
public @interface Cell {

String sheet() default "";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.PARAMETER})
public @interface ReadColumn {
public @interface Column {
String sheet() default "";

String from() default "";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import org.unitsheet.api.adapter.WorksheetType;

public @interface ForceWorkbookType {
public @interface WorkbookType {

Class<? extends WorksheetType> value();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ private void validateTestMethodArguments(List<Throwable> errors) {
Method method = frameworkMethod.getMethod();
boolean hasValidArguments = getTestMethodArgumentValidator().hasValidArguments(method);
if (!hasValidArguments) {
String msg = "Method " + frameworkMethod.getName() + " has parameters without @ReadCell or @ReadColumn";
String msg = "Method " + frameworkMethod.getName() + " has parameters without @Cell or @Column";
errors.add(new Exception(msg));
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
package org.unitsheet.reflection;

import org.unitsheet.annotations.ReadCell;
import org.unitsheet.annotations.Cell;
import org.unitsheet.api.adapter.CellInfo;
import org.unitsheet.api.adapter.SpreadsheetAdapter;
import org.unitsheet.types.ObjectConverter;

public class ReadCellValueResolver implements ValueResolver<ReadCell> {
public class ReadCellValueResolver implements ValueResolver<Cell> {

private final ObjectConverter objectConverter;

Expand All @@ -15,21 +15,21 @@ public ReadCellValueResolver(ObjectConverter objectConverter) {

@Override
public Class<?> getAnnotationType() {
return ReadCell.class;
return Cell.class;
}

@Override
public Object resolveValue(ReadCell annotation, Class<?> destType, SpreadsheetAdapter spreadsheet) {
public Object resolveValue(Cell annotation, Class<?> destType, SpreadsheetAdapter spreadsheet) {
Object cellValue = getRawCellValue(annotation, spreadsheet);
return objectConverter.convertType(cellValue, destType);
}

private Object getRawCellValue(ReadCell annotation, SpreadsheetAdapter spreadsheet) {
private Object getRawCellValue(Cell annotation, SpreadsheetAdapter spreadsheet) {
CellInfo cellInfo = convertToCellInfo(annotation);
return spreadsheet.getCellValue(cellInfo);
}

private CellInfo convertToCellInfo(ReadCell annotation) {
private CellInfo convertToCellInfo(Cell annotation) {
String cellName = annotation.value();
String sheetName = annotation.sheet();

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package org.unitsheet.reflection;

import org.unitsheet.annotations.ReadColumn;
import org.unitsheet.annotations.Column;
import org.unitsheet.api.adapter.CellInfo;
import org.unitsheet.api.adapter.ColumnInfo;
import org.unitsheet.api.adapter.SpreadsheetAdapter;
Expand All @@ -9,7 +9,7 @@
import java.util.ArrayList;
import java.util.List;

public class ReadColumnValueResolver implements ValueResolver<ReadColumn> {
public class ReadColumnValueResolver implements ValueResolver<Column> {

private final ObjectConverter objectConverter;

Expand All @@ -19,16 +19,16 @@ public ReadColumnValueResolver(ObjectConverter objectConverter) {

@Override
public Class<?> getAnnotationType() {
return ReadColumn.class;
return Column.class;
}

@Override
public Object resolveValue(ReadColumn annotation, Class<?> destType, SpreadsheetAdapter spreadsheet) {
public Object resolveValue(Column annotation, Class<?> destType, SpreadsheetAdapter spreadsheet) {
List<Object> column = getRawValues(annotation, spreadsheet);
return convertToDestType(destType, column);
}

private List<Object> getRawValues(ReadColumn annotation, SpreadsheetAdapter spreadsheet) {
private List<Object> getRawValues(Column annotation, SpreadsheetAdapter spreadsheet) {
ColumnInfo columnInfo = convertToColumnInfo(annotation);
return spreadsheet.getColumn(columnInfo);
}
Expand All @@ -43,7 +43,7 @@ private List<Object> convertToDestType(Class<?> destType, List<Object> column) {
return results;
}

private ColumnInfo convertToColumnInfo(ReadColumn annotation) {
private ColumnInfo convertToColumnInfo(Column annotation) {
String sheetName = annotation.sheet();
String from = annotation.from();
String to = annotation.to();
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package org.unitsheet.reflection;

import org.unitsheet.annotations.ReadCell;
import org.unitsheet.annotations.ReadColumn;
import org.unitsheet.annotations.Cell;
import org.unitsheet.annotations.Column;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
Expand All @@ -12,7 +12,7 @@

public class TestMethodArgumentValidator {

private static final Set<Class<?>> ALLOWED_TYPES = setOf(ReadCell.class, ReadColumn.class);
private static final Set<Class<?>> ALLOWED_TYPES = setOf(Cell.class, Column.class);

public boolean hasValidArguments(Method m) {
boolean valid = true;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,16 @@
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.runners.MockitoJUnitRunner;
import org.unitsheet.annotations.ReadCell;
import org.unitsheet.annotations.Cell;
import org.unitsheet.api.adapter.CellInfo;
import org.unitsheet.api.adapter.SpreadsheetAdapter;
import org.unitsheet.types.ObjectConverter;

import java.lang.reflect.Field;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.when;

@RunWith(MockitoJUnitRunner.class)
public class ReadCellValueResolverTest {
public class CellValueResolverTest {

@Mock
private SpreadsheetAdapter spreadsheet;
Expand All @@ -25,22 +23,22 @@ public class ReadCellValueResolverTest {
private ObjectConverter objectConverter;

@Mock
private ReadCell readCell;
private Cell cell;

@InjectMocks
private ReadCellValueResolver underTest;

@Test
public void checkValueIsResolved() {
/*
given ReadCell referencing cell A1, and happy path SpreadsheetAdapter and ObjectConverter calls
given Cell referencing cell A1, and happy path SpreadsheetAdapter and ObjectConverter calls
*/
when(readCell.value()).thenReturn("A1");
when(cell.value()).thenReturn("A1");
when(spreadsheet.getCellValue(CellInfo.builder().withName("A1").build())).thenReturn("raw_value");
when(objectConverter.convertType("raw_value", String.class)).thenReturn("result");

// when value is resolved
Object value = underTest.resolveValue(readCell, String.class, spreadsheet);
Object value = underTest.resolveValue(cell, String.class, spreadsheet);

// then the value is the String "result"
assertThat(value)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.runners.MockitoJUnitRunner;
import org.unitsheet.annotations.ReadCell;
import org.unitsheet.annotations.ReadColumn;
import org.unitsheet.annotations.Column;
import org.unitsheet.api.adapter.CellInfo;
import org.unitsheet.api.adapter.ColumnInfo;
import org.unitsheet.api.adapter.SpreadsheetAdapter;
Expand All @@ -19,7 +18,7 @@
import static org.unitsheet.utils.Collections.listOf;

@RunWith(MockitoJUnitRunner.class)
public class ReadColumnValueResolverTest {
public class ColumnValueResolverTest {

@Mock
private SpreadsheetAdapter spreadsheet;
Expand All @@ -28,7 +27,7 @@ public class ReadColumnValueResolverTest {
private ObjectConverter objectConverter;

@Mock
private ReadColumn readColumn;
private Column column;

@Mock
private List<Object> list;
Expand All @@ -41,8 +40,8 @@ public void checkValueIsResolved() {
/*
Given a column which has two cells and happy path SpreadsheetAdapter & ObjectConverter
*/
when(readColumn.from()).thenReturn("A1");
when(readColumn.to()).thenReturn("A2");
when(column.from()).thenReturn("A1");
when(column.to()).thenReturn("A2");

List<Object> rawList = listOf("raw1", "raw2");
when(spreadsheet.getColumn(new ColumnInfo(null, createCellInfo("A1"), createCellInfo("A2"))))
Expand All @@ -52,7 +51,7 @@ public void checkValueIsResolved() {
when(objectConverter.convertType("raw2", String.class)).thenReturn("result2");

// when
Object value = underTest.resolveValue(readColumn, String.class, spreadsheet);
Object value = underTest.resolveValue(column, String.class, spreadsheet);

/*
then value is a list containing the Strings "result1" and "result2"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
import org.junit.runner.RunWith;
import org.mockito.InjectMocks;
import org.mockito.runners.MockitoJUnitRunner;
import org.unitsheet.annotations.ReadCell;
import org.unitsheet.annotations.ReadColumn;
import org.unitsheet.annotations.Cell;
import org.unitsheet.annotations.Column;

import java.lang.reflect.Method;
import java.util.List;
Expand All @@ -20,13 +20,13 @@ public class TestMethodArgumentValidatorTest {

static class HasValidCellArgs {
@Test
public void validTestMethod(@ReadCell("A1") int x, @ReadCell("A2") String y) {
public void validTestMethod(@Cell("A1") int x, @Cell("A2") String y) {
}
}

static class HasValidColumnArg {
@Test
public void validTestMethod(@ReadColumn(from="A1", to="B1") List<Integer> x) {
public void validTestMethod(@Column(from="A1", to="B1") List<Integer> x) {
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.runners.MockitoJUnitRunner;
import org.unitsheet.annotations.ReadCell;
import org.unitsheet.annotations.Cell;
import org.unitsheet.api.adapter.SpreadsheetAdapter;


Expand All @@ -28,7 +28,7 @@ public class TestObjectFieldPopulatorTest {
private TestObjectFieldPopulator underTest;

static class SomeClass {
@ReadCell("A1")
@Cell("A1")
public String stringField;
}

Expand All @@ -40,10 +40,10 @@ public void setUp() throws Exception {
@Test
public void checkName() {
/*
given a test object with @ReadCell annotation and a ValueResolver for @ReadCell
given a test object with @Cell annotation and a ValueResolver for @Cell
*/
when(valueResolver.getAnnotationType()).thenReturn(ReadCell.class);
when(valueResolver.resolveValue(isA(ReadCell.class), eq(String.class), eq(spreadsheet)))
when(valueResolver.getAnnotationType()).thenReturn(Cell.class);
when(valueResolver.resolveValue(isA(Cell.class), eq(String.class), eq(spreadsheet)))
.thenReturn("value");
SomeClass testObject = new SomeClass();

Expand Down
10 changes: 5 additions & 5 deletions core/src/test/java/org/unitsheet/test/AnnotatedObject.java
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
package org.unitsheet.test;

import org.unitsheet.annotations.ReadCell;
import org.unitsheet.annotations.Cell;
import org.unitsheet.annotations.Workbook;

@Workbook("C:\\temp\\test.csv")
public class AnnotatedObject {

@ReadCell("private")
@Cell("private")
private String privateStringField = "prvt";

@ReadCell("protected")
@Cell("protected")
protected String protectedStringField = "prtctd";

@ReadCell("default")
@Cell("default")
String defaultStringField = "dflt";

@ReadCell("public")
@Cell("public")
public String publicStringField = "pblc";

}

0 comments on commit f545c63

Please sign in to comment.