method_repository 0.0.4 → 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d0710a19c282ef8e641f042d15563f5498602bc
+  data.tar.gz: c9a9f0bc218b5f5fc95feb03aa5b37045f5e718b
+SHA512:
+  metadata.gz: 78d801a95aee6810a5f18836587fe6d4a5b77d11e5c599fd429e6a2be16841a5a2e3d2a57e0d5df4084aa4dbe690c47f64310e3de0e9e6136b22f34f29fa2d2c
+  data.tar.gz: d9ba6041bfafbb1315a028dfdd2ccb5dbbe5d6ab14373eb14de5cc9b97248887210bdc7fff4667842c24a7be37dfdaa12fa2174d4199a73926fe17cb69ce03c9

data/README.md

@@ -8,7 +8,7 @@ To extract redundant codes into a method to commonalize them is a usual strategy
 
 I don't like when highly commonalized OOP structure disturbes me from quick tracing where such methods are defined. It's OOP's natural defect, I think. Once  classes/modules are defined, it's inevitable that the classes/modules are inherited/included at anywhere we don't know.
 
-In that way, inheritance/inclusion-based OOP resembles `goto` programming; There's no clear reason why some classes/modules are inherited/included by another classes/modules. Even though there's some structural thought in your classes/modules design, such an excessively free inheritance/inclusion prevent us from grasping the whole code quickily.
+In that way, inheritance/inclusion-based OOP resembles `goto` programming; There's no clear reason why some classes/modules are inherited/included by another classes/modules. Even though there's some structural thought in your classes/modules design, such an excessively free inheritance/inclusion prevents us from grasping the whole code quickily.
 
 ## Solution
 
@@ -38,6 +38,43 @@ class Qux; end
   * `method2` is declared it can be inserted in only `Baz`
   * No method is declared it can be inserted in `Qux`
 
+### Limit Extending/Including in a Lump
+
+You can also limit extending/including in a lump, not designating classes using `insert` method at method definitions, like below:
+
+```
+module Extendable
+  include MethodRepository
+
+  extendable_by 'Hoge'
+end
+
+module Includable
+  include MethodRepository
+
+  includable_by 'Hoge'
+end
+
+class Hoge; end
+class Fuga; end
+```
+
+In this way:
+
+```
+Hoge.extend(Extendable)
+Hoge.send(:include, Includable)
+```
+
+works as you see, however:
+
+```
+Fuga.extend(Extendable)
+Fuga.send(:include, Includable)
+```
+
+raises `MethodRepository::NotPermittedError`.
+
 ### Extending
 
 When the classes/objects are extended by `Repository` module:

data/lib/method_repository.rb

@@ -2,14 +2,22 @@ require_relative "method_repository/version"
 
 module MethodRepository
   def self.included(base)
-    base.instance_variable_set(:@targets, {})
+    base.instance_variable_set(:@targets,    {})
+    base.instance_variable_set(:@extendable, [])
+    base.instance_variable_set(:@includable, [])
     base.extend(ModuleMethods)
   end
 
+  class NotPermittedError < RuntimeError; end
+
   module ModuleMethods
     def extended(base)
       klass_name = base.class.to_s == 'Class' ? base.to_s : base.class.to_s
 
+      if !@extendable.empty? && !@extendable.include?(klass_name)
+        raise MethodRepository::NotPermittedError.new("Extending #{klass_name} by this module is not permitted")
+      end
+
       if (methods = @targets[klass_name])
         base.singleton_class.class_eval do
           methods.each do |method|
@@ -20,7 +28,13 @@ module MethodRepository
     end
 
     def included(base)
-      if (methods = @targets[base.to_s])
+      klass_name = base.to_s
+
+      if !@includable.empty? && !@includable.include?(klass_name)
+        raise MethodRepository::NotPermittedError.new("Including #{klass_name} by this module is not permitted")
+      end
+
+      if (methods = @targets[klass_name])
         base.class_eval do
           methods.each do |method|
             define_method method[:name], method[:block]
@@ -29,6 +43,14 @@ module MethodRepository
       end
     end
 
+    def extendable_by(*klasses)
+      @extendable.push(*klasses)
+    end
+
+    def includable_by(*klasses)
+      @includable.push(*klasses)
+    end
+
     def insert(name, klasses = {}, &block)
       if !klasses[:in]
         raise ArgumentError.new("`:in' parameter is required")

data/lib/method_repository/version.rb

@@ -1,3 +1,3 @@
 module MethodRepository
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/lib/method_repository_spec.rb

@@ -1,6 +1,18 @@
 require_relative '../spec_helper'
 
 describe MethodRepository do
+  module Extendable
+    include MethodRepository
+
+    extendable_by 'Hoge', 'Piyo'
+  end
+
+  module Includable
+    include MethodRepository
+
+    includable_by 'Hoge', 'Piyo'
+  end
+
   module Repository
     include MethodRepository
 
@@ -8,11 +20,59 @@ describe MethodRepository do
     insert :method2, in: %w[Baz]     do; end
   end
 
+  class Hoge; end
+  class Fuga; end
+  class Piyo; end
+
   class Foo; end
   class Bar; end
   class Baz; end
   class Qux; end
 
+  describe '.extendable_by' do
+    context 'when classes are permitted as extendable' do
+      before {
+        Hoge.extend(Extendable)
+        Piyo.extend(Extendable)
+      }
+
+      it {
+        expect(Hoge).to be_a_kind_of Extendable
+        expect(Piyo).to be_a_kind_of Extendable
+      }
+    end
+
+    context 'when classes are not permitted as extendable' do
+      it {
+        expect {
+          Fuga.extend(Extendable)
+        }.to raise_error(MethodRepository::NotPermittedError)
+      }
+    end
+  end
+
+  describe '.includable_by' do
+    context 'when classes are permitted as includable' do
+      before {
+        Hoge.send(:include, Includable)
+        Piyo.send(:include, Includable)
+      }
+
+      it {
+        expect(Hoge.new).to be_a_kind_of Includable
+        expect(Piyo.new).to be_a_kind_of Includable
+      }
+    end
+
+    context 'when classes are not permitted as includable' do
+      it {
+        expect {
+          Fuga.send(:include, Includable)
+        }.to raise_error(MethodRepository::NotPermittedError)
+      }
+    end
+  end
+
   describe '.insert' do
     it {
       expect {
@@ -95,4 +155,8 @@ describe MethodRepository do
       expect(Qux.new.respond_to?(:method2)).to be false
     }
   end
+
+  describe '.includable_by' do
+    context 'when classes'
+  end
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: method_repository
 version: !ruby/object:Gem::Version
-  version: 0.0.4
-  prerelease: 
+  version: 0.0.5
 platform: ruby
 authors:
 - Kentaro Kuribayashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-03 00:00:00.000000000 Z
+date: 2013-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,17 +27,15 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Extracting redundant code and commonalizing it in a different way.
@@ -63,29 +58,27 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/kentaro/method_repository
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Extracting redundant code and commonalizing it in a different way
 test_files:
 - spec/lib/method_repository_spec.rb
 - spec/spec_helper.rb
-has_rdoc: