dokaz 0.0.3 → 0.0.5

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OTE0MmZmNzRmMjlkOGE1ZTFmNjRiYjUwYmU5ZDlhNzQzZGE2Mjc4Yg==
-  data.tar.gz: !binary |-
-    NTkxNjdlMDk0Mjk5NDZiYmU0ODBlMDE2YjUzYTJjMzliM2YyN2UyZg==
+SHA256:
+  metadata.gz: 523736088a32b27b2e16d362c0ebe5cb704eff2153cd6b07a98565b58fd7dc01
+  data.tar.gz: c86ec189e60c7eaa6f485ef6b5ee807e5bc245300cff3d759bfb1b9a270b37fd
 SHA512:
-  metadata.gz: !binary |-
-    MjI2NDRlZTJkYjlkNWQxYzA0N2UwYWZiZjA0YWYxNzgwZmFkNDJlMWVlNzA2
-    YWEyNDk0OTZkOGVmYjg5ZDcwNWIxYTc5OGM2ODMzNzRmNTljZTY3Y2VkOGM1
-    ZmEzZWM5Zjg1NjQ2ZmU2MWZhZTQwYWZjMjE1MDFiNmYzOGY5OGU=
-  data.tar.gz: !binary |-
-    Y2JmMGY4ODljN2QxZjE0ODA4ZDYwN2Y4Mjg0MmM1M2EwYWNkYjM1YTBjYzIw
-    YTU2MTYwMjllOTc1NzgyMzUyODQxZmIyN2Y1NWQyMWNlM2E3ZWFmZmFlNThk
-    OTcyMjVjMjE5ZmI3ZWUwYTZhZGM5MjE4MTEwYTM0MTA0OGU1ZGY=
+  metadata.gz: 31c454210e0d3f8dc5ed652975fe24408c76c2004e743acea40b15b9914b102f759d7e569ce3f0b219e876a7ec07e7773e8ecc79f36abb18e69ca7c0aa925111
+  data.tar.gz: b798d663c0acf6c223a90f638c28dec10b52fb2b0b4112bf95a43371cb1bff2b81cf30ea50d2069d01b0665ddb70646660faa3c36466877ebeca08693aa48e15

data/Changelog.md

@@ -0,0 +1,5 @@
+# Dokaz Changelog
+
+## 0.0.5 -- 2023-02-12
+
+* Make it Ruby 3.1-3.2 compatible (rather hacky, but seem to work)

data/bin/dokaz

@@ -5,13 +5,10 @@ require 'slop'
 $:.unshift 'lib'
 require 'dokaz'
 
-if File.exists?('.dokaz')
+if File.exist?('.dokaz')
   ARGV.push(*File.read('.dokaz').split(/\s+/m))
 end
 
-patterns = []
-patterns << ARGV.shift until ARGV.empty? || ARGV.first =~ /^-/
-
 HELP = %Q{
 Usage: dokaz [patterns] [options]
 
@@ -26,12 +23,19 @@ Options:
       --help         Shows this message
 }
 
+patterns = []
+patterns << ARGV.shift until ARGV.empty? || ARGV.first =~ /^-/
+
 options = Slop.parse do
   on :r, :require=, "Additional files to require, comma-separated"
   on :f, :format=, "Output format (spec or show[case])"
   on :help
 end
 
+if patterns.empty?
+  patterns.concat(Dir['README.{md,markdown}'])
+end
+
 if patterns.empty? || options.help?
   puts HELP
   exit

data/dokaz.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name     = 'dokaz'
-  s.version  = '0.0.3'
+  s.version  = '0.0.5'
   s.authors  = ['Victor Shepelev']
   s.email    = 'zverok.offline@gmail.com'
   s.homepage = 'https://github.com/zverok/dokaz'
@@ -24,7 +24,11 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'ansi'
   s.add_dependency 'slop', '~> 3'
+  s.add_dependency 'rouge', '~> 4'
 
   s.add_development_dependency 'rspec', '~> 3'
   s.add_development_dependency 'rspec-its', '~> 1'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rubygems-tasks'
 end

data/examples/README.md

@@ -51,13 +51,14 @@ puts a.sum(10)
 This code throws an error:
 
 ```ruby
+# It's a comment, but not seen while evaluating
 100 / 0
 ```
 
 This code requires additional require:
 
 ```ruby
-BigDecimal.new("0")
+BigDecimal.new('0')
 ```
 
 Try to run it with option `--require cgi`.

data/lib/dokaz/formatters.rb

@@ -1,8 +1,14 @@
 # encoding: utf-8
 require 'ansi/code'
+require 'rouge'
 
 class Dokaz
   class Formatter
+    def initialize
+      @rouge = Rouge::Formatters::Terminal256.new(Rouge::Themes::Molokai.new)
+      @lexer = Rouge::Lexers::Ruby.new
+    end
+    
     def start_block(block)
     end
 
@@ -35,6 +41,14 @@ class Dokaz
         color(:dark, str)
       end
 
+      def code(str)
+        if STDOUT.tty?
+          @rouge.format(@lexer.lex(str))
+        else
+          code
+        end
+      end
+
       def color(code, str)
         if STDOUT.tty?
           ANSI.send(code){str}
@@ -46,6 +60,7 @@ class Dokaz
   
   class SpecFormatter < Formatter
     def initialize
+      super
       @ok = 0
       @errors = []
     end
@@ -65,14 +80,14 @@ class Dokaz
       puts
       puts
 
-      @errors.each do |code, e|
-        puts code
+      @errors.each do |src, e|
+        puts code(src)
         puts( error("#{e.message} (#{e.class})\n  " + filter_backtrace(e.backtrace).join("\n  ") + "\n"))
       end
 
       puts
       @errors.each do |code, e|
-        ln = e.backtrace.first.sub(/:in .*$/, '')
+        ln = filter_backtrace(e.backtrace).last.to_s.sub(/:in .*$/, '')
         puts error("dokaz #{ln}") + comment(" # #{e.message} (#{e.class})")
       end
 
@@ -97,16 +112,16 @@ class Dokaz
       puts "#{block.caption}\n#{'=' * block.caption.size}\n\n"
     end
     
-    def output(code, res, out)
-      puts code
+    def output(src, res, out)
+      puts code(src)
       unless out.empty?
-        puts comment("# Prints: \n#  " + out.split("\n").join("\n#    "))
+        puts comment("# Prints: \n#  " + out.split("\n").join("\n#  "))
       end
       puts comment("# => " + res.inspect.split("\n").join("\n#    "))
     end
 
-    def output_err(code, e)
-      puts code
+    def output_err(src, e)
+      puts code(src)
       puts comment("# Throws: #{e.message} (#{e.class})")
     end
 

data/lib/dokaz/parser.rb

@@ -1,11 +1,48 @@
 # encoding: utf-8
 require 'strscan'
+require 'stringio'
 
 class Dokaz
+  class Statement
+    attr_reader :code, :line, :block
+    attr_reader :pre_comment
+    attr_accessor :comment
+
+    def initialize(code, line, block)
+      @raw_code, @line, @block = code, line, block
+      @comment = ''
+      
+      parse!
+    end
+
+    def empty?
+      code.empty?
+    end
+
+    private
+
+    def parse!
+      pre_lines = []
+      lines = @raw_code.split("\n")
+      while !lines.empty? && (lines.first =~ /^\s*\#/ || lines.first.strip.empty?)
+        pre_lines << lines.shift
+        @line += 1
+      end
+      @code = lines.join("\n")
+      @pre_comment = pre_lines.reject{|ln| ln.strip.empty?}.join("\n")
+    end
+  end
+  
   class Block
+    FakeIRBContext = Struct.new(:local_variables)
+
     attr_reader :code, :line, :file
+    attr_reader :statements
+
     def initialize(code, line, file)
       @code, @line, @file = code, line, file
+
+      parse!
     end
 
     def end_line
@@ -19,6 +56,35 @@ class Dokaz
     def inside?(ln)
       (line..end_line).cover?(ln)
     end
+
+    private
+
+    def parse!
+      @statements = []
+      lex = RubyLex.new
+
+      # We do unholy things by reusing IRB's internal helper classes.
+      # In 3.2 (ver.1.6), IRB changed them to be more complicated. I only had
+      # time to quick-hack it around with fake copies of object IRB use.
+      # It might fail anytime, but works on test examples :shrug:
+      if IRB::VERSION >= '1.6'
+        ctx = FakeIRBContext.new(local_variables: [])
+        lex.set_input(SpecIO.new(code), context: ctx)
+        lex.each_top_level_statement(ctx) do |st, line_no|
+          @statements << Statement.new(st, line + line_no, self)
+        end
+      else
+        lex.set_input(SpecIO.new(code))
+        lex.each_top_level_statement do |st, line_no|
+          @statements << Statement.new(st, line + line_no, self)
+        end
+      end
+
+      @statements.each_cons(2){|s1, s2|
+        s1.comment = s2.pre_comment
+      }
+      @statements.reject!(&:empty?)
+    end
   end
   
   class Parser
@@ -27,9 +93,11 @@ class Dokaz
     end
 
     def parse
-      res = []
+      blocks = []
       ln = 0
+      
       scanner = StringScanner.new(File.read(@path))
+
       loop do
         text = scanner.scan_until(/\n```ruby\n/)
         break unless text
@@ -37,14 +105,14 @@ class Dokaz
         ln += text.count("\n")
         code = scanner.scan_until(/\n```\n/)
         if !code
-          res << Block.new(scanner.rest, ln, @path)
+          blocks << Block.new(scanner.rest, ln, @path)
           break
         end
-        res << Block.new(code.sub(/```\Z/, ''), ln, @path)
+        blocks << Block.new(code.sub(/```\Z/, ''), ln, @path)
         ln += code.count("\n")
       end
 
-      res
+      blocks
     end
   end
 end

data/lib/dokaz.rb

@@ -11,6 +11,13 @@ class Dokaz
     'show' => ShowcaseFormatter,
     'showcase' => ShowcaseFormatter
   }
+
+  class << self
+    def before(&block)
+      return @before || ->(){} unless block
+      @before = block
+    end
+  end
   
   def initialize(patterns, options = {})
     @blocks = select_blocks(patterns)
@@ -23,6 +30,8 @@ class Dokaz
   end
 
   def run
+    self.class.before.call
+    
     puts "Running #{@blocks.count} blocks from #{@blocks.map(&:file).uniq.count} files\n\n"
     
     @blocks.each do |b|
@@ -36,17 +45,15 @@ class Dokaz
   private
 
     def process_block(block)
-      lex = RubyLex.new
-      lex.set_input(SpecIO.new(block.code))
-      lex.each_top_level_statement do |line, line_no|
+      block.statements.each do |st|
         begin
           res = nil
           out = capture_output{
-            res = eval(line, TOPLEVEL_BINDING, block.file, block.line + line_no)
+            res = eval(st.code, TOPLEVEL_BINDING, block.file, st.line)
           }
-          @formatter.output(line, res, out)
-        rescue => e
-          @formatter.output_err(line, e)
+          @formatter.output(st.code, res, out)
+        rescue Exception => e
+          @formatter.output_err(st.code, e)
           break
         end
       end

metadata

@@ -1,71 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: dokaz
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Victor Shepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-19 00:00:00.000000000 Z
+date: 2023-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ansi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: zverok.offline@gmail.com
 executables:
@@ -73,6 +115,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- Changelog.md
 - LICENSE.txt
 - README.md
 - bin/dokaz
@@ -94,19 +137,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Use your documentation as a specification
 test_files: []
-has_rdoc: