interrogator 1.0.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in interrogator.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+== MIT License
+
+Copyright (c) 2010, Jim Gay.
+
+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,11 @@
+# Interrogator
+
+Use this Rails Engine to get information about your classes.
+
+You'll be able to access `/interrogator.json?klass=SomeModel` to get
+details about the `klass` that you requested.
+It'll return JSON with details about the model's columns and it's 
+associated objects.
+
+If you have Searchlogic installed you'll get JSON options for
+querying from `/interrogator.js`

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/app/controllers/interrogator_controller.rb

@@ -0,0 +1,25 @@
+class InterrogatorController < ApplicationController
+  def show
+    respond_to do |format|
+      format.json do
+        param_class = params[:klass].to_s.camelize(:upper)
+        details = {}
+        if param_class.present?
+          klass = param_class.constantize
+          details[:columns] = klass.simple_columns_array
+          details[:associations] = klass.associated_models_hash
+        end
+        render :json => details
+      end
+      format.js do
+        query_options = {}
+        query_options.tap do |hash|
+          Interrogator::Conditions.constants.each do |konstant|
+            hash[konstant.to_sym] = Interrogator::Conditions.const_get(konstant.to_sym)
+          end
+        end
+        render :json => query_options
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+ActionController::Routing::Routes.draw do |map|
+  map.resource :interrogator, :only => :show, :controller => 'interrogator'
+end

data/interrogator.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "interrogator/version"
+
+Gem::Specification.new do |s|
+  s.name        = "interrogator"
+  s.version     = Interrogator::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jim Gay"]
+  s.email       = ["jim@saturnflyer.com"]
+  s.homepage    = "http://github.com/saturnflyer/interrogator"
+  s.summary     = %q{Interrogate an ActiveRecord class to get details about attributes and associations.}
+  s.description = %q{Ask an ActiveRecord class for details about the database columns and details about the defined associations.}
+
+  s.rubyforge_project = "interrogator"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/interrogator.rb

@@ -0,0 +1,39 @@
+require 'active_record'
+begin
+  require 'searchlogic'
+rescue LoadError
+  STDERR.puts "Interrogator uses Searchlogic to provide query options. You'll need to define these yourself if you don't intend to use Searchlogic"
+end
+module Interrogator
+  def simple_columns_array(options={})
+    @interrogator_columns_hash ||= columns_hash
+    sort = options[:sort]||true
+    excl_columns = options[:except]||[]
+    incl_columns = options[:only]||[]
+    res=[]
+    @interrogator_columns_hash.each { |k, v|
+      ks=k.to_sym
+      next if excl_columns.include?(ks) || (!incl_columns.empty? && !incl_columns.include?(ks))
+      res << {
+        :column_name => k,
+        :type => v.type,
+        :limit => v.limit,
+        :null => v.null
+      }
+    }
+    sort ? res.sort{|a,b| a[:column_name] <=> b[:column_name]} : res
+  end
+
+  def associated_models_hash
+     {}.tap do |hash|
+      [:has_many, :has_one, :belongs_to].each do |assoc|
+        hash[assoc] = []
+        reflect_on_all_associations(assoc).each do |reflection|
+          hash[assoc] << {:name => reflection.name, :options => reflection.options.tap{|o| o.delete(:extend)}}
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:extend, Interrogator)

data/lib/interrogator/conditions.rb

@@ -0,0 +1,11 @@
+module Interrogator
+  class Conditions
+    if defined?(Searchlogic)
+      Searchlogic::NamedScopes::Conditions.constants.each do |konstant|
+        konst_sym = konstant.intern
+        konst_val = Searchlogic::NamedScopes::Conditions.const_get(konst_sym)
+        const_set(konst_sym, konst_val)
+      end
+    end
+  end
+end

data/lib/interrogator/version.rb

@@ -0,0 +1,3 @@
+module Interrogator
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: interrogator
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jim Gay
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-17 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Ask an ActiveRecord class for details about the database columns and details about the defined associations.
+email: 
+- jim@saturnflyer.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/controllers/interrogator_controller.rb
+- config/routes.rb
+- interrogator.gemspec
+- lib/interrogator.rb
+- lib/interrogator/conditions.rb
+- lib/interrogator/version.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/saturnflyer/interrogator
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: interrogator
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Interrogate an ActiveRecord class to get details about attributes and associations.
+test_files: []
+