inherit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5bc59b9072b4aa6720bd5a5ca9e624f4244d55aa
+  data.tar.gz: cd42224ed2714c3a0ea54caecff47cbdaf97a3b2
+SHA512:
+  metadata.gz: 589c2d2452de02e532ee54f67d04846910ffe4d171b77ae53078a732769ffabc8fec6ec8d3167f6aa878c9167cfd687ebee6ec6cc94457dea4e5f52469be0cf8
+  data.tar.gz: 29f5d84d936ae0ceba5f5151d2a4cb5466f4cb225cee47a159f3f2c6d584754b6156942192c77fadcfb37297468cdd87d45a3459033943e0eb3ad444590ab41a

data/LICENSE.txt

@@ -0,0 +1,8 @@
+Copyright (c) 2014, Stefan Rusterholz <stefan.rusterholz@gmail.com>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.markdown

@@ -0,0 +1,83 @@
+README
+======
+
+
+
+Summary
+-------
+
+Avoid the anti-pattern of `def self.included(base); base.extend …; end`, without
+getting lost in subclassing.
+
+
+
+Installation
+------------
+
+`gem install inherit`
+
+
+
+Usage
+-----
+
+    require 'inherit'
+
+    module Inheritable
+      module Constants
+        Foo = "Nice constant!"
+      end
+      module ClassMethods
+        def funky
+          "Funky class method!"
+        end
+      end
+      module InstanceMethods
+        def rad
+          "Rad instance method!"
+        end
+      end
+      def self.inherited(subclass)
+        puts "#{self} got inherited by #{subclass}"
+      end
+      def self.extended(object)
+        puts "#{self} extended #{object}"
+      end
+    end
+
+    class Example
+      inherit Inheritable # -> "Inheritable got inherited by Example"
+    end
+    Example::Foo                  # => "Nice constant!"
+    Example.funky                 # => "Funky class method!"
+    Example.new.rad               # => "Rad instance method!"
+    a_string = "a string"
+    a_string.inherit Inheritable  # -> "Inheritable extended a string"
+    a_string.singleton_class::Foo # => "Nice constant!"
+    a_string.rad                  # => "Rad instance method!"
+
+
+
+Description
+-----------
+
+Avoid the anti-pattern of `def self.included(base); base.extend …; end`, without
+getting lost in subclassing.
+
+
+
+Links
+-----
+
+* [Online API Documentation](http://rdoc.info/github/apeiros/inherit/master/frames)
+* [Public Repository](https://github.com/apeiros/inherit)
+* [Bug Reporting](https://github.com/apeiros/inherit/issues)
+* [RubyGems Site](https://rubygems.org/gems/inherit)
+
+
+
+License
+-------
+
+You can use this code under the {file:LICENSE.txt BSD-2-Clause License}, free of charge.
+If you need a different license, please ask the author.

data/Rakefile

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.expand_path('../rake/lib', __FILE__))
+Dir.glob(File.expand_path('../rake/tasks/**/*.{rake,task,rb}', __FILE__)) do |task_file|
+  begin
+    import task_file
+  rescue LoadError => e
+    warn "Failed to load task file #{task_file}"
+    warn "  #{e.class} #{e.message}"
+    warn "  #{e.backtrace.first}"
+  end
+end

data/inherit.gemspec

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name                      = "inherit"
+  s.version                   = "0.0.1"
+  s.authors                   = "Stefan Rusterholz"
+  s.email                     = "stefan.rusterholz@gmail.com"
+  s.homepage                  = "https://github.com/apeiros/inherit"
+  s.license                   = 'BSD 2-Clause'
+
+  s.description               = <<-DESCRIPTION.gsub(/^    /, '').chomp
+    Avoid the anti-pattern of `def self.included(base); base.extend …; end`, without getting lost in subclassing.
+  DESCRIPTION
+  s.summary                   = <<-SUMMARY.gsub(/^    /, '').chomp
+    Avoid the anti-pattern of `def self.included(base); base.extend …; end`, without getting lost in subclassing.
+  SUMMARY
+
+  s.files                     =
+    Dir['bin/**/*'] +
+    Dir['lib/**/*'] +
+    Dir['rake/**/*'] +
+    Dir['test/**/*'] +
+    Dir['*.gemspec'] +
+    %w[
+      LICENSE.txt
+      Rakefile
+      README.markdown
+    ]
+
+  if File.directory?('bin') then
+    s.executables = Dir.chdir('bin') { Dir.glob('**/*').select { |f| File.executable?(f) } }
+  end
+
+  s.add_development_dependency 'minitest', '>= 5.3.0'
+
+  s.required_ruby_version     = ">= 1.9.2"
+  s.rubygems_version          = "1.3.1"
+  s.specification_version     = 3
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1")
+end

data/lib/inherit.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+
+require 'inherit/version'
+
+# The `inherit` gem lets you avoid the anti-pattern of
+# `def self.included(base); base.extend …; end`, without getting lost in
+# subclassing.
+#
+# @see Module#inherit
+# @see Object#inherit
+#
+# @example Usage
+#     require 'inherit'
+#
+#     module Inheritable
+#       module Constants
+#         Foo = "Nice constant!"
+#       end
+#       module ClassMethods
+#         def funky
+#           "Funky class method!"
+#         end
+#       end
+#       module InstanceMethods
+#         def rad
+#           "Rad instance method!"
+#         end
+#       end
+#       def self.inherited(subclass)
+#         puts "#{self} got inherited by #{subclass}"
+#       end
+#       def self.extended(object)
+#         puts "#{self} extended #{object}"
+#       end
+#     end
+#     
+#     class Example
+#       inherit Inheritable # -> "Inheritable got inherited by Example"
+#     end
+#     Example::Foo                  # => "Nice constant!"
+#     Example.funky                 # => "Funky class method!"
+#     Example.new.rad               # => "Rad instance method!"
+#     a_string = "a string"
+#     a_string.inherit Inheritable  # -> "Inheritable extended a string"
+#     a_string.singleton_class::Foo # => "Nice constant!"
+#     a_string.rad                  # => "Rad instance method!"
+module Inherit
+end
+
+class Module
+
+  # Add constants, class methods and instance methods to a module/class.
+  #
+  # Adds the following things (if present) from `ancestor` to the module/class:
+  #
+  # * includes ancestor::Constants
+  # * extends ancestor::ClassMethods
+  # * includes ancestor::InstanceMethods
+  #
+  # Additionally it triggers `ancestor.inherited` with the module/class as argument.
+  #
+  # @param [Module] ancestor
+  #   The module to add constants, class methods and instance methods from, and
+  #   to trigger `.inherited` on.
+  #
+  # @see Inherit Usage example
+  #
+  def inherit(ancestor)
+    include ancestor::Constants if ancestor.const_defined?(:Constants)
+    extend  ancestor::ClassMethods if ancestor.const_defined?(:ClassMethods)
+    include ancestor::InstanceMethods if ancestor.const_defined?(:InstanceMethods)
+    ancestor.inherited(self) if ancestor.respond_to?(:inherited)
+  end
+end
+
+class Object
+
+  # Add constants and instance methods to an object.
+  #
+  # Adds the following things (if present) from `ancestor` to the object:
+  #
+  # * extends ancestor::Constants
+  # * extends ancestor::InstanceMethods
+  #
+  # Additionally it triggers `ancestor.extended` with the object as argument.
+  #
+  # @param [Module] ancestor
+  #   The module to add constants and instance methods from, and to trigger
+  #   `.extended` on.
+  #
+  # @see Inherit Usage example
+  #
+  def inherit(ancestor)
+    extend ancestor::Constants if ancestor.const_defined?(:Constants)
+    extend ancestor::InstanceMethods if ancestor.const_defined?(:InstanceMethods)
+    ancestor.extended(self) if ancestor.respond_to?(:extended)
+  end
+end

data/lib/inherit/version.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+begin
+  require 'rubygems/version' # newer rubygems use this
+rescue LoadError
+  require 'gem/version' # older rubygems use this
+end
+
+module Inherit
+
+  # The version of the inherit gem.
+  Version = Gem::Version.new("1.0.0")
+end

data/test/lib/helper.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+
+require 'stringio'
+require 'minitest/assertions'
+require 'minitest/test'
+require 'inherit'
+
+module TestSuite
+  attr_accessor :name
+end
+
+module Kernel
+  def suite(name, &block)
+    klass = Class.new(Minitest::Test)
+    klass.extend TestSuite
+    klass.name = "Suite #{name}"
+    klass.class_eval(&block)
+
+    klass
+  end
+  module_function :suite
+end
+
+class Minitest::Test
+  def self.inherited(by)
+    by.init
+    super
+  end
+
+  def self.init
+    @setups = []
+  end
+
+  def self.setup(&block)
+    @setups ||= []
+    @setups << block
+  end
+
+  class << self
+    attr_reader :setups
+  end
+
+  def setup
+    self.class.setups.each do |setup|
+      instance_eval(&setup)
+    end
+    super
+  end
+
+  def self.suite(name, &block)
+    klass = Class.new(Minitest::Test)
+    klass.extend TestSuite
+    klass.name = "Suite #{name}"
+    klass.name = "#{self.name} #{name}"
+    klass.class_eval(&block)
+
+    klass
+  end
+
+  def self.test(desc, &impl)
+    define_method("test_ #{desc}", &impl)
+  end
+
+  def capture_stdout
+    captured  = StringIO.new
+    $stdout   = captured
+    yield
+    captured.string
+  ensure
+    $stdout = STDOUT
+  end
+end

data/test/runner.rb

@@ -0,0 +1,21 @@
+# run with `ruby test/runner.rb`
+# if you only want to run a single test-file: `ruby test/runner.rb testfile.rb`
+
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start
+end
+
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+$LOAD_PATH << File.expand_path('../../test/lib', __FILE__)
+TEST_DIR    = File.expand_path('../../test', __FILE__)
+
+require 'minitest/autorun'
+require 'helper'
+
+units = ARGV.empty? ? Dir["#{TEST_DIR}/unit/**/*.rb"] : ARGV
+
+units.each do |unit|
+  p load: unit
+  load unit
+end

data/test/unit/lib/inherit.rb

@@ -0,0 +1,117 @@
+module Inheritable
+  module Constants
+    Foo = "Nice constant!"
+  end
+  module ClassMethods
+    def funky
+      "Funky class method!"
+    end
+  end
+  module InstanceMethods
+    def rad
+      "Rad instance method!"
+    end
+  end
+  def self.inherited(subclass)
+    subclass.inherited_me
+  end
+  def self.extended(object)
+    object.was_extended
+  end
+end
+
+
+
+suite "Module#inherit" do
+  test 'callback' do
+    test_class = Class.new do
+      @inherited = false
+      def self.inherited_me
+        @inherited = true
+      end
+      def self.did_inherit
+        @inherited
+      end
+    end
+
+    assert !test_class.did_inherit
+    test_class.inherit Inheritable
+    assert test_class.did_inherit
+  end
+
+  test 'constants' do
+    test_class = Class.new do
+      def self.inherited_me
+      end
+    end
+
+    assert !test_class.const_defined?(:Foo)
+    test_class.inherit Inheritable
+    assert test_class.const_defined?(:Foo)
+  end
+
+  test 'class methods' do
+    test_class = Class.new do
+      def self.inherited_me
+      end
+    end
+
+    assert !test_class.respond_to?(:funky)
+    test_class.inherit Inheritable
+    assert test_class.respond_to?(:funky)
+  end
+
+  test 'instance methods' do
+    test_class = Class.new do
+      def self.inherited_me
+      end
+    end
+
+    assert !test_class.method_defined?(:rad)
+    test_class.inherit Inheritable
+    assert test_class.method_defined?(:rad)
+  end
+end
+
+suite "Object#inherit" do
+  test 'callback' do
+    test_object = Object.new.instance_eval do
+      @inherited = false
+      def was_extended
+        @inherited = true
+      end
+      def did_inherit
+        @inherited
+      end
+      self
+    end
+
+    assert !test_object.did_inherit
+    test_object.inherit Inheritable
+    assert test_object.did_inherit
+  end
+
+  test 'constants' do
+    test_object = Object.new.instance_eval do
+      def was_extended
+      end
+      self
+    end
+
+    assert !test_object.singleton_class.const_defined?(:Foo)
+    test_object.inherit Inheritable
+    assert test_object.singleton_class.const_defined?(:Foo)
+  end
+
+  test 'instance methods' do
+    test_object = Object.new.instance_eval do
+      def was_extended
+      end
+      self
+    end
+
+    assert !test_object.respond_to?(:rad)
+    test_object.inherit Inheritable
+    assert test_object.respond_to?(:rad)
+  end
+end

data/test/unit/lib/inherit/version.rb

@@ -0,0 +1,2 @@
+suite "TableData::Tables" do
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: inherit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stefan Rusterholz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.3.0
+description: Avoid the anti-pattern of `def self.included(base); base.extend …; end`,
+  without getting lost in subclassing.
+email: stefan.rusterholz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- inherit.gemspec
+- lib/inherit.rb
+- lib/inherit/version.rb
+- test/lib/helper.rb
+- test/runner.rb
+- test/unit/lib/inherit.rb
+- test/unit/lib/inherit/version.rb
+homepage: https://github.com/apeiros/inherit
+licenses:
+- BSD 2-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 3
+summary: Avoid the anti-pattern of `def self.included(base); base.extend …; end`,
+  without getting lost in subclassing.
+test_files: []
+has_rdoc: