knot-ruby 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04ae67be521fbc10dc42972c8b3c7bfc9c0edc2822617a0ef565564e7e93bd6f
-  data.tar.gz: 89396bbc12e9aa181dcbf4af502262d4e8a4fb3ea982c28034c54d374078bd99
+  metadata.gz: 3d24b7dfed91ed556ec5c2ee1b6c765eb96879e2d7d5fdd4dfaf060e474f4c91
+  data.tar.gz: 66c899d76cbd7ff9ea68d7f3f0fad98dc8bf21a1e136d156379f25ee42046ad1
 SHA512:
-  metadata.gz: 8cf55c28b347d9f5103451ad60d0da577c1febf8909b10bd30449985057c7d8640777953de99ff5509736ead73b8a8f5a9329150948f1a2dea9c30e55728c738
-  data.tar.gz: 826ffdff42cbf5a3dd7fc0a54707796c283d13eb0e99478c293ac620cf4b179c24393f0c2db2638717904d7aec0ef097dda2c1cb3d566ad81ebfe43273e8b53c
+  metadata.gz: 5763ee24991d9d75ef48da2bb203acba69dc89dc4d982d35abd23980792f0649062ef4e58b8a9f5982a341cda9c20ac810873de1476d057c69cc733105fa5ecc
+  data.tar.gz: b932a258e7340a0e3baa7a0a833868b6a5a9ae8eb6f5d1149601193238c1279abe3710d3dda9e1e5cc193ba74baa3fad61411ad34820b60fdffca52d6a7035f5

data/lib/knot/interface.rb

@@ -11,22 +11,35 @@ class Knot::Zone
 		@zone, @transaction_opened = zone, 0
 	end
 
+	# If no transaction opened, yet, it opens a new transaction.
+	# Counts calling begin.
+	# Knot allowes only one global transaction, so if two clients tries to open a transaction,
+	# the second will fail.  But the second client can change items in the same
+	# transaction like the first client.
+	# The first client, which calls commit or abort, wins and the transaction will be closed.
+	# So, the transaction-handling is only safe, if one client connects to knot.
 	def begin
 		@transaction_opened += 1
 		@protocol.call command: 'zone-begin', zone: @zone  if 1 == @transaction_opened
 	end
 
+	# Decreases opened transactions.
+	# If opened transactions is zero, it stores items and closes transaction successfully.
 	def commit
 		@protocol.call command: 'zone-commit', zone: @zone  if 1 == @transaction_opened
 		@transaction_opened -= 1  if 0 < @transaction_opened
 	end
 
+	# Closes transaction without saving immidiatly.
+	# Counter of opened transaction will be reset to 0.
 	def abort
 		@protocol.call command: 'zone-abort', zone: @zone
 		@transaction_opened = 0
 	end
 
-	def transaction
+	# Opens transaction, calls yielded Proc and closes transaction after return.
+	# If exception was raised, the transaction will be aborted.
+	def transaction # :yield:
 		self.begin
 		yield self
 	rescue Object
@@ -72,6 +85,7 @@ class Knot::Zone
 	rescue Knot::Errors::ENONODE, Knot::Errors::ENOENT
 	end
 	alias delete unset
+	alias del unset
 
 	def get owner = nil, type = nil
 		@protocol.call command: 'zone-get',
@@ -115,10 +129,12 @@ class Knot::Conf
 
 	def parse_item k
 		case k
-		when k
+		when Hash
 			case k.keys.sort
-			when %w[section], %w[id section], %w[item section], %w[id item section] then k
-			else raise ArgumentError, "Invalid Item-format"
+			when %w[section], %w[id section], %w[item section], %w[id item section]
+				k
+			else
+				raise ArgumentError, "Invalid Item-format"
 			end
 
 		when Array
@@ -134,16 +150,26 @@ class Knot::Conf
 					(?: \[ (?<id> [a-z0-9_.-]+) \] )?
 					(?: \. (?<item>[a-z0-9_-]+) )?
 				\z/xi
+
 			$~.named_captures.delete_if {|_,v| v.nil? }
-		else raise ArgumentError, "Invalid Item-format"
+
+		else
+			raise ArgumentError, "Invalid Item-format"
 		end
 	end
 
+	def get item = nil
+		@protocol.call (item ? parse_item( item) : {}).update( command: 'conf-get')
+	end
+
+	# Sets or adds a new value to item.
+	# knot knows single-value items like `server.rundir` and multi-value items like `server.listen`.
+	# If you set a single-value, it will replace the old value.  On a multi-value, it will add it.
 	def set item, value
 		@protocol.call parse_item( item).update( command: 'conf-set', data: value)
 	end
-	alias [] set
 
+	# Removes value from item.  If you provide a value, this value will be removed.
 	def unset item, value = nil
 		@protocol.call parse_item( item).update( command: 'conf-unset', data: value)
 	end

data/lib/knot/protocol.rb

@@ -179,10 +179,10 @@ class Knot::Protocol
 
 	def zone( zone) @zones[zone.to_s.to_sym] end
 
-	def conf_set( **opts)   call opts.update( command: 'conf-set') end
-	def conf_unset( **opts) call opts.update( command: 'conf-set') end
+	def conf_set( **opts)   call **opts.update( command: 'conf-set') end
+	def conf_unset( **opts) call **opts.update( command: 'conf-set') end
 
-	def zone_set( **opts)   call opts.update( command: 'zone-set') end
-	def zone_unset( **opts) call opts.update( command: 'zone-unset') end
-	def zone_get( **opts)   call opts.update( command: 'zone-get') end
+	def zone_set( **opts)   call **opts.update( command: 'zone-set') end
+	def zone_unset( **opts) call **opts.update( command: 'zone-unset') end
+	def zone_get( **opts)   call **opts.update( command: 'zone-get') end
 end

data/lib/knot/version.rb

@@ -1,3 +1,3 @@
 module Knot
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knot-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Denis Knauf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-20 00:00:00.000000000 Z
+date: 2022-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iounpack