humanized 0.0.1.alpha

data/lib/humanized.rb

@@ -0,0 +1,52 @@
+# -*- encoding : utf-8 -*-
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the Affero GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#    (c) 2011 by Hannes Georg
+#
+
+require "facets/module/home.rb"
+require "facets/module/basename.rb"
+require "facets/module/anonymous.rb"
+require "facets/module/alias_method_chain.rb"
+
+# Humanized is library which really helps you create human 
+# readable output.
+module Humanized
+  
+  module HasNaturalGenus
+    
+    def self.included(base)
+      base.class_eval do
+        alias_method_chain :humanization_key, :genus
+      end
+    end
+    
+    def genus
+      return super if defined? super
+      raise NoMethodError, "Please implent a method `genus`!"
+    end
+    
+    def humanization_key_with_genus
+      return humanization_key_without_genus.optionally(self.genus)
+    end
+    
+  end
+  
+end
+require "humanized/ref"
+require "humanized/humanizer"
+require "humanized/scope"
+Dir[File.expand_path('humanized/core_ext/*.rb', File.dirname(__FILE__))].each do |file|
+  require file
+end

data/lib/humanized/compiler.rb

@@ -0,0 +1,127 @@
+# -*- encoding : utf-8 -*-
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the Affero GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#    (c) 2011 by Hannes Georg
+#
+
+module Humanized
+class Compiler
+  
+  class Compiled < Proc
+  
+    attr_accessor :str
+  
+    def initialize(str)
+      @str = str
+      super()
+      return self
+    end
+  
+    def to_s
+      @str
+    end
+    
+  end
+
+  def initialize
+    @compiled = Hash.new{|hsh,x| hsh[x] = compile!(x)}
+  end
+
+# Compiles a String into a Proc
+# @param [String] str A formated String
+# @return [Compiled] A Proc, which will handle interpolation.
+#
+  def compile(str)
+    @compiled[str]
+  end
+protected
+  
+  VAR_REGEXP = /^%([a-z_]+)/
+  CALL_START_REGEXP = /^\[([a-z]+)[\]\|]/
+  END_REGEXP = /[\[\]%\|]/
+  
+  TRANSFORMER = lambda{|token|
+    if token.kind_of? Array
+      "[#{token.map(&TRANSFORMER).join(',')}].join()"
+    elsif token.kind_of? String
+      token.inspect
+    elsif token.kind_of? Symbol
+      "variables[#{token.inspect}]"
+    elsif token.kind_of? Hash
+      "interpolater.#{token[:method]}(humanizer,#{token[:args].map(&TRANSFORMER).join(',')})"
+    end
+  }
+  
+  def compile!(str)
+    return eval('Compiled.new(str){|humanizer,interpolater,variables| ' + TRANSFORMER.call(read(str)) +' }')  
+  end
+  
+  def read(str)
+    result = []
+    rest = str
+    while( rest.size > 0 )
+      token, rest = read_one(rest)
+      if token.kind_of? String and result.last.kind_of? String
+        result.last << token
+      else
+        result << token
+      end
+    end
+    return result
+  end
+  
+  def read_one(str)
+    return str,str if str.size == 0
+    match = nil
+    if str =~ VAR_REGEXP
+      return $1.to_sym, str[($1.size+1)..-1]
+    elsif str =~ CALL_START_REGEXP
+      method = $1
+      args = []
+      rest = str[($1.size+1)..-1]
+      while rest[0] != ?]
+        arg = []
+        rest = rest[1..-1]
+        if rest.size == 0
+          return str, ''
+        end
+        while rest[0] != ?| and rest[0] != ?]
+          token, rest = read_one(rest)
+          if rest.size == 0
+            return str, ''
+          end
+          arg << token
+        end
+        if arg.size == 0
+          args << ''
+        elsif arg.size == 1
+          args << arg.first
+        else
+          args << arg
+        end
+        
+      end
+      return {:method=>method,:args=>args},rest[1..-1]
+    elsif match = END_REGEXP.match(str)
+      if match.pre_match.size == 0
+        return str[0...1], str[1..-1]
+      end
+      return match.pre_match, match[0] + match.post_match
+    end
+    return str, ''
+  end
+
+end
+  
+end

data/lib/humanized/core_ext/array.rb

@@ -0,0 +1,25 @@
+# -*- encoding : utf-8 -*-
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the Affero GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#    (c) 2011 by Hannes Georg
+#
+class Array
+  def _(*args,&block)
+    if self.any?
+      return self[0]._(*self[1..-1])._(*args,&block)
+    else
+      Humanized::Scope::None
+    end
+  end
+end

data/lib/humanized/core_ext/date.rb

@@ -0,0 +1,21 @@
+# -*- encoding : utf-8 -*-
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the Affero GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#    (c) 2011 by Hannes Georg
+#
+class Date
+  def _(*args,&block)
+    self.humanization_key.with_variables(:time=>self.dup.freeze, :format =>:default).with_default('[date|%time|%format]')._(*args,&block)
+  end
+end

data/lib/humanized/core_ext/hash.rb

@@ -0,0 +1,25 @@
+# -*- encoding : utf-8 -*-
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the Affero GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#    (c) 2011 by Hannes Georg
+#
+class Hash
+  def _(*args,&block)
+    if self.class == Hash
+      Humanized::Scope::None._(*args,&block).with_variables(self)
+    else
+      super
+    end
+  end
+end

data/lib/humanized/core_ext/module.rb

@@ -0,0 +1,47 @@
+# -*- encoding : utf-8 -*-
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the Affero GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#    (c) 2011 by Hannes Georg
+#
+class Module
+  
+  # Generates a {Humanized::Scope scope} for a Module or Class. This will be used by default by
+  # this Module and by all Objects of this Class.
+  def humanization_key!
+    if self.anonymous?
+      return self.superclass.humanization_key
+    end
+    h = self.home
+    if h != Object and h.respond_to? :humanization_key
+      result = h.humanization_key + self.basename.downcase.to_sym
+    else
+      result = Humanized::Scope::Root.+(*self.name.split('::').map{|s| s.downcase.to_sym })
+    end
+    thiz = self
+    if defined? thiz.superclass and self.superclass != Object
+      return result | self.superclass.humanization_key
+    end
+    return result
+  end
+  
+  # Like {Module#humanization_key!}, but cached.
+  def humanization_key
+    @humanization_key ||= humanization_key!
+  end
+
+  def _(*args,&block)
+    humanization_key._(*args,&block)
+  end
+  
+end

data/lib/humanized/core_ext/nilclass.rb

@@ -0,0 +1,21 @@
+# -*- encoding : utf-8 -*-
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the Affero GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#    (c) 2011 by Hannes Georg
+#
+class NilClass
+  def _(*args,&block)
+    Humanized::Scope::None._(*args,&block)
+  end
+end

data/lib/humanized/core_ext/numeric.rb

@@ -0,0 +1,21 @@
+# -*- encoding : utf-8 -*-
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the Affero GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#    (c) 2011 by Hannes Georg
+#
+class Numeric
+  def _(*args,&block)
+    self.humanization_key.with_variables(:number=>self, :format =>:default).with_default('[number|%number|%format]')._(*args,&block)
+  end
+end

data/lib/humanized/core_ext/object.rb

@@ -0,0 +1,24 @@
+# -*- encoding : utf-8 -*-
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the Affero GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#    (c) 2011 by Hannes Georg
+#
+class Object
+  def humanization_key
+    self.class.humanization_key
+  end
+  def _(*args,&block)
+    self.humanization_key._(*args,&block)
+  end
+end

data/lib/humanized/core_ext/string.rb

@@ -0,0 +1,21 @@
+# -*- encoding : utf-8 -*-
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the Affero GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#    (c) 2011 by Hannes Georg
+#
+class String
+  def _(*args,&block)
+    Humanized::Scope::None._(*args,&block).with_default(self)
+  end
+end

data/lib/humanized/core_ext/symbol.rb

@@ -0,0 +1,21 @@
+# -*- encoding : utf-8 -*-
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the Affero GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#    (c) 2011 by Hannes Georg
+#
+class Symbol
+  def _(*args,&block)
+    Humanized::Scope.new([[self]])._(*args,&block)
+  end
+end

data/lib/humanized/core_ext/time.rb

@@ -0,0 +1,21 @@
+# -*- encoding : utf-8 -*-
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the Affero GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#    (c) 2011 by Hannes Georg
+#
+class Time
+  def _(*args,&block)
+    self.humanization_key.with_variables(:time=>self.dup.freeze, :format =>:default).with_default('[date|%time|%format]')._(*args,&block)
+  end
+end