rails_info 0.0.1

data/lib/rails_info/model.rb

@@ -0,0 +1,221 @@
+class RailsInfo::Model
+  # TODO: Live reload of ruby code as maybe seen here with require_or_load path https://github.com/Tho85/sunspot/blob/f9f6f9666e6df1a0e92c0d8070f7007075f75071/sunspot_rails/lib/sunspot/rails/tasks.rb 
+  def classes
+    return @classes if @classes
+    
+    #model_names = Dir.chdir(File.join(Rails.root, 'app', 'models')) { Dir["*.rb"] }
+    #model_names = Dir.chdir(File.expand_path('../../../../../../../reqorder2/app/models', __FILE__)) { Dir["*.rb"] }
+    @classes = []
+
+    # Dir['app/models/**/*.*'].map{|f| f.gsub('app/models/', '')}
+    Dir["#{Rails.root}/app/models/**/*.*"].each do |class_name|
+      @classes << class_name.split('/').last.sub(/\.rb$/,'').camelize.constantize
+    end
+    
+    #select { |k| k.ancestors.include?(ActiveRecord::Base) && k.connection.table_exists?(k.table_name) }
+    @classes.select! { |c| c.respond_to?('table_name') }
+    
+    @classes
+  end 
+  
+  def list
+    models = {}
+    
+    classes.each do |klass| 
+      ar_ancestors = active_record_ancestors(klass)
+      
+      path_until_here = []
+      
+      klass_path = ar_ancestors.any? ? ar_ancestors.reverse : [] 
+      
+      if ar_ancestors.any?
+        if ar_ancestors.first.match('::') && ar_ancestors.length == 1
+          klass_path = (ar_ancestors.first + "::" + klass.to_s.split('::').last).split('::')
+        elsif ar_ancestors.first.match('::')    
+          raise 'unimplemented'
+        else
+          klass_path += klass.to_s.split('::') 
+        end
+      else
+        klass_path += klass.to_s.split('::')   
+      end   
+           
+      klass_path.each do |element|
+        path_until_here << element           
+        eval("models['" + path_until_here.join("']['") + "'] ||= {}")
+      end
+    end
+    
+    models
+  end
+  
+  def associations(key_constant, options = { parent: ''})
+    options.assert_valid_keys(:parent)
+    
+    key_constant = key_constant(key_constant, options[:parent]) if key_constant.is_a?(String)
+     
+    association_collection = []
+    columns = columns_for(key_constant)
+    columns.any? and association_collection << "belongs_to: #{columns.join(', ')}"    
+    super_active_record_ancestor_column = "#{get_super_active_record_ancestor(key_constant).split('::').last.underscore}_id"
+    has_many = {}
+    
+    if models_with_columns[super_active_record_ancestor_column]
+      has_many[:standard] = models_with_columns[super_active_record_ancestor_column].uniq      
+    else
+      has_many[:alias] = {}
+      
+      models_with_columns.keys.select{|c| c.match("#{super_active_record_ancestor_column}")}.each do |column|
+        has_many[:alias][column] = models_with_columns[column]
+      end
+      
+      has_many[:alias].empty? and has_many = {}
+    end
+    
+    has_many_polymorphs = {}
+    
+    if key_constant.respond_to?('reflections')
+      key_constant.reflections.values.select{|r| [:has_one, :has_many].include?(r.macro) && r.options.has_key?(:as) }.each do |reflection|        
+        association = reflection.options[:class_name] ? reflection.options[:class_name] : reflection.name.to_s.classify
+        has_many_polymorphs[association] = reflection.options[:as].to_s
+      end
+    end
+    
+    !has_many_polymorphs.empty? and has_many[:polymorphic] = has_many_polymorphs
+    
+    !has_many.empty? and association_collection << "has_many: #{has_many.inspect}"
+    
+    association_collection.any? ? " (#{association_collection.join(';')})" : ""
+  end
+  
+  def columns_for(key_constant, options = {})
+    options.assert_valid_keys(:parent)
+    
+    key_constant = key_constant(key_constant, options[:parent]) if key_constant.is_a?(String)
+    
+    columns = []
+    
+    begin
+      columns = key_constant.columns.map(&:name).select{|c| c.match('_id') || c.match('type')}.sort
+    rescue NoMethodError
+      columns = []
+    end
+    
+    columns
+  end
+  
+  private
+  
+  def models_with_columns
+    return @models_with_columns if @models_with_columns
+    
+    @models_with_columns = {}
+    #result = []
+    
+    classes.each do |klass| 
+      columns_for(klass).each do |column|
+        @models_with_columns[column] ||= []
+        @models_with_columns[column] << klass.to_s
+      end 
+      
+=begin      
+      klass.reflections.values.select{|r| r.macro == :has_many && r.options.has_key?(:as) }.each do |reflection|        
+        [
+          "#{reflection.options[:as].to_s}_type"#, "#{reflection.options[:as].to_s}_id"
+        ].each do |column|
+          @models_with_columns[column] ||= []
+          @models_with_columns[column] << reflection.options[:class_name] ? reflection.options[:class_name] : reflection.name.classify
+        end
+      end
+        
+      result << [klass.to_s, klass.table_name, ar_ancestors].inspect
+=end
+    end
+    
+    #raise @models_with_columns.inspect
+    
+    #raise Customer.reflections.values.select{|r| r.macro == :has_many && r.options[:as] == :owner }.first.inspect
+    #raise BaseValue.reflections.values.select{|r| r.macro == :belongs_to && r.options[:polymorphic] == true }.first.inspect
+    
+    #render :text => result.join('<br/>') and return
+    
+    @models_with_columns
+  end
+  
+  def get_super_active_record_ancestor(key_constant)
+    ancestors = active_record_ancestors(key_constant)
+    ancestors.none? ? key_constant.name : ancestors.last
+  end
+  
+  # TODO: move to ActiveRecord::Base ClassMethods
+  def active_record_ancestors(klass)
+    ar_ancestors = []
+    
+    klass.ancestors.map(&:to_s).uniq.each do |ancestor|
+      next if (ancestor == klass.to_s || ancestor == 'ActiveRecord::Base')
+      
+      ancestor_constant = ancestor.constantize rescue nil
+      
+      ancestor_constant == nil and next
+      
+      !ancestor_constant.ancestors.map(&:to_s).include?('ActiveRecord::Base') and next
+      
+      ar_ancestors << ancestor
+    end
+      
+    ar_ancestors  
+  end 
+  
+  def key_constant(key, parent = '')
+    key_was = key
+    key_constant = nil
+        
+    begin
+      key_constant = "#{parent}::#{key}".constantize
+    rescue
+      begin
+        key_constant = key.constantize
+        
+        !key_constant.ancestors.map(&:to_s).include?('ActiveRecord::Base') and raise key + 'is not a ActiveRecord instance.'
+      rescue
+        if parent.blank? && !key.match('::')
+          raise 'unexpected:' + key.inspect
+        elsif !parent.blank? && !key.match('::')
+          key = "#{parent}::#{key}"
+        elsif !parent.blank? && key.match('::')
+          raise "unexpected constellation of parent '#{parent}' and key '#{key}'"
+        end
+      
+        # e.g. DynamicForm::BaseElement::CheckBox should be DynamicForm::CheckBox
+        key = key.split('::')       
+        root_module = key.shift
+        klass = key.pop
+        
+        tries = []
+        
+        while key.any?
+          begin
+            key_constant_name = "#{root_module}::#{key.join('::')}::#{klass}"
+            tries << key_constant_name
+            key_constant = key_constant_name.constantize
+          rescue
+            key.pop
+          end
+          
+          break
+        end
+        
+        begin
+          key_constant_name = "#{root_module}::#{klass}"
+          tries << key_constant_name
+          key_constant = key_constant_name.constantize
+        rescue
+        end
+        
+        key_constant.blank? and raise 'unexpected that class for key "' + key_was + '" (' + ok.inspect + ') not found by one of these tries: ' + tries.inspect
+      end
+    end
+    
+    key_constant
+  end
+end

data/lib/rails_info/stack_trace.rb

@@ -0,0 +1,155 @@
+class RailsInfo::StackTrace
+  def initialize(stack_trace, options = {})
+    @request = options[:request]
+    @exception = options[:exception]
+    @rails_root = options[:rails_root] || Rails.root.to_s
+    @lines_of_code_around = options[:lines_of_code_around] || 5
+    @show_all = options[:show_all]
+    
+    if stack_trace.is_a?(String) && stack_trace.match('#')
+      # parse RSpec style stack trace "# ./app/observers/assignment_observer.rb:65:in `after_save'"
+      line_separator = if stack_trace.match(/\r\n/) 
+        "\r\n"
+      elsif stack_trace.match(/\\n/)
+        /\\n/
+      else 
+        "\n"
+      end
+      
+      stack_trace = stack_trace.split(line_separator).map{|line|line.gsub('#', '').gsub('./', rails_root + '/')}.map(&:strip)
+    elsif stack_trace.is_a?(String) && !stack_trace.strip.blank?
+      raise NotImplementedError.new(stack_trace.inspect)
+    end
+    
+    @stack_trace = stack_trace
+  end
+  
+  def exception
+    @exception
+  end
+  
+  def title
+    text = @exception.class.to_s
+    
+    if @request && @request.parameters['controller']
+      action = @request.parameters['action'].present? ? "##{@request.parameters['action']}" : ''
+      text += " in #{@request.parameters['controller'].camelize}Controller#{action}"
+    end
+    
+    text
+  end
+  
+  def message
+    @exception.message
+  end
+  
+  def lines_of_code_around
+    @lines_of_code_around
+  end
+  
+  def hash
+    return @hash if @hash
+    
+    @hash = {}
+    
+    parse_stack_trace
+    
+    @hash
+  end
+  
+  def request
+    @request
+  end
+  
+  def response
+    @response
+  end
+  
+  def rails_root
+    @rails_root
+  end
+  
+  private
+  
+  def parse_stack_trace
+    (@stack_trace.is_a?(Array) ? @stack_trace : []).each{|line| parse_stack_trace_line(line) }
+  end
+  
+  # TODO: add additionally tab with a diff of separate rails_root / gemset when those parameters have been passed
+  def parse_stack_trace_line(line_string)
+    method = line_string.match(/in `((.)+)'/)[1]
+    
+    line_string.gsub!(method, '')
+    line = line_string.split(':')
+    line = {file: line.first.strip, number: line.second.strip.to_i}
+    
+    code = {}
+    
+    if File.exist? line[:file]
+      code = code_with_line_numbers(line)
+    else
+      code = { text: "File #{line[:file]} not found", line_numbers: [0]}
+    end
+    
+    path = line[:file].split('/')
+    file_name = path.pop
+    
+    @hash["#{method} @ #{line[:number]} in #{file_name} of #{path.join('/')}"] = code
+ end
+ 
+ def code_with_line_numbers(options = {})
+    options.assert_valid_keys(:file, :number)
+    
+    middle_number = options[:number]
+    
+    lines_hash, current_number = {}, 0
+    
+    File.open options[:file] do |f|
+      f.each_line do |line|
+        current_number += 1
+
+        next if line.strip == "" # remove empty lines
+
+        lines_hash[current_number] = line
+      end
+    end
+    
+    not_empty_index, middle_index = 0, 0
+    
+    unless lines_hash.keys.include?(middle_number)
+      alternative_middle_numbers = lines_hash.keys.select{|number| number >= middle_number - @lines_of_code_around && number <= middle_number + @lines_of_code_around }
+      
+      if alternative_middle_numbers
+        middle_number = alternative_middle_numbers[(alternative_middle_numbers.length / 2).round - 1]
+      else
+        middle_number = nil
+      end
+    end
+    
+    lines_hash.each do |number,line| 
+      middle_index = not_empty_index if number == middle_number
+      not_empty_index += 1
+    end
+    
+    not_empty_index, lines, line_numbers = -1, [], []
+    highlighted_number, visible_number = nil, 1
+    
+    lines_hash.each do |number,line|
+      not_empty_index += 1
+      
+      unless @show_all || middle_number.nil?
+        next unless not_empty_index >= middle_index - @lines_of_code_around && not_empty_index <= middle_index + @lines_of_code_around
+      end
+        
+      lines << line
+      line_numbers << number
+      highlighted_number = visible_number if middle_number && number == middle_number
+      visible_number += 1
+    end
+    
+    # try to free memory
+    lines_hash = nil
+    
+    { text: lines.join(''), number: options[:number], line_numbers: line_numbers, highlighted_line_numbers: [highlighted_number] }
+  end
+end

data/lib/rails_info/version.rb

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

data/lib/tasks/rails_info_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_info do
+#   # Task goes here
+# end

data/spec/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
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- 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.