real_include 0.1.0

data/CHANGELOG

@@ -0,0 +1,2 @@
+4/10/10 version 0.1.0
+* release! This is still beta, not 100% tested yet..but appears to work OK so far

data/README.markdown

@@ -0,0 +1,34 @@
+Real Include
+--------------
+
+(c) John Mair (banisterfiend) 
+MIT license
+
+Removes the shackles from Module#include - use Module#real_include to
+bring in singleton classes from modules. No more ugly ClassMethods and
+included() hook hacks.
+
+example: 
+
+    module M
+        # class method
+        def self.hello
+            puts "hello!"
+        end
+
+        # instance method
+        def bye
+            puts "bye!"
+        end
+    end
+
+    class A
+        real_include M
+    end
+
+    # invoke class method
+    A.hello #=> hello!
+
+    # invoke instance method
+    A.new.bye #=> bye!
+

data/Rakefile

@@ -0,0 +1,36 @@
+$LOAD_PATH.unshift File.join(File.expand_path(__FILE__), '..')
+
+require 'rake/clean'
+require 'rake/gempackagetask'
+
+# get the texplay version
+require 'lib/real_include/version'
+
+$dlext = Config::CONFIG['DLEXT']
+
+CLEAN.include("ext/**/*.#{$dlext}", "ext/**/*.log", "ext/**/*.o", "ext/**/*~", "ext/**/*#*", "ext/**/*.obj", "ext/**/*.def", "ext/**/*.pdb")
+CLOBBER.include("**/*.#{$dlext}", "**/*~", "**/*#*", "**/*.log", "**/*.o")
+
+specification = Gem::Specification.new do |s|
+    s.name = "real_include"
+    s.summary = "Fixing the limitation in traditional Module#include"
+    s.version = RealInclude::VERSION
+    s.date = Time.now.strftime '%Y-%m-%d'
+    s.author = "John Mair (banisterfiend)"
+    s.email = 'jrmair@gmail.com'
+    s.description = s.summary
+    s.require_path = 'lib'
+    s.platform = Gem::Platform::RUBY
+    s.homepage = "http://banisterfiend.wordpress.com"
+    s.has_rdoc = false
+
+    s.extensions = ["ext/real_include/extconf.rb"]
+    s.files =  ["Rakefile", "README.markdown", "CHANGELOG", 
+                "lib/real_include.rb", "lib/real_include/version.rb"] +
+        FileList["ext/**/extconf.rb", "ext/**/*.h", "ext/**/*.c"].to_a 
+end
+
+Rake::GemPackageTask.new(specification) do |package|
+  package.need_zip = false
+  package.need_tar = false
+end

data/ext/real_include/compat.h

@@ -0,0 +1,18 @@
+/* contains basic macros to facilitate ruby 1.8 and ruby 1.9 compatibility */
+
+#ifndef GUARD_COMPAT_H
+#define GUARD_COMPAT_H
+
+#include <ruby.h>
+
+/* macros for backwards compatibility with 1.8 */
+#ifndef RUBY_19
+# define RCLASS_M_TBL(c) (RCLASS(c)->m_tbl)
+# define RCLASS_SUPER(c) (RCLASS(c)->super)
+# define RCLASS_IV_TBL(c) (RCLASS(c)->iv_tbl)
+#endif
+
+/* a useful macro. cannot use ordinary CLASS_OF as it does not return an lvalue */
+#define KLASS_OF(c) (RBASIC(c)->klass)
+
+#endif

data/ext/real_include/extconf.rb

@@ -0,0 +1,9 @@
+require 'mkmf'
+
+# 1.9 compatibility
+$CFLAGS += " -DRUBY_19" if RUBY_VERSION =~ /1.9/
+
+# let's use c99
+$CFLAGS += " -std=c99"
+
+create_makefile('real_include')

data/ext/real_include/real_include.c

@@ -0,0 +1,124 @@
+#include "compat.h"
+#include "ruby.h"
+
+#define FALSE 0
+#define TRUE 1
+
+static VALUE
+class_alloc(VALUE flags, VALUE klass)
+{
+    rb_classext_t *ext = ALLOC(rb_classext_t);
+    NEWOBJ(obj, struct RClass);
+    OBJSETUP(obj, klass, flags);
+    obj->ptr = ext;
+    RCLASS_IV_TBL(obj) = 0;
+    RCLASS_M_TBL(obj) = 0;
+    RCLASS_SUPER(obj) = 0;
+    RCLASS_IV_INDEX_TBL(obj) = 0;
+    return (VALUE)obj;
+}
+
+static VALUE
+include_class_new(VALUE module, VALUE super)
+{
+  if (module == rb_singleton_class(rb_cModule))
+    return module;
+    
+  VALUE klass = class_alloc(T_ICLASS, rb_singleton_class(rb_cModule));
+
+  /* if (BUILTIN_TYPE(module) == T_ICLASS) { */
+  /*   module = RBASIC(module)->klass; */
+  /* } */
+  if (!RCLASS_IV_TBL(module)) {
+    RCLASS_IV_TBL(module) = st_init_numtable();
+  }
+  RCLASS_IV_TBL(klass) = st_init_numtable();
+  RCLASS_M_TBL(klass) = RCLASS_M_TBL(module);
+  RCLASS_SUPER(klass) = super;
+  /*
+    if (TYPE(module) == T_ICLASS) {
+    RBASIC(klass)->klass = RBASIC(module)->klass;
+    }
+  */
+  
+  /* create IClass for module's singleton  */
+
+  VALUE meta = include_class_new(KLASS_OF(module), super ? KLASS_OF(super) : rb_cModule); 
+  if (meta != rb_singleton_class(rb_cModule)) {
+    FL_SET(meta, FL_SINGLETON);
+
+    /* attach singleton to module */
+    rb_singleton_class_attached(meta, klass);
+  }
+  /* assign the metaclass to module's klass */
+  KLASS_OF(klass) = meta;
+        
+  OBJ_INFECT(klass, module);
+  OBJ_INFECT(klass, super);
+
+  return (VALUE)klass;
+}
+
+VALUE
+rb_real_include_module(VALUE klass, VALUE module)
+{
+  VALUE p, c;
+  int changed = 0;
+
+  rb_frozen_class_p(klass);
+  if (!OBJ_UNTRUSTED(klass)) {
+    rb_secure(4);
+  }
+
+  if (TYPE(module) != T_MODULE) {
+    Check_Type(module, T_MODULE);
+  }
+
+  OBJ_INFECT(klass, module);
+  c = klass;
+
+  /* ensure singleton class exists */
+  rb_singleton_class(module);
+  rb_singleton_class(klass);
+  
+  while (module) {
+    int superclass_seen = FALSE;
+
+    if (RCLASS_M_TBL(klass) == RCLASS_M_TBL(module))
+      rb_raise(rb_eArgError, "cyclic include detected");
+    /* ignore if the module included already in superclasses */
+    for (p = RCLASS_SUPER(klass); p; p = RCLASS_SUPER(p)) {
+      switch (BUILTIN_TYPE(p)) {
+      case T_ICLASS:
+        if (RCLASS_M_TBL(p) == RCLASS_M_TBL(module)) {
+          if (!superclass_seen) {
+            c = p;  /* move insertion point */
+          }
+          goto skip;
+        }
+        break;
+      case T_CLASS:
+        superclass_seen = TRUE;
+        break;
+      }
+    }
+
+    VALUE imod = include_class_new(module, RCLASS_SUPER(c));
+    RCLASS_SUPER(c) = imod;
+    RCLASS_SUPER(KLASS_OF(c)) = KLASS_OF(imod);
+    c = imod;
+        
+    if (RMODULE_M_TBL(module) && RMODULE_M_TBL(module)->num_entries)
+      changed = 1;
+  skip:
+    module = RCLASS_SUPER(module);
+  }
+  if (changed) rb_clear_cache();
+
+  return Qnil;
+}
+
+void
+Init_real_include() {
+  rb_define_method(rb_cModule, "real_include", rb_real_include_module, 1);
+}

data/lib/real_include.rb

@@ -0,0 +1,14 @@
+# bring in user-defined extensions to TexPlay
+direc = File.dirname(__FILE__)
+dlext = Config::CONFIG['DLEXT']
+begin
+    if RUBY_VERSION && RUBY_VERSION =~ /1.9/
+        require "#{direc}/1.9/real_include.#{dlext}"
+    else
+        require "#{direc}/1.8/real_include.#{dlext}"
+    end
+rescue LoadError => e
+    require "#{direc}/real_include.#{dlext}"
+end
+
+require "#{direc}/real_include/version"

data/lib/real_include/version.rb

@@ -0,0 +1,3 @@
+module RealInclude
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: real_include
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- John Mair (banisterfiend)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-04 00:00:00 +13:00
+default_executable: 
+dependencies: []
+
+description: Fixing the limitation in traditional Module#include
+email: jrmair@gmail.com
+executables: []
+
+extensions: 
+- ext/real_include/extconf.rb
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- README.markdown
+- CHANGELOG
+- lib/real_include.rb
+- lib/real_include/version.rb
+- ext/real_include/extconf.rb
+- ext/real_include/compat.h
+- ext/real_include/real_include.c
+has_rdoc: true
+homepage: http://banisterfiend.wordpress.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Fixing the limitation in traditional Module#include
+test_files: []
+