method_repository 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/bundle

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kentaro Kuribayashi
+
+MIT License
+
+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.md

@@ -0,0 +1,136 @@
+# MethodRepository
+
+Extracting redandunt code and commonalizing it in a different way.
+
+## Problem
+
+To extract redandunt codes into a method to commonalize them is a usual strategy for OOP. It allows us to streamline our codes and modify at one stop even though the method is used at anywhere, anytimes.
+
+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  classed/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 them from grasping the whole code quickily.
+
+## Solution
+
+This library provides a "method repository" in which you can add your methods to commonalize redandunt codes here and there in your whole codes, which is just same as usual module usage. However, the methods you define in the "repository" will never be included automatically into other classes/modules unless not permitted explicitely.
+
+This is the point; There's no chance the methods in the "repository" appear at somewhere the "repository" don't know. To commonalize redanduncy is our intension, but we don't want the methods to be used where we don't know. The way this library provides solves the problem.
+
+## Usage
+
+Imagine there's such a code below:
+
+```ruby
+module Repository
+  include MethodRepository
+
+  insert :method1, in: %w[Foo Bar] do; end
+  insert :method2, in: %w[Baz]     do; end
+end
+
+class Foo; end
+class Bar; end
+class Baz; end
+class Qux; end
+```
+
+  * `method1` is declared it can be inserted in `Foo` and `Bar`
+  * `method2` is declared it can be inserted in only `Baz`
+  * No method is declared it can be inserted in `Qux`
+
+### Extending
+
+When the classes/objects are extended by `Repository` module:
+
+```ruby
+Foo.extend(Repository)
+Bar.extend(Repository)
+Baz.extend(Repository)
+Qux.extend(Repository)
+```
+
+or
+
+```ruby
+foo = Foo.new; foo.extend(Repository)
+bar = Bar.new; bar.extend(Repository)
+baz = Baz.new; bar.extend(Repository)
+qux = Qux.new; qux.extend(Repository)
+```
+
+Only explicitely permitted methods are defined as singleton methods of each classes/objects. That results in:
+
+```ruby
+Foo.respond_to?(:method1)) #=> true
+Bar.respond_to?(:method1)) #=> true
+Baz.respond_to?(:method1)) #=> false
+Qux.respond_to?(:method1)) #=> false
+
+Foo.respond_to?(:method2)) #=> false
+Bar.respond_to?(:method2)) #=> false
+Baz.respond_to?(:method2)) #=> true
+Qux.respond_to?(:method1)) #=> false
+```
+
+or
+
+```ruby
+foo.respond_to?(:method1)) #=> true
+bar.respond_to?(:method1)) #=> true
+baz.respond_to?(:method1)) #=> false
+qux.respond_to?(:method1)) #=> false
+
+foo.respond_to?(:method2)) #=> false
+bar.respond_to?(:method2)) #=> false
+baz.respond_to?(:method2)) #=> true
+qux.respond_to?(:method1)) #=> false
+```
+
+### Including
+
+The rule is also applicable to `include`:
+
+```ruby
+Foo.send(:include, Repository)
+Bar.send(:include, Repository)
+Baz.send(:include, Repository)
+Qux.send(:include, Repository)
+```
+
+Results in:
+
+```ruby
+Foo.new.respond_to?(:method1)) #=> true
+Bar.new.respond_to?(:method1)) #=> true
+Baz.new.respond_to?(:method1)) #=> false
+Qux.new.respond_to?(:method1)) #=> false
+
+Foo.new.respond_to?(:method2)) #=> false
+Bar.new.respond_to?(:method2)) #=> false
+Baz.new.respond_to?(:method2)) #=> true
+Qux.new.respond_to?(:method1)) #=> false
+```
+
+In this case, the methods in `Repository` are, of course, defined as instance methods of each classes, not singleton methods of each objects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'inserts'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install inserts
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/method_repository.rb

@@ -0,0 +1,47 @@
+require "method_repository/version"
+
+module MethodRepository
+  def self.included(base)
+    base.instance_variable_set(:@targets, {})
+    base.extend(ModuleMethods)
+  end
+
+  module ModuleMethods
+    def extended(base)
+      klass_name = base.class.to_s == 'Class' ? base.to_s : base.class.to_s
+
+      if (methods = @targets[klass_name])
+        singleton_class = class << base; self; end
+        singleton_class.class_eval do
+          methods.each do |method|
+            define_method method[:name], method[:block]
+          end
+        end
+      end
+    end
+
+    def included(base)
+      if (methods = @targets[base.to_s])
+        base.class_eval do
+          methods.each do |method|
+            define_method method[:name], method[:block]
+          end
+        end
+      end
+    end
+
+    def insert(name, klasses = {}, &block)
+      if !klasses[:in]
+        raise ArgumentError.new("`:in' parameter is required")
+      end
+
+      klasses[:in].each do |klass|
+        @targets[klass] ||= []
+        @targets[klass] << {
+          :name  => name,
+          :block => block,
+        }
+      end
+    end
+  end
+end

data/lib/method_repository/version.rb

@@ -0,0 +1,3 @@
+module MethodRepository
+  VERSION = "0.0.1"
+end

data/method_repository.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'method_repository/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "method_repository"
+  gem.version       = MethodRepository::VERSION
+  gem.authors       = ["Kentaro Kuribayashi"]
+  gem.email         = ["kentarok@gmail.com"]
+  gem.description   = %q{Extracting redandunt code and commonalizing it in a different way.}
+  gem.summary       = %q{Extracting redandunt code and commonalizing it in a different way}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rspec", "~> 2.12"
+end

data/spec/lib/method_repository_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+describe MethodRepository do
+  module Repository
+    include MethodRepository
+
+    insert :method1, in: %w[Foo Bar] do; end
+    insert :method2, in: %w[Baz]     do; end
+  end
+
+  class Foo; end
+  class Bar; end
+  class Baz; end
+  class Qux; end
+
+  describe '.insert' do
+    it {
+      expect {
+        module Repository
+          insert :method3
+        end
+      }.to raise_error(
+        ArgumentError,
+        "`:in' parameter is required",
+      )
+    }
+  end
+
+  describe '.extended' do
+    context 'when classes are extended' do
+      before {
+        Foo.extend(Repository)
+        Bar.extend(Repository)
+        Baz.extend(Repository)
+        Qux.extend(Repository)
+      }
+
+      it {
+        expect(Foo.respond_to?(:method1)).to be true
+        expect(Bar.respond_to?(:method1)).to be true
+        expect(Baz.respond_to?(:method1)).to be false
+        expect(Qux.respond_to?(:method1)).to be false
+
+        expect(Foo.respond_to?(:method2)).to be false
+        expect(Bar.respond_to?(:method2)).to be false
+        expect(Baz.respond_to?(:method2)).to be true
+        expect(Qux.respond_to?(:method1)).to be false
+      }
+    end
+
+    context 'when objects are extended' do
+      let(:foo) { Foo.new }
+      let(:bar) { Bar.new }
+      let(:baz) { Baz.new }
+      let(:qux) { Qux.new }
+
+      before {
+        foo.extend(Repository)
+        bar.extend(Repository)
+        baz.extend(Repository)
+        qux.extend(Repository)
+      }
+
+      it {
+        expect(foo.respond_to?(:method1)).to be true
+        expect(bar.respond_to?(:method1)).to be true
+        expect(baz.respond_to?(:method1)).to be false
+        expect(qux.respond_to?(:method1)).to be false
+
+        expect(foo.respond_to?(:method2)).to be false
+        expect(bar.respond_to?(:method2)).to be false
+        expect(baz.respond_to?(:method2)).to be true
+        expect(qux.respond_to?(:method1)).to be false
+      }
+    end
+  end
+
+  describe '.included' do
+    before {
+      Foo.send(:include, Repository)
+      Bar.send(:include, Repository)
+      Baz.send(:include, Repository)
+      Qux.send(:include, Repository)
+    }
+
+    it {
+      expect(Foo.new.respond_to?(:method1)).to be true
+      expect(Bar.new.respond_to?(:method1)).to be true
+      expect(Baz.new.respond_to?(:method1)).to be false
+      expect(Qux.new.respond_to?(:method1)).to be false
+
+      expect(Foo.new.respond_to?(:method2)).to be false
+      expect(Bar.new.respond_to?(:method2)).to be false
+      expect(Baz.new.respond_to?(:method2)).to be true
+      expect(Qux.new.respond_to?(:method1)).to be false
+    }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$:.unshift File.expand_path("../../lib", __FILE__)
+require 'method_repository'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: method_repository
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kentaro Kuribayashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+description: Extracting redandunt code and commonalizing it in a different way.
+email:
+- kentarok@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/method_repository.rb
+- lib/method_repository/version.rb
+- method_repository.gemspec
+- spec/lib/method_repository_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Extracting redandunt code and commonalizing it in a different way
+test_files:
+- spec/lib/method_repository_spec.rb
+- spec/spec_helper.rb
+has_rdoc: