smtlaissezfaire-mix_master 0.0.3

data/MIT_LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Scott Taylor (smtlaissezfaire) <scott@railsnewbie.com>
+
+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.rdoc

@@ -0,0 +1,32 @@
+= MixMaster
+
+A pure ruby solution for mixing & unmix modules from classes.
+
+  module Foo
+    def foo
+      'foo'
+    end
+  end
+
+  class Baz
+    mixin Foo
+  end
+
+  b = Baz.new
+  => #<Baz:0x6aa48c>
+  b.foo
+  => "foo"
+
+  Baz.mixout Foo
+  => [Foo]
+
+  Baz.new.foo
+  NoMethodError: undefined method `foo' for #<Baz:0x69a640>
+  	from (irb):30
+  b.foo
+  NoMethodError: undefined method `foo' for #<Baz:0x6aa48c>
+  	from (irb):31
+
+== Inspiration
+
+Both _why's and Dan Manges' libraries (mixico and mixology) have been of great inspiration.

data/Rakefile

@@ -0,0 +1,6 @@
+
+Dir.glob(File.dirname(__FILE__) + "/rake_tasks/**/**").each do |file|
+  load file
+end
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.0.3

data/lib/mix_master.rb

@@ -0,0 +1,23 @@
+require "using"
+
+module MixMaster
+  extend Using
+  
+  using :Mixer
+  using :MixinTable
+  using :ModuleExtension
+  using :Version
+  
+  class MixingError < StandardError; end
+  extend Mixer
+  
+  class << self
+    def install
+      mixin MixMaster::ModuleExtension, Object
+    end
+  
+    def uninstall
+      mixout MixMaster::ModuleExtension, Object
+    end
+  end
+end

data/lib/mix_master/mixer.rb

@@ -0,0 +1,37 @@
+module MixMaster
+  module Mixer
+    def mixin(mod, target)
+      mod_duplicate = mod.clone
+      
+      target.instance_eval { include mod_duplicate }
+      
+      mixin_table.set(mod, target, mod_duplicate)
+    end
+  
+    def mixout(from, to)
+      check_mixin(from, to)
+      
+      mixin_table.get(from, to).instance_eval do
+        methods = (public_instance_methods(false) + protected_instance_methods(false) + private_instance_methods(false))
+        
+        methods.each do |m|
+          remove_method m
+        end
+      end
+      
+      mixin_table.delete(from, to)
+    end
+    
+  private
+  
+    def check_mixin(from, to)
+      unless mixin_table.exists?(from, to)
+        raise MixMaster::MixingError, "#{from} was never mixed into #{to} with #mixin, or was already mixed out"
+      end
+    end
+  
+    def mixin_table
+      @mixin_table ||= MixinTable.new
+    end
+  end
+end

data/lib/mix_master/mixin_table.rb

@@ -0,0 +1,24 @@
+module MixMaster
+  class MixinTable
+    def initialize
+      @list = {}
+    end
+
+    def set(source, target, source_dup)
+      @list[source] ||= {}
+      @list[source][target] = source_dup
+    end
+
+    def exists?(from, to)
+      get(from, to) ? true : false
+    end
+
+    def get(from, to)
+      @list[from] && @list[from][to]
+    end
+    
+    def delete(from, to)
+      @list[from] = nil
+    end
+  end
+end

data/lib/mix_master/module_extension.rb

@@ -0,0 +1,15 @@
+module MixMaster
+  module ModuleExtension
+    def mixin(*mods)
+      mods.each do |mod|
+        MixMaster.mixin(mod, self)
+      end
+    end
+
+    def mixout(*mods)
+      mods.each do |mod|
+        MixMaster.mixout(mod, self)
+      end
+    end
+  end
+end

data/lib/mix_master/version.rb

@@ -0,0 +1,9 @@
+module MixMaster
+  module Version
+    STRING = File.read(File.expand_path(File.dirname(__FILE__) + "/../../VERSION")).strip
+    
+    MAJOR,
+    MINOR,
+    TINY   = STRING.split(",")
+  end
+end

data/mix_master.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mix_master}
+  s.version = "0.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Scott Taylor"]
+  s.date = %q{2009-09-05}
+  s.description = %q{Allows modules to be unmixed at runtime from classes, much as Mixology or Mixico do.  Implemented in pure ruby with no C extensions.}
+  s.email = %q{scott@railsnewbie.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "BUGS.rdoc",
+     "GPL_LICENSE",
+     "MIT_LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/mix_master.rb",
+     "lib/mix_master/mixer.rb",
+     "lib/mix_master/mixin_table.rb",
+     "lib/mix_master/module_extension.rb",
+     "lib/mix_master/version.rb",
+     "mix_master.gemspec",
+     "rake_tasks/flog.rake",
+     "rake_tasks/gems.rake",
+     "rake_tasks/rdoc.rake",
+     "rake_tasks/rspec.rake",
+     "rake_tasks/sloc.rake",
+     "rake_tasks/tags.rake",
+     "spec/installation_spec.rb",
+     "spec/mix_master_spec.rb",
+     "spec/module_methods_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/version_spec.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/smtlaissezfaire/mix_master}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Mix and unmix modules}
+  s.test_files = [
+    "spec/installation_spec.rb",
+     "spec/mix_master_spec.rb",
+     "spec/module_methods_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/version_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<smtlaissezfaire-using>, [">= 0.1.5"])
+    else
+      s.add_dependency(%q<smtlaissezfaire-using>, [">= 0.1.5"])
+    end
+  else
+    s.add_dependency(%q<smtlaissezfaire-using>, [">= 0.1.5"])
+  end
+end

data/rake_tasks/flog.rake

@@ -0,0 +1,10 @@
+desc "Feel the pain of my code, and submit a refactoring patch"
+task :flog do
+  puts %x(find lib | grep ".rb$" | xargs flog)
+end
+
+task :flog_to_disk => :create_doc_directory do
+  puts "Flogging..."
+  %x(find lib | grep ".rb$" | xargs flog > doc/flog.txt)
+  puts "Done Flogging...\n"
+end

data/rake_tasks/gems.rake

@@ -0,0 +1,19 @@
+begin
+  require 'jeweler'
+  
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name        = "mix_master"
+    gemspec.summary     = "Mix and unmix modules"
+    gemspec.description = <<-DESC
+      Allows modules to be unmixed at runtime from classes,
+      much as Mixology or Mixico do.  Implemented in pure ruby with
+      no C extensions.
+    DESC
+    gemspec.email       = "scott@railsnewbie.com"
+    gemspec.homepage    = "http://github.com/smtlaissezfaire/mix_master"
+    gemspec.authors     = ["Scott Taylor"]
+    gemspec.add_dependency "smtlaissezfaire-using", ">= 0.1.5"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/rake_tasks/rdoc.rake

@@ -0,0 +1,16 @@
+require 'rake'
+require 'hanna/rdoctask'
+
+DOC_DIRECTORY = File.dirname(__FILE__) + "/../doc"
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = DOC_DIRECTORY
+  rdoc.title    = "mix_master"
+  rdoc.options << '--line-numbers' << '--inline-source'
+
+  rdoc.options << '--webcvs=http://github.com/mislav/will_paginate/tree/master/'
+
+  ["README.rdoc", "BUGS.rdoc", "GPL_LICENSE", "MIT_LICENSE", "lib/**/*.rb"].each do |file|
+    rdoc.rdoc_files.include(file)
+  end
+end

data/rake_tasks/rspec.rake

@@ -0,0 +1,20 @@
+require 'spec/rake/spectask'
+require 'spec/rake/verify_rcov'
+
+desc 'Run the specs'
+Spec::Rake::SpecTask.new do |t|
+  t.warning = false
+  t.spec_opts = ["--color"]
+end
+
+desc "Create the html specdoc"
+Spec::Rake::SpecTask.new(:specdoc) do |t|
+  t.spec_opts = ["--format", "html:doc/specdoc.html"]
+end
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
+  t.rcov_dir = "doc/rcov"
+end

data/rake_tasks/sloc.rake

@@ -0,0 +1,16 @@
+def sloc
+  `sloccount #{File.dirname(__FILE__)}/../lib #{File.dirname(__FILE__)}/../ext`
+end
+
+desc "Output sloccount report.  You'll need sloccount installed."
+task :sloc do
+  puts "Counting lines of code"
+  puts sloc
+end
+
+desc "Write sloccount report"
+task :output_sloc => :create_doc_directory do
+  File.open(File.dirname(__FILE__) + "/doc/lines_of_code.txt", "w") do |f|
+    f << sloc
+  end
+end

data/rake_tasks/tags.rake

@@ -0,0 +1,23 @@
+# Build the TAGS file for Emacs
+# Taken with slight modifications from 
+# http://blog.lathi.net/articles/2007/11/07/navigating-your-projects-in-emacs
+#
+# Thanks Jim Weirich
+
+module Emacs
+  module Tags
+    def self.ruby_files
+      @ruby_files ||= FileList['**/*.rb'].exclude("pkg")
+    end
+  end
+end
+
+namespace :tags do
+  task :emacs do
+    puts "Making Emacs TAGS file"
+    sh "ctags -e #{Emacs::Tags.ruby_files}", :verbose => false
+  end
+end
+
+desc "Build the emacs tags file"
+task :tags => ["tags:emacs"]

data/spec/installation_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
+
+describe MixMaster do
+  describe "installation" do
+    after do
+      MixMaster.uninstall
+    end
+    
+    it "should have mixin + mixout in Object" do
+      MixMaster.install
+      Object.should respond_to(:mixin)
+      Object.should respond_to(:mixout)
+    end
+  end
+  
+  describe "uninstall" do
+    before do
+      MixMaster.install
+    end
+    
+    it "should uninstall mixin, mixout" do
+      MixMaster.uninstall
+    
+      Object.should_not respond_to(:mixin)
+      Object.should_not respond_to(:mixout)
+    end
+  end
+end

data/spec/mix_master_spec.rb

@@ -0,0 +1,179 @@
+require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
+
+describe MixMaster do
+  describe "mixing a module into a class" do
+    before do
+      @target = Class.new
+      @source = Module.new do
+        def something
+        end
+        
+        def a_public_method
+        end
+        
+      protected
+      
+        def a_protected_method
+        end
+        
+      private
+      
+        def a_private_method
+        end
+      end
+    end
+    
+    describe "mixing in" do
+      it "should add a public method" do
+        MixMaster.mixin(@source, @target)
+      
+        @target.new.should respond_to(:something)
+      end
+    
+      it "should add private methods" do
+        MixMaster.mixin(@source, @target)
+      
+        @target.new.private_methods.should include("a_private_method")
+      end
+    
+      it "should add protected methods" do
+        MixMaster.mixin(@source, @target)
+      
+        @target.new.protected_methods.should include("a_protected_method")
+      end
+    end
+    
+    describe "mixing out" do
+      it "should no longer respond to a public method" do
+        MixMaster.mixin(@source, @target)
+        MixMaster.mixout(@source, @target)
+      
+        @target.new.should_not respond_to(:something)
+      end
+      
+      it "should no longer respond to any public method" do
+        MixMaster.mixin(@source, @target)
+        MixMaster.mixout(@source, @target)
+      
+        @target.new.should_not respond_to(:a_public_method)
+      end
+      
+      it "should no longer have protected methods added" do
+        MixMaster.mixin(@source, @target)
+        MixMaster.mixout(@source, @target)
+      
+        @target.new.protected_methods.should_not include("a_protected_method")
+      end
+      
+      it "should no longer have private methods added" do
+        MixMaster.mixin(@source, @target)
+        MixMaster.mixout(@source, @target)
+      
+        @target.new.private_methods.should_not include("a_private_method")
+      end
+      
+      it "should not remove the methods from the module given" do
+        lambda {
+          MixMaster.mixin(@source, @target)
+          MixMaster.mixout(@source, @target)
+        }.should_not change { @source.instance_methods }
+      end
+      
+      it "should have a method added after remixing" do
+        MixMaster.mixin(@source, @target)
+        MixMaster.mixout(@source, @target)
+        MixMaster.mixin(@source, @target)
+        
+        @target.new.should respond_to(:something)
+      end
+      
+      it "should raise an error if never mixed in" do
+        lambda {
+          MixMaster.mixout(@source, @target)
+        }.should raise_error(MixMaster::MixingError, "#{@source} was never mixed into #{@target} with #mixin, or was already mixed out")
+      end
+      
+      it "should be able to mixout from a first module after mixing to a second one" do
+        one = Module.new do
+          def one; end
+        end
+        
+        two = Module.new do
+          def two; end
+        end
+        
+        MixMaster.mixin(one, @target)
+        MixMaster.mixin(two, @target)
+        MixMaster.mixout(one, @target)
+        
+        @target.new.should_not respond_to(:one)
+        @target.new.should respond_to(:two)
+      end
+      
+      it "should add methods in a module inside of a module" do
+        one = Module.new do
+          def one; end
+        end
+        
+        two = Module.new do
+          include one
+        end
+        
+        MixMaster.mixin(two, @target)
+        
+        @target.new.should respond_to(:one)
+      end
+      
+      it "should NOT remove methods from other parents (such as modules included into the module given)" do
+        one = Module.new do
+          def one; end
+        end
+        
+        two = Module.new do
+          include one
+        end
+        
+        MixMaster.mixin(two, @target)
+        MixMaster.mixout(two, @target)
+        
+        @target.new.should respond_to(:one)
+      end
+      
+      it "should not remove methods like to_s which will be defined on a regular object & a module (since the class is always first in the hierarchy chain)" do
+        one = Module.new do
+        end
+        
+        MixMaster.mixin(one, @target)
+        MixMaster.mixout(one, @target)
+        
+        @target.new.should respond_to(:inspect)
+      end
+      
+      it "should allow calling of super in the hierarchy chain" do
+        one = Module.new do
+          def something
+            "from_mod"
+          end
+        end
+        
+        two = Module.new do
+          def something
+            super
+          end
+        end
+        
+        klass = Class.new do
+          def something
+            super
+          end
+        end
+        
+        MixMaster.mixin(one, klass)
+        MixMaster.mixin(two, klass)
+        MixMaster.mixout(two, klass)
+        
+        klass.new.something.should == "from_mod"
+      end
+    end
+  end
+end