shard-container 0.6.8 → 0.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcb1a3e2800f9d4a684d53ce2beb4311bb8c6d61
-  data.tar.gz: f62285d01c26e134985b9fc2632fe7129c1546b6
+  metadata.gz: 68945a79f70d617c69093a4eff7f7b6e4aad83fc
+  data.tar.gz: 55c03290f51c15778eb500e935a675b042265fae
 SHA512:
-  metadata.gz: d2447895774a2fc18b5026e7873e415ca415fd5fa5a5f255798d852e0c6bbc39e9348aa28f967495c91ac57cb6c108df1f710b06f7582fc3d5c0066d7b276338
-  data.tar.gz: fb9b70e3817c15f5c84a8f6ba8ad29bb43eadd2c526f2dfc2f9af91ac2fc7c88bdcae3f45279c86ccecf15dfa7e31a5a1b689ca94bf8b4ea4e67dab9113898ef
+  metadata.gz: 7498be0290b087006beb3331c25785bb280adf16f1be7040ae6251c7fad781c0d63246948178134bb647a08fd528b58a94237c9ba9852edde5af9991f7487ae1
+  data.tar.gz: 2a133c018db0f5b9c9a7eb37c0662b8c754815458dfa7deb8ae87d1d859b44030b2d0cb852280acb676ef5b649b1c1036d1dbe6871455bec4dcdba61ec7b0a2d

data/lib/shard/formatting.rb

@@ -4,11 +4,9 @@ class Shard
 		@@clean=[]
 		if index
 			if endnum
-				@values[index..endnum].each{|v| @@clean<<[v.key,v.val,v.util]}
+				@values[index..endnum].each{|v| @@clean<<[*v]}
 			else
-				@@clean<<@values[index].key
-				@@clean<<@values[index].val
-				@@clean<<@values[index].util
+				@@clean<<@values[index][*v]
 			end
 		else
 			@values.each{|v| @@clean<<[*v]}
@@ -19,11 +17,12 @@ class Shard
 
 	#prune duplicates
 	def prune(*type)
-		type.each do |t|
+		type.each{|t|
 			@@uniqs=[]
 			@values.each{|v| @@uniqs.include?(v[t]) ? nil : @@uniqs<<v[t]}
 			@values.each{|v| @@uniqs.include?(v[t]) ? @@uniqs.delete(v[t]) : delete(@values.index(v),:pos)}
-		end
+		}
+		update
 	end
 
 	#fix incorrect entries
@@ -39,5 +38,6 @@ class Shard
 				delete(@values.index(v),:pos)
 			end
 		}
+		update
 	end
 end

data/lib/shard.rb

@@ -4,95 +4,75 @@ class Shard
 	#add attribute readers for meta and value hashes
 	attr_reader :meta,:values
 
-	#class constructor, creates instaces for meta table, values array, and Dict2 struct
-	def initialize(id)
-		if not ['Symbol','String','Fixnum'].include?(id.class.name)
-			raise "Class of type '#{id.class.name}' supplied for id. Symbol, String, or Fixnum required."
-		end
-		@Dict2=Struct.new(:key,:val,:util)
-		@meta=Struct.new(:name,:size,:is_empty)
-		@meta=@meta.new(id,0,true)
+	#updates meta hash
+	private def update
+		@meta.size=@values.length
+		@meta.is_empty=@meta.size<0
+		@meta.editStamp=Time.new
+	end
+
+
+	#class constructor, creates instaces for meta table, values array, and Dict2 struct using args
+	def initialize(*args)
+		args.map{|e| e.to_sym}
+
+		@@elements=args.map{|e| e.to_sym}
+		@Dict2=Struct.new(*@@elements)
+		@meta=Struct.new(:size,:is_empty,:num_indentifiers,:identifiers,:creationStamp,:editStamp)
+		@meta=@meta.new(0,true,@@elements.length,@@elements,Time.new,Time.new)
 		@values=[]
+
+		update
 	end
+	
+	#inset method, adds a Dict2 struct to values at set position
+	def insert(pos=-1,*args)
+		if args.length==@@elements.length
+			@values.insert(pos,@Dict2.new(*args))
+		elsif args.length<@@elements.length
+			raise "Not enough arguments to fill new Dict2 Struct. #{@@elements.length} required."
+		else
+			raise "Too many arguments supplied to fill new Dict2 Struct. #{@@elements.length} required."
+		end
 
-	#add method, adds a Dict2 struct to values
-	def add(key=nil,val=nil,util=nil,pos=-1)
-		@values.insert(pos,@Dict2.new(key,val,util))
-		
-		@meta.size=@values.length
-		@meta.is_empty=@meta.size<0
+		update
 	end
 
 	#deletes an element from the values array based on type parameter
-	def delete(element,type=nil)
-		case type
-		#deleting by key
-		when :key
-			#recursively delete all structs who's key matches element
-			@values.delete_if{|e| e.values[0]==element}
-		#deleting by value..
-		when :val
-			#recursively delete all structs who's value matches element
-			@values.delete_if{|e| e.values[1]==element}
-		when :pos
-			#delete struct at position or structs in range
-			@values.delete(@values[element])
+	def delete(type,val=nil,index=0,endnum=-1)
+		if type
+			@@pntr=@@elements.index(type.to_sym)
+			@values[index..endnum].each{|e|
+				if e[@@pntr]==val
+					@values.delete(e)
+				end
+			}
+		elsif type==false
+			if val!=nil
+				index,endnum=val,index
+			end
+			[index..endnum].to_a.each{|i| @values.delete(i)}
 		else
 			raise TypeError("No type supplied")
 		end
 
-		@meta.size=@values.length
-		@meta.is_empty=@meta.size<0
+		update
 	end
 
 	#return element(s) from shard (optional range)
-	def list(element=nil,index=0,endnum=-1)
-		if [:key,:val,:util].include?(element)
+	def list(element,index=0,endnum=-1)
+		if @@elements.include?(element)
 			@@temp=[]
 			@values[index..endnum].each{|v| @@temp<<v[element]}
 			return @@temp
 		else
-			raise TypeError("Improper or no type supplied.")
-		end
-	end
-
-	#delete by key (alias method)
-	def delKey(element)
-		delete(element,:key)
-	end
-
-	#delete by value (alias method)
-	def delVal(element)
-		delete(element,:val)
-	end
-
-	#delete by position or range (alias)
-	def delPos(element,endnum=nil)
-		case endnum.class.name
-		when 'Fixnum'
-			endnum.downto(element){|i|
-				delete(i,:pos)
-			}
-		when 'NilClass'
-			delete(element,:pos)
+			raise "Improper or no type supplied."
 		end
 	end
 
-	#prune shard by keys
-	def pKeys
-		prune(:key)
-	end
-	#prune shard by values
-	def pVals
-		prune(:val)
-	end
-	#prune shard by utils
-	def pUtils
-		prune(:util)
-	end
-	#prune all shard elements
+	#prune by all elements
 	def pAll
-		prune(:key,:value,:util)
+		prune(*@@elements)
 	end
 
 	#list element by single index
@@ -100,20 +80,13 @@ class Shard
 		list(element,index,index)
 	end
 
-	#deletion aliases
-	alias :keyDelete :delKey
-	alias :valDelete :delVal
-	alias :indexDelete :delPos
-	#pruning aliases
-	alias :pruneKeys :pKeys
-	alias :pruneVals :pVals
-	alias :pruneUtils :pUtils
-	alias :pruneAll :pAll
-	#listing aliases
+	#aliases
 	alias :listPos :lPos
+	alias :pruneAll :pAll
 end
 
-x=Shard.new(:test)
-x.add('foo','bar','123')
-x.add('foo','baz','123')
-p x.list(:val)
+x=Shard.new(:key,:val,:util)
+x.insert(0,'foo','baz',123)
+x.insert(0,'foo','bar',123)
+x.delete(:val,'bar')
+p x.clean

data/readme.md

@@ -6,50 +6,61 @@
 > Shard is an intuitive container class that allows extended capabilities of Hashes and arrays, as well as extra methods for formatting and aliases.
 
 ## Methods
-> #### Initialization
-> A shard's initial id parameter can be set to either a String, Symbol, or Fixnum.
+> ##### Initialization
+> A shard's initial parameters are the symbols that you can access via method calls (ex `Shard.values[0].name`) and can be set to any non-iterable. For ease of documenting my code, we'll just use key/val/util.
 >
->     test1=Shard.new(:testShard)
->     test2=Shard.new('testShard') #different id than the test1
->     test3=Shard.new(3)
+>     test1=Shard.new(key,val,util)
 >
-> #### Adding to a shard
+> ##### Inserting a new segment to a shard
 > Adding to a shard can be done one of two ways.
 >
->     test=Shard.new(:test)
->     test.add('foo',:bar,123)
->     test.values<<['foo',:bar,123] #this can be cleaned up later
+>     test=Shard.new(:key,:val,:util) #initialize the shard
+>     
+>     test.insert(-1,'foo',:bar,123)  #inserts at last position
+>     test.insert(0,'foo',:baz,123)   #inserts at position 0
+>     test.values<<['foo',:bar,123]   #this can be cleaned up later
 >
-> #### Deleting shard elements
-> Deleting from a shard is also easily done.
+> ##### Deleting shard elements
+> Deleting from a shard is also easily done. The type parameter is automatically converted to a symbol, so it can be any non-iterable that matches an identifier.
 >
->     test=Shard.new(:test)    #initialize the shard
->     test.add('foo',:bar,123) #add to the shard
+>     test=Shard.new(:key,:val,:util) #initialize the shard
+>     test.add(-1,'foo',:bar,123)     #add to the shard
 >     
->     test.keyDelete('foo')    #delete by key
->     test.valDelete(':bar')   #delete by value
->     test.indexDelete(0)      #delete by index, works with ranges by using 2 parameters
+>     test.delete('key','foo')        #delete by key
+>     test.delete(:val,':bar')        #delete by value
+>     test.delete(false,0,2)          #delete everything from position 0 to 2
+>     test.delete(:util,123,0,2)      #delete all utils that match 123 from position 0 to 2
 >
-> #### Correction
+> ##### Correction
 > Shards also supply a few formatting methods.
 >
->     test=Shard.new(:test)         #initialize the shard
->     x.values<<[1,2,3]             #add to the shard
+>     test=Shard.new(:key,:val,:util) #initialize the shard
+>     x.values<<[1,2,3]               #add to the shard manually
 >     => [[1, 2, 3]]
->     test.corr                     #converts the manually added array to a formatted struct
+>     test.corr                       #convert all manually inserted array to formatted Dict2 Structs
 >     => [#<struct key=1, val=2, util=3>]
 >
-> #### Pruning
-> Pruning a shard's unique keys, values, or utilities is accomplished using the following aliases, or a raw `Shard.prune` method call using any combination of `:key`,`:val`, or `:util` as parameters.
+> ##### Pruning
+> Pruning a shard down to its unique identifiers is accomplished using the following aliases, or a raw `Shard.prune` method call using any combination of the shard identifiers.
 >
->     Shard.pruneKeys   #prune by keys
->     Shard.pruneVals   #prune by values
->     Shard.pruneUtils  #prune by utilities
->     Shard.pruneAll    #prune by all parameters
+>     Shard.pAll             #prune all 
+>     Shard.pruneAll         #alias for pAll
+>     Shard.prune(:key,:val) #prune both keys and values
 >
-> #### Cleaning shards
-> Cleaning a shard using the `.clean` method returns an Array (nested, if more than one k/v/u set is selected) of readable sets with all elements in their original types.
+> ##### Cleaning shards
+> Cleaning a shard using the `.clean` method returns an Array (nested, if more than one set is selected) of readable sets with all elements in their original types.
 >
 >     Shard.clean      #cleans and returns entire shard
 >     Shard.clean(0)   #cleans and returns shard element at index 0
 >     Shard.clean(0,2) #cleans and returns shard elements at indexes 0 to 2
+>
+> ##### Listing
+> Listing shard elements is done with the `.list` method, like so
+> 
+>     Shard.list(:key,0,2)  #returns all keys between index 0 and 2
+>     Shard.listPos(:key,0) #returns the key at index 0
+>
+> ##### Meta tags
+> Getting a shard's meta information is done with the following methods or aliases
+> 
+>     

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shard-container
 version: !ruby/object:Gem::Version
-  version: 0.6.8
+  version: 0.7.6
 platform: ruby
 authors:
 - Chitoge
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-02 00:00:00.000000000 Z
+date: 2016-02-03 00:00:00.000000000 Z
 dependencies: []
 description: An intuitive new container class for everyone from the everyday programmer
   to the expert rubyist.