craftingguide/website
1
0
Fork 0
Code Pull Requests Actions Activity

Massive refactoring to clean up models

Browse Source 
* Tweak style of quantity label in output box to be more visible
* Move data files for all mods under a directory for the specific
  version of the mod
* Add a `silent` property to the base model to prevent models which
  shouldn't be observed from emitting events
* Change the term "itemSlug" to just "slug" across the board
* Change all models so that they don't require their parent in their
  constructors and so that they don't automatically add themselves to
  their parents lists
* Remove a bunch of unnecessary event triggering
* Tighten up access to various lists of children across all models
* Refactor the guts of the V2 parser into an abstract base class so
  it can be used for other parsers in the future
* Remove a number of unused methods
This commit is contained in:
Andrew Miner
2015-01-17 11:49:07 -08:00
parent bb959264ee
commit 83868e2760
34 changed files with 530 additions and 519 deletions
Download Patch File Download Diff File Expand all files Collapse all files
test/crafting_plan.test.coffee
+7 -3
View File
@@ -5,8 +5,9 @@ Copyright (c) 2014-2015 by Redwood Labs
All rights reserved.
###
ModPack = require '../src/scripts/models/mod_pack'
CraftingPlan = require '../src/scripts/models/crafting_plan'
ModVersion = require '../src/scripts/models/mod_version'
ModPack = require '../src/scripts/models/mod_pack'
########################################################################################################################
@@ -17,8 +18,8 @@ modPack = plan = null
describe 'CraftingPlan', ->
beforeEach ->
modPack = new ModPack
modPack.loadModVersionData """
modVersion = new ModVersion name:'Minecraft', version:'1.7.10'
modVersion.parse """
schema:2; name:Minecraft; version:1.7.10
item:Oak Plank; recipe:; input:Oak Log; pattern:... .0. ...; quantity:4
@@ -28,6 +29,9 @@ describe 'CraftingPlan', ->
item:Iron Ingot; recipe:; input:Iron Ore, furnace fuel; pattern:.0. ... .1.; tools:Furnace
item:Iron Sword; recipe:; input:Iron Ingot, Stick; pattern:.0. .0. .1.; tools:Crafting Table
"""
modPack = new ModPack
modPack.addModVersion modVersion
plan = new CraftingPlan modPack:modPack, includingTools:false
describe 'craft', ->
test/inventory.test.coffee
+5 -5
View File
@@ -19,7 +19,7 @@ inventory = null
describe 'Inventory', ->
beforeEach ->
inventory = new Inventory
inventory = new Inventory {}, silent:false
inventory.add 'wool', 4
inventory.add 'string', 20
inventory.add 'boat'
@@ -30,7 +30,7 @@ describe 'Inventory', ->
inventory.add 'iron_ingot', 4
stack = inventory._stacks['iron_ingot']
stack.constructor.name.should.equal 'Stack'
stack.itemSlug.should.equal 'iron_ingot'
stack.slug.should.equal 'iron_ingot'
stack.quantity.should.equal 4
it 'can augment quantity of existing items', ->
@@ -80,7 +80,7 @@ describe 'Inventory', ->
it 'works when items have only been added', ->
result = []
inventory.each (stack)-> result.push stack.itemSlug
inventory.each (stack)-> result.push stack.slug
result.should.eql ['boat', 'string', 'wool']
it 'works when items have been augmented', ->
@@ -89,7 +89,7 @@ describe 'Inventory', ->
inventory.add 'wool', 2
result = []
inventory.each (stack)-> result.push stack.itemSlug
inventory.each (stack)-> result.push stack.slug
result.should.eql ['boat', 'iron_ingot', 'string', 'wool']
describe 'hasAtLeast', ->
@@ -116,7 +116,7 @@ describe 'Inventory', ->
it 'completely removes the last item', ->
stack = inventory.pop()
stack.itemSlug.should.equal 'wool'
stack.slug.should.equal 'wool'
stack.quantity.should.equal 4
inventory.toList().should.eql ['boat', [20, 'string']]
test/mod_pack.test.coffee
+14 -52
View File
@@ -19,43 +19,22 @@ describe 'ModPack', ->
beforeEach ->
minecraft = new ModVersion name:'Minecraft', version:'1.7.10', enabled:true
new Item modVersion:minecraft, name:'Wool'
new Item modVersion:minecraft, name:'Bed', recipes:['']
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', enabled:false
new Item modVersion:buildcraft, name:'Stone Gear', recipes:['']
new Item modVersion:buildcraft, name:'Bed', recipes:['']
buildcraft = new ModVersion name:'Buildcraft', version:'6.2.6', 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', enabled:false
new Item modVersion:industrialCraft, name:'Resin'
new Item modVersion:industrialCraft, name:'Rubber', recipes:['']
industrialCraft.addItem new Item name:'Resin'
industrialCraft.addItem new Item name:'Rubber'
modPack = new ModPack modVersions:[minecraft, buildcraft, industrialCraft]
describe 'enableModsForItem', ->
it 'it ignores already-enabled mod versions', ->
buildcraft.enabled = true
modPack.enableModsForItem 'Stone Gear'
minecraft.enabled.should.be.true
buildcraft.enabled.should.be.true
industrialCraft.enabled.should.be.false
it 'it ignores mod versions not containing the item', ->
modPack.enableModsForItem 'Stone Gear'
minecraft.enabled.should.be.true
buildcraft.enabled.should.be.true
industrialCraft.enabled.should.be.false
it 'enables disabled mod versions with the item', ->
modPack.enableModsForItem 'Rubber'
minecraft.enabled.should.be.true
buildcraft.enabled.should.be.false
industrialCraft.enabled.should.be.true
modPack = new ModPack
modPack.addModVersion minecraft
modPack.addModVersion buildcraft
modPack.addModVersion industrialCraft
describe 'findItemByName', ->
@@ -75,7 +54,7 @@ describe 'ModPack', ->
it 'returns all data for a regular Minecraft item', ->
display = modPack.findItemDisplay 'bed'
display.iconUrl.should.equal '/data/minecraft/images/bed.png'
display.iconUrl.should.equal '/data/minecraft/1.7.10/images/bed.png'
display.itemUrl.should.equal '/item/Bed'
display.itemName.should.equal 'Bed'
display.modSlug.should.equal 'minecraft'
@@ -83,7 +62,7 @@ describe 'ModPack', ->
it 'returns all data for an item in an enabled mod', ->
buildcraft.enabled = true
display = modPack.findItemDisplay 'stone_gear'
display.iconUrl.should.equal '/data/buildcraft/images/stone_gear.png'
display.iconUrl.should.equal '/data/buildcraft/6.2.6/images/stone_gear.png'
display.itemUrl.should.equal '/item/Stone%20Gear'
display.itemName.should.equal 'Stone Gear'
display.modSlug.should.equal 'buildcraft'
@@ -94,24 +73,7 @@ describe 'ModPack', ->
it 'assumes an unfound item is from Minecraft', ->
display = modPack.findItemDisplay 'iron_chestplate'
display.iconUrl.should.equal '/data/minecraft/images/iron_chestplate.png'
display.iconUrl.should.equal '/data/minecraft/1.7.10/images/iron_chestplate.png'
display.itemUrl.should.equal '/item/Iron%20Chestplate'
display.itemName.should.equal 'Iron Chestplate'
display.modSlug.should.equal 'minecraft'
describe 'hasRecipe', ->
it 'returns true when the item is present and has recipes', ->
modPack.hasRecipe('Bed').should.be.true
it 'returns false when the item is not present', ->
modPack.hasRecipe('Iron Sword').should.be.false
it 'returns false when the item does not have recipes', ->
modPack.hasRecipe('Wool').should.be.false
it 'ignores disabled mod versions', ->
modPack.hasRecipe('Stone Gear').should.be.false
it 'includes disabled mod versions when include disabled is requested', ->
modPack.hasRecipe('Stone Gear', includeDisabled:true).should.be.true
test/mod_version.test.coffee
+13 -23
View File
@@ -21,25 +21,29 @@ describe 'ModVersion', ->
describe 'constructor', ->
it 'requires a mod name', ->
expect(-> new ModVersion version:'0.0').to.throw Error, 'name cannot be empty'
expect(-> new ModVersion version:'0.0').to.throw Error, 'attributes.name is required'
it 'requires a mod version', ->
expect(-> new ModVersion name:'Test').to.throw Error, 'version cannot be empty'
expect(-> new ModVersion name:'Test').to.throw Error, 'attributes.version is required'
it 'supplies default values', ->
modVersion.description.should.equal ''
modVersion.items.should.eql {}
modVersion.enabled.should.be.true
modVersion.slug.should.equal 'test'
describe 'addItem', ->
it 'refuses to add duplicates', ->
new Item modVersion:modVersion, name:'Wool'
expect(-> new Item modVersion:modVersion, name:'Wool').to.throw Error, 'duplicate item for Wool'
modVersion.addItem new Item name:'Wool'
expect(-> modVersion.addItem new Item name:'Wool').to.throw Error, 'duplicate item for Wool'
it 'adds an item indexes by its slug', ->
new Item modVersion:modVersion, name:'Wool'
modVersion.items.wool.name.should.equal 'Wool'
it 'adds an item indexed by its slug', ->
modVersion.addItem new Item name:'Wool'
modVersion._items.wool.name.should.equal 'Wool'
it 'sets the modVersion', ->
modVersion.addItem new Item name:'Wool'
modVersion._items.wool.modVersion.should.equal modVersion
describe 'compareTo', ->
@@ -56,19 +60,5 @@ describe 'ModVersion', ->
describe 'findItemByName', ->
it 'locates items by slugified name', ->
new Item modVersion:modVersion, name:'Crafting Table'
modVersion.addItem new Item name:'Crafting Table'
modVersion.findItemByName('Crafting Table').slug.should.equal 'crafting_table'
describe 'hasRecipe', ->
it 'returns false for an unknown item', ->
new Item modVersion:modVersion, name:'Oak Wood Planks', recipes:['foo']
modVersion.hasRecipe('Pineapple Upside-Down Cake').should.be.false
it 'returns false for a un-craftable item', ->
new Item modVersion:modVersion, name:'Wool'
modVersion.hasRecipe('Wool').should.be.false
it 'returns true for a craftable item', ->
new Item modVersion:modVersion, name:'Oak Wood Planks', recipes:['foo']
modVersion.hasRecipe('Oak Wood Planks').should.be.true
test/parser_versions/mod_version_parser_v1.test.coffee
+18 -19
View File
@@ -19,7 +19,7 @@ describe "ModVersionParserV1", ->
beforeEach ->
modVersion = new ModVersion name:'Test', version:'0.0'
parser = new ModVersionParserV1 modVersion:modVersion
parser = new ModVersionParserV1 model:modVersion
describe '_parseModVersion', ->
@@ -51,8 +51,7 @@ describe "ModVersionParserV1", ->
modVersion = parser._parseModVersion data
modVersion.name.should.equal 'Test'
modVersion.version.should.equal '0.0'
slugs = (slug for slug, item of modVersion.items).sort()
slugs.should.eql ['bed', 'sugar']
modVersion._slugs.should.eql ['bed', 'crafting_table', 'planks', 'sugar', 'sugar_cane', 'wool']
describe '_parseRawMaterials', ->
@@ -66,17 +65,17 @@ describe "ModVersionParserV1", ->
it 'adds items marked as gatherable', ->
parser._parseRawMaterials ['Wool']
modVersion.items['wool'].isGatherable.should.be.true
modVersion._items['wool'].isGatherable.should.be.true
it 'marks an existing item as gatherable', ->
item = new Item modVersion:modVersion, name:'Wool'
modVersion.items['wool'].isGatherable.should.be.false
modVersion.addItem new Item name:'Wool'
modVersion._items['wool'].isGatherable.should.be.false
parser._parseRawMaterials ['Wool']
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'
modVersion._names['wool'].should.equal 'Wool'
describe '_parseRecipe', ->
@@ -95,15 +94,15 @@ describe "ModVersionParserV1", ->
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']
(stack.slug for stack in recipe.output).should.eql ['bed']
(stack.slug for stack in recipe.input).sort().should.eql ['planks', 'wool']
(stack.slug 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 []
(stack.slug for stack in recipe.output).should.eql ['sugar']
(stack.slug for stack in recipe.input).sort().should.eql ['sugar_cane']
(stack.slug for stack in recipe.tools).should.eql []
it 'registers all names', ->
data =
@@ -111,7 +110,7 @@ describe "ModVersionParserV1", ->
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']
modVersion._slugs.should.eql ['bed', 'crafting_table', 'oak_wood_planks', 'wool']
describe '_parseStack', ->
@@ -123,11 +122,11 @@ describe "ModVersionParserV1", ->
it 'can fill in a missing number', ->
stack = parser._parseStack 'boat'
stack.itemSlug.should.equal 'boat'
stack.slug.should.equal 'boat'
stack.quantity.should.equal 1
stack2 = parser._parseStack ['boat']
stack2.itemSlug.should.equal 'boat'
stack2.slug.should.equal 'boat'
stack2.quantity.should.equal 1
it 'requires the data to start with a number', ->
@@ -144,7 +143,7 @@ describe "ModVersionParserV1", ->
it 'can promote a single item to a list', ->
list = parser._parseStackList 'boat'
(stack.itemSlug for stack in list).should.eql ['boat']
(stack.slug for stack in list).should.eql ['boat']
it 'can require a list to be non-empty', ->
parser._errorLocation = 'boat'
@@ -157,4 +156,4 @@ describe "ModVersionParserV1", ->
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']
(stack.slug for stack in list).sort().should.eql ['plank', 'wool']
test/parser_versions/mod_version_parser_v2.test.coffee
+26 -26
View File
@@ -18,7 +18,7 @@ describe 'ModVersionParserV2', ->
beforeEach ->
modVersion = new ModVersion name:'Test', version:'0.0'
parser = new ModVersionParserV2 modVersion:modVersion
parser = new ModVersionParserV2 model:modVersion
describe 'Item', ->
@@ -29,15 +29,15 @@ describe 'ModVersionParserV2', ->
recipe:; input:Alpha; pattern:... .0. ...;
recipe:; input:Bravo; pattern:... 0.0 ...;"
modVersion = parser.parse baseText + recipes
recipes = modVersion.items.charlie.recipes
recipes[0].input[0].itemSlug.should.equal 'alpha'
recipes[1].input[0].itemSlug.should.equal 'bravo'
recipes = modVersion._items.charlie._recipes
recipes[0].input[0].slug.should.equal 'alpha'
recipes[1].input[0].slug.should.equal 'bravo'
describe 'name', ->
it 'adds the name when present', ->
modVersion = parser.parse baseText + 'item: Charlie'
modVersion.items.charlie.name.should.equal 'Charlie'
modVersion._items.charlie.name.should.equal 'Charlie'
it 'requires a non-empty name', ->
func = -> parser.parse baseText + 'item: \n'
@@ -47,7 +47,7 @@ describe 'ModVersionParserV2', ->
it 'adds "gatherable" when present', ->
modVersion = parser.parse baseText + 'item: Alpha Bravo; gatherable: yes'
modVersion.items.alpha_bravo.isGatherable.should.be.true
modVersion._items.alpha_bravo.isGatherable.should.be.true
it 'does not allow a duplicate "gatherable" declaration', ->
func = -> parser.parse baseText + 'item: Alpha Bravo; gatherable: yes; gatherable: yes'
@@ -67,7 +67,7 @@ describe 'ModVersionParserV2', ->
modVersion = parser.parse 'item: Alpha; version:0.0; name:Test'
modVersion.name.should.equal 'Test'
modVersion.version.should.equal '0.0'
modVersion.items.alpha.name.should.equal 'Alpha'
modVersion._items.alpha.name.should.equal 'Alpha'
it 'does not allow duplicate item declarations', ->
func = -> parser.parse 'version:0.0; name:Test; item:Charlie; item:Charlie'
@@ -75,7 +75,7 @@ describe 'ModVersionParserV2', ->
it 'allows multiple items', ->
modVersion = parser.parse 'name:Test; version:0.0; item:Bravo; item:Charlie'
_.keys(modVersion.items).sort().should.eql ['bravo', 'charlie']
_.keys(modVersion._items).sort().should.eql ['bravo', 'charlie']
describe 'name', ->
@@ -123,7 +123,7 @@ describe 'ModVersionParserV2', ->
it 'adds "input" when present', ->
modVersion = parser.parse baseText + 'recipe:; input:Alpha, Bravo, Charlie; pattern: ... 012 ...'
slugs = (s.itemSlug for s in modVersion.items.charlie.recipes[0].input)
slugs = (s.slug for s in modVersion._items.charlie._recipes[0].input)
slugs.should.eql ['alpha', 'bravo', 'charlie']
it 'requires an "input" declaration', ->
@@ -140,13 +140,13 @@ describe 'ModVersionParserV2', ->
it 'registers slugs for each input name', ->
modVersion = parser.parse baseText + 'recipe:; input:Delta, Echo, Foxtrot; pattern:...012...'
_.keys(modVersion.names).sort().should.eql ['charlie', 'delta', 'echo', 'foxtrot']
modVersion._slugs.should.eql ['charlie', 'delta', 'echo', 'foxtrot']
describe 'pattern', ->
it 'adds "pattern" when present', ->
modVersion = parser.parse baseText + 'recipe:; input:Alpha, Bravo; pattern:... .0. .1.'
modVersion.items.charlie.recipes[0].pattern.should.equal '... .0. .1.'
modVersion._items.charlie._recipes[0].pattern.should.equal '... .0. .1.'
it 'requires a "pattern" declaration', ->
func = -> parser.parse baseText + 'recipe:; input:Alpha, Bravo'
@@ -174,7 +174,7 @@ describe 'ModVersionParserV2', ->
it 'computes the input stack sizes from the pattern', ->
modVersion = parser.parse baseText + 'recipe:; input:Alpha, Bravo, Charlie; pattern:111 .0. 2.2'
recipe = modVersion.items.charlie.recipes[0]
recipe = modVersion._items.charlie._recipes[0]
recipe.input[0].quantity.should.equal 1
recipe.input[1].quantity.should.equal 3
recipe.input[2].quantity.should.equal 2
@@ -190,7 +190,7 @@ describe 'ModVersionParserV2', ->
it 'adds "quantity" when present', ->
modVersion = parser.parse baseText + 'quantity: 2'
modVersion.items.charlie.recipes[0].output[0].quantity.should.equal 2
modVersion._items.charlie._recipes[0].output[0].quantity.should.equal 2
it 'does not allow a duplicate "quantity" declaration', ->
func = -> parser.parse baseText + 'quantity:1; quantity:2'
@@ -202,7 +202,7 @@ describe 'ModVersionParserV2', ->
it 'assumes a quantity of 1 by default', ->
modVersion = parser.parse baseText
modVersion.items.charlie.recipes[0].output[0].quantity.should.equal 1
modVersion._items.charlie._recipes[0].output[0].quantity.should.equal 1
it 'does not allow "quantity" before recipe', ->
func = -> parser.parse 'name:Alpha; version:1; item:Bravo; quantity:12; recipe:;'
@@ -215,18 +215,18 @@ describe 'ModVersionParserV2', ->
it 'adds a single item as the default output', ->
modVersion = parser.parse baseText
stack = modVersion.items.bravo.recipes[0].output[0]
stack.itemSlug.should.equal 'bravo'
stack = modVersion._items.bravo._recipes[0].output[0]
stack.slug.should.equal 'bravo'
stack.quantity.should.equal 1
it 'can add multiple extras with quantities', ->
modVersion = parser.parse baseText + 'extras:2 Delta, 4 Echo'
output = modVersion.items.bravo.recipes[0].output
output[0].itemSlug.should.equal 'bravo'
output = modVersion._items.bravo._recipes[0].output
output[0].slug.should.equal 'bravo'
output[0].quantity.should.equal 1
output[1].itemSlug.should.equal 'delta'
output[1].slug.should.equal 'delta'
output[1].quantity.should.equal 2
output[2].itemSlug.should.equal 'echo'
output[2].slug.should.equal 'echo'
output[2].quantity.should.equal 4
it 'does not allow "extras" before "recipe"', ->
@@ -235,7 +235,7 @@ describe 'ModVersionParserV2', ->
it 'registers slugs for each output name', ->
modVersion = parser.parse baseText + 'extras:Delta, Echo'
_.keys(modVersion.names).sort().should.eql ['bravo', 'charlie', 'delta', 'echo']
modVersion._slugs.should.eql ['bravo', 'charlie', 'delta', 'echo']
it 'does not allow a duplicate "extras" declaration', ->
func = -> parser.parse baseText + 'extras:Echo; extras:Delta'
@@ -248,17 +248,17 @@ describe 'ModVersionParserV2', ->
it 'can add a single tool', ->
modVersion = parser.parse baseText + 'tools: Furnace'
modVersion.items.bravo.recipes[0].tools[0].itemSlug.should.equal 'furnace'
modVersion._items.bravo._recipes[0].tools[0].slug.should.equal 'furnace'
it 'can add multiple tools', ->
modVersion = parser.parse baseText + 'tools: Crafting Table, Furnace'
tools = modVersion.items.bravo.recipes[0].tools
tools[0].itemSlug.should.equal 'crafting_table'
tools[1].itemSlug.should.equal 'furnace'
tools = modVersion._items.bravo._recipes[0].tools
tools[0].slug.should.equal 'crafting_table'
tools[1].slug.should.equal 'furnace'
it 'registers slugs for each tool name', ->
modVersion = parser.parse baseText + 'tools: Crafting Table, Furnace'
_.keys(modVersion.names).sort().should.eql ['bravo', 'charlie', 'crafting_table', 'furnace']
modVersion._slugs.should.eql ['bravo', 'charlie', 'crafting_table', 'furnace']
it 'does not allow a duplicate "tools" declaration', ->
func = -> parser.parse baseText + 'tools:Crafting Table; tools:Furnace'
test/test.coffee
+1
View File
@@ -21,6 +21,7 @@ global.util = require 'util'
Logger = require '../src/scripts/logger'
global.logger = new Logger level:Logger.TRACE
require '../src/scripts/polyfill'
require '../src/scripts/underscore_mixins'
# Test Registry ########################################################################################################