openstudio-workflow 1.2.1 → 1.2.2

data/lib/openstudio/workflow/util/weather_file.rb

@@ -1,108 +1,108 @@
-module OpenStudio
-  module Workflow
-    module Util
-      # The current precedence rules for weather files are defined in this module. Best practice is to only use the
-      #  #get_weather_file method, as it will be forward compatible
-      #
-      module WeatherFile
-        # Returns the weather file with precedence
-        #
-        # @param [String] directory The directory to append all relative directories to, see #get_weather_file_from_fs
-        # @param [String] wf The weather file being searched for. If not the name of the file this parameter should be
-        #   the absolute path specifying it's location
-        # @param [Array] wf_search_array The set of precedence ordered relative directories to search for the wf in. A
-        #   typical entry might look like `['files', '../../files', '../../weather']`
-        # @param [Object] model The OpenStudio::Model object to parse, see #get_weather_file_from_osm
-        # @return [String, nil] The weather file with precedence if defined, nil if not, and a failure if the wf is
-        #   defined but not in the filesystem
-        #
-        def get_weather_file(directory, wf, wf_search_array, model, logger = nil)
-          # TODO: this logic needs some updating, weather file should come from current model, found using search paths
-          logger ||= ::Logger.new(STDOUT) unless logger
-          if wf
-            weather_file = get_weather_file_from_fs(directory, wf, wf_search_array, logger)
-            raise 'Could not locate the weather file in the filesystem. Please see the log' if weather_file == false
-          end
-          weather_file = get_weather_file_from_osm(model, logger) if weather_file.nil?
-          raise 'Could not locate the weather file in the filesystem. Please see the log' if weather_file == false
-          logger.warn 'The weather file could not be determined. Please see the log for details' unless weather_file
-          weather_file
-        end
-
-        private
-
-        # Returns the weather file from the model. If the weather file is defined in the model, then
-        # it checks the file paths to check if the model exists. This allows for a user to upload a
-        # weather file in a measure and then have the measure's path be used for the weather file.
-        #
-        # @todo (rhorsey) verify the description of this method, as it seems suspect
-        # @param [Object] model The OpenStudio::Model object to retrieve the weather file from
-        # @return [nil,false, String] If the result is nil the weather file was not defined in the model, if the result
-        #   is false the weather file was set but could not be found on the filesystem, if a string the weather file was
-        #   defined and it's existence verified
-        #
-        def get_weather_file_from_osm(model, logger)
-          wf = nil
-          # grab the weather file out of the OSM if it exists
-          if model.weatherFile.empty?
-            logger.warn 'No weather file defined in the model'
-          else
-            p = model.weatherFile.get.path.get.to_s.gsub('file://', '')
-            wf = if File.exist? p
-                   File.absolute_path(p)
-                 else
-                   # this is the weather file from the OSM model
-                   File.absolute_path(@model.weatherFile.get.path.get.to_s)
-                 end
-            logger.info "The weather file path found in the model object: #{wf}"
-            unless File.exist? wf
-              logger.warn 'The weather file could not be found on the filesystem.'
-              wf = false
-            end
-          end
-          wf
-        end
-
-        # Returns the weather file defined in the OSW
-        #
-        # @param [String] directory The base directory to append all relative directories to
-        # @param [String] wf The weather file being searched for. If not the name of the file this parameter should be
-        #   the absolute path specifying it's location
-        # @param [Array] wf_search_array The set of precedence ordered relative directories to search for the wf in. A
-        #   typical entry might look like `['files', '../../files', '../../weather']`
-        # @return [nil, false, String] If the result is nil the weather file was not defined in the workflow, if the
-        #   result is false the weather file was set but could not be found on the filesystem, if a string the weather
-        #   file was defined and it's existence verified. The order of precedence for paths is as follows: 1 - an
-        #   absolute path defined in wf, 2 - the wf_search_array, should it be defined, joined with the weather file and
-        #   appended to the directory, with each entry in the array searched until the wf is found
-        #
-        def get_weather_file_from_fs(directory, wf, wf_search_array, logger)
-          raise "wf was defined as #{wf}. Please correct" unless wf
-          weather_file = nil
-          if Pathname.new(wf).absolute?
-            weather_file = wf
-          else
-            wf_search_array.each do |wf_dir|
-              logger.warn "The path #{wf_dir} does not exist" unless File.exist? File.join(directory, wf_dir)
-              next unless File.exist? File.join(directory, wf_dir)
-              if Dir.entries(File.join(directory, wf_dir)).include? File.basename(wf)
-                weather_file = File.absolute_path(File.join(directory, wf_dir, wf))
-                break
-              end
-            end
-          end
-          unless weather_file
-            logger.warn 'The weather file was not found on the filesystem'
-            return nil
-          end
-          logger.info "Weather file with precedence in the file system is #{weather_file}"
-          unless File.exist? weather_file
-            logger.warn 'The weather file could not be found on the filesystem'
-            weather_file = false
-          end
-          weather_file
-        end
-      end
-    end
-  end
-end
+module OpenStudio
+  module Workflow
+    module Util
+      # The current precedence rules for weather files are defined in this module. Best practice is to only use the
+      #  #get_weather_file method, as it will be forward compatible
+      #
+      module WeatherFile
+        # Returns the weather file with precedence
+        #
+        # @param [String] directory The directory to append all relative directories to, see #get_weather_file_from_fs
+        # @param [String] wf The weather file being searched for. If not the name of the file this parameter should be
+        #   the absolute path specifying it's location
+        # @param [Array] wf_search_array The set of precedence ordered relative directories to search for the wf in. A
+        #   typical entry might look like `['files', '../../files', '../../weather']`
+        # @param [Object] model The OpenStudio::Model object to parse, see #get_weather_file_from_osm
+        # @return [String, nil] The weather file with precedence if defined, nil if not, and a failure if the wf is
+        #   defined but not in the filesystem
+        #
+        def get_weather_file(directory, wf, wf_search_array, model, logger = nil)
+          # TODO: this logic needs some updating, weather file should come from current model, found using search paths
+          logger ||= ::Logger.new(STDOUT) unless logger
+          if wf
+            weather_file = get_weather_file_from_fs(directory, wf, wf_search_array, logger)
+            raise 'Could not locate the weather file in the filesystem. Please see the log' if weather_file == false
+          end
+          weather_file = get_weather_file_from_osm(model, logger) if weather_file.nil?
+          raise 'Could not locate the weather file in the filesystem. Please see the log' if weather_file == false
+          logger.warn 'The weather file could not be determined. Please see the log for details' unless weather_file
+          weather_file
+        end
+
+        private
+
+        # Returns the weather file from the model. If the weather file is defined in the model, then
+        # it checks the file paths to check if the model exists. This allows for a user to upload a
+        # weather file in a measure and then have the measure's path be used for the weather file.
+        #
+        # @todo (rhorsey) verify the description of this method, as it seems suspect
+        # @param [Object] model The OpenStudio::Model object to retrieve the weather file from
+        # @return [nil,false, String] If the result is nil the weather file was not defined in the model, if the result
+        #   is false the weather file was set but could not be found on the filesystem, if a string the weather file was
+        #   defined and it's existence verified
+        #
+        def get_weather_file_from_osm(model, logger)
+          wf = nil
+          # grab the weather file out of the OSM if it exists
+          if model.weatherFile.empty?
+            logger.warn 'No weather file defined in the model'
+          else
+            p = model.weatherFile.get.path.get.to_s.gsub('file://', '')
+            wf = if File.exist? p
+                   File.absolute_path(p)
+                 else
+                   # this is the weather file from the OSM model
+                   File.absolute_path(@model.weatherFile.get.path.get.to_s)
+                 end
+            logger.info "The weather file path found in the model object: #{wf}"
+            unless File.exist? wf
+              logger.warn 'The weather file could not be found on the filesystem.'
+              wf = false
+            end
+          end
+          wf
+        end
+
+        # Returns the weather file defined in the OSW
+        #
+        # @param [String] directory The base directory to append all relative directories to
+        # @param [String] wf The weather file being searched for. If not the name of the file this parameter should be
+        #   the absolute path specifying it's location
+        # @param [Array] wf_search_array The set of precedence ordered relative directories to search for the wf in. A
+        #   typical entry might look like `['files', '../../files', '../../weather']`
+        # @return [nil, false, String] If the result is nil the weather file was not defined in the workflow, if the
+        #   result is false the weather file was set but could not be found on the filesystem, if a string the weather
+        #   file was defined and it's existence verified. The order of precedence for paths is as follows: 1 - an
+        #   absolute path defined in wf, 2 - the wf_search_array, should it be defined, joined with the weather file and
+        #   appended to the directory, with each entry in the array searched until the wf is found
+        #
+        def get_weather_file_from_fs(directory, wf, wf_search_array, logger)
+          raise "wf was defined as #{wf}. Please correct" unless wf
+          weather_file = nil
+          if Pathname.new(wf).absolute?
+            weather_file = wf
+          else
+            wf_search_array.each do |wf_dir|
+              logger.warn "The path #{wf_dir} does not exist" unless File.exist? File.join(directory, wf_dir)
+              next unless File.exist? File.join(directory, wf_dir)
+              if Dir.entries(File.join(directory, wf_dir)).include? File.basename(wf)
+                weather_file = File.absolute_path(File.join(directory, wf_dir, wf))
+                break
+              end
+            end
+          end
+          unless weather_file
+            logger.warn 'The weather file was not found on the filesystem'
+            return nil
+          end
+          logger.info "Weather file with precedence in the file system is #{weather_file}"
+          unless File.exist? weather_file
+            logger.warn 'The weather file could not be found on the filesystem'
+            weather_file = false
+          end
+          weather_file
+        end
+      end
+    end
+  end
+end

data/lib/openstudio/workflow/version.rb

@@ -1,24 +1,24 @@
-######################################################################
-#  Copyright (c) 2008-2014, Alliance for Sustainable Energy.
-#  All rights reserved.
-#
-#  This library is free software; you can redistribute it and/or
-#  modify it under the terms of the GNU Lesser General Public
-#  License as published by the Free Software Foundation; either
-#  version 2.1 of the License, or (at your option) any later version.
-#
-#  This library is distributed in the hope that it will be useful,
-#  but WITHOUT ANY WARRANTY; without even the implied warranty of
-#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-#  Lesser General Public License for more details.
-#
-#  You should have received a copy of the GNU Lesser General Public
-#  License along with this library; if not, write to the Free Software
-#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
-######################################################################
-
-module OpenStudio
-  module Workflow
-    VERSION = '1.2.1'.freeze # Suffixes must have periods (not dashes)
-  end
-end
+######################################################################
+#  Copyright (c) 2008-2014, Alliance for Sustainable Energy.
+#  All rights reserved.
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License, or (at your option) any later version.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+######################################################################
+
+module OpenStudio
+  module Workflow
+    VERSION = '1.2.2'.freeze # Suffixes must have periods (not dashes)
+  end
+end

data/lib/openstudio/workflow_json.rb

@@ -1,426 +1,426 @@
-######################################################################
-#  Copyright (c) 2008-2014, Alliance for Sustainable Energy.
-#  All rights reserved.
-#
-#  This library is free software; you can redistribute it and/or
-#  modify it under the terms of the GNU Lesser General Public
-#  License as published by the Free Software Foundation; either
-#  version 2.1 of the License, or (at your option) any later version.
-#
-#  This library is distributed in the hope that it will be useful,
-#  but WITHOUT ANY WARRANTY; without even the implied warranty of
-#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-#  Lesser General Public License for more details.
-#
-#  You should have received a copy of the GNU Lesser General Public
-#  License along with this library; if not, write to the Free Software
-#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
-######################################################################
-
-require 'pathname'
-
-# Optional_Shim provides a wrapper that looks like an OpenStudio Optional
-class Optional_Shim
-  def initialize(obj)
-    @obj = obj
-  end
-
-  def empty?
-    @obj.nil?
-  end
-
-  def is_initialized
-    !@obj.nil?
-  end
-
-  def get
-    raise 'Uninitialized Optional_Shim' if @obj.nil?
-    @obj
-  end
-end
-
-s = ''
-unless s.respond_to?(:to_StepResult)
-  class String
-    def to_StepResult
-      self
-    end
-  end
-end
-unless s.respond_to?(:to_VariantType)
-  class String
-    def to_VariantType
-      self
-    end
-  end
-end
-unless s.respond_to?(:valueName)
-  class String
-    def valueName
-      self
-    end
-  end
-end
-
-# WorkflowStepResultValue_Shim provides a shim interface to the WorkflowStepResultValue class in OpenStudio 2.X when running in OpenStudio 1.X
-class WorkflowStepResultValue_Shim
-  def initialize(name, value, type)
-    @name = name
-    @value = value
-    @type = type
-  end
-
-  attr_reader :name
-
-  attr_reader :value
-
-  def variantType
-    @type
-  end
-
-  def valueAsString
-    @value.to_s
-  end
-
-  def valueAsDouble
-    @value.to_f
-  end
-
-  def valueAsInteger
-    @value.to_i
-  end
-
-  def valueAsBoolean
-    @value
-  end
-end
-
-# WorkflowStepResult_Shim provides a shim interface to the WorkflowStepResult class in OpenStudio 2.X when running in OpenStudio 1.X
-class WorkflowStepResult_Shim
-  def initialize(result)
-    @result = result
-  end
-
-  def stepInitialCondition
-    if @result[:initial_condition]
-      return Optional_Shim.new(@result[:initial_condition])
-    end
-    return Optional_Shim.new(nil)
-  end
-  
-  def stepFinalCondition
-    if @result[:final_condition]
-      return Optional_Shim.new(@result[:final_condition])
-    end
-    return Optional_Shim.new(nil)
-  end
-  
-  def stepErrors
-    return @result[:step_errors]
-  end
-
-  def stepWarnings
-    return @result[:step_warnings]
-  end
-
-  def stepInfo
-    return @result[:step_info]
-  end
-
-  def stepValues
-    result = []
-    @result[:step_values].each do |step_value|
-      result << WorkflowStepResultValue_Shim.new(step_value[:name], step_value[:value], step_value[:type])
-    end
-    return result
-  end
-
-  def stepResult
-    Optional_Shim.new(@result[:step_result])
-  end
-  
-   def setStepResult(step_result)
-    @result[:step_result] = step_result
-  end 
-   
-end
-
-# WorkflowStep_Shim provides a shim interface to the WorkflowStep class in OpenStudio 2.X when running in OpenStudio 1.X
-class WorkflowStep_Shim
-  def initialize(step)
-    @step = step
-  end
-
-  attr_reader :step
-
-  def result
-    if @step[:result]
-      Optional_Shim.new(WorkflowStepResult_Shim.new(@step[:result]))
-    else
-      Optional_Shim.new
-    end
-  end
-
-  # std::string measureDirName() const;
-  def measureDirName
-    @step[:measure_dir_name]
-  end
-
-  # std::map<std::string, Variant> arguments() const;
-  def arguments
-    # TODO: match C++
-    @step[:arguments]
-  end
-end
-
-# WorkflowJSON_Shim provides a shim interface to the WorkflowJSON class in OpenStudio 2.X when running in OpenStudio 1.X
-class WorkflowJSON_Shim
-  def initialize(workflow, osw_dir)
-    @workflow = workflow
-    @osw_dir = osw_dir
-    @current_step_index = 0
-  end
-
-  # std::string string(bool includeHash=true) const;
-  def string
-    JSON.fast_generate(@workflow)
-  end
-  
-  def timeString
-    ::Time.now.utc.strftime("%Y%m%dT%H%M%SZ")
-  end
-
-  # Returns the absolute path to the directory this workflow was loaded from or saved to.  Returns current working dir for new WorkflowJSON.
-  # openstudio::path oswDir() const;
-  def oswDir
-    OpenStudio.toPath(@osw_dir)
-  end
-
-  def saveAs(path)
-    File.open(path.to_s, 'w') do |file|
-      file << JSON.pretty_generate(@workflow)
-    end
-  end
-
-  # Sets the started at time.
-  def start
-    @workflow[:started_at] = timeString
-  end
-
-  # Get the current step index.
-  def currentStepIndex
-    @current_step_index
-  end
-
-  # Get the current step.
-  # boost::optional<WorkflowStep> currentStep() const;
-  def currentStep
-    steps = @workflow[:steps]
-
-    step = nil
-    if @current_step_index < steps.size
-      step = WorkflowStep_Shim.new(steps[@current_step_index])
-    end
-    return Optional_Shim.new(step)
-  end
-
-  # Increments current step, returns true if there is another step.
-  # bool incrementStep();
-  def incrementStep
-    @current_step_index += 1
-
-    if @current_step_index < @workflow[:steps].size
-      return true
-    end
-
-    return false
-  end
-
-  # Returns the root directory, default value is '.'. Evaluated relative to oswDir if not absolute.
-  # openstudio::path rootDir() const;
-  # openstudio::path absoluteRootDir() const;
-  def rootDir
-    if @workflow[:root_dir]
-      OpenStudio.toPath(@workflow[:root_dir])
-    else
-      OpenStudio.toPath(@osw_dir)
-    end
-  end
-
-  def absoluteRootDir
-    OpenStudio.toPath(File.absolute_path(rootDir.to_s, @osw_dir.to_s))
-  end
-
-  # Returns the run directory, default value is './run'. Evaluated relative to rootDir if not absolute.
-  # openstudio::path runDir() const;
-  # openstudio::path absoluteRunDir() const;
-  def runDir
-    if @workflow[:run_directory]
-      OpenStudio.toPath(@workflow[:run_directory])
-    else
-      OpenStudio.toPath('./run')
-    end
-  end
-
-  def absoluteRunDir
-    OpenStudio.toPath(File.absolute_path(runDir.to_s, rootDir.to_s))
-  end
-
-  def outPath
-    if @workflow[:out_name]
-      OpenStudio.toPath(@workflow[:out_name])
-    else
-      OpenStudio.toPath('./out.osw')
-    end
-  end
-
-  def absoluteOutPath
-    OpenStudio.toPath(File.absolute_path(outPath.to_s, oswDir.to_s))
-  end
-
-  # Returns the paths that will be searched in order for files, default value is './files/'. Evaluated relative to rootDir if not absolute.
-  # std::vector<openstudio::path> filePaths() const;
-  # std::vector<openstudio::path> absoluteFilePaths() const;
-  def filePaths
-    result = OpenStudio::PathVector.new
-    if @workflow[:file_paths]
-      @workflow[:file_paths].each do |file_path|
-        result << OpenStudio.toPath(file_path)
-      end
-    else
-      result << OpenStudio.toPath('./files')
-      result << OpenStudio.toPath('./weather')
-      result << OpenStudio.toPath('../../files')
-      result << OpenStudio.toPath('../../weather')
-      result << OpenStudio.toPath('./')
-    end
-    result
-  end
-
-  def absoluteFilePaths
-    result = OpenStudio::PathVector.new
-    filePaths.each do |file_path|
-      result << OpenStudio.toPath(File.absolute_path(file_path.to_s, rootDir.to_s))
-    end
-    result
-  end
-
-  # Attempts to find a file by name, searches through filePaths in order and returns first match.
-  # boost::optional<openstudio::path> findFile(const openstudio::path& file);
-  # boost::optional<openstudio::path> findFile(const std::string& fileName);
-  def findFile(file)
-    file = file.to_s
-
-    # check if absolute and exists
-    if Pathname.new(file).absolute?
-      if File.exist?(file)
-        return OpenStudio::OptionalPath.new(OpenStudio.toPath(file))
-      end
-
-      # absolute path does not exist
-      return OpenStudio::OptionalPath.new
-    end
-
-    absoluteFilePaths.each do |file_path|
-      result = File.join(file_path.to_s, file)
-      if File.exist?(result)
-        return OpenStudio::OptionalPath.new(OpenStudio.toPath(result))
-      end
-    end
-    OpenStudio::OptionalPath.new
-  end
-
-  # Returns the paths that will be searched in order for measures, default value is './measures/'. Evaluated relative to rootDir if not absolute.
-  # std::vector<openstudio::path> measurePaths() const;
-  # std::vector<openstudio::path> absoluteMeasurePaths() const;
-  def measurePaths
-    result = OpenStudio::PathVector.new
-    if @workflow[:measure_paths]
-      @workflow[:measure_paths].each do |measure_path|
-        result << OpenStudio.toPath(measure_path)
-      end
-    else
-      result << OpenStudio.toPath('./measures')
-      result << OpenStudio.toPath('../../measures')
-      result << OpenStudio.toPath('./')
-    end
-    result
-  end
-
-  def absoluteMeasurePaths
-    result = OpenStudio::PathVector.new
-    measurePaths.each do |measure_path|
-      result << OpenStudio.toPath(File.absolute_path(measure_path.to_s, rootDir.to_s))
-    end
-    result
-  end
-
-  # Attempts to find a measure by name, searches through measurePaths in order and returns first match. */
-  # boost::optional<openstudio::path> findMeasure(const openstudio::path& measureDir);
-  # boost::optional<openstudio::path> findMeasure(const std::string& measureDirName);
-  def findMeasure(measureDir)
-    measureDir = measureDir.to_s
-
-    # check if absolute and exists
-    if Pathname.new(measureDir).absolute?
-      if File.exist?(measureDir)
-        return OpenStudio::OptionalPath.new(OpenStudio.toPath(measureDir))
-      end
-
-      # absolute path does not exist
-      return OpenStudio::OptionalPath.new
-    end
-
-    absoluteMeasurePaths.each do |measure_path|
-      result = File.join(measure_path.to_s, measureDir)
-      if File.exist?(result)
-        return OpenStudio::OptionalPath.new(OpenStudio.toPath(result))
-      end
-    end
-    OpenStudio::OptionalPath.new
-  end
-
-  # Returns the seed file path. Evaluated relative to filePaths if not absolute.
-  # boost::optional<openstudio::path> seedFile() const;
-  def seedFile
-    result = OpenStudio::OptionalPath.new
-    if @workflow[:seed_file]
-      result = OpenStudio::OptionalPath.new(OpenStudio.toPath(@workflow[:seed_file]))
-    end
-    result
-  end
-
-  # Returns the weather file path. Evaluated relative to filePaths if not absolute.
-  # boost::optional<openstudio::path> weatherFile() const;
-  def weatherFile
-    result = OpenStudio::OptionalPath.new
-    if @workflow[:weather_file]
-      result = OpenStudio::OptionalPath.new(OpenStudio.toPath(@workflow[:weather_file]))
-    end
-    result
-  end
-
-  # Returns the workflow steps. */
-  # std::vector<WorkflowStep> workflowSteps() const;
-  def workflowSteps
-    result = []
-    @workflow[:steps].each do |step|
-      result << WorkflowStep_Shim.new(step)
-    end
-    result
-  end
-
-  def setCompletedStatus(status)
-    @workflow[:completed_status] = status
-    @workflow[:completed_at] = timeString
-  end
-  
-  def setEplusoutErr(eplusout_err)
-    @workflow[:eplusout_err] = eplusout_err
-  end
-  
-  # return empty optional
-  def runOptions
-    return Optional_Shim.new(nil)
-  end
-end
+######################################################################
+#  Copyright (c) 2008-2014, Alliance for Sustainable Energy.
+#  All rights reserved.
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License, or (at your option) any later version.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+######################################################################
+
+require 'pathname'
+
+# Optional_Shim provides a wrapper that looks like an OpenStudio Optional
+class Optional_Shim
+  def initialize(obj)
+    @obj = obj
+  end
+
+  def empty?
+    @obj.nil?
+  end
+
+  def is_initialized
+    !@obj.nil?
+  end
+
+  def get
+    raise 'Uninitialized Optional_Shim' if @obj.nil?
+    @obj
+  end
+end
+
+s = ''
+unless s.respond_to?(:to_StepResult)
+  class String
+    def to_StepResult
+      self
+    end
+  end
+end
+unless s.respond_to?(:to_VariantType)
+  class String
+    def to_VariantType
+      self
+    end
+  end
+end
+unless s.respond_to?(:valueName)
+  class String
+    def valueName
+      self
+    end
+  end
+end
+
+# WorkflowStepResultValue_Shim provides a shim interface to the WorkflowStepResultValue class in OpenStudio 2.X when running in OpenStudio 1.X
+class WorkflowStepResultValue_Shim
+  def initialize(name, value, type)
+    @name = name
+    @value = value
+    @type = type
+  end
+
+  attr_reader :name
+
+  attr_reader :value
+
+  def variantType
+    @type
+  end
+
+  def valueAsString
+    @value.to_s
+  end
+
+  def valueAsDouble
+    @value.to_f
+  end
+
+  def valueAsInteger
+    @value.to_i
+  end
+
+  def valueAsBoolean
+    @value
+  end
+end
+
+# WorkflowStepResult_Shim provides a shim interface to the WorkflowStepResult class in OpenStudio 2.X when running in OpenStudio 1.X
+class WorkflowStepResult_Shim
+  def initialize(result)
+    @result = result
+  end
+
+  def stepInitialCondition
+    if @result[:initial_condition]
+      return Optional_Shim.new(@result[:initial_condition])
+    end
+    return Optional_Shim.new(nil)
+  end
+  
+  def stepFinalCondition
+    if @result[:final_condition]
+      return Optional_Shim.new(@result[:final_condition])
+    end
+    return Optional_Shim.new(nil)
+  end
+  
+  def stepErrors
+    return @result[:step_errors]
+  end
+
+  def stepWarnings
+    return @result[:step_warnings]
+  end
+
+  def stepInfo
+    return @result[:step_info]
+  end
+
+  def stepValues
+    result = []
+    @result[:step_values].each do |step_value|
+      result << WorkflowStepResultValue_Shim.new(step_value[:name], step_value[:value], step_value[:type])
+    end
+    return result
+  end
+
+  def stepResult
+    Optional_Shim.new(@result[:step_result])
+  end
+  
+   def setStepResult(step_result)
+    @result[:step_result] = step_result
+  end 
+   
+end
+
+# WorkflowStep_Shim provides a shim interface to the WorkflowStep class in OpenStudio 2.X when running in OpenStudio 1.X
+class WorkflowStep_Shim
+  def initialize(step)
+    @step = step
+  end
+
+  attr_reader :step
+
+  def result
+    if @step[:result]
+      Optional_Shim.new(WorkflowStepResult_Shim.new(@step[:result]))
+    else
+      Optional_Shim.new
+    end
+  end
+
+  # std::string measureDirName() const;
+  def measureDirName
+    @step[:measure_dir_name]
+  end
+
+  # std::map<std::string, Variant> arguments() const;
+  def arguments
+    # TODO: match C++
+    @step[:arguments]
+  end
+end
+
+# WorkflowJSON_Shim provides a shim interface to the WorkflowJSON class in OpenStudio 2.X when running in OpenStudio 1.X
+class WorkflowJSON_Shim
+  def initialize(workflow, osw_dir)
+    @workflow = workflow
+    @osw_dir = osw_dir
+    @current_step_index = 0
+  end
+
+  # std::string string(bool includeHash=true) const;
+  def string
+    JSON.fast_generate(@workflow)
+  end
+  
+  def timeString
+    ::Time.now.utc.strftime("%Y%m%dT%H%M%SZ")
+  end
+
+  # Returns the absolute path to the directory this workflow was loaded from or saved to.  Returns current working dir for new WorkflowJSON.
+  # openstudio::path oswDir() const;
+  def oswDir
+    OpenStudio.toPath(@osw_dir)
+  end
+
+  def saveAs(path)
+    File.open(path.to_s, 'w') do |file|
+      file << JSON.pretty_generate(@workflow)
+    end
+  end
+
+  # Sets the started at time.
+  def start
+    @workflow[:started_at] = timeString
+  end
+
+  # Get the current step index.
+  def currentStepIndex
+    @current_step_index
+  end
+
+  # Get the current step.
+  # boost::optional<WorkflowStep> currentStep() const;
+  def currentStep
+    steps = @workflow[:steps]
+
+    step = nil
+    if @current_step_index < steps.size
+      step = WorkflowStep_Shim.new(steps[@current_step_index])
+    end
+    return Optional_Shim.new(step)
+  end
+
+  # Increments current step, returns true if there is another step.
+  # bool incrementStep();
+  def incrementStep
+    @current_step_index += 1
+
+    if @current_step_index < @workflow[:steps].size
+      return true
+    end
+
+    return false
+  end
+
+  # Returns the root directory, default value is '.'. Evaluated relative to oswDir if not absolute.
+  # openstudio::path rootDir() const;
+  # openstudio::path absoluteRootDir() const;
+  def rootDir
+    if @workflow[:root_dir]
+      OpenStudio.toPath(@workflow[:root_dir])
+    else
+      OpenStudio.toPath(@osw_dir)
+    end
+  end
+
+  def absoluteRootDir
+    OpenStudio.toPath(File.absolute_path(rootDir.to_s, @osw_dir.to_s))
+  end
+
+  # Returns the run directory, default value is './run'. Evaluated relative to rootDir if not absolute.
+  # openstudio::path runDir() const;
+  # openstudio::path absoluteRunDir() const;
+  def runDir
+    if @workflow[:run_directory]
+      OpenStudio.toPath(@workflow[:run_directory])
+    else
+      OpenStudio.toPath('./run')
+    end
+  end
+
+  def absoluteRunDir
+    OpenStudio.toPath(File.absolute_path(runDir.to_s, rootDir.to_s))
+  end
+
+  def outPath
+    if @workflow[:out_name]
+      OpenStudio.toPath(@workflow[:out_name])
+    else
+      OpenStudio.toPath('./out.osw')
+    end
+  end
+
+  def absoluteOutPath
+    OpenStudio.toPath(File.absolute_path(outPath.to_s, oswDir.to_s))
+  end
+
+  # Returns the paths that will be searched in order for files, default value is './files/'. Evaluated relative to rootDir if not absolute.
+  # std::vector<openstudio::path> filePaths() const;
+  # std::vector<openstudio::path> absoluteFilePaths() const;
+  def filePaths
+    result = OpenStudio::PathVector.new
+    if @workflow[:file_paths]
+      @workflow[:file_paths].each do |file_path|
+        result << OpenStudio.toPath(file_path)
+      end
+    else
+      result << OpenStudio.toPath('./files')
+      result << OpenStudio.toPath('./weather')
+      result << OpenStudio.toPath('../../files')
+      result << OpenStudio.toPath('../../weather')
+      result << OpenStudio.toPath('./')
+    end
+    result
+  end
+
+  def absoluteFilePaths
+    result = OpenStudio::PathVector.new
+    filePaths.each do |file_path|
+      result << OpenStudio.toPath(File.absolute_path(file_path.to_s, rootDir.to_s))
+    end
+    result
+  end
+
+  # Attempts to find a file by name, searches through filePaths in order and returns first match.
+  # boost::optional<openstudio::path> findFile(const openstudio::path& file);
+  # boost::optional<openstudio::path> findFile(const std::string& fileName);
+  def findFile(file)
+    file = file.to_s
+
+    # check if absolute and exists
+    if Pathname.new(file).absolute?
+      if File.exist?(file)
+        return OpenStudio::OptionalPath.new(OpenStudio.toPath(file))
+      end
+
+      # absolute path does not exist
+      return OpenStudio::OptionalPath.new
+    end
+
+    absoluteFilePaths.each do |file_path|
+      result = File.join(file_path.to_s, file)
+      if File.exist?(result)
+        return OpenStudio::OptionalPath.new(OpenStudio.toPath(result))
+      end
+    end
+    OpenStudio::OptionalPath.new
+  end
+
+  # Returns the paths that will be searched in order for measures, default value is './measures/'. Evaluated relative to rootDir if not absolute.
+  # std::vector<openstudio::path> measurePaths() const;
+  # std::vector<openstudio::path> absoluteMeasurePaths() const;
+  def measurePaths
+    result = OpenStudio::PathVector.new
+    if @workflow[:measure_paths]
+      @workflow[:measure_paths].each do |measure_path|
+        result << OpenStudio.toPath(measure_path)
+      end
+    else
+      result << OpenStudio.toPath('./measures')
+      result << OpenStudio.toPath('../../measures')
+      result << OpenStudio.toPath('./')
+    end
+    result
+  end
+
+  def absoluteMeasurePaths
+    result = OpenStudio::PathVector.new
+    measurePaths.each do |measure_path|
+      result << OpenStudio.toPath(File.absolute_path(measure_path.to_s, rootDir.to_s))
+    end
+    result
+  end
+
+  # Attempts to find a measure by name, searches through measurePaths in order and returns first match. */
+  # boost::optional<openstudio::path> findMeasure(const openstudio::path& measureDir);
+  # boost::optional<openstudio::path> findMeasure(const std::string& measureDirName);
+  def findMeasure(measureDir)
+    measureDir = measureDir.to_s
+
+    # check if absolute and exists
+    if Pathname.new(measureDir).absolute?
+      if File.exist?(measureDir)
+        return OpenStudio::OptionalPath.new(OpenStudio.toPath(measureDir))
+      end
+
+      # absolute path does not exist
+      return OpenStudio::OptionalPath.new
+    end
+
+    absoluteMeasurePaths.each do |measure_path|
+      result = File.join(measure_path.to_s, measureDir)
+      if File.exist?(result)
+        return OpenStudio::OptionalPath.new(OpenStudio.toPath(result))
+      end
+    end
+    OpenStudio::OptionalPath.new
+  end
+
+  # Returns the seed file path. Evaluated relative to filePaths if not absolute.
+  # boost::optional<openstudio::path> seedFile() const;
+  def seedFile
+    result = OpenStudio::OptionalPath.new
+    if @workflow[:seed_file]
+      result = OpenStudio::OptionalPath.new(OpenStudio.toPath(@workflow[:seed_file]))
+    end
+    result
+  end
+
+  # Returns the weather file path. Evaluated relative to filePaths if not absolute.
+  # boost::optional<openstudio::path> weatherFile() const;
+  def weatherFile
+    result = OpenStudio::OptionalPath.new
+    if @workflow[:weather_file]
+      result = OpenStudio::OptionalPath.new(OpenStudio.toPath(@workflow[:weather_file]))
+    end
+    result
+  end
+
+  # Returns the workflow steps. */
+  # std::vector<WorkflowStep> workflowSteps() const;
+  def workflowSteps
+    result = []
+    @workflow[:steps].each do |step|
+      result << WorkflowStep_Shim.new(step)
+    end
+    result
+  end
+
+  def setCompletedStatus(status)
+    @workflow[:completed_status] = status
+    @workflow[:completed_at] = timeString
+  end
+  
+  def setEplusoutErr(eplusout_err)
+    @workflow[:eplusout_err] = eplusout_err
+  end
+  
+  # return empty optional
+  def runOptions
+    return Optional_Shim.new(nil)
+  end
+end