acts_as_interface 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+  gem "activesupport", "2.3.4"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Philippe Huibonhoa
+
+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,76 @@
+= acts_as_interface
+
+== INSTALL
+
+  gem install timecop
+
+== 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
+
+  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
+
+== 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/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "acts_as_interface"
+  gem.homepage = "http://github.com/phuibonhoa/acts_as_interface"
+  gem.license = "MIT"
+  gem.summary = %Q{Easily define abstract methods and callbacks for superclasses and modules}
+  gem.description = %Q{Easily define abstract methods and callbacks for superclasses and modules}
+  gem.email = "philippe.huibonhoa@bookrenter.com"
+  gem.authors = ["Philippe Huibonhoa"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "acts_as_interface #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/acts_as_interface.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_interface}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Philippe Huibonhoa"]
+  s.date = %q{2011-01-27}
+  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"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "acts_as_interface.gemspec",
+    "lib/acts_as_interface.rb",
+    "test/helper.rb",
+    "test/test_acts_as_interface.rb"
+  ]
+  s.homepage = %q{http://github.com/phuibonhoa/acts_as_interface}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Easily define abstract methods and callbacks for superclasses and modules}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_acts_as_interface.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<activesupport>, ["= 2.3.4"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<activesupport>, ["= 2.3.4"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<activesupport>, ["= 2.3.4"])
+  end
+end
+

data/lib/acts_as_interface.rb

@@ -0,0 +1,76 @@
+require 'active_support'
+
+#Include ActsAsInterface to easily define abstract methods
+#Example: Superclass
+# class Person
+#   abstract_methods :dance, :eat
+#   abstract_methods :sleep, :play, :visibility => :private
+#   callbacks :prance
+#
+#   abstract_methods :foo, :for => :class
+#   callbacks :france, :for => :class, :visibility => :protected
+# end
+#
+# me = MyClass.new
+# me.dance #raises NotImplementedError
+# me.play #raises NoMethodError: private method `close_book` called
+# me.send(:play) #calls empty method play
+# me.prance #calls empty method prance
+# Person.foo #raises NotImplementedError
+#
+#Example: ActiveRecord Module
+# module ActsAsPerson
+#   
+#   # included in active record objects where abstracted methods can be either attributes of the model or defined by the model
+#   def self.included(base)
+#     base.instance_eval do
+#       include ActsAsInterface
+#       abstract_methods :name, :dance
+#     end
+#   end
+#   
+# end
+class Object
+  def define_abstract_method(abstract_method_name, options)
+    unless method_defined?(abstract_method_name) or (respond_to?(:columns) and columns.any? { |column| column.name.to_sym == abstract_method_name })
+      define_method(abstract_method_name) do |*abstract_method_args|
+        if options.has_key?(:default)
+          options[:default]
+        else 
+          raise NotImplementedError, "#{abstract_method_name} not defined for #{self.class}"
+        end      
+      end
+    
+      send(options[:visibility], abstract_method_name) if options[:visibility]
+    end
+  end
+end
+
+module ActsAsInterface
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end    
+
+  module ClassMethods
+    def abstract_methods(*args)
+      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
+        else
+          define_abstract_method(abstract_method_name, options)
+        end        
+      end
+    end
+    
+    def callbacks(*args)
+      options = args.extract_options!
+      options = {:default => nil}.merge(options)
+      abstract_methods(*args.push(options))
+    end
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'acts_as_interface'
+
+class Test::Unit::TestCase
+end

data/test/test_acts_as_interface.rb

@@ -0,0 +1,104 @@
+require "helper"
+
+class AttributeActsAsInterfaceTest < Test::Unit::TestCase
+
+  class InterfacedClass
+    include ActsAsInterface
+    
+    def existing_method
+      true
+    end
+        
+    def self.existing_class_method
+      true
+    end
+    
+    abstract_methods :im, :existing_method
+    abstract_methods :private_im, :visibility => :private
+    abstract_methods :im_with_default, :default => nil
+    callbacks :icb
+
+    abstract_methods :cm, :existing_class_method, :for => :class
+    abstract_methods :private_cm, :visibility => :private, :for => :class
+    abstract_methods :cm_with_default, :default => nil, :for => :class
+    callbacks :ccb, :for => :class
+  end
+  
+  class ChildOfInterfacedClass < InterfacedClass
+    def im(word)
+      "hello #{word}"
+    end
+    
+    def self.cm(word)
+      "#{word} world"
+    end
+  end
+  
+  context "with instance methods" do
+    setup do
+      @ic = InterfacedClass.new
+    end
+    
+    should "raise with no default" do
+      assert_raise(NotImplementedError) { @ic.im }
+    end
+    
+    should "scope visibility if passed visibility option" do
+      assert_raise(NoMethodError) { @ic.private_im }
+      assert_raise(NotImplementedError) { @ic.send(:private_im) }
+    end
+    
+    should "return default if passed default option" do
+      assert_equal nil, @ic.im_with_default
+    end
+    
+    should "return nil if callback" do
+      assert_equal nil, @ic.icb
+    end
+    
+    should "not override existing methods" do
+      assert_equal true, @ic.existing_method
+    end
+    
+    context "child class" do
+      setup do
+        @child = ChildOfInterfacedClass.new
+      end
+      
+      should "be allowed to override abstracted method" do
+        assert_equal "hello world", @child.im('world')
+      end
+    end    
+  end
+  
+  context "with class methods" do
+    should "raise with no default" do
+      assert_raise(NotImplementedError) { InterfacedClass.cm }
+    end
+    
+    should "scope visibility if passed visibility option" do
+      assert_raise(NoMethodError) { InterfacedClass.private_cm }
+      assert_raise(NotImplementedError) { InterfacedClass.send(:private_cm) }
+    end
+    
+    should "return default if passed default option" do
+      assert_equal nil, InterfacedClass.cm_with_default
+    end
+    
+    should "return nil if callback" do
+      assert_equal nil, InterfacedClass.ccb
+    end
+    
+    should "not override existing methods" do
+      assert_equal true, InterfacedClass.existing_class_method
+    end
+    
+    context "child class" do
+      should "be allowed to override abstracted method" do
+        assert_equal "wayne's world", ChildOfInterfacedClass.cm("wayne's")
+      end
+    end
+  end  
+  
+  
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_interface
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Philippe Huibonhoa
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-27 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: shoulda
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  name: bundler
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  name: jeweler
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rcov
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 3
+        - 4
+        version: 2.3.4
+  type: :development
+  name: activesupport
+  prerelease: false
+  version_requirements: *id005
+description: Easily define abstract methods and callbacks for superclasses and modules
+email: philippe.huibonhoa@bookrenter.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- acts_as_interface.gemspec
+- lib/acts_as_interface.rb
+- test/helper.rb
+- test/test_acts_as_interface.rb
+has_rdoc: true
+homepage: http://github.com/phuibonhoa/acts_as_interface
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Easily define abstract methods and callbacks for superclasses and modules
+test_files: 
+- test/helper.rb
+- test/test_acts_as_interface.rb