Complete refactoring to move Recipes into Items
* Changed "version" to "dataVersion" in data format * Changed the "modName" and "modVersion" fields on the ModVersion class to remove the "mod" prefix and changed the data format to match * Change the Stack class to use the itemSlug instead of the item itself * Update the ModVersion and ModPack classes to include methods for recording a correspondence between slugs and names. Update code which displays items from stacks to use these methods to determine display names. * Add a reference from Recipe back to the item it creates
This commit is contained in:
Andrew Miner
@@ -11,7 +11,7 @@ ModVersionParser = require '../src/scripts/models/mod_version_parser'
|
||||
|
||||
########################################################################################################################
|
||||
|
||||
parser = null
|
||||
modVersion = parser = null
|
||||
|
||||
########################################################################################################################
|
||||
|
||||
@@ -19,93 +19,77 @@ describe 'ModVersionParser', ->
|
||||
|
||||
describe "V1", ->
|
||||
|
||||
before -> parser = new ModVersionParser.V1
|
||||
|
||||
describe '_parseItemList', ->
|
||||
|
||||
beforeEach -> parser.modVersion = new ModVersion modName:'Test', modVersion:'0.0'
|
||||
|
||||
it 'can parse an empty list', ->
|
||||
parser._parseItemList []
|
||||
_.keys(parser.modVersion.items).should.eql []
|
||||
|
||||
it 'can add new items', ->
|
||||
parser._parseItemList ['Crafting Table', 'Furnace']
|
||||
_.keys(parser.modVersion.items).should.eql ['crafting_table', 'furnace']
|
||||
|
||||
it 'can find existing items', ->
|
||||
parser.modVersion.addItem new Item name:'Furnace'
|
||||
parser._parseItemList ['Crafting Table', 'Furnace']
|
||||
_.keys(parser.modVersion.items).should.eql ['furnace', 'crafting_table']
|
||||
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, mod_version:'1.0', items:[]
|
||||
expect(-> parser._parseModVersion data).to.throw Error, 'mod_name is required'
|
||||
data = version:'1.0', items:[]
|
||||
expect(-> parser._parseModVersion data).to.throw Error, 'name is required'
|
||||
|
||||
it 'requires a mod_version', ->
|
||||
data = version:1, mod_name:'Empty', items:[]
|
||||
expect(-> parser._parseModVersion data).to.throw Error, 'mod_version is required'
|
||||
data = name:'Empty', items:[]
|
||||
expect(-> parser._parseModVersion data).to.throw Error, 'version is required'
|
||||
|
||||
it 'can parse an empty modVersion', ->
|
||||
data =
|
||||
version: 1
|
||||
mod_name: 'Empty'
|
||||
mod_version: '1.0'
|
||||
name: 'Empty'
|
||||
version: '1.0'
|
||||
recipes: []
|
||||
modVersion = parser._parseModVersion data
|
||||
modVersion.modName.should.equal 'Empty'
|
||||
modVersion.modVersion.should.equal '1.0'
|
||||
modVersion.name.should.equal 'Empty'
|
||||
modVersion.version.should.equal '1.0'
|
||||
|
||||
it 'can parse a non-empty mod version', ->
|
||||
data =
|
||||
version: 1
|
||||
mod_name: 'Minecraft'
|
||||
mod_version: '1.7.10'
|
||||
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.modName.should.equal 'Minecraft'
|
||||
modVersion.modVersion.should.equal '1.7.10'
|
||||
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', 'crafting_table', 'planks', 'sugar', 'sugar_cane', 'wool']
|
||||
slugs.should.eql ['bed', 'sugar']
|
||||
|
||||
describe '_parseRawMaterials', ->
|
||||
|
||||
beforeEach -> parser.modVersion = new ModVersion modName:'Test', modVersion:'0.0'
|
||||
|
||||
it 'skips the section when missing', ->
|
||||
parser._parseRawMaterials null
|
||||
_.keys(parser.modVersion._items).length.should.equal 0
|
||||
_.keys(modVersion._items).length.should.equal 0
|
||||
|
||||
it 'skips the section when empty', ->
|
||||
parser._parseRawMaterials []
|
||||
_.keys(parser.modVersion._items).length.should.equal 0
|
||||
_.keys(modVersion._items).length.should.equal 0
|
||||
|
||||
it 'adds items marked as gatherable', ->
|
||||
parser._parseRawMaterials ['Wool']
|
||||
parser.modVersion.items['wool'].isGatherable.should.be.true
|
||||
modVersion.items['wool'].isGatherable.should.be.true
|
||||
|
||||
it 'marks an existing item as gatherable', ->
|
||||
parser.modVersion.addItem new Item name:'Wool'
|
||||
parser.modVersion.items['wool'].isGatherable.should.be.false
|
||||
modVersion.addItem new Item name:'Wool'
|
||||
modVersion.items['wool'].isGatherable.should.be.false
|
||||
parser._parseRawMaterials ['Wool']
|
||||
parser.modVersion.items['wool'].isGatherable.should.be.true
|
||||
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', ->
|
||||
|
||||
beforeEach -> parser.modVersion = new ModVersion modName:'Test', modVersion:'0.0'
|
||||
|
||||
it 'requires output to be defined', ->
|
||||
parser._errorLocation = 'boat'
|
||||
expect(-> parser._parseRecipe input:'wool').to.throw Error, 'boat is missing output'
|
||||
test = -> parser._parseRecipe {input:'wool'}
|
||||
expect(test).to.throw Error, 'boat is missing output'
|
||||
|
||||
it 'requires input to be defined', ->
|
||||
expect(-> parser._parseRecipe output:'wool').to.throw Error, 'recipe for wool is missing input'
|
||||
test = -> parser._parseRecipe {output:'wool'}
|
||||
expect(test).to.throw Error, 'recipe for wool is missing input'
|
||||
|
||||
it 'can parse a regular recipe', ->
|
||||
data =
|
||||
@@ -113,20 +97,26 @@ describe 'ModVersionParser', ->
|
||||
input: [[3, 'planks'], [3, 'wool']]
|
||||
tools: 'crafting table'
|
||||
recipe = parser._parseRecipe data
|
||||
(stack.name for stack in recipe.output).should.eql ['bed']
|
||||
(stack.name for stack in recipe.input).sort().should.eql ['planks', 'wool']
|
||||
(item.name for item in recipe.tools).should.eql ['crafting table']
|
||||
(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.name for stack in recipe.output).should.eql ['sugar']
|
||||
(stack.name for stack in recipe.input).sort().should.eql ['sugar cane']
|
||||
(stack.name for stack in recipe.tools).should.eql []
|
||||
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', ->
|
||||
|
||||
beforeEach -> parser.modVersion = new ModVersion modName:'Test', modVersion:'0.0'
|
||||
|
||||
it 'requires the array to have at least one element', ->
|
||||
parser._errorLocation = 'boat'
|
||||
options = index:1, field:'output'
|
||||
@@ -134,13 +124,13 @@ describe 'ModVersionParser', ->
|
||||
"output element 1 for boat must have at least one element"
|
||||
|
||||
it 'can fill in a missing number', ->
|
||||
item = parser._parseStack 'boat'
|
||||
item.name.should.equal 'boat'
|
||||
item.quantity.should.equal 1
|
||||
stack = parser._parseStack 'boat'
|
||||
stack.itemSlug.should.equal 'boat'
|
||||
stack.quantity.should.equal 1
|
||||
|
||||
item2 = parser._parseStack ['boat']
|
||||
item2.name.should.equal 'boat'
|
||||
item2.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'
|
||||
@@ -154,11 +144,9 @@ describe 'ModVersionParser', ->
|
||||
|
||||
describe '_parseStackList', ->
|
||||
|
||||
beforeEach -> parser.modVersion = new ModVersion modName:'Test', modVersion:'0.0'
|
||||
|
||||
it 'can promote a single item to a list', ->
|
||||
list = parser._parseStackList 'boat'
|
||||
(i.name for i in list).should.eql ['boat']
|
||||
(stack.itemSlug for stack in list).should.eql ['boat']
|
||||
|
||||
it 'can require a list to be non-empty', ->
|
||||
parser._errorLocation = 'boat'
|
||||
@@ -171,4 +159,4 @@ describe 'ModVersionParser', ->
|
||||
|
||||
it 'can parse a non-empty list', ->
|
||||
list = parser._parseStackList [[3, 'plank'], [3, 'wool']]
|
||||
(i.name for i in list).sort().should.eql ['plank', 'wool']
|
||||
(stack.itemSlug for stack in list).sort().should.eql ['plank', 'wool']
|
||||
|
||||
Reference in New Issue
Block a user