fancy 0.3.3 → 0.4.0

data/lib/compiler/ast/method_def.fy

@@ -1,8 +1,9 @@
 class Fancy AST {
-
   class MethodDef : Rubinius AST Define {
-    def initialize: @line name: @name args: @arguments body: @body access: @access {
+    def initialize: @line name: @name args: @arguments (MethodArgs new: @line) body: @body (ExpressionList new: @line) access: @access ('public) {
+      { @body = ExpressionList new: @line } unless: @body
       @name = @name method_name: nil
+      @docstring = @body shift_docstring
       generate_ivar_assignment
 
       if: (@body empty?) then: {
@@ -34,9 +35,8 @@ class Fancy AST {
         define_method_missing: g
       }
 
-      docstring = @body shift_docstring
       bytecode(g)
-      MethodDef set: g docstring: docstring line: @line argnames: $ @arguments names()
+      MethodDef set: g docstring: @docstring line: @line argnames: $ @arguments names()
     }
 
     # Sets fancy documentation for the object currently
@@ -77,13 +77,13 @@ class Fancy AST {
       ms = MessageSend new:     @line                                                          \
                        message: (Identifier from: "define_forward_method_missing" line: @line) \
                        to:      (Self new: @line)                                              \
-                       args:    (MessageArgs new: @line args: [])
+                       args:    (MessageArgs new: @line)
       ms bytecode: g
     }
   }
 
   class MethodArgs : Rubinius AST FormalArguments {
-    def initialize: @line args: @array{
+    def initialize: @line args: @array ([]) {
       initialize(@line, @array map() |a| { a to_sym() }, nil, nil)
     }
   }

data/lib/compiler/ast/node.fy

@@ -1,7 +1,7 @@
 class Fancy AST {
-
   class Node : Rubinius AST Node {
-    define_method('bytecode) |g| { bytecode: g }
+    define_method('bytecode) |g| {
+      bytecode: g
+    }
   }
-
 }

data/lib/compiler/ast/range.fy

@@ -1,6 +1,7 @@
 class Fancy AST {
   class RangeLiteral : Node {
     read_slots: ['from, 'to]
+
     def initialize: @line from: @from to: @to {
     }
 

data/lib/compiler/ast/script.fy

@@ -1,5 +1,4 @@
 class Fancy AST {
-
   class Script : Node {
     read_slots: ['file, 'line, 'body]
 
@@ -48,5 +47,4 @@ class Fancy AST {
       }
     }
   }
-
 }

data/lib/compiler/ast/singleton_method_def.fy

@@ -1,6 +1,5 @@
 class Fancy AST {
   class SingletonMethodDef : Rubinius AST DefineSingleton {
-
     def initialize: @line name: @name args: @arguments body: @body access: @access owner: @receiver {
       name = @name method_name: @receiver
       @body = SingletonMethodDefScope new: @line name: name args: @arguments body: @body
@@ -13,12 +12,11 @@ class Fancy AST {
       g pop()
       bytecode(g)
     }
-
   }
 
   class SingletonMethodDefScope : Rubinius AST DefineSingletonScope {
-
-    def initialize: @line name: @name args: @arguments body: @body { }
+    def initialize: @line name: @name args: @arguments body: @body {
+    }
 
     define_method("bytecode") |g, recv| {
       bytecode: g receiver: recv

data/lib/compiler/ast/string_interpolation.fy

@@ -0,0 +1,17 @@
+class Fancy AST {
+  class StringInterpolation : Node {
+    """
+    StringInterpolation nodes need to be parsed after the overall code has been parsed
+    as the parser currently isn't re-entrant.
+    It works...
+    """
+
+    def initialize: @line code: @code
+    def parse_code {
+      Fancy Parser parse_code: @code file: ("<<StringInterpolation: " ++ (@code inspect) ++ ">>") line: @line
+    }
+    def bytecode: g {
+      parse_code body expressions first bytecode: g
+    }
+  }
+}

data/lib/compiler/ast/super.fy

@@ -1,11 +1,13 @@
 class Fancy AST {
-
   class Super : Node {
-    def initialize: @line { }
+    def initialize: @line {
+    }
   }
 
   class SuperSend : Node {
-    def initialize: @line message: @name args: @args { }
+    def initialize: @line message: @name args: @args {
+    }
+
     def bytecode: g {
       pos(g)
       @args bytecode: g
@@ -14,5 +16,4 @@ class Fancy AST {
       g send_super(name, @args size)
     }
   }
-
 }

data/lib/compiler/ast/try_catch.fy

@@ -1,6 +1,5 @@
 class Fancy AST {
   class TryCatch : Node {
-
     def initialize: @line body: @body handlers: @handlers ensure: @ensure {
       if: (@body empty?) then: {
         @body unshift_expression: $ NilLiteral new: @line
@@ -12,7 +11,6 @@ class Fancy AST {
 
       g push_modifiers()
 
-
       outer_retry = g new_label()
       this_retry = g new_label()
       reraise = g new_label()
@@ -133,7 +131,8 @@ class Fancy AST {
   }
 
   class ExceptionHandler : Node {
-    def initialize: @line condition: @condition var: @var body: @body {}
+    def initialize: @line condition: @condition var: @var body: @body {
+    }
 
     def bytecode: g final_tag: final_tag {
       pos(g)
@@ -161,7 +160,9 @@ class Fancy AST {
   }
 
   class CurrentException : Node {
-    def initialize: @line {}
+    def initialize: @line {
+    }
+
     def bytecode: g {
       pos(g)
       g push_current_exception()
@@ -169,12 +170,13 @@ class Fancy AST {
   }
 
   class Retry : Node {
-    def initialize: @line {}
+    def initialize: @line {
+    }
+
     def bytecode: g {
       pos(g)
       g pop()
       g goto(g retry())
     }
   }
-
 }

data/lib/compiler/ast/tuple_literal.fy

@@ -1,6 +1,7 @@
 class Fancy AST {
   class TupleLiteral : Node {
-    def initialize: @line entries: @elements { }
+    def initialize: @line entries: @elements {
+    }
 
     def bytecode: g {
       pos(g)
@@ -22,7 +23,7 @@ class Fancy AST {
         ary = [FixnumLiteral new: @line value: i, e]
 
         ms = MessageSend new:  @line                                       \
-                         message: (Identifier from: "at:put:" line: @line) \
+                         message: (Identifier from: "[]:" line: @line) \
                          to:   (Nothing new: @line)                        \
                          args: (MessageArgs new: @line args: ary)
 

data/lib/compiler/command.fy

@@ -2,7 +2,6 @@ require("fileutils")
 
 class Fancy {
   class Compiler Command {
-
     def self option: argv flag: name {
       argv delete(name)
     }

data/lib/compiler/compiler.fy

@@ -1,8 +1,6 @@
 class Fancy {
-
   class Compiler : Rubinius Compiler {
-
-    read_write_slots: ['parser, 'generator, 'packager, 'writer]
+    read_write_slots: [ 'parser, 'generator, 'packager, 'writer ]
 
     def self compiled_name: file {
      """
@@ -69,7 +67,5 @@ class Fancy {
         compiler_error("Error trying to compile " ++ file, e)
       }
     }
-
   }
-
 }

data/lib/compiler/stages.fy

@@ -1,7 +1,5 @@
 class Fancy Compiler Stages {
-
   class Stage : Rubinius Compiler Stage {
-
     initialize = |compiler, last| {
       sup = Rubinius Compiler Stage instance_method('initialize)
       sup bind(self) call(compiler, last)
@@ -16,14 +14,11 @@ class Fancy Compiler Stages {
 
     run = { self run; run_next() }
     define_method('run, &run)
-
   }
 
   class FancyGenerator : Stage {
-
     stage: 'fancy_bytecode next: Rubinius Compiler Encoder
-
-    read_write_slots: ['variable_scope]
+    read_write_slot: 'variable_scope
 
     def initialize: compiler last: last {
       @variable_scope = nil
@@ -36,7 +31,6 @@ class Fancy Compiler Stages {
       @input bytecode(@output)
       @output close()
     }
-
   }
 
   class FancyCodeParser : Stage {
@@ -47,7 +41,8 @@ class Fancy Compiler Stages {
       compiler parser: self
     }
 
-    def input: @code file: @filename line: @line (1) {}
+    def input: @code file: @filename line: @line (1) {
+    }
 
     def run {
       ast = Fancy Parser parse_code: @code file: @filename line: @line
@@ -58,7 +53,6 @@ class Fancy Compiler Stages {
   }
 
   class FancyFileParser : Stage {
-
     stage: 'fancy_file next: FancyGenerator
     read_write_slots: ['root, 'print]
 
@@ -66,7 +60,8 @@ class Fancy Compiler Stages {
       compiler parser: self
     }
 
-    def input: @filename line: @line (1) {}
+    def input: @filename line: @line (1) {
+    }
 
     def run {
       ast = Fancy Parser parse_file: @filename line: @line
@@ -74,8 +69,5 @@ class Fancy Compiler Stages {
       @output = @root new(ast)
       @output file=(@filename)
     }
-
   }
-
-}
-
+}

data/lib/documentation.fy

@@ -1,57 +1,60 @@
 class Fancy Documentation {
-
   """
-   A Fancy Documentation object is a holder for docstrings and specs.
-   Keeps a registry of documentation for anything Fancy.
+  A Fancy Documentation object is a holder for docstrings and specs.
+  Keeps a registry of documentation for anything Fancy.
 
-   Provides methods for searching and formatting objects' docstrings
-   this can be be handy for users of interactive Fancy REPL,
-   document generators, instrospection toos, IDEs, anything!.
+  Provides methods for searching and formatting an Object's docstrings.
+  This can be be handy for users of the interactive Fancy REPL,
+  document generators, instrospection tools, IDEs, anything!
 
-   This object can be converted to just anything by using its format:
-   method. formatters can be registered with Fancy Documentation formatter:is:
+  This object can be converted to just anything by using its format:
+  method. Formatters can be registered with Fancy Documentation#formatter:is:
 
-   By default two formatters are defined:
+  By default two formatters are defined:
 
-        'fancy    => Returns the Fancy::Documentation object
-        'string   => Returns the docs string representation
+      'fancy    => Returns the Fancy::Documentation object
+      'string   => Returns the docs string representation
   """
+
   read_write_slots: ['object, 'docs, 'specs]
 
   instance_method: 'docs . executable() . documentation: """
-     An array of docstrings for the object beind documented.
+    An array of docstrings for the object beind documented.
 
-     We have an array of docstrings because in Fancy, some
-     things like classes can be re-openned and the user may
-     specify new documentation for it each time. Thus we dont
-     want to loose the previous documentation but rather build
-     upon it. That is, fancy supports incremental documentation.
+    We have an array of docstrings because in Fancy, some
+    things like classes can be re-openned and the user may
+    specify new documentation for it each time. Thus we dont
+    want to loose the previous documentation but rather build
+    upon it. That is, fancy supports incremental documentation.
   """
 
   instance_method: 'specs . documentation: """
-     An array of associated Fancy specs for the object
-     being documented.
-
-     Its a lot better to keep the associated specs in
-     Fancy Documentation objects instead of just having them
-     in method instances. This allows us to associate any object
-     with an spec example.
-
-     This way you can have a single Fancy spec example that
-     is related to many objects (methods, constants, classes)
-     that are being specified. Later in documentation, we can
-     provide links to all specs where an object is being exercised.
+    An array of associated Fancy specs for the object
+    being documented.
+
+    Its a lot better to keep the associated specs in
+    Fancy Documentation objects instead of just having them
+    in method instances. This allows us to associate any object
+    with an spec example.
+
+    This way you can have a single Fancy spec example that
+    is related to many objects (methods, constants, classes)
+    that are being specified. Later in documentation, we can
+    provide links to all specs where an object is being exercised.
   """
 
-  def to_s { @docs join: "\n" }
+  def to_s {
+    @docs join: "\n" . skip_leading_indentation
+  }
 
   def format: format {
     """
-      If format is specified, the documentation string will be
-      converted using the corresponding formatter. This allows
-      you to extend Fancy documentation system, and produce
-      html documents, man pages, or anything you can imagine.
+    If format is specified, the documentation string will be
+    converted using the corresponding formatter. This allows
+    you to extend Fancy documentation system, and produce
+    html documents, man pages, or anything you can imagine.
     """
+
     formatter = Fancy Documentation formatter: format
     { "No such documentation format: " ++ format . raise! } unless: formatter
     formatter call: [self]
@@ -59,9 +62,10 @@ class Fancy Documentation {
 
   def self for: obj append: docstring {
     """
-      Append docstring to the documentation for obj.
-      If obj has no documentation, one is created for it.
+    Append docstring to the documentation for obj.
+    If obj has no documentation, one is created for it.
     """
+
     doc = for: obj
     if: doc then: {
       doc docs << docstring
@@ -72,17 +76,26 @@ class Fancy Documentation {
   }
 
   def self formatter: name {
-    "Obtain a formatter by the given name. Returns a callable object"
+    """
+    Obtains a formatter by a given name. Returns a callable object.
+    """
+
     formatters at: name
   }
 
   def self formatter: name is: callable {
-    "Register a callable object as formatter under name."
-    formatters at: name put: callable
+    """
+    Registers a callable object as formatter under name.
+    """
+
+    formatters[name]: callable
   }
 
   def self formatters {
-    "Obtain the hash of known documentation formatters."
+    """
+    Obtain the hash of known documentation formatters.
+    """
+
     unless: @formatters do: { @formatters = <[]> }
     @formatters
   }
@@ -92,12 +105,13 @@ class Fancy Documentation {
 
   # TODO: implement. Plain is just like string but including spec names.
   self formatter: 'plain  is: |doc| { doc to_s }
-
 }
 
 class Fancy Documentation RDiscount {
+  """
+  A documentation formatter using ruby's RDiscount markdown
+  """
 
-  "A documentation formatter using ruby's RDiscount markdown"
   Fancy Documentation formatter: 'rdiscount is: |d| { rdiscount: d }
 
   # Register as default markdown formatter.
@@ -109,7 +123,4 @@ class Fancy Documentation RDiscount {
     require("rdiscount")
     RDiscount.new(doc to_s).to_html()
   }
-
-}
-
-
+}