seeing_is_believing 0.0.9 → 0.0.10

data/spec/line_formatter_spec.rb

@@ -0,0 +1,53 @@
+require 'seeing_is_believing/binary/line_formatter'
+
+describe SeeingIsBelieving::Binary::LineFormatter do
+  def result_for(line, separator, result, options={})
+    described_class.new(line, separator, result, options).call
+  end
+
+  specify 'it returns the consolidated result if there are no truncations' do
+    result_for('1', '=>', '12345').should == '1=>12345'
+  end
+
+  specify 'result_length truncates a result to the specified length, using elipses up to that length if appropriate'  do
+    line      = '1'
+    separator = '=>'
+    result    = '12345'
+    result_for(line, separator, result, result_length: Float::INFINITY).should == '1=>12345'
+    result_for(line, separator, result, result_length: 7).should == '1=>12345'
+    result_for(line, separator, result, result_length: 6).should == '1=>1...'
+    result_for(line, separator, result, result_length: 5).should == '1=>...'
+    result_for(line, separator, result, result_length: 4).should == '1'
+    result_for(line, separator, result, result_length: 0).should == '1'
+  end
+
+  specify 'line_length truncates a result to the specified length, minus the length of the line' do
+    line      = '1'
+    separator = '=>'
+    result    = '12345'
+    result_for(line, separator, result).should == '1=>12345'
+    result_for(line, separator, result, line_length: Float::INFINITY).should == '1=>12345'
+    result_for(line, separator, result, line_length: 8).should == '1=>12345'
+    result_for(line, separator, result, line_length: 7).should == '1=>1...'
+    result_for(line, separator, result, line_length: 6).should == '1=>...'
+    result_for(line, separator, result, line_length: 5).should == '1'
+    result_for(line, separator, result, line_length: 0).should == '1'
+  end
+
+  specify 'source_length will alter the length that the line is displayed in' do
+    result_for('1', '=>', '2', source_length: 0).should == '1=>2'
+    result_for('1', '=>', '2', source_length: 1).should == '1=>2'
+    result_for('1', '=>', '2', source_length: 2).should == '1 =>2'
+  end
+
+  specify 'source_length is ignored when separator/result will not be printed' do
+    result_for('1', '=>', '12345', source_length: 2,   line_length: 2).should == '1'
+    result_for('1', '=>', '12345', source_length: 2, result_length: 2).should == '1'
+  end
+
+  specify 'they can all work together' do
+    result_for('1', '=>', '12345', line_length: 100, result_length: 100, source_length: 2).should == '1 =>12345'
+    result_for('1', '=>', '12345', line_length:   8, result_length: 100, source_length: 2).should == '1 =>1...'
+    result_for('1', '=>', '12345', line_length: 100, result_length:   6, source_length: 2).should == '1 =>1...'
+  end
+end

data/spec/seeing_is_believing_spec.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 require 'seeing_is_believing'
 require 'stringio'
 
@@ -198,13 +199,10 @@ describe SeeingIsBelieving do
     result.stdout.should == filename
   end
 
-  # this can be refactored to use invoke
-  specify 'cwd is the directory of the file' do
+  specify 'cwd of the file is the cwd of the evaluating program' do
     filename = File.join proving_grounds_dir, 'mah_file.rb'
     FileUtils.rm_f filename
-    result   = invoke 'print File.expand_path __FILE__', filename: filename
-    result   = invoke 'print File.expand_path(Dir.pwd)', filename: filename
-    result.stdout.should == proving_grounds_dir
+    invoke('print File.expand_path(Dir.pwd)', filename: filename).stdout.should == Dir.pwd
   end
 
   it 'does not capture output from __END__ onward' do
@@ -231,4 +229,11 @@ describe SeeingIsBelieving do
     values_for("1\n.even?").should == [[], ['false']]
     values_for("1\n.even?\n__END__").should == [[], ['false']]
   end
+
+  it 'does not record leading comments' do
+    values_for("# -*- coding: utf-8 -*-\n'ç'\n__LINE__").should == [[], ['"ç"'], ['3']]
+    values_for("=begin\n1\n=end\n=begin\n=end\n__LINE__").should == [[], [], [],
+                                                                     [], [],
+                                                                     ['6']]
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seeing_is_believing
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-04 00:00:00.000000000 Z
+date: 2013-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70151257454580 !ruby/object:Gem::Requirement
+  requirement: &70252880676580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 10.0.3
   type: :development
   prerelease: false
-  version_requirements: *70151257454580
+  version_requirements: *70252880676580
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70151257453880 !ruby/object:Gem::Requirement
+  requirement: &70252880675820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.12.0
   type: :development
   prerelease: false
-  version_requirements: *70151257453880
+  version_requirements: *70252880675820
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70151257449440 !ruby/object:Gem::Requirement
+  requirement: &70252880691520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.2.1
   type: :development
   prerelease: false
-  version_requirements: *70151257449440
+  version_requirements: *70252880691520
 - !ruby/object:Gem::Dependency
   name: ichannel
-  requirement: &70151257448960 !ruby/object:Gem::Requirement
+  requirement: &70252880691040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: 5.1.1
   type: :development
   prerelease: false
-  version_requirements: *70151257448960
+  version_requirements: *70252880691040
 description: Records the results of every line of code in your file (intended to be
   like xmpfilter), inspired by Bret Victor's JavaScript example in his talk "Inventing
   on Principle"
@@ -78,14 +78,15 @@ files:
 - features/step_definitions/steps.rb
 - features/support/env.rb
 - lib/seeing_is_believing.rb
-- lib/seeing_is_believing/arg_parser.rb
 - lib/seeing_is_believing/binary.rb
+- lib/seeing_is_believing/binary/arg_parser.rb
+- lib/seeing_is_believing/binary/line_formatter.rb
+- lib/seeing_is_believing/binary/print_results_next_to_lines.rb
 - lib/seeing_is_believing/error.rb
 - lib/seeing_is_believing/evaluate_by_moving_files.rb
 - lib/seeing_is_believing/expression_list.rb
 - lib/seeing_is_believing/hard_core_ensure.rb
 - lib/seeing_is_believing/has_exception.rb
-- lib/seeing_is_believing/print_results_next_to_lines.rb
 - lib/seeing_is_believing/queue.rb
 - lib/seeing_is_believing/result.rb
 - lib/seeing_is_believing/syntax_analyzer.rb
@@ -97,6 +98,7 @@ files:
 - spec/evaluate_by_moving_files_spec.rb
 - spec/expression_list_spec.rb
 - spec/hard_core_ensure_spec.rb
+- spec/line_formatter_spec.rb
 - spec/queue_spec.rb
 - spec/seeing_is_believing_spec.rb
 - spec/syntax_analyzer_spec.rb
@@ -135,6 +137,7 @@ test_files:
 - spec/evaluate_by_moving_files_spec.rb
 - spec/expression_list_spec.rb
 - spec/hard_core_ensure_spec.rb
+- spec/line_formatter_spec.rb
 - spec/queue_spec.rb
 - spec/seeing_is_believing_spec.rb
 - spec/syntax_analyzer_spec.rb

data/lib/seeing_is_believing/arg_parser.rb

@@ -1,94 +0,0 @@
-class SeeingIsBelieving
-  class ArgParser
-    def self.parse(args)
-      new(args).call
-    end
-
-    attr_accessor :args
-
-    def initialize(args)
-      self.args      = args
-      self.filenames = []
-    end
-
-    def call
-      @result ||= begin
-        until args.empty?
-          case (arg = args.shift)
-
-          # help screen
-          when '-h', '--help'
-            options[:help] = self.class.help_screen
-
-          # start line
-          when '-l', '--start-line'
-            start_line = args.shift
-            i_start_line = start_line.to_i
-            if i_start_line.to_s == start_line && !i_start_line.zero?
-              options[:start_line] = start_line.to_i
-            else
-              options[:errors] << "#{arg} expects a positive integer argument"
-            end
-
-          # end line
-          when '-L', '--end-line'
-            end_line = args.shift
-            if end_line.to_i.to_s == end_line
-              options[:end_line] = end_line.to_i
-            else
-              options[:errors] << "#{arg} expect an integer argument"
-            end
-
-          # unknown flags
-          when /^-/
-            options[:errors] << "Unknown option: #{arg.inspect}"
-
-          # filenames
-          else
-            filenames << arg
-            options[:filename] = arg
-          end
-        end
-        normalize_and_validate
-        options
-      end
-    end
-
-    private
-
-    attr_accessor :filenames
-
-    def normalize_and_validate
-      if 1 < filenames.size
-        options[:errors] << "Can only have one filename, but had: #{filenames.map(&:inspect).join ', '}"
-      end
-
-      if options[:end_line] < options[:start_line]
-        options[:start_line], options[:end_line] = options[:end_line], options[:start_line]
-      end
-    end
-
-    def options
-      @options ||= {
-        filename:     nil,
-        errors:       [],
-        start_line:   1,
-        end_line:     Float::INFINITY,
-      }
-    end
-  end
-
-  def ArgParser.help_screen
-<<HELP_SCREEN
-Usage: #{$0} [options] [filename]
-
-  #{$0} is a program and library that will evaluate a Ruby file and capture/display the results.
-
-  If no filename is provided, the binary will read the program from standard input.
-
-  -l, --start-line  # line number to begin showing results on
-  -L, --end-line    # line number to stop showing results on
-  -h, --help        # this help screen
-HELP_SCREEN
-  end
-end

data/lib/seeing_is_believing/print_results_next_to_lines.rb

@@ -1,117 +0,0 @@
-require 'seeing_is_believing'
-require 'seeing_is_believing/queue'
-require 'seeing_is_believing/has_exception'
-
-class SeeingIsBelieving
-  class PrintResultsNextToLines
-    include HasException
-
-       STDOUT_PREFIX = '# >>'
-       STDERR_PREFIX = '# !>'
-    EXCEPTION_PREFIX = '# ~>'
-       RESULT_PREFIX = '# =>'
-
-    def initialize(body, stdin, options={})
-      self.body       = remove_previous_output_from body
-      self.stdin      = stdin
-      self.filename   = options.fetch :filename,   nil
-      self.start_line = options.fetch :start_line
-      self.end_line   = options.fetch :end_line
-    end
-
-    def new_body
-      @new_body ||= ''
-    end
-
-    def call
-      evaluate_program
-      inherit_exception
-      add_each_line_until_start_or_data_segment
-      add_lines_with_results_until_end_or_data_segment
-      add_lines_until_data_segment
-      add_stdout
-      add_stderr
-      add_remaining_lines
-      return new_body
-    end
-
-    private
-
-    attr_accessor :body, :filename, :file_result, :stdin, :start_line, :end_line
-
-    def evaluate_program
-      self.file_result = SeeingIsBelieving.new(body, filename: filename, stdin: stdin).call
-    end
-
-    def inherit_exception
-      self.exception = file_result.exception
-    end
-
-    def add_each_line_until_start_or_data_segment
-      line_queue.until { |line, line_number| line_number == start_line || start_of_data_segment?(line) }
-                .each  { |line, line_number| new_body << line }
-    end
-
-    def add_lines_with_results_until_end_or_data_segment
-      line_queue.until { |line, line_number| end_line < line_number || start_of_data_segment?(line) }
-                .each  { |line, line_number| new_body << format_line(line.chomp, file_result[line_number]) }
-    end
-
-    def add_lines_until_data_segment
-      line_queue.until { |line, line_number| start_of_data_segment?(line) }
-                .each  { |line, line_number| new_body << line }
-    end
-
-    def add_remaining_lines
-      line_queue.each { |line, line_number| new_body << line }
-    end
-
-    def line_queue
-      @line_queue ||= Queue.new &body.each_line.with_index(1).to_a.method(:shift)
-    end
-
-    def start_of_data_segment?(line)
-      line.chomp == '__END__'
-    end
-
-    # max line length of the lines to output (exempting coments) + 2 spaces for padding
-    def line_length
-      @line_length ||= 2 + body.each_line
-                               .map(&:chomp)
-                               .select.with_index(1) { |line, index| start_line <= index && index <= end_line }
-                               .take_while { |line| not start_of_data_segment? line }
-                               .select { |line| not (line == "=begin") .. (line == "=end") }
-                               .reject { |line| SyntaxAnalyzer.ends_in_comment? line }
-                               .map(&:length)
-                               .max
-    end
-
-    def remove_previous_output_from(string)
-      string.gsub(/\s+(#{EXCEPTION_PREFIX}|#{RESULT_PREFIX}).*?$/, '')
-            .gsub(/\n?(^#{STDOUT_PREFIX}[^\n]*\r?\n?)+/m,          '')
-            .gsub(/\n?(^#{STDERR_PREFIX}[^\n]*\r?\n?)+/m,          '')
-    end
-
-    def add_stdout
-      return unless file_result.has_stdout?
-      new_body << "\n"
-      file_result.stdout.each_line { |line| new_body << "#{STDOUT_PREFIX} #{line}" }
-    end
-
-    def add_stderr
-      return unless file_result.has_stderr?
-      new_body << "\n"
-      file_result.stderr.each_line { |line| new_body << "#{STDERR_PREFIX} #{line}" }
-    end
-
-    def format_line(line, line_results)
-      if line_results.has_exception?
-        sprintf "%-#{line_length}s#{EXCEPTION_PREFIX} %s: %s\n", line, line_results.exception.class, line_results.exception.message
-      elsif line_results.any?
-        sprintf "%-#{line_length}s#{RESULT_PREFIX} %s\n", line, line_results.join(', ')
-      else
-        line + "\n"
-      end
-    end
-  end
-end