fancy 0.5.0 → 0.6.0

data/lib/enumerator.fy

@@ -1,184 +1,186 @@
-class FancyEnumerator {
-  def initialize: @collection {
-    """
-    @collection Collection to iterate over.
-
-    Initializes a new FancyEnumerator with a given @collection,
-    using #each: for iteration.
-    """
-
-    @iterator = 'each:
-    rewind
-  }
-
-  def initialize: @collection with: @iterator {
-    """
-    @collection Collection to iterate over.
-    @iterator Selector to use to iterate over @collection.
-
-    Initializes a new FancyEnumerator with a given @collection
-    and @iterator selector to be used for iteration.
-    """
-
-    rewind
-  }
+class Fancy {
+  class Enumerator {
+    def initialize: @collection {
+      """
+      @collection Collection to iterate over.
+
+      Initializes a new Enumerator with a given @collection,
+      using #each: for iteration.
+      """
+
+      @iterator = 'each:
+      rewind
+    }
 
-  def next {
-    """
-    @return Next element in the collection this enumerator is attached to.
+    def initialize: @collection with: @iterator {
+      """
+      @collection Collection to iterate over.
+      @iterator Selector to use to iterate over @collection.
 
-    Returns the next element in the collection this enumerator is attached to.
-    It will move the internal position forward (compared to e.g. #peek, which doesn't).
+      Initializes a new Enumerator with a given @collection
+      and @iterator selector to be used for iteration.
+      """
 
-    Example:
-          a = [1,2,3]
-          e = a to_enum
-          e next # => 1
-          e next # => 2
-          e next # => 3
-          e next # => raises Fancy StopIteration
-    """
+      rewind
+    }
 
-    if: @peeked then: {
-      @peeked = false
-      @peek
-    } else: {
-      result = @fiber resume
-      if: (@fiber alive?) then: {
-        return result
+    def next {
+      """
+      @return Next element in the collection this enumerator is attached to.
+
+      Returns the next element in the collection this enumerator is attached to.
+      It will move the internal position forward (compared to e.g. #peek, which doesn't).
+
+      Example:
+            a = [1,2,3]
+            e = a to_enum
+            e next # => 1
+            e next # => 2
+            e next # => 3
+            e next # => raises Fancy StopIteration
+      """
+
+      if: @peeked then: {
+        @peeked = false
+        @peek
       } else: {
-        (Fancy StopIteration new: result) raise!
+        result = @fiber resume
+        if: (@fiber alive?) then: {
+          return result
+        } else: {
+          (Fancy StopIteration new: result) raise!
+        }
       }
     }
-  }
-
-  def ended? {
-    """
-    @return @true if the enumerator has ended (no more values left), @false otherwise.
 
-    Indicates if an enumerator has ended (no more values left).
-    """
+    def ended? {
+      """
+      @return @true if the enumerator has ended (no more values left), @false otherwise.
 
-    @fiber alive? not
-  }
+      Indicates if an enumerator has ended (no more values left).
+      """
 
-  def peek {
-    """
-    Returns the next object in the FancyEnumerator, but doesn't move the
-    internal position forward.
-    When the position reaches the end, a Fancy StopIteration exception is
-    raised.
-
-    Example:
-          a = [1,2,3]
-          e = a to_enum
-          e next p #=> 1
-          e peek p #=> 2
-          e peek p #=> 2
-          e peek p #=> 2
-          e next p #=> 2
-          e next p #=> 3
-          e next p #=> raises Fancy StopIteration
-    """
-
-    unless: @peeked do: {
-      @peeked = true
-      @peek = @fiber resume
-      if: (@fiber alive?) then: {
-        return @peek
-      } else: {
-        (Fancy StopIteration new: result) raise!
-      }
+      @fiber alive? not
     }
 
-    return @peek
-  }
-
-  def rewind {
-    """
-    Resets the enumerator to start from the collection's beginning.
-    """
-
-    @peeked = false
-    @peek = nil
+    def peek {
+      """
+      Returns the next object in the Enumerator, but doesn't move the
+      internal position forward.
+      When the position reaches the end, a Fancy StopIteration exception is
+      raised.
+
+      Example:
+            a = [1,2,3]
+            e = a to_enum
+            e next p #=> 1
+            e peek p #=> 2
+            e peek p #=> 2
+            e peek p #=> 2
+            e next p #=> 2
+            e next p #=> 3
+            e next p #=> raises Fancy StopIteration
+      """
+
+      unless: @peeked do: {
+        @peeked = true
+        @peek = @fiber resume
+        if: (@fiber alive?) then: {
+          return @peek
+        } else: {
+          (Fancy StopIteration new: result) raise!
+        }
+      }
 
-    @fiber = Fiber new: {
-      param = |element| { yield: element }
-      @collection receive_message: @iterator with_params: [param]
+      return @peek
     }
-  }
 
-  def with: object each: block {
-    """
-    @object Object to pass along to @block with each element in the collection.
-    @block A @Block@ to be called with each element in the collection and @object.
+    def rewind {
+      """
+      Resets the enumerator to start from the collection's beginning.
+      """
 
-    Similar to #each: but also passing in a given @object to each invocation of @block.
-    """
+      @peeked = false
+      @peek = nil
 
-    each: |element| {
-      block call: [element, object]
+      @fiber = Fiber new: {
+        param = |element| { yield: element }
+        @collection receive_message: @iterator with_params: [param]
+      }
     }
 
-    return object
-  }
-
-  def each: block {
-    """
-    @block @Block@ to be called with each element in the collection (iteration).
+    def with: object each: block {
+      """
+      @object Object to pass along to @block with each element in the collection.
+      @block A @Block@ to be called with each element in the collection and @object.
 
-    Calls a given @Block@ with each element in the collection this enumerator is attached to.
-    Used for iterating over the collection using this enumerator.
-    """
+      Similar to #each: but also passing in a given @object to each invocation of @block.
+      """
 
-    loop: {
-      try {
-        block call: [next]
-      } catch (Fancy StopIteration) => ex {
-        return self
+      each: |element| {
+        block call: [element, object]
       }
+
+      return object
     }
-  }
 
-  def chunk: block {
-    Generator new: |inner_block| {
-      enums = []
-      last = nil
-      previous = nil
-      stack = []
+    def each: block {
+      """
+      @block @Block@ to be called with each element in the collection (iteration).
+
+      Calls a given @Block@ with each element in the collection this enumerator is attached to.
+      Used for iterating over the collection using this enumerator.
+      """
+
+      loop: {
+        try {
+          block call: [next]
+        } catch (Fancy StopIteration) => ex {
+          return self
+        }
+      }
+    }
 
-      each: |element| {
-        result = (block call: [element]) not not
-        if: (previous == result) then: {
-          stack << element
-        } else: {
-          previous if_nil: {
-            # wait one gap to call
+    def chunk: block {
+      Generator new: |inner_block| {
+        enums = []
+        last = nil
+        previous = nil
+        stack = []
+
+        each: |element| {
+          result = (block call: [element]) not not
+          if: (previous == result) then: {
+            stack << element
           } else: {
-            inner_block call: [[previous, stack]]
+            previous if_nil: {
+              # wait one gap to call
+            } else: {
+              inner_block call: [[previous, stack]]
+            }
+            previous = result
+            stack = [element]
+            last = [result, stack]
+            enums << last
           }
-          previous = result
-          stack = [element]
-          last = [result, stack]
-          enums << last
         }
-      }
 
-      self
-    } . to_enum
-  }
+        self
+      } . to_enum
+    }
 
-  class Generator {
-    def initialize: @block {}
+    class Generator {
+      def initialize: @block {}
 
-    def each: block {
-      @block call: [block]
+      def each: block {
+        @block call: [block]
+      }
     }
-  }
 
-  def to_a {
-    output = []
-    each: |element| { output << element }
-    output
+    def to_a {
+      output = []
+      each: |element| { output << element }
+      output
+    }
   }
-}
+}

data/lib/fdoc.fy

@@ -208,50 +208,37 @@ class Fancy FDoc {
     def self create_class_references: str {
       """
       Creates class references for Fancy class names.
-
       A docstring may contain class names sorounded by @
       without space between the @.
 
       Nested classes can be indicated by using :: like
-
-        Foo::Bar
-
+            Foo::Bar
       This will create references for both, @Foo and @Bar
 
       Instance methods should be written:
-
-        Foo::Bar#baz
+            Foo::Bar#baz
 
       Class methods should be written:
-
-        Foo::Bar.baz
+            Foo::Bar.baz
 
       Some examples:
-
       A simple class reference:
-
       @Fancy@
 
       Nested class reference:
-
       @Fancy::FDoc@
 
       A fancy method without arguments:
-
       @Fancy::FDoc::JSON#:generate_map@
 
       A ruby method reference (will link to ruby docs if available)
-
       @String#split@
 
       A fancy method with many arguments:
-
       @Fancy::Package::Installer#initialize:version:install_path:@
 
       A singleton method:
-
       @Fancy::FDoc::Formatter~format:@
-
       """
       str gsub(/@[A-Z][^\r\n\s]+?@/) |cstr| {
        names = cstr slice(1, cstr size() - 2) split("::")
@@ -319,7 +306,7 @@ class Fancy FDoc {
     }
 
     def self create_code: str {
-      str gsub(/@([^\s,\]\)\}\.]+)/,
+      str gsub(/@([^\s,\]\)\{\}\.]+)/,
                "<code data-lang=\"fancy\">\\1</code>")
     }
 

data/lib/fiber.fy

@@ -6,17 +6,11 @@ class Fiber {
   There is no preemptive scheduler.
   """
 
-  def sleep: seconds {
-    @sleep_end = Time now + seconds
-  }
-
-  def asleep? {
-    if: @sleep_end then: {
-      Time now < @sleep_end
-    }
-  }
-
   def Fiber name {
     "Fiber"
   }
+
+  def Fiber inspect {
+    name
+  }
 }

data/lib/file.fy

@@ -4,33 +4,29 @@ class File {
   system on which Fancy is running.
   """
 
-  # def self exists?: filename {
-  #   "Indicates, if a File exists with a given filename."
-  #   try {
-  #     f = File open: filename modes: ['read]
-  #     f close
-  #     true
-  #   } catch IOError => e {
-  #     nil
-  #   }
-  # }
-
-  def self read: filename {
-    """
-    Reads all the contens (in ASCII mode) of a given file and returns
-    them as an Array of lines being read.
-    """
-
-    lines = []
-    File open: filename modes: ['read] with: |f| {
-      { f eof? } while_false: {
-        lines << (f readln)
-      }
-    }
-    lines join
+  def File write: filename with: block {
+    """
+    @filename Filename of @File@ to write to.
+    @block @Block@ called with a @File@ object to write to.
+
+    Opens a @File@ for writing and calls @block with it.
+    """
+
+    File open: filename modes: ['write] with: block
   }
 
-  def self touch: filename {
+  def File read: filename with: block {
+    """
+    @filename Filename of @File@ to read from.
+    @block @Block@ called with a @File@ object to read from.
+
+    Opens a @File@ for reading and calls @block with it.
+    """
+
+    File open: filename modes: ['read] with: block
+  }
+
+  def File touch: filename {
     """
     @filename Name of @File@ to be created, if not already existant.
 
@@ -55,4 +51,16 @@ class File {
 
   alias_method: 'print: for: 'write:
   alias_method: 'println: for: 'writeln:
+
+  def expanded_path {
+    """
+    @return Expanded (absolute) path of @self.
+
+    Example:
+          f = File open: \"README.txt\"
+          f expanded_path # => \"/path/to/README.txt\" (when run from /path/to/)
+    """
+
+    File expand_path: path
+  }
 }