reflexive 0.0.3 → 0.0.4

data/spec/sexp_builder_with_scanner_events.rb

@@ -0,0 +1,39 @@
+require File.expand_path("../ripper_events_recorder", __FILE__)
+
+# reports scanner events as hashes
+class SexpBuilderWithScannerEvents < RipperEventsRecorder
+  SCANNER_EVENTS.each do |event|
+    module_eval(<<-End, __FILE__, __LINE__ + 1)
+      def on_#{event}(tok)
+        super
+        { :#{ event } => tok }
+      end
+    End
+  end
+
+  PARSER_EVENT_TABLE.each do |event, arity|
+    if /_new\z/ =~ event.to_s and arity == 0
+      module_eval(<<-End, __FILE__, __LINE__ + 1)
+        def on_#{event}
+          super
+          []
+        end
+      End
+    elsif /_add\z/ =~ event.to_s
+      module_eval(<<-End, __FILE__, __LINE__ + 1)
+        def on_#{event}(list, item)
+          super
+          list.push item
+          list
+        end
+      End
+    else
+      module_eval(<<-End, __FILE__, __LINE__ + 1)
+        def on_#{event}(*args)
+          super
+          [:#{event}, *args]
+        end
+      End
+    end
+  end
+end

data/spec/shell_out.rb

@@ -0,0 +1,417 @@
+# ## ShellOut
+#
+# Provides a convenient feature-rich way to "shell out" to external commands.
+# Most useful features come from using `PTY` to execute the command. Not available
+# on Windows, `Kernel#system` will be used instead.
+#
+# ## Features
+#
+# ### Interruption
+#
+# The external command can be easily interrupted and `Interrupt` exception
+# will propagate to the calling program.
+#
+# For example while something like this can hang your terminal
+#
+#     loop { system("ls -R /") } # => lists directories indefinitely,
+#                                # Ctrl-C only stops ls
+#
+# That won't be the case with ShellOut:
+#
+#     require "shell_out"
+#     include ShellOut
+#     loop { shell_out("ls -R /") } # => when Ctrl-C is pressed ls is terminated
+#                                   # and Interrupt exception is propagated
+#
+# Yes it's possible to examine the `$CHILD_STATUS.exitstatus` variable but that's
+# not nearly as robust and flexible as `PTY` solution. 
+#
+# ### TTY-like Output
+#
+# External command is running in pseudo TTY provided by `PTY` library on Unix,
+# which means that commands like `ffmpeg`, `git` can report progress and
+# **otherwise interact with user as usual**.
+#
+# ### Output Capturing
+#
+# Output of the command can be captured using `:out` option
+#
+#     io = StringIO.new
+#     shell_out("echo 42", :out => io) # doesn't print anything
+#     io.string.chomp # => "42"
+#
+# If `:out => :return` option is passed - the `shell_out` return the output
+# of the command instead of exit status.
+#
+# ### :raise_exceptions, :verbose, :noop, and :dry_run Options
+#
+# * `:raise_exceptions => true` will raise `ShellOutException` for any non-zero
+# exit status of the command
+#
+# Following options have the same semantics as `FileUtils` method options do
+#
+# * `:verbose => true` will echo command before execution
+#
+# * `:noop => true` will just return zero exit status without executing
+#   the command
+#
+# * `:dry_run => true` equivalent to `:verbose => true, :noop => true`
+#
+module ShellOut
+  class ShellOutException < Exception
+  end
+
+  CTRL_C_CODE = ?\C-c
+  SUCCESS_EXIT_STATUS = 0
+
+  class << self
+    def before(*args)
+      if args.last.is_a?(Hash)
+        options = args.last
+        
+        verbose, dry_run, noop = options.delete(:verbose), options.delete(:dry_run), options.delete(:noop)
+        verbose = noop = true if dry_run
+
+        puts "Executing: #{ args[0..-2].join(" ") }" if verbose
+
+        return false if noop
+      end
+
+      true
+    end
+
+    def after(exitstatus, out_stream, *args)
+      if args.last.is_a?(Hash) && args.last[:raise_exceptions] == true
+        unless exitstatus == SUCCESS_EXIT_STATUS
+          raise ShellOutException, "`#{ args[0..-2].join(" ") }' command finished with non-zero (#{ exitstatus }) exit status"
+        end
+      end
+      if args.last.is_a?(Hash) && args.last[:out] == :return
+        out_stream.rewind if out_stream.is_a?(StringIO)
+        out_stream.read
+      else
+        exitstatus
+      end
+    end
+
+    def command(*args)
+      stripped_command = args.dup
+      stripped_command.pop if stripped_command[-1].is_a?(Hash) # remove options
+      stripped_command.shift if stripped_command[0].is_a?(Hash) # remove env
+      stripped_command.join(" ")
+    end
+
+    def with_env(*args)
+      yield unless (env = args[0]).is_a?(Hash)
+      stored_env = {}
+      for name, value in env
+        stored_env[name] = ENV[name]
+        value == nil ? ENV.delete(name) : ENV[name] = value 
+      end
+      begin
+        yield
+      ensure
+        for name, value in stored_env
+          ENV[name] = value
+        end
+      end
+    end
+
+    def getopt(opt, default, *args)
+      if args.last.is_a?(Hash)
+        if opt == :out && args.last[:out] == :return
+          StringIO.new
+        else
+          args.last.fetch(opt, default)
+        end
+      else
+        default
+      end
+    end
+  end
+
+  module_function
+
+  def shell_out_with_pty(*args)
+    old_state = `stty -g`
+    
+    return SUCCESS_EXIT_STATUS unless ShellOut::before(*args)
+
+    begin
+      # stolen from ruby/ext/pty/script.rb
+      # disable echoing and enable raw (not having to press enter)
+      system "stty -echo raw lnext ^_"
+
+      in_stream = ShellOut.getopt(:in, STDIN, *args)
+      out_stream = ShellOut.getopt(:out, STDOUT, *args)
+      writer = nil
+      ShellOut.with_env(*args) do
+        PTY.spawn(ShellOut.command(*args)) do |r_pty, w_pty, pid|
+          reader = Thread.current
+          writer = Thread.new do
+            while true
+              break if (ch = in_stream.getc).nil?
+              ch = ch.chr
+              if ch == ShellOut::CTRL_C_CODE
+                reader.raise Interrupt, "Interrupted by user"
+              else
+                w_pty.print ch
+                w_pty.flush
+              end
+            end
+          end
+          writer.abort_on_exception = true
+
+          loop do
+            c = begin
+              r_pty.sysread(512)
+            rescue Errno::EIO, EOFError
+              nil
+            end
+            break if c.nil?
+
+            out_stream.print c
+            out_stream.flush
+          end
+
+          begin
+            # try to invoke waitpid() before the signal handler does it
+            return ShellOut::after(Process::waitpid2(pid)[1].exitstatus, out_stream, *args)
+          rescue Errno::ECHILD
+            # the signal handler managed to call waitpid() first;
+            # PTY::ChildExited will be delivered pretty soon, so just wait for it
+            sleep 1
+          end
+        end
+      end
+    rescue PTY::ChildExited => e
+      return ShellOut::after(e.status.exitstatus, out_stream, *args)
+    ensure
+      writer && writer.kill
+      system "stty #{ old_state }"
+    end
+  end
+
+  def shell_out_with_system(*args)
+    return SUCCESS_EXIT_STATUS unless ShellOut::before(*args)
+
+    cleaned_args = if args.last.is_a?(Hash)
+      cleaned_options = args.last.dup.delete_if { |k, | [ :verbose, :raise_exceptions ].include?(k) }
+      require "stringio"
+      if cleaned_options[:out].is_a?(StringIO) ||
+              cleaned_options[:out] == :return
+        r, w = IO.pipe
+        cleaned_options[:out] = w
+        cleaned_options[:err] = [ :child, :out ]
+      end
+      if cleaned_options[:in].is_a?(StringIO)
+        in_r, in_w = IO.pipe
+        in_w.write cleaned_options[:in].read
+        in_w.close
+        cleaned_options[:in] = in_r
+      end
+      cleaned_options.empty? ? args[0..-2] : args[0..-2].dup << cleaned_options
+    else
+      args
+    end
+
+    exitstatus = if Kernel.system(*cleaned_args)
+      SUCCESS_EXIT_STATUS
+    else
+      require "English"
+      $CHILD_STATUS.exitstatus
+    end
+
+    if r
+      w.close
+      unless args.last[:out] == :return
+        args.last[:out] << r.read
+      end
+    end
+
+    ShellOut::after(exitstatus, r, *args)
+  end
+
+  begin
+    require "pty"
+    alias shell_out shell_out_with_pty
+  rescue LoadError
+    alias shell_out shell_out_with_system
+  end
+
+  module_function :shell_out
+end
+
+def ShellOut(*args)
+  ShellOut.shell_out(*args)
+end
+
+if $PROGRAM_NAME == __FILE__
+  require "spec"
+  require "stringio"
+  require "./io_interceptor.rb"
+
+  describe "ShellOut" do
+    before do
+      STDOUT.extend(IoInterceptor)
+    end
+
+    share_examples_for "having base capabilities" do
+
+      it "shells out to successful command and returns 0 exit code" do
+        ShellOut("ruby -e ''").should == 0
+      end
+
+      it "passes arbitrary exit codes" do
+        ShellOut("ruby -e 'exit(42)'").should == 42
+      end
+
+      it "passes STDIN (or options[:in]) stream to the command" do
+        fake_stdin = StringIO.new
+        fake_stdin.write "testing\n"
+        fake_stdin.rewind
+
+        STDOUT.supress do # TODO still mystery why "testing\n" gets written to the output 
+          ShellOut("ruby -e 'exit(123) if gets.chomp == \"testing\"'", :in => fake_stdin).should == 123
+        end
+      end
+
+      it "alters command environment when first argument is a Hash" do
+        ShellOut({ "ENV_VAR" => "42" }, 
+                 "ruby -e 'puts ENV.inspect'",
+                 :out => :return).should include('"ENV_VAR"=>"42"')
+      end
+
+      describe ":raise_exceptions option" do
+        it "raises exception for non-zero exit codes" do
+          lambda do
+            ShellOut("false", :raise_exceptions => true)
+          end.should raise_error(ShellOut::ShellOutException)
+        end
+
+        it "raises exception for non-existing command" do
+          lambda do
+            ShellOut("nonexisting", :raise_exceptions => true)
+          end.should raise_error(ShellOut::ShellOutException)
+        end
+      end
+
+      describe ":out option" do
+        it "redirects output of command" do
+          fake_stdout = StringIO.new
+          ShellOut("echo 42", :out => fake_stdout)
+          fake_stdout.string.chomp.should == "42"
+        end
+      end
+
+      describe ":out => :return option" do
+        it "return the output of command" do
+          ShellOut("echo 42", :out => :return).chomp.should == "42"
+        end
+
+        it "return STDERR output of command" do
+          ShellOut("ruby -e 'STDERR.puts 42'", :out => :return).chomp.should == "42"
+        end
+      end
+
+      describe ":verbose option" do
+        it "echoes the command name" do
+          STDOUT.intercept { ShellOut("true", :verbose => true) }.should include("true")
+        end
+      end
+
+      def with_vanishing_file(f)
+        yield
+      ensure
+        File.delete(f) rescue nil
+      end
+
+      describe ":noop option" do
+        it "always returns 0 status" do
+          ShellOut("ruby -e 'exit 123'", :noop => true).should == 0
+        end
+
+        it "never executes command" do
+          f = "never_executes_command.test"
+          with_vanishing_file(f) do
+            ShellOut("touch #{ f }", :noop => true)
+            File.exist?(f).should == false
+          end
+        end
+      end
+
+      describe ":dry_run option" do
+        it "echoes the command name" do
+          STDOUT.intercept { ShellOut("true", :dry_run => true) }.should include("true")
+        end
+
+        it "always returns 0 status" do
+          STDOUT.supress { ShellOut("ruby -e 'exit 123'", :dry_run => true) }.should == 0
+        end
+
+        it "never executes command" do
+          f = "never_executes_command.test"
+          with_vanishing_file(f) do
+            STDOUT.supress { ShellOut("touch #{ f }", :dry_run => true) }
+            File.exist?(f).should == false
+          end
+        end
+      end
+    end
+
+    describe "#shell_out_with_system" do
+      before do
+        def ShellOut(*args)
+          ShellOut.shell_out_with_system(*args);
+        end
+      end
+
+      it_should_behave_like "having base capabilities"
+    end
+
+    describe "#shell_out_with_pty" do
+      begin
+        require "pty"
+        before do
+          def ShellOut(*args)
+            ShellOut.shell_out_with_pty(*args);
+          end
+        end
+
+        it_should_behave_like "having base capabilities"
+
+        it "uses pseudo-tty" do
+          ShellOut("ruby -e 'exit(123) if [STDIN, STDOUT, STDERR].all? { |stream| stream.tty? }'").should == 123
+        end
+
+        it "shows the output of the executing command on own STDOUT" do
+          STDOUT.intercept { ShellOut("echo '42'") }.should include("42")
+        end
+
+        it "doesn't pass Ctrl-C to the command and raises Interrupt exception when Ctrl-C is sent" do
+          fake_stdin = StringIO.new
+          fake_stdin.write ShellOut::CTRL_C_CODE
+          fake_stdin.rewind
+          int_trap = "ruby -e 'trap(\"INT\") { puts \"SIGINT received\" }; sleep 999'"
+          lambda do
+            ShellOut(int_trap, :in => fake_stdin)
+          end.should raise_error(Interrupt)
+
+          fake_stdin = StringIO.new
+          fake_stdin.write ShellOut::CTRL_C_CODE
+          fake_stdin.rewind
+          STDOUT.intercept do
+            begin
+              ShellOut(int_trap, :in => fake_stdin)
+            rescue Interrupt
+            end
+          end.should_not include("SIGINT received")
+        end
+      rescue LoadError
+        it "cannot be tested because 'pty' is not available on this system"
+      end
+    end
+  end
+
+  exit ::Spec::Runner::CommandLine.run
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'rspec/expectations'
+require 'rspec/matchers'
+require 'rspec/core'

data/spec/test_apps/rails2_test_app/README

@@ -0,0 +1,243 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create 
+database-backed web applications according to the Model-View-Control pattern. 
+
+This pattern splits the view (also called the presentation) into "dumb" templates
+that are primarily responsible for inserting pre-built data in between HTML tags.
+The model contains the "smart" domain objects (such as Account, Product, Person,
+Post) that holds all the business logic and knows how to persist themselves to
+a database. The controller handles the incoming requests (such as Save New Account,
+Update Product, Show Post) by manipulating the model and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails.  You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, start a new Rails application using the <tt>rails</tt> command
+   and your application name. Ex: rails myapp
+2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
+3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!"
+4. Follow the guidelines to start developing your application
+
+
+== Web Servers
+
+By default, Rails will try to use Mongrel if it's are installed when started with script/server, otherwise Rails will use WEBrick, the webserver that ships with Ruby. But you can also use Rails
+with a variety of other web servers.
+
+Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
+suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
+getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
+More info at: http://mongrel.rubyforge.org
+
+Say other Ruby web servers like Thin and Ebb or regular web servers like Apache or LiteSpeed or
+Lighttpd or IIS. The Ruby web servers are run through Rack and the latter can either be setup to use
+FCGI or proxy to a pack of Mongrels/Thin/Ebb servers.
+
+== Apache .htaccess example for FCGI/CGI
+
+# General Apache options
+AddHandler fastcgi-script .fcgi
+AddHandler cgi-script .cgi
+Options +FollowSymLinks +ExecCGI
+
+# If you don't want Rails to look in certain directories,
+# use the following rewrite rules so that Apache won't rewrite certain requests
+# 
+# Example:
+#   RewriteCond %{REQUEST_URI} ^/notrails.*
+#   RewriteRule .* - [L]
+
+# Redirect all requests not available on the filesystem to Rails
+# By default the cgi dispatcher is used which is very slow
+# 
+# For better performance replace the dispatcher with the fastcgi one
+#
+# Example:
+#   RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
+RewriteEngine On
+
+# If your Rails application is accessed via an Alias directive,
+# then you MUST also set the RewriteBase in this htaccess file.
+#
+# Example:
+#   Alias /myrailsapp /path/to/myrailsapp/public
+#   RewriteBase /myrailsapp
+
+RewriteRule ^$ index.html [QSA]
+RewriteRule ^([^.]+)$ $1.html [QSA]
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
+
+# In case Rails experiences terminal errors
+# Instead of displaying this message you can supply a file here which will be rendered instead
+# 
+# Example:
+#   ErrorDocument 500 /500.html
+
+ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly"
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong.  Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files.  Have "tail -f" commands running
+on the server.log and development.log. Rails will automatically display debugging
+and runtime information to these files. Debugging info will also be shown in the
+browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code using
+the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
+
+* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
+* Learn to Program: http://pine.fm/LearnToProgram/  (a beginners guide)
+
+These two online (and free) books will bring you up to speed on the Ruby language
+and also on programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your Mongrel or
+Webrick server with --debugger. This means that you can break out of execution at any point
+in the code, investigate and change the model, AND then resume execution! 
+You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug'
+Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find(:all)
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
+       #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better is that you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you enter "cont"
+
+
+== Console
+
+You can interact with the domain model by starting the console through <tt>script/console</tt>.
+Here you'll have all parts of the application configured, just like it is when the
+application is running. You can inspect domain models, change values, and save to the
+database. Starting the script without arguments will launch it in the development environment.
+Passing an argument will specify a different environment, like <tt>script/console production</tt>.
+
+To reload your controllers and models after launching the console run <tt>reload!</tt>
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>script/dbconsole</tt>.
+You would be connected to the database with the credentials defined in database.yml.
+Starting the script without arguments will connect you to the development database. Passing an
+argument will connect you to a different database, like <tt>script/dbconsole production</tt>.
+Currently works for mysql, postgresql and sqlite.
+
+== Description of Contents
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from ApplicationController
+  which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb.
+  Most models will descend from ActiveRecord::Base.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use eRuby
+  syntax.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the common
+  header/footer method of wrapping views. In your views, define a layout using the
+  <tt>layout :default</tt> and create a file named default.html.erb. Inside default.html.erb,
+  call <% yield %> to render the view using this layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are generated
+  for you automatically when using script/generate for controllers. Helpers can be used to
+  wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database, and other dependencies.
+
+db
+  Contains the database schema in schema.rb.  db/migrate contains all
+  the sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when generated
+  using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that doesn't
+  belong under controllers, models, or helpers. This directory is in the load path.
+
+public
+  The directory available for the web server. Contains subdirectories for images, stylesheets,
+  and javascripts. Also contains the dispatchers and the default HTML files. This should be
+  set as the DOCUMENT_ROOT of your web server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the script/generate scripts, template
+  test files will be generated for you and placed in this directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins subdirectory.
+  If the app has frozen rails, those gems also go here, under vendor/rails/.
+  This directory is in the load path.