facets 2.9.3 → 3.0.0

data/lib/core/facets/nilclass.rb

@@ -1,5 +1,2 @@
-require 'facets/kernel/require_relative'
-
 require_relative 'nilclass/ergo.rb'
-require_relative 'nilclass/to_f.rb'
 

data/lib/core/facets/numeric.rb

@@ -1,12 +1,8 @@
-require 'facets/kernel/require_relative'
-
 require_relative 'numeric/approx.rb'
 require_relative 'numeric/distance.rb'
 require_relative 'numeric/length.rb'
 require_relative 'numeric/negative.rb'
 require_relative 'numeric/positive.rb'
-require_relative 'numeric/round.rb'
-require_relative 'numeric/round_at.rb'
 require_relative 'numeric/round_to.rb'
 require_relative 'numeric/spacing.rb'
 

data/lib/core/facets/numeric/approx.rb

@@ -17,7 +17,8 @@ class Numeric
   # Determines if another number is approximately equal
   # within a given +epsilon+.
   #
-  # This is the same a {#approx?} but has a different defualt.
+  # This is the same a {#approx?} but has a different default.
+  # In this case it is 1/100th.
   #
   # @author Gavin Sinclair
   def close?(number, epsilon=0.01)
@@ -26,7 +27,7 @@ class Numeric
     a, b = self.to_f, number.to_f
     if a.zero? or b.zero?
       ## There's no scale, so we can only go on difference.
-      (a - b).abs < @epsilon
+      (a - b).abs < epsilon
     else
       ## We go by ratio. The ratio of two equal numbers is one, so the ratio
       ## of two practically-equal floats will be very nearly one.

data/lib/core/facets/numeric/range.rb

@@ -0,0 +1,12 @@
+class Numeric
+
+  # Create a range from the number plus-or-minus a given value.
+  #
+  # Return [Range]
+  def range(value)
+    Range.new(self - value, self + value)
+  end
+
+  alias :plus_or_minus :range
+
+end

data/lib/core/facets/numeric/round_to.rb

@@ -1 +1,32 @@
-require 'facets/numeric/round'
+class Numeric
+
+  # Conceptually, rounding is expected to apply to floating point numbers.
+  # However it can actually be applied to pretty much any Numeric object.
+  # For example, one could round an Integer to the nearest kilo.
+  #
+  # See Float#round_to.
+
+  def round_to(*args)
+    to_f.round_to(*args)
+  end
+
+end
+
+class Float
+
+  # Rounds to the nearest _n_th degree.
+  #
+  #   4.555.round_to(1)     #=> 5.0
+  #   4.555.round_to(0.1)   #=> 4.6
+  #   4.555.round_to(0.01)  #=> 4.56
+  #   4.555.round_to(0)     #=> 4.555
+  #
+  # CREDIT: Trans
+
+  def round_to( n ) #n=1
+    return self if n == 0
+    (self * (1.0 / n)).round.to_f / (1.0 / n)
+  end
+
+end
+

data/lib/core/facets/object.rb

@@ -1,8 +1,7 @@
-require 'facets/kernel/require_relative'
-
+# TODO: Is there a good reason for these to be here instead of in Kernel module?
 require_relative 'object/clone.rb'
 require_relative 'object/dup.rb'
+require_relative 'object/itself.rb'
 require_relative 'object/object_state.rb'
-require_relative 'object/replace.rb'
 require_relative 'object/try_dup.rb'
 

data/lib/core/facets/object/itself.rb

@@ -0,0 +1,16 @@
+class Object
+
+  # An identity method that provides access to an object's 'self'.
+  #
+  # Example
+  #
+  #   [1,2,3,4,5,1,2,2,3].group_by(&:itself)
+  #   #=> {1=>[1, 1], 2=>[2, 2, 2], 3=>[3, 3], 4=>[4], 5=>[5]}
+  #
+  # CREDIT: Michael Kohl
+
+  def itself
+    self
+  end
+
+end

data/lib/core/facets/objectspace.rb

@@ -1,6 +1,3 @@
-require 'facets/kernel/require_relative'
-
 require_relative 'objectspace/classes.rb'
 require_relative 'objectspace/op_fetch.rb'
-require_relative 'objectspace/reflect.rb'
 

data/lib/core/facets/proc.rb

@@ -1,9 +1,6 @@
-require 'facets/kernel/require_relative'
-
 require_relative 'proc/bind.rb'
 require_relative 'proc/bind_to.rb'
 require_relative 'proc/compose.rb'
-require_relative 'proc/curry.rb'
 require_relative 'proc/partial.rb'
 require_relative 'proc/to_method.rb'
 require_relative 'proc/update.rb'

data/lib/core/facets/proc/bind_to.rb

@@ -1,8 +1,8 @@
 class Proc
 
-  # Bind a procedure to an object. This works
-  # wrapping instance_eval on the Proc object
-  # and then wrapping this in a new Proc.
+  # Bind a procedure to an object. This works by
+  # wrapping instance_eval on the Proc object and
+  # then wrapping this in a new Proc.
   #
   #    a = [1,2,3]
   #    p1 = Proc.new{ join(' ') }

data/lib/core/facets/proc/wrap.rb

@@ -0,0 +1,17 @@
+class Proc
+
+  # Wrap the argument in a proc. Simply returns the argument if it is
+  # already a Proc object.
+  #
+  # TODO: Would this make more sense as `Kernel#Proc()` method,
+  #        akin to `Integer()` and the like?
+  #
+  # Returns [Proc]
+  #
+  # Credit: Sean Mackesey
+
+  def self.wrap(arg)
+    Proc === arg ? arg : Proc.new{ arg }
+  end
+
+end

data/lib/core/facets/process.rb

@@ -1,4 +1,2 @@
-require 'facets/kernel/require_relative'
-
 require_relative 'process/daemon.rb'
 

data/lib/core/facets/range.rb

@@ -1,9 +1,9 @@
-require 'facets/kernel/require_relative'
-
 require_relative 'range/combine.rb'
 require_relative 'range/overlap.rb'
-#require_relative 'range/quantile.rb'    # uncommon
-require_relative 'range/to_r.rb'
+#require_relative 'range/quantile.rb'     # uncommon
+#require_relative 'range/op_add.rb'       # too new
+#require_relative 'range/op_sub.rb'       # too new
+require_relative 'range/to_rng.rb'
 require_relative 'range/umbrella.rb'
 require_relative 'range/within.rb'
 

data/lib/core/facets/range/op_add.rb

@@ -0,0 +1,15 @@
+require 'facets/array/arrange'
+
+class Range
+
+  # Add two ranges to create a range array.
+  #
+  # Returns [Array]
+  #
+  # CREDIT: monocle
+
+  def +(value)
+		[self, value].arrange
+	end
+
+end

data/lib/core/facets/range/op_sub.rb

@@ -0,0 +1,45 @@
+class Range
+
+  # Subtract one range from another producing a range array.
+  #
+  # Examples
+  #
+  #     (1..10) - (4..6)  => [1..3, 7..10]
+  #
+  #     (1..10) - (9..12) => [1..8]
+  #
+  # Returns [Array]
+  #
+  # CREDIT: monocle
+
+	def -(value)
+		if value.class == first.class
+			minus_obj(value)
+		else
+			[minus_obj(value.first)[0], minus_obj(value.last)[1]].compact
+		end
+	end
+
+	private
+
+    # TODO: Better name? Maybe make public?
+	  def minus_obj(value)
+		  f = case value <=> first.succ
+		      when -1 then nil
+       		when  0 then first
+	       	else
+       		  #value < last.succ ? first...value : self
+       		  value < last.succ ? first..(value.pred) : self
+          end
+
+		  s = case last <=> value.succ
+          when -1 then nil
+          when  0 then last
+          else
+            value.succ > first ? (value.succ)..last : self
+          end
+
+		  [f, s]
+	  end
+
+end

data/lib/core/facets/range/{to_r.rb → to_rng.rb}

@@ -5,7 +5,7 @@ class Range
   #
   # CREDIT: Trans
 
-  def to_r
+  def to_rng
     self
   end
 

data/lib/core/facets/regexp.rb

@@ -1,5 +1,3 @@
-require 'facets/kernel/require_relative'
-
 require_relative 'regexp/arity.rb'
 require_relative 'regexp/multiline.rb'
 require_relative 'regexp/op_add.rb'

data/lib/core/facets/regexp/to_proc.rb

@@ -0,0 +1,13 @@
+class Regexp
+
+  # Useful to pass a Regexp as a block that will match elements
+  #
+  # %w[ joe_the_dog mary_the_cat ].index &/cat/  #=> 1
+  #
+  # Returns [Proc] which passes it's argument to Regexp#match method.
+
+  def to_proc
+    proc { |x| match(x) }
+  end
+
+end

data/lib/core/facets/string.rb

@@ -1,9 +1,6 @@
-require 'facets/kernel/require_relative'
-
 require_relative 'string/acronym.rb'
 require_relative 'string/align.rb'
 require_relative 'string/bracket.rb'
-require_relative 'string/bytes.rb'
 require_relative 'string/camelcase.rb'
 require_relative 'string/capitalized.rb'
 require_relative 'string/characters.rb'
@@ -13,10 +10,9 @@ require_relative 'string/cmp.rb'
 require_relative 'string/compress_lines.rb'
 #require_relative 'string/crypt.rb'          # uncommon
 require_relative 'string/divide.rb'
-require_relative 'string/each_char.rb'
 require_relative 'string/each_word.rb'
 require_relative 'string/edit_distance.rb'
-require_relative 'string/end_with.rb'
+require_relative 'string/ends_with.rb'
 require_relative 'string/exclude.rb'
 require_relative 'string/expand_tab.rb'
 require_relative 'string/file.rb'
@@ -25,8 +21,8 @@ require_relative 'string/indent.rb'
 require_relative 'string/index_all.rb'
 require_relative 'string/interpolate.rb'
 require_relative 'string/lchomp.rb'
-require_relative 'string/lines.rb'
 require_relative 'string/line_wrap.rb'
+require_relative 'string/linear.rb'
 require_relative 'string/lowercase.rb'
 require_relative 'string/margin.rb'
 require_relative 'string/methodize.rb'
@@ -35,23 +31,26 @@ require_relative 'string/mscan.rb'
 require_relative 'string/natcmp.rb'
 require_relative 'string/nchar.rb'
 require_relative 'string/newlines.rb'
+require_relative 'string/number.rb'
 require_relative 'string/op_div.rb'
-require_relative 'string/op_sub.rb'
+require_relative 'string/op_sub.rb'          # included in `remove`.
 require_relative 'string/outdent.rb'
 require_relative 'string/pathize.rb'
 require_relative 'string/quote.rb'
-require_relative 'string/random_binary.rb'
+require_relative 'string/random.rb'
 require_relative 'string/range.rb'
 require_relative 'string/range_all.rb'
 require_relative 'string/range_of_line.rb'
+require_relative 'string/remove.rb'
 require_relative 'string/rewrite.rb'
 #require_relative 'integer/roman.rb'         # uncommon
+require_relative 'string/rotate.rb'
 require_relative 'string/shatter.rb'
 require_relative 'string/similarity.rb'
 require_relative 'string/snakecase.rb'
 require_relative 'string/splice.rb'
 require_relative 'string/squish.rb'
-require_relative 'string/start_with.rb'
+require_relative 'string/starts_with.rb'
 require_relative 'string/store.rb'
 require_relative 'string/subtract.rb'
 require_relative 'string/tab.rb'

data/lib/core/facets/string/ascii_only.rb

@@ -0,0 +1,52 @@
+class String
+  # Get a new string with non-ASCII characters removed.
+  #
+  # alt - String to replace non-ASCII characters with.
+  #       Defaults to a blank string (`''`).
+  #
+  # Examples
+  #
+  #   'abc'.ascii_only     #=> 'abc'
+  #   '中文123'.ascii_only  #=> '123'
+  #
+  # Returns a copy of [String] with ASCII characters only.
+  #
+  # CREDIT: Nathan Long
+  #
+  # SEE: http://stackoverflow.com/questions/1268289
+  def ascii_only(alt='')
+    encoding_options = {
+      :invalid                     => :replace,  # Replace invalid byte sequences
+      :undef                       => :replace,  # Replace anything not defined in ASCII
+      :replace                     => alt,       # Use a blank for those replacements
+      :UNIVERSAL_NEWLINE_DECORATOR => true       # Always break lines with \n
+    }
+    self.encode(Encoding.find('ASCII'), encoding_options)
+  end
+
+  # Modify string keeping only ASCII characters.
+  #
+  # alt - String to replace non-ASCII characters with.
+  #       Defaults to a blank string (`''`).
+  # 
+  # Examples
+  #
+  #   'abc'.ascii_only!     #=> 'abc'
+  #   '中文123'.ascii_only!  #=> '123'
+  #
+  # Returns [String]
+  #
+  # CREDIT: Nathan Long
+  #
+  # SEE: http://stackoverflow.com/questions/1268289
+  def ascii_only!(alt='')
+    encoding_options = {
+      :invalid                     => :replace,  # Replace invalid byte sequences
+      :undef                       => :replace,  # Replace anything not defined in ASCII
+      :replace                     => alt,       # Use a blank for those replacements
+      :UNIVERSAL_NEWLINE_DECORATOR => true       # Always break lines with \n
+    }
+    self.encode!(Encoding.find('ASCII'), encoding_options)
+  end
+
+end

data/lib/core/facets/string/each_match.rb

@@ -0,0 +1 @@
+require 'facets/string/mscan'

data/lib/core/facets/string/ends_with.rb

@@ -0,0 +1 @@
+require 'facets/string/starts_with'

data/lib/core/facets/string/file.rb

@@ -2,6 +2,8 @@ require 'facets/functor'
 
 class String
 
+  # TODO: Should String#file be moved to functor gem?"
+
   # Use fluent notation for making file directives.
   #
   # For instance, if we had a file 'foo.txt',
@@ -9,27 +11,11 @@ class String
   #    'foo.txt'.file.mtime
   #
   def file
-    Functor.new(&method(:file_send).to_proc)
+    f = self
+    Functor.new do |op, *a, &b|
+      File.send(op, f, *a, &b)
+    end
   end
 
-  private
-
-  def file_send(op, *a, &b)
-    File.send(op, self, *a, &b)
-  end
-
-  ## TODO: When no longer needing to support 1.8.6 we can use:
-  ##
-  ## # Use fluent notation for making file directives.
-  ## #
-  ## #    'README.rdoc'.file.mtime
-  ## #  
-  ## def file
-  ##   f = self
-  ##   Functor.new do |op, *a, &b|
-  ##     File.send(op, f, *a, &b)
-  ##   end
-  ## end
-
 end
 

data/lib/core/facets/string/fold.rb

@@ -3,14 +3,14 @@ class String
   # Returns a new string with all new lines removed from
   # adjacent lines of text.
   #
-  #   s = "This is\na test.\n\nIt clumps\nlines of text."
-  #   s.fold
+  #     s = "This is\na test.\n\nIt clumps\nlines of text."
+  #     s.fold
   #
   # _produces_
   #
-  #   "This is a test.\n\nIt clumps lines of text. "
+  #     "This is a test.\n\nIt clumps lines of text. "
   #
-  # One arguable flaw with this, that might need a fix:
+  # TODO: One arguable flaw with this that might need a fix:
   # if the given string ends in a newline, it is replaced with
   # a single space.
   #
@@ -19,7 +19,7 @@ class String
   def fold(ignore_indented=false)
     ns = ''
     i = 0
-    br = self.scan(/(\n\s*\n|\Z)/m) do |m|
+    self.scan(/(\n\s*\n|\Z)/m) do |m|
       b = $~.begin(1)
       e = $~.end(1)
       nl = $&