module_functions 0.0.1

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+group :rake do
+  gem 'rake_tasks', '~> 0.0.1'
+end

data/Gemfile.lock

@@ -0,0 +1,13 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    rake (0.8.7)
+    rake_tasks (0.0.4)
+      rake (~> 0.8.7)
+
+PLATFORMS
+  ruby
+  x86-mingw32
+
+DEPENDENCIES
+  rake_tasks (~> 0.0.1)

data/README

@@ -0,0 +1,27 @@
+== Welcome to ModuleFunctions
+
+ModuleFunctions contains useful module functions.
+One example is the function that adds
+all public module functions to another module.
+
+== Getting Started
+
+1. Install ModuleFunctions at the command prompt if you haven't yet:
+
+    gem install module_functions
+
+2. Require the gem in your Gemfile:
+
+    gem 'module_functions', '~> 0.0.1'
+
+3. Require the gem wherever you need to use it:
+
+    require 'module_functions'
+
+== Additional Documentation
+
+ rake rdoc:app
+
+== License
+
+ModuleFunctions is released under the GPLv3 license.

data/lib/module_functions.rb

@@ -0,0 +1,3 @@
+gem_name = File.basename(__FILE__, '.rb')
+
+require_relative File.join(gem_name, gem_name)

data/lib/module_functions/module_functions.rb

@@ -0,0 +1,64 @@
+# This file contains useful module functions.
+
+#--
+################################################################################
+#                      Copyright (C) 2011 Travis Herrick                       #
+################################################################################
+#                                                                              #
+#                                 \v^V,^!v\^/                                  #
+#                                 ~%       %~                                  #
+#                                 {  _   _  }                                  #
+#                                 (  *   -  )                                  #
+#                                 |    /    |                                  #
+#                                  \   _,  /                                   #
+#                                   \__.__/                                    #
+#                                                                              #
+################################################################################
+# This program is free software: you can redistribute it                       #
+# and/or modify it under the terms of the GNU General Public License           #
+# as published by the Free Software Foundation,                                #
+# either version 3 of the License, or (at your option) any later version.      #
+#                                                                              #
+# Commercial licensing may be available for a fee under a different license.   #
+################################################################################
+# This program is distributed in the hope that it will be useful,              #
+# but WITHOUT ANY WARRANTY;                                                    #
+# without even the implied warranty of MERCHANTABILITY                         #
+# or FITNESS FOR A PARTICULAR PURPOSE.                                         #
+# See the GNU General Public License for more details.                         #
+#                                                                              #
+# You should have received a copy of the GNU General Public License            #
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.        #
+################################################################################
+#++
+
+# Useful functions for modules.
+module ModuleFunctions
+  class << self
+    # Imports public methods from one module into another.
+    # ==== Input
+    # [receiver : Module] This module will have new methods added to it.
+    # [sender : Module] This module will have it's methods
+    #                   called from <tt>receiver</tt>.
+    def import_public_methods(receiver, sender)
+      unless receiver.class == Module && sender.class == Module
+        raise ArgumentError, "Invalid parameter for #{__method__}. " +
+          "A #{Module} was expected, but was a #{receiver.class}."
+      end
+
+      # Create a public methods of the same name in the receiving module
+      # that will call the original module's methods.
+      (sender.public_methods - sender.class.public_methods).each do |method|
+        receiver.module_eval(<<-EOT, __FILE__, __LINE__)
+          def self.#{method}(*args)
+            if args.length == 0
+              #{sender.name}.#{method}
+            else
+              #{sender.name}.#{method}(*args)
+            end
+          end
+        EOT
+      end
+    end
+  end
+end

data/module_functions.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name = 'module_functions'
+  s.version = '0.0.1'
+
+  s.summary = 'This gem contains useful module functions.'
+  s.description = %Q{
+ModuleFunctions contains useful module functions.
+One example is the function that adds
+all public module functions to another module.
+}.strip
+
+  s.author   = 'Travis Herrick'
+  s.email    = 'tthetoad@gmail.com'
+  s.homepage = 'http://www.bitbucket.org/ToadJamb/gems_module_functions'
+
+  s.license = 'GPLv3'
+
+  s.extra_rdoc_files << 'README'
+
+  s.require_paths = ['lib']
+  s.files = Dir['lib/**/*.rb', '*']
+  s.test_files = Dir['test/**/*.rb']
+
+  s.add_development_dependency 'rake_tasks', '~> 0.0.1'
+
+  s.has_rdoc = true
+end

data/rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler.require :rake

data/test/lib/empty_module.rb

@@ -0,0 +1,37 @@
+# This file contains a module that is used to assist in testing this gem.
+
+#--
+################################################################################
+#                      Copyright (C) 2011 Travis Herrick                       #
+################################################################################
+#                                                                              #
+#                                 \v^V,^!v\^/                                  #
+#                                 ~%       %~                                  #
+#                                 {  _   _  }                                  #
+#                                 (  *   -  )                                  #
+#                                 |    /    |                                  #
+#                                  \   _,  /                                   #
+#                                   \__.__/                                    #
+#                                                                              #
+################################################################################
+# This program is free software: you can redistribute it                       #
+# and/or modify it under the terms of the GNU General Public License           #
+# as published by the Free Software Foundation,                                #
+# either version 3 of the License, or (at your option) any later version.      #
+#                                                                              #
+# Commercial licensing may be available for a fee under a different license.   #
+################################################################################
+# This program is distributed in the hope that it will be useful,              #
+# but WITHOUT ANY WARRANTY;                                                    #
+# without even the implied warranty of MERCHANTABILITY                         #
+# or FITNESS FOR A PARTICULAR PURPOSE.                                         #
+# See the GNU General Public License for more details.                         #
+#                                                                              #
+# You should have received a copy of the GNU General Public License            #
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.        #
+################################################################################
+#++
+
+# This module is used to assist in testing this gem.
+module EmptyModule
+end

data/test/lib/my_class.rb

@@ -0,0 +1,55 @@
+# This file contains a class that is used to assist in testing this gem.
+
+#--
+################################################################################
+#                      Copyright (C) 2011 Travis Herrick                       #
+################################################################################
+#                                                                              #
+#                                 \v^V,^!v\^/                                  #
+#                                 ~%       %~                                  #
+#                                 {  _   _  }                                  #
+#                                 (  *   -  )                                  #
+#                                 |    /    |                                  #
+#                                  \   _,  /                                   #
+#                                   \__.__/                                    #
+#                                                                              #
+################################################################################
+# This program is free software: you can redistribute it                       #
+# and/or modify it under the terms of the GNU General Public License           #
+# as published by the Free Software Foundation,                                #
+# either version 3 of the License, or (at your option) any later version.      #
+#                                                                              #
+# Commercial licensing may be available for a fee under a different license.   #
+################################################################################
+# This program is distributed in the hope that it will be useful,              #
+# but WITHOUT ANY WARRANTY;                                                    #
+# without even the implied warranty of MERCHANTABILITY                         #
+# or FITNESS FOR A PARTICULAR PURPOSE.                                         #
+# See the GNU General Public License for more details.                         #
+#                                                                              #
+# You should have received a copy of the GNU General Public License            #
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.        #
+################################################################################
+#++
+
+# This class is used to assist in testing this gem.
+class MyClass
+  class << self
+    def my_public_class_method; end
+
+    protected
+    def my_protected_class_method; end
+
+    private
+    def my_private_class_method; end
+  end
+
+  public
+  def my_public_instance_method; end
+
+  protected
+  def my_protected_instance_method; end
+
+  private
+  def my_private_instance_method; end
+end

data/test/lib/my_module.rb

@@ -0,0 +1,68 @@
+# This file contains a module that is used to assist in testing this gem.
+
+#--
+################################################################################
+#                      Copyright (C) 2011 Travis Herrick                       #
+################################################################################
+#                                                                              #
+#                                 \v^V,^!v\^/                                  #
+#                                 ~%       %~                                  #
+#                                 {  _   _  }                                  #
+#                                 (  *   -  )                                  #
+#                                 |    /    |                                  #
+#                                  \   _,  /                                   #
+#                                   \__.__/                                    #
+#                                                                              #
+################################################################################
+# This program is free software: you can redistribute it                       #
+# and/or modify it under the terms of the GNU General Public License           #
+# as published by the Free Software Foundation,                                #
+# either version 3 of the License, or (at your option) any later version.      #
+#                                                                              #
+# Commercial licensing may be available for a fee under a different license.   #
+################################################################################
+# This program is distributed in the hope that it will be useful,              #
+# but WITHOUT ANY WARRANTY;                                                    #
+# without even the implied warranty of MERCHANTABILITY                         #
+# or FITNESS FOR A PARTICULAR PURPOSE.                                         #
+# See the GNU General Public License for more details.                         #
+#                                                                              #
+# You should have received a copy of the GNU General Public License            #
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.        #
+################################################################################
+#++
+
+# This module is used to assist in testing this gem.
+module MyModule
+  class << self
+    def my_public_module_method; end
+
+    protected
+    def my_protected_module_method; end
+
+    private
+    def my_private_module_method; end
+  end
+
+  public
+  def my_public_instance_method; end
+
+  protected
+  def my_protected_instance_method; end
+
+  private
+  def my_private_instance_method; end
+
+  module_function
+
+  def my_default_module_function; end
+
+  def my_public_module_function; end
+  public :my_public_module_function
+
+  def my_protected_module_function; end
+  protected :my_protected_module_function
+
+  def my_private_module_function; end
+  private :my_private_module_function
+end

data/test/module_functions_test.rb

@@ -0,0 +1,92 @@
+#--
+################################################################################
+#                      Copyright (C) 2011 Travis Herrick                       #
+################################################################################
+#                                                                              #
+#                                 \v^V,^!v\^/                                  #
+#                                 ~%       %~                                  #
+#                                 {  _   _  }                                  #
+#                                 (  *   -  )                                  #
+#                                 |    /    |                                  #
+#                                  \   _,  /                                   #
+#                                   \__.__/                                    #
+#                                                                              #
+################################################################################
+# This program is free software: you can redistribute it                       #
+# and/or modify it under the terms of the GNU General Public License           #
+# as published by the Free Software Foundation,                                #
+# either version 3 of the License, or (at your option) any later version.      #
+#                                                                              #
+# Commercial licensing may be available for a fee under a different license.   #
+################################################################################
+# This program is distributed in the hope that it will be useful,              #
+# but WITHOUT ANY WARRANTY;                                                    #
+# without even the implied warranty of MERCHANTABILITY                         #
+# or FITNESS FOR A PARTICULAR PURPOSE.                                         #
+# See the GNU General Public License for more details.                         #
+#                                                                              #
+# You should have received a copy of the GNU General Public License            #
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.        #
+################################################################################
+#++
+
+require_relative 'require'
+
+class ModuleFunctionsTest < Test::Unit::TestCase
+  ITEMS = {
+    :public_methods => [
+      :my_public_module_method,
+      :my_default_module_function,
+      :my_public_module_function,
+      :my_protected_module_function,
+      :my_private_module_function,
+    ],
+    :non_public_methods => [
+      :my_protected_module_method,
+      :my_private_module_method,
+    ],
+  }
+
+  def setup
+    super
+    @class = MyClass
+    @module = ModuleFunctions
+    @my_module = MyModule
+    @empty = EmptyModule
+  end
+
+  def test_import_public_methods
+    assert_nothing_raised {
+      @module.import_public_methods(@empty, @my_module) }
+    assert_responses @empty, ITEMS[:public_methods]
+    assert_no_responses @empty, ITEMS[:non_public_methods]
+  end
+
+  def test_import_into_class_should_fail
+    assert_raise(ArgumentError) {
+      @module.import_public_methods(@class, @my_module) }
+  end
+
+  def test_import_from_class_should_fail
+    assert_raise(ArgumentError) {
+      @module.import_public_methods(@my_module, @class) }
+  end
+
+
+  ############################################################################
+  private
+  ############################################################################
+
+  def assert_responses(object, methods)
+    methods.each do |method|
+      assert_respond_to object, method
+    end
+  end
+
+  def assert_no_responses(object, methods)
+    methods.each do |method|
+      assert !object.respond_to?(method),
+        "#{object.class} was not expected to respond to #{method}."
+    end
+  end
+end

data/test/require.rb

@@ -0,0 +1,9 @@
+Bundler.require :test
+
+require 'test/unit'
+
+require_relative '../lib/module_functions'
+
+require_relative 'lib/my_class'
+require_relative 'lib/my_module'
+require_relative 'lib/empty_module'

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: module_functions
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Travis Herrick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-15 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake_tasks
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 1
+        version: 0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+description: |-
+  ModuleFunctions contains useful module functions.
+  One example is the function that adds
+  all public module functions to another module.
+email: tthetoad@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/module_functions/module_functions.rb
+- lib/module_functions.rb
+- Gemfile
+- Gemfile.lock
+- module_functions.gemspec
+- rakefile
+- README
+- test/require.rb
+- test/module_functions_test.rb
+- test/lib/my_module.rb
+- test/lib/empty_module.rb
+- test/lib/my_class.rb
+has_rdoc: true
+homepage: http://www.bitbucket.org/ToadJamb/gems_module_functions
+licenses: 
+- GPLv3
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -3178384406756779379
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: This gem contains useful module functions.
+test_files: 
+- test/require.rb
+- test/module_functions_test.rb
+- test/lib/my_module.rb
+- test/lib/empty_module.rb
+- test/lib/my_class.rb