ari 0.2.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 AtlantBH
+
+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.md

@@ -0,0 +1,99 @@
+Ari
+===
+
+Active Record Inspector - extend rails project to easily display and navigate through ActiveRecord Models. Ari will display model data including columns, relations (has and belongs) and custom functions. It's easy to customize and extend Ari for your purposes.
+
+Features
+--------
+
+* Generators - automatically generate Ari controller and corresponding views
+* Ari will display both belongs to and has relations as links for easy navigation
+* Customize each model which columns you don't wanna to display
+* Add functions that you like to display
+
+Requirements
+--------
+* Rails 3+
+
+Installation
+--------
+
+Install 'ari' gem:
+
+```
+gem 'ari'
+```
+
+or
+
+```
+gem 'ari', :git => git://github.com/ATLANTBH/ari.git
+```
+	
+Note: Currently ari was tested only on rails 3.0+	
+	
+Setup
+--------
+
+After installation run ari generator.
+
+```
+rails generate ari
+```
+	
+Add following resource to routes.rb.
+
+```
+resources :ari, :only => [:index, :show]
+```
+	
+Run rails and point your browser to ari route, e.g. http://localhost:3000/ari
+
+Customization
+--------
+
+By default ari will display following information from model:
+
+* all columns
+* all has_ relations
+* all belongs_ relations
+
+You can exclude informations via ari_options
+
+```
+class User < ActiveRecord::Base
+	ari_options	:exclude => [:password, :money]
+end
+```
+
+This will exclude columns/relations names 'password' and 'money' from displaying.
+
+In addition to excluding, sometimes is good idea to include results from some functions, e.g.
+
+```
+class User < ActiveRecord::Base
+	ari_options	:exclude => [:password, :money], :functions => ['displayable_name']
+	
+	def displayable_name
+		return self.name || self.email  # if name is nil return email as displayable_name
+	end
+end
+```
+
+Preview
+------
+
+Here is preview of ari:
+
+[Model listing](https://github.com/ATLANTBH/ari/raw/master/images/table-list.png "Model listing")
+[Sample table 1](https://github.com/ATLANTBH/ari/raw/master/images/sample-1.png "Sample table 1")
+[Sample table 2](https://github.com/ATLANTBH/ari/raw/master/images/sample-2.png "Sample table 2")
+
+License
+-------
+
+Copyright 2012 AtlantBH
+
+ari is licensed under the MIT License.
+
+For more info see MIT_LICENSE file.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Ari'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/ari.rb

@@ -0,0 +1,6 @@
+module Ari
+  autoload :ModelHelpers, 'ari/active_record'
+  autoload :Inspector, 'ari/inspector'
+  
+  ActiveRecord::Base.send(:include, Ari::ModelHelpers)
+end

data/lib/ari/active_record.rb

@@ -0,0 +1,33 @@
+module Ari
+  module ModelHelpers
+    extend ActiveSupport::Concern
+    
+    module ClassMethods
+
+      #
+      # options:
+      #     :exclude   => ['column_name', 'relation_name']
+      #     :functions => ['function']
+      #
+      def ari_options(options = {})
+        puts "ARI OPTIONS"
+        @ari_functions  ||= {}
+        @ari_exclude    ||= {}
+        options[:exclude].each { |x| @ari_exclude[x] = true } if options[:exclude]
+        options[:functions].each { |x| @ari_functions[x] = true } if options[:functions]
+        puts "ARI OPTIONS INSPECT : #{@ari_functions} : #{@ari_exclude}"
+      end
+
+      def ari_functions
+        puts "GET FOOS"
+        return @ari_functions || {}
+      end
+
+      def ari_exclude
+        puts "GET EXS"
+        return @ari_exclude || {}
+      end
+      
+    end
+  end
+end

data/lib/ari/inspector.rb

@@ -0,0 +1,153 @@
+module Ari
+  module Inspector
+    
+    # TODO - find smarter method to resolve non-conventional file/model names
+    def self.collect_models
+      models = []
+      
+      # touch classes (to preload them)
+      Dir["app/models/**/*.rb"].each do |model_file|
+        print "Resolving model : #{model_file} ... "
+        begin
+          File.basename(model_file, '.rb').camelize.constantize
+        rescue
+          puts "ERROR"
+          # Silent night, holy night, .... - skip files 
+        end
+        puts "DONE"
+      end
+      
+      ActiveRecord::Base.descendants.each do |desc|
+        models << { :model => desc.name, :table => desc.table_name, :count => desc.count} if desc.table_exists?
+      end
+      
+      return models.sort! {|a, b| a[:model] <=> b[:model]}
+    end
+    
+    def self.inspect_data(model_name, method, where_clause, parent_model_name, parent_id, belongs, collection, offset)
+      offset ||= 0
+      collection ||=  true
+      where_clause ||= ''
+      
+      
+      model_class = eval(model_name)
+      columns = model_class.columns
+
+      puts "GET GET"
+      ari_functions  = model_class.ari_functions
+      ari_exclude    = model_class.ari_exclude
+      
+      columns = model_class.columns
+      rows = []
+      count = 0
+      sql = ''
+
+      if (belongs.nil?)
+        if (where_clause)
+          rows = model_class.where(where_clause).limit(10).offset(offset).order(:id)
+          sql = "#{model_name}.where(#{where_clause})"
+          count = model_class.where(where_clause).count()
+        else
+          rows = model_class.send(method).limit(10).offset(offset).order(:id)
+          sql = "#{model_name}.#{method}()"
+          count = model_class.send(method).count()
+        end
+      else
+        parent_model_class = eval(parent_model_name)
+        parent_model = parent_model_class.find(parent_id)
+        result = nil
+        if (collection == 'true')
+          result = parent_model.send(method).limit(10).offset(offset).order(:id)
+          sql = "#{parent_model_name}.find(#{parent_id}).#{method}()"
+          count = parent_model.send(method).count()
+          rows = result if result != nil
+        else 
+          result = parent_model.send(method)
+          sql = "#{parent_model_name}.find(#{parent_id}).#{method}()"
+          rows = [result] if result != nil
+        end
+      end
+
+      belongs_to_relations = {}
+      has_relations = {}
+      model_class.reflect_on_all_associations.each do |rel|
+        begin
+          if (rel.belongs_to?)
+            belongs_to_relations[rel.association_foreign_key] = rel
+          else
+            has_relations[rel.name.to_s] = rel
+          end
+        rescue
+        end
+      end
+
+      inspected_data = {
+        :columns => [],
+        :rows => [],
+        :count => count,
+        :sql => sql
+      }
+
+  		columns.each do |column|
+  			rel = belongs_to_relations[column.name]
+  			
+  			label = rel ? rel.name : column.name
+  			
+  			if (ari_exclude[label].nil?)
+    			if rel
+    			  inspected_data[:columns] << { :label => label, :type => :bt }
+    			else
+    			  inspected_data[:columns] << { :label => label, :type => :simple }
+    			end
+    		end
+  		end
+  		has_relations.each do |name, rel|
+  			if (ari_exclude[rel.name].nil?)
+  		    inspected_data[:columns] << { :label => rel.name, :type => :has }
+		    end
+  		end
+  		
+  		ari_functions.each do |funct, dummy|
+  		  inspected_data[:columns] << { :label => funct, :type => :function }
+		  end
+
+
+      rows.each do |row|
+        one_row = []
+
+    		columns.each do |column|
+    		  rel = belongs_to_relations[column.name]
+    			if rel
+    				if row[column.name]
+    				  one_row << { :type =>:bt, :label => row[column.name], :params => {:parent_model =>model_name, :parent_id => row.id, :model => rel.class_name, :method => rel.name, :collection => rel.collection?.to_s, :belongs_to => true} }
+    				else
+    				  one_row << { :type =>:bt, :label => '', :params => {:parent_model =>model_name, :parent_id => row.id, :model => rel.class_name, :method => rel.name, :collection => rel.collection?.to_s, :belongs_to => true} }
+    				end
+    			else
+    				if column.name == 'id'
+    				  one_row << { :type => :id, :label => row[column.name], :params => {:model => model_name, :where => "id=#{row[column.name]}" } }
+    				else
+    				  one_row << { :type => :simple, :label => row[column.name] }
+    				end
+    			end
+    		end
+
+    		has_relations.each do |name, rel|
+    		  one_row << {:type => :has, :label => rel.name, :params => {:parent_model => model_name, :parent_id => row.id, :model => rel.class_name, :method => rel.name, :collection => rel.collection?.to_s, :belongs_to => 'false' }}
+    		end
+    		
+    		ari_functions.each do |funct, dummy|
+				  one_row << { :type => :function, :label => row.send(funct) }
+  		  end
+    		
+
+    		inspected_data[:rows] << one_row
+      end
+
+      return inspected_data
+
+    end    
+    
+    
+  end
+end

data/lib/ari/version.rb

@@ -0,0 +1,3 @@
+module Ari
+  VERSION = "0.2.1"
+end

data/lib/generators/USAGE

@@ -0,0 +1,4 @@
+Ari
+=============
+# Generate MVC 
+  rails generate ari

data/lib/generators/ari_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+
+class AriGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+                          
+  def self.source_root
+    @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates/'))
+  end
+
+  def create
+    template "views/index.html.erb", File.join('app/views', 'ari', "index.html.erb")
+    template "views/show.html.erb", File.join('app/views', 'ari', "show.html.erb")
+    template "views/_styles.html.erb", File.join('app/views', 'ari', "_styles.html.erb")
+    template "views/_paging.html.erb", File.join('app/views', 'ari', "_paging.html.erb")
+    template "controllers/ari_controller.rb", File.join('app/controllers', 'ari_controller.rb')
+  end
+end

data/lib/generators/templates/controllers/ari_controller.rb

@@ -0,0 +1,10 @@
+class AriController < ActionController::Base
+  def index
+    @models = Ari::Inspector.collect_models()
+  end
+  
+  def show
+    @data = Ari::Inspector.inspect_data(params[:id], params[:method], params[:where], params[:parent_model], params[:parent_id], params[:belongs_to], params[:collection], params[:offset].to_i)
+  end
+  
+end

data/lib/generators/templates/views/_paging.html.erb

@@ -0,0 +1,9 @@
+<div style="height:40px; margin-top:40px;">
+	<%% (0..((count / 10)-1)).each do |i|%>
+		<div style="float:left; padding:4px; line-height:13px; height:13px; background-color:<%%=offset/10 == i ? 'gray;' : 'white'%>; margin-left:3px;">
+			<%% offset = i * 10 %>
+			<%% params[:offset] = offset %>
+			<%%=link_to i,  {:controller => "ari", :action => "show", :id => params[:model], }.merge(params) %>
+		</div>
+	<%% end %>
+</div>

data/lib/generators/templates/views/_styles.html.erb

@@ -0,0 +1,49 @@
+<style>
+	.ari-table {
+		font-family:"lucida grande",tahoma,verdana,arial,sans-serif;
+		font-size: 12px;
+		border-width: 0px;
+		border-spacing: 0px;
+		border-style: solid;
+		border-color: gray;
+		border-collapse: collapse;
+	}
+	.ari-table th {
+		font-size: 12px;
+		max-width: 300px;
+		word-wrap: break-word;
+		padding: 6px;
+	}
+	.ari-table td {
+		font-size: 12px;
+		max-width: 300px;
+		word-wrap: break-word;
+		padding: 6px;
+		border-width: 1px;
+		border-color: gray;
+		border-style: inset;
+	}
+	.ari-name-div {
+		font-size:20px;
+		line-height:20px;
+		padding:10px;
+	}
+	.ari-simple {
+		
+	}
+	.ari-function {
+		background-color:#eeeeee;
+	}
+	.ari-bt {
+		background-color:#CDEBE8; 
+		font-weight:bold;
+	}
+	.ari-id {
+		font-weight:bold;
+	}
+	.ari-has {
+		background-color:#BDEBBB; 
+		font-weight:bold;
+	}
+	
+</style>