bcl 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51f36ae11ea89ebfeba378d2473fc62494bcc905
-  data.tar.gz: 35bddda57da88a7bbb4e8f77515586abb5d11d60
+  metadata.gz: d84cc1c93cc41cbcd5e66681619123bf8a173a98
+  data.tar.gz: 99519415353a6c8dcafe3e2b558b0f0ceba001e8
 SHA512:
-  metadata.gz: 7f6457d15d1ac094d3616842dcb751051acf2ac86161b415f7caa1643dc53656ebe911d92b777875f5372659bd37927053d1cb1622af53de6774e0f412ecae9f
-  data.tar.gz: 1d830da0c99a4a4db01b3559833e81008839b161df6c0d394d4f14094f6f82db3787eabd64cb32fd038cd7d6604504fbae881fa0bd80759a4a2f73415950a32c
+  metadata.gz: 5c78265464c68b61f6f01cbb8f312884b219e1d95f4b049ad73b2b65b8a1d5b33d3acb1bd1c92e78e5dce8549bb112d9cd0be7c24964b299a1bfd73306861183
+  data.tar.gz: b82a8f5e0cf75223377f414ae3fec6682c8cffba04cb1904fcd655377b0a0508da278bbc98701e1e08e1e4e862e1a35076c80a07feb3305cf0641eebff34c565

data/lib/bcl/{bcl_xml.rb → base_xml.rb}

@@ -1,130 +1,132 @@
-require 'uuid' # gem install uuid
-
-module BCL
-  ProvStruct = Struct.new(:author, :datetime, :comment)
-  TagsStruct = Struct.new(:descriptor)
-  AttrStruct = Struct.new(:name, :value, :datatype, :units)
-  FileStruct = Struct.new(:version_software_program, :version_id, :fqp_file, :filename, :filetype, :usage_type, :checksum)
-  CostStruct = Struct.new(:cost_name, :cost_type, :category, :value, :interval,
-                          :interval_units, :year, :location, :units, :currency, :source,
-                          :reference_component_name, :reference_component_id)
-
-  ObjectStruct = Struct.new(:obj_type, :obj_instance)
-
-  class BaseXml
-    attr_accessor :name
-    attr_accessor :description
-    attr_accessor :uuid
-    attr_accessor :vuid
-
-    attr_accessor :attributes
-    attr_accessor :files
-    attr_accessor :costs
-    attr_accessor :tags
-    attr_accessor :provenances
-
-    def initialize(save_path)
-      @name = ""  #this is also a unique identifier to the component...
-      @description = ""
-
-      @provenances = []
-      @tags = []
-      @attributes = []
-      @files = []
-
-      @schema_url = "schema.xsd"
-    end
-
-    def generate_uuid()
-      @uuid = UUID.new.generate
-    end
-
-    def generate_vuid()
-      @vuid = UUID.new.generate
-    end
-
-
-    def add_provenance(author, datetime, comment)
-      prov = ProvStruct.new
-      prov.author = author
-      prov.datetime = datetime
-      prov.comment = comment
-
-      @provenances << prov
-    end
-
-    def add_tag(tag_name)
-      tag = TagsStruct.new
-      tag.descriptor = tag_name
-
-      @tags << tag
-    end
-
-    def add_attribute(name, value, units, datatype = nil)
-      attr = AttrStruct.new
-      attr.name = name
-      attr.value = value
-
-      if !datatype.nil?
-        attr.datatype = datatype
-      else
-        attr.datatype = get_datatype(value)
-      end
-      attr.units = units
-
-      @attributes << attr
-    end
-
-    def add_file(version_sp, version_id, fqp_file, filename, filetype, usage_type = nil, checksum = nil)
-      fs = FileStruct.new
-      fs.version_software_program = version_sp
-      fs.version_id = version_id
-      fs.fqp_file = fqp_file
-      fs.filename = filename
-      fs.filetype = filetype
-      fs.usage_type = usage_type if usage_type != nil
-      fs.checksum = checksum if checksum != nil
-
-      @files << fs
-    end
-
-    #return the title case of the string
-    def tc(input)
-      val = input.gsub(/\b\w/){$&.upcase}
-      if val.downcase == "energyplus"
-        val = "EnergyPlus"
-      end
-      return val
-    end
-
-    def get_attribute(attribute_name)
-      result = nil
-      @attributes.each do |attr|
-        if attr.name == attribute_name
-          result = attr
-        end
-      end
-
-      result
-    end
-
-    def get_datatype(input_value)
-      dt = 'undefined'
-
-      # simple method to test if the input_value is a string, float, or integer.
-      # First convert the value back to a string for testing (in case it was passed as a float/integer)
-      test = input_value.to_s
-      input_value = test.match('\.').nil? ? Integer(test) : Float(test) rescue test.to_s
-
-      if input_value.is_a?(Fixnum) || input_value.is_a?(Bignum)
-        dt = "int"
-      elsif input_value.is_a?(Float)
-        dt = "float"
-      else
-        dt = "string"
-      end
-
-      dt
-    end
-  end
-end
+require 'uuid' # gem install uuid
+
+module BCL
+  ProvStruct = Struct.new(:author, :datetime, :comment)
+  TagsStruct = Struct.new(:descriptor)
+  AttrStruct = Struct.new(:name, :value, :datatype, :units)
+  FileStruct = Struct.new(:version_software_program, :version_id, :fqp_file, :filename, :filetype, :usage_type, :checksum)
+  CostStruct = Struct.new(:cost_name, :cost_type, :category, :value, :interval,
+                          :interval_units, :year, :location, :units, :currency, :source,
+                          :reference_component_name, :reference_component_id)
+
+  ObjectStruct = Struct.new(:obj_type, :obj_instance)
+
+  class BaseXml
+    attr_accessor :name
+    attr_accessor :description
+    attr_accessor :modeler_description
+    attr_accessor :uuid
+    attr_accessor :vuid
+
+    attr_accessor :attributes
+    attr_accessor :files
+    attr_accessor :costs
+    attr_accessor :tags
+    attr_accessor :provenances
+
+    def initialize(save_path)
+      @name = "" #this is also a unique identifier to the component...
+      @description = ""
+      @modeler_description = ""
+
+      @provenances = []
+      @tags = []
+      @attributes = []
+      @files = []
+
+      @schema_url = "schema.xsd"
+    end
+
+    def generate_uuid()
+      @uuid = UUID.new.generate
+    end
+
+    def generate_vuid()
+      @vuid = UUID.new.generate
+    end
+
+    def add_provenance(author, datetime, comment)
+      prov = ProvStruct.new
+      prov.author = author
+      prov.datetime = datetime
+      prov.comment = comment
+
+      @provenances << prov
+    end
+
+    def add_tag(tag_name)
+      tag = TagsStruct.new
+      tag.descriptor = tag_name
+
+      @tags << tag
+    end
+
+    def add_attribute(name, value, units, datatype = nil)
+      attr = AttrStruct.new
+      attr.name = name
+      attr.value = value
+
+      if !datatype.nil?
+        attr.datatype = datatype
+      else
+        attr.datatype = get_datatype(value)
+      end
+      attr.units = units
+
+      @attributes << attr
+    end
+
+    def add_file(version_sp, version_id, fqp_file, filename, filetype, usage_type = nil, checksum = nil)
+      fs = FileStruct.new
+      fs.version_software_program = version_sp
+      fs.version_id = version_id
+      fs.fqp_file = fqp_file
+      fs.filename = filename
+      fs.filetype = filetype
+      fs.usage_type = usage_type if usage_type != nil
+      fs.checksum = checksum if checksum != nil
+
+      @files << fs
+    end
+
+    #return the title case of the string
+    def tc(input)
+      val = input.gsub(/\b\w/) { $&.upcase }
+      if val.downcase == "energyplus"
+        val = "EnergyPlus"
+      end
+
+      val
+    end
+
+    def get_attribute(attribute_name)
+      result = nil
+      @attributes.each do |attr|
+        if attr.name == attribute_name
+          result = attr
+        end
+      end
+
+      result
+    end
+
+    def get_datatype(input_value)
+      dt = 'undefined'
+
+      # simple method to test if the input_value is a string, float, or integer.
+      # First convert the value back to a string for testing (in case it was passed as a float/integer)
+      test = input_value.to_s
+      input_value = test.match('\.').nil? ? Integer(test) : Float(test) rescue test.to_s
+
+      if input_value.is_a?(Fixnum) || input_value.is_a?(Bignum)
+        dt = "int"
+      elsif input_value.is_a?(Float)
+        dt = "float"
+      else
+        dt = "string"
+      end
+
+      dt
+    end
+  end
+end

data/lib/bcl/{component_xml.rb → component.rb}

@@ -34,6 +34,7 @@ module BCL
     attr_accessor :uid
     attr_accessor :comp_version_id
     attr_accessor :description
+    attr_accessor :modeler_description
     attr_accessor :fidelity_level
     attr_accessor :source_manufacturer
     attr_accessor :source_model
@@ -98,7 +99,13 @@ module BCL
       #the directory
 
       Dir.chdir("#{resolve_path}")
-      destination = "#{@name.gsub(/\W/,'_').gsub(/___/,'_').gsub(/__/,'_').chomp('_').strip}.tar.gz"
+      destination = "#{@name.gsub(/\W/,'_').gsub(/___/,'_').gsub(/__/,'_').chomp('_').strip}"
+      # truncate filenames for paths that are longer than 256 characters (with .tar.gz appended)
+      unless (@path + destination + destination).size < 249
+        destination = "#{@uid}"
+        puts "truncating filename...using uid instead of name"
+      end
+      destination = destination + ".tar.gz"
                     
       File.delete(destination) if File.exists?(destination)
 
@@ -148,7 +155,15 @@ module BCL
 
     def resolve_path
       FileUtils.mkdir_p(@path) unless File.directory?(@path)
-      new_path = "#{@path}/#{name.gsub(/\W/,'_').gsub(/___/,'_').gsub(/__/,'_').chomp('_').strip}"
+
+      # TODO: should probably save all components with uid instead of name to avoid path length limitation issues
+      # for now, switch to uid instead of name if larger than arbitrary number of characters
+      if @name.size < 75
+        new_path = "#{@path}/#{name.gsub(/\W/,'_').gsub(/___/,'_').gsub(/__/,'_').chomp('_').strip}"
+      else
+        new_path = "#{@path}/#{@uid}"
+      end
+
       FileUtils.mkdir_p(new_path) unless File.directory?(new_path)
       result = new_path
     end
@@ -275,9 +290,10 @@ module BCL
         comp_xml.uid @uuid
         comp_xml.version_id @vuid
         comp_xml.description @description if @description != ""
+        comp_xml.modeler_description @modeler_description if @modeler_description != ""
         comp_xml.comment @comment if @comment != ""
 
-        comp_xml.fidelity_level @fidelity_level if @fidelity_level != ""
+        #comp_xml.fidelity_level @fidelity_level if @fidelity_level != ""
         
         comp_xml.provenances {
           @provenances.each do |prov|

data/lib/bcl/component_from_spreadsheet.rb

@@ -0,0 +1,243 @@
+######################################################################
+#  Copyright (c) 2008-2013, 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
+######################################################################
+
+# Converts a custom Excel spreadsheet format to BCL components for upload
+
+require 'rubyXL'
+require 'bcl'
+
+module BCL
+
+  WorksheetStruct = Struct.new(:name, :components)
+  HeaderStruct = Struct.new(:name, :children)
+  ComponentStruct = Struct.new(:row, :name, :uid, :version_id, :headers, :values)
+
+  class ComponentFromSpreadsheet
+
+    @@changed = false
+
+    public
+
+    #initialize with Excel spreadsheet to read
+    def initialize(xlsx_path, worksheet_names =["all"])
+
+      @xlsx_path = Pathname.new(xlsx_path).realpath.to_s
+      @worksheets = []
+
+      begin
+        xlsx= RubyXL::Parser.parse(@xlsx_path)
+
+        #by default, operate on all worksheets
+        if worksheet_names == ["all"]
+          xlsx.worksheets.each do |xlsx_worksheet|
+            parse_xlsx_worksheet(xlsx_worksheet)
+          end
+        else #if specific worksheets are specified, operate on them
+          worksheet_names.each do |worksheet_name|
+            parse_xlsx_worksheet(xlsx[worksheet_name])
+          end
+        end
+
+        #save spreadsheet if changes have been made
+        if @@changed
+          xlsx.write(@xlsx_path)
+          puts "[ComponentFromSpreadsheet] Spreadsheet changes saved"
+        end
+      ensure
+        xlsx=nil
+      end
+    end
+
+    def save(save_path, chunk_size = 1000, delete_old_gather = false)
+      #FileUtils.rm_rf(save_path) if File.exists?(save_path) and File.directory?(save_path)
+      # TODO: validate against taxonomy
+
+      @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
+
+          # this tag is how we know where this goes in the taxonomy
+          component_xml.add_tag(worksheet.name)
+          puts "tag: #{worksheet.name}"
+
+          values = component.values
+
+          component.headers.each do |header|
+            if /description/i.match(header.name)
+              name = values.delete_at(0) # name, uid already processed
+              uid = values.delete_at(0)
+              description = values.delete_at(0)
+              component_xml.modeler_description = values.delete_at(0)
+              component_xml.description = description
+            elsif /provenance/i.match(header.name)
+              author = values.delete_at(0)
+              datetime = values.delete_at(0)
+              if datetime.nil?
+                #puts "[ComponentSpreadsheet] WARNING missing the date in the datetime column in the spreadsheet - assuming today"
+                datetime = DateTime.new
+              end
+
+              comment = values.delete_at(0)
+              component_xml.add_provenance(author.to_s, datetime.strftime("%Y-%m-%d"), comment.to_s)
+            elsif /tag/i.match(header.name)
+              value = values.delete_at(0)
+              component_xml.add_tag(value)
+            elsif /attribute/i.match(header.name)
+              value = values.delete_at(0)
+              name = header.children[0]
+              units = ""
+              if match_data = /(.*)\((.*)\)/.match(name)
+                name = match_data[1].strip
+                units = match_data[2].strip
+              end
+              component_xml.add_attribute(name, value, units)
+            elsif /source/i.match(header.name)
+              manufacturer = values.delete_at(0)
+              model = values.delete_at(0)
+              serial_no = values.delete_at(0)
+              year = values.delete_at(0)
+              url = values.delete_at(0)
+              component_xml.source_manufacturer = manufacturer
+              component_xml.source_model = model
+              component_xml.source_serial_no = serial_no
+              component_xml.source_year = year
+              component_xml.source_url = url
+            elsif /file/i.match(header.name)
+              software_program = values.delete_at(0)
+              version = values.delete_at(0)
+              filename = values.delete_at(0)
+              filetype = values.delete_at(0)
+              filepath = values.delete_at(0)
+              #not all components(rows) have all files; skip if filename "" or nil
+              next if filename == "" or filename == nil
+              #skip the file if it doesn't exist at the specified location
+              if not File.exists?(filepath)
+                puts "[ComponentFromSpreadsheet] ERROR #{filepath} -> File does not exist, will not be included in component xml"
+                next #go to the next file
+              end
+              component_xml.add_file(software_program, version, filepath, filename, filetype)
+            else
+              fail "Unknown section #{header.name}"
+            end
+          end
+
+          component_xml.save_tar_gz(false)
+        end
+      end
+
+      BCL.gather_components(save_path, chunk_size, delete_old_gather)
+    end
+
+    private
+
+    def parse_xlsx_worksheet(xlsx_worksheet)
+      worksheet = WorksheetStruct.new
+      worksheet.name = xlsx_worksheet[0][0].value #get A1, order is: row, col
+      worksheet.components = []
+      puts "[ComponentFromSpreadsheet] Starting parsing components of type #{worksheet.name}"
+
+      # find number of rows, first column should be name, should not be empty
+
+      xlsx_data = xlsx_worksheet.extract_data
+      #puts "Data: #{xlsx_data.inspect}"
+
+      num_rows = xlsx_data.size
+      #puts "Number of Rows: #{xlsx_data.size}"
+      num_rows = 2
+      while true do
+        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 = []
+      header = nil
+      max_col = nil
+
+      xlsx_data[0].each_with_index do |col, index|
+        value1 = xlsx_data[0][index]
+        value2 = xlsx_data[1][index]
+
+        if not value1.nil? and not value1.empty?
+          if not header.nil?
+            headers << header
+          end
+          header = HeaderStruct.new
+          header.name = value1
+          header.children = []
+        end
+
+        if not value2.nil? and not value2.empty?
+          if not header.nil?
+            header.children << value2
+          end
+        end
+
+        if (value1.nil? or value1.empty?) and (value2.nil? or value2.empty?)
+          break
+        end
+
+        max_col = index
+      end
+
+      if not header.nil?
+        headers << header
+      end
+
+      if not headers.empty?
+        headers[0].name = "description"
+      end
+
+      puts "  Found #{num_rows - 2} components"
+
+      components = []
+      for i in 2..num_rows-1 do
+        component = ComponentStruct.new
+        component.row = i
+
+        # get name
+        component.name = xlsx_data[i][0]
+
+        # get uid, if empty set it
+        component.uid = xlsx_data[i][1]
+        if component.uid.nil? or component.uid.empty?
+          component.uid = UUID.new.generate
+          puts "#{component.name} uid missing; creating new one"
+          xlsx_worksheet.add_cell(i, 1, component.uid)
+          @@changed = true
+
+        end
+
+        component.headers = headers
+        component.values = xlsx_data[i][0..max_col]
+        worksheet.components << component
+      end
+
+      @worksheets << worksheet
+
+      puts "[ComponentFromSpreadsheet] Finished parsing components of type #{worksheet.name}"
+    end
+  end
+end

data/lib/bcl/component_methods.rb

@@ -17,8 +17,6 @@
 #  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 ######################################################################
 
-
-# required gems
 require 'net/https'
 
 module BCL
@@ -42,7 +40,6 @@ module BCL
       load_config
     end
 
-
     def login(username=nil, password=nil, url=nil, group_id = nil)
       #figure out what url to use
       if url.nil?
@@ -65,11 +62,12 @@ 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}"
       else
-        puts "logging in using credentials in function arguments: Connecting to #{url} on port #{port} as #{username}"
+        @group_id = group_id
+        puts "logging in using credentials in function arguments: Connecting to #{url} on port #{port} as #{username} with group #{@group_id}"
       end
 
       if @group_id.nil?
-        puts "[WARNING] You did not set a group ID in your config.yml file. You can retrieve your group ID from the node number of your group page (e.g., https://bcl.nrel.gov/node/32). Will continue, but you will not be able to upload content."
+        puts "[WARNING] You did not set a group ID in your config.yml file or pass in a group ID. You can retrieve your group ID from the node number of your group page (e.g., https://bcl.nrel.gov/node/32). Will continue, but you will not be able to upload content."
       end
 
       @http = Net::HTTP.new(url, port)
@@ -150,32 +148,115 @@ module BCL
       end
     end
 
-    #retrieve, parse, and save metadata for BCL measures
+    # retrieve, parse, and save metadata for BCL measures
     def measure_metadata(search_term = nil, filter_term=nil, return_all_pages = false)
-
-      #setup results directory
+      # setup results directory
       if !File.exists?(@parsed_measures_path)
         FileUtils.mkdir_p(@parsed_measures_path)
       end
       puts "...storing parsed metadata in #{@parsed_measures_path}"
 
-      #retrieve measures
-      puts "retrieving measures that match search_term: #{search_term.nil? ? "nil" :search_term} and filters: #{filter_term.nil? ? "nil" :filter_term}"
+      # retrieve measures
+      puts "retrieving measures that match search_term: #{search_term.nil? ? "nil" : search_term} and filters: #{filter_term.nil? ? "nil" : filter_term}"
       retrieve_measures(search_term, filter_term, return_all_pages) do |measure|
-        #parse and save
+        # parse and save
         parse_measure_metadata(measure)
       end
 
-      return true
+      true
     end
 
+    # Read in an exisitng 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.
+    def parse_measure_file(measure_name, measure_filename)
+      measure_hash = {}
+      if File.exists? measure_filename
+        # read in the measure file and extract some information
+        measure_string = File.read(measure_filename)
+
+        measure_hash[:classname] = measure_string.match(/class (.*) </)[1]
+        measure_hash[:path] = "#{@parsed_measures_path}/#{measure_hash[:classname]}"
+        #measure_hash[:display_name] = clean(measure_name)
+        measure_hash[:name] = measure_hash[:classname].to_underscore
+        measure_hash[:display_name] = clean(measure_hash[:name].titleize)
+        if measure_string =~ /OpenStudio::Ruleset::WorkspaceUserScript/
+          measure_hash[:measure_type] = "EnergyPlusMeasure"
+        elsif measure_string =~ /OpenStudio::Ruleset::ModelUserScript/
+          measure_hash[:measure_type] = "RubyMeasure"
+        elsif measure_string =~ /OpenStudio::Ruleset::ReportingUserScript/
+          measure_hash[:measure_type] = "ReportingMeasure"
+        else
+          raise "measure type is unknown with an inherited class in #{measure_filename}: #{measure_hash.inspect}"
+        end
+
+        measure_hash[:arguments] = []
+
+        args = measure_string.scan(/(.*).*=.*OpenStudio::Ruleset::OSArgument.*make(.*)Argument\((.*).*\)/)
+        args.each do |arg|
+          new_arg = {}
+          new_arg[:local_variable] = arg[0].strip
+          new_arg[:variable_type] = arg[1]
+          arg_params = arg[2].split(",")
+          new_arg[:name] = arg_params[0].gsub(/"|'/, "")
+          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]
+          new_arg[:display_name] = clean(new_arg[:display_name])
+
+          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"
+          end
+
+          case new_arg[:variable_type]
+            when "Choice"
+              # Choices to appear to only be strings?
+              puts "Choice vector appears to be #{choice_vector}"
+              new_arg[:default_value].gsub!(/"|'/, "") if new_arg[:default_value]
 
-    # Read the measure's information to pull out the metadata and to move into a more
-    # friendly directory name.
-    #   option measure is a JSON
+              # parse the choices from the measure
+              possible_choices = measure_string.scan(/#{choice_vector}.*<<.*("|')(.*)("|')/)
+              puts "Possible choices are #{possible_choices}"
+
+              if possible_choices.empty?
+                new_arg[:choices] = []
+              else
+                new_arg[:choices] = possible_choices.map { |c| c[1] }
+              end
+
+              # if the choices are inherited from the model, then need to just display the default value which
+              # somehow magically works because that is the display name
+              if new_arg[:default_value]
+                new_arg[:choices] << new_arg[:default_value] unless new_arg[:choices].include?(new_arg[:default_value])
+              end
+            when "String"
+              new_arg[:default_value].gsub!(/"|'/, "") if new_arg[:default_value]
+            when "Bool"
+              new_arg[:default_value] = new_arg[:default_value].downcase == "true" ? true : false
+            when "Integer"
+              new_arg[:default_value] = new_arg[:default_value].to_i if new_arg[:default_value]
+            when "Double"
+              new_arg[:default_value] = new_arg[:default_value].to_f if new_arg[:default_value]
+            else
+              raise "unknown variable type of #{new_arg[:variable_type]}"
+          end
+
+          measure_hash[:arguments] << new_arg
+        end
+      end
+
+      measure_hash
+    end
+
+    # Read the measure's information to pull out the metadata and to move into a more friendly directory name.
+    # option measure is a JSON
     def parse_measure_metadata(measure)
 
-      #check for valid measure
+      # check for valid measure
       if measure[:measure][:name] && measure[:measure][:uuid]
 
         file_data = download_component(measure[:measure][:uuid])
@@ -184,14 +265,14 @@ module BCL
           save_file = File.expand_path("#{@parsed_measures_path}/#{measure[:measure][:name].downcase.gsub(" ", "_")}.zip")
           File.open(save_file, 'wb') { |f| f << file_data }
 
-          #unzip file and delete zip.
-          #TODO check that something was downloaded here before extracting zip
-          if File.exists?(save_file)
+          # unzip file and delete 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)
 
             # catch a weird case where there is an extra space in an unzip file structure but not in the measure.name
             if measure[:measure][:name] == "Add Daylight Sensor at Center of Spaces with a Specified Space Type Assigned"
-              if !File.exists? "#{@parsed_measures_path}/#{measure[:measure][:name]}"
+              unless File.exists? "#{@parsed_measures_path}/#{measure[:measure][:name]}"
                 temp_dir_name = "#{@parsed_measures_path}/Add Daylight Sensor at Center of  Spaces with a Specified Space Type Assigned"
                 FileUtils.move(temp_dir_name, "#{@parsed_measures_path}/#{measure[:measure][:name]}")
               end
@@ -202,92 +283,15 @@ module BCL
             # Read the measure.rb file
             #puts "save dir name #{temp_dir_name}"
             measure_filename = "#{temp_dir_name}/measure.rb"
-            if File.exists?(measure_filename)
-              measure_hash = {}
-              # read in the measure file and extract some information
-              measure_string = File.read(measure_filename)
-
-              measure_hash[:classname] = measure_string.match(/class (.*) </)[1]
-              measure_hash[:path] = "#{@parsed_measures_path}/#{measure_hash[:classname]}"
-              measure_hash[:name] = measure[:measure][:name]
-              if measure_string =~ /OpenStudio::Ruleset::WorkspaceUserScript/
-                measure_hash[:measure_type] = "EnergyPlusMeasure"
-              elsif measure_string =~ /OpenStudio::Ruleset::ModelUserScript/
-                measure_hash[:measure_type] = "RubyMeasure"
-              elsif measure_string =~ /OpenStudio::Ruleset::ReportingUserScript/
-                measure_hash[:measure_type] = "ReportingMeasure"
-              else
-                raise "measure type is unknown with an inherited class in #{measure_filename}: #{measure_hash.inspect}"
-              end
+            measure_hash = parse_measure_file(measure[:measure][:name], measure_filename)
 
+            unless measure_hash.empty?
               # move the directory to the class name
               FileUtils.rm_rf(measure_hash[:path]) if File.exists?(measure_hash[:path]) && temp_dir_name != measure_hash[:path]
               FileUtils.move(temp_dir_name, measure_hash[:path]) unless temp_dir_name == measure_hash[:path]
 
-              measure_hash[:arguments] = []
-
-              args = measure_string.scan(/(.*).*=.*OpenStudio::Ruleset::OSArgument::make(.*)Argument\((.*).*\)/)
-              #puts "found #{args.size} arguments for measure '#{measure[:measure][:name]}'"
-              args.each do |arg|
-
-
-                new_arg = {}
-                new_arg[:local_variable] = arg[0].strip
-                new_arg[:variable_type] = arg[1]
-                arg_params = arg[2].split(",")
-                new_arg[:name] = arg_params[0].gsub(/"|'/, "")
-                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]
-
-                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"
-                end
-
-                case new_arg[:variable_type]
-                  when "Choice"
-                    # Choices to appear to only be strings?
-                    puts "Choice vector appears to be #{choice_vector}"
-                    new_arg[:default_value].gsub!(/"|'/, "") if new_arg[:default_value]
-
-                    # parse the choices from the measure
-                    possible_choices = measure_string.scan(/#{choice_vector}.*<<.*("|')(.*)("|')/)
-                    puts "Possible choices are #{possible_choices}"
-
-                    if possible_choices.empty?
-                      new_arg[:choices] = []
-                    else
-                      new_arg[:choices] = possible_choices.map { |c| c[1] }
-                    end
-
-                    # if the choices are inherited from the model, then need to just display the default value which
-                    # somehow magically works because that is the display name
-                    if new_arg[:default_value]
-                      new_arg[:choices] << new_arg[:default_value] unless new_arg[:choices].include?(new_arg[:default_value])
-                    end
-                  when "String"
-                    new_arg[:default_value].gsub!(/"|'/, "") if new_arg[:default_value]
-                  when "Bool"
-                    new_arg[:default_value] = new_arg[:default_value].downcase == "true" ? true : false
-                  when "Integer"
-                    new_arg[:default_value] = new_arg[:default_value].to_i if new_arg[:default_value]
-                  when "Double"
-                    new_arg[:default_value] = new_arg[:default_value].to_f if new_arg[:default_value]
-                  else
-                    raise "unknown variable type of #{new_arg[:variable_type]}"
-                end
-
-                measure_hash[:arguments] << new_arg
-              end
-
               # create a new measure.json file for parsing later if need be
               File.open("#{measure_hash[:path]}/measure.json", 'w') { |f| f << MultiJson.dump(measure_hash, :pretty => true) }
-
             end
           else
             puts "Problems downloading #{measure[:measure][:name]}... moving on"
@@ -296,6 +300,41 @@ module BCL
       end
     end
 
+    # clean name
+    def clean(name)
+      # TODO: save/display errors
+      errors = ""
+      m = nil
+
+      clean_name = name
+      # remove everything btw parentheses
+      m = clean_name.match(/\((.+?)\)/)
+      unless m.nil?
+        errors = errors + " removing parentheses,"
+        clean_name = clean_name.gsub(/\((.+?)\)/, "")
+      end
+
+      # remove everything btw brackets
+      m = nil
+      m = clean_name.match(/\[(.+?)\]/)
+      unless m.nil?
+        errors = errors + " removing brackets,"
+        clean_name = clean_name.gsub(/\[(.+?)\]/, "")
+      end
+
+      # remove characters
+      m = nil
+      m = clean_name.match(/(\?|\.|\#).+?/)
+      unless m.nil?
+        errors = errors + " removing any of following: ?.#"
+        clean_name = clean_name.gsub(/(\?|\.|\#).+?/, "")
+      end
+      clean_name = clean_name.gsub(".", "")
+      clean_name = clean_name.gsub("?", "")
+
+      clean_name
+    end
+
     # retrieve measures for parsing metadata.
     # specify a search term to narrow down search or leave nil to retrieve all
     # set all_pages to true to iterate over all pages of results
@@ -461,7 +500,7 @@ module BCL
       path = "/api/content.json"
       headers = {'Content-Type' => 'application/json', 'Cookie' => @session, 'X-CSRF-Token' => @access_token}
 
-      res = @http.post(path, @data.to_json, headers)
+      res = @http.post(path, MultiJson.dump(@data), headers)
 
       res_j = "could not get json from http post response"
       if res.code == '200'

data/lib/bcl/core_ext.rb

@@ -0,0 +1,15 @@
+class String
+  def to_underscore
+    self.gsub(/::/, '/').
+        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
+  def titleize
+    arr = ['a', 'an', 'the']
+    self.gsub('_', ' ').gsub(/\w+/) { |match| arr.include?(match) ? match : match.capitalize }
+  end
+end

data/lib/bcl/master_taxonomy.rb

@@ -37,7 +37,10 @@ module BCL
 
   # each TermStruct represents a row in the master taxonomy
   TermStruct = Struct.new(:first_level, :second_level, :third_level, :level_hierarchy, :name, :description,
-                :abbr, :data_type, :enums, :ip_written, :ip_symbol, :ip_mask, :si_written, :si_symbol, :si_mask, :unit_conversion, :default_val, :min_val, :max_val, :allow_multiple, :row, :tp_include, :tp_required, :tp_use_in_search, :tp_use_in_facets, :tp_show_data_to_data_users, :tp_third_party_testing, :tp_additional_web_dev_info, :tp_additional_data_user_info, :tp_additional_data_submitter_info)
+                :abbr, :data_type, :enums, :ip_written, :ip_symbol, :ip_mask, :si_written, :si_symbol, :si_mask,
+                :unit_conversion, :default_val, :min_val, :max_val, :allow_multiple, :row, :tp_include,
+                :tp_required, :tp_use_in_search, :tp_use_in_facets, :tp_show_data_to_data_users, :tp_third_party_testing,
+                :tp_additional_web_dev_info, :tp_additional_data_user_info, :tp_additional_data_submitter_info)
 
 
   # class for parsing, validating, and querying the master taxonomy document

data/lib/bcl/tar_ball.rb

@@ -1,4 +1,4 @@
-  ######################################################################
+######################################################################
 #  Copyright (c) 2008-2013, Alliance for Sustainable Energy.
 #  All rights reserved.
 #  
@@ -21,8 +21,8 @@ module BCL
 
   module_function
 
+  # tarball multiple paths recursively to destination
   def tarball(destination, paths)
-
     #check for filepath length limit
     full_destination = File.expand_path(destination)
     if full_destination.length > 259 #256 chars max; "C:\" doesn't count
@@ -45,13 +45,12 @@ module BCL
   end
 
   def extract_tarball(filename, destination)
-    Zlib::GzipReader.open(filename) { |gz|
+    Zlib::GzipReader.open(filename) do |gz|
       Archive::Tar::Minitar.unpack(gz, destination)
-    }
+    end
   end
 
   def create_zip(destination, paths)
-
     Zip::File.open(zipfile_name, Zip::File::CREATE) do |zipfile|
       paths.each do |fi|
         # Two arguments:
@@ -60,17 +59,16 @@ module BCL
         zipfile.add(fi.basename, fi)
       end
     end
-
   end
 
   def extract_zip(filename, destination, delete_zip = false)
-    Zip::File.open(filename) { |zip_file|
-      zip_file.each { |f|
+    Zip::File.open(filename) do |zip_file|
+      zip_file.each do |f|
         f_path=File.join(destination, f.name)
         FileUtils.mkdir_p(File.dirname(f_path))
-        zip_file.extract(f, f_path) unless File.exist?(f_path)
-      }
-    }
+        zip_file.extract(f, f_path) unless File.exist? f_path
+      end
+    end
 
     if delete_zip
       fileList = Array.new
@@ -79,4 +77,4 @@ module BCL
     end
   end
 
-end # module BCL
+end

data/lib/bcl/version.rb

@@ -1,22 +1,22 @@
-######################################################################
-#  Copyright (c) 2008-2013, 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 BCL
-  VERSION = "0.5.2"
-end
+######################################################################
+#  Copyright (c) 2008-2013, 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 BCL
+  VERSION = "0.5.3"
+end

data/lib/bcl.rb

@@ -1,6 +1,14 @@
 require 'pathname'
 require 'base64'
 
+begin
+  require 'openstudio'
+  $openstudio_gem = true
+rescue LoadError => e
+  $openstudio_gem = false
+  puts 'OpenStudio did not load, but most functionality is still available. Will continue...'
+end
+
 # file formatters
 require 'yaml'
 require 'multi_json'
@@ -12,11 +20,14 @@ require 'archive/tar/minitar'
 require 'zlib'
 require 'zip'
 
-require 'bcl/bcl_xml'
+require 'rubyXL'
+
+require 'bcl/core_ext'
+require 'bcl/base_xml'
 require 'bcl/component_spreadsheet'
-require 'bcl/component_xml'
+require 'bcl/component_from_spreadsheet'
+require 'bcl/component'
 require 'bcl/component_methods'
-require 'bcl/measure_xml'
 require 'bcl/tar_ball'
 require 'bcl/master_taxonomy'
 require 'bcl/version'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bcl
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Daniel Macumber
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-02 00:00:00.000000000 Z
+date: 2014-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid
@@ -167,6 +167,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubyXL
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '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
@@ -175,14 +189,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/bcl/bcl_xml.rb
+- lib/bcl/base_xml.rb
+- lib/bcl/component.rb
+- lib/bcl/component_from_spreadsheet.rb
 - lib/bcl/component_methods.rb
 - lib/bcl/component_spreadsheet.rb
-- lib/bcl/component_xml.rb
+- lib/bcl/core_ext.rb
 - lib/bcl/current_taxonomy.json
 - lib/bcl/current_taxonomy.xml
 - lib/bcl/master_taxonomy.rb
-- lib/bcl/measure_xml.rb
 - lib/bcl/tar_ball.rb
 - lib/bcl/version.rb
 - lib/bcl.rb

data/lib/bcl/measure_xml.rb

@@ -1,37 +0,0 @@
-######################################################################
-#  Copyright (c) 2008-2013, 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 th e 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
-######################################################################
-
-# Provides programmatic access to the component.xsd schema needed for
-# generating the component information that will be uploaded to
-# the Building Component Library.
-
-module BCL
-  class Measure
-    def initialize(save_path)
-      super(save_path)
-
-    end
-
-    def read_measure_xml(filepath)
-      xmlfile = File.open(filepath, 'r').read
-
-      @xml = LibXML::XML::Document.string(xmlfile)
-    end
-  end
-end