refactor: rename utils

BREAKING CHANGE: rename makeBreakpointsMap with
makeBreakpointsModel

.babelrc

@@ -12,7 +12,7 @@
         "alias": {
           "@calculators": "./src/calculators",
           "@convertors": "./src/convertors",
-          "@make-breakpoints-map": "./src/make-breakpoints-map",
+          "@make-breakpoints-model": "./src/make-breakpoints-model",
           "@models": "./src/models",
           "@utils": "./src/utils",
           "@utils-public": "./src/utils-public",

.flowconfig

@@ -1,7 +1,7 @@
  [options]
   esproposal.export_star_as=enable
   module.name_mapper='@convertors' -> '<PROJECT_ROOT>/src/convertors'
-  module.name_mapper='@make-breakpoints-map' -> '<PROJECT_ROOT>/src/make-breakpoints-map'
+  module.name_mapper='@make-breakpoints-model' -> '<PROJECT_ROOT>/src/make-breakpoints-model'
   module.name_mapper='@models' -> '<PROJECT_ROOT>/src/models'
   module.name_mapper='@utils' -> '<PROJECT_ROOT>/src/utils'
   module.name_mapper='@utils-public' -> '<PROJECT_ROOT>/src/utils-public'

CHANGELOG.md

@@ -255,7 +255,7 @@ returns the Maybe type. The associative array is returned
 
 ### Features
 
-* **flow:** add type BreakpointsMap ([0f630b2](https://github.com/typographist/core/commit/0f630b2))
+* **flow:** add type BreakpointsModel ([0f630b2](https://github.com/typographist/core/commit/0f630b2))
 
 # [6.0.0](https://github.com/typographist/core/compare/v5.1.2...v6.0.0) (2019-01-23)
 

jsconfig.json

@@ -6,7 +6,7 @@
     "paths": {
       "@calculators/*": ["./calculators/*"],
       "@convertors/*": ["./convertors/*"],
-      "@make-breakpoints-map/*": ["./make-breakpoints-map/*"],
+      "@make-breakpoints-model/*": ["./make-breakpoints-model/*"],
       "@models/*": ["./models/*"],
       "@utils/*": ["./utils/*"],
       "@utils-public/*": ["./utils-public/*"],

src/constants.js

@@ -1,5 +1,5 @@
 // @flow
-import type { UserConfig, Breakpoint, BreakpointsMap } from '@models';
+import type { UserConfig, Breakpoint, BreakpointsModel } from '@models';
 
 export const HALF = 0.5;
 export const BROWSER_VIEWPORT_WIDTH = '100vw';
@@ -21,7 +21,7 @@ export const DEFAULT_CONFIG: UserConfig = {
   ratio: 1.333,
 };
 
-export const DEFAULT_BREAK_MAP: BreakpointsMap = {
+export const DEFAULT_BREAK_MAP: BreakpointsModel = {
   default: {
     base: [16],
     lineHeight: 1.5,

src/index.js

@@ -1,6 +1,6 @@
 // @flow
 
-export { makeBreakpointsMap } from '@make-breakpoints-map';
+export { makeBreakpointsModel } from '@make-breakpoints-model';
 export * as constants from '@constants';
 export { percentage } from '@convertors/percentage';
 export { toEm } from '@convertors/to-em';
@@ -13,13 +13,13 @@ export { toCebabCase } from '@utils-public/to-cebab-case';
 export { toRem } from '@utils-public/to-rem';
 export { toSnakeCase } from '@utils-public/to-snake-case';
 export {
-  getBreaksWithoutDefault,
-  getBreakNames,
+  getTailBreaksValues,
+  getTailBreaksNames,
   makeBreakNamesRow,
   makeBreakpoints,
   getDefaultBreak,
 } from '@utils-public/breakpoints';
-export type { BreakpointsMap, Breakpoint } from '@models/breakpoints';
+export type { BreakpointsModel, Breakpoint } from '@models/breakpoints';
 export type { UserConfig } from '@models/user-config';
 
 export const ratios = {

src/make-breakpoints-map/index.js → src/make-breakpoints-model/index.js

@@ -3,15 +3,15 @@
 import memoizeone from 'memoize-one';
 import { validateUserConfig } from '@validate-user-config';
 import { type UserConfig } from '@models/user-config';
-import { type BreakpointsMap } from '@models/breakpoints';
-import { makeBreakpointsProcess } from './make-breakpoints-process';
+import { type BreakpointsModel } from '@models/breakpoints';
+import { makeBreakpointsProcess } from './make-breakpoints-model-process';
 
-const memoizedMakeBreakpoints: (UserConfig) => BreakpointsMap = memoizeone(
+const memoizedMakeBreakpoints: (UserConfig) => BreakpointsModel = memoizeone(
   makeBreakpointsProcess,
 );
 
 /* eslint-disable consistent-return */
-export const makeBreakpointsMap: (UserConfig) => * = (config) => {
+export const makeBreakpointsModel: (UserConfig) => * = (config) => {
   if (validateUserConfig(config)) {
     return memoizedMakeBreakpoints(config);
   }

src/make-breakpoints-map/make-breakpoints-process.js → src/make-breakpoints-model/make-breakpoints-model-process.js

@@ -11,12 +11,12 @@ import { setPropRoot } from './root-prop-utils';
 import { makeBreakMap } from './make-break-map';
 import type {
   UserConfig,
-  BreakpointsMap,
+  BreakpointsModel,
   NotFilledNamedBreak,
   NotFilledRenamedBreak,
 } from '../models';
 
-export const makeBreakpointsProcess: (UserConfig) => BreakpointsMap = R.compose(
+export const makeBreakpointsProcess: (UserConfig) => BreakpointsModel = R.compose(
   R.compose(
     R.map(R.omit(['name'])),
     R.reduce(makeBreakMap, {}),

src/mocks.js

@@ -1,6 +1,10 @@
 // @flow
 
-import type { UserConfig, BreakpointWithName, BreakpointsMap } from './models';
+import type {
+  UserConfig,
+  BreakpointWithName,
+  BreakpointsModel,
+} from './models';
 
 export const userConfig: UserConfig = {
   base: ['1em', '2em'],
@@ -69,7 +73,7 @@ export const breakpoints: BreakpointWithName[] = [
   },
 ];
 
-export const breakpointsMap: BreakpointsMap = {
+export const breakpointsModel: BreakpointsModel = {
   default: {
     base: [16, 32],
     lineHeight: 1.5,

src/models/__mocks__/breakpoints.js

@@ -1,6 +1,6 @@
 // @flow
 
-import type { BreakpointWithName, BreakpointsMap } from '../breakpoints';
+import type { BreakpointWithName, BreakpointsModel } from '../breakpoints';
 
 export const breakpoints: BreakpointWithName[] = [
   {
@@ -45,7 +45,7 @@ export const breakpoints: BreakpointWithName[] = [
   },
 ];
 
-export const breakpointsMap: BreakpointsMap = {
+export const breakpointsModel: BreakpointsModel = {
   default: {
     base: [16, 32],
     lineHeight: 1.5,

src/models/breakpoints.js

@@ -85,7 +85,7 @@ export type Breakpoint = {|
   root: number,
 |};
 
-export type BreakpointsMap = {
+export type BreakpointsModel = {
   [string]: Breakpoint,
 };
 

src/utils-public/breakpoints.js

@@ -1,35 +1,35 @@
 // @flow
 
 import * as R from 'ramda';
-import { getBreaksMapOr } from '@utils/get-breaks-map-or';
+import { getBreaksModelOrDefaultModel } from '@utils/get-breaks-model-or-default-model';
 import { headOr } from '@utils/head-or';
 import type {
-  BreakpointsMap,
+  BreakpointsModel,
   UserConfig,
   Breakpoints,
   Breakpoint,
 } from '@models';
 
-export const getBreaksWithoutDefault: (BreakpointsMap) => * = R.compose(
+export const getTailBreaksValues: (BreakpointsModel) => * = R.compose(
   R.tail,
   R.values,
 );
 
-export const getBreakNames: (BreakpointsMap) => string[] = R.compose(
+export const getTailBreaksNames: (BreakpointsModel) => string[] = R.compose(
   R.tail,
   R.keys,
 );
 
-export const makeBreakNamesRow = (breaksMap: BreakpointsMap) =>
-  `'${getBreakNames(breaksMap).join(', ')}'`;
+export const makeBreakNamesRow = (breaksMap: BreakpointsModel) =>
+  `'${getTailBreaksNames(breaksMap).join(', ')}'`;
 
 export const makeBreakpoints: (UserConfig) => Breakpoints = R.compose(
   R.dissoc('default'),
   R.map(R.prop('value')),
-  getBreaksMapOr,
+  getBreaksModelOrDefaultModel,
 );
 
-export const getDefaultBreak: (BreakpointsMap) => Breakpoint = R.compose(
+export const getDefaultBreak: (BreakpointsModel) => Breakpoint = R.compose(
   headOr,
   R.values,
 );

src/utils/get-breaks-model-or-default-model.js

@@ -0,0 +1,9 @@
+import type { UserConfig } from '@models';
+import * as R from 'ramda';
+import { DEFAULT_BREAK_MAP } from '@constants';
+import { makeBreakpointsModel } from '@make-breakpoints-model';
+
+export const getBreaksModelOrDefaultModel: (UserConfig) => * = R.compose(
+  R.defaultTo(DEFAULT_BREAK_MAP),
+  makeBreakpointsModel,
+);

test/make-breakpoints-map/base-prop-process.spec.js → test/make-breakpoints-model/base-prop-process.spec.js

@@ -1,4 +1,4 @@
-import { basePropProcess } from '@make-breakpoints-map/base-prop-process';
+import { basePropProcess } from '@make-breakpoints-model/base-prop-process';
 
 describe('basePropProcess', () => {
   it('breakpoint object with a base key containing an array of numbers', () => {

test/make-breakpoints-map/create-breakpoints.spec.js → test/make-breakpoints-model/create-breakpoints.spec.js

@@ -1,4 +1,4 @@
-import { createBreakpoints } from '@make-breakpoints-map/create-breakpoints';
+import { createBreakpoints } from '@make-breakpoints-model/create-breakpoints';
 import { userConfig } from '@mocks';
 
 describe('createBreakpoints', () => {

test/make-breakpoints-map/index.spec.js → test/make-breakpoints-model/index.spec.js

@@ -1,9 +1,9 @@
 import { userConfig } from '@mocks';
-import { makeBreakpointsMap } from '@make-breakpoints-map';
+import { makeBreakpointsModel } from '@make-breakpoints-model';
 
-describe('makeBreakpointsMap', () => {
+describe('makeBreakpointsModel', () => {
   it('create a list of breakpoint values if the user config is valid', () => {
-    expect(makeBreakpointsMap(userConfig)).toEqual({
+    expect(makeBreakpointsModel(userConfig)).toEqual({
       default: {
         base: [16, 32],
         lineHeight: 1.5,

test/make-breakpoints-map/inherit-props.spec.js → test/make-breakpoints-model/inherit-props.spec.js

@@ -1,4 +1,4 @@
-import { inheritProps } from '@make-breakpoints-map/inherit-props';
+import { inheritProps } from '@make-breakpoints-model/inherit-props';
 
 describe('inheritProps', () => {
   it('inherits all missing key values', () => {

test/make-breakpoints-map/make-break-map.spec.js → test/make-breakpoints-model/make-break-map.spec.js

@@ -1,4 +1,4 @@
-import { makeBreakMap } from '@make-breakpoints-map/make-break-map';
+import { makeBreakMap } from '@make-breakpoints-model/make-break-map';
 import { breakpoints } from '@mocks';
 
 describe('makeBreaksMap', () => {

test/make-breakpoints-map/make-breakpoints-process.spec.js → test/make-breakpoints-model/make-breakpoints-model-process.spec.js

@@ -1,9 +1,9 @@
-import { makeBreakpointsProcess } from '@make-breakpoints-map/make-breakpoints-process';
-import { userConfig, breakpointsMap } from '@mocks';
+import { makeBreakpointsProcess } from '@make-breakpoints-model/make-breakpoints-model-process';
+import { userConfig, breakpointsModel } from '@mocks';
 
 describe('makeBreakpointsProcess', () => {
   it('returns the breakpoints map', () => {
-    expect(makeBreakpointsProcess(userConfig)).toEqual(breakpointsMap);
+    expect(makeBreakpointsProcess(userConfig)).toEqual(breakpointsModel);
   });
 
   it('returns the breakpoint model from default user config', () => {

test/make-breakpoints-map/make-default-break.spec.js → test/make-breakpoints-model/make-default-break.spec.js

@@ -1,4 +1,4 @@
-import { makeDefaultBreak } from '@make-breakpoints-map/make-default-break';
+import { makeDefaultBreak } from '@make-breakpoints-model/make-default-break';
 import { userConfig } from '@mocks';
 
 describe('makeDefaultBreak', () => {

test/make-breakpoints-map/make-named-breaks.spec.js → test/make-breakpoints-model/make-named-breaks.spec.js

@@ -1,4 +1,4 @@
-import { makeNamedBreaks } from '@make-breakpoints-map/make-named-breaks';
+import { makeNamedBreaks } from '@make-breakpoints-model/make-named-breaks';
 import { userConfig } from '@mocks';
 
 describe('makeNamedBreaks', () => {

test/make-breakpoints-map/ratio-prop-utils.spec.js → test/make-breakpoints-model/ratio-prop-utils.spec.js

@@ -3,7 +3,7 @@ import {
   makeFontSizeFromLiteral,
   calcRatio,
   calcRatioProcess,
-} from '@make-breakpoints-map/ratio-prop-utils';
+} from '@make-breakpoints-model/ratio-prop-utils';
 
 const ratioLiteral = '45px at 6';
 

test/make-breakpoints-map/reaname-prop.spec.js → test/make-breakpoints-model/reaname-prop.spec.js

@@ -1,4 +1,4 @@
-import { renameProp } from '@make-breakpoints-map/rename-prop';
+import { renameProp } from '@make-breakpoints-model/rename-prop';
 
 describe('renameProp', () => {
   it('return object with ranamed prop', () => {

test/make-breakpoints-map/root-prop-utils.spec.js → test/make-breakpoints-model/root-prop-utils.spec.js

@@ -1,7 +1,7 @@
 import {
   calcRoot,
   setPropRoot,
-} from '@make-breakpoints-map/root-prop-utils';
+} from '@make-breakpoints-model/root-prop-utils';
 
 describe('calcRoot', () => {
   it('calculated int root', () => {

test/make-breakpoints-map/to-px-break-value.spec.js → test/make-breakpoints-model/to-px-break-value.spec.js

@@ -1,4 +1,4 @@
-import { toPxBreakValue } from '@make-breakpoints-map/to-px-break-value';
+import { toPxBreakValue } from '@make-breakpoints-model/to-px-break-value';
 
 describe('toPxBreakValue', () => {
   it('returns the breakpoints value converted from em to px', () => {