mynyml-simple_example 0.1

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright © 2009 Martin Aumont (mynyml)
+
+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

@@ -0,0 +1,25 @@
+Add easy fancy-pants examples to your projects.
+
+running:
+
+  require 'lib/simple_example'
+  include SimpleExample
+
+  example do
+    x = 1 + 1
+    y = 2 + 2
+    x + y
+  end
+
+outputs:
+
+  x = (1 + 1)
+  #=> 2
+  y = (2 + 2)
+  #=> 4
+  (x + y)
+  #=> 6
+
+Easy. Fancy.
+
+There are a few neat options to tweak the formatting. See the examples.rb file.

data/Rakefile

@@ -0,0 +1,64 @@
+# --------------------------------------------------
+# tasks mostly copied from thin's Rakefile
+# http://github.com/macournoyer/thin/tree/master
+# --------------------------------------------------
+require 'rake/gempackagetask'
+require 'pathname'
+require 'yaml'
+
+RUBY_1_9  = RUBY_VERSION =~ /^1\.9/
+WIN       = (RUBY_PLATFORM =~ /mswin|cygwin/)
+SUDO      = (WIN ? "" : "sudo")
+ROOT      = Pathname(__FILE__).dirname.expand_path
+
+def gem
+  RUBY_1_9 ? 'gem19' : 'gem'
+end
+
+def all_except(paths)
+  Dir['**/*'] - paths.map {|path| path.strip.gsub(/^\//,'').gsub(/\/$/,'') }
+end
+
+def gitignored
+  ROOT.join('.gitignore').read.strip.split("\n").compact.map {|line| line.strip }
+end
+
+spec = Gem::Specification.new do |s|
+  s.name            = 'simple_example'
+  s.version         = '0.1'
+  s.summary         = "Add easy fancy-pants examples to your projects."
+  s.description     = "Add easy fancy-pants examples to your projects."
+  s.author          = "Martin Aumont"
+  s.email           = 'mynyml@gmail.com'
+  s.homepage        = ''
+  s.has_rdoc        = true
+  s.require_path    = "lib"
+  s.files           = all_except(gitignored << 'generate_examples_results.rb')
+
+  s.add_dependency 'ruby2ruby'
+  s.add_dependency 'ParseTree'
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+end
+
+
+desc "Remove package products"
+task :clean => :clobber_package
+
+desc "Update the gemspec for GitHub's gem server"
+task :gemspec do
+  Pathname("#{spec.name}.gemspec").open('w') {|f| f << YAML.dump(spec) }
+end
+
+desc "Install gem"
+task :install => [:clobber, :package] do
+  sh "#{SUDO} #{gem} install pkg/#{spec.full_name}.gem"
+end
+
+desc "Uninstall gem"
+task :uninstall => :clean do
+  sh "#{SUDO} #{gem} uninstall -v #{spec.version} -x #{spec.name}"
+end
+

data/TODO

@@ -0,0 +1,3 @@
+o compact style should keep constant width for source string (so that results align)
+o formatting settings as options to example method?
+o add optional terminal colours?

data/examples.rb

@@ -0,0 +1,97 @@
+require 'lib/simple_example'
+include SimpleExample
+
+
+SEP = '-'*10
+SimpleExample::Format.separator = SEP
+
+puts SEP
+
+# simple
+example do
+  1 + 1
+end
+
+# less simple
+example do
+  [1.4, 2.4, 3.4].map(&:floor)
+end
+
+# returns last statement
+result = example { 1 + 1 }
+puts "previous result: #{result}"
+
+puts SEP
+
+# multiple statements
+example do
+  arr = %w( a b c )
+  arr.each {|x| x.upcase! }
+  arr.map  {|x| x << 'y'  }
+end
+
+# irb style:
+SimpleExample::Format.source_prefix = '>> '
+SimpleExample::Format.result_prefix = '=> '
+
+example { 1 + 1; 2 + 2 }
+
+# python shell style:
+SimpleExample::Format.source_prefix = '>>> '
+SimpleExample::Format.result_prefix = ''
+
+example { 1 + 1; 2 + 2 }
+
+# io shell style
+SimpleExample::Format.source_prefix = 'rb> '
+SimpleExample::Format.result_prefix = '==> '
+
+example { 1 + 1; 2 + 2 }
+
+# compact:
+SimpleExample::Format.source_prefix = ''
+SimpleExample::Format.result_prefix = '#=> '
+SimpleExample::Format.compact = true
+
+example { 1 + 1; 2 + 2 }
+
+
+__END__
+OUTPUT:
+----------
+(1 + 1)
+#=> 2
+----------
+[1.4, 2.4, 3.4].map(&:floor)
+#=> [1, 2, 3]
+----------
+(1 + 1)
+#=> 2
+----------
+previous result: 2
+----------
+arr = ["a", "b", "c"]
+#=> ["a", "b", "c"]
+arr.each { |x| x.upcase! }
+#=> ["A", "B", "C"]
+arr.map { |x| (x << "y") }
+#=> ["Ay", "By", "Cy"]
+----------
+>> (1 + 1)
+=> 2
+>> (2 + 2)
+=> 4
+----------
+>>> (1 + 1)
+2
+>>> (2 + 2)
+4
+----------
+rb> (1 + 1)
+==> 2
+rb> (2 + 2)
+==> 4
+----------
+(1 + 1) #=> 2
+(2 + 2) #=> 4
+----------

data/lib/simple_example.rb

@@ -0,0 +1,54 @@
+require 'pathname'
+require 'rubygems'
+require 'ruby2ruby'
+require 'parse_tree'
+require 'parse_tree_extensions'
+
+module SimpleExample
+  extend self
+
+  class Format
+    class << self
+      attr_accessor :source_prefix
+      attr_accessor :result_prefix
+      attr_accessor :separator
+      attr_accessor :compact
+
+      def source_prefix
+        @source_prefix || ''
+      end
+
+      def result_prefix
+        @result_prefix || '#=> '
+      end
+
+      def separator
+        @separator || ''
+      end
+
+      def compact?
+        !!@compact
+      end
+    end
+  end
+
+  def example(&block)
+    result = block.call
+
+    statement = block.to_ruby
+    statement.gsub!(/\Aproc \{/,'')
+    statement.gsub!(/\}\Z/,'')
+
+    lines = statement.strip.split(/\n/)
+    lines.each do |line|
+      src_str = Format.source_prefix + line.strip
+      res_str = Format.result_prefix + eval(line.strip, block.binding, Pathname(__FILE__).basename, __LINE__).inspect
+      sep_str = Format.compact? ? " " : "\n"
+
+      Kernel.puts "#{src_str}#{sep_str}#{res_str}"
+    end
+    Kernel.puts Format.separator unless Format.separator.empty?
+
+    result
+  end
+end

data/simple_example.gemspec

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: simple_example
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Martin Aumont
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-02 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby2ruby
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ParseTree
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Add easy fancy-pants examples to your projects.
+email: mynyml@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib
+- lib/simple_example.rb
+- simple_example.gemspec
+- README
+- Rakefile
+- test
+- test/test_helper.rb
+- test/output_helper.rb
+- test/test_simple_example.rb
+- examples.rb
+- MIT-LICENSE
+- TODO
+has_rdoc: true
+homepage: ""
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Add easy fancy-pants examples to your projects.
+test_files: []
+

data/test/output_helper.rb

@@ -0,0 +1,24 @@
+module OutputHelper
+
+  def assert_output(expected, &block)
+    keep_stdout do |stdout|
+      block.call
+      if expected.is_a?(Regexp)
+        assert_match expected, stdout.string
+      else
+        stdout.string.should be(expected.to_s)
+      end
+    end
+  end
+
+  def keep_stdout(&block)
+    begin
+      orig_stream, $stdout = $stdout, StringIO.new
+      block.call($stdout)
+    ensure
+      s, $stdout = $stdout.string, orig_stream
+      s
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+require 'test/unit'
+require 'rubygems'
+require 'context'
+require 'matchy'
+require 'unindent'
+require 'mocha'
+begin
+  require 'ruby-debug'
+  require 'quietbacktrace'
+rescue LoadError, RuntimeError
+end
+
+class Test::Unit::TestCase
+end

data/test/test_simple_example.rb

@@ -0,0 +1,127 @@
+require 'pathname'
+root  =  Pathname(__FILE__).dirname.parent.expand_path
+require root.join('test/test_helper.rb')
+require root.join('test/output_helper.rb')
+require root.join('lib/simple_example.rb')
+
+class String
+  # name isn't so intuitive; maybe to_exact_regexp ?
+  def to_regexp
+    Regexp.new(Regexp.escape(self))
+  end
+end
+
+class SimpleExampleTest < Test::Unit::TestCase
+  include SimpleExample
+  include OutputHelper
+
+  context "SimpleExample" do
+    def reset_config!
+      SimpleExample::Format.instance_variable_set(:@source_prefix, nil)
+      SimpleExample::Format.instance_variable_set(:@result_prefix, nil)
+      SimpleExample::Format.instance_variable_set(:@separator, nil)
+      SimpleExample::Format.instance_variable_set(:@compact, nil)
+    end
+
+    before do
+      reset_config!
+
+      # shortcuts
+      @sp = SimpleExample::Format.source_prefix
+      @rp = SimpleExample::Format.result_prefix
+    end
+
+    test "can be called from original scope" do
+      Kernel.stubs(:puts)
+      lambda { SimpleExample.example {} }.should_not raise_error(NoMethodError)
+    end
+    context "evaluation" do
+      test "returns result" do
+        Kernel.stubs(:puts)
+        example { 1+1 }.should be(2)
+      end
+    end
+    context "output" do
+      test "prints statement's source" do
+        assert_output('(1 + 1)'.to_regexp) { example { 1+1 } }
+      end
+      test "prints statement's result" do
+        assert_output(/2/) { example { 1+1 } }
+      end
+      test "prints every step's source + result" do
+        out = <<-STR.unindent
+          #{@sp}(1 + 1)
+          #{@rp}2
+          #{@sp}(3 + 3)
+          #{@rp}6
+        STR
+        assert_output(out) do
+          example { 1+1; 3+3 }
+        end
+      end
+      test "doesn't strip closing brakets" do
+        Kernel.stubs(:puts)
+
+        lambda {
+          example do
+            arr = %w( a b c )
+            arr.each {|x| x.upcase! }
+          end
+        }.should_not raise_error(SyntaxError)
+      end
+    end
+    context "formating" do
+      test "prepends source lines with marker" do
+        SimpleExample::Format.source_prefix = '>   '
+        assert_output('>   (1 + 1)'.to_regexp) { example { 1+1 } }
+      end
+      test "prepends result lines with marker" do
+        SimpleExample::Format.result_prefix = '#=> '
+        assert_output('#=> 2'.to_regexp) { example { 1+1 } }
+      end
+      test "default source marker" do
+        SimpleExample::Format.source_prefix.should be('')
+      end
+      test "default result marker" do
+        SimpleExample::Format.result_prefix.should be('#=> ')
+      end
+      test "custom source marker" do
+        SimpleExample::Format.source_prefix = '|   '
+        assert_output('|   (1 + 1)'.to_regexp) { example { 1+1 } }
+      end
+      test "custom result marker" do
+        SimpleExample::Format.result_prefix = '|=> '
+        assert_output('|=> 2'.to_regexp) { example { 1+1 } }
+      end
+      test "seperator marker" do
+        SimpleExample::Format.separator = '-'*10
+
+        out = <<-STR.unindent
+          #{@sp}(1 + 1)
+          #{@rp}2
+          #{@sp}(2 + 2)
+          #{@rp}4
+          ----------
+          #{@sp}(3 + 3)
+          #{@rp}6
+          ----------
+        STR
+        assert_output(out) do
+          example { 1+1; 2+2 }
+          example { 3+3 }
+        end
+      end
+      test "compact output" do
+        SimpleExample::Format.compact = true
+
+        out = <<-STR.unindent
+          #{@sp}(1 + 1) #{@rp}2
+          #{@sp}(3 + 3) #{@rp}6
+        STR
+        assert_output(out) do
+          example { 1+1; 3+3 }
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: mynyml-simple_example
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Martin Aumont
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-01 21:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby2ruby
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ParseTree
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Add easy fancy-pants examples to your projects.
+email: mynyml@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib
+- lib/simple_example.rb
+- simple_example.gemspec
+- README
+- Rakefile
+- test
+- test/test_helper.rb
+- test/output_helper.rb
+- test/test_simple_example.rb
+- examples.rb
+- MIT-LICENSE
+- TODO
+has_rdoc: true
+homepage: ""
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Add easy fancy-pants examples to your projects.
+test_files: []
+