kyanite 0.7.4 → 0.7.5

data/History.rdoc

@@ -1,3 +1,6 @@
+== 0.7.5 2012-11-14
+* added FSymbol class
+
 == 0.7.0 2012-10-31
 * some structure changes
 * englisch YARD documentation

data/Manifest.txt

@@ -18,6 +18,7 @@ lib/kyanite/enumerable/enumerable_enumerables.rb
 lib/kyanite/enumerable/enumerable_numerics.rb
 lib/kyanite/enumerable/enumerable_strings.rb
 lib/kyanite/enumerable/structure.rb
+lib/kyanite/fsymbol.rb
 lib/kyanite/general.rb
 lib/kyanite/general/callerutils.rb
 lib/kyanite/general/classutils.rb
@@ -64,6 +65,7 @@ test/string/test_misc.rb
 test/string/test_nested.rb
 test/string/test_split.rb
 test/test_dictionary.rb
+test/test_fsymbol.rb
 test/test_hash.rb
 test/test_optimizer.rb
 test/test_range.rb

data/README.rdoc

@@ -13,6 +13,7 @@ Welcome to Kyanite. It's a general toolbox like Facets or ActiveSupport.
 [{Hash} {Dictionary} {Tree::TreeNode Tree}] General tools.
 [{Optimizer}] Find objects with min or max score.
 [{Undoable}] Save and restore objects. Great for try-and-error-algorithms.
+[{FSymbol}] A comparable {Symbol} within a hierarchy: A more specific {FSymbol} is larger than a more general {FSymbol}.
 [{Object} {CallerUtils}] Repeats a block until the time is up. Silence Ruby warnings. Deep copy. Examine the call stack.
 
 

data/Rakefile.rb

@@ -22,8 +22,8 @@ $hoe = Hoe.spec Drumherum.project_name do
    
   developer('Bjoern Klippstein', 'klippstein@klippstein.com')
   summary               = 'General toolbox like Facets or ActiveSupport.'  
-  extra_deps            << ['drumherum',                '>= 0.1.19']  
-  extra_deps            << ['transparent_nil',          '>= 0.1.7']
+  extra_deps            << ['drumherum',                '>= 0.1.34']  
+  extra_deps            << ['transparent_nil',          '>= 0.1.20']
   extra_deps            << ['activesupport',            '>= 3.2.8']
   extra_deps            << ['facets',                   '>= 2.9.3']
   extra_deps            << ['rubytree',                 '>= 0.8.3'] 

data/lib/kyanite/fsymbol.rb

@@ -0,0 +1,177 @@
+# ruby encoding: utf-8
+# ü
+if $0 == __FILE__ 
+  require 'drumherum'
+  smart_init
+end
+require 'kyanite/tree'  
+
+
+
+
+# @!macro fsymbol
+class FSymbol
+
+  attr_accessor :value
+  attr_accessor :childs
+  @@instance_cache = {}
+  @@def_tree_cache = nil
+  
+  # @private  
+  def self.instance_cache
+    @@instance_cache
+  end
+  
+
+    
+    
+  
+  def initialize( value, def_tree=nil)
+    raise ArgumentError, 'Value darf nicht nil sein!'       if value.nil?    
+    @value = value    
+    
+    if @@instance_cache[value]
+      @childs = @@instance_cache[value].childs 
+      return @@instance_cache[value] 
+    end
+    
+    if def_tree.nil?
+      def_tree = @@def_tree_cache
+    else
+      @@def_tree_cache = def_tree
+    end
+    tree = def_tree.find(value) || nil
+    raise ArgumentError, "FSymbol konnte nicht erzeugt werden. Value :#{value} nicht im Definitionstree gefunden."       if tree.nil? 
+    
+    @childs = tree.all_child_keys    
+    @@instance_cache[value] = self
+    self
+  end  
+  
+  
+  def to_s
+    @value.to_s
+  end
+  
+  
+  def inspect
+    @value.inspect
+  end  
+
+  
+  def <=>(other)
+    return nil       if other.nil?
+    other = other.to_fsymbol  unless other.class == FSymbol
+    return 0   if @value == other.value    
+    return -1  if @childs.include?(other.value)
+    return 1   if other.childs.include?(@value) 
+    return nil
+  end   
+    
+  
+  def ==(other)
+    return nil       if other.nil?
+    begin
+      (self <=> other) == 0
+    rescue
+      nil
+    end
+  end  
+  
+  
+  def <=(other)
+    return nil       if other.nil?
+    begin
+      c = (self <=> other)
+      (c == -1 || c == 0)
+    rescue
+      nil
+    end
+  end  
+  
+  
+  def >=(other)
+    return nil       if other.nil?
+    begin
+      c = (self <=> other)
+      (c == 1 || c == 0)
+    rescue
+      nil
+    end
+  end    
+
+  
+  def nil?
+    return true if @value.nil?
+    false
+  end
+  
+  
+end
+
+
+
+# -----------------------------------------------------------------------------------------
+# Interface für Symbol
+#
+class Symbol
+   
+  def to_fsymbol(def_tree=nil)
+    FSymbol.new(self, def_tree)
+  end
+ 
+end
+
+
+
+
+
+
+# -----------------------------------------------------------------------------------------
+# Ausprobieren
+#
+if $0 == __FILE__ then
+
+  require 'perception'  
+
+  unless defined? DEF_TREE
+      # Oberste Ebene
+      ttroot = Tree::TreeNode.new(:root)
+      ttroot << Tree::TreeNode.new(:item)       
+      ttroot << Tree::TreeNode.new(:num) 
+      ttroot << Tree::TreeNode.new(:site) << Tree::TreeNode.new(:url) 
+      ttroot << Tree::TreeNode.new(:sonstiges) 
+      
+      # :singlechar
+      ttroot << Tree::TreeNode.new(:singlechar)        
+                            ttroot[:singlechar] << Tree::TreeNode.new(:struktur) << Tree::TreeNode.new(:punkt) << Tree::TreeNode.new(:satzende) 
+                            ttroot[:singlechar] << Tree::TreeNode.new(:minus) 
+                            ttroot[:singlechar] << Tree::TreeNode.new(:sonderzeichen)  
+      
+     # :item    
+      ttroot[:item] << (wa_word=Tree::TreeNode.new(:de)) << Tree::TreeNode.new(:name)    
+                          wa_word << Tree::TreeNode.new(:abbrev)   
+                          wa_word << Tree::TreeNode.new(:multi)   
+      
+      
+      DEF_TREE = ttroot   
+    # see DEF_TREE.print_tree     
+  end    
+
+
+  see :item.to_fsymbol(DEF_TREE)
+  see :item.to_fsymbol(DEF_TREE)
+  see :singlechar.to_fsymbol(DEF_TREE)
+  see :singlechar.to_fsymbol(DEF_TREE)
+  see FSymbol.instance_cache
+
+
+
+end
+
+
+
+
+
+
+

data/lib/kyanite.rb

@@ -157,12 +157,32 @@
 #  [Kyanite tests and examples]  
 #  [Usage] +require 'kyanite/general/callerutils'+ 
 
+# @!macro [new] fsymbol
+#  === CallerUtils
+#  [Kyanite definitions] {FSymbol} 
+#  [Kyanite tests and examples] {TestKyaniteFSymbols} 
+#  [Usage] +require 'kyanite/fsymbol'+ 
+# 
+#  A {FSymbol} ("focusable Symbol") is 
+#  a comparable {Symbol} within a hierarchy. You can use it for classifications.
+#  In its values​​, it is limited to the values​​, 
+#  which are defined in the hierarchy. 
+#  FSymbols are comparable with <= >= <=>. A more specific {FSymbol} is larger than a more general {FSymbol} 
+#  (because the specific FSymbol contains more information)
+#  E.g. if you define a hierarchy if animal species, you can say:
+#    :insect.to_f_symbol <= :bee.to_f_symbol
+#  FSymbols are equal to Symbols with the same name.
+#  
+
+
+
   require 'drumherum'
 
   require 'kyanite/array'
 # require 'kyanite/basics'            # Auswahl
   require 'kyanite/dictionary'
   require 'kyanite/enumerable'       
+  require 'kyanite/fsymbol'
   require 'kyanite/general'
   require 'kyanite/hash'
   require 'kyanite/numeric' 

data/test/_start_all.rb

@@ -3,17 +3,10 @@
 #	Führt alle Tests aus
 #
 
-if $0 == __FILE__ 
-  require 'drumherum'
-  smart_init  
-end
+require 'drumherum'
+smart_init 
 
-require 'transparent_nil'     
-  
-  
-# Test-Verzeichnisse der Applikation
 Dir["#{File.join(Drumherum::directory_main, 'test')}/test_*.rb"].sort.each { |t| require t }  
-
 Dir["#{File.join(Drumherum::directory_main, 'test', 'array' )}/test_*.rb"].sort.each { |t| require t }  
 Dir["#{File.join(Drumherum::directory_main, 'test', 'enumerable' )}/test_*.rb"].sort.each { |t| require t }  
 Dir["#{File.join(Drumherum::directory_main, 'test', 'general' )}/test_*.rb"].sort.each { |t| require t }  

data/test/test_fsymbol.rb

@@ -0,0 +1,122 @@
+# ruby encoding: utf-8
+# ü
+if $0 == __FILE__ 
+  require 'drumherum'
+  smart_init 
+  require 'perception'  
+end
+require 'drumherum/unit_test' 
+
+require 'kyanite/fsymbol'              
+
+
+# @!macro fsymbol
+class TestKyaniteFSymbols < UnitTest
+
+  
+  def setup
+  
+    unless defined? $def_tree
+        # Oberste Ebene
+        ttroot = Tree::TreeNode.new(:root)
+        ttroot << Tree::TreeNode.new(:item)       
+        ttroot << Tree::TreeNode.new(:num) 
+        ttroot << Tree::TreeNode.new(:site) << Tree::TreeNode.new(:url) 
+        ttroot << Tree::TreeNode.new(:sonstiges) 
+        
+        # :singlechar
+        ttroot << Tree::TreeNode.new(:singlechar)        
+                              ttroot[:singlechar] << Tree::TreeNode.new(:struktur) << Tree::TreeNode.new(:punkt) << Tree::TreeNode.new(:satzende) 
+                              ttroot[:singlechar] << Tree::TreeNode.new(:minus) 
+                              ttroot[:singlechar] << Tree::TreeNode.new(:sonderzeichen)  
+        
+       # :item    
+        ttroot[:item] << (wa_word=Tree::TreeNode.new(:de)) << Tree::TreeNode.new(:name)    
+                            wa_word << Tree::TreeNode.new(:abbrev)   
+                            wa_word << Tree::TreeNode.new(:multi)   
+        
+        
+        $def_tree = ttroot   
+        #$def_tree.print_tree     
+    end    
+  
+    @tokencodes = [:num, :url, :site, :item, :punkt, :minus, :struktur, :sonderzeichen, :sonstiges, :singlechar, :satzende, :de, :abbrev, :name, :multi]
+    @root = :root.to_fsymbol($def_tree)
+  end
+  
+  
+  
+  def test_first
+    a = FSymbol.new(:item)
+    assert_equal 'item',     a.to_s
+    assert_equal ':item',    a.inspect
+  end    
+  
+  
+  def test_raise
+    assert_raise(ArgumentError)  {   FSymbol.new(:idfsdgtem)  }
+    assert_raise(ArgumentError)  {   FSymbol.new('item')  }
+    assert_raise(ArgumentError)  {   FSymbol.new(nil)  }
+  end     
+
+    
+  def test_tokencodes
+    @tokencodes.each do |c|
+      assert_equal c.to_s,  FSymbol.new(c).to_s, "FSymbol für Tokencode :#{c} konnte nicht erzeugt werden"          
+    end
+  end
+
+  
+  def test_all_child_keys
+    t = @tokencodes.to_set
+    b = FSymbol.new(:root).childs.to_set
+    diff = ((t-b) + (b-t)).to_a
+    assert_equal t, b, "\n\n\nDifferenz zwischen @tokencodes hier im Test und dem Definitionsbaum. \nUnterschied: #{diff}\n\n\n" 
+  end
+  
+  
+  def test_root
+    assert_equal 0,       @root <=> @root  
+    assert_equal 0,       @root <=> :root 
+    assert                @root >= @root 
+    assert                @root <= @root 
+    assert                @root >= @root   
+    assert                @root <= @root       
+    @tokencodes.each do |c|
+      cf = c.to_fsymbol
+      assert_equal( -1,    (@root <=> c.to_fsymbol     )) 
+      assert_equal(  1,    (cf     <=> @root  ))
+      assert_equal( -1,    (@root <=> cf                 ))       
+    end
+  end
+  
+  
+  def test_specific
+    assert :item.to_fsymbol <= :name.to_fsymbol
+    assert :name.to_fsymbol >= :item.to_fsymbol
+    assert :item.to_fsymbol   <= :abbrev.to_fsymbol
+    assert :abbrev.to_fsymbol >= :item.to_fsymbol
+    assert :minus.to_fsymbol >= :singlechar.to_fsymbol    
+    assert :singlechar.to_fsymbol <= :minus.to_fsymbol    
+  end
+  
+  
+
+  
+
+  
+  
+
+ 
+    
+  
+
+
+
+  
+end
+
+
+
+
+

data/version.rb

@@ -2,7 +2,7 @@
 
 module Kyanite 
 
-  VERSION  = '0.7.4'
+  VERSION  = '0.7.5'
     
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kyanite
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.7.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-12 00:00:00.000000000 Z
+date: 2012-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: drumherum
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.1.19
+        version: 0.1.34
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.1.19
+        version: 0.1.34
 - !ruby/object:Gem::Dependency
   name: transparent_nil
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: 0.1.20
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: 0.1.20
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -202,6 +202,7 @@ files:
 - lib/kyanite/enumerable/enumerable_numerics.rb
 - lib/kyanite/enumerable/enumerable_strings.rb
 - lib/kyanite/enumerable/structure.rb
+- lib/kyanite/fsymbol.rb
 - lib/kyanite/general.rb
 - lib/kyanite/general/callerutils.rb
 - lib/kyanite/general/classutils.rb
@@ -248,6 +249,7 @@ files:
 - test/string/test_nested.rb
 - test/string/test_split.rb
 - test/test_dictionary.rb
+- test/test_fsymbol.rb
 - test/test_hash.rb
 - test/test_optimizer.rb
 - test/test_range.rb
@@ -298,6 +300,7 @@ test_files:
 - test/string/test_nested.rb
 - test/string/test_split.rb
 - test/test_dictionary.rb
+- test/test_fsymbol.rb
 - test/test_hash.rb
 - test/test_optimizer.rb
 - test/test_range.rb