Deprecate PropertySet

[samreid]

As discussed in #71 and #101, PropertySet creates more problems than it solves and should be deprecated. The recommended pattern is described here #71 (comment)

with reset and disposal as described here:
#71 (comment)

If anyone wants to argue that PropertySet should be kept/fixed/etc, that should happen here. Otherwise, this issue is about how and when we will move away from PropertySet. Some possibilities:
(a) Replace all PropertySet occurrences now up front, then delete PropertySet immediately.
(b) Leave existing PropertySet occurrences for now, but no new code will use PropertySet
(c) When PhET-iO instrumenting a simulation, refactor away from PropertySet

We also have the possibility to refactor PropertySet as @pixelzoom described in https://github.com/phetsims/phet-io/issues/640 as an intermediate solution.

@jessegreenberg @pixelzoom @aadish @andrewadare @jbphet @jonathanolson please comment below and we'll decide at an upcoming developer meeting.

[samreid]

@jonathanolson proposed keeping ES5 get/set in #71 (comment) and I responded in #71 (comment)

[samreid]

We have to decide in #71 before doing anything here.

[pixelzoom]

Over in #71, we decided to move away from PropertySet. So it's constructor should be annotated as @deprectated.

[pixelzoom]

PropertySet constructor and its public public functions as now annotated as @deprecated.

Labeling for developer meeting to decide how to proceed with refactoring away from PropertySet.

[pixelzoom]

The repositories below use PropertySet. Shall we make an issue for each repository?

common code:

• joist
• scenery-phet
• sun
• vegas

simulations:

• area-builder (JB/DB)
• arithmetic (JB/DB)
• balancing-act (JB/DB)
• balloons-and-static-electricity
• bending-light (SR/DB)
• blackbody-spectrum
• build-a-molecule (JO)
• calculus-grapher (JO)
• capacitor-lab-basics
• charges-and-fields (MV)
• circuit-construction-kit-basics (SR/DB)
• color-vision (CM)
• curve-fitting
• energy-skate-park-basics (SR)
• faradays-law (JB/DB)
• fluid-pressure-and-flow (MK)
• forces-and-motion-basics (JG/MB)
• fraction-comparison
• fraction-matcher (SR)
• friction (JB/DB)
• gravity-and-orbits (JG/MB)
• gravity-force-lab-basics
• john-travoltage
• least-squares-regression
• masses-and-springs
• molecule-shapes (DB)
• molecules-and-light (JG/MB)
• neuron (JB/DB)
• ohms-law
• optics-lab (MV)
• pendulum-lab (JO)
• projectile-motion
• proportion-playground
• protein-synthesis (SR)
• resistance-in-a-wire
• rutherford-scattering (JG/MB)
• seasons (some intern sometime - CM)
• sugar-and-salt-solutions (SR)
• trig-tour (JG/MB)
• wave-on-a-string

[samreid]

There are 160 occurrences of PropertySet.call and 20 occurrences of new PropertySet.

[pixelzoom]

I removed PropertySet from simula-rasa, blast, chains and vegas.

[samreid]

@ariel-phet recommended to create 30+ issues, one per each repo. Even better: Let's add a note to the "how to instrument" doc to this effect.

@pixelzoom says we should fix the common code that uses propertyset. @pixelzoom will create issues for that.

@jbphet will tackle ButtonModel.

[samreid]

I finished removing usages of PropertySet then I deleted PropertySet. I'm going to let Bayes use preventGetSet for a few days in Fluid Pressure and Flow before deleting that. Also leaving this issue open in case there is anything else to discuss about it. Is the next step to "eliminate" Events? #83 Eliminate is in quotes because we may keep it or a variant of it for scenery node.

UPDATE: #142 seems a better reference for emitter/events.

[pixelzoom]

Agreed, #142 is the reference for converting Events to Emitter.

Looks like our work here is done?

[zepumph]

Good work everyone, that was a biggy!