sourcify 0.5.0 → 0.6.0.rc1

data/lib/sourcify/common/parser/raw_scanner/heredoc.rb

@@ -0,0 +1,26 @@
+module Sourcify
+  module Common
+    class Parser
+      module RawScanner #:nodoc:all
+        class Heredoc < Struct.new(:tag, :indented)
+
+          def <<(content)
+            (@contents ||= []) << content
+          end
+
+          def to_s
+            @contents.join
+          end
+
+          def closed?(sealer)
+            return false unless sealer == "\n"
+            parts = @contents[-1].split("\n")
+            return true if parts[-1] == tag
+            indented && parts[-1].sub(/^\s*(.*)$/,'\1') == tag
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/sourcify/common/parser/source_code.rb

@@ -0,0 +1,33 @@
+module Sourcify
+  module Common
+    class Parser #:nodoc:all
+      class SourceCode < Struct.new(:file, :line)
+
+        def line
+          super.pred
+        end
+
+        def to_s
+          case file
+          when /\(irb\)/ then from_irb_to_s
+          else from_file_to_s
+          end
+        end
+
+        def from_file_to_s
+          File.open(file, 'r') do |fh|
+            fh.extend(File::Tail).forward(line)
+            fh.readlines.join
+          end
+        end
+
+        def from_irb_to_s
+          # Really owe it to Florian Groß's solution @ http://rubyquiz.com/quiz38.html ...
+          # anyway, note that we use *line.succ* instead of *line* here.
+          IRB.CurrentContext.io.line(line.succ .. -1).join
+        end
+
+      end
+    end
+  end
+end

data/lib/sourcify/common/ragel/common.rl

@@ -0,0 +1,5 @@
+%%{
+  machine common;
+  include common_expressions 'expressions.rl';
+  include common_machines 'machines.rl';
+

data/lib/sourcify/common/ragel/expressions.rl

@@ -0,0 +1,38 @@
+%%{
+  machine common_expressions;
+
+  kw_class  = 'class';
+  kw_module = 'module';
+  kw_def    = 'def';
+  kw_begin  = 'begin';
+  kw_case   = 'case';
+  kw_if     = 'if';
+  kw_unless = 'unless';
+  kw_do     = 'do';
+  kw_then   = 'then';
+  kw_for    = 'for';
+  kw_while  = 'while';
+  kw_until  = 'until';
+  kw_end    = 'end';
+
+  vchar   = alnum | '_';
+  const   = upper . vchar* . ('::' . alpha . vchar*)*;
+  var     = (lower | '_') . vchar*;
+  meth    = (alpha | '_') . vchar*;
+  symbol  = ':' . (var | const);
+  assoc   = '=>';
+  assgn   = '=';
+  comma   = ',';
+  label   = (var | const) . ':';
+
+  lparen  = '(';
+  rparen  = ')';
+  lbrace  = '{';
+  rbrace  = '}';
+  smcolon = ';';
+  newline = '\n';
+  bslash  = '\\' . newline;
+  ospaces = space* -- newline;
+  mspaces = space+ -- newline;
+
+}%%

data/lib/sourcify/{proc/scanner.rl → common/ragel/machines.rl}

@@ -1,70 +1,8 @@
-Sourcify.require_rb('proc', 'scanner', 'extensions')
-
-module Sourcify
-  module Proc
-    module Scanner #:nodoc:all
-
 %%{
-  machine proc_scanner;
-
-  kw_class  = 'class';
-  kw_module = 'module';
-  kw_def    = 'def';
-  kw_begin  = 'begin';
-  kw_case   = 'case';
-  kw_if     = 'if';
-  kw_unless = 'unless';
-  kw_do     = 'do';
-  kw_then   = 'then';
-  kw_for    = 'for';
-  kw_while  = 'while';
-  kw_until  = 'until';
-  kw_end    = 'end';
-
-  vchar   = alnum | '_';
-  const   = upper . vchar* . ('::' . alpha . vchar*)*;
-  var     = (lower | '_') . vchar*;
-  meth    = (alpha | '_') . vchar*;
-  symbol  = ':' . (var | const);
-  assoc   = '=>';
-  assgn   = '=';
-  comma   = ',';
-  label   = (var | const) . ':';
+  machine common_machines;
 
-  lparen  = '(';
-  rparen  = ')';
-  lbrace  = '{';
-  rbrace  = '}';
-  smcolon = ';';
-  newline = '\n';
-  bslash  = '\\' . newline;
-  ospaces = space* -- newline;
-  mspaces = space+ -- newline;
-
-  ## MACHINE >> New statement
-  new_statement := |*
-
-    (kw_for | kw_while | kw_until) . ^vchar => {
-      push(:kw_do_alias2, ts, te)
-      increment_counter(:do_end, 0..1)
-      fgoto main;
-    };
-
-    (
-      ((kw_class | kw_module | kw_def | kw_begin | kw_case | kw_if | kw_unless) . ^vchar) |
-      (kw_class . ospaces . '<<' . ospaces . ^newline+)
-    ) => {
-      push(:kw_do_alias1, ts, te)
-      increment_counter(:do_end, 1)
-      fgoto main;
-    };
-
-    ospaces => { push(:space, ts, te) };
-    any => { fhold; fgoto main; };
-
-  *|;
+## MACHINE >> One-liner comment
 
-  ## MACHINE >> One-liner comment
   per_line_comment := |*
     ^newline* => {
       push(:comment, ts.pred, te)
@@ -72,7 +10,8 @@ module Sourcify
     };
   *|;
 
-  ## MACHINE >> Block comment
+## MACHINE >> Block comment
+
   block_comment := |*
     any* . newline . '=end' . ospaces . ^newline* => {
       unless push_comment(ts, te)
@@ -81,7 +20,8 @@ module Sourcify
     };
   *|;
 
-  ## MACHINE >> Heredoc
+## MACHINE >> Heredoc
+
   heredoc := |*
     ^newline* . newline . ospaces . ^newline+ => {
       unless push_heredoc(ts, te)
@@ -90,7 +30,8 @@ module Sourcify
     };
   *|;
 
-  ## MACHINE >> String
+## MACHINE >> String
+
   string := |*
 
     sqm = '%q' | '%w';
@@ -174,7 +115,8 @@ module Sourcify
     };
   *|;
 
-  ## MACHINES >> Double quote strings
+## MACHINES >> Double quote strings
+
   dstring1 := |*
     [^\"]*[\"] => {
       unless push_dstring(ts, te)
@@ -372,114 +314,4 @@ module Sourcify
     };
   *|;
 
-  ## MACHINE >> Main
-  main := |*
-
-    ## == Start/end of do..end block
-
-    kw_do => {
-      push(:kw_do, ts, te)
-      increment_counter(:do_end)
-      fgoto new_statement;
-    };
-
-    kw_end => {
-      push(:kw_end, ts, te)
-      decrement_counter(:do_end)
-    };
-
-    ## == Start/end of {...} block
-
-    lbrace => {
-      push(:lbrace, ts, te)
-      increment_counter(:brace)
-    };
-
-    rbrace => {
-      push(:rbrace, ts, te)
-      decrement_counter(:brace)
-    };
-
-    assoc => {
-      push(:assoc, ts, te)
-      fix_counter_false_start(:brace)
-    };
-
-    label => {
-      push_label(ts, te)
-      fix_counter_false_start(:brace)
-    };
-
-    ## == New statement
-
-    newline => {
-      push(:newline, ts, te)
-      increment_lineno
-      fgoto new_statement;
-    };
-
-    smcolon | lparen | assgn | kw_then | comma => {
-      push(:newline_alias, ts, te)
-      fgoto new_statement;
-    };
-
-    ## == Comment
-
-    '#' => {
-      fgoto per_line_comment;
-    };
-
-    newline . '=begin' . ospaces . (ospaces . ^newline+)* . newline => {
-      push_comment(ts, te)
-      increment_lineno
-      fgoto block_comment;
-    };
-
-    ## == Strings
-
-    ('<<' | '<<-') . ["']? . (const | var) . ["']? . newline => {
-      push_heredoc(ts, te)
-      increment_lineno
-      fgoto heredoc;
-    };
-
-    ('"' | "'" | '`' | '%') => {
-      fhold; fgoto string;
-    };
-
-    '/' => {
-      if preceded_with?(:char, :digit, :var, :const, :symbol, :dstring, :sstring, ')', ']', '}')
-        push(:op, ts, te)
-      else
-        fhold; fgoto string;
-      end
-    };
-
-    ## == Misc
-
-    var         => { push(:var, ts, te) };
-    bslash      => { push(:bslash, ts, te) };
-    const       => { push(:const, ts, te) };
-    symbol      => { push(:symbol, ts, te) };
-    mspaces     => { push(:space, ts, te) };
-    [0-9]       => { push(:digit, ts, te) };
-    lower       => { push(:char, ts, te) };
-    any         => { push(:any, ts, te) };
-
-  *|;
-
 }%%
-%% write data;
-
-      extend Scanner::Extensions
-
-      def self.execute!
-        data = @data
-        eof = data.length
-        %% write init;
-        %% write exec;
-      end
-
-    end
-  end
-end

data/lib/sourcify/errors.rb

@@ -0,0 +1,4 @@
+module Sourcify
+  class ParserInternalError < Exception; end
+  class CannotParseEvalCodeError < Exception; end
+end

data/lib/sourcify/method.rb

@@ -0,0 +1,134 @@
+module Sourcify
+
+  class MultipleMatchingMethodsPerLineError < Exception; end
+  class NoMatchingMethodError < Exception; end
+  class CannotFindSourceLocationError < Exception; end
+  class PlatformNotSupportedError < Exception; end
+
+  IS_PLATFORM_SUPPORTED =
+    begin
+      [:source_location, :parameters].each{|meth| 1.method(:to_s).send(meth) }
+      raise PlatformNotSupportedError if RUBY_PLATFORM =~ /java/i
+      true
+    rescue NoMethodError, PlatformNotSupportedError
+      false
+    end
+
+  module Method
+
+    def self.included(base) #:nodoc:
+      base.class_eval do
+        Sourcify.require_rb('method', 'methods')
+        include Methods::ToSource
+        include Methods::ToSexp
+        include Methods::ToRawSource
+      end
+    end
+
+    module Stubs
+
+      ###
+      # Returns the code representation of this method. Unlike Method#to_raw_source,
+      # the returned code retains only the functional aspects, fluff like comments
+      # are stripped off.
+      #
+      #   class MyMath
+      #     def self.sum(x, y)
+      #       x + y # (blah)
+      #     end
+      #   end
+      #
+      #   MyMath.method(:sum).to_source
+      #   # >> "def sum(x, y)
+      #   # >>   (x + y)
+      #   # >> end"
+      #
+      # This works for method defined via Module#define_method as well. The following
+      # approach of defining method yields exactly the same result as above:
+      #
+      #   class MyMath
+      #     class << self
+      #       define_method(:sum) do |x,y|
+      #         x + y # (blah)
+      #       end
+      #     end
+      #   end
+      #
+      #   MyMath.method(:sum).to_source
+      #   # >> "def sum(x, y)
+      #   # >>   (x + y)
+      #   # >> end"
+      #
+      # The following options are supported:
+      #
+      # * +:strip_enclosure+ when set to true, strips the method enclosure to get
+      #   just the meat within.
+      #
+      #     MyMath.method(:sum).to_source(:strip_enclosure => true)
+      #     # >> "(x + y)"
+      #
+      # * +:attached_to+ is useful ONLY when a method is defined via
+      #   Module#define_method, pls see Sourcify::Proc::Stubs#to_source for more info.
+      #
+      # * +:ignore_nested+ is useful ONLY when a method is defined via
+      #   Module#define_method, pls see Sourcify::Proc::Stubs#to_source for more info.
+      #
+      # * an optional +body_matcher+ block is supported as well, again this is ONLY
+      #   useful for method defined via Module#define_method, pls see
+      #   Sourcify::Proc::Stubs#to_source for more info.
+      #
+      def to_source(opts={}, &body_matcher)
+        # NOTE: this is a stub for the actual one in Methods::ToSource
+      end
+
+      ###
+      # Returns the S-expression representation of this method.
+      #
+      #   class MyMath
+      #     def self.sum(x, y)
+      #       x + y # (blah)
+      #     end
+      #   end
+      #
+      #   MyMath.method(:sum).to_sexp
+      #   >> s(:defn,
+      #   >>  :sum,
+      #   >>  s(:args, :x, :y),
+      #   >>  s(:scope, s(:block, s(:call, s(:lvar, :x), :+, s(:arglist, s(:lvar, :y))))))
+      #
+      # This works for methods defined via Module#define_method as well. Pls see
+      # #to_source for options/arguments supported.
+      #
+      def to_sexp(opts={}, &body_matcher)
+        # NOTE: this is a stub for the actual one in Methods::ToSexp
+      end
+
+      ###
+      # Returns the raw code enclosed within this method.
+      #
+      #   class MyMath
+      #     def self.sum(x, y)
+      #       x + y # (blah)
+      #     end
+      #   end
+      #
+      #   MyMath.method(:sum).to_raw_source
+      #   >> "def sum(x, y)
+      #   >>   x + y # (blah)
+      #   >> end"
+      #
+      # This works for methods defined via Module#define_method as well. Pls see
+      # #to_source for options/arguments supported.
+      #
+      def to_raw_source(opts={}, &body_matcher)
+        # NOTE: this is a stub for the actual one in Methods::ToRawSource
+      end
+
+    end
+
+  end
+end
+
+Method.class_eval do
+  include Sourcify::Method
+end