shared 0.4.2

data/README

@@ -0,0 +1,183 @@
+NAME
+  shared.rb
+
+DESCRIPTION
+  super simple super power sharing of instance and class level code
+
+INSTALL
+  gem install shared
+
+URIS
+  http://rubyforge.org/projects/codeforpeople
+  http://codeforpeople.com/lib/ruby/
+
+HISTORY
+  0.4.2
+    initial version
+
+SAMPLES
+
+  <========< samples/a.rb >========>
+
+  ~ > cat samples/a.rb
+
+    # shared.rb is a very simple and very powerful method of sharing code between
+    # classes.
+    #
+      require 'shared'
+    
+      shared(:code) do
+        def classname() self.class.name end
+      end
+    
+      class Foo 
+        include shared(:code)
+      end
+    
+      class Bar
+        include shared(:code)
+      end
+    
+      p Foo.new.classname #=> "Foo"
+    
+      p Bar.new.classname #=> "Bar"
+
+  ~ > ruby samples/a.rb
+
+    "Foo"
+    "Bar"
+
+
+  <========< samples/b.rb >========>
+
+  ~ > cat samples/b.rb
+
+    # shared.rb allows natural declaration of both instance and class-level
+    # methods - it's more than simple module inclusion
+    #
+    
+      require 'shared'
+    
+      shared('methods') do
+        def self.class_method() 40 end
+    
+        def instance_method() 2 end
+      end
+    
+      class C
+        include shared('methods')
+      end
+    
+      p(C.class_method + C.new.instance_method) #=> 42
+      
+
+  ~ > ruby samples/b.rb
+
+    42
+
+
+  <========< samples/c.rb >========>
+
+  ~ > cat samples/c.rb
+
+    # shared.rb works equally well with individual objects in addition to the
+    # normal class level usage
+    #
+    
+      require 'shared'
+    
+      shared(:meta_tools) do
+        def singleton_class &block
+          singleton_class =
+            class << self
+              self
+            end
+          block ? singleton_class.module_eval(&block) : singleton_class
+        end
+      end
+    
+      a = %w( a b c )
+    
+      a.extend shared(:meta_tools)
+    
+      a.singleton_class do
+        def to_range() first .. last end
+      end
+    
+      p a.to_range #=> "a".."c"
+
+  ~ > ruby samples/c.rb
+
+    "a".."c"
+
+
+  <========< samples/d.rb >========>
+
+  ~ > cat samples/d.rb
+
+    # an example use-case for shared.rb is sharing code bewteen classes that
+    # require both class level and instance level behaviour to be shared
+    #
+    
+      require 'shared'
+    
+      shared(:acts_as_named) do
+        validates_precence_of :name
+    
+        def to_html() "<blink> #{ name } </blink>" end
+      end
+    
+      class Model
+        def Model.validates_precence_of(*a) end
+    
+        def name() 'zaphod' end
+    
+        include shared(:acts_as_named)
+      end
+    
+      p Model.new.to_html #=> "<blink> zaphod </blink>"
+
+  ~ > ruby samples/d.rb
+
+    "<blink> zaphod </blink>"
+
+
+  <========< samples/e.rb >========>
+
+  ~ > cat samples/e.rb
+
+    # it's important to note that the shared code is injected into the reciever
+    # fresh on each call and, in that way, the effect is rather macro like
+    #
+    
+      require 'shared'
+    
+      share(:instance_tracker) do
+        const_set :Instances, []
+      
+        def self.instances() const_get :Instances end
+    
+        def self.new *a, &b
+          obj = super
+        ensure
+          instances << obj
+        end
+      end
+    
+      class Foo
+        include shared(:instance_tracker)
+      end
+    
+      class Bar 
+        include shared(:instance_tracker)
+      end
+    
+      2.times{ Foo.new }
+      40.times{ Bar.new }
+    
+      p(Foo.instances.size + Bar.instances.size)
+
+  ~ > ruby samples/e.rb
+
+    42
+

data/gemspec.rb

@@ -0,0 +1,38 @@
+#! /usr/bin/env gem build
+
+lib, version = File::basename(File::dirname(File::expand_path(__FILE__))).split %r/-/, 2
+
+require 'rubygems'
+
+Gem::Specification::new do |spec|
+  $VERBOSE = nil
+
+  shiteless = lambda do |list|
+    list.delete_if do |file|
+      file =~ %r/\.svn/ or
+      file =~ %r/\.tmp/
+    end
+  end
+
+  spec.name = lib 
+  spec.version = version 
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = lib 
+
+  spec.files = shiteless[Dir::glob("**/**")]
+  spec.executables = shiteless[Dir::glob("bin/*")].map{|exe| File::basename exe}
+  
+  spec.require_path = "lib" 
+
+  spec.has_rdoc = File::exist? "doc" 
+  spec.test_suite_file = "test/#{ lib }.rb" if File::directory? "test"
+  #spec.add_dependency 'lib', '>= version'
+  spec.add_dependency 'fattr'
+
+  spec.extensions << "extconf.rb" if File::exists? "extconf.rb"
+
+  spec.rubyforge_project = 'codeforpeople'
+  spec.author = "Ara T. Howard"
+  spec.email = "ara.t.howard@gmail.com"
+  spec.homepage = "http://codeforpeople.com/lib/ruby/#{ lib }/"
+end

data/gen_readme.rb

@@ -0,0 +1,35 @@
+#! /usr/bin/env ruby
+
+require 'pathname'
+
+$VERBOSE=nil
+
+def indent s, n = 2
+  ws = ' ' * n
+  s.gsub %r/^/, ws 
+end
+
+template = IO::read 'README.tmpl'
+
+samples = ''
+prompt = '~ > '
+
+Dir['sample*/*'].sort.each do |sample|
+  samples << "\n" << "  <========< #{ sample } >========>" << "\n\n"
+
+  cmd = "cat #{ sample }" 
+  samples << indent(prompt + cmd, 2) << "\n\n" 
+  samples << indent(`#{ cmd }`, 4) << "\n" 
+
+  cmd = "ruby #{ sample }" 
+  samples << indent(prompt + cmd, 2) << "\n\n" 
+
+  cmd = "ruby -e'STDOUT.sync=true; exec %(ruby -Ilib #{ sample })'" 
+  #cmd = "ruby -Ilib #{ sample }" 
+  samples << indent(`#{ cmd } 2>&1`, 4) << "\n" 
+end
+
+#samples.gsub! %r/^/, '  '
+
+readme  = template.gsub %r/^\s*@samples\s*$/, samples
+print readme 

data/install.rb

@@ -0,0 +1,214 @@
+#!/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 (/\.svn/ =~ File.dirname(f))
+    next if f =~ %r/\.lnk/
+    next if f =~ %r/\.svn/
+    next if f =~ %r/\.swp/
+    next if f =~ %r/\.svn/
+    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
+
+system "#{ sudo } #{ $ruby } pre-install.rb" if test(?s, 'pre-install.rb')
+
+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
+
+system "#{ sudo } #{ $ruby } post-install.rb" if test(?s, 'post-install.rb')

data/lib/shared.rb

@@ -0,0 +1,59 @@
+module Shared
+  Code = {}
+
+  def shared name, &block
+    key = key_for name
+
+    return Code[key] if block.nil?
+
+    m = (Code[key] || Module.new)
+
+    singleton_class(m) do
+      unless defined?(@@blocks)
+        @@blocks = []
+
+        define_method(:blocks){ @@blocks }
+
+        define_method(:included) do |other|
+          blocks.each{|b| other.send(:module_eval, &b)}
+        end
+
+        define_method(:extend_object) do |other|
+          Shared.singleton_class(other) do
+            m.blocks.each{|b| module_eval &b}
+          end
+        end
+      end
+    end
+
+    m.blocks << block
+
+    Code[key] ||= m
+  end
+  
+  alias_method 'share', 'shared'
+
+  def key_for name
+    name.to_s.strip.downcase
+  end
+
+  def singleton_class object, &block
+    singleton_class =
+      class << object
+        self
+      end
+    block ? singleton_class.module_eval(&block) : singleton_class
+  end
+
+  extend self
+end
+
+class Object
+  def share *a, &b
+    Shared.share *a, &b
+  end
+
+  def shared *a, &b
+    Shared.shared *a, &b
+  end
+end

data/samples/a.rb

@@ -0,0 +1,20 @@
+# shared.rb is a very simple and very powerful method of sharing code between
+# classes.
+#
+  require 'shared'
+
+  shared(:code) do
+    def classname() self.class.name end
+  end
+
+  class Foo 
+    include shared(:code)
+  end
+
+  class Bar
+    include shared(:code)
+  end
+
+  p Foo.new.classname #=> "Foo"
+
+  p Bar.new.classname #=> "Bar"

data/samples/b.rb

@@ -0,0 +1,18 @@
+# shared.rb allows natural declaration of both instance and class-level
+# methods - it's more than simple module inclusion
+#
+
+  require 'shared'
+
+  shared('methods') do
+    def self.class_method() 40 end
+
+    def instance_method() 2 end
+  end
+
+  class C
+    include shared('methods')
+  end
+
+  p(C.class_method + C.new.instance_method) #=> 42
+  

data/samples/c.rb

@@ -0,0 +1,25 @@
+# shared.rb works equally well with individual objects in addition to the
+# normal class level usage
+#
+
+  require 'shared'
+
+  shared(:meta_tools) do
+    def singleton_class &block
+      singleton_class =
+        class << self
+          self
+        end
+      block ? singleton_class.module_eval(&block) : singleton_class
+    end
+  end
+
+  a = %w( a b c )
+
+  a.extend shared(:meta_tools)
+
+  a.singleton_class do
+    def to_range() first .. last end
+  end
+
+  p a.to_range #=> "a".."c"

data/samples/d.rb

@@ -0,0 +1,21 @@
+# an example use-case for shared.rb is sharing code bewteen classes that
+# require both class level and instance level behaviour to be shared
+#
+
+  require 'shared'
+
+  shared(:acts_as_named) do
+    validates_precence_of :name
+
+    def to_html() "<blink> #{ name } </blink>" end
+  end
+
+  class Model
+    def Model.validates_precence_of(*a) end
+
+    def name() 'zaphod' end
+
+    include shared(:acts_as_named)
+  end
+
+  p Model.new.to_html #=> "<blink> zaphod </blink>"

data/samples/e.rb

@@ -0,0 +1,30 @@
+# it's important to note that the shared code is injected into the reciever
+# fresh on each call and, in that way, the effect is rather macro like
+#
+
+  require 'shared'
+
+  share(:instance_tracker) do
+    const_set :Instances, []
+  
+    def self.instances() const_get :Instances end
+
+    def self.new *a, &b
+      obj = super
+    ensure
+      instances << obj
+    end
+  end
+
+  class Foo
+    include shared(:instance_tracker)
+  end
+
+  class Bar 
+    include shared(:instance_tracker)
+  end
+
+  2.times{ Foo.new }
+  40.times{ Bar.new }
+
+  p(Foo.instances.size + Bar.instances.size)

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: shared
+version: !ruby/object:Gem::Version 
+  version: 0.4.2
+platform: ruby
+authors: 
+- Ara T. Howard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-09 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fattr
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: ara.t.howard@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- gemspec.rb
+- gen_readme.rb
+- install.rb
+- lib
+- lib/shared.rb
+- README
+- samples
+- samples/a.rb
+- samples/b.rb
+- samples/c.rb
+- samples/d.rb
+- samples/e.rb
+has_rdoc: false
+homepage: http://codeforpeople.com/lib/ruby/shared/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: codeforpeople
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: shared
+test_files: []
+