rails_notebook 1.0.0

data/lib/rails_notebook/assets/tipsy.css

@@ -0,0 +1,25 @@
+.tipsy { font-size: 10px; position: absolute; padding: 5px; z-index: 100000; }
+  .tipsy-inner { background-color: #000; color: #FFF; max-width: 600px; padding: 5px 8px 4px 8px; text-align: center; }
+
+  /* Rounded corners */
+  .tipsy-inner { border-radius: 3px; -moz-border-radius: 3px; -webkit-border-radius: 3px; }
+  
+  /* Uncomment for shadow */
+  /*.tipsy-inner { box-shadow: 0 0 5px #000000; -webkit-box-shadow: 0 0 5px #000000; -moz-box-shadow: 0 0 5px #000000; }*/
+  
+  .tipsy-arrow { position: absolute; width: 0; height: 0; line-height: 0; border: 5px dashed #000; }
+  
+  /* Rules to colour arrows */
+  .tipsy-arrow-n { border-bottom-color: #000; }
+  .tipsy-arrow-s { border-top-color: #000; }
+  .tipsy-arrow-e { border-left-color: #000; }
+  .tipsy-arrow-w { border-right-color: #000; }
+  
+    .tipsy-n .tipsy-arrow { top: 0px; left: 50%; margin-left: -5px; border-bottom-style: solid; border-top: none; border-left-color: transparent; border-right-color: transparent; }
+    .tipsy-nw .tipsy-arrow { top: 0; left: 10px; border-bottom-style: solid; border-top: none; border-left-color: transparent; border-right-color: transparent;}
+    .tipsy-ne .tipsy-arrow { top: 0; right: 10px; border-bottom-style: solid; border-top: none;  border-left-color: transparent; border-right-color: transparent;}
+  .tipsy-s .tipsy-arrow { bottom: 0; left: 50%; margin-left: -5px; border-top-style: solid; border-bottom: none;  border-left-color: transparent; border-right-color: transparent; }
+    .tipsy-sw .tipsy-arrow { bottom: 0; left: 10px; border-top-style: solid; border-bottom: none;  border-left-color: transparent; border-right-color: transparent; }
+    .tipsy-se .tipsy-arrow { bottom: 0; right: 10px; border-top-style: solid; border-bottom: none; border-left-color: transparent; border-right-color: transparent; }
+  .tipsy-e .tipsy-arrow { right: 0; top: 50%; margin-top: -5px; border-left-style: solid; border-right: none; border-top-color: transparent; border-bottom-color: transparent; }
+  .tipsy-w .tipsy-arrow { left: 0; top: 50%; margin-top: -5px; border-right-style: solid; border-left: none; border-top-color: transparent; border-bottom-color: transparent; }

data/lib/rails_notebook/command.rb

@@ -0,0 +1,104 @@
+require 'fileutils'
+require 'multi_json'
+
+module RailsNotebook
+
+  class Command
+
+    def initialize
+      ipython_dir = ENV['IPYTHONDIR'] || '~/.ipython'
+      @kernel_dir  = File.join(File.expand_path(ipython_dir), 'kernels', 'rails_notebook')
+      @kernel_file = File.join(@kernel_dir, 'kernel.json')
+      puts @kernel_file
+      @iruby_path  = File.expand_path $0
+      puts @iruby_path
+    end
+
+    def run_kernel
+      require 'iruby/logger'
+      IRuby.logger = Rails.logger
+
+      connection_file = ENV['connection_file']
+      change_working_dir
+
+      IRuby::Kernel.new(connection_file).run
+    rescue Exception => e
+      IRuby.logger.fatal "Kernel died: #{e.message}\n#{e.backtrace.join("\n")}"
+      raise
+    end
+
+    def run_ipython
+      check_version
+      check_registered_kernel
+      change_working_dir
+      #create_static_symlink!
+      Kernel.exec('ipython', 'notebook')
+    end
+
+    private
+
+    #================================= For Symlink
+    def create_static_symlink!
+      src, dst = static_path, File.join(profile_path, '/kernels/rails_notebook')
+      puts src
+      puts dst
+      FileUtils.rm_r dst
+      File.symlink src, dst
+    end
+
+    def profile_path
+      `ipython locate rails_notebook`.strip
+      #File.expand_path(".." , `ipython locate rails_notebook`.strip)
+    end
+
+    def static_path
+      File.join(File.dirname(__FILE__), "assets")
+    end
+    #================================= For Symlink
+
+
+    def change_working_dir
+      working_dir = File.join(Rails.root, "notebooks")
+      Dir.mkdir(working_dir) unless Dir.exist?(working_dir)
+      Dir.chdir(working_dir) if working_dir
+    end
+
+    def check_version
+      required = '3.0.0'
+      version  = `ipython --version`.chomp
+      if version < required
+        STDERR.puts "Your IPython version #{version} is too old, at least #{required} is required"
+        exit 1
+      end
+    end
+
+    def check_registered_kernel
+      if (kernel = registered_iruby_path)
+        STDERR.puts "#{@iruby_path} differs from registered path #{registered_iruby_path}.
+This might not work. Run 'iruby register --force' to fix it." if @iruby_path != kernel
+      else
+        register_kernel
+      end
+    end
+
+    def register_kernel
+      FileUtils.mkpath(@kernel_dir)
+
+      if RUBY_PLATFORM =~ /mswin(?!ce)|mingw|cygwin/
+        ruby_path, iruby_path = [RbConfig.ruby, @iruby_path].map { |path| path.gsub('/', '\\\\') }
+        File.write(@kernel_file, MultiJson.dump(argv:         [ruby_path, iruby_path, 'rails_notebook_kernel', 'connection_file={connection_file}'],
+                                                display_name: "Rails #{Rails.application.class.to_s}", language: 'ruby'))
+      else
+        File.write(@kernel_file, MultiJson.dump(argv:         [@iruby_path, 'rails_notebook_kernel', 'connection_file={connection_file}'],
+                                                display_name: "Rails #{Rails.application.class.to_s}", language: 'ruby'))
+      end
+
+      FileUtils.copy(Dir[File.join(__dir__, 'assets', '*')], @kernel_dir) rescue nil
+    end
+
+    def registered_iruby_path
+      File.exist?(@kernel_file) && MultiJson.load(File.read(@kernel_file))['argv'].first
+    end
+
+  end
+end

data/lib/rails_notebook/engine.rb

@@ -0,0 +1,9 @@
+module RailsNotebook
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsNotebook
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/rails_notebook/profiler.rb

@@ -0,0 +1,111 @@
+#https://github.com/SamSaffron/flamegraph/
+#Modified from Sam Saffron's original code for flamegraph
+require "json"
+require "stackprof"
+
+module Profiler
+    def self.profile(filename=nil, opts = {})
+        backtraces = nil;
+        fidelity = opts[:fidelity]  || 0.05
+        backtraces = StackProfSampler.collect( fidelity ) do yield end
+        Profiler::Profile.new( Profiler::generate_data( backtraces ) , fidelity )
+    end
+
+    def self.generate_data( stacks )
+        table = []
+        prev = []
+
+        # a 2d array makes collapsing easy
+        stacks.each_with_index do |stack, pos|
+            next unless stack
+            col = []
+
+            stack.reverse.map{|r| r.to_s}.each_with_index do |frame, i|
+                if !prev[i].nil?
+                    last_col = prev[i]
+                    if last_col[0] == frame
+                        last_col[1] += 1
+                        col << nil
+                        next
+                    end
+                end
+
+                prev[i] = [frame, 1]
+                col << prev[i]
+            end
+            prev = prev[0..col.length-1].to_a
+            table << col
+        end
+
+        data = []
+        # a 1d array makes rendering easy
+        table.each_with_index do |col, col_num|
+            col.each_with_index do |row, row_num|
+                next unless row && row.length == 2
+                data << {
+                    :x      => col_num + 1,
+                    :y      => row_num + 1,
+                    :width  => row[1],
+                    :frame  => row[0]
+                }
+                end
+            end
+        data
+    end
+
+    class Profile
+        def initialize( data, _sampleTime )
+            @data = data
+            @sampleTime = _sampleTime
+        end
+    end
+
+    class StackProfSampler
+        def self.collect(fidelity=0.5)
+            result = StackProf.run(mode: :wall,
+                           raw: true,
+                           aggregate: false,
+                           interval: (fidelity * 1000).to_i) do
+                yield
+            end
+
+            stacks = []
+            stack = []
+
+            return [] unless result[:raw]
+
+            length = nil
+            result[:raw].each do |i|
+                if length.nil?
+                    length = i
+                next
+                end
+
+                if length > 0
+                    frame = result[:frames][i]
+                    frame = "#{frame[:file]}:#{frame[:line]}:in `#{frame[:name]}'"
+                    # puts frame
+                    #if frame.to_s =~ /iruby/ && !( frame.to_s =~ /IRuby::/ )
+                    s = frame.to_s
+                    if !( s =~ /application.rb/ ) &&
+                            !( s =~ /Rake::Application/) &&
+                            !( s =~ /task.rb/) &&
+                            !( s =~ /kernel.rb/) &&
+                            !( s =~ /profiler.rb/)
+                        stack << frame.to_s
+                    end
+                    length -= 1
+                    next
+                end
+
+                i.times do
+                    stacks << stack.reverse
+                end
+
+                stack = []
+                length = nil
+            end
+            stacks
+        end
+    end
+end

data/lib/rails_notebook/renderers.rb

@@ -0,0 +1,121 @@
+require 'json'
+
+module RailsNotebook
+    
+    module Renderers
+
+        def self.pretty_print_json( json )
+            <<-HTML
+            <div id="json-#{json.object_id}"></div>
+            <script>
+                require(["jquery", "/kernelspecs/rails_notebook/jquery.jsonview.js"], function ($, jsonview) {
+                    $("#json-#{json.object_id}").JSONView( #{json} );
+                });
+            </script>
+            HTML
+        end
+
+        def self.render_html( object , functionName )
+            <<-HTML
+            <div id="railsnb-#{object.object_id}"></div>
+            <script>
+            require(["/kernelspecs/rails_notebook/rails_notebook.js"] , function ( railsNB ) {
+                railsNB.#{functionName}( #{MultiJson.dump(object)} , document.getElementById( "railsnb-#{object.object_id}" ) );
+            }); 
+            </script>
+            HTML
+        end
+    end
+
+    IRuby::Display::Registry.type { String }
+    IRuby::Display::Registry.format("text/html") do |string| 
+        begin JSON.parse( string )
+            Renderers.pretty_print_json( string )
+        rescue
+            string
+        end
+    end
+
+    IRuby::Display::Registry.type { Rails.application }
+    IRuby::Display::Registry.format("text/html") do |obj|
+        Renderers.json_view( Serializers.serialize(obj) )
+    end
+
+    IRuby::Display::Registry.type { Profiler::Profile }
+    IRuby::Display::Registry.format("text/html") do |profiledData|
+        Renderers.render_html( profiledData, "renderFlamechart" )
+    end
+
+    IRuby::Display::Registry.type { ActionDispatch::Routing::RouteSet }
+    IRuby::Display::Registry.format("text/html") do |route_set|
+        all_routes = route_set.routes.to_a
+        all_routes.reject! { |route| route.verb.nil? || route.path.spec.to_s == '/assets' || ( route.path.spec.to_s =~ /^\/rails(.*)/ ) || route.path.spec.to_s =~ /^\/pages(.*)/ }
+        routeTree = RouteTree.new( RouteNode.new( "/" , nil, nil, nil, "" ) )
+        all_routes.group_by { |route| route.defaults[:controller] }.each_value do |group|
+            group.each do |r|
+                routeNode = RouteNode.new(  (r.path.spec.to_s.sub '(.:format)','') , 
+                                            r.verb.inspect.gsub(/^.{2}|.{2}$/, "") , 
+                                            r.name.to_s , r.defaults[:action].to_s , 
+                                            (r.path.spec.to_s.sub '(.:format)','').split("/")[-1] 
+                                        )
+                routeTree.insertNode( routeNode )
+            end
+        end
+        #routeTree.printTree() # for debugging
+        Renderers.render_html( routeTree, "renderRoutes" )
+    end
+
+    IRuby::Display::Registry.type { ActiveRecord::Base.connection.tables }
+    IRuby::Display::Registry.format("text/html") do |obj|
+        tables = [] # List of Table objects
+        tableNames = [] # List of table names
+        obj.each do |table_name|
+            tableNames.push(table_name.singularize.foreign_key)
+        end # Populates table names
+
+        obj.each do |table_name| # Finding foreign keys and populating the array of Table objects
+            columnsTemp = []
+            arrowsTo = []
+            ActiveRecord::Base.connection.columns(table_name).each do |c|
+                columnTemp = []
+                if (tableNames.include? c.name)
+                    arrowsTo.push(c.name[0..-4].pluralize.downcase) # [0..-4] chops off the _id suffix for foreign keys. .humanize renmoves existing underscores, which causes bugs.
+                    columnTemp.push("* " + c.name)
+                    columnTemp.push(c.type.to_s)
+                else 
+                    columnTemp.push("- " + c.name)
+                    columnTemp.push(c.type.to_s)
+                end
+                columnsTemp.push(columnTemp)
+            end # end iterating through columns in tables
+            tables.push(Table.new(table_name , columnsTemp , arrowsTo ))
+        end # end iterating through tables
+        tables = tables.sort_by { |x| x.arrowsTo.length }
+        Renderers.render_html( tables, "renderSchema" ) # Parses the array of tables to Javascript for rendering
+    end
+
+    IRuby::Display::Registry.type { ActiveRecord::Relation}
+    IRuby::Display::Registry.format("text/html") do |obj|
+        columnNames = []
+        tableData = []
+        tableData.push(obj.name)
+        obj.columns.each do |column|
+            columnNames.push(column.name)
+        end
+        columnNames.each do |index|
+            tempValues = []
+            tempValues.push(index)
+            obj[0,10].each do |row| # Display only the first ten rows
+                tempValues.push(row[index])
+            end
+            tableData.push(tempValues)
+        end
+        Renderers.render_html( tableData, "renderTableData" )
+    end # DatabaseQueries
+
+    IRuby::Display::Registry.type { SchemaTable::ChartRenderer }
+    IRuby::Display::Registry.format("text/html") do |obj|
+        Renderers.render_html( obj.data , "renderBarChart" )
+    end
+
+end

data/lib/rails_notebook/route.rb

@@ -0,0 +1,121 @@
+class RouteNode
+
+	def initialize( _uriPattern , _verb , _controller , _action, _nodeUri )
+		@uriPattern = _uriPattern
+		_verb ? @verbs = [_verb] : @verbs = []
+		@controller = _controller
+		_action ? @actions = [_action] : @actions = []
+		@countChildrenNodes = 0
+		@childrenNodes = []
+		@nodeUri = _nodeUri
+		@id = self.object_id
+	end
+	def updateParams( _verb , _controller , _action )
+		@verbs << _verb unless _verb.nil?
+		@controller = _controller
+		@actions << _action unless _action.nil?
+	end
+	def verbs
+  		@verbs
+	end
+	def verb
+  		@verbs.first
+	end
+	def controller
+		@controller
+	end
+	def actions
+		@actions
+	end
+	def action
+		@actions.first
+	end
+	def uriPattern
+  		@uriPattern
+	end
+	def getChildren
+  		@childrenNodes
+	end
+	def getCountChildrenNodes
+		@countChildrenNodes
+	end
+
+	def hasRoute( uri_mapping )
+		@childrenNodes.each do |childNode|
+			if childNode.uriPattern == uri_mapping 
+				return childNode
+			end
+		end
+		return false
+	end
+
+	def insertChild( childNode )
+		@childrenNodes << childNode
+	end
+
+  	def countChildrenNodes( count )
+    	@childrenNodes.each do |child|
+    		count = count + child.countChildrenNodes(0)
+    	end
+    	@countChildrenNodes = count
+    	count += 1
+    	return count
+  	end
+
+  	def printNode
+  		puts "====================NODE===================="
+  		puts @uriPattern
+		puts @verbs
+		puts @controller
+		puts @actions
+		puts "============================================"
+		@childrenNodes.each do |child|
+			child.printNode
+		end
+	end
+end
+
+
+
+class RouteTree
+	def initialize( _headNode )
+		@headNode = _headNode
+	end
+
+	def insertNode( _node )
+		#Get route mapping and iteratively either walk the tree or insert a node at the correct position
+		uri_mapping = ""
+		thisNode = @headNode #always insert from the headNode
+
+		_node.uriPattern.split("/").each do |uri|
+            uri_mapping += uri + "/"
+            if uri_mapping[0...-1] == _node.uriPattern || uri_mapping == _node.uriPattern # We are at node to insert or update
+            	if thisNode.uriPattern == uri_mapping # Update the parameters to include details
+            		thisNode.updateParams( _node.verb , _node.controller , _node.action ) 
+            	elsif thisNode.hasRoute( uri_mapping )
+            		thisNode.hasRoute( uri_mapping ).updateParams( _node.verb , _node.controller , _node.action )
+            	else 
+            		child = RouteNode.new( uri_mapping , _node.verb , _node.controller , _node.action, uri )
+            		thisNode.insertChild( child )
+            	end
+            elsif thisNode.hasRoute( uri_mapping ) # node exists so walk the tree
+            	thisNode = thisNode.hasRoute( uri_mapping )
+            elsif thisNode.uriPattern == uri_mapping # already there so do nothing
+            	#thisNode.updateParams( _node.verb , _node.controller , _node.action )
+            else
+            	child = RouteNode.new( uri_mapping , nil, nil , nil, uri )
+            	thisNode.insertChild( child )
+            	thisNode = child
+            end
+        end
+	end
+	def removeNode( _node )
+		puts "removing node"
+	end
+	def getRoot
+		@headNode
+	end
+	def printTree
+		@headNode.printNode
+	end	
+end