arspy 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+pkg
+nbproject

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006-2009 Jeff Patmon
+
+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/Rakefile

@@ -0,0 +1,101 @@
+#require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'gem_versions'
+#require 'rake/contrib/sshpublisher'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'arspy'
+  s.version = GemVersions.get_version
+  s.platform = Gem::Platform::RUBY
+  s.description = 'Active Record Spy'
+  s.summary = 'Rails console command line tool for browsing and inspecting the structure, associations and data of an ActiveRecord data model.'
+  
+  exclude_folders = '' # 'spec/rails/{doc,lib,log,nbproject,tmp,vendor,test}'
+  exclude_files = [] # FileList['**/*.log'] + FileList[exclude_folders+'/**/*'] + FileList[exclude_folders]
+  s.files = FileList['{lib,spec}/**/*'] + %w(init.rb LICENSE Rakefile README.rdoc .gitignore) - exclude_files
+  s.require_path = 'lib'
+  s.has_rdoc = true
+  s.test_files = Dir['spec/*_spec.rb']
+  
+  s.author = 'Jeff Patmon'
+  s.email = 'jpatmon@gmail.com'
+  s.homepage = 'http://github.com/jeffp/arspy/tree/master'
+end
+ 
+require 'spec/version'
+require 'spec/rake/spectask'
+
+desc "Run specs"
+namespace :spec do
+	task :default=>:object
+	Spec::Rake::SpecTask.new(:object) do |t|
+		t.spec_files = FileList['spec/*_spec.rb']
+		t.libs << 'lib' << 'spec'
+		t.rcov = false
+		t.spec_opts = ['--options', 'spec/spec.opts']
+		#t.rcov_dir = 'coverage'
+		#t.rcov_opts = ['--exclude', "kernel,load-diff-lcs\.rb,instance_exec\.rb,lib/spec.rb,lib/spec/runner.rb,^spec/*,bin/spec,examples,/gems,/Library/Ruby,\.autotest,#{ENV['GEM_HOME']}"]
+	end
+=begin
+	Spec::Rake::SpecTask.new(:sub) do |t|
+		t.spec_files = FileList['spec/inheritance_spec.rb']
+		t.libs << 'lib' << 'spec'
+		t.rcov = false
+		t.spec_opts = ['--options', 'spec/spec.opts']
+	end
+	Spec::Rake::SpecTask.new(:poro) do |t|
+		t.spec_files = FileList['spec/poro_spec.rb']
+		t.libs << 'lib' << 'spec'
+		t.rcov = false
+		t.spec_opts = ['--options', 'spec/spec.opts']
+	end
+
+  desc "Run ActiveRecord integration specs"
+	Spec::Rake::SpecTask.new(:active_record) do |t|
+		t.spec_files = FileList['spec/active_record/*_spec.rb']
+		t.libs << 'lib' << 'spec/active_record'
+		t.spec_opts = ['--options', 'spec/spec.opts']    
+		t.rcov = false
+	end
+	Spec::Rake::SpecTask.new(:forms) do |t|
+		t.spec_files = FileList['spec/rails/spec/integrations/*_spec.rb']
+		t.libs << 'lib' << 'spec/rails/spec'
+		t.spec_opts = ['--options', 'spec/spec.opts']    
+		t.rcov = false
+	end
+#	Spec::Rake::SpecTask.new(:associations) do |t|
+#		t.spec_files = FileList['spec/active_record/associations_spec.rb']
+#		t.libs << 'lib' << 'spec/active_record'
+#		t.rcov = false
+#	end
+	desc "Run all specs"
+	task :all=>[:object, :active_record, :forms]
+=end
+end
+
+
+desc "Generate documentation for the #{spec.name} gem."
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = spec.name
+  #rdoc.template = '../rdoc_template.rb'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc', 'LICENSE', 'lib/**/*.rb')
+end
+ 
+desc 'Generate a gemspec file.'
+task :gemspec do
+  File.open("#{spec.name}.gemspec", 'w') do |f|
+    f.write spec.to_ruby
+  end
+  GemVersions.increment_version
+end
+ 
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = RUBY_PLATFORM =~ /mswin/ ? false : true
+  p.need_zip = true
+end
+
+Dir['tasks/**/*.rake'].each {|rake| load rake}

data/init.rb

@@ -0,0 +1 @@
+require 'arspy'

data/lib/arspy/class_extensions.rb

@@ -0,0 +1,10 @@
+module Arspy
+  module ClassExtensions
+    module ActiveRecord
+      module Base
+        def la; Arspy::Operators.la(self); end
+        def lf; Arspy::Operators.lf(self); end
+      end
+    end
+  end
+end

data/lib/arspy/delegators/active_record_extensions.rb

@@ -0,0 +1,9 @@
+module Arspy
+  module Delegators
+    module ActiveRecordExtensions
+      def pr(*args); Arspy::Operators.print_object(self, *args); end
+      def la; Arspy::Operators.la(self.class); end
+      def lf; Arspy::Operators.lf(self.class); end
+    end
+  end
+end

data/lib/arspy/delegators/array_extensions.rb

@@ -0,0 +1,33 @@
+module Arspy
+  module Delegators
+    module ArrayExtensions
+      def self.included(base)
+        base.define_chained_method(:method_missing, :arspy) do |symbol, *args|
+          result = Arspy::Operators.interpret(self, symbol, *args)
+          result = method_missing_without_arspy(symbol, *args) unless result
+          result
+        end
+        base.define_chained_method(:id, :arspy) do
+          return id_without_arspy if (self.empty? || !self.first.is_a?(ActiveRecord::Base))
+          self.map(&:id)
+        end
+      end
+
+      def la
+        Arspy::Operators.la(self.first.class) unless (self.emtpy? || !(self.first.is_a?(ActiveRecord::Base)))
+      end
+      def lf
+        Arspy::Operators.lf(self.first.class) unless (self.empty? || !(self.first.is_a?(ActiveRecord::Base)))
+      end
+      def pr(*args)
+        Arspy::Operators.print_array(self, *args)
+      end
+      def wi(*args)
+        Arspy::Operators.with(self, *args)
+      end
+      def wo(*args)
+        Arspy::Operators.without(self, *args)
+      end
+    end
+  end
+end

data/lib/arspy/delegators/association_collection_extensions.rb

@@ -0,0 +1,34 @@
+module Arspy
+  module Delegators
+    module AssociationCollectionExtensions
+      def self.included(base)
+        base.define_chained_method(:method_missing, :arspy) do |symbol, *args|
+          load_target unless loaded?
+          result = Arspy::Operators.interpret(@target, symbol, *args)
+          result = method_missing_without_arspy(symbol, *args) unless result
+          result
+        end
+      end
+      def pr(*args)
+        load_target unless loaded?
+        Arspy::Operators.print_array(@target, *args)
+      end
+      def la
+        load_target unless loaded?
+        Arspy::Operators.la(@target.first.class) unless (@target.emtpy? || !(@target.first.is_a?(ActiveRecord::Base)))
+      end
+      def lf
+        load_target unless loaded?
+        Arspy::Operators.lf(@target.first.class) unless (@target.empty? || !(@target.first.is_a?(ActiveRecord::Base)))
+      end
+      def wi(*args)
+        load_target unless loaded?
+        Arspy::Operators.with(@target, *args)
+      end
+      def wo(*args)
+        load_target unless loaded?
+        Arspy::Operators.without(@target, *args)
+      end
+    end
+  end
+end

data/lib/arspy/delegators/factory.rb

@@ -0,0 +1,21 @@
+require 'arspy/delegators/null_extensions'
+require 'arspy/delegators/array_extensions'
+require 'arspy/delegators/association_collection_extensions'
+require 'arspy/delegators/active_record_extensions'
+
+module Arspy
+  module Delegators
+    module Factory
+      def self.module_for(klass)
+        case klass.name
+        when 'Array' then Arspy::Delegators::ArrayExtensions
+        when 'ActiveRecord::Base' then Arspy::Delegators::ActiveRecordExtensions
+        when 'ActiveRecord::Associations::HasManyThroughAssociation', 'ActiveRecord::Associations::AssociationCollection'
+          then Arspy::Delegators::AssociationCollectionExtensions
+        else
+          Arspy::Delegators::NullExtensions
+        end
+      end
+    end
+  end
+end

data/lib/arspy/delegators/null_extensions.rb

@@ -0,0 +1,9 @@
+module Arspy
+  module Delegators
+    module NullExtensions
+      def la; end
+      def lf; end
+      def pr(*args); end
+    end
+  end
+end

data/lib/arspy/delegators.rb

@@ -0,0 +1,6 @@
+require 'arspy/delegators/factory'
+
+module Arspy
+  module Delegators
+  end
+end

data/lib/arspy/operators.rb

@@ -0,0 +1,129 @@
+module Arspy
+  module Operators
+    def self.la(active_record_klass)
+      counts = {}
+      rows = active_record_klass.reflect_on_all_associations.map do |a|
+        counts[a.macro] ||= 0
+        counts[a.macro] += 1
+        self.format_column_association(a)
+      end
+      rows.sort!{|a,b| a.first <=> b.first}
+      self.print_matrix(rows)
+      "Total: #{counts.inject(0){|sum, c| sum+c.last}} (" + counts.map{|c| "#{c.last} #{c.first}" }.join(', ') + ")"
+    end
+
+    def self.lf(active_record_klass)
+      rows = active_record_klass.columns.map do |c|
+        self.format_column_field(c)
+      end
+      rows.sort!{|a,b| a.first <=> b.first}
+      self.print_matrix(rows)
+      "Total #{active_record_klass.columns.size} field#{active_record_klass.columns.size == 1 ? '' : 's'}"
+    end
+
+    def self.format_column_association(a)
+      select_options = a.options.select{|k,v| [:through, :as, :polymorphic].include?(k)}
+      [a.name.to_s, a.macro.to_s, "(#{a.options[:class_name] || a.name.to_s.singularize.camelize})", select_options.empty? ? '' : Hash[*select_options.flatten].inspect]
+    end
+    def self.format_column_field(f)
+      [f.name.to_s, ":#{f.type}", "(#{f.sql_type})"]
+    end
+
+    def self.print_array(array, *args)
+      array.each{|element| puts element.is_a?(String) ? element : element.inspect } if args.empty?
+      self.print_matrix(
+        array.map do |obj|
+          args.map do |arg|
+            case arg
+            when Symbol then obj.__send__(arg)
+            when String then obj.respond_to?(arg) ? obj.__send__(arg) : (obj.instance_eval(arg) rescue nil)
+            else nil
+            end
+          end
+        end
+      ) unless args.empty?
+      nil
+    end
+
+    def self.print_object(object, *args)
+      print_matrix([args.map{|a| object[a]}]) if args
+      puts(object.inspect) unless args
+      nil
+    end
+    def self.test_object(obj, args)
+      args.any? do |arg|
+        case arg
+        when String then obj.instance_eval(arg) rescue false
+        when Integer then obj.id == arg
+        when Hash
+          arg.any?{|k,v| self.test_attribute(obj, k, (v.is_a?(Array) ? v : [v]) ) }
+        else
+          false
+        end
+      end
+    end
+    def self.with(array, *args)
+      return array if (args.empty? || array.nil? || array.empty?)
+      array.select{|o| o && self.test_object(o, args)}
+    end
+    def self.without(array, *args)
+      return array if (args.empty? || array.nil? || array.empty?)
+      array.select{|o| o && !self.test_object(o, args)}
+    end
+    def self.interpret(array, symbol, *args)
+      return nil unless (array && symbol)
+      return nil unless (array.is_a?(Array) && !array.empty? && array.first.is_a?(ActiveRecord::Base))
+
+      if array.first.class.reflect_on_all_associations.detect{|a| a.name == symbol}
+        array.map(&symbol).flatten
+      elsif (array.first.attribute_names.include?(symbol.to_s) || array.first.respond_to?(symbol))
+        return array.map(&symbol) if args.empty?
+        raise 'Hash not allowed as attribute conditionals' if args.any?{|a| a.is_a?(Hash)}
+        array.select{|o| o && self.test_attribute(o, symbol, args)}
+      else
+        nil
+      end
+    end
+
+    def self.test_attribute(obj, attr_sym, args)
+      return false if (obj.nil? || attr_sym.nil? || args.empty?)
+      value = obj.__send__(attr_sym)
+      args.any? do |arg|
+        case arg
+        when String then (arg == value || (obj.instance_eval("#{attr_sym} #{arg}") rescue false))
+        when Regexp then arg.match(value)
+        when Range then arg.include?(value)
+        when Integer then (value.is_a?(ActiveRecord::Base) ? arg == value.id : arg == value)  #TODO: what about value is association collection
+        when Float then arg == value
+        else
+          false
+        end
+      end
+    end
+
+    def self.prepare_arguments(symbol, *args)
+      return nil if args.empty?
+      Hash[*args.map{|a| a.is_a?(Hash) ? a.map{|k,v| [k, v]} : [symbol, a]}.flatten]
+    end
+
+    @@column_padding = 2
+    def self.print_matrix(matrix_array)
+      return nil if matrix_array.empty?
+      raise 'Cannot print a non-matrix array' unless matrix_array.all?{|ar| ar.is_a? Array }
+
+      columns_per_row = matrix_array.map{|ar| ar.size }.max
+      init_array = Array.new(columns_per_row, 0)
+      max_widths = matrix_array.inject(init_array)do |mw, row|
+        row.each_with_index do |string, index|
+          mw[index] = [string.to_s.length, mw[index]].max
+        end
+        mw
+      end
+      matrix_array.each do |row|
+        index = -1
+        puts (row.map{|column| column.to_s + ' '*(max_widths[index += 1] - column.to_s.length) }.join(' '*@@column_padding))
+      end
+      nil
+    end
+  end
+end

data/lib/arspy.rb

@@ -0,0 +1,26 @@
+raise 'Arspy only runs in an ActiveRecord environment' unless defined?(ActiveRecord::Base)
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__))
+
+require 'active_support/core_ext/string/inflections'
+require 'meta_programming'
+require 'arspy/operators'
+require 'arspy/delegators'
+require 'arspy/class_extensions'
+
+module Arspy
+  def self.included(base)
+    base.send :include, Delegators::Factory.module_for(base)
+    extension = "Arspy::ClassExtensions::#{base.name}".constantize rescue nil
+    base.extend(extension) if extension
+  end
+end
+
+a = ActiveRecord::Associations
+returning([Array, ActiveRecord::Base, a::AssociationCollection ]) { |classes|
+  unless a::HasManyThroughAssociation.superclass == a::HasManyAssociation
+    classes << a::HasManyThroughAssociation    
+  end
+}.each do |klass|
+  klass.send :include, Arspy
+end
+

data/lib/meta_programming/object.rb

@@ -0,0 +1,33 @@
+module MetaProgramming
+  module Object
+    def self.included(base)
+      raise 'This module may only be included in class Object' unless base.name == 'Object'
+      base.extend(ClassExtensions)
+    end
+
+    module ClassExtensions
+      def metaclass
+        class << self; self; end
+      end
+      def safe_alias_method_chain(method_name, ext)
+        class_eval do
+          method_name_with_ext = "#{method_name}_with_#{ext}".to_sym
+          if (method_defined?(method_name_with_ext) && !(metaclass.instance_variable_defined?("@#{method_name_with_ext}")))
+            if method_defined?(method_name.to_sym)
+              alias_method_chain(method_name.to_sym, ext.to_sym)
+            else
+              alias_method method_name.to_sym, method_name_with_ext
+              define_method("#{method_name}_without_#{ext}".to_sym) {|*args| }
+            end
+            metaclass.instance_variable_set("@#{method_name_with_ext}", true)
+          end
+        end
+      end
+
+      def define_chained_method(method_name, ext, &block)
+        define_method("#{method_name}_with_#{ext}".to_sym, block)
+        safe_alias_method_chain(method_name.to_sym, ext)
+      end
+    end
+  end
+end

data/lib/meta_programming.rb

@@ -0,0 +1,7 @@
+require 'meta_programming/object'
+
+module MetaProgramming
+end
+
+Object.send :include, MetaProgramming::Object
+

data/spec/database.rb

@@ -0,0 +1,63 @@
+require 'rubygems'
+
+gem 'activerecord', ENV['AR_VERSION'] ? "=#{ENV['AR_VERSION']}" : '>=2.1.0'
+require 'active_record'
+
+ActiveRecord::Base.establish_connection({'adapter' => 'sqlite3', 'database' => ':memory:'})
+ActiveRecord::Base.logger = Logger.new("#{File.dirname(__FILE__)}/active_record.log")
+cx = ActiveRecord::Base.connection
+
+cx.create_table(:things, :force=>true) do |t|
+
+end
+cx.create_table(:one_manies, :force=>true) do |t|
+
+end
+cx.create_table(:many_manies, :force=>true) do |t|
+
+end
+cx.create_table(:many_manies_things, :force=>true) do |t|
+
+end
+cx.create_table(:manies_one, :force=>true) do |t|
+
+end
+
+#basic_associations
+connection.create_table(:companies, :force=>true) do |t|
+  t.string :name
+  t.string :status
+end
+connection.create_table(:contract_workers, :force=>true) do |t|
+  t.references :company
+  t.references :contractor
+  t.string :status
+end
+connection.create_table(:licenses, :force=>true) do |t|
+  t.references :company
+  t.string :status
+end
+connection.create_table(:contractors, :force=>true) do |t|
+  t.string :name
+  t.string :status
+end
+connection.create_table(:employees, :force=>true) do |t|
+  t.references :company
+  t.string :name
+  t.string :status
+end
+
+#polymorphic_associations
+connection.create_table(:comments, :force=>true) do |t|
+  t.references :document, :polymorphic=>true
+  t.text :comment
+  t.string :status
+end
+connection.create_table(:articles, :force=>true) do |t|
+  t.string :name
+  t.string :status
+end
+connection.create_table(:images, :force=>true) do |t|
+  t.string :name
+  t.string :status
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: arspy
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jeff Patmon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-03 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Active Record Spy
+email: jpatmon@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/meta_programming/object.rb
+- lib/arspy/class_extensions.rb
+- lib/arspy/delegators/factory.rb
+- lib/arspy/delegators/association_collection_extensions.rb
+- lib/arspy/delegators/array_extensions.rb
+- lib/arspy/delegators/null_extensions.rb
+- lib/arspy/delegators/active_record_extensions.rb
+- lib/arspy/delegators.rb
+- lib/arspy/operators.rb
+- lib/meta_programming.rb
+- lib/arspy.rb
+- spec/database.rb
+- init.rb
+- LICENSE
+- Rakefile
+- README.rdoc
+- .gitignore
+has_rdoc: true
+homepage: http://github.com/jeffp/arspy/tree/master
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Rails console command line tool for browsing and inspecting the structure, associations and data of an ActiveRecord data model.
+test_files: []
+