Convert cover and media player models to classes (#1197)

src/util/cover-model.js

@@ -1,117 +1,110 @@
-export default function CoverEntity(hass, stateObj) {
-  this.hass = hass;
-  this.stateObj = stateObj;
-}
-
-function addGetter(name, getter) {
-  Object.defineProperty(
-    CoverEntity.prototype, name,
-    { get: getter }
-  );
-}
-
-addGetter('isFullyOpen', function () {
-  if (this.stateObj.attributes.current_position !== undefined) {
-    return this.stateObj.attributes.current_position === 100;
-  }
-  return this.stateObj.state === 'open';
-});
-
-addGetter('isFullyClosed', function () {
-  if (this.stateObj.attributes.current_position !== undefined) {
-    return this.stateObj.attributes.current_position === 0;
-  }
-  return this.stateObj.state === 'closed';
-});
-
-addGetter('isFullyOpenTilt', function () {
-  return this.stateObj.attributes.current_tilt_position === 100;
-});
-
-addGetter('isFullyClosedTilt', function () {
-  return this.stateObj.attributes.current_tilt_position === 0;
-});
-
-/* eslint-disable no-bitwise */
-
-addGetter('supportsOpen', function () {
-  return (this.stateObj.attributes.supported_features & 1) !== 0;
-});
-
-addGetter('supportsClose', function () {
-  return (this.stateObj.attributes.supported_features & 2) !== 0;
-});
-
-addGetter('supportsSetPosition', function () {
-  return (this.stateObj.attributes.supported_features & 4) !== 0;
-});
-
-addGetter('supportsStop', function () {
-  return (this.stateObj.attributes.supported_features & 8) !== 0;
-});
-
-addGetter('supportsOpenTilt', function () {
-  return (this.stateObj.attributes.supported_features & 16) !== 0;
-});
-
-addGetter('supportsCloseTilt', function () {
-  return (this.stateObj.attributes.supported_features & 32) !== 0;
-});
-
-addGetter('supportsStopTilt', function () {
-  return (this.stateObj.attributes.supported_features & 64) !== 0;
-});
-
-addGetter('supportsSetTiltPosition', function () {
-  return (this.stateObj.attributes.supported_features & 128) !== 0;
-});
-
-addGetter('isTiltOnly', function () {
-  var supportsCover = this.supportsOpen || this.supportsClose || this.supportsStop;
-  var supportsTilt = this.supportsOpenTilt || this.supportsCloseTilt || this.supportsStopTilt;
-  return supportsTilt && !supportsCover;
-});
-
 /* eslint-enable no-bitwise */
+export default class CoverEntity {
+  constructor(hass, stateObj) {
+    this.hass = hass;
+    this.stateObj = stateObj;
+    this._attr = stateObj.attributes;
+    this._feat = this._attr.supported_features;
+  }
 
-Object.assign(CoverEntity.prototype, {
+  get isFullyOpen() {
-  openCover: function () {
+    if (this._attr.current_position !== undefined) {
+      return this._attr.current_position === 100;
+    }
+    return this.stateObj.state === 'open';
+  }
+
+  get isFullyClosed() {
+    if (this._attr.current_position !== undefined) {
+      return this._attr.current_position === 0;
+    }
+    return this.stateObj.state === 'closed';
+  }
+
+  get isFullyOpenTilt() {
+    return this._attr.current_tilt_position === 100;
+  }
+
+  get isFullyClosedTilt() {
+    return this._attr.current_tilt_position === 0;
+  }
+
+  /* eslint-disable no-bitwise */
+
+  get supportsOpen() {
+    return (this._feat & 1) !== 0;
+  }
+
+  get supportsClose() {
+    return (this._feat & 2) !== 0;
+  }
+
+  get supportsSetPosition() {
+    return (this._feat & 4) !== 0;
+  }
+
+  get supportsStop() {
+    return (this._feat & 8) !== 0;
+  }
+
+  get supportsOpenTilt() {
+    return (this._feat & 16) !== 0;
+  }
+
+  get supportsCloseTilt() {
+    return (this._feat & 32) !== 0;
+  }
+
+  get supportsStopTilt() {
+    return (this._feat & 64) !== 0;
+  }
+
+  get supportsSetTiltPosition() {
+    return (this._feat & 128) !== 0;
+  }
+
+  get isTiltOnly() {
+    var supportsCover = this.supportsOpen || this.supportsClose || this.supportsStop;
+    var supportsTilt = this.supportsOpenTilt || this.supportsCloseTilt || this.supportsStopTilt;
+    return supportsTilt && !supportsCover;
+  }
+
+  openCover() {
     this.callService('open_cover');
-  },
+  }
 
-  closeCover: function () {
+  closeCover() {
     this.callService('close_cover');
-  },
+  }
 
-  stopCover: function () {
+  stopCover() {
     this.callService('stop_cover');
-  },
+  }
 
-  openCoverTilt: function () {
+  openCoverTilt() {
     this.callService('open_cover_tilt');
-  },
+  }
 
-  closeCoverTilt: function () {
+  closeCoverTilt() {
     this.callService('close_cover_tilt');
-  },
+  }
 
-  stopCoverTilt: function () {
+  stopCoverTilt() {
     this.callService('stop_cover_tilt');
-  },
+  }
 
-  setCoverPosition: function (position) {
+  setCoverPosition(position) {
-    this.callService('set_cover_position', { position: position });
+    this.callService('set_cover_position', { position });
-  },
+  }
 
-  setCoverTiltPosition: function (tiltPosition) {
+  setCoverTiltPosition(tiltPosition) {
     this.callService('set_cover_tilt_position', { tilt_position: tiltPosition });
-  },
+  }
 
   // helper method
 
-  callService: function (service, data) {
+  callService(service, data = {}) {
-    var serviceData = data || {};
+    data.entity_id = this.stateObj.entity_id;
-    serviceData.entity_id = this.stateObj.entity_id;
+    this.hass.callService('cover', service, data);
-    this.hass.callService('cover', service, serviceData);
+  }
-  },
+}
-});

src/util/hass-media-player-model.js

@@ -1,210 +1,204 @@
-export default function HassMediaPlayerEntity(hass, stateObj) {
+export default class MediaPlayerEntity {
-  this.hass = hass;
+  constructor(hass, stateObj) {
-  this.stateObj = stateObj;
+    this.hass = hass;
-}
+    this.stateObj = stateObj;
-
+    this._attr = stateObj.attributes;
-function addGetter(name, getter) {
+    this._feat = this._attr.supported_features;
-  Object.defineProperty(
-    HassMediaPlayerEntity.prototype, name,
-    { get: getter }
-  );
-}
-
-addGetter('isOff', function () {
-  return this.stateObj.state === 'off';
-});
-
-addGetter('isIdle', function () {
-  return this.stateObj.state === 'idle';
-});
-
-addGetter('isMuted', function () {
-  return this.stateObj.attributes.is_volume_muted;
-});
-
-addGetter('isPaused', function () {
-  return this.stateObj.state === 'paused';
-});
-
-addGetter('isPlaying', function () {
-  return this.stateObj.state === 'playing';
-});
-
-addGetter('isMusic', function () {
-  return this.stateObj.attributes.media_content_type === 'music';
-});
-
-addGetter('isTVShow', function () {
-  return this.stateObj.attributes.media_content_type === 'tvshow';
-});
-
-addGetter('hasMediaControl', function () {
-  return ['playing', 'paused', 'unknown'].indexOf(this.stateObj.state) !== -1;
-});
-
-addGetter('volumeSliderValue', function () {
-  return this.stateObj.attributes.volume_level * 100;
-});
-
-addGetter('showProgress', function () {
-  return (
-    (this.isPlaying || this.isPaused) &&
-    'media_duration' in this.stateObj.attributes &&
-    'media_position' in this.stateObj.attributes &&
-    'media_position_updated_at' in this.stateObj.attributes);
-});
-
-addGetter('currentProgress', function () {
-  var progress = this.stateObj.attributes.media_position;
-  if (this.isPlaying) {
-    progress += (Date.now() -
-                 new Date(this.stateObj.attributes.media_position_updated_at).getTime()) / 1000.0;
   }
-  return progress;
-});
 
-/* eslint-disable no-bitwise */
+  get isOff() {
+    return this.stateObj.state === 'off';
+  }
 
-addGetter('supportsPause', function () {
+  get isIdle() {
-  return (this.stateObj.attributes.supported_features & 1) !== 0;
+    return this.stateObj.state === 'idle';
-});
+  }
 
-addGetter('supportsVolumeSet', function () {
+  get isMuted() {
-  return (this.stateObj.attributes.supported_features & 4) !== 0;
+    return this._attr.is_volume_muted;
-});
+  }
 
-addGetter('supportsVolumeMute', function () {
+  get isPaused() {
-  return (this.stateObj.attributes.supported_features & 8) !== 0;
+    return this.stateObj.state === 'paused';
-});
+  }
 
-addGetter('supportsPreviousTrack', function () {
+  get isPlaying() {
-  return (this.stateObj.attributes.supported_features & 16) !== 0;
+    return this.stateObj.state === 'playing';
-});
+  }
 
-addGetter('supportsNextTrack', function () {
+  get isMusic() {
-  return (this.stateObj.attributes.supported_features & 32) !== 0;
+    return this._attr.media_content_type === 'music';
-});
+  }
 
-addGetter('supportsTurnOn', function () {
+  get isTVShow() {
-  return (this.stateObj.attributes.supported_features & 128) !== 0;
+    return this._attr.media_content_type === 'tvshow';
-});
+  }
 
-addGetter('supportsTurnOff', function () {
+  get hasMediaControl() {
-  return (this.stateObj.attributes.supported_features & 256) !== 0;
+    return ['playing', 'paused', 'unknown'].indexOf(this.stateObj.state) !== -1;
-});
+  }
 
-addGetter('supportsPlayMedia', function () {
+  get volumeSliderValue() {
-  return (this.stateObj.attributes.supported_features & 512) !== 0;
+    return this._attr.volume_level * 100;
-});
+  }
 
-addGetter('supportsVolumeButtons', function () {
+  get showProgress() {
-  return (this.stateObj.attributes.supported_features & 1024) !== 0;
+    return (
-});
+      (this.isPlaying || this.isPaused) &&
+      'media_duration' in this.stateObj.attributes &&
+      'media_position' in this.stateObj.attributes &&
+      'media_position_updated_at' in this.stateObj.attributes);
+  }
 
-addGetter('supportsSelectSource', function () {
+  get currentProgress() {
-  return (this.stateObj.attributes.supported_features & 2048) !== 0;
+    var progress = this._attr.media_position;
-});
+    if (this.isPlaying) {
-
+      progress += (Date.now() -
-addGetter('supportsPlay', function () {
+                  new Date(this._attr.media_position_updated_at).getTime()) / 1000.0;
-  return (this.stateObj.attributes.supported_features & 16384) !== 0;
-});
-
-/* eslint-enable no-bitwise */
-
-addGetter('primaryTitle', function () {
-  return this.stateObj.attributes.media_title;
-});
-
-addGetter('secondaryTitle', function () {
-  if (this.isMusic) {
-    return this.stateObj.attributes.media_artist;
-  } else if (this.isTVShow) {
-    var text = this.stateObj.attributes.media_series_title;
-
-    if (this.stateObj.attributes.media_season) {
-      text += ' S' + this.stateObj.attributes.media_season;
-
-      if (this.stateObj.attributes.media_episode) {
-        text += 'E' + this.stateObj.attributes.media_episode;
-      }
     }
-
+    return progress;
-    return text;
-  } else if (this.stateObj.attributes.app_name) {
-    return this.stateObj.attributes.app_name;
   }
-  return '';
-});
 
-addGetter('source', function () {
+  /* eslint-disable no-bitwise */
-  return this.stateObj.attributes.source;
-});
 
-addGetter('sourceList', function () {
+  get supportsPause() {
-  return this.stateObj.attributes.source_list;
+    return (this._feat & 1) !== 0;
-});
+  }
 
-Object.assign(HassMediaPlayerEntity.prototype, {
+  get supportsVolumeSet() {
-  mediaPlayPause: function () {
+    return (this._feat & 4) !== 0;
+  }
+
+  get supportsVolumeMute() {
+    return (this._feat & 8) !== 0;
+  }
+
+  get supportsPreviousTrack() {
+    return (this._feat & 16) !== 0;
+  }
+
+  get supportsNextTrack() {
+    return (this._feat & 32) !== 0;
+  }
+
+  get supportsTurnOn() {
+    return (this._feat & 128) !== 0;
+  }
+
+  get supportsTurnOff() {
+    return (this._feat & 256) !== 0;
+  }
+
+  get supportsPlayMedia() {
+    return (this._feat & 512) !== 0;
+  }
+
+  get supportsVolumeButtons() {
+    return (this._feat & 1024) !== 0;
+  }
+
+  get supportsSelectSource() {
+    return (this._feat & 2048) !== 0;
+  }
+
+  get supportsPlay() {
+    return (this._feat & 16384) !== 0;
+  }
+
+  /* eslint-enable no-bitwise */
+
+  get primaryTitle() {
+    return this._attr.media_title;
+  }
+
+  get secondaryTitle() {
+    if (this.isMusic) {
+      return this._attr.media_artist;
+    } else if (this.isTVShow) {
+      var text = this._attr.media_series_title;
+
+      if (this._attr.media_season) {
+        text += ' S' + this._attr.media_season;
+
+        if (this._attr.media_episode) {
+          text += 'E' + this._attr.media_episode;
+        }
+      }
+
+      return text;
+    } else if (this._attr.app_name) {
+      return this._attr.app_name;
+    }
+    return '';
+  }
+
+  get source() {
+    return this._attr.source;
+  }
+
+  get sourceList() {
+    return this._attr.source_list;
+  }
+
+  mediaPlayPause() {
     this.callService('media_play_pause');
-  },
+  }
 
-  nextTrack: function () {
+  nextTrack() {
     this.callService('media_next_track');
-  },
+  }
 
-  playbackControl: function () {
+  playbackControl() {
     this.callService('media_play_pause');
-  },
+  }
 
-  previousTrack: function () {
+  previousTrack() {
     this.callService('media_previous_track');
-  },
+  }
 
-  setVolume: function (volume) {
+  setVolume(volume) {
     this.callService('volume_set', { volume_level: volume });
-  },
+  }
 
-  togglePower: function () {
+  togglePower() {
     if (this.isOff) {
       this.turnOn();
     } else {
       this.turnOff();
     }
-  },
+  }
 
-  turnOff: function () {
+  turnOff() {
     this.callService('turn_off');
-  },
+  }
 
-  turnOn: function () {
+  turnOn() {
     this.callService('turn_on');
-  },
+  }
 
-  volumeDown: function () {
+  volumeDown() {
     this.callService('volume_down');
-  },
+  }
 
-  volumeMute: function (mute) {
+  volumeMute(mute) {
     if (!this.supportsVolumeMute) {
       throw new Error('Muting volume not supported');
     }
     this.callService('volume_mute', { is_volume_muted: mute });
-  },
+  }
 
-  volumeUp: function () {
+  volumeUp() {
     this.callService('volume_up');
-  },
+  }
 
-  selectSource: function (sourceInput) {
+  selectSource(source) {
-    this.callService('select_source', { source: sourceInput });
+    this.callService('select_source', { source });
-  },
+  }
 
   // helper method
 
-  callService: function (service, data) {
+  callService(service, data = {}) {
-    var serviceData = data || {};
+    data.entity_id = this.stateObj.entity_id;
-    serviceData.entity_id = this.stateObj.entity_id;
+    this.hass.callService('media_player', service, data);
-    this.hass.callService('media_player', service, serviceData);
+  }
-  },
+}
-});