widgetz 0.0.1

data/README

@@ -0,0 +1,91 @@
+NAME
+
+  widgetz.rb
+
+SYNOPSIS
+
+  simple widgets for rails 
+
+INSTALL
+
+  gem install widgetz
+
+URIS
+  http://rubyforge.org/projects/codeforpeople/
+  http://codeforpeople.com/lib/ruby/widgetz/
+  http://drawohara.tumblr.com/post/6060120
+
+DESCRIPTION
+
+  widgetz.rb aims to fix two problems with factoring and abstracting html
+  generation in rails using the normal 'helper' methodolgy:
+
+    1) helper methods are purely procedural and provide no state.  ruby is an
+    object oriented language and we like to use objects to abstract things
+    where possible.  widgetz lets you do just that.  some people call this
+    encapsulation.
+
+    2) by using the normal rendering chain in rails, widgetz makes sure you
+    get a nice stack stace from the location in the widgetz template where 
+    you used ruby's power blow your leg off instead of some esoteric message
+    from an anonymous module you barely knew.
+
+  widgetz are essentailly bags of data that use a controller to render
+  themselves.  all the state of the widget is made available in the view as
+  local variables, while the normal @variables set in a controller remain
+  visible as normal.  one special local variable, 'widget', is set in the view's
+  local vars so you have a handle on the widget in order to use it for some evil
+  purpose.
+
+SAMPLE
+  #
+  # app/controllers/sample_controller.rb
+  #
+    def c
+      @var = 42
+      @c = widget 'c'
+
+      render :layout => 'application', :inline => <<-rhtml
+        var: <%= @var %>
+
+        <hr>
+
+        <%= @c %>
+      rhtml
+    end
+
+  #
+  # lib/widgets/c.rb
+  #
+    Widget 'c' do
+      attribute 'var' => 'forty-two'
+
+      def answer
+        42.0
+      end
+    end
+
+  #
+  # app/views/widgets/c.rhtml
+  #
+    controller var : <%= @var %>          <br> 
+    widget var     : <%= var %>           <br> 
+    widget method  : <%= widget.answer %> <br> 
+
+  #
+  # output
+  #
+    var: 42  
+    ----------------------
+    controller var : 42
+    widget var     : forty-two
+    widget method  : 42.0
+
+DOCS
+
+  lib/*
+  sample/rails/*
+
+AUTHOR
+
+  a @ http://drawohara.com/

data/README.html

@@ -0,0 +1,60 @@
+<pre>
+NAME
+
+  widgetz.rb
+
+SYNOPSIS
+
+  simple widgets for rails 
+
+INSTALL
+
+  gem install widgetz
+
+URIS
+  <a href="http://rubyforge.org/projects/codeforpeople/">http://rubyforge.org/projects/codeforpeople/</a>
+  <a href="http://codeforpeople.com/lib/ruby/widgetz/">http://codeforpeople.com/lib/ruby/widgetz/</a>
+  <a href="http://drawohara.tumblr.com/post/6060120">http://drawohara.tumblr.com/post/6060120</a>
+
+DESCRIPTION
+
+  widgetz.rb aims to fix two problems with factoring and abstracting html
+  generation in rails using the normal 'helper' methodolgy:
+
+    1) helper methods are purely procedural and provide no state.  ruby is an
+    object oriented language and we like to use objects to abstract things
+    where possible.  widgetz lets you do just that.  some people call this
+    encapsulation.
+
+    2) by using the normal rendering chain in rails, widgetz makes sure you
+    get a nice stack stace from the location in the widgetz template where 
+    you used ruby's power blow your leg off instead of some esoteric message
+    from an anonymous module you barely knew.
+
+  widgetz are essentailly bags of data that use a controller to render
+  themselves.  all the state of the widget is made available in the view as
+  local variables, while the normal @variables set in a controller remain
+  visible as normal.  one special local variable, 'widget', is set in the view's
+  local vars so you have a handle on the widget in order to use it for some evil
+  purpose.
+
+SAMPLE
+</pre>
+<div style="background:black;color:white;padding:10px;border-style:solid;border-color:gray;"><font face="monospace"> &nbsp;&nbsp;<font color="#00ffff">#</font><br> &nbsp;&nbsp;<font color="#00ffff"># app/controllers/sample_controller.rb</font><br> &nbsp;&nbsp;<font color="#00ffff">#</font><br> <font color="#5fd7ff">&nbsp;&nbsp;&nbsp;&nbsp;def </font><font color="#00ffff"><b>c</b></font><br> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<font color="#00ffff"><b>@var</b></font>&nbsp;= <font color="#ff40ff">42</font><br> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<font color="#00ffff"><b>@c</b></font>&nbsp;= widget <font color="#ffd7d7">'</font><font color="#ff40ff">c</font><font color="#ffd7d7">'</font><br> <br> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;render <font color="#00ffff"><b>:layout</b></font>&nbsp;=&gt; <font color="#ffd7d7">'</font><font color="#ff40ff">application</font><font color="#ffd7d7">'</font>, <font color="#00ffff"><b>:inline</b></font>&nbsp;=&gt; &lt;&lt;-<font color="#ffd7d7">rhtml</font><br> <font color="#ff40ff">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;var: &lt;%= @var %&gt;</font><br> <br> <font color="#ff40ff">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;hr&gt;</font><br> <br> <font color="#ff40ff">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;%= @c %&gt;</font><br> <font color="#ffd7d7">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;rhtml</font><br> &nbsp;&nbsp;&nbsp;&nbsp;<font color="#5fd7ff">end</font><br> </font></div> 
+<br>
+<div style="background:black;color:white;padding:10px;border-style:solid;border-color:gray;"><font face="monospace"> &nbsp;&nbsp;<font color="#00ffff">#</font><br> &nbsp;&nbsp;<font color="#00ffff"># lib/widgets/c.rb</font><br> &nbsp;&nbsp;<font color="#00ffff">#</font><br> &nbsp;&nbsp;&nbsp;&nbsp;<font color="#00ffff"><b>Widget</b></font>&nbsp;<font color="#ffd7d7">'</font><font color="#ff40ff">c</font><font color="#ffd7d7">'</font>&nbsp;<font color="#ffff00">do</font><br> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;attribute <font color="#ffd7d7">'</font><font color="#ff40ff">var</font><font color="#ffd7d7">'</font>&nbsp;=&gt; <font color="#ffd7d7">'</font><font color="#ff40ff">forty-two</font><font color="#ffd7d7">'</font><br> <br> <font color="#5fd7ff">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;def </font><font color="#00ffff"><b>answer</b></font><br> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<font color="#ff40ff">42.0</font><br> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<font color="#5fd7ff">end</font><br> &nbsp;&nbsp;&nbsp;&nbsp;<font color="#ffff00">end</font><br> </font></div> 
+<br>
+<div style="background:black;color:white;padding:10px;border-style:solid;border-color:gray;"><font face="monospace"> &nbsp;&nbsp;<font color="#00ffff">#</font><br> &nbsp;&nbsp;<font color="#00ffff"># app/views/widgets/c.rhtml</font><br> &nbsp;&nbsp;<font color="#00ffff">#</font><br> &nbsp;&nbsp;&nbsp;&nbsp;controller var : &lt;%= <font color="#00ffff"><b>@var</b></font>&nbsp;%&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;br&gt; <br> &nbsp;&nbsp;&nbsp;&nbsp;widget var&nbsp;&nbsp;&nbsp;&nbsp; : &lt;%= var %&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;br&gt; <br> &nbsp;&nbsp;&nbsp;&nbsp;widget method&nbsp;&nbsp;: &lt;%= widget.answer %&gt; &lt;br&gt; <br> </font></div> 
+<br>
+<div style="background:black;color:white;padding:10px;border-style:solid;border-color:gray;"><font face="monospace"> &nbsp;&nbsp;<font color="#00ffff">#</font><br> &nbsp;&nbsp;<font color="#00ffff"># output</font><br> &nbsp;&nbsp;<font color="#00ffff">#</font><br> &nbsp;&nbsp;&nbsp;&nbsp;&lt;&lt;-<font color="#ffd7d7">html</font><br> <font color="#ff40ff">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;var: 42&nbsp;&nbsp;</font><br> <font color="#ff40ff">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;----------------------</font><br> <font color="#ff40ff">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;controller var : 42</font><br> <font color="#ff40ff">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;widget var&nbsp;&nbsp;&nbsp;&nbsp; : forty-two</font><br> <font color="#ff40ff">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;widget method&nbsp;&nbsp;: 42.0</font><br> <font color="#ffd7d7">&nbsp;&nbsp;&nbsp;&nbsp;html</font><br> </font></div> 
+<br>
+<pre>
+DOCS
+
+  lib/*
+  sample/rails/*
+
+AUTHOR
+
+  a @ http://drawohara.com/
+</pre>

data/gemspec.rb

@@ -0,0 +1,28 @@
+
+lib, version = File::basename(File::dirname(File::expand_path(__FILE__))).split %r/-/, 2
+
+require 'rubygems'
+
+Gem::Specification::new do |spec|
+  $VERBOSE = nil
+  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.add_dependency 'attributes'
+
+  spec.extensions << "extconf.rb" if File::exists? "extconf.rb"
+
+  spec.author = "Ara T. Howard"
+  spec.email = "ara.t.howard@gmail.com"
+  spec.homepage = "http://codeforpeople.com/lib/ruby/#{ lib }/"
+end

data/install.rb

@@ -0,0 +1,210 @@
+#!/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
+
+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/widgets.rb

@@ -0,0 +1,154 @@
+require 'fileutils'
+require 'attributes'
+
+class Widget
+#--{{{
+  VERSION = '0.0.1' unless defined? Widget::VERSION
+  def self.version() VERSION end
+
+  class << self
+    attribute('libdir'){ File.join RAILS_ROOT, 'lib', 'widgets' }
+
+    def for_controller controller, name, *a, &b
+      klass = Widget.load name
+      returning(klass.new(*a, &b)){|widget| widget.controller = controller}
+    end
+
+    def load name
+      lib = File.join libdir, "#{ name }.rb"
+      RAILS_ENV == "development" ? Kernel.load(lib) : Kernel.require(lib)
+      #RAILS_ENV == "development" ? eval(IO.read((lib))) : Kernel.require(lib)
+      #eval(IO.read((lib)))
+      begin
+        const_for name
+      rescue
+        raise "wtf? Widget '#{ name }' was not defined in #{ lib }"
+      end
+    end
+
+    def const_for name
+      consts = name.camelize.split %r/::/
+      klass = Widget
+      consts.each{|const| klass = klass.const_get(const)}
+      klass
+    end
+
+    def new *a, &b
+      returning( allocate ) do |obj|
+        obj.instance_eval do
+          @in_render = false
+          initialize *a, &b
+        end
+      end
+    end
+  end
+  FileUtils.mkdir_p libdir rescue nil
+
+
+  attribute('name'){ self.class.name.gsub(%r/^.*Widget::/, '').underscore }
+  attribute 'controller'
+  attribute 'template'
+  attribute 'show' => true
+  attribute 'content' => ''
+
+  def inspect
+    "#{ name }=#{ super }"
+  end
+
+  def template
+    "widgets/#{ name }"
+  end
+
+  def configure options = {} , &block
+    options.to_options!
+    has_attribute = attributes.inject({}){|h,k| h.update k.to_s => true, k.to_sym => true}
+    options.each do |k,v|
+      if has_attribute[k] 
+        send k, v
+      else
+        attribute k => v
+      end
+    end
+    instance_eval &block if block
+    self
+  end
+
+  def inherited_attributes
+    ancestors = self.class.ancestors
+    offset = ancestors.index Widget
+    ancestors = ancestors[0, offset + 1].compact if offset
+    ancestors.reverse.map do |ancestor|
+      ancestor.attributes
+    end.flatten.uniq
+  end
+
+  def to_hash 
+    inherited_attributes.inject({}){|h,a| h.update a.to_sym => send(a)}
+  end
+
+  def render options = {}
+    raise "recursive render of #{ name }" if @in_render
+    @in_render = true
+    begin
+      return '' unless show?
+      widget = self
+      template = widget.template
+      locals = widget.to_hash.update options.to_options!
+      locals[:widget] = locals['widget'] = locals[:w] = locals['w'] = widget
+      controller.instance_eval do
+        render_to_string :file => template, :use_full_path => true, :locals => locals
+      end
+    ensure
+      @in_render = false
+    end
+  end
+  alias_method "to_s", "render"
+
+  def with_content
+    content yield 
+    render
+  end
+  alias_method "for_content", "with_content"
+
+  def [] k
+    send k
+  end
+
+  def []= k, v
+    send k, v
+  end
+
+  def widget name, *a, &b
+    controller.widget name, *a, &b
+  end
+
+  def self.Class path, &block
+    classes = path.camelize.split %r/::/
+    klass = Widget
+    classes.each do |const|
+      subklass = Class.new Widget
+      klass.module_eval{
+        remove_const const if const_defined? const
+        const_set const, subklass
+      }
+      klass = subklass
+    end
+    klass.module_eval &block
+    klass
+  end
+#--}}}
+end
+
+if defined?(Rails)
+  class ActionController::Base
+    def widget name = '', *a, &b
+      Widget.for_controller self, name, *a, &b
+    end
+    helper_method 'widget'
+  end
+end
+
+def Widget(*a, &b) Widget.Class(*a, &b) end
+
+Widgetz = Widget unless defined? Widgetz
+def Widgetz(*a, &b) Widgetz.Class(*a, &b) end