conventional_models 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+tmp

data/Gemfile

@@ -0,0 +1,18 @@
+source :gemcutter
+
+group :features do
+  gem "cucumber", "0.6.4"
+  gem "aruba", "0.1.7"
+end
+
+group :specs do
+  gem "rspec", "1.3.0"
+end
+
+group :development do
+  gem "jeweler"
+  gem "rake"
+end
+
+gem "activerecord", "2.3.5"
+gem "sqlite3-ruby"

data/Gemfile.lock

@@ -0,0 +1,69 @@
+--- 
+dependencies: 
+  activerecord: 
+    group: 
+    - :default
+    version: = 2.3.5
+  sqlite3-ruby: 
+    group: 
+    - :default
+    version: ">= 0"
+  rake: 
+    group: 
+    - :development
+    version: ">= 0"
+  rspec: 
+    group: 
+    - :specs
+    version: = 1.3.0
+  aruba: 
+    group: 
+    - :features
+    version: = 0.1.7
+  jeweler: 
+    group: 
+    - :development
+    version: ">= 0"
+  cucumber: 
+    group: 
+    - :features
+    version: = 0.6.4
+specs: 
+- rake: 
+    version: 0.8.7
+- activesupport: 
+    version: 2.3.5
+- activerecord: 
+    version: 2.3.5
+- aruba: 
+    version: 0.1.7
+- builder: 
+    version: 2.1.2
+- diff-lcs: 
+    version: 1.1.2
+- json_pure: 
+    version: 1.2.4
+- polyglot: 
+    version: 0.3.1
+- term-ansicolor: 
+    version: 1.0.5
+- treetop: 
+    version: 1.4.5
+- cucumber: 
+    version: 0.6.4
+- gemcutter: 
+    version: 0.5.0
+- git: 
+    version: 1.2.5
+- rubyforge: 
+    version: 2.0.4
+- jeweler: 
+    version: 1.4.0
+- rspec: 
+    version: 1.3.0
+- sqlite3-ruby: 
+    version: 1.2.5
+hash: e54d068ab5b54822142a3392faafd4850696a431
+sources: 
+- Rubygems: 
+    uri: http://gemcutter.org

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Steve Hodgkiss
+
+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.rdoc

@@ -0,0 +1,17 @@
+= ConventionalModels
+
+Generate ActiveRecord models with basic relationships based on conventions.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Steve Hodgkiss. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,85 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "conventional_models"
+    gem.description = %Q{Generate ActiveRecord models automatically with basic relationships based on conventions.}
+    gem.summary = %Q{Generate ActiveRecord models. For lazy people.}
+    gem.email = "steve@hodgkiss.me.uk"
+    gem.homepage = "http://github.com/stevehodgkiss/conventional_models"
+    gem.authors = ["Steve Hodgkiss"]
+    gem.add_development_dependency "rspec", ">= 1.3.0"
+    gem.add_development_dependency "cucumber", ">= 0.6.4"
+    gem.add_development_dependency "aruba", ">= 0.1.7"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+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 = "conventional_models #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/conventional_models.gemspec

@@ -0,0 +1,80 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{conventional_models}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Steve Hodgkiss"]
+  s.date = %q{2010-04-10}
+  s.description = %q{Generate ActiveRecord models automatically with basic relationships based on conventions.}
+  s.email = %q{steve@hodgkiss.me.uk}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "conventional_models.gemspec",
+     "features/conventional_models.feature",
+     "features/output_model_code.feature",
+     "features/step_definitions/conventional_models_steps.rb",
+     "features/step_definitions/output_model_code_steps.rb",
+     "features/support/env.rb",
+     "lib/conventional_models.rb",
+     "lib/conventional_models/active_record_base_model_for.rb",
+     "lib/conventional_models/column.rb",
+     "lib/conventional_models/conventions.rb",
+     "lib/conventional_models/database.rb",
+     "lib/conventional_models/table.rb",
+     "lib/conventional_models/version.rb",
+     "spec/conventional_models/conventions_spec.rb",
+     "spec/conventional_models/database_spec.rb",
+     "spec/conventional_models/table_spec.rb",
+     "spec/conventional_models_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/stevehodgkiss/conventional_models}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Generate ActiveRecord models. For lazy people.}
+  s.test_files = [
+    "spec/conventional_models/conventions_spec.rb",
+     "spec/conventional_models/database_spec.rb",
+     "spec/conventional_models/table_spec.rb",
+     "spec/conventional_models_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_development_dependency(%q<cucumber>, [">= 0.6.4"])
+      s.add_development_dependency(%q<aruba>, [">= 0.1.7"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_dependency(%q<cucumber>, [">= 0.6.4"])
+      s.add_dependency(%q<aruba>, [">= 0.1.7"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    s.add_dependency(%q<cucumber>, [">= 0.6.4"])
+    s.add_dependency(%q<aruba>, [">= 0.1.7"])
+  end
+end
+

data/features/conventional_models.feature

@@ -0,0 +1,80 @@
+Feature: ConventionalModels
+  In order play with my database
+  As a lazy fuck
+  I want conventional ActiveRecord models for my database
+
+  Scenario Outline: One table, no rows
+    Given a table "<table_name>"
+    And a file named "my_script.rb" with:
+      """
+      $:.unshift("../../lib")
+      require 'rubygems'
+      require 'active_record'
+      ActiveRecord::Base.establish_connection(:database => '../test.sqlite', :adapter => 'sqlite3')
+      require 'conventional_models'
+      ConventionalModels.configure
+      puts "Number of records: #{<model_name>.count}"
+      """
+    When I run "ruby my_script.rb"
+    Then I should see "Number of records: 0"
+    
+    Examples:
+      | table_name    | model_name  |
+      | pages         | Page        |
+      | content_items | ContentItem |
+  
+  Scenario Outline: One table, no rows, legacy database
+    Given a table "<table_name>"
+    And a file named "my_script.rb" with:
+      """
+      $:.unshift("../../lib")
+      require 'rubygems'
+      require 'active_record'
+      ActiveRecord::Base.establish_connection(:database => '../test.sqlite', :adapter => 'sqlite3')
+      require 'conventional_models'
+      ConventionalModels.configure do
+        table_name do |table|
+          table
+        end
+      end
+      puts "Number of records: #{<model_name>.count}"
+      """
+    When I run "ruby my_script.rb"
+    Then I should see "Number of records: 0"
+
+    Examples:
+      | table_name    | model_name  |
+      | Page          | Page        |
+      | ContentItem   | ContentItem |
+  
+  Scenario: Two tables with belongs_to and has_many relationship
+    Given a table "Page" with the following columns
+      | name    | type    |
+      | Id      | integer |
+      | Name    | string  |
+    And a table "ContentItems" with the following columns
+      | name    | type                                       |
+      | Id      | INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL |
+      | Name    | string                                     |
+      | Page_id | integer                                    |
+    And a file named "my_script.rb" with:
+      """
+      $:.unshift("../../lib")
+      require 'rubygems'
+      require 'active_record'
+      ActiveRecord::Base.establish_connection(:database => '../test.sqlite', :adapter => 'sqlite3')
+      require 'conventional_models'
+      ConventionalModels.configure do
+        primary_key_name "Id"
+        table_name do |table|
+          table
+        end
+      end
+      page = Page.create :Name => 'test'
+      page.content_items.create :Name => 'content1'
+      puts "My page's content item name: #{page.content_items.first.Name}"
+      """
+    When I run "ruby my_script.rb"
+    Then I should see "My page's content item name: content1"
+  
+  

data/features/output_model_code.feature

@@ -0,0 +1,42 @@
+Feature: Output model code
+  In order to see what model code has been generated
+  As a lazy fuck
+  I want to be able to output the evaluated model code
+
+  Scenario: A page with many content items
+    Given a table "Page" with the following columns
+      | name    | type    |
+      | Id      | integer |
+      | Name    | string  |
+    And a table "ContentItem" with the following columns
+      | name    | type                                       |
+      | Id      | INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL |
+      | Name    | string                                     |
+      | Page_id | integer                                    |
+    And a file named "my_script.rb" with:
+      """
+      $:.unshift("../../lib")
+      require 'rubygems'
+      require 'active_record'
+      ActiveRecord::Base.establish_connection(:database => '../test.sqlite', :adapter => 'sqlite3')
+      require 'conventional_models'
+      ConventionalModels.configure do
+        primary_key_name "Id"
+        table_name do |table|
+          table
+        end
+      end
+      puts "ContentItem code:<<\n#{ContentItem.model_code}>>"
+      puts "Page code:<<\n#{Page.model_code}>>"
+      """
+    When I run "ruby my_script.rb"
+    And within "ContentItem code" I should see:
+      | line                         |
+      | set_table_name "ContentItem" |
+      | set_primary_key "Id"         |
+      | belongs_to :page             |
+    Then within "Page code" I should see:
+      | line                    |
+      | set_table_name "Page"   |
+      | set_primary_key "Id"    |
+      | has_many :content_items |

data/features/step_definitions/conventional_models_steps.rb

@@ -0,0 +1,12 @@
+Given /^a table "([^\"]*)"$/ do |name|
+  ActiveRecord::Base.connection.execute "CREATE TABLE \"#{name}\" (\"id\" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL)"
+end
+
+Given /^a table "([^\"]*)" with the following columns$/ do |name, table|
+  columns = []
+  table.hashes.each do |column|
+    columns << "#{column["name"]} #{column["type"]}"
+  end
+  sql = "CREATE TABLE \"#{name}\" (#{columns.join(", ")})"
+  ActiveRecord::Base.connection.execute sql
+end

data/features/step_definitions/output_model_code_steps.rb

@@ -0,0 +1,7 @@
+Then /^within "([^\"]*)" I should see:$/ do |within, table|
+  puts combined_output
+  output = combined_output.scan(/#{within}:\<\<(.*)\>\>/m).to_s
+  table.hashes.each do |row|
+    output.should =~ /#{row["line"]}/
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'conventional_models'
+
+require 'spec/expectations'
+
+require 'aruba'
+require 'active_record'
+
+Before do
+  config = {
+    :development => {
+      :database => 'tmp/test.sqlite',
+      :adapter => 'sqlite3'
+    }
+  }
+  
+  ActiveRecord::Base.configurations = config
+  
+  system "mkdir -p tmp"
+  system 'rm -f tmp/test.sqlite'
+  ActiveRecord::Base.establish_connection(config[:development])
+end

data/lib/conventional_models/active_record_base_model_for.rb

@@ -0,0 +1,5 @@
+class ActiveRecord::Base
+  def self.model_code
+    ::ConventionalModels.model_code_for(table_name)
+  end
+end

data/lib/conventional_models/column.rb

@@ -0,0 +1,7 @@
+require 'active_record/connection_adapters/abstract/schema_definitions'
+
+module ConventionalModels
+  class Column < ActiveRecord::ConnectionAdapters::Column
+  
+  end
+end

data/lib/conventional_models/conventions.rb

@@ -0,0 +1,48 @@
+module ConventionalModels
+  class Conventions
+    def initialize(&block)
+      builder = Builder.new(self)
+      builder.instance_eval(&block) if block
+    end
+    
+    attr_accessor :ignored_tables, :primary_key_name, :class_name,
+                  :table_name, :belongs_to_matcher, :belongs_to_name
+    
+    class Builder
+      def initialize(config)
+        @config = config
+        belongs_to_matcher {|column| column.name.end_with? "_id"}
+        belongs_to_name {|column| column.name.gsub(/_id$/, "")}
+        primary_key_name "id"
+        table_name {|table_name| table_name.pluralize}
+        class_name {|table_name| table_name.singularize.camelize}
+        ignore_tables "schema_migrations", "sqlite_sequence", "sysdiagrams"
+      end
+      
+      def ignore_tables(*tables)
+        @config.ignored_tables = tables.map{|t|t.to_s}
+      end
+      
+      def primary_key_name(name)
+        @config.primary_key_name = name
+      end
+      
+      def table_name(&block)
+        @config.table_name = block
+      end
+      
+      def belongs_to_matcher(&block)
+        @config.belongs_to_matcher = block
+      end
+      
+      def belongs_to_name(&block)
+        @config.belongs_to_name = block
+      end
+      
+      def class_name(&block)
+        @config.class_name = block
+      end
+    end
+  end
+  
+end

data/lib/conventional_models/database.rb

@@ -0,0 +1,44 @@
+require 'active_support/core_ext/string/inflections'
+
+module ConventionalModels
+  class Database
+    attr_accessor :tables
+    
+    def initialize(connection)
+      @connection = connection
+      @tables = []
+    end
+    
+    def apply_conventions(conventions)
+      @connection.tables.select{|table| !conventions.ignored_tables.include? table}.each do |table|
+        @tables << Table.new(table, @connection.columns(table))
+      end
+      
+      @tables.each{|table| table.apply_conventions(conventions)}
+      
+      @tables.each do |table|
+        table.belongs_to_names.each do |belongs_to|
+          name = conventions.belongs_to_name.call(belongs_to)
+          table_name = conventions.table_name.call(name)
+          has_many_table = @tables.select{|t| t.name == table_name}.first
+          if has_many_table
+            has_many_table.lines << "has_many :#{table.name.tableize}, :class_name => '#{table.class_name}', :primary_key => '#{conventions.primary_key_name}', :foreign_key => '#{belongs_to.name}'"
+          end
+        end
+      end
+    end
+    
+    def code
+      @tables.map{|t| t.code}.join("\n")
+    end
+    
+    def code_for(table_name)
+      table = @tables.select{|t| t.name == table_name}.first
+      if table
+        table.code
+      else
+        "#{table_name} not found"
+      end
+    end
+  end
+end

data/lib/conventional_models/table.rb

@@ -0,0 +1,37 @@
+module ConventionalModels
+  class Table
+    attr_accessor :name, :columns, :lines, :belongs_to_names, :class_name
+    
+    def initialize(name, columns)
+      @name = name
+      @columns = columns
+      @lines = []
+      @belongs_to_names = []
+    end
+    
+    def ==(other)
+      @name == other.name
+    end
+    
+    def apply_conventions(conventions)
+      @class_name = conventions.class_name.call(@name)
+      
+      @lines << "set_primary_key \"#{conventions.primary_key_name}\""
+      
+      table_name = conventions.table_name.call(name)
+      @lines << "set_table_name \"#{table_name}\""
+      
+      @columns.each do |column|
+        if conventions.belongs_to_matcher.call(column)
+          name = conventions.belongs_to_name.call(column)
+          @belongs_to_names << column
+          @lines << "belongs_to :#{name.underscore}, :class_name => '#{conventions.class_name.call(name)}'"
+        end
+      end
+    end
+    
+    def code
+      "class ::#{@name.singularize.camelize} < ::ActiveRecord::Base\n#{@lines.join("\n")}\nend"
+    end
+  end
+end

data/lib/conventional_models/version.rb

@@ -0,0 +1,9 @@
+module ConventionalModels #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    BUILD = 1
+ 
+    STRING = [MAJOR, MINOR, BUILD].join('.')
+  end
+end

data/lib/conventional_models.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'active_record'
+require 'active_support'
+require 'conventional_models/version'
+require 'conventional_models/conventions'
+require 'conventional_models/database'
+require 'conventional_models/table'
+require 'conventional_models/column'
+require 'conventional_models/active_record_base_model_for'
+
+module ConventionalModels
+  def self.configure(&block)
+    @@conventions = Conventions.new(&block)
+    @@database = Database.new(::ActiveRecord::Base.connection)
+    @@database.apply_conventions(@@conventions)
+    run_code @@database.code
+  end
+  
+  def self.run_code(code)
+    eval code
+  end
+  
+  def self.model_code
+    @@database.code
+  end
+  
+  def self.model_code_for(table)
+    @@database.code_for(table)
+  end
+end

data/spec/conventional_models/conventions_spec.rb

@@ -0,0 +1,67 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module ConventionalModels 
+  describe Conventions do
+    it "should set ignored tables" do
+      config = Conventions.new do
+        ignore_tables "slc", "abc"
+      end
+      config.ignored_tables.should == ["slc", "abc"]
+    end
+  
+    it "should set primary key name" do
+      config = Conventions.new do
+        primary_key_name "Id"
+      end
+      config.primary_key_name.should == "Id"
+    end
+  
+    it "should set table name" do
+      config = Conventions.new do
+        table_name do |table_name|
+          table_name
+        end
+      end
+      config.table_name.call("test").should == "test"
+    end
+  
+    it "should set belongs to matcher" do
+      config = Conventions.new do
+        belongs_to_matcher do |column|
+          true
+        end
+      end
+      config.belongs_to_matcher.call("test_id").should be_true
+    end
+  
+    it "should set belongs to name" do
+      config = Conventions.new do
+        belongs_to_name do |column|
+          column
+        end
+      end
+      config.belongs_to_name.call("test").should == "test"
+    end
+    
+    it "should set class name" do
+      config = Conventions.new do
+        class_name do |column|
+          "test"
+        end
+      end
+      config.class_name.call("").should == "test"
+    end
+  
+    it "should have default settings" do
+      @site_id_column = Column.new("site_id", nil, "integer")
+      
+      config = Conventions.new
+      config.belongs_to_name.call(@site_id_column).should == "site"
+      config.belongs_to_matcher.call(@site_id_column).should be_true
+      config.primary_key_name.should == "id"
+      config.table_name.call("pages").should == "pages"
+      config.class_name.call("pages").should == "Page"
+      config.ignored_tables.should == %w{schema_migrations sqlite_sequence sysdiagrams}
+    end
+  end
+end

data/spec/conventional_models/database_spec.rb

@@ -0,0 +1,90 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module ConventionalModels
+  describe Database do
+    before(:each) do
+      @conventions = mock(Conventions)
+      @conventions.stub(:ignored_tables).and_return([])
+      
+      @connection = mock(::ActiveRecord::ConnectionAdapters::AbstractAdapter)
+      @columns = [mock(Column)]
+      
+      @connection.stub(:tables).and_return(["Test"])
+      @connection.stub(:columns).with("Test").and_return(@columns)
+      
+      @table = mock(Table)
+      @table.stub(:apply_conventions)
+      @table.stub(:belongs_to_names).and_return([])
+      @table.stub(:name).and_return("Test")
+      Table.stub(:new => @table)
+    end
+    
+    describe "#apply_conventions" do
+      before(:each) do
+        @database = Database.new(@connection)
+      end
+      
+      it "creates a table with the table name and the column definitions" do
+        Table.should_receive(:new).with("Test", @columns).and_return(@table)
+        @database.apply_conventions(@conventions)
+        @database.tables.first.should == @table
+      end
+      
+      it "applies conventions to each table" do
+        @table.should_receive(:apply_conventions).with(@conventions)
+        @database.apply_conventions(@conventions)
+      end
+      
+      describe "has many relationships" do
+        before(:each) do
+          @connection.stub(:tables).and_return(["sites", "pages"])
+          
+          Table.unstub!(:new)
+          @site_columns = [Column.new("name", nil, "string")]
+          @pages_columns = [Column.new("site_id", nil, "integer")]
+          
+          @connection.stub(:columns).with("sites").and_return(@site_columns)
+          @connection.stub(:columns).with("pages").and_return(@pages_columns)
+        end
+        
+        it "sets site to have many pages" do
+          @database.apply_conventions(Conventions.new)
+          @database.tables.first.name.should == "sites"
+          @database.tables.first.lines.last.should == "has_many :pages, :class_name => 'Page', :primary_key => 'id', :foreign_key => 'site_id'"
+        end
+      end
+      
+      it "ignores tables" do
+        @conventions = Conventions.new do
+          ignore_tables "Test"
+        end
+        @table.should_not_receive(:apply_conventions)
+        @database.apply_conventions(@conventions)
+      end
+    end
+
+    describe "code outputting" do
+      before(:each) do
+        @table.stub(:name).and_return("Test")
+        @database = Database.new(@connection)
+        @database.apply_conventions(@conventions)
+      end
+      describe "#code" do
+        it "should return the code for each table" do
+          @table.should_receive(:code).and_return("test")
+          @database.code.should == "test"
+        end
+      end
+    
+      describe "#code_for" do
+        it "should return the model code for a specific table" do
+          @table.should_receive(:code).and_return("test")
+          @database.code_for("Test").should == "test"
+        end
+        it "should return not found for unknown tables" do
+          @database.code_for("SomeTable").should == "SomeTable not found"
+        end
+      end
+    end
+  end
+end

data/spec/conventional_models/table_spec.rb

@@ -0,0 +1,89 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module ConventionalModels
+  describe Table do
+    before(:each) do
+      @columns = [mock(Column, :name => "test")]
+    end
+    
+    describe ".new" do
+      it "sets the name" do
+        Table.new("test", @columns).name.should == "test"
+      end
+      
+      it "sets the columns" do
+        Table.new("test", @columns).columns.should == @columns
+      end
+    end
+    
+    describe "#==" do
+      it "is true for tables with the same name" do
+        Table.new("Page", @columns).should == Table.new("Page", @columns)
+      end
+      
+      it "is false for tables with different names" do
+        Table.new("Page", @columns).should_not == Table.new("Bar", @columns)
+      end
+    end
+    
+    describe "#apply_conventions" do
+      it "sets the primary key" do
+        @conventions = Conventions.new do
+          primary_key_name "ID"
+        end
+        @table = Table.new("Page", @columns)
+        @table.apply_conventions(@conventions)
+        @table.lines[0].should == "set_primary_key \"ID\""
+      end
+      
+      it "sets the table name" do
+        @conventions = Conventions.new do
+          table_name do |table|
+            "Test"
+          end
+        end
+        @table = Table.new("Page", @columns)
+        @table.apply_conventions(@conventions)
+        @table.lines[1].should == "set_table_name \"Test\""
+      end
+      
+      it "sets the class name" do
+        @conventions = Conventions.new do
+          class_name do |table|
+            "BOO"
+          end
+        end
+        @table = Table.new("Page", @columns)
+        @table.apply_conventions(@conventions)
+        @table.class_name.should == "BOO"
+      end
+      
+      it "sets belongs to columns" do
+        @conventions = Conventions.new
+        @columns = [Column.new("Site_id", nil, "integer")]
+        @table = Table.new("Page", @columns)
+        @table.apply_conventions(@conventions)
+        @table.lines[2].should == "belongs_to :site, :class_name => 'Site'"
+        @table.belongs_to_names.first.name.should == "Site_id"
+      end
+      
+    end
+    
+    describe "#code" do
+      before(:each) do
+        @table = Table.new("pages", @columns)
+      end
+      
+      it "returns an empty activerecord class with no columns" do
+        @model_code = @table.code
+        @model_code.should == %Q{class ::Page < ::ActiveRecord::Base\n\nend}
+      end
+      
+      it "returns lines in the model definition" do
+        @table.lines << "test"
+        @model_code = @table.code
+        @model_code.split("\n")[1].should == "test"
+      end
+    end
+  end
+end

data/spec/conventional_models_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+module ConventionalModels
+  describe ConventionalModels do
+    before(:each) do
+      @conventions = mock(Conventions)
+      Conventions.stub(:new => @conventions)
+      
+      ConventionalModels.stub(:run_code)
+      
+      @connection = mock(Column)
+      ::ActiveRecord::Base.stub(:connection).and_return(@connection)
+      
+      @generated_code = mock(String)
+      @database = mock(Database, :code => @generated_code)
+      @database.stub(:apply_conventions).with(@conventions)
+      Database.stub(:new => @database)
+    end
+    
+    describe ".configure" do
+      describe "with no args" do        
+        it "creates a database object with the connection and conventions" do
+          Database.should_receive(:new).with(@connection).and_return(@database)
+          ConventionalModels.configure
+        end
+        
+        it "called apply_conventions on the database object" do
+          @database.should_receive(:apply_conventions).with(@conventions)
+          ConventionalModels.configure
+        end
+      
+        it "run the generated code" do
+          ConventionalModels.should_receive(:run_code).with(@generated_code)
+          ConventionalModels.configure
+        end
+      end
+    end
+    
+    describe ".run_code" do
+      it "evaluates the code (probably using Kernel#eval...)" do
+        ConventionalModels.unstub!(:run_code)
+        ConventionalModels.run_code("1 + 1").should == 2
+        ConventionalModels.run_code("'banana'.reverse").should == "ananab"
+      end
+    end
+    
+    describe ".model_code" do
+      it "returns the database code" do
+        ConventionalModels.configure
+        ConventionalModels.model_code.should == @generated_code
+      end
+    end
+    
+    describe ".model_code_for" do
+      it "returns the model code for a specific model" do
+        @database.should_receive(:code_for).with("Test").and_return("test")
+        ConventionalModels.configure
+        ConventionalModels.model_code_for("Test").should == "test"
+      end
+    end
+  end  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:specs)
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'conventional_models'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification 
+name: conventional_models
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Steve Hodgkiss
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-10 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  prerelease: false
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :development
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 4
+        version: 0.6.4
+  prerelease: false
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  name: aruba
+  type: :development
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 7
+        version: 0.1.7
+  prerelease: false
+  requirement: *id003
+description: Generate ActiveRecord models automatically with basic relationships based on conventions.
+email: steve@hodgkiss.me.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- conventional_models.gemspec
+- features/conventional_models.feature
+- features/output_model_code.feature
+- features/step_definitions/conventional_models_steps.rb
+- features/step_definitions/output_model_code_steps.rb
+- features/support/env.rb
+- lib/conventional_models.rb
+- lib/conventional_models/active_record_base_model_for.rb
+- lib/conventional_models/column.rb
+- lib/conventional_models/conventions.rb
+- lib/conventional_models/database.rb
+- lib/conventional_models/table.rb
+- lib/conventional_models/version.rb
+- spec/conventional_models/conventions_spec.rb
+- spec/conventional_models/database_spec.rb
+- spec/conventional_models/table_spec.rb
+- spec/conventional_models_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/stevehodgkiss/conventional_models
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: Generate ActiveRecord models. For lazy people.
+test_files: 
+- spec/conventional_models/conventions_spec.rb
+- spec/conventional_models/database_spec.rb
+- spec/conventional_models/table_spec.rb
+- spec/conventional_models_spec.rb
+- spec/spec_helper.rb