Revert local storage change & refactor parser V1

* Revert the local storage change as it ties model objects to global
  state and makes testing impossible. It will be necessary to redo
  that feature differently
* Refactor the parser versions to move V1 into its own set of files
This commit is contained in:
Andrew Miner
2015-01-13 09:44:13 -08:00
parent 47c7cf693a
commit 823df84924
10 changed files with 397 additions and 397 deletions
+1 -1
View File
@@ -32,7 +32,7 @@ describe 'CraftingPlan', ->
]
}
plan = new CraftingPlan modPack:modPack
plan = new CraftingPlan modPack:modPack, includingTools:false
describe 'craft', ->
+3 -3
View File
@@ -18,16 +18,16 @@ buildcraft = industrialCraft = minecraft = modPack = null
describe 'ModPack', ->
beforeEach ->
minecraft = new ModVersion name:'Minecraft', version:'1.7.10'
minecraft = new ModVersion name:'Minecraft', version:'1.7.10', enabled:true
minecraft.addItem new Item name:'Wool'
minecraft.addItem new Item name:'Bed', recipes:['']
minecraft.registerSlug 'iron_chestplate', 'Iron Chestplate'
buildcraft = new ModVersion name:'Buildcraft', version:'4.0'
buildcraft = new ModVersion name:'Buildcraft', version:'4.0', enabled:false
buildcraft.addItem new Item name:'Stone Gear', recipes:['']
buildcraft.addItem new Item name:'Bed', recipes:['']
industrialCraft = new ModVersion name:'Industrial Craft', version:'2.0'
industrialCraft = new ModVersion name:'Industrial Craft', version:'2.0', enabled:false
industrialCraft.addItem new Item name:'Resin'
industrialCraft.addItem new Item name:'Rubber', recipes:['']
+1 -1
View File
@@ -29,7 +29,7 @@ describe 'ModVersion', ->
it 'supplies default values', ->
modVersion.description.should.equal ''
modVersion.items.should.eql {}
modVersion.enabled.should.be.false
modVersion.enabled.should.be.true
describe 'addItem', ->
-162
View File
@@ -1,162 +0,0 @@
###
Crafting Guide - v1.test.coffee
Copyright (c) 2014-2015 by Redwood Labs
All rights reserved.
###
Item = require '../src/scripts/models/item'
ModVersion = require '../src/scripts/models/mod_version'
ModVersionParser = require '../src/scripts/models/mod_version_parser'
########################################################################################################################
modVersion = parser = null
########################################################################################################################
describe 'ModVersionParser', ->
describe "V1", ->
beforeEach ->
parser = new ModVersionParser.V1
modVersion = parser.modVersion = new ModVersion name:'Test', version:'0.0'
describe '_parseModVersion', ->
it 'requires a mod_name', ->
data = version:'1.0', items:[]
expect(-> parser._parseModVersion data).to.throw Error, 'name is required'
it 'requires a mod_version', ->
data = name:'Empty', items:[]
expect(-> parser._parseModVersion data).to.throw Error, 'version is required'
it 'can parse an empty modVersion', ->
data =
name: 'Empty'
version: '1.0'
recipes: []
modVersion = parser._parseModVersion data
modVersion.name.should.equal 'Empty'
modVersion.version.should.equal '1.0'
it 'can parse a non-empty mod version', ->
data =
name: 'Minecraft'
version: '1.7.10'
recipes: [
{ input:'Sugar Cane', output:'Sugar' }
{ input:[[3, 'Wool'], [3, 'Planks']], tools:'Crafting Table', output:'Bed' }
]
modVersion = parser._parseModVersion data
modVersion.name.should.equal 'Minecraft'
modVersion.version.should.equal '1.7.10'
slugs = (slug for slug, item of modVersion.items).sort()
slugs.should.eql ['bed', 'sugar']
describe '_parseRawMaterials', ->
it 'skips the section when missing', ->
parser._parseRawMaterials null
_.keys(modVersion._items).length.should.equal 0
it 'skips the section when empty', ->
parser._parseRawMaterials []
_.keys(modVersion._items).length.should.equal 0
it 'adds items marked as gatherable', ->
parser._parseRawMaterials ['Wool']
modVersion.items['wool'].isGatherable.should.be.true
it 'marks an existing item as gatherable', ->
modVersion.addItem new Item name:'Wool'
modVersion.items['wool'].isGatherable.should.be.false
parser._parseRawMaterials ['Wool']
modVersion.items['wool'].isGatherable.should.be.true
it 'registers the names of the items', ->
parser._parseRawMaterials ['Wool']
modVersion.names['wool'].should.equal 'Wool'
describe '_parseRecipe', ->
it 'requires output to be defined', ->
parser._errorLocation = 'boat'
test = -> parser._parseRecipe {input:'wool'}
expect(test).to.throw Error, 'boat is missing output'
it 'requires input to be defined', ->
test = -> parser._parseRecipe {output:'wool'}
expect(test).to.throw Error, 'recipe for wool is missing input'
it 'can parse a regular recipe', ->
data =
output: 'bed'
input: [[3, 'planks'], [3, 'wool']]
tools: 'crafting table'
recipe = parser._parseRecipe data
(stack.itemSlug for stack in recipe.output).should.eql ['bed']
(stack.itemSlug for stack in recipe.input).sort().should.eql ['planks', 'wool']
(stack.itemSlug for stack in recipe.tools).should.eql ['crafting_table']
it 'can parse a recipe without tools', ->
recipe = parser._parseRecipe {output:'sugar', input:'sugar cane'}
(stack.itemSlug for stack in recipe.output).should.eql ['sugar']
(stack.itemSlug for stack in recipe.input).sort().should.eql ['sugar_cane']
(stack.itemSlug for stack in recipe.tools).should.eql []
it 'registers all names', ->
data =
output: 'Bed'
input: [[3, 'Oak Wood Planks'], [3, 'Wool']]
tools: 'Crafting Table'
parser._parseRecipe data
_.keys(modVersion.names).sort().should.eql ['bed', 'crafting_table', 'oak_wood_planks', 'wool']
describe '_parseStack', ->
it 'requires the array to have at least one element', ->
parser._errorLocation = 'boat'
options = index:1, field:'output'
expect(-> parser._parseStack([], options)).to.throw Error,
"output element 1 for boat must have at least one element"
it 'can fill in a missing number', ->
stack = parser._parseStack 'boat'
stack.itemSlug.should.equal 'boat'
stack.quantity.should.equal 1
stack2 = parser._parseStack ['boat']
stack2.itemSlug.should.equal 'boat'
stack2.quantity.should.equal 1
it 'requires the data to start with a number', ->
parser._errorLocation = 'boat'
options = index:1, field:'output'
expect(-> parser._parseStack(['2', 'wool'], options)).to.throw Error,
"output element 1 for boat must start with a number"
it 'can parse a basic item', ->
stack = parser._parseStack [2, 'wool']
stack.constructor.name.should.equal 'Stack'
describe '_parseStackList', ->
it 'can promote a single item to a list', ->
list = parser._parseStackList 'boat'
(stack.itemSlug for stack in list).should.eql ['boat']
it 'can require a list to be non-empty', ->
parser._errorLocation = 'boat'
options = field:'output', canBeEmpty:false
expect(-> parser._parseStackList [], options).to.throw Error, 'output for boat cannot be empty'
it 'can allow an empty list', ->
list = parser._parseStackList [], canBeEmpty:true
list.length.should.equal 0
it 'can parse a non-empty list', ->
list = parser._parseStackList [[3, 'plank'], [3, 'wool']]
(stack.itemSlug for stack in list).sort().should.eql ['plank', 'wool']
+160
View File
@@ -0,0 +1,160 @@
###
Crafting Guide - mod_version_parsers/v1.test.coffee
Copyright (c) 2014-2015 by Redwood Labs
All rights reserved.
###
Item = require '../../src/scripts/models/item'
ModVersion = require '../../src/scripts/models/mod_version'
V1 = require '../../src/scripts/models/mod_version_parsers/v1'
########################################################################################################################
modVersion = parser = null
########################################################################################################################
describe "V1", ->
beforeEach ->
parser = new V1
modVersion = parser.modVersion = new ModVersion name:'Test', version:'0.0'
describe '_parseModVersion', ->
it 'requires a mod_name', ->
data = version:'1.0', items:[]
expect(-> parser._parseModVersion data).to.throw Error, 'name is required'
it 'requires a mod_version', ->
data = name:'Empty', items:[]
expect(-> parser._parseModVersion data).to.throw Error, 'version is required'
it 'can parse an empty modVersion', ->
data =
name: 'Empty'
version: '1.0'
recipes: []
modVersion = parser._parseModVersion data
modVersion.name.should.equal 'Empty'
modVersion.version.should.equal '1.0'
it 'can parse a non-empty mod version', ->
data =
name: 'Minecraft'
version: '1.7.10'
recipes: [
{ input:'Sugar Cane', output:'Sugar' }
{ input:[[3, 'Wool'], [3, 'Planks']], tools:'Crafting Table', output:'Bed' }
]
modVersion = parser._parseModVersion data
modVersion.name.should.equal 'Minecraft'
modVersion.version.should.equal '1.7.10'
slugs = (slug for slug, item of modVersion.items).sort()
slugs.should.eql ['bed', 'sugar']
describe '_parseRawMaterials', ->
it 'skips the section when missing', ->
parser._parseRawMaterials null
_.keys(modVersion._items).length.should.equal 0
it 'skips the section when empty', ->
parser._parseRawMaterials []
_.keys(modVersion._items).length.should.equal 0
it 'adds items marked as gatherable', ->
parser._parseRawMaterials ['Wool']
modVersion.items['wool'].isGatherable.should.be.true
it 'marks an existing item as gatherable', ->
modVersion.addItem new Item name:'Wool'
modVersion.items['wool'].isGatherable.should.be.false
parser._parseRawMaterials ['Wool']
modVersion.items['wool'].isGatherable.should.be.true
it 'registers the names of the items', ->
parser._parseRawMaterials ['Wool']
modVersion.names['wool'].should.equal 'Wool'
describe '_parseRecipe', ->
it 'requires output to be defined', ->
parser._errorLocation = 'boat'
test = -> parser._parseRecipe {input:'wool'}
expect(test).to.throw Error, 'boat is missing output'
it 'requires input to be defined', ->
test = -> parser._parseRecipe {output:'wool'}
expect(test).to.throw Error, 'recipe for wool is missing input'
it 'can parse a regular recipe', ->
data =
output: 'bed'
input: [[3, 'planks'], [3, 'wool']]
tools: 'crafting table'
recipe = parser._parseRecipe data
(stack.itemSlug for stack in recipe.output).should.eql ['bed']
(stack.itemSlug for stack in recipe.input).sort().should.eql ['planks', 'wool']
(stack.itemSlug for stack in recipe.tools).should.eql ['crafting_table']
it 'can parse a recipe without tools', ->
recipe = parser._parseRecipe {output:'sugar', input:'sugar cane'}
(stack.itemSlug for stack in recipe.output).should.eql ['sugar']
(stack.itemSlug for stack in recipe.input).sort().should.eql ['sugar_cane']
(stack.itemSlug for stack in recipe.tools).should.eql []
it 'registers all names', ->
data =
output: 'Bed'
input: [[3, 'Oak Wood Planks'], [3, 'Wool']]
tools: 'Crafting Table'
parser._parseRecipe data
_.keys(modVersion.names).sort().should.eql ['bed', 'crafting_table', 'oak_wood_planks', 'wool']
describe '_parseStack', ->
it 'requires the array to have at least one element', ->
parser._errorLocation = 'boat'
options = index:1, field:'output'
expect(-> parser._parseStack([], options)).to.throw Error,
"output element 1 for boat must have at least one element"
it 'can fill in a missing number', ->
stack = parser._parseStack 'boat'
stack.itemSlug.should.equal 'boat'
stack.quantity.should.equal 1
stack2 = parser._parseStack ['boat']
stack2.itemSlug.should.equal 'boat'
stack2.quantity.should.equal 1
it 'requires the data to start with a number', ->
parser._errorLocation = 'boat'
options = index:1, field:'output'
expect(-> parser._parseStack(['2', 'wool'], options)).to.throw Error,
"output element 1 for boat must start with a number"
it 'can parse a basic item', ->
stack = parser._parseStack [2, 'wool']
stack.constructor.name.should.equal 'Stack'
describe '_parseStackList', ->
it 'can promote a single item to a list', ->
list = parser._parseStackList 'boat'
(stack.itemSlug for stack in list).should.eql ['boat']
it 'can require a list to be non-empty', ->
parser._errorLocation = 'boat'
options = field:'output', canBeEmpty:false
expect(-> parser._parseStackList [], options).to.throw Error, 'output for boat cannot be empty'
it 'can allow an empty list', ->
list = parser._parseStackList [], canBeEmpty:true
list.length.should.equal 0
it 'can parse a non-empty list', ->
list = parser._parseStackList [[3, 'plank'], [3, 'wool']]
(stack.itemSlug for stack in list).sort().should.eql ['plank', 'wool']
+2 -1
View File
@@ -31,7 +31,8 @@ require './inventory.test'
require './inventory_parser.test'
require './mod_pack.test'
require './mod_version.test'
require './mod_version_parser.test'
require './mod_version_parsers/v1.test'
mocha.checkLeaks()
mocha.globals ['LiveReload']
mocha.run()