fancy 0.5.0 → 0.6.0

data/lib/range.fy

@@ -8,7 +8,7 @@ class Range {
         Range new: 10 to: 100
   """
 
-  include: FancyEnumerable
+  include: Fancy Enumerable
 
   def to_s {
     """

data/lib/rbx.fy

@@ -25,8 +25,8 @@ require: "rbx/system"
 require: "rbx/exception"
 require: "rbx/io"
 require: "rbx/file"
-require: "rbx/tcp_server"
 require: "rbx/tcp_socket"
+require: "rbx/tcp_server"
 require: "rbx/match_data"
 require: "rbx/regexp"
 require: "rbx/directory"
@@ -40,3 +40,4 @@ require: "rbx/date"
 require: "rbx/time"
 require: "rbx/actor"
 require: "rbx/mutex"
+require: "rbx/module"

data/lib/rbx/array.fy

@@ -1,12 +1,18 @@
 class Array {
-  ruby_aliases: [ '==, '<<, 'pop, 'last, 'shift ]
+  ruby_aliases: [ '==, '<<, 'pop, 'last, 'shift, 'flatten ]
 
   forwards_unary_ruby_methods
 
   def Array new: size with: default {
-    "Creates a new Array with a given size and default-value."
+    """
+    Creates a new Array with a given size and default-value.
+    If @default is a @Block@, call that block for each element instead.
+    """
 
-    Array new(size, default)
+    match default {
+      case Block -> Array new(size, &default)
+      case _ -> Array new(size, default)
+    }
   }
 
   def includes?: obj {
@@ -32,16 +38,14 @@ class Array {
       delete_at(index)
       return deleted
     } else: {
-      if: (index is_a?: Array) then: {
-        count = 0
-        deleted_values = []
-        index each: |idx| {
-          deleted_values << (at: (idx - count))
-          delete_at(idx - count)
-          count = count + 1
-        }
-        return deleted_values
+      count = 0
+      deleted_values = []
+      index each: |idx| {
+        deleted_values << (at: (idx - count))
+        delete_at(idx - count)
+        count = count + 1
       }
+      return deleted_values
     }
     nil
   }
@@ -106,6 +110,18 @@ class Array {
   }
 
   def unshift: value {
+    """
+    @value Value to be added at the front of @self.
+    @return @self.
+
+    Inserts a value at the front of @self.
+
+    Example:
+          a = [1,2,3]
+          a unshift: 10
+          a # => [10,1,2,3]
+    """
+
     unshift(value)
   }
 }

data/lib/rbx/bignum.fy

@@ -5,7 +5,7 @@ class Bignum {
 
   include: Number
 
-  ruby_aliases: [ '==, '-, '+, '*, '/, '<, '>, '<=, '>=, '===, '**, '& ]
+  ruby_aliases: [ '==, '-, '+, '*, '/, '<, '>, '<=, '>=, '===, '**, '&, '<<, '>> ]
 
   forwards_unary_ruby_methods
 

data/lib/rbx/block.fy

@@ -50,6 +50,19 @@ class Block {
   # Ugh. HACK.
   # Use try/catch to deal with older and latest version of rbx (method got changed)
   def call_with_receiver: receiver {
+    """
+    @receiver Receiver (value of @self) when calling the @Block@.
+
+    Calls a @Block@ with @receiver as the receiver (referenced by @self within the Block).
+
+    Example:
+          r1 = [1,2,3]
+          r2 = \"hello world\"
+          b = { self class }
+          b call_with_receiver: r1 # => Array
+          b call_with_receiver: r2 # => String
+    """
+
     try {
       return call_under(receiver, method() scope())
     } catch {
@@ -58,6 +71,20 @@ class Block {
   }
 
   def call: args with_receiver: receiver {
+    """
+    @args @Array@ of arguments passed to @self for invocation.
+    @receiver Receiver (value of @self) when calling the @Block@.
+
+    Same as @call_with_receiver: but passing along arguments to the @Block@.
+
+    Example:
+          r1 = [1,2,3]
+          r2 = \"hello world\"
+          b = |arg| { self to_s + arg }
+          b call: [\"foo\"] with_receiver: r1 # => \"123foo\"
+          b call: [\"foo\"] with_receiver: r2 # => \"hello worldfoo\"
+    """
+
     try {
       return call_under(receiver, method() scope(), *args)
     } catch {

data/lib/rbx/console.fy

@@ -38,11 +38,7 @@ class Console {
     """
 
     Console print: message
-    if: (STDIN eof?) then: {
-      nil
-    } else: {
-      STDIN gets() chomp
-    }
+    Console readln
   }
 
   def Console readln {
@@ -52,7 +48,11 @@ class Console {
     Reads a line from @STDIN and returns it as a @String@.
     """
 
-    STDIN gets() chomp
+    if: (STDIN eof?) then: {
+      nil
+    } else: {
+      STDIN gets() chomp
+    }
   }
 
   def Console clear {

data/lib/rbx/date.fy

@@ -9,9 +9,14 @@ class Date {
   metaclass forwards_unary_ruby_methods
 
   metaclass ruby_alias: 'today
-  ruby_aliases: [ '==, '-, '+, '<, '> ]
+  ruby_aliases: [ '==, '-, '+, '<, '>, 'cwday, 'wday ]
 
   def != other {
+    """
+    @other Other @Date@ to compare to.
+    @return @true if equal, @false otherwhise.
+    """
+
     self == other not
   }
 }

data/lib/rbx/documentation.fy

@@ -2,7 +2,6 @@
 class Fancy {}
 
 class Fancy Documentation {
-
   def initialize: docstring {
     @docs = [docstring]
   }
@@ -42,6 +41,14 @@ class Fancy Documentation {
     doc
   }
 
+  def self for_method: method_name on_class: class is: docstring {
+    """
+    Similar to @Fancy::Documentation##for:is:@ but taking the method name and the @Class@ for which @Method@ to define the docstring.
+    """
+
+    class instance_method: method_name . documentation: docstring
+  }
+
   for: (instance_method('initialize:)) is: "Create a new documentation object."
   for: (method('for:is:)) is: "Sets the documentation for obj."
 
@@ -59,6 +66,4 @@ class Fancy Documentation {
     "Append docstring to docs."
     for: obj is: docstring
   }
-
 }
-

data/lib/rbx/exception.fy

@@ -1,4 +1,9 @@
 class Exception {
+  """
+  Base Exception class.
+  All Exception classes inherit from @Exception@.
+  """
+
   forwards_unary_ruby_methods
 }
 

data/lib/rbx/file.fy

@@ -8,6 +8,9 @@ class File {
       'truncate => "w+"]>
 
   ruby_aliases: [ 'eof?, 'closed?, 'flush ]
+  metaclass alias_method: 'expand_path: for_ruby: 'expand_path
+
+  forwards_unary_ruby_methods
 
   def File open: filename modes: modes_arr with: block {
     """
@@ -46,16 +49,30 @@ class File {
     File exists?(filename)
   }
 
-  def close {
+  def File read: filename {
     """
-    Closes an opened @File@.
+    @filename @String@ containing the path of the File to be read.
+    @return Contents of the File as a @String@.
+
+    Reads all the contens (in ASCII mode) of a given file and returns
+    them as an Array of lines being read.
     """
 
-    try {
-      close()
-    } catch Errno::ENOENT => e {
-      IOError new: (e message) . raise!
-    }
+    File read(filename)
+  }
+
+  def File read: filename length: length offset: offset (0) {
+    """
+    @filename @String@ containing the path of the File to be read.
+    @length @Fixnum@ being the maximum length to read from the File.
+    @offset @Fixnum@ being the offset in bytes to start reading from the File.
+    @return Contents of the File as a @String@.
+
+    Reads all the contens (in ASCII mode) of a given file, length and offset
+    and returns them as an Array of lines being read.
+    """
+
+    File read(filename, length, offset)
   }
 
   def File open: filename modes: modes_arr {
@@ -131,6 +148,22 @@ class File {
     File rename(old_name, new_name)
   }
 
+  def initialize: path {
+    initialize(path)
+  }
+
+  def close {
+    """
+    Closes an opened @File@.
+    """
+
+    try {
+      close()
+    } catch Errno::ENOENT => e {
+      IOError new: (e message) . raise!
+    }
+  }
+
   def modes {
     """
     @return @File@ access modes @Array@.

data/lib/rbx/fixnum.fy

@@ -9,11 +9,22 @@ class Fixnum {
 
   ruby_aliases: [
     '==, '-, '+, '*, '/, '<, '>, '<=, '>=,
-    '===, 'chr, 'to_i, 'to_f, '**, '&, '|
+    '===, 'chr, 'to_i, 'to_f, '**, '&, '|,
+    '<<, '>>
   ]
 
   alias_method: 'to_s: for: 'to_s
   alias_method: 'modulo: for: 'modulo
   alias_method: ":%" for: "modulo:" # use a : so we dont overwrite ruby's % operator
   alias_method: 'div: for: 'div
+
+  def random {
+    """
+    @return Random number between 0 and @self.
+
+    Returns a random number between 0 and @self.
+    """
+
+    rand(self)
+  }
 }

data/lib/rbx/method.fy

@@ -8,7 +8,7 @@ class MethodMixin {
     @return Docstring for @self.
     """
 
-    Fancy Documentation for: (executable())
+    Fancy Documentation for: executable
   }
 
   def documentation: docstring {
@@ -16,7 +16,7 @@ class MethodMixin {
     @docstring New docstring for @self.
     """
 
-    Fancy Documentation for: (executable()) is: docstring
+    Fancy Documentation for: executable is: docstring
   }
 
   def visibility {
@@ -66,7 +66,13 @@ class MethodMixin {
 }
 
 class Method {
+  """
+  An instance of Method represents a method on a Class.
+  Every method in Fancy is an instance of the Method class.
+  """
+
   ruby_alias: 'arity
+  ruby_alias: 'executable
   include: MethodMixin
   forwards_unary_ruby_methods
 }
@@ -77,6 +83,7 @@ class UnboundMethod {
   """
 
   ruby_alias: 'arity
+  ruby_alias: 'executable
   include: MethodMixin
   forwards_unary_ruby_methods
 }

data/lib/rbx/module.fy

@@ -0,0 +1,24 @@
+class Module {
+  forwards_unary_ruby_methods
+
+  def [constant_name] {
+    """
+    @constant_name Name (@String@) of constant's name.
+    @return @constant_name's value.
+
+    Returns the value of the constant with the given name in @self.
+    """
+
+    const_get(constant_name)
+  }
+
+  def included: module {
+    """
+    @module @Module@ or @Class@ that has been included into @self.
+    Gets called when a @Class@ or @Module@ is included into another @Class@.
+    """
+
+    # do nothing by default
+    nil
+  }
+}

data/lib/rbx/regexp.fy

@@ -14,6 +14,14 @@ class Regexp {
     Regexp new(source(), true)
   }
 
+  def m {
+    Regexp new(source(), Regexp MULTILINE)
+  }
+
+  def x {
+    Regexp new(source(), Regexp EXTENDED)
+  }
+
   def Regexp new: string {
     new(string)
   }

data/lib/rbx/string.fy

@@ -6,20 +6,25 @@ class String {
     'chomp, 'inspect, 'to_sym, '<, '>
   ]
 
+  alias_method: 'ruby_idx: for_ruby: '[]
   alias_method: '[]: for_ruby: '[]=
   alias_method: 'scan: for_ruby: 'scan
+  alias_method: 'uppercase for: 'upcase
+  alias_method: 'lowercase for: 'downcase
 
   forwards_unary_ruby_methods
 
   def [index] {
-    """Given an Array of 2 Numbers, it returns the substring between the given indices.
-       If given a Number, returns the character at that index."""
+    """
+    Given an Array of 2 Numbers, it returns the substring between the given indices.
+    If given a Number, returns the character at that index.
+    """
 
     # if given an Array, interpret it as a from:to: range substring
-    if: (index is_a?: Array) then: {
-      from: (index[0]) to: (index[1])
-    } else: {
-      ruby: '[] args: [index] . chr
+    match index {
+      case Array -> from: (index[0]) to: (index[1])
+      case Tuple -> ruby_idx: index
+      case _ -> ruby_idx: index . chr()
     }
   }
 
@@ -31,7 +36,8 @@ class String {
 
     Returns a Substring from @from to @to.
     """
-    ruby: '[] args: [(from .. to)]
+
+    ruby_idx: (from .. to)
   }
 
   def each: block {
@@ -146,4 +152,14 @@ class String {
 
     include?(substring)
   }
+
+  def substitute: substring with: substitution {
+    """
+    @substring @String@ or @Regexp@ to be substituted.
+    @substitution @String@ to replace @substring with.
+    @return A new @String@ where @substring is substituted by @substitution.
+    """
+
+    gsub(substring, substitution)
+  }
 }