conventional_models 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,6 +1,60 @@
 = ConventionalModels
 
-Generate ActiveRecord models with basic relationships based on conventions.
+Generate ActiveRecord models automatically with basic relationships based on conventions.
+
+== Install
+
+  gem install conventional_models
+
+== Example
+
+We have a table called Page and another called ContentItems (not following ActiveRecord conventions).
+
+  # point active_record to a database
+  require 'rubygems'
+  require 'active_record'
+  ActiveRecord::Base.establish_connection(:database => 'db.sqlite', :adapter => 'sqlite3')
+  
+  # set your conventions
+  require 'conventional_models'
+  ConventionalModels.configure do
+    primary_key_name "Id"
+    table_name do |table|
+      table
+    end
+  end
+  
+  # use the models
+  page = Page.create :Name => 'test'
+  page.content_items.create :Name => 'content1'
+  
+  # have a look at the generated code
+  puts Page.model_code
+  puts ContentItem.model_code
+
+Output:
+
+  class ::Page < ::ActiveRecord::Base
+    set_primary_key "Id"
+    set_table_name "Page"
+    has_many :content_items, :class_name => 'ContentItem', :primary_key => 'Id', :foreign_key => 'Page_id'
+  end
+  class ::ContentItem < ::ActiveRecord::Base
+    set_primary_key "Id"
+    set_table_name "ContentItem"
+    belongs_to :page, :class_name => 'Page'
+  end
+
+== Default conventions
+
+  ConventionalModels.configure do
+    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
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/conventional_models.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{conventional_models}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Steve Hodgkiss"]

data/lib/conventional_models/table.rb

@@ -31,7 +31,7 @@ module ConventionalModels
     end
     
     def code
-      "class ::#{@name.singularize.camelize} < ::ActiveRecord::Base\n#{@lines.join("\n")}\nend"
+      "class ::#{@name.singularize.camelize} < ::ActiveRecord::Base\n#{@lines.map{|l| "  #{l}"}.join("\n")}\nend"
     end
   end
 end

data/spec/conventional_models/table_spec.rb

@@ -82,7 +82,7 @@ module ConventionalModels
       it "returns lines in the model definition" do
         @table.lines << "test"
         @model_code = @table.code
-        @model_code.split("\n")[1].should == "test"
+        @model_code.split("\n")[1].should == "  test"
       end
     end
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Steve Hodgkiss