shattered_support 0.3.2 → 0.3.3

data/lib/shattered_support/core_ext/class/attribute_accessors.rb

@@ -0,0 +1,44 @@
+# Extends the class object with class and instance accessors for class attributes,
+# just like the native attr* accessors for instance attributes.
+class Class # :nodoc:
+  def cattr_reader(*syms)
+    syms.flatten.each do |sym|
+      class_eval(<<-EOS, __FILE__, __LINE__)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+
+        def self.#{sym}
+          @@#{sym}
+        end
+
+        def #{sym}
+          @@#{sym}
+        end
+      EOS
+    end
+  end
+
+  def cattr_writer(*syms)
+    syms.flatten.each do |sym|
+      class_eval(<<-EOS, __FILE__, __LINE__)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+
+        def self.#{sym}=(obj)
+          @@#{sym} = obj
+        end
+
+        def #{sym}=(obj)
+          @@#{sym} = obj
+        end
+      EOS
+    end
+  end
+
+  def cattr_accessor(*syms)
+    cattr_reader(*syms)
+    cattr_writer(*syms)
+  end
+end

data/lib/shattered_support/core_ext/class/inheritable_attributes.rb

@@ -0,0 +1,115 @@
+# Retain for backward compatibility.  Methods are now included in Class.
+module ClassInheritableAttributes # :nodoc:
+end
+
+# Allows attributes to be shared within an inheritance hierarchy, but where each descendant gets a copy of
+# their parents' attributes, instead of just a pointer to the same. This means that the child can add elements
+# to, for example, an array without those additions being shared with either their parent, siblings, or
+# children, which is unlike the regular class-level attributes that are shared across the entire hierarchy.
+class Class # :nodoc:
+  def class_inheritable_reader(*syms)
+    syms.each do |sym|
+      class_eval <<-EOS
+        def self.#{sym}
+          read_inheritable_attribute(:#{sym})
+        end
+
+        def #{sym}
+          self.class.#{sym}
+        end
+      EOS
+    end
+  end
+
+  def class_inheritable_writer(*syms)
+    syms.each do |sym|
+      class_eval <<-EOS
+        def self.#{sym}=(obj)
+          write_inheritable_attribute(:#{sym}, obj)
+        end
+
+        def #{sym}=(obj)
+          self.class.#{sym} = obj
+        end
+      EOS
+    end
+  end
+
+  def class_inheritable_array_writer(*syms)
+    syms.each do |sym|
+      class_eval <<-EOS
+        def self.#{sym}=(obj)
+          write_inheritable_array(:#{sym}, obj)
+        end
+
+        def #{sym}=(obj)
+          self.class.#{sym} = obj
+        end
+      EOS
+    end
+  end
+
+  def class_inheritable_hash_writer(*syms)
+    syms.each do |sym|
+      class_eval <<-EOS
+        def self.#{sym}=(obj)
+          write_inheritable_hash(:#{sym}, obj)
+        end
+
+        def #{sym}=(obj)
+          self.class.#{sym} = obj
+        end
+      EOS
+    end
+  end
+
+  def class_inheritable_accessor(*syms)
+    class_inheritable_reader(*syms)
+    class_inheritable_writer(*syms)
+  end
+
+  def class_inheritable_array(*syms)
+    class_inheritable_reader(*syms)
+    class_inheritable_array_writer(*syms)
+  end
+
+  def class_inheritable_hash(*syms)
+    class_inheritable_reader(*syms)
+    class_inheritable_hash_writer(*syms)
+  end
+
+  def inheritable_attributes
+    @inheritable_attributes ||= {}
+  end
+  
+  def write_inheritable_attribute(key, value)
+    inheritable_attributes[key] = value
+  end
+  
+  def write_inheritable_array(key, elements)
+    write_inheritable_attribute(key, []) if read_inheritable_attribute(key).nil?
+    write_inheritable_attribute(key, read_inheritable_attribute(key) + elements)
+  end
+
+  def write_inheritable_hash(key, hash)
+    write_inheritable_attribute(key, {}) if read_inheritable_attribute(key).nil?
+    write_inheritable_attribute(key, read_inheritable_attribute(key).merge(hash))
+  end
+
+  def read_inheritable_attribute(key)
+    inheritable_attributes[key]
+  end
+  
+  def reset_inheritable_attributes
+    inheritable_attributes.clear
+  end
+
+  private 
+    def inherited_with_inheritable_attributes(child)
+      inherited_without_inheritable_attributes(child) if respond_to?(:inherited_without_inheritable_attributes)
+      child.instance_variable_set('@inheritable_attributes', inheritable_attributes.dup)
+    end
+
+    alias inherited_without_inheritable_attributes inherited
+    alias inherited inherited_with_inheritable_attributes
+end

data/lib/shattered_support/core_ext/class/removal.rb

@@ -0,0 +1,24 @@
+class Class #:nodoc:
+  def remove_subclasses
+    Object.remove_subclasses_of(self)
+  end
+
+  def subclasses
+    Object.subclasses_of(self).map { |o| o.to_s }
+  end
+
+  def remove_class(*klasses)
+    klasses.flatten.each do |klass|
+      # Skip this class if there is nothing bound to this name
+      next unless defined?(klass.name)
+      
+      basename = klass.to_s.split("::").last
+      parent = klass.parent
+      
+      # Skip this class if it does not match the current one bound to this name
+      next unless parent.const_defined?(basename) && klass = parent.const_get(basename)
+      
+      parent.send :remove_const, basename unless parent == klass
+    end
+  end
+end

data/lib/shattered_support/core_ext/class.rb

@@ -0,0 +1,3 @@
+require File.dirname(__FILE__) + '/class/attribute_accessors'
+require File.dirname(__FILE__) + '/class/inheritable_attributes'
+require File.dirname(__FILE__) + '/class/removal'

data/lib/shattered_support/core_ext/dir/search.rb

@@ -0,0 +1,25 @@
+module ShatteredSupport #:nodoc:
+	module CoreExtensions #:nodoc:
+		module Dir #:nodoc:
+			module Search #:nodoc:
+        def self.append_features(base) #:nodoc:
+          super
+          base.extend(ClassMethods)
+        end
+
+				# Dir.each_in_path will recursively yield all non-hidden 
+				# directories from the given path.
+				module ClassMethods
+					def each_in_path(path, &block)
+						return unless ::File.directory? path
+						yield path
+						foreach(path) do |directory|
+							next if directory =~ /\..*/
+							each_in_path("#{path}/#{directory}", &block)
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/shattered_support/core_ext/dir.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/dir/search'
+
+class Dir
+	include ShatteredSupport::CoreExtensions::Dir::Search
+end

data/lib/shattered_support/core_ext/file/search.rb

@@ -0,0 +1,50 @@
+module ShatteredSupport #:nodoc:
+	module CoreExtensions #:nodoc:
+		module File #:nodoc:
+			module Search #:nodoc:
+        def self.append_features(base) #:nodoc:
+          super
+          base.extend(ClassMethods)
+        end
+
+				module ClassMethods
+					# File.each_in_path will recursively look for all files, 
+					# starting at the given path.
+					# It will yield with each result.
+					def each_in_path(path)
+						::Dir.each_in_path(path) do |directory|
+							::Dir.foreach( directory ) do |filename|
+								resource = directory + "/#{filename}"
+								yield(resource) if ::File.file? resource
+							end
+						end
+					end
+					
+					# This finds all files in paths (an array or string) 
+					# matching the given extensions:
+					#
+					# Usage:
+					#   -File.find_by_extensions(SHATTERED_ROOT,"ogg","mp3","wav")
+					#   -File.find_by_extension(["apps","media","plugins"], "rmaterial")
+					def find_by_extensions(paths, *extensions)
+						paths = [paths] if paths.is_a? ::String
+						# get rid of "." in ".ogg"
+						extensions.collect! { |ext| ext[0].chr == "." ? ext[1..-1] : ext }
+						reg_exp = /\.(#{extensions.join("|")})$/
+						files = []
+						paths.each do |path|
+							each_in_path(path) do |filename|
+								files << filename if filename =~ reg_exp
+							end
+						end
+						return files
+					end
+					# See File#find_by_extensions
+					def find_by_extension(paths, extension)
+						find_by_extensions(paths, extension)
+					end
+				end
+			end
+		end
+	end
+end

data/lib/shattered_support/core_ext/file.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/file/search'
+
+class File
+	include ShatteredSupport::CoreExtensions::File::Search
+end

data/lib/shattered_support/core_ext/numeric/time.rb

@@ -0,0 +1,72 @@
+module ShatteredSupport #:nodoc:
+  module CoreExtensions #:nodoc:
+    module Numeric #:nodoc:
+      # Enables the use of time calculations and declarations, like 45.minutes + 2.hours + 4.years.
+      #
+      # If you need precise date calculations that doesn't just treat months as 30 days, then have
+      # a look at Time#advance.
+      # 
+      # Some of these methods are approximations, Ruby's core 
+      # Date[http://stdlib.rubyonrails.org/libdoc/date/rdoc/index.html] and 
+      # Time[http://stdlib.rubyonrails.org/libdoc/time/rdoc/index.html] should be used for precision
+      # date and time arithmetic
+      module Time
+        def seconds
+          self
+        end
+        alias :second :seconds
+
+        def minutes
+          self * 60
+        end
+        alias :minute :minutes  
+        
+        def hours
+          self * 60.minutes
+        end
+        alias :hour :hours
+        
+        def days
+          self * 24.hours
+        end
+        alias :day :days
+
+        def weeks
+          self * 7.days
+        end
+        alias :week :weeks
+        
+        def fortnights
+          self * 2.weeks
+        end
+        alias :fortnight :fortnights
+        
+        def months
+          self * 30.days
+        end
+        alias :month :months
+
+        def years
+          (self * 365.25.days).to_i
+        end
+        alias :year :years
+
+        # Reads best without arguments:  10.minutes.ago
+        def ago(time = ::Time.now)
+          time - self
+        end
+
+        # Reads best with argument:  10.minutes.until(time)
+        alias :until :ago
+
+        # Reads best with argument:  10.minutes.since(time)
+        def since(time = ::Time.now)
+          time + self
+        end
+
+        # Reads best without arguments:  10.minutes.from_now
+        alias :from_now :since
+      end
+    end
+  end
+end

data/lib/shattered_support/core_ext/numeric.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/numeric/time'
+
+class Numeric #:nodoc:
+  include ShatteredSupport::CoreExtensions::Numeric::Time 
+end

data/lib/shattered_support/core_ext/string/access.rb

@@ -0,0 +1,58 @@
+module ShatteredSupport #:nodoc:
+  module CoreExtensions #:nodoc:
+    module String #:nodoc:
+      # Makes it easier to access parts of a string, such as specific characters and substrings.
+      module Access
+        # Returns the character at the +position+ treating the string as an array (where 0 is the first character).
+        #
+        # Examples: 
+        #   "hello".at(0)  # => "h"
+        #   "hello".at(4)  # => "o"
+        #   "hello".at(10) # => nil
+        def at(position)
+          self[position, 1]
+        end
+        
+        # Returns the remaining of the string from the +position+ treating the string as an array (where 0 is the first character).
+        #
+        # Examples: 
+        #   "hello".from(0)  # => "hello"
+        #   "hello".from(2)  # => "llo"
+        #   "hello".from(10) # => nil
+        def from(position)
+          self[position..-1]
+        end
+        
+        # Returns the beginning of the string up to the +position+ treating the string as an array (where 0 is the first character).
+        #
+        # Examples: 
+        #   "hello".to(0)  # => "h"
+        #   "hello".to(2)  # => "hel"
+        #   "hello".to(10) # => "hello"
+        def to(position)
+          self[0..position]
+        end
+
+        # Returns the first character of the string or the first +limit+ characters.
+        #
+        # Examples: 
+        #   "hello".first     # => "h"
+        #   "hello".first(2)  # => "he"
+        #   "hello".first(10) # => "hello"
+        def first(limit = 1)
+          self[0..(limit - 1)]
+        end
+        
+        # Returns the last character of the string or the last +limit+ characters.
+        #
+        # Examples: 
+        #   "hello".last     # => "o"
+        #   "hello".last(2)  # => "lo"
+        #   "hello".last(10) # => "hello"
+        def last(limit = 1)
+          self[(-limit)..-1] || self
+        end
+      end
+    end
+  end
+end

data/lib/shattered_support/core_ext/string/conversions.rb

@@ -0,0 +1,19 @@
+require 'parsedate'
+
+module ShatteredSupport #:nodoc:
+  module CoreExtensions #:nodoc:
+    module String #:nodoc:
+      # Converting strings to other objects
+      module Conversions
+        # Form can be either :utc (default) or :local.
+        def to_time(form = :utc)
+          ::Time.send(form, *ParseDate.parsedate(self))
+        end
+
+        def to_date
+          ::Date.new(*ParseDate.parsedate(self)[0..2])
+        end
+      end
+    end
+  end
+end

data/lib/shattered_support/core_ext/string/inflections.rb

@@ -0,0 +1,64 @@
+require File.dirname(__FILE__) + '/../../inflector' unless defined? Inflector
+module ShatteredSupport #:nodoc:
+  module CoreExtensions #:nodoc:
+    module String #:nodoc:
+      # Makes it possible to do "posts".singularize that returns "post" and "MegaCoolClass".underscore that returns "mega_cool_class".
+      module Inflections
+        def pluralize
+          Inflector.pluralize(self)
+        end
+
+        def singularize
+          Inflector.singularize(self)
+        end
+
+        def camelize(first_letter = :upper)
+          case first_letter
+            when :upper then Inflector.camelize(self, true)
+            when :lower then Inflector.camelize(self, false)
+          end
+        end
+        alias_method :camelcase, :camelize
+
+        def titleize
+          Inflector.titleize(self)
+        end
+        alias_method :titlecase, :titleize
+
+        def underscore
+          Inflector.underscore(self)
+        end
+
+        def dasherize
+          Inflector.dasherize(self)
+        end
+
+        def demodulize
+          Inflector.demodulize(self)
+        end
+
+        def tableize
+          Inflector.tableize(self)
+        end
+
+        def classify
+          Inflector.classify(self)
+        end
+        
+        # Capitalizes the first word and turns underscores into spaces and strips _id, so "employee_salary" becomes "Employee salary" 
+        # and "author_id" becomes "Author".
+        def humanize
+          Inflector.humanize(self)
+        end
+
+        def foreign_key(separate_class_name_and_id_with_underscore = true)
+          Inflector.foreign_key(self, separate_class_name_and_id_with_underscore)
+        end
+
+        def constantize
+          Inflector.constantize(self)
+        end
+      end
+    end
+  end
+end

data/lib/shattered_support/core_ext/string/iterators.rb

@@ -0,0 +1,17 @@
+require 'strscan'
+
+module ShatteredSupport #:nodoc:
+  module CoreExtensions #:nodoc:
+    module String #:nodoc:
+      # Custom string iterators
+      module Iterators
+        # Yields a single-character string for each character in the string.
+        # When $KCODE = 'UTF8', multi-byte characters are yielded appropriately.
+        def each_char
+          scanner, char = StringScanner.new(self), /./mu
+          loop { yield(scanner.scan(char) || break) }
+        end
+      end
+    end
+  end
+end

data/lib/shattered_support/core_ext/string/starts_ends_with.rb

@@ -0,0 +1,20 @@
+module ShatteredSupport #:nodoc:
+  module CoreExtensions #:nodoc:
+    module String #:nodoc:
+      # Additional string tests.
+      module StartsEndsWith
+        # Does the string start with the specified +prefix+?
+        def starts_with?(prefix)
+          prefix = prefix.to_s
+          self[0, prefix.length] == prefix
+        end
+
+        # Does the string end with the specified +suffix+?
+        def ends_with?(suffix)
+          suffix = suffix.to_s
+          self[-suffix.length, suffix.length] == suffix      
+        end
+      end
+    end
+  end
+end

data/lib/shattered_support/core_ext/string.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/string/inflections'
+require File.dirname(__FILE__) + '/string/conversions'
+require File.dirname(__FILE__) + '/string/access'
+require File.dirname(__FILE__) + '/string/starts_ends_with'
+require File.dirname(__FILE__) + '/string/iterators'
+
+class String #:nodoc:
+  include ShatteredSupport::CoreExtensions::String::Access
+  include ShatteredSupport::CoreExtensions::String::Conversions
+  include ShatteredSupport::CoreExtensions::String::Inflections
+  include ShatteredSupport::CoreExtensions::String::StartsEndsWith
+  include ShatteredSupport::CoreExtensions::String::Iterators
+end

data/lib/shattered_support/core_ext.rb

@@ -0,0 +1 @@
+Dir[File.dirname(__FILE__) + "/core_ext/*.rb"].each { |file| require(file) }

data/lib/shattered_support/inflections.rb

@@ -0,0 +1,53 @@
+Inflector.inflections do |inflect|
+  inflect.plural(/$/, 's')
+  inflect.plural(/s$/i, 's')
+  inflect.plural(/(ax|test)is$/i, '\1es')
+  inflect.plural(/(octop|vir)us$/i, '\1i')
+  inflect.plural(/(alias|status)$/i, '\1es')
+  inflect.plural(/(bu)s$/i, '\1ses')
+  inflect.plural(/(buffal|tomat)o$/i, '\1oes')
+  inflect.plural(/([ti])um$/i, '\1a')
+  inflect.plural(/sis$/i, 'ses')
+  inflect.plural(/(?:([^f])fe|([lr])f)$/i, '\1\2ves')
+  inflect.plural(/(hive)$/i, '\1s')
+  inflect.plural(/([^aeiouy]|qu)y$/i, '\1ies')
+  inflect.plural(/([^aeiouy]|qu)ies$/i, '\1y')
+  inflect.plural(/(x|ch|ss|sh)$/i, '\1es')
+  inflect.plural(/(matr|vert|ind)ix|ex$/i, '\1ices')
+  inflect.plural(/([m|l])ouse$/i, '\1ice')
+  inflect.plural(/^(ox)$/i, '\1en')
+  inflect.plural(/(quiz)$/i, '\1zes')
+
+  inflect.singular(/s$/i, '')
+  inflect.singular(/(n)ews$/i, '\1ews')
+  inflect.singular(/([ti])a$/i, '\1um')
+  inflect.singular(/((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)ses$/i, '\1\2sis')
+  inflect.singular(/(^analy)ses$/i, '\1sis')
+  inflect.singular(/([^f])ves$/i, '\1fe')
+  inflect.singular(/(hive)s$/i, '\1')
+  inflect.singular(/(tive)s$/i, '\1')
+  inflect.singular(/([lr])ves$/i, '\1f')
+  inflect.singular(/([^aeiouy]|qu)ies$/i, '\1y')
+  inflect.singular(/(s)eries$/i, '\1eries')
+  inflect.singular(/(m)ovies$/i, '\1ovie')
+  inflect.singular(/(x|ch|ss|sh)es$/i, '\1')
+  inflect.singular(/([m|l])ice$/i, '\1ouse')
+  inflect.singular(/(bus)es$/i, '\1')
+  inflect.singular(/(o)es$/i, '\1')
+  inflect.singular(/(shoe)s$/i, '\1')
+  inflect.singular(/(cris|ax|test)es$/i, '\1is')
+  inflect.singular(/([octop|vir])i$/i, '\1us')
+  inflect.singular(/(alias|status)es$/i, '\1')
+  inflect.singular(/^(ox)en/i, '\1')
+  inflect.singular(/(vert|ind)ices$/i, '\1ex')
+  inflect.singular(/(matr)ices$/i, '\1ix')
+  inflect.singular(/(quiz)zes$/i, '\1')
+
+  inflect.irregular('person', 'people')
+  inflect.irregular('man', 'men')
+  inflect.irregular('child', 'children')
+  inflect.irregular('sex', 'sexes')
+  inflect.irregular('move', 'moves')
+
+  inflect.uncountable(%w(equipment information rice money species series fish sheep))
+end