hodmin 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bb33acdfd9c0f5535e53bf8c5d26fc81fdf6fbf
-  data.tar.gz: 1eee8590abe1d7fb11b958a2f1f8adf46d713d9e
+  metadata.gz: 633ba0e1284ac259815ac6780c0fe8e903f01abe
+  data.tar.gz: 72d81747ae99df84f8beb6b2d2299b9e547e6eee
 SHA512:
-  metadata.gz: 8216ba7554941c66bdedb0188c4ec4d966b81e938dd562621a54f46fae00e4c364e66e3eccd74eb1b831ddcecaf620cdeff469fb3b59d62f84e158da12cecf6c
-  data.tar.gz: 7b20bae529e42caf8da7c307bc7986ad49988e872cf802a0ce5c1bc6591a16fce2e8750cf526b56fd03e0a3eaf77e59f18b01fd0ebcc7bc93d3d382ac3fbeda7
+  metadata.gz: 3c7a4b16c02349d8c2b8cee0f5298aca28aed5bf034aa674d89f788bfc044dcfc21b5d8de8b9585291297cc349404198d6da6c15e9db3e95bd6ebd1dd177e379
+  data.tar.gz: 4ea0c6a415352f4e0d4edacdd8baac9a014d417a27c6a6100860c4e81a6d07d66970a8eceffc1d954d07157fa9364a7a8a6d546b1fde8c5d57f351926234e3d6

data/lib/hodmin/hodmin_tools.rb

@@ -106,10 +106,7 @@ class HomieDevice
       + ' check hodmin for updates'
     end
     mhash.tap { |hs| hs.delete('$homie') }
-    # Some topics-names from homie do not fit our needs due to special chars like '/'.
-    # ['$fw/name','$fw/version','$fw/checksum']
-    # Replace '/' by '_':
-    mhash.each { |k, v| create_attr(k.to_s.delete('$').gsub(/\//, '_').tr('-', '_'), v) }
+    mhash.each { |k, v| create_attr(k.to_s, v) }
 
     # mac only downcase and without separating ':'
     @mac = mac.delete(':').downcase
@@ -127,17 +124,15 @@ class HomieDevice
     self.class.send(:define_method, name, &block)
   end
 
-  # Helper to remove some special chars from string to avoid problems in instance_variable_set:
-  def remove_special_chars(str)
-    to_be_replaced = ['%', '!', '(', ')', '&', '?', ',', '.', '^', ' ']
-    to_be_replaced.each{|char| str.gsub!(char,'')}
-    str
-  end
-  
   # Helper to create instance variables on the fly:
   def create_attr(name, value)
-    # replace chars
-    name = remove_special_chars(name)
+    # Some topics-names of homie do not fit our needs due to special chars like '/'.
+    # ['$fw/name','$fw/version','$fw/checksum']
+    # to fix this, replace / delete some chars:
+    name = cleanup_instance_var_name(name)
+    # do we already have a instance variable with this name?
+    name = ensure_individual_instance_name(name, instance_variables)
+    # now name should be clean, we create an instancevariable using this name:
     create_method(name.to_sym) { instance_variable_get('@' + name) }
     instance_variable_set('@' + name, value)
   end
@@ -218,7 +213,7 @@ end
 
 # Reads all Homie-Devices from given broker.
 # To be called with connected MQTT-client. Topic has to be set in calling program.
-# Variable timeout_seconds defines, after what time out client.get will be cancelled. Choose
+# Variable timeout_seconds defines, after what time our client.get will be cancelled. Choose
 # a value high enough for your data, but fast enough for quick response. default is 0.7 sec,
 # which should be enough for a lot of Homies controlled by a broker running on a Raspberry-PI.
 def get_homies(client, *fw_list)
@@ -430,3 +425,38 @@ def default_config_initialize
   config['ota'] = Hash['enabled' => true]
   config
 end
+
+# Helper to remove some special chars from string to avoid problems in instance_variable_set:
+def cleanup_instance_var_name(inputstring)
+	# translate some signs into char-representation:
+	str = inputstring
+	to_be_replaced = [['%','PCT'],[':','CLN'],['?','QMARK'],['&','AMPS'],['!','EXCLM'],['.','DOT']]
+	to_be_replaced.each{|org,rpl| str = str.gsub(org,'_' + rpl + '_')}
+	# translate some signs into '_':
+	str.tr!('/-','__')
+	# remove '$':
+	str.delete!('$')
+	# remove all other nonnumerical chars:
+	str.gsub!(/[^0-9a-zA-Z_]/i, '')
+	# sometimes remaining string may be empty:
+	str = 'GENERIC_TOPIC' if str.empty?
+	# return string as new instance variable name:
+	str
+end
+
+def ensure_individual_instance_name(name,list)
+	instance_variable_names = list.map do |i|
+		i = i.to_s
+		i[0] = '' if i[0] == '@'
+		i
+	end
+	n = 1
+	org_name = name
+	while instance_variable_names.include?(name)
+		# name already used, so change it a little bit:
+		name = org_name + '_' + n.to_s.rjust(3, "0")
+		n += 1
+		raise "ERR: Too many topics with special chars: #{instance_variable_names.join(', ')}" if n > 999
+	end
+	name
+end

data/lib/hodmin/version.rb

@@ -1,3 +1,3 @@
 module Hodmin
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hodmin
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Thomas Romeyke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-07 00:00:00.000000000 Z
+date: 2017-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: configatron