code_output 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format d
+--order random

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - ruby-head
+  - rbx
+matrix:
+  allow_failures:
+    - rvm: rbx

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# CodeOutput [![Build Status](https://secure.travis-ci.org/infertux/code_output.png)](http://travis-ci.org/#!/infertux/code_output)
+
+Inject a script output into the source file as comments.
+This is particularly useful to generate code examples.
+
+## Usage
+
+### Command line
+
+```bash
+code_output example.rb
+```
+
+### Library
+
+```ruby
+# example.rb
+
+class Example
+
+  def initialize
+    p __method__
+  end
+
+  p __method__
+
+end
+
+Example.new
+```
+
+```ruby
+parser = CodeOutput::Parser.new "example.rb"
+parser.run # executes the script
+
+parser.raw_output #=> "nil\n:initialize\n"
+parser.file_with_output #=> "# example.rb\n\nclass Example\n\n  def initialize\n    p __method__ #=> :initialize\n  end\n\n  p __method__ #=> nil\n\nend\n\nExample.new\n"
+
+parser.dump 'example_with_output.rb' # writes file_with_output into the given file
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'code_output'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install code_output
+
+## License
+
+MIT
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+

data/bin/code_output

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'code_output'
+
+if ARGV.size != 1
+  $stderr.puts "#{File.basename(__FILE__)} takes exactly one argument."
+  exit 1
+end
+
+filename = ARGV[0]
+
+parser = CodeOutput::Parser.new filename
+parser.run
+puts parser.file_with_output
+

data/code_output.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'code_output/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "code_output"
+  gem.version       = CodeOutput::VERSION
+  gem.authors       = ["Cédric Félizard"]
+  gem.email         = ["cedric@felizard.fr"]
+  gem.description   = %q{Inject a script output into the source file as comments.}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/infertux/code_output"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+end

data/lib/code_output/version.rb

@@ -0,0 +1,3 @@
+module CodeOutput
+  VERSION = "0.0.1"
+end

data/lib/code_output.rb

@@ -0,0 +1,71 @@
+require "code_output/version"
+require "stringio"
+
+module CodeOutput
+
+  class Parser
+
+    def initialize filename
+      @filename = File.expand_path(filename)
+      raise IOError, "`#{filename}' is not readable" unless File.readable? filename
+
+      @old_stdout = $stdout
+
+      $stdout = StringIO.new
+      $stdout.instance_eval do
+        class << self
+          attr_accessor :outputs
+
+          alias_method :old_write, :write
+
+          def write string
+            (@outputs ||= []) << { line: caller.first, string: string }
+
+            old_write string
+          end
+        end
+      end
+    end
+
+    def capture_output
+      load @filename
+
+      $stdout.close_write
+      @output_stream = $stdout
+      @output_stream.rewind
+
+      $stdout = @old_stdout
+    end
+    alias_method :run, :capture_output
+
+    def dump filename
+      File.open(filename, 'w') do |file|
+        file.write file_with_output
+      end
+    end
+
+    def raw_output
+      @output_stream.string
+    end
+
+    def file_with_output
+      inject_output unless @file_with_output
+      @file_with_output.join
+    end
+
+  private
+    def inject_output
+      @file_with_output = IO.readlines(@filename)
+
+      @output_stream.outputs.each do |output|
+        next if output[:string] == "\n"
+
+        match = output[:line].match(/\A#{@filename}:(?<line_no>\d+):/)
+        line_no = match[:line_no].to_i - 1
+        @file_with_output[line_no].rstrip!
+        @file_with_output[line_no] << " \#=> #{output[:string]}\n"
+      end
+    end
+  end
+end
+

data/spec/assets/catch.dump.rb

@@ -0,0 +1,8 @@
+def routine(n)
+  puts n #=> 3 #=> 2 #=> 1 #=> 0
+  throw :done if n < 1
+  routine(n-1)
+end
+
+catch(:done) { routine(3) }
+

data/spec/assets/catch.output.rb

@@ -0,0 +1,4 @@
+3
+2
+1
+0

data/spec/assets/catch.rb

@@ -0,0 +1,8 @@
+def routine(n)
+  puts n
+  throw :done if n < 1
+  routine(n-1)
+end
+
+catch(:done) { routine(3) }
+

data/spec/assets/coffee_machine.dump.rb

@@ -0,0 +1,28 @@
+class CoffeeMachine
+
+  # block
+  # comment
+
+  def initialize # inline comment
+    p __method__ #=> :initialize
+    # noop
+    # noop
+  end
+
+  def make!
+    p __method__ #=> :make!
+    puts "DONE" #=> DONE
+  end
+
+  def sugar?
+    false
+  end
+
+  p __method__ #=> nil
+
+end
+
+cm = CoffeeMachine.new
+cm.make!
+p cm.sugar? # nope #=> false
+

data/spec/assets/coffee_machine.output.rb

@@ -0,0 +1,5 @@
+nil
+:initialize
+:make!
+DONE
+false

data/spec/assets/coffee_machine.rb

@@ -0,0 +1,28 @@
+class CoffeeMachine
+
+  # block
+  # comment
+
+  def initialize # inline comment
+    p __method__
+    # noop
+    # noop
+  end
+
+  def make!
+    p __method__
+    puts "DONE"
+  end
+
+  def sugar?
+    false
+  end
+
+  p __method__
+
+end
+
+cm = CoffeeMachine.new
+cm.make!
+p cm.sugar? # nope
+

data/spec/assets/inheritance.dump.rb

@@ -0,0 +1,17 @@
+class Bird
+  def has_wings?
+    true
+  end
+end
+
+class Duck < Bird
+  def quack
+    puts "QUACK!" #=> QUACK! #=> QUACK!
+  end
+end
+
+duck = Duck.new
+p duck.has_wings? #=> true
+duck.quack
+Duck.new.quack
+

data/spec/assets/inheritance.output.rb

@@ -0,0 +1,3 @@
+true
+QUACK!
+QUACK!

data/spec/assets/inheritance.rb

@@ -0,0 +1,17 @@
+class Bird
+  def has_wings?
+    true
+  end
+end
+
+class Duck < Bird
+  def quack
+    puts "QUACK!"
+  end
+end
+
+duck = Duck.new
+p duck.has_wings?
+duck.quack
+Duck.new.quack
+

data/spec/assets/simple.dump.rb

@@ -0,0 +1,3 @@
+puts "puts" #=> puts
+p "p" #=> "p"
+$stdout.puts "$stdout.puts" #=> $stdout.puts

data/spec/assets/simple.output.rb

@@ -0,0 +1,3 @@
+puts
+"p"
+$stdout.puts

data/spec/assets/simple.rb

@@ -0,0 +1,3 @@
+puts "puts"
+p "p"
+$stdout.puts "$stdout.puts"

data/spec/code_output_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'tempfile'
+
+def assets
+  dump_files = File.expand_path("../assets/*.dump.rb", __FILE__)
+
+  Dir[dump_files].each do |dump_file|
+    asset = {
+      dump_file: dump_file,
+      source_file: dump_file.sub(/.dump(.rb)\Z/, '\1'),
+      output_file: dump_file.sub(/.dump(.rb)\Z/, '.output\1')
+    }
+
+    yield asset, File.basename(asset[:source_file])
+  end
+end
+
+describe CodeOutput do
+
+  describe "#initialize" do
+    it "raises IOError if the input file is not readable" do
+      expect {
+        CodeOutput::Parser.new '/etc/shadow'
+      }.to raise_error IOError
+    end
+  end
+
+  [
+    [:file_with_output, :dump_file],
+    [:raw_output,       :output_file]
+  ].each do |method, file|
+
+    describe "##{method}" do
+      assets do |asset, filename|
+        it "returns the expected output for #{filename}" do
+          parser = CodeOutput::Parser.new asset[:source_file]
+          parser.run
+
+          got = parser.__send__ method
+          expected = File.open(asset[file]).read
+
+          got.should eq expected
+        end
+      end
+    end
+
+  end
+
+  describe "#dump" do
+    assets do |asset, filename|
+      it "writes the expected contents for #{filename}" do
+        parser = CodeOutput::Parser.new asset[:source_file]
+        parser.run
+
+        temp_file = Tempfile.new('tmp')
+
+        begin
+          parser.dump(temp_file.path)
+
+          FileUtils.identical?(asset[:dump_file], temp_file).should be_true
+        ensure
+          temp_file.unlink
+        end
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'simplecov'
+SimpleCov.start do
+  minimum_coverage 100
+  add_group "Sources", "lib"
+  add_group "Tests", "spec"
+end
+
+require 'code_output'
+

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: code_output
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Cédric Félizard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Inject a script output into the source file as comments.
+email:
+- cedric@felizard.fr
+executables:
+- code_output
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/code_output
+- code_output.gemspec
+- lib/code_output.rb
+- lib/code_output/version.rb
+- spec/assets/catch.dump.rb
+- spec/assets/catch.output.rb
+- spec/assets/catch.rb
+- spec/assets/coffee_machine.dump.rb
+- spec/assets/coffee_machine.output.rb
+- spec/assets/coffee_machine.rb
+- spec/assets/inheritance.dump.rb
+- spec/assets/inheritance.output.rb
+- spec/assets/inheritance.rb
+- spec/assets/simple.dump.rb
+- spec/assets/simple.output.rb
+- spec/assets/simple.rb
+- spec/code_output_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/infertux/code_output
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Inject a script output into the source file as comments.
+test_files:
+- spec/assets/catch.dump.rb
+- spec/assets/catch.output.rb
+- spec/assets/catch.rb
+- spec/assets/coffee_machine.dump.rb
+- spec/assets/coffee_machine.output.rb
+- spec/assets/coffee_machine.rb
+- spec/assets/inheritance.dump.rb
+- spec/assets/inheritance.output.rb
+- spec/assets/inheritance.rb
+- spec/assets/simple.dump.rb
+- spec/assets/simple.output.rb
+- spec/assets/simple.rb
+- spec/code_output_spec.rb
+- spec/spec_helper.rb