acts_as_relatable 0.0.1 → 0.0.2

data/README.rdoc

@@ -26,6 +26,8 @@ Followed by :
 
 == Usage
 
+    # Model definition
+
     class Recipe < ActiveRecord::Base
       acts_as_relatable :product
     end
@@ -34,33 +36,91 @@ Followed by :
       acts_as_relatable :recipe
     end
 
+    # Create some entries
+
     @bread = Product.create(:name => "Bread")
     @butter = Product.create(:name => "Butter")
     @pancake = Recipe.create(:name => "Pancakes")
 
+
     #Creating relationships
+
     @butter.relates_to!(@pancake)   # #<ActsAsRelatable::Relationship id: 2, relator_id: 1, relator_type: "Recipe", related_id: 2, related_type: "Product">
     @bread.relates_to!(@butter)     # #<ActsAsRelatable::Relationship id: 4, relator_id: 2, relator_type: "Product", related_id: 1, related_type: "Product">
 
-    #By default, relationships are both-sided, it means that on the first line above, @butter is related to @pancake, but @pancake is also related to @butter.
-    #If you don't want/need this behaviour, you can pass false as a second argument to the relates_to! instance method :
+    # By default, relationships are both-sided, it means that on the first line above,
+    # @butter is related to @pancake, but @pancake is also related to @butter.
+    #If you don't want/need this behaviour, you can pass false as a second argument
+    # to the relates_to! instance method :
 
     @butter.relates_to!(@pancake, false)
 
 
     #Fetching relationships
+
     @butter.related_recipes         # [#<Recipe id: 1, name: "Pancakes">]
     @butter.related_products        # [#<Product id: 1, name: "Bread"]
 
+
     @butter.relateds                # {:recipes=>[#<Recipe id: 1, name: "Pancakes">], :products=>[#<Product id: 1, name: "Bread">]}
 
     #Testing relationships
+
     @butter.related_to? @bread      # true
     @bread.related_to? @pancake     # false
 
+
     #Destroying relationships (This instance method destroys both relationships if it's a both-sided one)
+
     @butter.destroy_relation_with @pancake
 
+== Relationship model extension
+
+You can add class/instance methods to the ActsAsRelatable::Relationship model
+by adding a module in your project. Here is how to do it :
+
+Add a new file named relationship_extension.rb in your app/models directory.
+
+Let's call this module RelationshipExtension. The file may look like :
+
+  module RelationshipExtension
+    def self.included(klass)
+      klass.extend(ClassMethods).relate
+    end
+
+    module ClassMethods
+
+      def relate
+        include RelationshipExtension::InstanceMethods
+      end
+
+    end
+
+    module InstanceMethods
+      def to_s
+        "#{relator.class} #{relator.id} is related with #{related.class} #{related.id}"
+      end
+    end
+  end
+
+In a shell, run :
+
+  r g acts_as_relatable:config
+
+It will create a file called acts_as_relatable.rb in config/initializers
+
+Open this file and uncomment this line :
+
+  ActsAsRelatable::Relationship.send(:include, RelationshipExtension)
+
+I define a to_s instance method in this example. It is now a part of the ActsAsRelatable::Relationship model
+and you can use it like that :
+
+  ActsAsRelatable::Relationship.first.to_s
+
+it will return :
+
+  "Product 1 is related with Recipe 1"
 
 == Contributing to acts_as_relatable
 
@@ -70,13 +130,15 @@ Followed by :
 * Start a feature/bugfix branch
 * Commit and push until you are happy with your contribution
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version,
+  or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
 == TODOS
 
 * Rails 3.1 compatibility
 * Add a make_between method in Relationship model
 * Improve README
+* Specs for generators
 
 == Copyright
 

data/lib/generators/acts_as_relatable/templates/acts_as_relatable.rb

@@ -1 +1,2 @@
-# This config file is useless for the moment but should be useful in a near future
+# Uncomment the following line if you want to add methods to the ActsAsRelatable::Relationship AR model
+#ActsAsRelatable::Relationship.send(:include, RelationshipExtension)

data/spec/acts_as_relatable/generators/config_generator_spec.rb

@@ -1,34 +0,0 @@
-require "spec_helper"
-# describe ActsAsRelatable::Generators::ConfigGenerator do
-#
-#   context "generates config file" do
-#
-#     before { setup }
-#     after { teardown }
-#
-#     it "copy it in config/initializers" do
-#       Rails::Generators::Scripts::Generate.new.run([""], :destination => fake_rails_root)
-#       new_file = (file_list - @original_files).first
-#       assert_equal "definition.txt", File.basename(new_file)
-#     end
-#
-#     def setup
-#       FileUtils.mkdir_p(fake_rails_root)
-#       @original_files = file_list
-#     end
-#
-#     def teardown
-#       FileUtils.rm_r(fake_rails_root)
-#     end
-#
-#     def fake_rails_root
-#       File.join(File.dirname(__FILE__), 'rails_root')
-#     end
-#
-#     def file_list
-#       Dir.glob(File.join(fake_rails_root, "*"))
-#     end
-#
-#   end
-#
-# end

metadata

@@ -2,7 +2,7 @@
 name: acts_as_relatable
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - "Fr\xC3\xA9d\xC3\xA9ric Malamitsas"