lx 1.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4c0434d776d126749bc25f0261862ef735b77ac115e65fa53b81c4d37910e0b
-  data.tar.gz: 327b023d673ed23f7281d61d85001b9a2c1e577ed2b0c5ba571f245c4b8d1883
+  metadata.gz: '0129287631d7874f63195026285a321e29b8beb2ed2959a02d6ed59a7edda3ba'
+  data.tar.gz: 3b2ce691ff835795825aae039084bfa68a908b275028d3d4ec5a58b37d26c16b
 SHA512:
-  metadata.gz: d46c1fd25072f59cb72eff63d3b323c86749cdb522ac17c225509397227be60f2fc9e92ac695467866170244f6318128c2b744394b1e755f0f25ffb7ce440838
-  data.tar.gz: 35bbb8fb3bd0a20c9eaae80685bf255ebb3374950230c28771e5a7a1bdff0b9cccffc46938af062990d2d52359a3d813281e5051947eda274fcc7bcac136e424
+  metadata.gz: e5b6723a4103a00ba8769c6a60d696481d3048e5359b7448ab3afa5d35d5ded07f6d271b214a67eead90ce9c62718245b48d851b4f49d47a31ead16175bf1bcc
+  data.tar.gz: e06b0f7724126c604993825f5640f5fcd18cbbbf7526282a17f745e82a912c68602f052f4d3aca2d8998ef62538e1b416830b73e5a6540f1ceb17857adcc4ca5

data/README.md

@@ -25,10 +25,11 @@ mike@idocs.com
 ## Name
 
 "LX" doesn't mean anything in particular. It's concise and it was available on
-rubygems.rb.
+rubygems.
 
 ## History
 
 | version | date         | notes                         |
 |---------|--------------|-------------------------------|
-| 1.0     | May 29, 2020 | Initial upload.               |
+| 1.0     | May 29, 2020 | Initial upload.               |
+| 1.1     | January 3, 2021 | Added deep_dup for arrays and hashes, LX.randstr, File.lx.atomic_write(), and File.lx.temp_path. |

data/lib/lx.rb

@@ -5,8 +5,8 @@
 # The LX module is the home for utilities that don't particularly fit in one
 # class. For now, it only contains the randstr method.
 module LX
-	# version '1.0'
-	VERSION = '1.0'
+	# version
+	VERSION = '1.1'
 	
 	#---------------------------------------------------------------------------
 	# verbose
@@ -62,6 +62,109 @@ module LX
 	#
 	# randstr
 	#---------------------------------------------------------------------------
+	
+	
+	#---------------------------------------------------------------------------
+	# scope
+	#
+	
+	# A little method that does nothing more than allow you to create a 'do'
+	# block.
+	def self.scope
+		yield
+	end
+	
+	# Same as LX::scope.
+	def self.block
+		yield
+	end
+	
+	#
+	# scope
+	#---------------------------------------------------------------------------
+
+
+	#---------------------------------------------------------------------------
+	# deep_dup
+	#
+	
+	# Deep suplicates a hash or array. Don't call this method directly. Call
+	# Array#lx#deep_dup or Hash#lx#deep_dup.
+	
+	def self.deep_dup(obj, opts={})
+		# $tm.hrm
+		rv = nil
+		
+		# default options
+		opts = {'done'=>{}}.merge(opts)
+		
+		# error if object has already been cloned
+		if obj.is_a?(::Array) or obj.is_a?(::Hash)
+			if opts['done'][obj.object_id]
+				raise "object #{obj.object_id} has already been dupped"
+			end
+		end
+		
+		if obj.is_a?(::Array)
+			rv = deep_dup_array(obj, opts)
+		elsif obj.is_a?(::Hash)
+			rv = deep_dup_hash(obj, opts)
+		else
+			begin
+				rv = obj.dup
+			rescue
+				rv = obj
+			end
+		end
+		
+		# note object as done
+		opts['done'][obj.object_id] = true
+		
+		# return rv
+		return rv
+	end
+	#
+	# deep_dup
+	#---------------------------------------------------------------------------
+	
+	
+	#---------------------------------------------------------------------------
+	# deep_dup_hash
+	#
+	def self.deep_dup_hash(hsh, opts)
+		# $tm.hrm
+		rv = {}
+		
+		hsh.each do |key, val|
+			rv[key.dup] = self.deep_dup(val, opts)
+		end
+		
+		return rv
+	end
+	
+	private_class_method :deep_dup_hash
+	#
+	# deep_dup_hash
+	#---------------------------------------------------------------------------
+	
+	
+	#---------------------------------------------------------------------------
+	# deep_dup_array
+	#
+	def self.deep_dup_array(arr, opts)
+		rv = []
+		
+		arr.each do |val|
+			rv.push self.deep_dup(val, opts)
+		end
+		
+		return rv
+	end
+	
+	private_class_method :deep_dup_array
+	#
+	# deep_dup_array
+	#---------------------------------------------------------------------------
 end
 #
 # LX
@@ -89,7 +192,7 @@ end
 # A helper class to add methods to the Array class. When you use the Array::lx
 # you're creating an instance of LX::Array.
 class LX::Array
-	# Initialize a LX::Array object. The only param is the array itself.
+	# initialize a LX::Array object. The only param is the array itself.
 	def initialize(p_arr)
 		@arr = p_arr
 	end
@@ -130,12 +233,59 @@ class LX::Array
 		# return
 		return rv
 	end
+	
+	# draw
+	def draw
+		rv = @arr[0]
+		@arr.rotate!
+		return rv
+	end
+	
+	# deep_dup
+	def deep_dup
+		return LX.deep_dup(@arr)
+	end
 end
 #
 # Array
 #===============================================================================
 
 
+#===============================================================================
+# Hash
+#
+
+# Adds a single method to the Hash class. This is the only method that is
+# added to the Hash class itself. Access LX utilities through the array's new
+# +lx+ method.
+#
+# For example, the use the move method, call the method like this:
+#  hsh = {'a'=>1, 'b'=>2, 'c'=>3}
+class Hash
+	# Creates a LX::Array object and returns it.
+	def lx
+		return LX::Hash.new(self)
+	end
+end
+
+# A helper class to add methods to the Hash class. When you use the Hash::lx
+# you're creating an instance of LX::Hash.
+class LX::Hash
+	# initialize a LX::Array object. The only param is the array itself.
+	def initialize(p_hsh)
+		@hsh = p_hsh
+	end
+	
+	# deep_dup
+	def deep_dup
+		return LX.deep_dup(@hsh)
+	end
+end
+#
+# Hash
+#===============================================================================
+
+
 #===============================================================================
 # String
 #
@@ -191,7 +341,205 @@ class LX::String
 	#
 	# collapse
 	#---------------------------------------------------------------------------
+	
+	
+	#---------------------------------------------------------------------------
+	# inner_collapse
+	#
+	def inner_collapse
+		rv = @str.clone
+		rv.gsub!(/[\u00A0\s]+/imu, ' ')
+		return rv
+	end
+	#
+	# inner_collapse
+	#---------------------------------------------------------------------------
+	
+	
+	#---------------------------------------------------------------------------
+	# content?, no_content?, nocontent?
+	#
+	
+	# Returns true if the string contains a non-whitespace character.
+	def hascontent?
+		return @str.match(/\S/mu) ? true : false
+	end
+	
+	# Same as hascontent?
+	def has_content?
+		return hascontent?
+	end
+	
+	# Return true if the string does *not* have any non-whitespace characters.
+	def nocontent?
+		return !hascontent?
+	end
+	
+	# Same as no_content?
+	def no_content?
+		return nocontent?
+	end
+	
+	#
+	# content?, no_content?, nocontent?
+	#---------------------------------------------------------------------------
+	
+	
+	#---------------------------------------------------------------------------
+	# tmp_untaint
+	#
+	def tmp_untaint(rx)
+		# dangerous
+		if rx == LX::String::Dangerous
+			tmp = @str.dup.untaint
+		else
+			if @str.match(rx)
+				tmp = @str.dup.untaint
+			else
+				raise 'string-does-not-match-untaint-pattern'
+			end
+		end
+		
+		# yield
+		yield tmp
+	end
+	#
+	# tmp_untaint
+	#---------------------------------------------------------------------------
+end
+
+module LX::String::Dangerous
 end
 #
 # String
+#===============================================================================
+
+
+#===============================================================================
+# Integer
+#
+class Integer
+	# Creates a LX::Array object and returns it.
+	def lx
+		return LX::Integer.new(self)
+	end
+end
+
+class LX::Integer
+	def initialize(int)
+		@int = int
+	end
+	
+	def multiple_of?(number)
+		number != 0 ? @int % number == 0 : @int.zero?
+	end
+end
+#
+# Integer
+#===============================================================================
+
+
+#===============================================================================
+# File
+#
+class File
+	def self.lx
+		return LX::File::Class.new(self)
+	end
+end
+
+module LX::File
+end
+
+class LX::File::Class
+	def initialize(clss)
+	end
+	
+	# Atomically writes content to the given path. Does so by creating a temp
+	# file, writing to it, then renaming the temp file to the final destination.
+	def atomic_write(path_final, content)
+		# $tm.hrm
+		temp_path do |path_tmp|
+			File.write path_tmp, content
+			File.rename path_tmp, path_final
+		end
+		
+		# path_tmp = path_final + '.' + rand.to_s.sub(/\A.*\./mu, '')
+	end
+	
+	# Creates a temporary path. Does *not* create a file. If, after the `do`
+	# block, a file exists at that path, that file is deleted.
+	def temp_path(opts = {})
+		opts = {'delete'=>true}.merge(opts)
+		
+		# root
+		if opts['root']
+			root = opts['root'].sub(/\/*\z/mu, '/')
+		else
+			root = './'
+		end
+		
+		# full path
+		path = root + LX.randstr
+		
+		# add extension
+		if opts['ext']
+			ext = opts['ext']
+			ext = ext.sub(/\A\.*/mu, '.')
+			path += ext
+		end
+		
+		if block_given?
+			begin
+				yield path
+			ensure
+				if opts['delete'] and File.exist?(path)
+					File.delete path
+				end
+			end
+		else
+			return path
+		end
+	end
+end
+#
+# File
+#===============================================================================
+
+
+#===============================================================================
+# NilClass
+#
+class NilClass
+	def lx
+		return LX::NilClass.new(self)
+	end
+end
+
+class LX::NilClass
+	def initialize(obj)
+	end
+	
+	# Always returns false.
+	def hascontent?
+		return false
+	end
+	
+	# Always returns false.
+	def has_content?
+		return false
+	end
+	
+	# Always returns true.
+	def nocontent?
+		return true
+	end
+	
+	# Always returns true.
+	def no_content?
+		return true
+	end
+end
+#
+# NilClass
 #===============================================================================

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: lx
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.1'
 platform: ruby
 authors:
 - Mike O'Sullivan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-29 00:00:00.000000000 Z
+date: 2021-01-03 00:00:00.000000000 Z
 dependencies: []
-description: Misc utilities for strings and arrays
+description: Misc utilities, mostly for use in other libraries that I'm uploading.
 email: mike@idocs.com
 executables: []
 extensions: []