module_with_params 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,8 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in module_with_params.gemspec
+gemspec
+
+gem 'rake'
+gem 'schmurfy-bacon'
+

data/README.md

@@ -0,0 +1,53 @@
+This gem is a simple way to solve a problem I often have: How
+to write a module designed to be included and allow the class including
+it to configure its behavior.
+
+I have tried many solutions but this one is the most elegant one I
+have for now and the code is at the same time really short and easy to
+understand.
+
+# Supported versions
+
+- MRI 1.8.7+
+
+# Example
+
+You can pass a hash as argument:
+
+```ruby
+module MySuperModule
+  include ModuleWithParams
+  
+  def number
+    _MySuperModule_module_options[:number]
+  end
+end
+
+
+class A
+  include MySuperModule[:number => 234]
+  
+end
+
+A.new.number # => 234
+```
+
+Or an array:
+
+```ruby
+module MySuperModule
+  include ModuleWithParams
+  
+  def number
+    _MySuperModule_module_options[0]
+  end
+end
+
+
+class A
+  include MySuperModule[234]
+  
+end
+
+A.new.number # => 234
+```

data/Rakefile

@@ -0,0 +1,14 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :default => :test
+
+task :test do
+  require 'bacon'
+  
+  Dir[File.expand_path('../specs/*_spec.rb', __FILE__)].each do |file|
+    load(file)
+  end
+
+end
+

data/lib/module_with_params.rb

@@ -0,0 +1,19 @@
+require "module_with_params/version"
+
+module ModuleWithParams
+  def self.included(klass)
+    klass.send(:extend, ClassMethods)
+  end
+  
+  module ClassMethods
+    def [](*args)
+      clone.tap do |mod|
+        module_name = self.name
+        mod.instance_eval do
+          define_method(:"_#{module_name}_module_options"){ (args.size == 1) ? args[0] : args }
+        end
+      end
+    end
+  end
+  
+end

data/lib/module_with_params/version.rb

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

data/module_with_params.gemspec

@@ -0,0 +1,15 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/module_with_params/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Julien Ammous"]
+  gem.email         = []
+  gem.description   = %q{include module with parameters}
+  gem.summary       = %q{module with parameters}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.name          = "module_with_params"
+  gem.require_paths = ["lib"]
+  gem.version       = ModuleWithParams::VERSION
+end

data/specs/common.rb

@@ -0,0 +1,10 @@
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'bacon'
+
+$LOAD_PATH.unshift( File.expand_path('../../lib', __FILE__) )
+require 'module_with_params'
+
+Bacon.summary_at_exit

data/specs/module_with_params_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path('../common', __FILE__)
+
+module TestModule
+  include ModuleWithParams
+  
+  def number
+    _TestModule_module_options[:number]
+  end
+end
+
+module TestModuleArray
+  include ModuleWithParams
+  
+  def first
+    _TestModuleArray_module_options[0]
+  end
+  
+  def second
+    _TestModuleArray_module_options[1]
+  end
+  
+end
+
+describe 'Module with params' do
+  
+  it 'can be included included in multiple separate classes' do
+    cl = Class.new do
+      include TestModule[:number => 5]
+    end
+    
+    cl2 = Class.new do
+      include TestModule[:number => 43]
+    end
+    
+    cl.new.number.should == 5
+    cl2.new.number.should == 43
+  end
+  
+  it 'can be used with non hash parameters' do
+    cl = Class.new do
+      include TestModuleArray["hello", 43]
+    end
+    obj = cl.new
+    obj.first.should == "hello"
+    obj.second.should == 43
+  end
+  
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: module_with_params
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Julien Ammous
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-14 00:00:00.000000000 Z
+dependencies: []
+description: include module with parameters
+email: []
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/module_with_params.rb
+- lib/module_with_params/version.rb
+- module_with_params.gemspec
+- specs/common.rb
+- specs/module_with_params_spec.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'
+      segments:
+      - 0
+      hash: -1270772489623524378
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1270772489623524378
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: module with parameters
+test_files: []