active_schema 0.1.0

data/.autotest

@@ -0,0 +1 @@
+require 'autotest/growl'

data/.document

@@ -0,0 +1,11 @@
+# .document is used by rdoc and yard to know how to generate documentation 
+# for example, it can be used to control how rdoc gets built when you do `gem install foo`
+
+README.rdoc
+lib/**/*.rb
+bin/*
+
+# Files below this - are treated as 'extra files', and aren't parsed for ruby code
+- 
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,48 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Netbeans
+nbproject/private
+
+
+
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+*~
+\#*
+.\#*
+#
+# For vim:
+#*.swp

data/.rspec

@@ -0,0 +1,3 @@
+--drb
+--colour
+--format nested

data/Gemfile

@@ -0,0 +1,21 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "foreigner"
+gem "activerecord"
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", ">= 2.0.0.beta.22"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.0.pre3"
+  gem "rcov", ">= 0"
+  gem 'rspec-rails', '>=2.0.0.beta.22'
+  gem 'autotest'
+  gem "autotest-growl"
+  gem "autotest-fsevent"
+  gem "spork"
+  gem "mysql2"
+end

data/Gemfile.lock

@@ -0,0 +1,63 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.0)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    autotest (4.3.2)
+    autotest-fsevent (0.2.3)
+      sys-uname
+    autotest-growl (0.2.6)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    foreigner (0.9.0)
+    git (1.2.5)
+    i18n (0.4.1)
+    jeweler (1.5.0.pre3)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mysql2 (0.2.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+      rspec-mocks (= 2.0.0.beta.22)
+    rspec-core (2.0.0.beta.22)
+    rspec-expectations (2.0.0.beta.22)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+    rspec-rails (2.0.0.beta.22)
+      rspec (= 2.0.0.beta.22)
+    spork (0.9.0.rc2)
+    sys-uname (0.8.4)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  autotest
+  autotest-fsevent
+  autotest-growl
+  bundler (~> 1.0.0)
+  foreigner
+  jeweler (~> 1.5.0.pre3)
+  mysql2
+  rcov
+  rspec (>= 2.0.0.beta.22)
+  rspec-rails (>= 2.0.0.beta.22)
+  spork

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Anders Johannsen
+
+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.textile

@@ -0,0 +1,80 @@
+h1. ActiveSchema
+
+ActiveSchema makes ActiveRecord a bit DRYer. It discovers associations, such as belongs_to and has_many, using foreign keys, and it adds validations to ensure constraints on data, like NOT NULL and maximum length, are honored.
+
+h2. An example
+
+If you have a table structure like this (arrows indicate foreign keys)
+
+  !http://farm5.static.flickr.com/4113/5047260003_da4ecd08ac_z.jpg!
+
+ActiveSchema would link your models like below
+
+<pre>
+class Prisoner
+  belongs_to :facility
+end
+
+class Facility
+  has_many :facilities
+  belongs_to :warden
+end
+
+class Warde
+  has_one :facility
+end
+</pre>
+
+
+h2. Usage
+
+Put
+
+@gem 'activeschema'@
+
+in your Gemfile.
+
+ActiveSchema can be enabled per model, or you can choose to make it available everywhere.
+
+Either way, it must be activated by the @active_schema@ class method. Per model:
+
+<pre>
+class Model < ActiveRecord::Base
+  active_schema
+end
+</pre>
+
+In ActiveRecord::Base:
+
+<pre>
+class ActiveRecord::Base
+  active_schema
+end
+</pre>
+
+
+h2. Foreign key support by 'foreigner'
+
+Foreign key information is extracted by the "Foreigner":http://github.com/matthuhiggins/foreigner library.
+It has out-of-the-box support for MySQL, Postgresql, and SQL2003.
+
+h2. Rails 3 and Ruby 1.9.2
+
+ActiveSchema has only been tested on Rails 3 and Ruby 1.9.2. It may work elsewhere, but there really is no guarantee.
+
+h2. Preloading the associations
+
+The speed at which MySQL supplies foreign key information can, at times, be leisurely, to say the least.
+
+To circumvent this, ActiveSchema supports foreign key extraction without hitting the database.
+Instead, it reads the information from the dumped "schema.rb" file, which of course must be current.
+
+Adjusted configuration:
+
+<pre>
+schema_feeder = ActiveSchema::SchemaFeeder.new
+schema_feeder.read("path/to/schema.rb")
+ActiveSchema.configure do |c|
+   c.feeder = schema_feeder
+end
+</pre>

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "active_schema"
+  gem.summary = %Q{Association discovery by foreign keys}
+  gem.description = %Q{If you've gone through the trouble of linking your schema with proper foreign keys,
+    defining associations in ActiveRecord feels like double work.
+
+    ActiveSchema discovers the associations and validations that can be derived from the database schema.
+  }
+  gem.email = "anders@johannsen.com"
+  gem.homepage = "http://github.com/andersjo/active_schema"
+  gem.authors = ["Anders Johannsen"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  spec.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  spec.add_development_dependency 'rspec', '> 1.2.3'
+#    spec.add_runtime_dependency 'jabber4r', '> 0.1'
+  gem.add_runtime_dependency 'foreigner'
+  gem.add_development_dependency "rspec", ">= 2.0.0.beta.19"
+  gem.add_development_dependency "bundler", "~> 1.0.0"
+  gem.add_development_dependency "jeweler", "~> 1.5.0.pre3"
+  gem.add_development_dependency "rcov", ">= 0"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "active_schema #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/lib/active_schema.rb

@@ -0,0 +1,30 @@
+require 'active_support/core_ext/string/inflections'
+
+require 'active_schema/configuration'
+require 'active_schema/on_the_fly_feeder'
+require 'active_schema/in_advance_feeder'
+require 'active_schema/schema_feeder'
+
+require 'active_schema/table'
+require 'active_schema/table_hub'
+
+
+require 'active_schema/validations/generator'
+require 'active_schema/associations/generator'
+require 'active_schema/associations/by_foreign_key'
+
+
+module ActiveSchema
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+end
+
+require 'active_record'
+require 'active_record/base'
+require 'active_schema/active_record/base'
+

data/lib/active_schema/active_record/base.rb

@@ -0,0 +1,46 @@
+module ActiveSchema
+  module ActiveRecord
+    module ClassMethods
+      def self.extended(klass)
+        klass.class_attribute :active_schema_activated
+        klass.class_attribute :active_schema_configuration
+        klass.active_schema_configuration = ActiveSchema.configuration
+      end
+
+      def active_schema
+        if !active_schema_activated
+          self.active_schema_activated = true
+          active_schema_load_model
+        end
+      end
+
+      def active_schema_load_model
+        unless active_schema_configuration.skip_model.call(self)
+          active_schema_configuration.feeder.model_loaded(self)
+        end
+      end
+
+    end
+
+    module InstanceMethods
+    end
+  end
+end
+
+ActiveRecord::Base
+module ActiveRecord #:nodoc:
+  class ModelLoadedObserver
+    def update(event, klass)
+      case event 
+      when :observed_class_inherited
+        klass.active_schema_load_model if klass.active_schema_activated
+      end
+    end
+  end
+
+  class Base
+    add_observer ModelLoadedObserver.new
+    extend  ActiveSchema::ActiveRecord::ClassMethods
+    include ActiveSchema::ActiveRecord::InstanceMethods
+  end
+end

data/lib/active_schema/associations/by_foreign_key.rb

@@ -0,0 +1,50 @@
+module ActiveSchema::Associations
+  module Naming
+    def name_for(model)
+      model.name.demodulize.underscore.downcase
+    end
+
+    def plural_name_for(model)
+      name_for(model).pluralize
+    end
+  end
+
+  class ByForeignKey
+    include Naming
+    def initialize(from_model, to_model, key_column, key_column_unique)
+      @from_model = from_model
+      @to_model = to_model
+      @key_column = key_column
+      @key_column_unique = key_column_unique
+    end
+
+    def association(receiver, method_name, name, opts = {})
+      receiver.send(method_name, name, opts)
+    end
+  end
+
+  class ByForwardForeignKey < ByForeignKey
+    def generate
+      association @from_model, :belongs_to,
+        name_for(@to_model),
+        { :class_name => @to_model.name, :foreign_key => @key_column }
+    end
+  end
+
+  class ByReverseForeignKey < ByForeignKey
+    def generate
+      if @key_column_unique
+        association @to_model, :has_one,
+          name_for(@from_model),
+          { :class_name => @from_model.name, :foreign_key => @key_column }
+      else
+        association @to_model, :has_many, 
+          plural_name_for(@from_model),
+          { :class_name => @from_model.name, :foreign_key => @key_column }
+      end
+
+    end
+
+  end
+
+end