web-console-rails3 0.2.0

data/lib/web_console/fiber.rb

@@ -0,0 +1,48 @@
+module WebConsole
+  # Poor Man's Fiber (API compatible Thread based Fiber implementation for Ruby 1.8)
+  # (c) 2008 Aman Gupta (tmm1)
+  #
+  # For the purposes of our REPL adapters there is a need for fiber invocation
+  # across threads. The native implementation does not support that.
+  class FiberError < StandardError; end
+
+  class Fiber
+    def initialize
+      raise ArgumentError, 'new Fiber requires a block' unless block_given?
+
+      @yield = Queue.new
+      @resume = Queue.new
+
+      @thread = Thread.new { @yield.push [ *yield(*@resume.pop) ] }
+      @thread.abort_on_exception = true
+      @thread[:fiber] = self
+    end
+    attr_reader :thread
+
+    def resume(*args)
+      raise FiberError, 'dead fiber called' unless @thread.alive?
+      @resume.push(args)
+      result = @yield.pop
+      result.size > 1 ? result : result.first
+    end
+
+    def yield(*args)
+      @yield.push(args)
+      result = @resume.pop
+      result.size > 1 ? result : result.first
+    end
+
+    def self.yield(*args)
+      raise FiberError, "can't yield from root fiber" unless fiber = Thread.current[:fiber]
+      fiber.yield(*args)
+    end
+
+    def self.current
+      Thread.current[:fiber] or raise FiberError, 'not inside a fiber'
+    end
+
+    def inspect
+      "#<#{self.class}:0x#{self.object_id.to_s(16)}>"
+    end
+  end
+end

data/lib/web_console/repl.rb

@@ -0,0 +1,59 @@
+require 'active_support/core_ext/string/inflections'
+
+module WebConsole
+  module REPL
+    extend self
+
+    # Registry of REPL implementations mapped to their correspondent adapter
+    # classes.
+    #
+    # Don't manually alter the registry. Use WebConsole::REPL.register_adapter
+    # for adding entries.
+    def adapters
+      @adapters ||= {}
+    end
+
+    # Register an adapter into the adapters registry.
+    #
+    # Registration maps and adapter class to an existing REPL implementation,
+    # that we call an adaptee constant. If the adaptee constant is not given,
+    # it is automatically derived from the adapter class name.
+    #
+    # For example, adapter named +WebConsole::REPL::IRB+ will derive the
+    # adaptee constant to +::IRB+.
+    #
+    # If a block is given, it would be evaluated right after the adapter
+    # registration.
+    def register_adapter(adapter_class, adaptee_constant = nil, options = {})
+      if adaptee_constant.is_a?(Hash)
+        options          = adaptee_constant
+        adaptee_constant = nil
+      end
+      adaptee_constant   = adapter_class if options[:standalone]
+      adaptee_constant ||= derive_adaptee_constant_from(adapter_class)
+      adapters[adaptee_constant] = adapter_class
+      yield if block_given?
+    end
+
+    # Get the default adapter for the given application.
+    #
+    # By default the application will be Rails.application and the adapter
+    # will be chosen from Rails.application.config.console.
+    #
+    # If no suitible adapter is found for the configured Rails console, a dummy
+    # adapter will be used. You can evaluate code in it, but it won't support
+    # any advanced features, like multiline code evaluation.
+    def default(app = Rails.application)
+      adapters[(app.config.console || ::IRB rescue ::IRB)] || adapters[Dummy]
+    end
+
+    private
+      def derive_adaptee_constant_from(cls, suffix = 'REPL')
+        "::#{cls.name.split('::').last.gsub(/#{suffix}$/i, '')}".constantize
+      end
+  end
+end
+
+# Require the builtin adapters.
+require 'web_console/repl/irb'
+require 'web_console/repl/dummy'

data/lib/web_console/repl/dummy.rb

@@ -0,0 +1,38 @@
+require 'web_console/stream'
+
+module WebConsole
+  module REPL
+    # == Dummy\ Adapter
+    #
+    # Dummy adapter that is used as a fallback for REPL with no adapters.
+    #
+    # It provides only the most basic code evaluation with no multiline code
+    # support.
+    class Dummy
+      def initialize(binding = TOPLEVEL_BINDING)
+        @binding = binding
+      end
+
+      def prompt
+        '>> '
+      end
+
+      def send_input(input)
+        eval_result = nil
+        streams_output = Stream.threadsafe_capture! do
+          eval_result = @binding.eval(input).inspect
+        end
+        "#{streams_output}=> #{eval_result}\n"
+      rescue Exception => exc
+        exc.backtrace.join("\n")
+      end
+    end
+
+    register_adapter Dummy, standalone: true do
+      require 'rails/console/app'
+      require 'rails/console/helpers'
+
+      TOPLEVEL_BINDING.eval('self').send(:include, Rails::ConsoleMethods)
+    end
+  end
+end

data/lib/web_console/repl/irb.rb

@@ -0,0 +1,62 @@
+require 'irb'
+require 'web_console/fiber'
+require 'web_console/stream'
+
+module WebConsole
+  module REPL
+    # == IRB\ Adapter
+    #
+    # Adapter for the IRB REPL, which is the default Ruby on Rails console.
+    class IRB
+      # For some reason™ we have to be ::IRB::StdioInputMethod subclass to get
+      # #prompt populated.
+      #
+      # Not a pretty OOP, but for now, we just have to deal with it.
+      class FiberInputMethod < ::IRB::StdioInputMethod
+        def initialize; end
+
+        def gets
+          @previous = Fiber.yield
+        end
+
+        def encoding
+          (@previous || '').encoding
+        end
+      end
+
+      def initialize(binding = TOPLEVEL_BINDING)
+        initialize_irb_session!
+        @input = FiberInputMethod.new
+        @irb   = ::IRB::Irb.new(::IRB::WorkSpace.new(binding), @input)
+        @fiber = Fiber.new { @irb.eval_input }.tap(&:resume)
+        finalize_irb_session!
+      end
+
+      def prompt
+        @input.prompt
+      end
+
+      def send_input(input)
+        Stream.threadsafe_capture! { @fiber.resume("#{input}\n") }
+      end
+
+      private
+        def initialize_irb_session!(ap_path = nil)
+          ::IRB.init_config(ap_path)
+          ::IRB.run_config unless WebConsole.config.prevent_irbrc_execution
+        end
+
+        def finalize_irb_session!
+          ::IRB.conf[:MAIN_CONTEXT] = @irb.context
+        end
+    end
+
+    register_adapter IRB do
+      require 'rails/console/app'
+      require 'rails/console/helpers'
+
+      # Include all of the rails console helpers in the IRB session.
+      ::IRB::ExtendCommandBundle.send(:include, Rails::ConsoleMethods)
+    end
+  end
+end

data/lib/web_console/stream.rb

@@ -0,0 +1,30 @@
+require 'mutex_m'
+
+module WebConsole
+  module Stream
+    extend Mutex_m
+
+    def self.threadsafe_capture!(*streams)
+      streams = [$stdout, $stderr] if streams.empty?
+      synchronize do
+        begin
+          streams_copy = streams.collect(&:dup)
+          replacement  = Tempfile.new(name)
+          streams.each do |stream|
+            stream.reopen(replacement)
+            stream.sync = true
+          end
+          yield
+          streams.each(&:rewind)
+          replacement.read
+        ensure
+          replacement.close
+          replacement.unlink
+          streams.each_with_index do |stream, i|
+            stream.reopen(streams_copy[i])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/web_console/version.rb

@@ -0,0 +1,3 @@
+module WebConsole
+  VERSION = '0.2.0'
+end

data/test/controllers/web_console/console_sessions_controller_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+module WebConsole
+  class ConsoleSessionsControllerTest < ActionController::TestCase
+    setup do
+      # Where does .stubs lives?
+      def @request.remote_ip; '127.0.0.1' end
+    end
+
+    test 'index is successful' do
+      get :index, use_route: 'web_console'
+      assert_response :success
+    end
+
+    test 'index creates new console session' do
+      assert_difference 'ConsoleSession::INMEMORY_STORAGE.size' do
+        get :index, use_route: 'web_console'
+      end
+    end
+
+    test 'update updates new console session' do
+      get :index, use_route: 'web_console'
+      assert_not_nil console_session = assigns(:console_session)
+
+      put :update, id: console_session.id, input: 42, use_route: 'web_console'
+      assert_match %r{42}, console_session.output
+    end
+
+    test 'update failes when session is no longer available' do
+      get :index, use_route: 'web_console'
+      assert_not_nil console_session = assigns(:console_session)
+
+      ConsoleSession::INMEMORY_STORAGE.delete(console_session.id)
+      put :update, id: console_session.id, input: 42, use_route: 'web_console'
+      assert_response :gone
+    end
+
+    test 'blocks requests from non-whitelisted ips' do
+      def @request.remote_ip; '128.0.0.1' end
+      get :index, use_route: 'web_console'
+      assert_response :unauthorized
+    end
+
+    test 'index generated path' do
+      assert_generates mount_path, {
+        use_route: 'web_console',
+        controller: 'console_sessions'
+      }, {}, {controller: 'console_sessions'}
+    end
+
+    private
+
+      def mount_path
+        WebConsole::Engine.config.web_console.default_mount_path
+      end
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== 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, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== 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/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two 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 <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.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", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, 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 can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. 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.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+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>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+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. Models descend from
+  ActiveRecord::Base by default.
+
+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 by default.
+
+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 generators 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. 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 rails generate
+  command, 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.