relations 0.0.3

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.rdoc

@@ -0,0 +1,53 @@
+== Relations
+
+Relations is a gem to generate associations between models in a Rails application. 
+With a simple command you can generate the migration and add the associations to the models involved.
+
+== Installation
+
+You can use relations gem with any rails version major to 3.0 and minor to 3.1:
+
+	gem install relations
+
+== Usage 
+
+After you install Relations and add it to your Gemfile, you could use it in the following way:
+
+	rails generate relation model_one relation_type model_two
+
+
+* Both models should be created before you can generate the relation.
+
+* Both model's names should be in the singular form.
+
+
+
+* Sopported Relations types:
+ 
+	* has_many
+
+	* belongs_to
+
+	* has_one
+
+	* has_and_belongs_to_many
+
+For instance: 
+
+	rails g relation user has_many task
+
+It should: 
+		* generate a migration "db/migration/***_relate_users_to_tasks.rb"
+
+		* add "has_many :tasks" line to app/models/user.rb
+
+		* add "belongs_to :user" line to app/models/task.rb
+
+=== Maintainers
+
+* Alvaro Muhlethaler (http://github.com/vairix-amuhlethaler)
+* Sebastián Sierra (http://github.com/vairix-ssierra)
+
+== License
+
+MIT License. Copyright 2011 VAIRIX Software Development. http://www.vairix.com

data/Rakefile

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rdoc/task'
+
+desc 'Default: run tests for Ralations'
+task :default => :test
+
+
+desc 'Run Relations unit tests.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for Relations.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Relations'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/generators/relation/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate relation Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/relation/orm_helpers.rb

@@ -0,0 +1,13 @@
+module Relation
+  module Generators
+    module OrmHelpers
+      def model_exists?(model_name)
+        File.exists?(File.join(destination_root, model_path(model_name)))
+      end
+
+      def model_path(model_name)
+        File.join("app", "models", "#{model_name}.rb")
+      end
+    end
+  end
+end

data/lib/generators/relation/relation_generator.rb

@@ -0,0 +1,84 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'generators/relation/orm_helpers'
+
+module Relation
+    module Generators
+        class RelationGenerator < Rails::Generators::Base
+            include Rails::Generators::Migration
+            include Relation::Generators::OrmHelpers
+
+            attr_accessor :table_name, :fk
+
+            # Returns true if Rails version is bigger than 3.0.x
+			def self.is_rails_bigger_than_3_0?
+				Rails::VERSION::STRING[0,3] != "3.0"
+			end
+
+            def	self.template_path
+				rails_version = is_rails_bigger_than_3_0? ? '/new' : ''
+				File.expand_path("../templates#{rails_version}", __FILE__)
+			end
+
+            source_root template_path
+
+            File.expand_path('../templates', __FILE__)
+            argument :model_one, :type => :string
+            argument :relation_type, :type => :string
+            argument :model_two, :type => :string
+
+            @@opposite_relations = {
+                :belongs_to => :has_many,
+                :has_one => :belongs_to,
+                :has_many => :belongs_to,
+                :has_and_belongs_to_many => :has_and_belongs_to_many
+            }
+
+            def inject_relation
+                model_contents = get_model_content(relation_type.to_sym, model_two)
+                inject_into_class(model_path(model_one), model_one.to_s.capitalize, model_contents) if model_exists?(model_one)
+            end
+
+            def inject_opposite_relation
+                model_contents = get_model_content(@@opposite_relations[relation_type.to_sym], model_one)
+                inject_into_class(model_path(model_two), model_two.to_s.capitalize, model_contents) if model_exists?(model_two)
+            end
+
+            def self.next_migration_number(dirname)
+                migration_number = Time.now.strftime("%Y%m%d%H%M%S").to_i
+                migration_number += 1
+                migration_number.to_s
+            end
+
+            def create_migration
+                if (model_exists?(model_one) and model_exists?(model_two))
+                    if self.fk != ''
+                   	    migration_template "belongs_to_migration.rb", "db/migrate/relate_#{model_one.pluralize}_to_#{model_two.pluralize}"
+                    else
+                        migration_template "has_and_belongs_to_many_migration.rb", "db/migrate/relate_#{model_one.pluralize}_to_#{model_two.pluralize}"
+                    end
+                end
+            end
+
+        private
+            def get_model_content(rel,entity)
+                relations = {
+                    :belongs_to => "  #{rel} :#{entity}\n",
+                    :has_one => "  #{rel} :#{entity}\n",
+                    :has_many => "  #{rel} :#{entity.pluralize}\n",
+                    :has_and_belongs_to_many => "  #{rel} :#{entity.pluralize}\n"
+                }
+                if rel == :belongs_to
+                    self.table_name = model_one == entity ? model_two.pluralize : model_one.pluralize
+                    self.fk = entity + '_id'
+                elsif rel == :has_and_belongs_to_many
+                    self.table_name = model_one.to_s.pluralize + '_' + model_two.to_s.pluralize
+                    self.fk = ''
+                end
+                relations[rel]
+            end
+
+        end
+    end
+end
+

data/lib/generators/relation/templates/belongs_to_migration.rb

@@ -0,0 +1,9 @@
+class Relate<%= model_one.capitalize.pluralize %>To<%= model_two.capitalize.pluralize %> < ActiveRecord::Migration
+    def self.up
+        add_column :<%= table_name %>, :<%= fk %>, :integer
+    end
+
+    def self.down
+        remove_column :<%= table_name %>, :<%= fk %>
+    end
+end

data/lib/generators/relation/templates/has_and_belongs_to_many_migration.rb

@@ -0,0 +1,13 @@
+class Relate<%= model_one.capitalize.pluralize %>To<%= model_two.capitalize.pluralize %> < ActiveRecord::Migration
+    def self.up
+        create_table :<%= table_name %> do |t|
+            t.integer <%= model_one %>_id,
+            t.integer <%= model_two %>_id,
+            t.timestamps
+        end
+    end
+
+    def self.down
+        drop_table :<%= table_name %>
+    end
+end

data/lib/generators/relation/templates/new/belongs_to_migration.rb

@@ -0,0 +1,5 @@
+class Relate<%= model_one.capitalize.pluralize %>To<%= model_two.capitalize.pluralize %> < ActiveRecord::Migration
+    def change
+        add_column :<%= table_name %>, :<%= fk %>, :integer
+    end
+end

data/lib/generators/relation/templates/new/has_and_belongs_to_many_migration.rb

@@ -0,0 +1,9 @@
+class Relate<%= model_one.capitalize.pluralize %>To<%= model_two.capitalize.pluralize %>  < ActiveRecord::Migration
+    def change
+        create_table :<%= table_name %> do |t|
+            t.integer <%= model_one %>_id,
+            t.integer <%= model_two %>_id,
+            t.timestamps
+        end
+    end
+end

data/lib/relations/version.rb

@@ -0,0 +1,3 @@
+module Relations
+  VERSION = "0.0.3"
+end

data/lib/relations.rb

@@ -0,0 +1,5 @@
+require "relations/version"
+
+module Relations
+
+end

data/relations.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "relations/version"
+
+Gem::Specification.new do |s|
+    s.name        = "relations"
+    s.version     = Relations::VERSION
+    s.summary     = 'Relations generator solution for Rails'
+    s.authors     = ['Alvaro Muhlethaler', 'Sebastian Sierra']
+    s.email       = ["amuhlethaler@vairix.com"]
+    s.homepage    = "http://github.com/vairix-amuhlethaler/relations"
+    s.description = 'Relations generator solution for Rails'
+
+    s.rubyforge_project = "relations"
+
+    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"]
+
+    s.add_dependency("rails", ">= 3.0.0")
+end

data/test/relation_generator_test.rb

@@ -0,0 +1,57 @@
+require "test_helper"
+require "generators/relation/relation_generator"
+
+class RelationGeneratorTest < Rails::Generators::TestCase
+	tests Relation::Generators::RelationGenerator
+
+	destination File.expand_path("../tmp", __FILE__)
+
+	setup do 
+		prepare_destination
+		copy_app
+	end
+
+	test 'has_many relation between user and task' do
+		run_generator %w(user has_many task)
+	    match_user = /has_many :tasks/
+		assert_file "app/models/user.rb", match_user
+	    match_task = /belongs_to :user/
+		assert_file "app/models/task.rb", match_task
+		assert_migration "db/migrate/relate_users_to_tasks.rb"
+	end
+
+	test 'belongs_to relation between task and user' do
+		run_generator %w(task belongs_to user)
+	    match_user = /has_many :tasks/
+		assert_file "app/models/user.rb", match_user
+	    match_task = /belongs_to :user/
+		assert_file "app/models/task.rb", match_task
+		assert_migration "db/migrate/relate_tasks_to_users.rb"
+	end
+
+	test 'has_and_belongs_to_many relation between user and task' do
+		run_generator %w(user has_and_belongs_to_many task)
+	    match_user = /has_and_belongs_to_many :tasks/
+		assert_file "app/models/user.rb", match_user
+	    match_task = /has_and_belongs_to_many :users/
+		assert_file "app/models/task.rb", match_task
+		assert_migration "db/migrate/relate_users_to_tasks.rb"
+	end
+
+	test 'has_one relation between user and task' do
+		run_generator %w(user has_one task)
+	    match_user = /has_one :task/
+		assert_file "app/models/user.rb", match_user
+	    match_task = /belongs_to :user/
+		assert_file "app/models/task.rb", match_task
+		assert_migration "db/migrate/relate_users_to_tasks.rb"
+	end
+
+	def copy_app
+		app = File.expand_path("../test_app/app", __FILE__)
+		destination = File.join(destination_root, "")
+
+	    FileUtils.mkdir_p(destination)
+	    FileUtils.cp_r app, destination
+	end
+end

data/test/test_app/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/

data/test/test_app/Gemfile

@@ -0,0 +1,31 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.9'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+
+# Use unicorn as the web server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19', :require => 'ruby-debug'
+
+# Bundle the extra gems:
+# gem 'bj'
+# gem 'nokogiri'
+# gem 'sqlite3-ruby', :require => 'sqlite3'
+# gem 'aws-s3', :require => 'aws/s3'
+
+# Bundle gems for the local environment. Make sure to
+# put test-only gems in this group so their generators
+# and rake tasks are available in development mode:
+# group :development, :test do
+#   gem 'webrat'
+# end

data/test/test_app/README

@@ -0,0 +1,256 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find(:all)
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.com/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |   |-- images
+  |   |-- javascripts
+  |   `-- stylesheets
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Contains subdirectories for
+  images, stylesheets, and javascripts. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/test/test_app/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+TestApp::Application.load_tasks

data/test/test_app/app/models/task.rb

@@ -0,0 +1,2 @@
+class Task < ActiveRecord::Base
+end

data/test/test_app/app/models/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end