bcl 0.5.5 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c879a3a43c8b31973a5432fda978ef90aade0139
-  data.tar.gz: 2e7889e68d19f79576462a527e039a791dfa552a
+  metadata.gz: b9b595f2fbb18ac0cdf885c9cd7c94595272a0e6
+  data.tar.gz: 4a9f7d8789ae367ad26e2b1a139c2f781aefbe45
 SHA512:
-  metadata.gz: 67f1c26d8815663a569edac566e0ffb939a0c683decdd279e8df597b3cf612e9a09e61c01c7efa6b70660ff84dcfc650f3eb451dd22bf3d5f274d141d89b1a76
-  data.tar.gz: 34903fceacea4d40817c4880e290820e158191db0d03e7b0811025abcd319c29f624e7ecd0a8e9b9840b16494a09438db10c1708d063200670660a14d5982047
+  metadata.gz: 28a7fa4ba6ab4cca1fece24b9928d2d82e440814b6c4d92126e4792d74bc6c0cff1716218d72a2a2610529feafa354ff916a0621f3c53733038de155d7efb897
+  data.tar.gz: cfa0c7c21b956deadfdb992324b8af6da997a0c8f3ac3a9e109de44d59c981dcb77a9f39593a3206f10c884557b27edce32bf4a8ced57ab221f60a4843b80140

data/lib/bcl/component.rb

@@ -105,7 +105,7 @@ module BCL
         destination = "#{@uid}"
         puts 'truncating filename...using uid instead of name'
       end
-      destination = destination + '.tar.gz'
+      destination += '.tar.gz'
 
       File.delete(destination) if File.exist?(destination)
 
@@ -186,7 +186,7 @@ module BCL
       FileUtils.mkdir_p(@path) unless File.directory?(@path)
       new_path = @path + '/OpenStudio'
       FileUtils.mkdir_p(new_path) unless File.directory?(new_path)
-      new_path = new_path + "/#{component_type}"
+      new_path += "/#{component_type}"
       FileUtils.mkdir_p(new_path) unless File.directory?(new_path)
       new_path
     end
@@ -379,7 +379,6 @@ module BCL
             end
           end
         end
-
       end
 
       xmlfile.close

data/lib/bcl/component_from_spreadsheet.rb

@@ -77,6 +77,7 @@ module BCL
 
           values = component.values
 
+          puts " headers: #{component.headers}"
           component.headers.each do |header|
             if /description/i.match(header.name)
               name = values.delete_at(0) # name, uid already processed
@@ -155,18 +156,19 @@ module BCL
 
       xlsx_data = xlsx_worksheet.extract_data
       # puts "Data: #{xlsx_data.inspect}"
+      # puts "***********************"
 
       num_rows = xlsx_data.size
-      # puts "Number of Rows: #{xlsx_data.size}"
-      num_rows = 2
-      loop do
-        test = xlsx_data[num_rows][0]
-        if test.nil? || test.empty?
-          # num_rows -= 1
-          break
-        end
-        num_rows += 1
-      end
+      puts "Number of Rows: #{xlsx_data.size}"
+      # num_rows = 2
+      # while true
+      #   test = xlsx_data[num_rows][0]
+      #   if test.nil? or test.empty?
+      #     # num_rows -= 1
+      #     break
+      #   end
+      #   num_rows += 1
+      # end
 
       # scan number of columns
       headers = []

data/lib/bcl/component_methods.rb

@@ -60,7 +60,7 @@ module BCL
         @group_id = group_id || @config[:server][:user][:group]
         puts "logging in using credentials in .bcl/config.yml: Connecting to #{url} on port #{port} as #{username} with group #{@group_id}"
       else
-        @group_id = group_id
+        @group_id = group_id || @config[:server][:user][:group]
         puts "logging in using credentials in function arguments: Connecting to #{url} on port #{port} as #{username} with group #{@group_id}"
       end
 
@@ -169,8 +169,8 @@ module BCL
       measures
     end
 
-    # Read in an existing measure.rb file and extract the arguments.  Note that the measure_name (display name)
-    # does not exist in the .rb file, so you have to pass this in.
+    # Read in an existing measure.rb file and extract the arguments.
+    # TODO: deprecate the _measure_name. This is used in the openstudio analysis gem, so it has to be carefully removed or renamed
     def parse_measure_file(_measure_name, measure_filename)
       measure_hash = {}
 
@@ -180,7 +180,10 @@ module BCL
 
         measure_hash[:classname] = measure_string.match(/class (.*) </)[1]
         measure_hash[:name] = measure_hash[:classname].to_underscore
-        measure_hash[:display_name] = measure_hash[:name].titleize
+        measure_hash[:display_name] = nil
+        measure_hash[:display_name_titleized] = measure_hash[:name].titleize
+        measure_hash[:display_name_from_measure] = nil
+
         if measure_string =~ /OpenStudio::Ruleset::WorkspaceUserScript/
           measure_hash[:measure_type] = 'EnergyPlusMeasure'
         elsif measure_string =~ /OpenStudio::Ruleset::ModelUserScript/
@@ -193,11 +196,48 @@ module BCL
           fail "measure type is unknown with an inherited class in #{measure_filename}: #{measure_hash.inspect}"
         end
 
+        # New versions of measures have name, description, and modeler description methods
+        n = measure_string.scan(/def name(.*?)end/m).first
+        if n
+          n = n.first.strip
+          n.gsub!('return', '')
+          n.gsub!(/"|'/, '')
+          n.strip!
+          measure_hash[:display_name_from_measure] = n
+        end
+
+        # New versions of measures have name, description, and modeler description methods
+        n = measure_string.scan(/def description(.*?)end/m).first
+        if n
+          n = n.first.strip
+          n.gsub!('return', '')
+          n.gsub!(/"|'/, '')
+          n.strip!
+          measure_hash[:description] = n
+        end
+
+        # New versions of measures have name, description, and modeler description methods
+        n = measure_string.scan(/def modeler_description(.*?)end/m).first
+        if n
+          n = n.first.strip
+          n.gsub!('return', '')
+          n.gsub!(/"|'/, '')
+          n.strip!
+          measure_hash[:modeler_description] = n
+        end
+
         measure_hash[:arguments] = []
 
         args = measure_string.scan(/(.*).*=.*OpenStudio::Ruleset::OSArgument.*make(.*)Argument\((.*).*\)/)
         args.each do |arg|
           new_arg = {}
+          new_arg[:name] = nil
+          new_arg[:display_name] = nil
+          new_arg[:variable_type] = nil
+          new_arg[:local_variable] = nil
+          new_arg[:units] = nil
+          new_arg[:units_in_name] = nil
+
           new_arg[:local_variable] = arg[0].strip
           new_arg[:variable_type] = arg[1]
           arg_params = arg[2].split(',')
@@ -205,24 +245,36 @@ module BCL
           next if new_arg[:name] == 'info_widget'
           choice_vector = arg_params[1] ? arg_params[1].strip : nil
 
-          # local variable name to get other attributes
-          new_arg[:display_name] = measure_string.match(/#{new_arg[:local_variable]}.setDisplayName\((.*)\)/)[1]
-          new_arg[:display_name].gsub!(/"|'/, '') if new_arg[:display_name]
+          # try find the display name of the argument
+          reg = /#{new_arg[:local_variable]}.setDisplayName\((.*)\)/
+          if measure_string =~ reg
+            new_arg[:display_name] = measure_string.match(reg)[1]
+            new_arg[:display_name].gsub!(/"|'/, '') if new_arg[:display_name]
+          else
+            new_arg[:display_name] = new_arg[:name]
+          end
+
           p = parse_measure_name(new_arg[:display_name])
           new_arg[:display_name] = p[0]
-          new_arg[:units] = p[1]
-          new_arg[:description] = p[2]
+          new_arg[:units_in_name] = p[1]
+
+          # try to get the units
+          reg = /#{new_arg[:local_variable]}.setUnits\((.*)\)/
+          if measure_string =~ reg
+            new_arg[:units] = measure_string.match(reg)[1]
+            new_arg[:units].gsub!(/"|'/, '') if new_arg[:units]
+          end
 
           if measure_string =~ /#{new_arg[:local_variable]}.setDefaultValue/
             new_arg[:default_value] = measure_string.match(/#{new_arg[:local_variable]}.setDefaultValue\((.*)\)/)[1]
           else
-            puts "[WARNING] #{measure_hash[:name]}:#{new_arg[:name]} has no default value... will try to continue"
+            puts "[WARNING] #{measure_hash[:name]}:#{new_arg[:name]} has no default value... will continue"
           end
 
           case new_arg[:variable_type]
             when 'Choice'
               # Choices to appear to only be strings?
-              puts "Choice vector appears to be #{choice_vector}"
+              # puts "Choice vector appears to be #{choice_vector}"
               new_arg[:default_value].gsub!(/"|'/, '') if new_arg[:default_value]
 
               # parse the choices from the measure
@@ -276,15 +328,82 @@ module BCL
         measure_hash[:name_xml] = doc.xpath('/measure/name').first.content
         measure_hash[:uid] = doc.xpath('/measure/uid').first.content
         measure_hash[:version_id] = doc.xpath('/measure/version_id').first.content
-        measure_hash[:modeler_description] = doc.xpath('/measure/modeler_description').first.content
-        measure_hash[:description] = doc.xpath('/measure/description').first.content
         measure_hash[:tags] = doc.xpath('/measure/tags/tag').map(&:content)
+
+        measure_hash[:modeler_description_xml] = doc.xpath('/measure/modeler_description').first.content
+
+        measure_hash[:description_xml] = doc.xpath('/measure/description').first.content
+
         f.close
       end
 
+      # validate the measure information
+
+      validate_measure_hash(measure_hash)
+
       measure_hash
     end
 
+    # Validate the measure hash to make sure that it is meets the style guide. This will also perform the selection
+    # of which data to use for the "actual metadata"
+    #
+    # @param h [Hash] Measure hash
+    def validate_measure_hash(h)
+      if h.key? :name_xml
+        if h[:name_xml] != h[:name]
+          puts "[ERROR] {Validation}. Snake-cased name and the name in the XML do not match. Will default to automatic snake-cased measure name. #{h[:name_xml]} <> #{h[:name]}"
+        end
+      end
+
+      puts '[WARNING] {Validation} Could not find measure description in measure.'  unless h[:description]
+      puts '[WARNING] {Validation} Could not find modeler description in measure.'  unless h[:modeler_description]
+      puts '[WARNING] {Validation} Could not find measure name method in measure.'  unless h[:name_from_measure]
+
+      # check the naming conventions
+      if h[:display_name_from_measure]
+        if h[:display_name_from_measure] != h[:display_name_titleized]
+          puts '[WARNING] {Validation} Display name from measure and automated naming do not match. Will default to the automated name until all measures use the name method because of potential conflicts due to bad copy/pasting.'
+        end
+        h[:display_name] = h.delete :display_name_titleized
+      else
+        h[:display_name] = h.delete :display_name_titleized
+      end
+      h.delete :display_name_from_measure
+
+      if h.key?(:description) && h.key?(:description_xml)
+        if h[:description] != h[:description_xml]
+          puts '[ERROR] {Validation} Measure description and XML description differ. Will default to description in measure'
+        end
+        h.delete(:description_xml)
+      end
+
+      if h.key?(:modeler_description) && h.key?(:modeler_description_xml)
+        if h[:modeler_description] != h[:modeler_description_xml]
+          puts '[ERROR] {Validation} Measure modeler description and XML modeler description differ. Will default to modeler description in measure'
+        end
+        h.delete(:modeler_description_xml)
+      end
+
+      h[:arguments].each do |arg|
+        if arg[:units_in_name]
+          puts "[ERROR] {Validation} It appears that units are embedded in the argument name for #{arg[:name]}."
+
+          if arg[:units]
+            if arg[:units] != arg[:units_in_name]
+              puts '[ERROR] {Validation} Units in argument name do not match units in setUnits method. Using setUnits.'
+              arg.delete :units_in_name
+            end
+          else
+            puts '[ERROR] {Validation} Units appear to be in measure name. Please use setUnits.'
+            arg[:units] = arg.delete :units_in_name
+          end
+        else
+          # make sure to delete if null
+          arg.delete :units_in_name
+        end
+      end
+    end
+
     def translate_measure_hash_to_csv(measure_hash)
       csv = []
       csv << [false, measure_hash[:display_name], measure_hash[:classname], measure_hash[:classname], measure_hash[:measure_type]]
@@ -328,7 +447,7 @@ module BCL
           File.open(save_file, 'wb') { |f| f << file_data }
 
           # unzip file and delete zip.
-          # TODO check that something was downloaded here before extracting zip
+          # TODO: check that something was downloaded here before extracting zip
           if File.exist? save_file
             BCL.extract_zip(save_file, @parsed_measures_path, true)
 
@@ -345,18 +464,18 @@ module BCL
             # Read the measure.rb file
             # puts "save dir name #{temp_dir_name}"
             measure_filename = "#{temp_dir_name}/measure.rb"
-            measure_hash = parse_measure_file(measure[:measure][:name], measure_filename)
+            measure_hash = parse_measure_file(nil, measure_filename)
 
             if measure_hash.empty?
               puts 'Measure Hash was empty... moving on'
             else
-              #puts measure_hash.inspect
+              # puts measure_hash.inspect
               m_result = measure_hash
               # move the directory to the class name
               new_dir_name = File.join(@parsed_measures_path, measure_hash[:classname])
-              #puts "Moving #{temp_dir_name} to #{new_dir_name}"
+              # puts "Moving #{temp_dir_name} to #{new_dir_name}"
               if temp_dir_name == new_dir_name
-                puts "Destination directory is the same as the processed directory"
+                puts 'Destination directory is the same as the processed directory'
               else
                 FileUtils.rm_rf(new_dir_name) if File.exist?(new_dir_name) && temp_dir_name != measure_hash[:classname]
                 FileUtils.move(temp_dir_name, new_dir_name) unless temp_dir_name == measure_hash[:classname]
@@ -381,12 +500,11 @@ module BCL
 
       clean_name = name
       units = nil
-      description = nil
 
       # remove everything btw parentheses
       m = clean_name.match(/\((.+?)\)/)
       unless m.nil?
-        errors = errors + ' removing parentheses,'
+        errors += ' removing parentheses,'
         units = m[1]
         clean_name = clean_name.gsub(/\((.+?)\)/, '')
       end
@@ -395,7 +513,7 @@ module BCL
       m = nil
       m = clean_name.match(/\[(.+?)\]/)
       unless m.nil?
-        errors = errors + ' removing brackets,'
+        errors += ' removing brackets,'
         clean_name = clean_name.gsub(/\[(.+?)\]/, '')
       end
 
@@ -403,13 +521,13 @@ module BCL
       m = nil
       m = clean_name.match(/(\?|\.|\#).+?/)
       unless m.nil?
-        errors = errors + ' removing any of following: ?.#'
+        errors += ' removing any of following: ?.#'
         clean_name = clean_name.gsub(/(\?|\.|\#).+?/, '')
       end
       clean_name = clean_name.gsub('.', '')
       clean_name = clean_name.gsub('?', '')
 
-      [clean_name.strip, units, description]
+      [clean_name.strip, units]
     end
 
     # retrieve measures for parsing metadata.
@@ -423,7 +541,7 @@ module BCL
       if filter_term.nil?
         filter_term = 'fq[]=bundle%3Anrel_measure'
       elsif !filter_term.include? 'bundle'
-        filter_term = filter_term + '&fq[]=bundle%3Anrel_measure'
+        filter_term += '&fq[]=bundle%3Anrel_measure'
       end
 
       # use provided search term or nil.
@@ -484,7 +602,7 @@ module BCL
     # Construct the post parameter for the API content.json end point.
     # param(@update) is a boolean that triggers whether to use content_type or uuid
     def construct_post_data(filepath, update, content_type_or_uuid)
-      # TODO remove special characters in the filename; they create firewall errors
+      # TODO: remove special characters in the filename; they create firewall errors
       # filename = filename.gsub(/\W/,'_').gsub(/___/,'_').gsub(/__/,'_').chomp('_').strip
 
       file_b64 = Base64.encode64(File.binread(filepath))
@@ -505,7 +623,7 @@ module BCL
         data['node']['type'] = content_type_or_uuid
       end
 
-      # TODO remove this field_component_tags once BCL is fixed
+      # TODO: remove this field_component_tags once BCL is fixed
       data['node']['field_component_tags'] = { 'und' => '1289' }
       data['node']['og_group_ref'] = { 'und' => ['target_id' => @group_id] }
 
@@ -765,7 +883,7 @@ module BCL
       # puts "RESULTS BODY: #{result.body}"
       # look at response code
       if result.code == '200'
-        #puts 'Download Successful'
+        # puts 'Download Successful'
         result.body ? result.body : nil
       else
         puts "Download fail. Error code #{result.code}"
@@ -809,7 +927,7 @@ module BCL
     end
   end # class ComponentMethods
 
-  # TODO make this extend the component_xml class (or create a super class around components)
+  # TODO: make this extend the component_xml class (or create a super class around components)
 
   def self.gather_components(component_dir, chunk_size = 0, delete_previousgather = false, destination = nil)
     if destination.nil?

data/lib/bcl/component_spreadsheet.rb

@@ -98,7 +98,6 @@ module BCL
 
       @worksheets.each do |worksheet|
         worksheet.components.each do |component|
-
           component_xml = Component.new("#{save_path}/components")
           component_xml.name = component.name
           component_xml.uid = component.uid
@@ -109,7 +108,6 @@ module BCL
 
           values = component.values[0]
           component.headers.each do |header|
-
             if /description/i.match(header.name)
 
               name = values.delete_at(0)
@@ -184,15 +182,12 @@ module BCL
               fail "Unknown section #{header.name}"
 
             end
-
           end
 
           taxonomy.check_component(component_xml)
 
           component_xml.save_tar_gz(false)
-
         end
-
       end
 
       BCL.gather_components(save_path, chunk_size, delete_old_gather)

data/lib/bcl/core_ext.rb

@@ -20,10 +20,10 @@
 class String
   def to_underscore
     gsub(/::/, '/')
-        .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-        .tr('-', '_')
-        .downcase
+      .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+      .tr('-', '_')
+      .downcase
   end
 
   # simple method to create titles -- very custom to catch known inflections

data/lib/bcl/master_taxonomy.rb

@@ -176,7 +176,6 @@ module BCL
 
       # check that all attributes are allowed
       component.attributes.each do |attribute|
-
         term = nil
         terms.each do |t|
           if t.name == attribute.name
@@ -192,7 +191,6 @@ module BCL
         end
 
         # TODO: validate value, datatype, units
-
       end
 
       valid
@@ -526,7 +524,6 @@ module BCL
         child_tags.each do |child_tag|
           write_tag_to_xml(child_tag, level, xml, output_type)
         end
-
       end
     end
   end

data/lib/bcl/version.rb

@@ -18,5 +18,5 @@
 ######################################################################
 
 module BCL
-  VERSION = '0.5.5'
+  VERSION = '0.5.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bcl
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.6
 platform: ruby
 authors:
 - Daniel Macumber
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-14 00:00:00.000000000 Z
+date: 2015-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid
@@ -167,90 +167,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 10.3.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 10.3.2
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.26.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.26.1
-- !ruby/object:Gem::Dependency
-  name: rubocop-checkstyle_formatter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.1.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.1.1
-- !ruby/object:Gem::Dependency
-  name: ci_reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.9.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.9.1
-- !ruby/object:Gem::Dependency
-  name: rspec-legacy_formatters
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
 description: This gem contains helper methods for generating the Component XML file
   needed to upload files to the Building Component Library. It also contains the classes
   needed for logging in via the api and uploading generating components
@@ -259,6 +175,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/bcl.rb
 - lib/bcl/base_xml.rb
 - lib/bcl/component.rb
 - lib/bcl/component_from_spreadsheet.rb
@@ -270,7 +187,6 @@ files:
 - lib/bcl/master_taxonomy.rb
 - lib/bcl/tar_ball.rb
 - lib/bcl/version.rb
-- lib/bcl.rb
 homepage: http://bcl.nrel.gov
 licenses:
 - LGPL
@@ -283,7 +199,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -291,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Classes for creating component XML files for the BCL