Merge pull request #190 from dolanmiu/feat/more-tests

Introduce some functional programming techniques
dolanmiu · Nov 2, 2018 · 401ef73 · 401ef73
2 parents 40d6a41 + 1813451
commit 401ef73
Show file tree

Hide file tree

Showing 108 changed files with 749 additions and 659 deletions.
diff --git a/.nycrc b/.nycrc
@@ -1,9 +1,9 @@
 {
   "check-coverage": true,
-  "lines": 87.39,
-  "functions": 83.54,
-  "branches": 71.95,
-  "statements": 87.17,
+  "lines": 87.54,
+  "functions": 83.61,
+  "branches": 72.57,
+  "statements": 87.32,
   "include": [
     "src/**/*.ts"
   ],

diff --git a/package.json b/package.json
@@ -81,6 +81,7 @@
     "sinon": "^5.0.7",
     "ts-node": "^7.0.1",
     "tslint": "^5.11.0",
+    "tslint-immutable": "^4.9.0",
     "typedoc": "^0.11.1",
     "typescript": "2.9.2",
     "webpack": "^3.10.0"

diff --git a/src/export/packer/next-compiler.ts b/src/export/packer/next-compiler.ts
@@ -5,25 +5,25 @@ import { File } from "file";
 import { Formatter } from "../formatter";
 
 interface IXmlifyedFile {
-    data: string;
-    path: string;
+    readonly data: string;
+    readonly path: string;
 }
 
 interface IXmlifyedFileMapping {
-    Document: IXmlifyedFile;
-    Styles: IXmlifyedFile;
-    Properties: IXmlifyedFile;
-    Numbering: IXmlifyedFile;
-    Relationships: IXmlifyedFile;
-    FileRelationships: IXmlifyedFile;
-    Headers: IXmlifyedFile[];
-    Footers: IXmlifyedFile[];
-    HeaderRelationships: IXmlifyedFile[];
-    FooterRelationships: IXmlifyedFile[];
-    ContentTypes: IXmlifyedFile;
-    AppProperties: IXmlifyedFile;
-    FootNotes: IXmlifyedFile;
-    Settings: IXmlifyedFile;
+    readonly Document: IXmlifyedFile;
+    readonly Styles: IXmlifyedFile;
+    readonly Properties: IXmlifyedFile;
+    readonly Numbering: IXmlifyedFile;
+    readonly Relationships: IXmlifyedFile;
+    readonly FileRelationships: IXmlifyedFile;
+    readonly Headers: IXmlifyedFile[];
+    readonly Footers: IXmlifyedFile[];
+    readonly HeaderRelationships: IXmlifyedFile[];
+    readonly FooterRelationships: IXmlifyedFile[];
+    readonly ContentTypes: IXmlifyedFile;
+    readonly AppProperties: IXmlifyedFile;
+    readonly FootNotes: IXmlifyedFile;
+    readonly Settings: IXmlifyedFile;
 }
 
 export class Compiler {

diff --git a/src/file/app-properties/app-properties-attributes.ts b/src/file/app-properties/app-properties-attributes.ts
@@ -1,12 +1,12 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IAppPropertiesAttributes {
-    xmlns: string;
-    vt: string;
+    readonly xmlns: string;
+    readonly vt: string;
 }
 
 export class AppPropertiesAttributes extends XmlAttributeComponent<IAppPropertiesAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         xmlns: "xmlns",
         vt: "xmlns:vt",
     };

diff --git a/src/file/content-types/content-types-attributes.ts b/src/file/content-types/content-types-attributes.ts
@@ -1,11 +1,11 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IContentTypeAttributes {
-    xmlns?: string;
+    readonly xmlns?: string;
 }
 
 export class ContentTypeAttributes extends XmlAttributeComponent<IContentTypeAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         xmlns: "xmlns",
     };
 }
diff --git a/src/file/content-types/default/default-attributes.ts b/src/file/content-types/default/default-attributes.ts
@@ -1,12 +1,12 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IDefaultAttributes {
-    contentType: string;
-    extension?: string;
+    readonly contentType: string;
+    readonly extension?: string;
 }
 
 export class DefaultAttributes extends XmlAttributeComponent<IDefaultAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         contentType: "ContentType",
         extension: "Extension",
     };

diff --git a/src/file/content-types/override/override-attributes.ts b/src/file/content-types/override/override-attributes.ts
@@ -1,12 +1,12 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IOverrideAttributes {
-    contentType: string;
-    partName?: string;
+    readonly contentType: string;
+    readonly partName?: string;
 }
 
 export class OverrideAttributes extends XmlAttributeComponent<IOverrideAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         contentType: "ContentType",
         partName: "PartName",
     };

diff --git a/src/file/core-properties/properties.ts b/src/file/core-properties/properties.ts
@@ -3,14 +3,14 @@ import { DocumentAttributes } from "../document/document-attributes";
 import { Created, Creator, Description, Keywords, LastModifiedBy, Modified, Revision, Subject, Title } from "./components";
 
 export interface IPropertiesOptions {
-    title?: string;
-    subject?: string;
-    creator?: string;
-    keywords?: string;
-    description?: string;
-    lastModifiedBy?: string;
-    revision?: string;
-    externalStyles?: string;
+    readonly title?: string;
+    readonly subject?: string;
+    readonly creator?: string;
+    readonly keywords?: string;
+    readonly description?: string;
+    readonly lastModifiedBy?: string;
+    readonly revision?: string;
+    readonly externalStyles?: string;
 }
 
 export class CoreProperties extends XmlComponent {

diff --git a/src/file/document/body/section-properties/columns/columns-attributes.ts b/src/file/document/body/section-properties/columns/columns-attributes.ts
@@ -1,11 +1,11 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IColumnsAttributes {
-    space?: number;
+    readonly space?: number;
 }
 
 export class ColumnsAttributes extends XmlAttributeComponent<IColumnsAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         space: "w:space",
     };
 }
diff --git a/src/file/document/body/section-properties/doc-grid/doc-grid-attributes.ts b/src/file/document/body/section-properties/doc-grid/doc-grid-attributes.ts
@@ -1,11 +1,11 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IDocGridAttributesProperties {
-    linePitch?: number;
+    readonly linePitch?: number;
 }
 
 export class DocGridAttributes extends XmlAttributeComponent<IDocGridAttributesProperties> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         linePitch: "w:linePitch",
     };
 }
diff --git a/src/file/document/body/section-properties/footer-reference/footer-reference-attributes.ts b/src/file/document/body/section-properties/footer-reference/footer-reference-attributes.ts
@@ -7,12 +7,12 @@ export enum FooterReferenceType {
 }
 
 export interface IFooterReferenceAttributes {
-    type: string;
-    id: string;
+    readonly type: string;
+    readonly id: string;
 }
 
 export class FooterReferenceAttributes extends XmlAttributeComponent<IFooterReferenceAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         type: "w:type",
         id: "r:id",
     };

diff --git a/src/file/document/body/section-properties/footer-reference/footer-reference.ts b/src/file/document/body/section-properties/footer-reference/footer-reference.ts
@@ -2,8 +2,8 @@ import { XmlComponent } from "file/xml-components";
 import { FooterReferenceAttributes, FooterReferenceType } from "./footer-reference-attributes";
 
 export interface IFooterOptions {
-    footerType?: FooterReferenceType;
-    footerId?: number;
+    readonly footerType?: FooterReferenceType;
+    readonly footerId?: number;
 }
 
 export class FooterReference extends XmlComponent {

diff --git a/src/file/document/body/section-properties/header-reference/header-reference-attributes.ts b/src/file/document/body/section-properties/header-reference/header-reference-attributes.ts
@@ -7,12 +7,12 @@ export enum HeaderReferenceType {
 }
 
 export interface IHeaderReferenceAttributes {
-    type: string;
-    id: string;
+    readonly type: string;
+    readonly id: string;
 }
 
 export class HeaderReferenceAttributes extends XmlAttributeComponent<IHeaderReferenceAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         type: "w:type",
         id: "r:id",
     };

diff --git a/src/file/document/body/section-properties/header-reference/header-reference.ts b/src/file/document/body/section-properties/header-reference/header-reference.ts
@@ -2,8 +2,8 @@ import { XmlComponent } from "file/xml-components";
 import { HeaderReferenceAttributes, HeaderReferenceType } from "./header-reference-attributes";
 
 export interface IHeaderOptions {
-    headerType?: HeaderReferenceType;
-    headerId?: number;
+    readonly headerType?: HeaderReferenceType;
+    readonly headerId?: number;
 }
 
 export class HeaderReference extends XmlComponent {

diff --git a/src/file/document/body/section-properties/page-border/page-borders.ts b/src/file/document/body/section-properties/page-border/page-borders.ts
@@ -19,28 +19,28 @@ export enum PageBorderZOrder {
 }
 
 export interface IPageBorderAttributes {
-    display?: PageBorderDisplay;
-    offsetFrom?: PageBorderOffsetFrom;
-    zOrder?: PageBorderZOrder;
+    readonly display?: PageBorderDisplay;
+    readonly offsetFrom?: PageBorderOffsetFrom;
+    readonly zOrder?: PageBorderZOrder;
 }
 
 export interface IPageBorderConfiguration {
-    style?: BorderStyle;
-    size?: number;
-    color?: string;
-    space?: number;
+    readonly style?: BorderStyle;
+    readonly size?: number;
+    readonly color?: string;
+    readonly space?: number;
 }
 
 export interface IPageBordersOptions {
-    pageBorders?: IPageBorderAttributes;
-    pageBorderTop?: IPageBorderConfiguration;
-    pageBorderRight?: IPageBorderConfiguration;
-    pageBorderBottom?: IPageBorderConfiguration;
-    pageBorderLeft?: IPageBorderConfiguration;
+    readonly pageBorders?: IPageBorderAttributes;
+    readonly pageBorderTop?: IPageBorderConfiguration;
+    readonly pageBorderRight?: IPageBorderConfiguration;
+    readonly pageBorderBottom?: IPageBorderConfiguration;
+    readonly pageBorderLeft?: IPageBorderConfiguration;
 }
 
 class PageBordeAttributes extends XmlAttributeComponent<IPageBorderConfiguration> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         style: "w:val",
         size: "w:size",
         color: "w:color",
@@ -57,7 +57,7 @@ class PageBorder extends XmlComponent {
 }
 
 class PageBordersAttributes extends XmlAttributeComponent<IPageBorderAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         display: "w:display",
         offsetFrom: "w:offsetFrom",
         zOrder: "w:zOrder",

diff --git a/src/file/document/body/section-properties/page-margin/page-margin-attributes.ts b/src/file/document/body/section-properties/page-margin/page-margin-attributes.ts
@@ -1,18 +1,18 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IPageMarginAttributes {
-    top?: number;
-    right?: number;
-    bottom?: number;
-    left?: number;
-    header?: number;
-    footer?: number;
-    gutter?: number;
-    mirror?: boolean;
+    readonly top?: number;
+    readonly right?: number;
+    readonly bottom?: number;
+    readonly left?: number;
+    readonly header?: number;
+    readonly footer?: number;
+    readonly gutter?: number;
+    readonly mirror?: boolean;
 }
 
 export class PageMarginAttributes extends XmlAttributeComponent<IPageMarginAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         top: "w:top",
         right: "w:right",
         bottom: "w:bottom",

diff --git a/src/file/document/body/section-properties/page-number/page-number.ts b/src/file/document/body/section-properties/page-number/page-number.ts
@@ -17,12 +17,12 @@ export enum PageNumberFormat {
 }
 
 export interface IPageNumberTypeAttributes {
-    pageNumberStart?: number;
-    pageNumberFormatType?: PageNumberFormat;
+    readonly pageNumberStart?: number;
+    readonly pageNumberFormatType?: PageNumberFormat;
 }
 
 export class PageNumberTypeAttributes extends XmlAttributeComponent<IPageNumberTypeAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         pageNumberStart: "w:start",
         pageNumberFormatType: "w:fmt",
     };

diff --git a/src/file/document/body/section-properties/page-size/page-size-attributes.ts b/src/file/document/body/section-properties/page-size/page-size-attributes.ts
@@ -6,13 +6,13 @@ export enum PageOrientation {
 }
 
 export interface IPageSizeAttributes {
-    width?: number;
-    height?: number;
-    orientation?: PageOrientation;
+    readonly width?: number;
+    readonly height?: number;
+    readonly orientation?: PageOrientation;
 }
 
 export class PageSizeAttributes extends XmlAttributeComponent<IPageSizeAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         width: "w:w",
         height: "w:h",
         orientation: "w:orient",

diff --git a/src/file/document/body/section-properties/section-properties.ts b/src/file/document/body/section-properties/section-properties.ts
@@ -20,21 +20,21 @@ import { IPageSizeAttributes, PageOrientation } from "./page-size/page-size-attr
 import { TitlePage } from "./title-page/title-page";
 
 export interface IHeaderFooterGroup<T> {
-    default?: T;
-    first?: T;
-    even?: T;
+    readonly default?: T;
+    readonly first?: T;
+    readonly even?: T;
 }
 
 interface IHeadersOptions {
-    headers?: IHeaderFooterGroup<HeaderWrapper>;
+    readonly headers?: IHeaderFooterGroup<HeaderWrapper>;
 }
 
 interface IFootersOptions {
-    footers?: IHeaderFooterGroup<FooterWrapper>;
+    readonly footers?: IHeaderFooterGroup<FooterWrapper>;
 }
 
 interface ITitlePageOptions {
-    titlePage?: boolean;
+    readonly titlePage?: boolean;
 }
 
 export type SectionPropertiesOptions = IPageSizeAttributes &

diff --git a/src/file/document/body/section-properties/title-page/title-page-attributes.ts b/src/file/document/body/section-properties/title-page/title-page-attributes.ts
@@ -1,11 +1,11 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IHeaderReferenceAttributes {
-    value: string;
+    readonly value: string;
 }
 
 export class TitlePageAttributes extends XmlAttributeComponent<IHeaderReferenceAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         value: "w:val",
     };
 }