acts_as_interface 0.1.1 → 0.1.2

data/README.md

@@ -0,0 +1,110 @@
+# acts\_as\_interface
+
+## INSTALL
+
+    gem install acts_as_interface
+
+## DESCRIPTION
+
+In the spirit of self documenting code, `acts_as_interface` allows you to easily define `abstract_methods` and callbacks just by listing them at the top of a superclass or module.  Child classes or classes that include the module must implement abstract_methods or a `NotImplementedError` is raised when the method is called.
+
+## EXAMPLES
+
+### SUPERCLASS
+
+    class Person
+      include acts_as_interface
+      
+      abstract_methods :dance, :eat
+      abstract_methods :sleep, :play, :visibility => :private
+      callbacks :prance
+    
+      abstract_methods :foo, :for => :class
+      callbacks :france, :for => :class, :visibility => :protected
+    end
+    
+    class Student < Person
+      
+    end
+    
+    me = Student.new
+    me.dance ## => raises NotImplementedError
+    
+    me.play ## => raises NoMethodError: private method `play` called
+    me.send(:play) ## => raises NotImplementedError
+    
+    me.prance ## calls empty method prance
+    
+    Student.foo ## => raises NotImplementedError
+
+
+### MODULE (on include)
+
+    module ActsAsPerson    
+      def self.included(base)
+        base.instance_eval do
+          include ActsAsInterface
+          abstract_methods :name, :dance
+        end
+      end
+    end
+  
+    class Student < ActiveRecord::Base
+      include acts_as_person
+      
+      #name is an attribute (ie t.string :name)
+    end
+    
+    student = Student.first
+    student.name ## works as usual
+    student.dance ## => raises NotImplementedError
+  
+### MODULE (from method call)
+
+    module ActsAsPerson    
+      module ClassMethods
+        def acts_as_person
+          include ActsAsInterface
+          abstract_methods :name, :dance
+        end
+      end
+      
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  
+    class Student < ActiveRecord::Base
+      include acts_as_person
+      
+      #include or invoke modules that defines name but not dance
+      
+      acts_as_person ## apply interface
+    end
+    
+    student = Student.first
+    student.name ## works as usual
+    student.dance ## => raises NotImplementedError
+  
+  
+## Credits
+
+![BookRenter.com Logo](http://assets0.bookrenter.com/images/header/bookrenter_logo.gif "BookRenter.com")
+
+ActsAsInterface is currently maintained by [Philippe Huibonhoa](http://github.com/phuibonhoa) and funded by [BookRenter.com](http://www.bookrenter.com "BookRenter.com").
+
+## CONTRIBUTING
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* 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.
+
+## COPYRIGHT
+
+Copyright (c) 2011 Philippe Huibonhoa. See LICENSE.txt for
+further details.
+

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/acts_as_interface.gemspec

@@ -5,22 +5,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_interface}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Philippe Huibonhoa"]
-  s.date = %q{2011-02-04}
+  s.date = %q{2011-03-02}
   s.description = %q{Easily define abstract methods and callbacks for superclasses and modules}
   s.email = %q{philippe.huibonhoa@bookrenter.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
     "Gemfile",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "acts_as_interface.gemspec",

data/lib/acts_as_interface.rb

@@ -1,3 +1,5 @@
+require 'active_support'
+
 #Include ActsAsInterface to easily define abstract methods
 #Example: Superclass
 # class Person
@@ -35,7 +37,8 @@ class Object
         if options.has_key?(:default)
           options[:default]
         else 
-          raise NotImplementedError, "#{abstract_method_name} not defined for #{self.class}"
+          class_name = options[:for] == :class ? self : self.class
+          raise NotImplementedError, "#{abstract_method_name} not defined for #{class_name}"
         end      
       end
     
@@ -55,9 +58,7 @@ module ActsAsInterface
       options = args.extract_options!
       args.each do |abstract_method_name|
         if options[:for] == :class
-          (class << self; self; end).instance_eval do
-            define_abstract_method(abstract_method_name, options)
-          end
+          (class << self; self; end).define_abstract_method(abstract_method_name, options)
         else
           define_abstract_method(abstract_method_name, options)
         end        

data/test/test_acts_as_interface.rb

@@ -8,9 +8,11 @@ class AttributeActsAsInterfaceTest < Test::Unit::TestCase
     def existing_method
       true
     end
-        
-    def self.existing_class_method
-      true
+    
+    class << self
+      def existing_class_method
+        true
+      end
     end
     
     abstract_methods :im, :existing_method
@@ -29,8 +31,10 @@ class AttributeActsAsInterfaceTest < Test::Unit::TestCase
       "hello #{word}"
     end
     
-    def self.cm(word)
-      "#{word} world"
+    class << self
+      def cm(word)
+        "#{word} world"
+      end
     end
   end
   

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_interface
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Philippe Huibonhoa
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-04 00:00:00 -08:00
+date: 2011-03-02 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -118,12 +118,12 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README.rdoc
+- README.md
 files: 
 - .document
 - Gemfile
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - acts_as_interface.gemspec

data/README.rdoc

@@ -1,104 +0,0 @@
-= acts_as_interface
-
-== INSTALL
-
-  gem install acts_as_interface
-
-== DESCRIPTION
-
-In the spirit of self documenting code, acts_as_interface allows you to easily define abstract_methods and callbacks just by listing them at the top of a superclass or module.  Child classes or classes that include the module must implement abstract_methods or a NotImplementedError is raised when the method is called.
-
-== EXAMPLES
-
-=== SUPERCLASS
-
-  class Person
-    include acts_as_interface
-    
-    abstract_methods :dance, :eat
-    abstract_methods :sleep, :play, :visibility => :private
-    callbacks :prance
-  
-    abstract_methods :foo, :for => :class
-    callbacks :france, :for => :class, :visibility => :protected
-  end
-  
-  class Student < Person
-    
-  end
-  
-  me = Student.new
-  me.dance #raises NotImplementedError
-  
-  me.play #raises NoMethodError: private method `play` called
-  me.send(:play) #raises NotImplementedError
-  
-  me.prance #calls empty method prance
-  
-  Student.foo #raises NotImplementedError
-
-
-=== MODULE (on include)
-
-  module ActsAsPerson    
-    def self.included(base)
-      base.instance_eval do
-        include ActsAsInterface
-        abstract_methods :name, :dance
-      end
-    end
-  end
-
-  class Student < ActiveRecord::Base
-    include acts_as_person
-    
-    #name is an attribute (ie t.string :name)
-  end
-  
-  student = Student.first
-  student.name #works as usual
-  student.dance #raises NotImplementedError
-  
-=== MODULE (from method call)
-
-  module ActsAsPerson    
-    module ClassMethods
-      def acts_as_person
-        include ActsAsInterface
-        abstract_methods :name, :dance
-      end
-    end
-    
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-  end
-
-  class Student < ActiveRecord::Base
-    include acts_as_person
-    
-    #include or invoke modules that defines name but not dance
-    
-    acts_as_person #apply interface
-  end
-  
-  student = Student.first
-  student.name #works as usual
-  student.dance #raises NotImplementedError
-  
-
-== CONTRIBUTING
-
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* 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.
-
-== COPYRIGHT
-
-Copyright (c) 2011 Philippe Huibonhoa. See LICENSE.txt for
-further details.
-