activesupport-refinements 0.0.1

data/lib/active_support/refinements/core_ext/array/prepend_and_append.rb

@@ -0,0 +1,9 @@
+module ArrayExt; end; module ArrayExt::PrependAndAppend
+refine Array do
+  # The human way of thinking about adding stuff to the end of a list is with append
+#  alias_method :append,  :<<
+
+  # The human way of thinking about adding stuff to the beginning of a list is with prepend
+#  alias_method :prepend, :unshift
+end
+end

data/lib/active_support/refinements/core_ext/array/uniq_by.rb

@@ -0,0 +1,21 @@
+module ArrayExt; end; module ArrayExt::UniqBy
+refine Array do
+  # *DEPRECATED*: Use +Array#uniq+ instead.
+  #
+  # Returns a unique array based on the criteria in the block.
+  #
+  #   [1, 2, 3, 4].uniq_by { |i| i.odd? } # => [1, 2]
+  def uniq_by(&block)
+    ActiveSupport::Deprecation.warn 'uniq_by is deprecated. Use Array#uniq instead', caller
+    uniq(&block)
+  end
+
+  # *DEPRECATED*: Use +Array#uniq!+ instead.
+  #
+  # Same as +uniq_by+, but modifies +self+.
+  def uniq_by!(&block)
+    ActiveSupport::Deprecation.warn 'uniq_by! is deprecated. Use Array#uniq! instead', caller
+    uniq!(&block)
+  end
+end
+end

data/lib/active_support/refinements/core_ext/array/wrap.rb

@@ -0,0 +1,48 @@
+module ArrayExt; end; module ArrayExt::Wrap
+refine Array do
+  # Wraps its argument in an array unless it is already an array (or array-like).
+  #
+  # Specifically:
+  #
+  # * If the argument is +nil+ an empty list is returned.
+  # * Otherwise, if the argument responds to +to_ary+ it is invoked, and its result returned.
+  # * Otherwise, returns an array with the argument as its single element.
+  #
+  #     Array.wrap(nil)       # => []
+  #     Array.wrap([1, 2, 3]) # => [1, 2, 3]
+  #     Array.wrap(0)         # => [0]
+  #
+  # This method is similar in purpose to <tt>Kernel#Array</tt>, but there are some differences:
+  #
+  # * If the argument responds to +to_ary+ the method is invoked. <tt>Kernel#Array</tt>
+  #   moves on to try +to_a+ if the returned value is +nil+, but <tt>Array.wrap</tt> returns
+  #   such a +nil+ right away.
+  # * If the returned value from +to_ary+ is neither +nil+ nor an +Array+ object, <tt>Kernel#Array</tt>
+  #   raises an exception, while <tt>Array.wrap</tt> does not, it just returns the value.
+  # * It does not call +to_a+ on the argument, though special-cases +nil+ to return an empty array.
+  #
+  # The last point is particularly worth comparing for some enumerables:
+  #
+  #   Array(foo: :bar)      # => [[:foo, :bar]]
+  #   Array.wrap(foo: :bar) # => [{foo: :bar}]
+  #
+  # There's also a related idiom that uses the splat operator:
+  #
+  #   [*object]
+  #
+  # which for +nil+ returns <tt>[nil]</tt> (Ruby 1.8.7) or <tt>[]</tt> (Ruby
+  # 1.9), and calls to <tt>Array(object)</tt> otherwise.
+  #
+  # Thus, in this case the behavior may be different for +nil+, and the differences with
+  # <tt>Kernel#Array</tt> explained above apply to the rest of <tt>object</tt>s.
+  def self.wrap(object)
+    if object.nil?
+      []
+    elsif object.respond_to?(:to_ary)
+      object.to_ary || [object]
+    else
+      [object]
+    end
+  end
+end
+end

data/lib/active_support/refinements/core_ext/benchmark.rb

@@ -0,0 +1,7 @@
+require 'benchmark'
+
+class << Benchmark
+  def ms
+    1000 * realtime { yield }
+  end
+end

data/lib/active_support/refinements/core_ext/big_decimal.rb

@@ -0,0 +1 @@
+require 'active_support/refinements/core_ext/big_decimal/conversions'

data/lib/active_support/refinements/core_ext/big_decimal/conversions.rb

@@ -0,0 +1,32 @@
+module BigDecimalExt; end; module BigDecimalExt::Conversions
+require 'bigdecimal'
+require 'yaml'
+
+refine BigDecimal do
+  YAML_MAPPING = { 'Infinity' => '.Inf', '-Infinity' => '-.Inf', 'NaN' => '.NaN' }
+
+  def encode_with(coder)
+    string = to_s
+    coder.represent_scalar(nil, YAML_MAPPING[string] || string)
+  end
+
+  # Backport this method if it doesn't exist
+  unless method_defined?(:to_d)
+    def to_d
+      self
+    end
+  end
+
+  DEFAULT_STRING_FORMAT = 'F'
+  def to_formatted_s(*args)
+    if args[0].is_a?(Symbol)
+      super
+    else
+      format = args[0] || DEFAULT_STRING_FORMAT
+      _original_to_s(format)
+    end
+  end
+#  alias_method :_original_to_s, :to_s
+#  alias_method :to_s, :to_formatted_s
+end
+end

data/lib/active_support/refinements/core_ext/class.rb

@@ -0,0 +1,4 @@
+require 'active_support/refinements/core_ext/class/attribute'
+require 'active_support/refinements/core_ext/class/attribute_accessors'
+require 'active_support/refinements/core_ext/class/delegating_attributes'
+require 'active_support/refinements/core_ext/class/subclasses'

data/lib/active_support/refinements/core_ext/class/attribute.rb

@@ -0,0 +1,119 @@
+module ClassExt; end; module ClassExt::Attribute
+require 'active_support/refinements/core_ext/kernel/singleton_class'
+require 'active_support/refinements/core_ext/module/remove_method'
+require 'active_support/refinements/core_ext/array/extract_options'
+
+refine Class do
+  # Declare a class-level attribute whose value is inheritable by subclasses.
+  # Subclasses can change their own value and it will not impact parent class.
+  #
+  #   class Base
+  #     class_attribute :setting
+  #   end
+  #
+  #   class Subclass < Base
+  #   end
+  #
+  #   Base.setting = true
+  #   Subclass.setting            # => true
+  #   Subclass.setting = false
+  #   Subclass.setting            # => false
+  #   Base.setting                # => true
+  #
+  # In the above case as long as Subclass does not assign a value to setting
+  # by performing <tt>Subclass.setting = _something_ </tt>, <tt>Subclass.setting</tt>
+  # would read value assigned to parent class. Once Subclass assigns a value then
+  # the value assigned by Subclass would be returned.
+  #
+  # This matches normal Ruby method inheritance: think of writing an attribute
+  # on a subclass as overriding the reader method. However, you need to be aware
+  # when using +class_attribute+ with mutable structures as +Array+ or +Hash+.
+  # In such cases, you don't want to do changes in places but use setters:
+  #
+  #   Base.setting = []
+  #   Base.setting                # => []
+  #   Subclass.setting            # => []
+  #
+  #   # Appending in child changes both parent and child because it is the same object:
+  #   Subclass.setting << :foo
+  #   Base.setting               # => [:foo]
+  #   Subclass.setting           # => [:foo]
+  #
+  #   # Use setters to not propagate changes:
+  #   Base.setting = []
+  #   Subclass.setting += [:foo]
+  #   Base.setting               # => []
+  #   Subclass.setting           # => [:foo]
+  #
+  # For convenience, a query method is defined as well:
+  #
+  #   Subclass.setting?       # => false
+  #
+  # Instances may overwrite the class value in the same way:
+  #
+  #   Base.setting = true
+  #   object = Base.new
+  #   object.setting          # => true
+  #   object.setting = false
+  #   object.setting          # => false
+  #   Base.setting            # => true
+  #
+  # To opt out of the instance reader method, pass <tt>instance_reader: false</tt>.
+  #
+  #   object.setting          # => NoMethodError
+  #   object.setting?         # => NoMethodError
+  #
+  # To opt out of the instance writer method, pass <tt>instance_writer: false</tt>.
+  #
+  #   object.setting = false  # => NoMethodError
+  #
+  # To opt out of both instance methods, pass <tt>instance_accessor: false</tt>.
+  def class_attribute(*attrs)
+    options = attrs.extract_options!
+    instance_reader = options.fetch(:instance_accessor, true) && options.fetch(:instance_reader, true)
+    instance_writer = options.fetch(:instance_accessor, true) && options.fetch(:instance_writer, true)
+
+    attrs.each do |name|
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def self.#{name}() nil end
+        def self.#{name}?() !!#{name} end
+
+        def self.#{name}=(val)
+          singleton_class.class_eval do
+            remove_possible_method(:#{name})
+            define_method(:#{name}) { val }
+          end
+
+          if singleton_class?
+            class_eval do
+              remove_possible_method(:#{name})
+              def #{name}
+                defined?(@#{name}) ? @#{name} : singleton_class.#{name}
+              end
+            end
+          end
+          val
+        end
+
+        if instance_reader
+          remove_possible_method :#{name}
+          def #{name}
+            defined?(@#{name}) ? @#{name} : self.class.#{name}
+          end
+
+          def #{name}?
+            !!#{name}
+          end
+        end
+      RUBY
+
+      attr_writer name if instance_writer
+    end
+  end
+
+  private
+    def singleton_class?
+      ancestors.first != self
+    end
+end
+end

data/lib/active_support/refinements/core_ext/class/attribute_accessors.rb

@@ -0,0 +1,172 @@
+module ClassExt; end; module ClassExt::AttributeAccessors
+require 'active_support/refinements/core_ext/array/extract_options'
+
+# Extends the class object with class and instance accessors for class attributes,
+# just like the native attr* accessors for instance attributes.
+refine Class do
+  # Defines a class attribute if it's not defined and creates a reader method that
+  # returns the attribute value.
+  #
+  #   class Person
+  #     cattr_reader :hair_colors
+  #   end
+  #
+  #   Person.class_variable_set("@@hair_colors", [:brown, :black])
+  #   Person.hair_colors     # => [:brown, :black]
+  #   Person.new.hair_colors # => [:brown, :black]
+  #
+  # The attribute name must be a valid method name in Ruby.
+  #
+  #   class Person
+  #     cattr_reader :"1_Badname "
+  #   end
+  #   # => NameError: invalid attribute name
+  #
+  # If you want to opt out the instance reader method, you can pass <tt>instance_reader: false</tt>
+  # or <tt>instance_accessor: false</tt>.
+  #
+  #   class Person
+  #     cattr_reader :hair_colors, instance_reader: false
+  #   end
+  #
+  #   Person.new.hair_colors # => NoMethodError
+  def cattr_reader(*syms)
+    options = syms.extract_options!
+    syms.each do |sym|
+      raise NameError.new('invalid attribute name') unless sym =~ /^[_A-Za-z]\w*$/
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+
+        def self.#{sym}
+          @@#{sym}
+        end
+      EOS
+
+      unless options[:instance_reader] == false || options[:instance_accessor] == false
+        class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+          def #{sym}
+            @@#{sym}
+          end
+        EOS
+      end
+    end
+  end
+
+  # Defines a class attribute if it's not defined and creates a writer method to allow
+  # assignment to the attribute.
+  #
+  #   class Person
+  #     cattr_writer :hair_colors
+  #   end
+  #
+  #   Person.hair_colors = [:brown, :black]
+  #   Person.class_variable_get("@@hair_colors") # => [:brown, :black]
+  #   Person.new.hair_colors = [:blonde, :red]
+  #   Person.class_variable_get("@@hair_colors") # => [:blonde, :red]
+  #
+  # The attribute name must be a valid method name in Ruby.
+  #
+  #   class Person
+  #     cattr_writer :"1_Badname "
+  #   end
+  #   # => NameError: invalid attribute name
+  #
+  # If you want to opt out the instance writer method, pass <tt>instance_writer: false</tt>
+  # or <tt>instance_accessor: false</tt>.
+  #
+  #   class Person
+  #     cattr_writer :hair_colors, instance_writer: false
+  #   end
+  #
+  #   Person.new.hair_colors = [:blonde, :red] # => NoMethodError
+  #
+  # Also, you can pass a block to set up the attribute with a default value.
+  #
+  #   class Person
+  #     cattr_writer :hair_colors do
+  #       [:brown, :black, :blonde, :red]
+  #     end
+  #   end
+  #
+  #   Person.class_variable_get("@@hair_colors") # => [:brown, :black, :blonde, :red]
+  def cattr_writer(*syms)
+    options = syms.extract_options!
+    syms.each do |sym|
+      raise NameError.new('invalid attribute name') unless sym =~ /^[_A-Za-z]\w*$/
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+
+        def self.#{sym}=(obj)
+          @@#{sym} = obj
+        end
+      EOS
+
+      unless options[:instance_writer] == false || options[:instance_accessor] == false
+        class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+          def #{sym}=(obj)
+            @@#{sym} = obj
+          end
+        EOS
+      end
+      send("#{sym}=", yield) if block_given?
+    end
+  end
+
+  # Defines both class and instance accessors for class attributes.
+  #
+  #   class Person
+  #     cattr_accessor :hair_colors
+  #   end
+  #
+  #   Person.hair_colors = [:brown, :black, :blonde, :red]
+  #   Person.hair_colors     # => [:brown, :black, :blonde, :red]
+  #   Person.new.hair_colors # => [:brown, :black, :blonde, :red]
+  #
+  # If a subclass changes the value then that would also change the value for
+  # parent class. Similarly if parent class changes the value then that would
+  # change the value of subclasses too.
+  #
+  #   class Male < Person
+  #   end
+  #
+  #   Male.hair_colors << :blue
+  #   Person.hair_colors # => [:brown, :black, :blonde, :red, :blue]
+  #
+  # To opt out of the instance writer method, pass <tt>instance_writer: false</tt>.
+  # To opt out of the instance reader method, pass <tt>instance_reader: false</tt>.
+  #
+  #   class Person
+  #     cattr_accessor :hair_colors, instance_writer: false, instance_reader: false
+  #   end
+  #
+  #   Person.new.hair_colors = [:brown]  # => NoMethodError
+  #   Person.new.hair_colors             # => NoMethodError
+  #
+  # Or pass <tt>instance_accessor: false</tt>, to opt out both instance methods.
+  #
+  #   class Person
+  #     cattr_accessor :hair_colors, instance_accessor: false
+  #   end
+  #
+  #   Person.new.hair_colors = [:brown]  # => NoMethodError
+  #   Person.new.hair_colors             # => NoMethodError
+  #
+  # Also you can pass a block to set up the attribute with a default value.
+  #
+  #   class Person
+  #     cattr_accessor :hair_colors do
+  #       [:brown, :black, :blonde, :red]
+  #     end
+  #   end
+  #
+  #   Person.class_variable_get("@@hair_colors") #=> [:brown, :black, :blonde, :red]
+  def cattr_accessor(*syms, &blk)
+    cattr_reader(*syms)
+    cattr_writer(*syms, &blk)
+  end
+end
+end

data/lib/active_support/refinements/core_ext/class/delegating_attributes.rb

@@ -0,0 +1,42 @@
+module ClassExt; end; module ClassExt::DelegatingAttributes
+require 'active_support/refinements/core_ext/kernel/singleton_class'
+require 'active_support/refinements/core_ext/module/remove_method'
+
+refine Class do
+  def superclass_delegating_accessor(name, options = {})
+    # Create private _name and _name= methods that can still be used if the public
+    # methods are overridden. This allows
+    _superclass_delegating_accessor("_#{name}")
+
+    # Generate the public methods name, name=, and name?
+    # These methods dispatch to the private _name, and _name= methods, making them
+    # overridable
+    singleton_class.send(:define_method, name) { send("_#{name}") }
+    singleton_class.send(:define_method, "#{name}?") { !!send("_#{name}") }
+    singleton_class.send(:define_method, "#{name}=") { |value| send("_#{name}=", value) }
+
+    # If an instance_reader is needed, generate methods for name and name= on the
+    # class itself, so instances will be able to see them
+    define_method(name) { send("_#{name}") } if options[:instance_reader] != false
+    define_method("#{name}?") { !!send("#{name}") } if options[:instance_reader] != false
+  end
+
+  private
+    # Take the object being set and store it in a method. This gives us automatic
+    # inheritance behavior, without having to store the object in an instance
+    # variable and look up the superclass chain manually.
+    def _stash_object_in_method(object, method, instance_reader = true)
+      singleton_class.remove_possible_method(method)
+      singleton_class.send(:define_method, method) { object }
+      remove_possible_method(method)
+      define_method(method) { object } if instance_reader
+    end
+
+    def _superclass_delegating_accessor(name, options = {})
+      singleton_class.send(:define_method, "#{name}=") do |value|
+        _stash_object_in_method(value, name, options[:instance_reader] != false)
+      end
+      send("#{name}=", nil)
+    end
+end
+end