urbanopt-scenario 0.3.0 → 0.4.0

data/lib/urbanopt/scenario/default_reports/validator.rb

@@ -1,97 +0,0 @@
-# *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
-# contributors. All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without modification,
-# are permitted provided that the following conditions are met:
-#
-# Redistributions of source code must retain the above copyright notice, this list
-# of conditions and the following disclaimer.
-#
-# Redistributions in binary form must reproduce the above copyright notice, this
-# list of conditions and the following disclaimer in the documentation and/or other
-# materials provided with the distribution.
-#
-# Neither the name of the copyright holder nor the names of its contributors may be
-# used to endorse or promote products derived from this software without specific
-# prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
-# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
-# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
-# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
-# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
-# OF THE POSSIBILITY OF SUCH DAMAGE.
-# *********************************************************************************
-
-require 'json'
-
-module URBANopt
-  module Scenario
-    module DefaultReports
-      class Validator
-        @@schema = nil
-
-        # Initialize the root directory
-        def initialize
-          super
-
-          @root_dir = File.absolute_path(File.join(File.dirname(__FILE__), '..', '..', '..', '..'))
-
-          @instance_lock = Mutex.new
-          @@schema ||= schema
-        end
-
-        # Return the absolute path of the default reports files
-        def files_dir
-          File.absolute_path(File.join(@root_dir, 'lib/urbanopt/scenario/default_reports/'))
-        end
-
-        # return path to schema file
-        def schema_file
-          File.join(files_dir, 'schema/scenario_schema.json')
-        end
-
-        # return schema
-        def schema
-          @instance_lock.synchronize do
-            if @@schema.nil?
-              File.open(schema_file, 'r') do |f|
-                @@schema = JSON.parse(f.read, symbolize_names: true)
-              end
-            end
-          end
-
-          @@schema
-        end
-
-        ##
-        # validate data against schema
-        ##
-        # [parameters:]
-        # +schema+ - _Hash_ - A hash of the JSON scenario_schema.
-        # +data+ - _Hash_ - A hash of the data to be validated against scenario_schema.
-        ##
-        def validate(schema, data)
-          JSON::Validator.fully_validate(schema, data)
-        end
-
-        # check if the schema is valid
-        def schema_valid?
-          metaschema = JSON::Validator.validator_for_name('draft6').metaschema
-          JSON::Validator.validate(metaschema, @@schema)
-        end
-
-        # return detailed schema validation errors
-        def schema_validation_errors
-          metaschema = JSON::Validator.validator_for_name('draft6').metaschema
-          JSON::Validator.fully_validate(metaschema, @@schema)
-        end
-      end
-    end
-  end
-end

data/lib/urbanopt/scenario/default_reports/wind.rb

@@ -1,92 +0,0 @@
-# *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
-# contributors. All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without modification,
-# are permitted provided that the following conditions are met:
-#
-# Redistributions of source code must retain the above copyright notice, this list
-# of conditions and the following disclaimer.
-#
-# Redistributions in binary form must reproduce the above copyright notice, this
-# list of conditions and the following disclaimer in the documentation and/or other
-# materials provided with the distribution.
-#
-# Neither the name of the copyright holder nor the names of its contributors may be
-# used to endorse or promote products derived from this software without specific
-# prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
-# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
-# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
-# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
-# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
-# OF THE POSSIBILITY OF SUCH DAMAGE.
-# *********************************************************************************
-
-require 'json'
-require 'json-schema'
-
-module URBANopt
-  module Scenario
-    module DefaultReports
-      ##
-      # Onsite wind system attributes
-      ##
-      class Wind
-        ##
-        # _Float_ - power capacity in kilowatts
-        #
-        attr_accessor :size_kw
-
-        ##
-        # Initialize Wind attributes from a hash. Wind attributes currently are limited to power capacity.
-        ##
-        # [parameters:]
-        #
-        # * +hash+ - _Hash_ - A hash containting a +:size_kw+ key/value pair which represents the nameplate capacity in kilowatts (kW)
-        #
-        def initialize(hash = {})
-          hash.delete_if { |k, v| v.nil? }
-
-          @size_kw = hash[:size_kw]
-
-          # initialize class variables @@validator and @@schema
-          @@validator ||= Validator.new
-          @@schema ||= @@validator.schema
-
-          # initialize @@logger
-          @@logger ||= URBANopt::Scenario::DefaultReports.logger
-        end
-
-        ##
-        # Convert to a Hash equivalent for JSON serialization
-        ##
-        def to_hash
-          result = {}
-
-          result[:size_kw] = @size_kw if @size_kw
-
-          return result
-        end
-
-        ##
-        # Merge Wind systems
-        ##
-        def self.add_wind(existing_wind, new_wind)
-          if existing_wind.size_kw.nil? && new_wind.size_kw.nil?
-            existing_wind.size_kw = nil
-          else
-            existing_wind.size_kw = (existing_wind.size_kw || 0) + (new_wind.size_kw || 0)
-          end
-
-          return existing_wind
-        end
-      end
-    end
-  end
-end