lib/ramaze/snippets/object/__dir__.rb lib/ramaze/snippets/object/acquire.rb lib/ramaze/snippets/ramaze/struct.rb spec/ramaze/struct.rb spec/snippets/object/__dir__.rb spec/snippets/object/acquire.rb @@ -90,7 +90,7 @@ task :rcov_summary => :rcov_dir do end desc "generate rdoc" -task :rdoc => [:clean, :readme2html] do +task :rdoc => [:clean] do sh "rdoc #{(RDOC_OPTS + RDOC_FILES).join(' ')}" end Rakefile @@ -10,7 +10,7 @@ module Ramaze # The Action holds information that is essential to render the action for a # request. - class Action < Struct.new('Action', *members) + class Action < Ramaze::Struct.new('Action', *members) end end @@ -145,7 +145,7 @@ module Ramaze end end - # Shortcut to create new instances of Action via Action::fill + # Shortcut to create new instances of Action def self.Action(hash = {}) Action.create(hash) lib/ramaze/action.rb @@ -7,3 +7,16 @@ glob = File.join(dir, '**', '*.rb') Dir[glob].each do |snippet| require(snippet) end + +Ramaze::CoreExtensions.constants.each do |const| + ext = Ramaze::CoreExtensions.const_get(const) + into = Module.const_get(const) + + collisions = ext.instance_methods & into.instance_methods + + if collisions.empty? + into.__send__(:include, ext) + else + warn "Won't include %p with %p, %p exists" % [into, ext, collisions] + end +end lib/ramaze/snippets.rb @@ -1,37 +1,44 @@ # Copyright (c) 2008 Michael Fellinger m.fellinger@gmail.com # All files in this distribution are subject to the terms of the Ruby license. -class Array +module Ramaze + module CoreExtensions - # a = [1, 2, 3] - # a.put_within(4, :after => 2, :before => 3) - # a # => [1, 2, 4, 3] + # Extensions for Array - def put_within(object, constrain) - pre, post = constrain.values_at(:after, :before) + module Array - unless rindex(post) - index(pre) == 1 - raise ArgumentError, "Too many elements within constrain" - end + # a = [1, 2, 3] + # a.put_within(4, :after => 2, :before => 3) + # a # => [1, 2, 4, 3] - put_after(pre, object) - end + def put_within(object, constrain) + pre, post = constrain.values_at(:after, :before) - # a = [1, 2, 3] - # a.put_after(2, 4) - # a # => [1, 2, 4, 3] + return put_after(pre, object) if rindex(post) - index(pre) == 1 - def put_after(element, object) - raise ArgumentError, "The given element doesn't exist" unless include?(element) - self[index(element) + 1, 0] = object - end + raise ArgumentError, "Too many elements within constrain" + end + + # a = [1, 2, 3] + # a.put_after(2, 4) + # a # => [1, 2, 4, 3] - # a = [1, 2, 3] - # a.put_before(2, 4) - # a # => [1, 4, 2, 3] + def put_after(element, object) + return self[index(element) + 1, 0] = object if include?(element) - def put_before(element, object) - raise ArgumentError, "The given element doesn't exist" unless include?(element) - self[rindex(element), 0] = object + raise ArgumentError, "The given element doesn't exist" + end + + # a = [1, 2, 3] + # a.put_before(2, 4) + # a # => [1, 4, 2, 3] + + def put_before(element, object) + return self[rindex(element), 0] = object if include?(element) + + raise ArgumentError, "The given element doesn't exist" + end + end end end lib/ramaze/snippets/array/put_within.rb @@ -1,13 +1,25 @@ -class Binding - - # returns a hash of localvar/localvar-values from binding, useful for - # template engines that do not accept bindings and force passing locals via - # hash - # usage: x = 42; p binding.locals #=> {'x'=> 42} - def locals - Kernel::eval ' - local_variables.inject({}){|h,v| k = v.to_s; h.merge!(k => eval(k)) } - ', self - end +module Ramaze + module CoreExtensions + + # Extensions for Binding + + module Binding + # Returns a hash of localvar/localvar-values from binding, useful for + # template engines that do not accept bindings and force passing locals + # via hash + # + # Usage: + # x = 42; p binding.locals #=> {'x'=> 42} + + def locals + ::Kernel::eval ' + local_variables.inject({}){|h,v| + k = v.to_s + h.merge!(k => eval(k)) + }', self + end + + end + end end lib/ramaze/snippets/binding/locals.rb @@ -1,26 +1,41 @@ # Copyright (c) 2008 Michael Fellinger m.fellinger@gmail.com # All files in this distribution are subject to the terms of the Ruby license. -# Extensions for Kernel - -module Kernel - # Original from Trans (Facets 1.4.5) - # This is similar to +Module#const_get+ but is accessible at all levels, - # and, unlike +const_get+, can handle module hierarchy. - # - # constant("Fixnum") # -> Fixnum - # constant(:Fixnum) # -> Fixnum - # - # constant("Process::Sys") # -> Process::Sys - # constant("Regexp::MULTILINE") # -> 4 - # - # require 'test/unit' - # Test.constant("Unit::Assertions") # -> Test::Unit::Assertions - # Test.constant("::Test::Unit") # -> Test::Unit - - def constant(const) - const = const.to_s.dup - base = const.sub!(/^::/, '') ? Object : ( self.kind_of?(Module) ? self : self.class ) - const.split(/::/).inject(base){ |mod, name| mod.const_get(name) } +module Ramaze + module CoreExtensions + + # Extensions for Kernel + + module Object + + # Original from Trans (Facets 1.4.5) + # This is similar to +Module#const_get+ but is accessible at all levels, + # and, unlike +const_get+, can handle module hierarchy. + # + # constant("Fixnum") # -> Fixnum + # constant(:Fixnum) # -> Fixnum + # + # constant("Process::Sys") # -> Process::Sys + # constant("Regexp::MULTILINE") # -> 4 + # + # require 'test/unit' + # Test.constant("Unit::Assertions") # -> Test::Unit::Assertions + # Test.constant("::Test::Unit") # -> Test::Unit + + def constant(const) + const = const.to_s.dup + + if const.sub!(/^::/, '') + base = Object + elsif self.kind_of?(Module) + base = self + else + base = self.class + end + + const.split(/::/).inject(base){ |mod, name| mod.const_get(name) } + end + end + end end lib/ramaze/snippets/kernel/constant.rb @@ -3,13 +3,19 @@ require 'pp' -# Extensions for Kernel +module Ramaze + module CoreExtensions -module Kernel - unless defined?(pretty_inspect) - # returns a pretty printed object as a string. - def pretty_inspect - PP.pp(self, '') + # Extensions for Kernel + + module Kernel + unless defined?(pretty_inspect) + # returns a pretty printed object as a string. + def pretty_inspect + PP.pp(self, '') + end + end end + end end lib/ramaze/snippets/kernel/pretty_inspect.rb @@ -1,25 +1,32 @@ # Copyright (c) 2008 Michael Fellinger m.fellinger@gmail.com # All files in this distribution are subject to the terms of the Ruby license. -class Numeric - FILESIZE_FORMAT = [ - ['%.1fT', 1 << 40], - ['%.1fG', 1 << 30], - ['%.1fM', 1 << 20], - ['%.1fK', 1 << 10], - ] +module Ramaze + module CoreExtensions - # Output this number as easily readable filesize. - # Usage: - # 100_000.filesize_format # => "97.7K" - # 100_000_000.filesize_format # => "95.4M" - # 100_000_000_000.filesize_format # => "93.1G" - # 100_000_000_000_000.filesize_format # => "90.9T" - def filesize_format - FILESIZE_FORMAT.each do |format, size| - return format % (self.to_f / size) if self >= size + # Extensions for Numeric + module Numeric + FILESIZE_FORMAT = [ + ['%.1fT', 1 << 40], + ['%.1fG', 1 << 30], + ['%.1fM', 1 << 20], + ['%.1fK', 1 << 10], + ] + + # Output this number as easily readable filesize. + # Usage: + # 100_000.filesize_format # => "97.7K" + # 100_000_000.filesize_format # => "95.4M" + # 100_000_000_000.filesize_format # => "93.1G" + # 100_000_000_000_000.filesize_format # => "90.9T" + def filesize_format + FILESIZE_FORMAT.each do |format, size| + return format % (self.to_f / size) if self >= size + end + + self.to_s + end end - self.to_s end end lib/ramaze/snippets/numeric/filesize_format.rb @@ -1,56 +1,63 @@ -class Numeric - - def seconds - self - end - alias second seconds - - # 60 seconds in a minute - def minutes - self * 60 - end - alias minute minutes - - # 60 minutes in an hour - def hours - self * 3600 - end - alias hour hours - - # 24 hours in a day - def days - self * 86400 - end - alias day days - - # 7 days in a week - def weeks - self * 604800 - end - alias week weeks - - # 30 days in a month - def months - self * 2592000 - end - alias month months - - # 365.25 days in a year - def years - self * 883612800 - end - alias year years - - # Time in the past, i.e. 3.days.ago - def ago t = Time.now - t - self - end - alias before ago - - # Time in the future, i.e. 3.days.from_now - def from_now t = Time.now - t + self - end - alias since from_now - -end unless 5.respond_to? :days +module Ramaze + module CoreExtensions + + # Extensions for Numeric + + module Numeric + def seconds + self + end + alias second seconds + + # 60 seconds in a minute + def minutes + self * 60 + end + alias minute minutes + + # 60 minutes in an hour + def hours + self * 3600 + end + alias hour hours + + # 24 hours in a day + def days + self * 86400 + end + alias day days + + # 7 days in a week + def weeks + self * 604800 + end + alias week weeks + + # 30 days in a month + def months + self * 2592000 + end + alias month months + + # 365.25 days in a year + def years + self * 883612800 + end + alias year years + + # Time in the past, i.e. 3.days.ago + def ago t = Time.now + t - self + end + alias before ago + + # Time in the future, i.e. 3.days.from_now + def from_now t = Time.now + t + self + end + alias since from_now + + end + + end +end lib/ramaze/snippets/numeric/time.rb @@ -1,8 +1,19 @@ -class Object - # Available in 1.8.6 and later. - unless method_defined?(:instance_variable_defined?) - def instance_variable_defined?(variable) - instance_variables.include?(variable.to_s) +# Copyright (c) 2008 Michael Fellinger m.fellinger@gmail.com +# All files in this distribution are subject to the terms of the Ruby license. + +module Ramaze + module CoreExtensions + + # Extensions for Object + module Object + # Available in 1.8.6 and later. + + unless ::Object.method_defined?(:instance_variable_defined?) + def instance_variable_defined?(variable) + instance_variables.include?(variable.to_s) + end + end end + end end lib/ramaze/snippets/object/instance_variable_defined.rb @@ -1,6 +1,16 @@ -class Object - def pretty s = '' - PP.pp(self, s) - s +module Ramaze + module CoreExtensions + + # Extensions for Object + module Object + + # Returns the string that #pretty_inspect would yield + + def pretty s = '' + PP.pp(self, s) + s + end + end + end end lib/ramaze/snippets/object/pretty.rb @@ -1,11 +1,18 @@ -class Object +module Ramaze + module CoreExtensions - # returns a new clean binding for this object - # usage: eval 'self', object.scope #=> returns object - # + # Extensions for Object + module Object - def scope - lambda{} - end + # returns a new clean binding for this object + # usage: eval 'self', object.scope #=> returns object + # + + def scope + lambda{} + end + end + + end end lib/ramaze/snippets/object/scope.rb @@ -1,11 +1,19 @@ -class Proc - - # returns a hash of localvar/localvar-values from proc, useful for template - # engines that do not accept bindings/proc and force passing locals via - # hash - # usage: x = 42; p Proc.new.locals #=> {'x'=> 42} - def locals - instance_eval('binding').locals - end +module Ramaze + module CoreExtensions + + # Extensions for Proc + + module Proc + # returns a hash of localvar/localvar-values from proc, useful for template + # engines that do not accept bindings/proc and force passing locals via + # hash + # usage: x = 42; p Proc.new.locals #=> {'x'=> 42} + + def locals + instance_eval('binding').locals + end + + end + end end lib/ramaze/snippets/proc/locals.rb @@ -1,16 +1,21 @@ # Copyright (c) 2008 Michael Fellinger m.fellinger@gmail.com # All files in this distribution are subject to the terms of the Ruby license. -# Extensions for String +module Ramaze + module CoreExtensions -class String + # Extensions for String - # simple transformation to CamelCase from snake_case - # - # 'foo_bar'.camel_case # => 'FooBar' + module String + + # simple transformation to CamelCase from snake_case + # + # 'foo_bar'.camel_case # => 'FooBar' + + def camel_case + split('_').map{|e| e.capitalize}.join + end + end - def camel_case - split('_').map{|e| e.capitalize}.join end end - lib/ramaze/snippets/string/camel_case.rb @@ -1,27 +1,31 @@ # Copyright (c) 2008 Michael Fellinger m.fellinger@gmail.com # All files in this distribution are subject to the terms of the Ruby license. -# Extensions for String +module Ramaze + module CoreExtensions + # Extensions for String -class String - { :reset => 0, - :bold => 1, - :dark => 2, - :underline => 4, - :blink => 5, - :negative => 7, - :black => 30, - :red => 31, - :green => 32, - :yellow => 33, - :blue => 34, - :magenta => 35, - :cyan => 36, - :white => 37, - }.each do |key, value| - define_method key do - "\e[#{value}m" + self + "\e[0m" + module String + { :reset => 0, + :bold => 1, + :dark => 2, + :underline => 4, + :blink => 5, + :negative => 7, + :black => 30, + :red => 31, + :green => 32, + :yellow => 33, + :blue => 34, + :magenta => 35, + :cyan => 36, + :white => 37, + }.each do |key, value| + define_method key do + "\e[#{value}m" + self + "\e[0m" + end + end end + end end - lib/ramaze/snippets/string/color.rb @@ -1,8 +1,19 @@ # Copyright (c) 2008 Michael Fellinger m.fellinger@gmail.com # All files in this distribution are subject to the terms of the Ruby license. -# Extensions for String +module Ramaze + module CoreExtensions -class String - alias each each_line unless ''.respond_to?(:each) + # Extensions for String + + module String + # 1.9 Compatibility with 1.8 + + unless ''.respond_to?(:each) + def each(*args, &block) + each_line(*args, &block) + end + end + end + end end lib/ramaze/snippets/string/each.rb @@ -1,9 +1,20 @@ -class String - unless method_defined?(:end_with?) - # Compatibility with 1.9 - def end_with?(other) - other = other.to_s - self[-other.size, other.size] == other +# Copyright (c) 2008 Michael Fellinger m.fellinger@gmail.com +# All files in this distribution are subject to the terms of the Ruby license. + +module Ramaze + module CoreExtensions + + # Extensions for String + + module String + unless ''.respond_to?(:end_with?) + # Compatibility with 1.9 + def end_with?(other) + other = other.to_s + self[-other.size, other.size] == other + end + end end + end end lib/ramaze/snippets/string/end_with.rb @@ -1,26 +1,34 @@ require 'cgi' require 'uri' -class String +module Ramaze + module CoreExtensions - # String#escape is an extensible escaping mechanism for string. currently - # it suports - # '<div>foo bar</div>'.esc(:html) - # 'foo bar'.esc(:uri) - # 'foo bar'.esc(:cgi) + # Extensions for String - def escape which = :html - case which - when :html - Rack::Utils.escape_html(self) - when :cgi - Rack::Utils.escape(self) - when :uri - ::URI.escape(self) - else - raise ArgumentError, "do not know how to escape '#{ which }'" + module String + + # String#escape is an extensible escaping mechanism for string. currently + # it suports + # '<div>foo bar</div>'.esc(:html) + # 'foo bar'.esc(:uri) + # 'foo bar'.esc(:cgi) + + def escape which = :html + case which + when :html + Rack::Utils.escape_html(self) + when :cgi + Rack::Utils.escape(self) + when :uri + ::URI.escape(self) + else + raise ArgumentError, "do not know how to escape '#{ which }'" + end + end + + alias_method 'esc', 'escape' end - end - alias_method 'esc', 'escape' + end end lib/ramaze/snippets/string/esc.rb @@ -1,15 +1,21 @@ # Copyright (c) 2008 Michael Fellinger m.fellinger@gmail.com # All files in this distribution are subject to the terms of the Ruby license. -# Extensions for String +module Ramaze + module CoreExtensions -class String - unless method_defined?(:ord) + # Extensions for String - # compatibility with Ruby 1.9 + module String + unless ''.respond_to?(:ord) - def ord - self[0] + # compatibility with Ruby 1.9 + + def ord + self[0] + end + end end + end end lib/ramaze/snippets/string/ord.rb @@ -1,15 +1,21 @@ # Copyright (c) 2008 Michael Fellinger m.fellinger@gmail.com # All files in this distribution are subject to the terms of the Ruby license. -# Extensions for String +module Ramaze + module CoreExtensions -class String + # Extensions for String - # convert to snake_case from CamelCase - # - # 'FooBar'.snake_case # => 'foo_bar' + module String + + # convert to snake_case from CamelCase + # + # 'FooBar'.snake_case # => 'foo_bar' + + def snake_case + gsub(/\B[A-Z][^A-Z]/, '_\&').downcase.gsub(' ', '_') + end + end - def snake_case - gsub(/\B[A-Z][^A-Z]/, '_\&').downcase.gsub(' ', '_') end end lib/ramaze/snippets/string/snake_case.rb @@ -1,9 +1,19 @@ -class String - unless method_defined?(:start_with?) - # Compatibility with 1.9 - def start_with?(other) - other = other.to_s - self[0, other.size] == other +module Ramaze + module CoreExtensions + + # Extensions for String + + module String + + unless ''.respond_to?(:start_with?) + + # Compatibility with 1.9 + + def start_with?(other) + other = other.to_s + self[0, other.size] == other + end + end end end end lib/ramaze/snippets/string/start_with.rb @@ -1,20 +1,28 @@ -class String - # Useful for writing indented String and unindent on demand, based on the - # first line with indentation. - def unindent - find_indent = proc{ |l| l.find{|l| !l.strip.empty?}.to_s[/^(\s+)/, 1] } +module Ramaze + module CoreExtensions - lines = self.split("\n") - space = find_indent[lines] - space = find_indent[lines.reverse] unless space + # Extensions for String - strip.gsub(/^#{space}/, '') - end - alias ui unindent + module String + + # Useful for writing indented String and unindent on demand, based on the + # first line with indentation. + def unindent + find_indent = proc{ |l| l.find{|l| !l.strip.empty?}.to_s[/^(\s+)/, 1] } + + lines = self.split("\n") + space = find_indent[lines] + space = find_indent[lines.reverse] unless space + + strip.gsub(/^#{space}/, '') + end + alias ui unindent - # Destructive variant of undindent, replacing the String - def unindent! - self.replace unindent + # Destructive variant of undindent, replacing the String + def unindent! + self.replace unindent + end + alias ui! unindent! + end end - alias ui! unindent! end lib/ramaze/snippets/string/unindent.rb @@ -1,24 +1,30 @@ # Copyright (c) 2008 Michael Fellinger m.fellinger@gmail.com # All files in this distribution are subject to the terms of the Ruby license. -# Extensions for Symbol +module Ramaze + module CoreExtensions -class Symbol - unless method_defined?(:to_proc) + # Extensions for Symbol - # Turns the symbol into a simple proc, which is especially useful for enumerations. Examples: - # - # # The same as people.collect { |p| p.name } - # people.collect(&:name) - # - # # The same as people.select { |p| p.manager? }.collect { |p| p.salary } - # people.select(&:manager?).collect(&:salary) - # - # [1, 2, 3].map(&:to_s) # => ['1', '2', '3'] - # %w[a b c].map(&:to_sym) # => [:a, :b, :c] + module Symbol + unless :to_proc.respond_to?(:to_proc) - def to_proc - Proc.new{|*args| args.shift.__send__(self, *args) } + # Turns the symbol into a simple proc, which is especially useful for enumerations. Examples: + # + # # The same as people.collect { |p| p.name } + # people.collect(&:name) + # + # # The same as people.select { |p| p.manager? }.collect { |p| p.salary } + # people.select(&:manager?).collect(&:salary) + # + # [1, 2, 3].map(&:to_s) # => ['1', '2', '3'] + # %w[a b c].map(&:to_sym) # => [:a, :b, :c] + + def to_proc + Proc.new{|*args| args.shift.__send__(self, *args) } + end + end end + end end lib/ramaze/snippets/symbol/to_proc.rb @@ -1,10 +1,10 @@ # Copyright (c) 2008 Michael Fellinger m.fellinger@gmail.com # All files in this distribution are subject to the terms of the Ruby license. +# Extensions for Thread + class Thread - # Copy following: - # :action, :response, :request, :session, - # :task, :adapter, :controller, :exception + # Copy all thread variables into the new thread def self.into *args Thread.new(Thread.current, *args) do |thread, *args| lib/ramaze/snippets/thread/into.rb @@ -1,6 +1,14 @@ if caller snippet = caller.grep(%r!spec/snippets/!).first.split(':').first require File.expand_path(snippet).gsub('/spec/', '/lib/ramaze/') + + if defined?(Ramaze::CoreExtensions) + Ramaze::CoreExtensions.constants.each do |const| + ext = Ramaze::CoreExtensions.const_get(const) + into = Module.const_get(const) + into.__send__(:include, ext) + end + end end require 'lib/ramaze/spec/helper/bacon' lib/ramaze/spec/helper/snippets.rb @@ -4,8 +4,7 @@ require 'rake' require 'pp' -require 'lib/ramaze/snippets/divide' -require 'lib/ramaze/snippets/string/color' +require 'lib/ramaze/snippets' desc 'Run all specs' task 'spec' do rake_tasks/spec.rake @@ -21,5 +21,3 @@ describe 'Template Haml' do end end end - - spec/examples/templates/template_haml.rb lib/ramaze/snippets/kernel/__dir__.rb lib/ramaze/snippets/kernel/acquire.rb lib/ramaze/snippets/struct/fill.rb lib/ramaze/snippets/struct/values_at.rb spec/snippets/kernel/__dir__.rb spec/snippets/kernel/acquire.rb spec/snippets/struct/fill.rb spec/snippets/struct/values_at.rb 758142cc19356063e58a36175d97803387404657 Michael Fellinger m.fellinger@gmail.com http://github.com/manveru/ramaze/commit/acc76de754a70ae3c12c0c77330d9dfec3711234 acc76de754a70ae3c12c0c77330d9dfec3711234 2008-08-25T08:48:06-07:00 2008-08-16T08:05:14-07:00 Move extensions to ruby core into own module * Moved into Ramaze::CoreExtensions * Included into appropriate class on startup * Remove unused or broken snippets * Warn and don't extend on collision of method names * Move Kernel snippets that belong into Object into the correct place 4bb3a25acdfaaec5fa61b210fe985d7eadbd5896 Michael Fellinger m.fellinger@gmail.com