knjrbfw 0.0.30 → 0.0.31

data/lib/knj/locale_strings.rb

@@ -1,17 +1,27 @@
 #This file can be symlinked and thereby easily translated by POEdit. Further more the static methods can be used for stuff.
 module Knj::Locales
+  #Returns an array of translated day-names ('_'-method must exist!).
+  #===Examples
+  # Knj::Locales.days_arr #=> ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]
   def self.days_arr
     return [_("Monday"), _("Tuesday"), _("Wednesday"), _("Thursday"), _("Friday"), _("Saturday"), _("Sunday")]
   end
   
+  #Returns an array of short translated day-names.
+  #===Examples
+  # Knj::Locales.days_short_arr #=> ["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"]
   def self.days_short_arr
     return [_("Mon"), _("Tue"), _("Wed"), _("Thu"), _("Fri"), _("Sat"), _("Sun")]
   end
   
+  #Returns an array of translated month-names.
+  #===Examples
+  # Knj::Locales.months_arr #=> ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"]
   def self.months_arr
     return [_("January"), _("February"), _("March"), _("April"), _("May"), _("June"), _("July"), _("August"), _("September"), _("October"), _("November"), _("December")]
   end
   
+  #Returns an array of translate 'ago'-strings. View the source to see which.
   def self.ago_strings
     return {
       :year_ago_str => _("%s year ago"),

data/lib/knj/locales.rb

@@ -1,5 +1,8 @@
+#This module can be used to handel various language-stuff.
 module Knj::Locales
   #Returns the primary locale, secondary locale and the two put together.
+  #===Examples
+  # Knj::Locales.lang #=> {"first" => "en", "second" => "GB", "full" => "en_GB"}
   def self.lang
     match = self.locale.to_s.match(/^([a-z]{2})_([A-Z]{2})/)
     raise "Could not understand language: #{self.locale}." if !match
@@ -12,6 +15,8 @@ module Knj::Locales
   end
   
   #Returns various localized information about the environment.
+  #===Examples
+  # Knj::Locales.localeconv #=> {"decimal_point" => ".", "thousands_sep" => ",", "csv_delimiter" => ","}
   def self.localeconv
     f = Knj::Locales.lang["first"]
     
@@ -38,18 +43,25 @@ module Knj::Locales
   end
   
   #Returns a float from the formatted string according to the current locale.
+  #===Examples
+  # Knj::Locales.number_in("123,456.68") #=> 123456.68
   def self.number_in(num_str)
     lc = Knj::Locales.localeconv
     return num_str.to_s.gsub(lc["thousands_sep"], "").gsub(lc["decimal_point"], ".").to_f
   end
   
   #Returns the given number as a formatted string according to the current locale.
+  #===Examples
+  # Knj::Locales.number_out(123456.68) #=> "123,456.68"
   def self.number_out(num_str, dec = 2)
     lc = Knj::Locales.localeconv
     return Knj::Php.number_format(num_str, dec, lc["decimal_point"], lc["thousands_sep"])
   end
   
-  #Returns the current locale for the current environment.
+  #Returns the current locale for the current environment (_session[:locale] or Thread.current[:locale]).
+  #===Examples
+  # Knj::Locales.locale #=> 'en_GB'
+  # Knj::Locales.locale #=> 'da_DK'
   def self.locale
     begin
       return _session[:locale] if _session[:locale].to_s.strip.length > 0

data/lib/knj/rand.rb

@@ -1,8 +1,11 @@
+#This module is used to handel various random handeling.
 module Knj::Rand
+  #Returns a random integer between the two integers given.
   def self.range(first, last)
     return first.to_i + rand(last.to_i - first.to_i)
   end
   
+  #Returns a random element in the given array.
   def self.array(arr)
     key = rand(arr.length)
     return arr[key]

data/lib/knj/strings.rb

@@ -1,10 +1,13 @@
 #encoding: utf-8
 
+#This module contains various methods to escape, change or treat strings.
 module Knj::Strings
+  #Returns a string that is safe to use on the command line.
   def self.UnixSafe(tha_string)
     return tha_string.to_s.gsub(" ", "\\ ").gsub("&", "\&").gsub("(", "\\(").gsub(")", "\\)").gsub('"', '\"').gsub("\n", "\"\n\"").gsub(":", "\\:").gsub('\'', "\\\\'").gsub("`", "\\\\`")
   end
   
+  #Alias for UnixSafe.
   def self.unixsafe(string)
     return Knj::Strings.UnixSafe(string)
   end
@@ -125,14 +128,21 @@ module Knj::Strings
   end
   
   #Shortens a string to maxlength and adds "..." if it was shortened.
+  #===Examples
+  # Knj::Strings.shorten("Kasper Johansen", 6) #=> "Kasper..."
   def self.shorten(str, maxlength)
     str = str.to_s
     str = str.slice(0..(maxlength - 1)).strip + "..." if str.length > maxlength
     return str
   end
   
+  #Search for what looks like links in a string and does something with it based on block given or arguments given.
+  #===Examples
+  # str = "asd asd asd asdjklqwejqwer http://www.google.com asdfas df asf"
+  # Knj::Strings.html_links(str) #=> "asd asd asd asdjklqwejqwer <a href=\"http://www.google.com\">http://www.google.com</a> asdfas df asf"
+  # Knj::Strings.html_links(str){ |data| str.gsub(data[:match][0], "!!!#{data[:match][1]}!!!")} #=> "asd asd asd asdjklqwejqwer !!!www!!! asdfas df asf"
   def self.html_links(str, args = {})
-    str.to_s.html.scan(/(http:\/\/([A-z]+)\S*\.([A-z]{2,4})(\S+))/) do |match|
+    Knj::Web.html(str).scan(/(http:\/\/([A-z]+)\S*\.([A-z]{2,4})(\S+))/) do |match|
       if block_given?
         str = yield(:str => str, :args => args, :match => match)
       else
@@ -150,8 +160,11 @@ module Knj::Strings
     return str
   end
   
+  #Strips various given characters from a given string.
+  #===Examples
+  # Knj::Strings.strip("...kasper...", {:right => false, :left => true, :strips => [".", ","]}) #=> "kasper..."
   def self.strip(origstr, args)
-    newstr = "#{origstr}<br>"
+    newstr = "#{origstr}"
     
     if !args.key?(:right) or args[:right]
       loop do

data/lib/knj/threadhandler.rb

@@ -114,10 +114,10 @@ class Knj::Threadhandler
         else
           #No free objects, but we can spawn a new one and use that...
           newobj = @spawn_new_block.call
-          @objects << {
+          @objects << Knj::Threadsafe::Synced_hash.new.merge(
             :free => false,
             :object => newobj
-          }
+          )
           STDOUT.print "Spawned db and locked new.\n" if @args[:debug]
         end
       end

data/lib/knj/threadsafe.rb

@@ -105,7 +105,7 @@ module Knj::Threadsafe
   # arr << 5
   # ret = arr[0]
   class Synced_array < ::Array
-    include Mutexed
+    include Monitored
   end
   
   #Predefined synchronized hash.
@@ -115,6 +115,6 @@ module Knj::Threadsafe
   # h['test'] = 'trala'
   # ret = h['test']
   class Synced_hash < ::Hash
-    include Mutexed
+    include Monitored
   end
 end

data/lib/knj/unix_proc.rb

@@ -1,5 +1,6 @@
 require "#{$knjpath}wref"
 
+#This class handels various stuff regarding Unix-processes.
 class Knj::Unix_proc
   attr_reader :data
   

data/lib/knj/wref.rb

@@ -1,7 +1,25 @@
 #A simple weak-reference framework with mapping. Only handles the referencing of objects.
+#===Examples
+# user_obj = ob.get(:User, 1)
+# weak_ref = Knj::Wref(user_obj)
+# user_obj = nil
+# sleep 0.5
+# GC.start
+#
+# begin
+#   user_obj = weak_ref.get
+#   print "The user still exists in memory and has ID #{user.id}."
+# rescue Knj::Wref::Recycled
+#   print "The user has been removed from memory."
+# end
 class Knj::Wref
-  attr_reader :class_name, :id
+  #Returns the classname of the object.
+  attr_reader :class_name
   
+  #Returns the object-ID which is used to look up the ObjectSpace (if not running JRuby).
+  attr_reader :id
+  
+  #Initializes various variables.
   def initialize(obj)
     @id = obj.__id__
     
@@ -17,7 +35,13 @@ class Knj::Wref
     end
   end
   
-  #Returns the object that this weak reference holds or throws Knj::Wref::Recycled.
+  #Returns the object that this weak reference holds or raises Knj::Wref::Recycled.
+  # begin
+  #   obj = wref.get
+  #   print "Object still exists in memory."
+  # rescue Knj::Wref::Recycled
+  #   print "Object has been garbage-collected."
+  # end
   def get
     begin
       raise Knj::Wref::Recycled if !@class_name or !@id
@@ -54,6 +78,7 @@ class Knj::Wref
   end
   
   #Returns true if the reference is still alive.
+  # print "The object still exists in memory." if wref.alive?
   def alive?
     begin
       self.get
@@ -63,11 +88,28 @@ class Knj::Wref
     end
   end
   
-  #Make Wref compatible with the normal WeakRef.
+  #Makes Wref compatible with the normal WeakRef.
   alias weakref_alive? alive?
   alias __getobj__ get
 end
 
+#A weak hash-map.
+#===Examples
+# map = Knj::Wref_map.new
+# map[1] = obj
+# obj = nil
+# 
+# sleep 0.5
+# 
+# begin
+#   obj = map[1]
+#   print "Object still exists in memory."
+# rescue Knj::Wref::Recycled
+#   print "Object has been garbage-collected."
+# end
+#
+# obj = map.get!(1)
+# print "Object still exists in memory." if obj
 class Knj::Wref_map
   def initialize(args = nil)
     @map = {}
@@ -93,6 +135,13 @@ class Knj::Wref_map
   end
   
   #Returns a object by ID or raises a RefError.
+  #===Examples
+  # begin
+  #   obj = map[1]
+  #   print "Object still exists in memory."
+  # rescue Knj::Wref::Recycled
+  #   print "Object has been garbage-collected."
+  # end
   def get(id)
     begin
       @mutex.synchronize do
@@ -106,6 +155,9 @@ class Knj::Wref_map
   end
   
   #The same as 'get' but returns nil instead of WeakRef-error. This can be used to avoid writing lots of code.
+  #===Examples
+  # obj = map.get!(1)
+  # print "Object still exists in memory." if obj
   def get!(id)
     begin
       return self.get(id)
@@ -147,6 +199,8 @@ class Knj::Wref_map
   end
   
   #Returns true if the given key exists in the hash.
+  #===Examples
+  # print "Key exists but we dont know if the value has been garbage-collected." if map.key?(1)
   def key?(key)
     @mutex.synchronize do
       return @map.key?(key)
@@ -193,4 +247,5 @@ class Knj::Wref_map
   alias []= set
 end
 
+#This error is raised when an object in a wref has been garbage-collected.
 class Knj::Wref::Recycled < RuntimeError; end

metadata

@@ -1,91 +1,94 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: knjrbfw
-version: !ruby/object:Gem::Version
-  version: 0.0.30
+version: !ruby/object:Gem::Version 
   prerelease: 
+  version: 0.0.31
 platform: ruby
-authors:
+authors: 
 - Kasper Johansen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-03 00:00:00.000000000 +02:00
+
+date: 2012-05-06 00:00:00 +02:00
 default_executable: 
-dependencies:
-- !ruby/object:Gem::Dependency
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &10501580 !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *10501580
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: &10500380 !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *10500380
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: jeweler
-  requirement: &10498900 !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 1.6.3
   type: :development
   prerelease: false
-  version_requirements: *10498900
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: rcov
-  requirement: &10498100 !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
   prerelease: false
-  version_requirements: *10498100
-- !ruby/object:Gem::Dependency
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: sqlite3
-  requirement: &10497180 !ruby/object:Gem::Requirement
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
   prerelease: false
-  version_requirements: *10497180
-- !ruby/object:Gem::Dependency
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: rmagick
-  requirement: &10496360 !ruby/object:Gem::Requirement
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
   prerelease: false
-  version_requirements: *10496360
+  version_requirements: *id006
 description: Including stuff for HTTP, SSH and much more.
 email: k@spernj.org
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - LICENSE.txt
 - README.rdoc
-files:
+files: 
 - .document
 - .rspec
 - Gemfile
@@ -332,31 +335,34 @@ files:
 - testfiles/image.jpg
 has_rdoc: true
 homepage: http://github.com/kaspernj/knjrbfw
-licenses:
+licenses: 
 - MIT
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -1220639088849160956
+      segments: 
       - 0
-      hash: -3738020012836301532
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
 requirements: []
+
 rubyforge_project: 
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A framework with lots of stuff for Ruby.
 test_files: []
+