dynaload 0.2.0 → 0.2.1

data/HISTORY

@@ -0,0 +1,11 @@
+---
+0.2.1:
+  - the verisioned and non-versioned files in lib were out of sync.  this just
+    fixes that
+0.2.0:
+  - massively simplified the code to the core set of functionality i've found
+    most useful.
+0.1.1:
+  - efficiency tweak.  thanks akonsu <akonsu@gmail.com>
+0.1.0:
+  - added ability to export objects

data/README

@@ -0,0 +1,133 @@
+URIS
+  http://raa.ruby-lang.org/project/dynaload/
+  http://www.codeforpeople.com/lib/ruby/dynaload/
+
+NAME
+  dynaload.rb
+
+DESCRIPTION
+  a simple toolset to make dynamic loading of classes and modules easier
+
+  imagine you have many files containing the following kinds of class
+  definitions
+
+    class ClassName 
+      def method 
+      end
+    end
+
+  you'd like to be able to dynamically load the file defining a class,
+  instantiate the class(es) defined in it, and and run ClassName#method on an
+  instance WITHOUT knowing beforhand which class will be loaded.  dyanload
+  solves this problem.  classes wishing to be dyanloaded do the following
+
+    ----------------
+    file: 1.rb
+    ----------------
+      require 'dynaload'
+
+      class ClassOne
+        def answer 
+          42
+        end
+      end
+
+      Dynaload::export ClassOne, 'answer' => true 
+
+    ----------------
+    file: 2.rb
+    ----------------
+      require 'dynaload'
+
+      class ClassTwo
+        def answer 
+          42
+        end
+      end
+
+      Dynaload::export ClassTwo, 'answer' => true 
+
+  the options hash ('answer' => true) may contain anything deemed useful and is
+  entirely dedicated for user data
+
+  now both files can be dynaloaded, the classes instantiated, and methods called
+  with
+
+    require 'dynaload'
+
+    %w( 1.rb 2.rb ).each do |file|
+      loaded = Dynaload::dynaload file 
+
+      klasses = loaded.select{|klass, attributes| attributes['answer'] == true}
+
+      klasses.each do |klass, attributes|
+        object = klass::new
+        p object.answer
+      end
+    end
+
+  any class or module defined in a file can be exported and is then available
+  via the Dynaload interface.  for instance:
+
+    class C
+      module M
+        class B
+          Dynaload::export B
+        end
+      end
+    end
+    Dynaload::export C
+
+  is valid and exports only the classes C and B - not C::M.  
+  
+  the concept works best with modules as the exported quantities and loading
+  within an anonymous wrapper module (the default) to protect the namespace.
+  eg.
+
+    ----------------
+    file: 1.rb
+    ----------------
+
+      require 'dynaload'
+
+      module FooJob
+        def run
+          ...
+        end
+      end
+
+      Dynaload::export FooJob
+
+    ----------------
+    file: 2.rb
+    ----------------
+
+      require 'dynaload'
+
+      module BarJob
+        def run
+          ...
+        end
+      end
+
+      Dynaload::export BarJob
+
+    loading is done (by default) in an anonymous module so neither FooJob or
+    BarJob is introduced into the caller's namespace:
+
+      require 'dynaload'
+
+      loaded = Dynaload::dynaload('1.rb') | Dynaload::dynaload('2.rb')
+
+      modules = loaded.modules
+
+      # here neither FooJob or BarJob are polluting namespace
+
+
+
+SAMPLES/DOCS
+  see samples/*
+
+
+CAVEATS
+  this software is experimental and quite simple

data/gemspec.rb

@@ -0,0 +1,23 @@
+lib, version = File::basename(File::dirname(File::expand_path(__FILE__))).split %r/-/, 2
+
+require 'rubygems'
+
+Gem::Specification::new do |spec|
+  spec.name = lib 
+  spec.version = version 
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = lib 
+
+  spec.files = Dir::glob "**/**"
+  spec.executables = Dir::glob("bin/*").map{|exe| File::basename exe}
+  
+  spec.require_path = "lib" 
+  spec.autorequire = lib
+
+  spec.has_rdoc = File::exist? "doc" 
+  spec.test_suite_file = "test/#{ lib }.rb" if File::directory? "test"
+
+  spec.author = "Ara T. Howard"
+  spec.email = "ara.t.howard@noaa.gov"
+  spec.homepage = "http://codeforpeople.com/lib/ruby/#{ lib }/"
+end

data/install.rb

@@ -0,0 +1,206 @@
+#!/usr/bin/env ruby
+require 'rbconfig'
+require 'find'
+require 'ftools'
+require 'tempfile'
+include Config
+
+LIBDIR      = "lib"
+LIBDIR_MODE = 0644
+
+BINDIR      = "bin"
+BINDIR_MODE = 0755
+
+
+$srcdir            = CONFIG["srcdir"]
+$version           = CONFIG["MAJOR"]+"."+CONFIG["MINOR"]
+$libdir            = File.join(CONFIG["libdir"], "ruby", $version)
+$archdir           = File.join($libdir, CONFIG["arch"])
+$site_libdir       = $:.find {|x| x =~ /site_ruby$/}
+$bindir            = CONFIG["bindir"] || CONFIG['BINDIR']
+$ruby_install_name = CONFIG['ruby_install_name'] || CONFIG['RUBY_INSTALL_NAME'] || 'ruby'
+$ruby_ext          = CONFIG['EXEEXT'] || ''
+$ruby              = File.join($bindir, ($ruby_install_name + $ruby_ext))
+
+if !$site_libdir
+  $site_libdir = File.join($libdir, "site_ruby")
+elsif $site_libdir !~ %r/#{Regexp.quote($version)}/
+  $site_libdir = File.join($site_libdir, $version)
+end
+
+def install_rb(srcdir=nil, destdir=nil, mode=nil, bin=nil)
+#{{{
+  path   = []
+  dir    = []
+  Find.find(srcdir) do |f|
+    next unless FileTest.file?(f)
+    next if (f = f[srcdir.length+1..-1]) == nil
+    next if (/CVS$/ =~ File.dirname(f))
+    next if f =~ %r/\.lnk/
+    path.push f
+    dir |= [File.dirname(f)]
+  end
+  for f in dir
+    next if f == "."
+    next if f == "CVS"
+    File::makedirs(File.join(destdir, f))
+  end
+  for f in path
+    next if (/\~$/ =~ f)
+    next if (/^\./ =~ File.basename(f))
+    unless bin
+      File::install(File.join(srcdir, f), File.join(destdir, f), mode, true)
+    else
+      from = File.join(srcdir, f)
+      to = File.join(destdir, f)
+      shebangify(from) do |sf|
+        $deferr.print from, " -> ", File::catname(from, to), "\n"
+        $deferr.printf "chmod %04o %s\n", mode, to 
+        File::install(sf, to, mode, false)
+      end
+    end
+  end
+#}}}
+end
+def shebangify f
+#{{{
+  open(f) do |fd|
+    buf = fd.read 42 
+    if buf =~ %r/^\s*#\s*!.*ruby/o
+      ftmp = Tempfile::new("#{ $$ }_#{ File::basename(f) }")
+      begin
+        fd.rewind
+        ftmp.puts "#!#{ $ruby  }"
+        while((buf = fd.read(8192)))
+          ftmp.write buf
+        end
+        ftmp.close
+        yield ftmp.path
+      ensure
+        ftmp.close!
+      end
+    else
+      yield f
+    end
+  end
+#}}}
+end
+def ARGV.switch
+#{{{
+  return nil if self.empty?
+  arg = self.shift
+  return nil if arg == '--'
+  if arg =~ /^-(.)(.*)/
+    return arg if $1 == '-'
+    raise 'unknown switch "-"' if $2.index('-')
+    self.unshift "-#{$2}" if $2.size > 0
+    "-#{$1}"
+  else
+    self.unshift arg
+    nil
+  end
+#}}}
+end
+def ARGV.req_arg
+#{{{
+  self.shift || raise('missing argument')
+#}}}
+end
+def linkify d, linked = []
+#--{{{
+  if test ?d, d
+    versioned = Dir[ File::join(d, "*-[0-9].[0-9].[0-9].rb") ]
+    versioned.each do |v| 
+      src, dst = v, v.gsub(%r/\-[\d\.]+\.rb$/, '.rb')
+      lnk = nil
+      begin
+        if test ?l, dst
+          lnk = "#{ dst }.lnk"
+          puts "#{ dst } -> #{ lnk }"
+          File::rename dst, lnk
+        end
+        unless test ?e, dst
+          puts "#{ src } -> #{ dst }"
+          File::copy src, dst 
+          linked << dst
+        end
+      ensure
+        if lnk
+          at_exit do
+            puts "#{ lnk } -> #{ dst }"
+            File::rename lnk, dst
+          end
+        end
+      end
+    end
+  end
+  linked
+#--}}}
+end
+
+
+#
+# main program
+#
+
+libdir = $site_libdir
+bindir = $bindir
+no_linkify = false
+linked = nil
+help = false
+
+usage = <<-usage
+  #{ File::basename $0 }
+    -d, --destdir    <destdir>
+    -l, --libdir     <libdir>
+    -b, --bindir     <bindir>
+    -r, --ruby       <ruby>
+    -n, --no_linkify
+    -s, --sudo
+    -h, --help
+usage
+
+begin
+  while switch = ARGV.switch
+    case switch
+    when '-d', '--destdir'
+      libdir = ARGV.req_arg
+    when '-l', '--libdir'
+      libdir = ARGV.req_arg
+    when '-b', '--bindir'
+      bindir = ARGV.req_arg
+    when '-r', '--ruby'
+      $ruby = ARGV.req_arg
+    when '-n', '--no_linkify'
+      no_linkify = true
+    when '-s', '--sudo'
+      sudo = 'sudo' 
+    when '-h', '--help'
+      help = true
+    else
+      raise "unknown switch #{switch.dump}"
+    end
+  end
+rescue
+  STDERR.puts $!.to_s
+  STDERR.puts usage
+  exit 1
+end    
+
+if help
+  STDOUT.puts usage
+  exit
+end
+
+unless no_linkify
+  linked = linkify('lib') + linkify('bin')
+end
+
+system "#{ $ruby } extconf.rb && make && #{ sudo } make install" if test(?s, 'extconf.rb')
+
+install_rb(LIBDIR, libdir, LIBDIR_MODE)
+install_rb(BINDIR, bindir, BINDIR_MODE, bin=true)
+
+if linked
+  linked.each{|path| File::rm_f path}
+end

data/lib/dynaload-0.2.1.rb

@@ -0,0 +1,67 @@
+module Dynaload
+  VERSION = '0.2.0'
+
+  require "sync"
+
+  extend Sync_m
+
+  class ExportError < ::StandardError; end
+
+  class Exported < ::Hash
+    THINGS = %w( classes modules objects )
+    def initialize *a, &b
+      super
+      THINGS.each{|thing| self[thing] = []}
+    end
+    def method_missing m, *a, &b
+      self["#{ m }"] || super
+    end
+    def empty?
+      THINGS.map{|thing| self[thing].empty?}.all?
+    end
+    def clear!
+      THINGS.each{|thing| self[thing].clear}
+      self
+    end
+    def export thing, attributes 
+      case thing 
+        when Class
+          (self['classes'] << [thing, attributes]).uniq!
+        when Module
+          (self['modules'] << [thing, attributes]).uniq!
+        else
+          (self['objects'] << [thing, attributes]).uniq!
+      end
+      self
+    end
+    def dup
+      THINGS.inject({}){|h,t| h[t] = self[t].dup}
+    end
+  end
+
+  class << self
+    def exported
+      synchronize{ @exported ||= Exported::new }
+    end
+
+    def export thing, attributes = {}
+      synchronize{ exported.export thing, attributes }
+    end
+
+    def dynaload path, opts = {"wrap" => true}
+      ret = nil
+      synchronize do
+        begin
+          @exported = Exported::new
+          ::Kernel::load(path, opts["wrap"] || opts[:wrap]) 
+          raise ExportError, "no dynamic exports from <#{ path }>!" if 
+            @exported.nil? or @exported.empty?
+          ret = @exported
+        ensure
+          @exported = nil
+        end
+      end
+      ret
+    end
+  end
+end

data/sample/loaded.rb

@@ -0,0 +1,35 @@
+$:.unshift '../lib' and $:.unshift './lib'
+
+require "dynaload"
+
+module M
+  C = 4
+  module N
+    C = 2
+  end
+  class A
+    def run
+      4
+    end
+    class B
+      def run
+        2
+      end
+    end
+  end
+end
+
+Dynaload::export M, 
+  "description" => "the M module"
+
+Dynaload::export M::N, 
+  "description" => "the M::N module"
+
+Dynaload::export M::A, 
+  "description" => "the M::A class",
+  "runnable"    => true
+
+Dynaload::export M::A::B, 
+  "description"  => "the M::A::B class",
+  "runnable"     => true,
+  "these can be" => "any attributes you like!"

data/sample/loader.rb

@@ -0,0 +1,48 @@
+$:.unshift '../lib' and $:.unshift './lib'
+
+require "yaml"
+require "dynaload"
+
+#
+# load loaded.rb
+#
+  dirname, basename = File::split __FILE__
+  loaded_rb = File::join dirname, "loaded.rb"
+  loaded = Dynaload::dynaload loaded_rb, "wrap" => false
+
+#
+# examine loaded modules, their constants, and descriptions
+#
+
+  report = {}
+  loaded.modules.each do |m, attributes|
+    name = m.to_s
+    report[name] = {}
+    report[name]["constants"] = {}
+    report[name]["attributes"] = {}
+
+    m.constants.each do |const|
+      value = m.const_get const 
+      report[name]["constants"][const] = value unless
+        Class === value or Module === value 
+    end
+
+    attributes.each do |k,v|
+      report[name]["attributes"][k] = v
+    end
+  end
+  y report
+
+#
+# find loaded classes that are runnable and run them 
+#
+  runnables = 
+    loaded.classes.select{|c,attributes| attributes["runnable"]}
+
+  report = {}
+  runnables.each do |c,attributes|
+    name = c.name 
+    report[name] = {}
+    report[name]["run"] = c::new.run 
+  end
+  y report

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.2
 specification_version: 1
 name: dynaload
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
-date: 2005-12-12 00:00:00 -07:00
+  version: 0.2.1
+date: 2007-10-04 00:00:00 -06:00
 summary: dynaload
 require_paths: 
-  - lib
+- lib
 email: ara.t.howard@noaa.gov
 homepage: http://codeforpeople.com/lib/ruby/dynaload/
 rubyforge_project: 
@@ -18,23 +18,38 @@ bindir: bin
 has_rdoc: false
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
-    - 
-      - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
   version: 
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
-  - Ara T. Howard
+- Ara T. Howard
 files: 
-  - lib/dynaload-0.2.0.rb
-  - lib/dynaload.rb
+- lib
+- lib/dynaload.rb
+- lib/dynaload-0.2.1.rb
+- README
+- install.rb
+- sample
+- sample/loader.rb
+- sample/loaded.rb
+- gemspec.rb
+- HISTORY
 test_files: []
+
 rdoc_options: []
+
 extra_rdoc_files: []
+
 executables: []
+
 extensions: []
+
 requirements: []
-dependencies: []
+
+dependencies: []
+

data/lib/dynaload-0.2.0.rb

@@ -1,81 +0,0 @@
-module Dynaload
-  VERSION = '0.2.0'
-
-  class ExportError < ::StandardError; end
-
-  class Exported < ::Hash
-    THINGS = %w( classes modules objects )
-    def initialize(*a, &b)
-      super
-      THINGS.each{|thing| self[thing] = []}
-    end
-    def method_missing(m,*a,&b)
-      self[m] || self["#{ m }"] || super
-    end
-    def empty?
-      THINGS.map{|thing| self[thing].empty?}.all?
-    end
-    def clear!
-      THINGS.each{|thing| self[thing].clear}
-      self
-    end
-    def 
-          case thing 
-            when Class
-              dyna_exported.classes << [thing, attributes]
-            when Module
-              dyna_exported.modules << [thing, attributes]
-            else
-              dyna_exported.objects << [thing, attributes]
-          end
-  end
-
-  module Dynaloadable
-    module ClassMethods
-      def dyna_exported
-        ::Dynaload::exported ||= ::Dynaload::Exported::new 
-      end
-      def dyna_export *args
-        things, attribute_hashes = args.partition{|arg| not Hash === arg} 
-        raise ArgumentError, "nothing given to dyna_export!" if things.empty?
-        attributes = attribute_hashes.inject({}){|h,ah| h.update ah}
-        things.each do |thing|
-          case thing 
-            when Class
-              dyna_exported.classes << [thing, attributes]
-            when Module
-              dyna_exported.modules << [thing, attributes]
-            else
-              dyna_exported.objects << [thing, attributes]
-          end
-        end
-        dyna_exported.classes.uniq!
-        dyna_exported.modules.uniq!
-        dyna_exported.objects.uniq!
-        dyna_exported
-      end
-      alias_method "export", "dyna_export"
-      alias_method "exported", "dyna_exported"
-    end
-    module InstanceMethods; end
-    extend ClassMethods
-    def self::included other 
-      other.extend ClassMethods
-      other.module_eval{ include InstanceMethods }
-    end
-  end
-
-  class Dynaloader
-    def dynaload path
-      ::Kernel::load path, true 
-      raise ExportError, "no dynamic exports from <#{ path }>!" if Dynaload::exported.empty?
-      Dynaload::exported
-    end
-  end
-
-  include Dynaloadable
-
-  def self::dynaload(*a, &b)
-    (@dynaloader ||= Dynaloader::new).dynaload(*a, &b)
-  end
-end