aetherical_utils 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-06-14
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 FIXME full name
+
+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/Manifest.txt

@@ -0,0 +1,30 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+config/requirements.rb
+lib/aetherical_utils.rb
+lib/aetherical_utils/attribute.rb
+lib/aetherical_utils/loader.rb
+lib/aetherical_utils/metaid.rb
+lib/aetherical_utils/misc.rb
+lib/aetherical_utils/traiter.rb
+lib/aetherical_utils/version.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+spec/aetherical_utils_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/rspec.rake
+tasks/website.rake
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/PostInstall.txt

@@ -0,0 +1,6 @@
+
+For more information on aetherical_utils, see http://war.rubyforge.org/aetherical_utils
+
+
+
+

data/README.txt

@@ -0,0 +1,62 @@
+= aetherical_utils
+
+http://war.rubyforge.org/aetherical_utils
+
+== DESCRIPTION:
+
+This library provides a number of utility functions and features which
+were originally part of the WAR gem.
+
+== FEATURES/PROBLEMS:
+
+* attribute.rb -- provides code to create attributes (like attr_accessor)
+  which have a default value which may be a proc / block.
+
+* loader.rb -- provides code to create classes on the fly based upon a
+  yaml file.
+
+* metaid.rb -- from _why
+
+* misc.rb -- This contains several things:
+  * subclass -- describes subclasses of a class
+
+* traiter.rb -- based upon Dwemthy's Array, it is used to create
+  classes which have traits.  WAR uses this with loader to create
+  units and terrain.
+
+== SYNOPSIS:
+
+   See individual files for usage
+
+== REQUIREMENTS:
+
+   None
+
+== INSTALL:
+
+   sudo gem install aetherical_utils
+
+== LICENSE:
+
+Unless otherwise declared, this code is under the MIT License.
+
+Copyright (c) 2008 Matt Williams, matt@aetherical.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/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/aetherical_utils/attribute.rb

@@ -0,0 +1,51 @@
+# This is a portion of the Aetherical Utils gem, a collection of
+# utilities developed, in part, for use with the WAR library
+#
+#
+# Author::    Matt Williams  (mailto:matt@aetherical.com)
+# Copyright:: Copyright (c) 2008 Matthew Williams, All Rights Reserved
+# License::   MIT License
+
+module AethericalUtils
+  module Attribute
+  # Attribute is a method of declaring default values for a property.
+  # These default values may be either an explicit value, such as 1,
+  # or "dog", or they may be a block _which is evaluated at runtime_.
+  # As such, the block could return different values each time it is
+  # invoked.
+  #
+  # If the attribute is a boolean, denoted by '?', such as
+  # 'billable?', then the library will correctly create 'billable?'
+  # and 'billable=' methods.
+  #
+  # *Important*: Since the instance variable ('@billable') may not be
+  # defined or the attribute may represent the value returned by a
+  # block, it is important to access the attribute via the method
+  # ('billable?') as opposed to the instance variable name
+  # ('@billable').
+
+  def self.attribute(*arg,&block)
+    (name, default) = arg
+    short_name = name.to_s.sub(/\?/,"")
+    self.send(:define_method, name) {
+      if instance_variables.include? "@#{short_name}"
+           self.instance_eval "@#{short_name}"
+      else
+        if block_given?
+          instance_eval &block
+        else
+          default
+        end
+      end
+    }
+    self.send(:define_method, "#{short_name}="){ |value|
+      self.instance_eval "@#{short_name} = value"
+    }
+  end
+  end
+end
+
+
+Object.send(:include, AethericalUtils::Attribute)
+
+

data/lib/aetherical_utils/loader.rb

@@ -0,0 +1,56 @@
+# This is a portion of the War library, a library of utilities
+# and methods for wargaming.
+#
+#
+# Author::    Matt Williams  (mailto:matt@aetherical.com)
+# Copyright:: Copyright (c) 2008 Matthew Williams, All Rights Reserved
+# License::   MIT License
+
+require 'yaml'
+
+module AethericalUtils
+  # This class loads and creates classes which have been defined in
+  # a yaml file.  The file is expected to contain two elements,
+  # templates and classes.  A sample file looks like:
+  # ---
+  # templates:
+  #   soldier:
+  #     movement: 1
+  #     vision: 1
+  #     zone_of_control: 1
+  #     range: 1
+  # classes:
+  # - name: militia
+  #   template: soldier
+  #   attributes:
+  #     strength: 50
+  #     attack: -10
+  #     defence: 10
+  #     cost: 50
+  #     symbol: m
+  #
+  # The classes are then created from the information in the yaml file
+  class Loader
+    # This method loads the classes defined in the yaml file.
+    # +parent+ represents the parent class of classes being loaded;
+    # if not present, it's expected to be in the yaml.
+    def self.load_classes(file, parent = nil)
+      begin
+        y = YAML.load(File.open(file))
+        templates = y["templates"] || { }
+        klasses = y["classes"] || []
+        klasses.each do |klass|
+          puts klass['name']
+          k = Object.const_set(klass['name'].capitalize,
+                               Class.new(parent || Object.const_get(klass['parent'].capitalize)))
+          k.class_eval  <<EOF
+  #{(klass['traits'].nil? ? "" : "traits #{klass['traits'].map{ |trait| ":#{trait}"}.join(",")}")}
+  #{(templates["#{klass['template']}"] || {}).merge((klass['attributes'] || {})).sort.map{|t| t[1]="\"#{t[1]}\"" if t[1].instance_of?(String); t.join(" ").downcase}.join("\n")}
+EOF
+        end
+      rescue Exception => e
+        puts "Error parsing File #{file}: #{e}"
+      end
+    end
+  end
+end

data/lib/aetherical_utils/metaid.rb

@@ -0,0 +1,25 @@
+# This class is originally from _why
+# http://whytheluckystiff.net/articles/seeingMetaclassesClearly.html
+#
+#
+
+module AethericalUtils
+  module Metaid
+    # The hidden singleton lurks behind everyone
+    def metaclass; class << self; self; end; end
+    def meta_eval &blk; metaclass.instance_eval &blk; end
+
+    # Adds methods to a metaclass
+    def meta_def name, &blk
+      meta_eval { define_method name, &blk }
+    end
+
+    # Defines an instance method within a class
+    def class_def name, &blk
+      class_eval { define_method name, &blk }
+    end
+  end
+end
+
+Object.send(:include, AethericalUtils::Metaid)
+

data/lib/aetherical_utils/misc.rb

@@ -0,0 +1,31 @@
+# This is a portion of the AethericalUtils library.
+#
+#
+# Author::    Matt Williams  (mailto:matt@aetherical.com)
+# Copyright:: Copyright (c) 2008 Matthew Williams, All Rights Reserved
+# License::   MIT License
+
+module AethericalUtils
+  module Misc
+    module Subclasses
+      # return a list of the subclasses of a class
+      def subclasses(direct = false)
+        classes = []
+        if direct
+          ObjectSpace.each_object(Class) do |c|
+            next unless c.superclass == self
+            classes << c
+          end
+        else
+          ObjectSpace.each_object(Class) do |c|
+            next unless c.ancestors.include?(self) and (c != self)
+            classes << c
+          end
+        end
+        classes
+      end
+    end
+  end
+end
+
+Object.send(:include, AethericalUtils::Misc::Subclasses)

data/lib/aetherical_utils/traiter.rb

@@ -0,0 +1,33 @@
+# This is a portion of the Aetherical Utils library, a library of utilities
+# used by WAR
+#
+# Author::    Matt Williams  (mailto:matt@aetherical.com)
+# Copyright:: Copyright (c) 2008 Matthew Williams, All Rights Reserved
+# License::   MIT License
+# This is a modification of _why's Creature class from DWEMTHY's array
+# The way _why had it, the initialize method would fail if there was not
+# at least one trait defined.
+
+require 'aetherical_utils/metaid'
+module AethericalUtils
+  class Traiter
+    def self.traits( *arr )
+      return @traits if arr.empty?
+      attr_accessor *arr
+      arr.each do |trait|
+        meta_def trait do |val|
+          @traits ||= {}
+          @traits[trait] = val
+        end
+      end
+      class_def :initialize do
+
+        self.class.traits.each do |k,v|
+          instance_variable_set( "@#{k}", v )
+        end unless (self.class.traits.nil?)
+
+      end
+    end
+  end
+end
+

data/lib/aetherical_utils/version.rb

@@ -0,0 +1,9 @@
+module AethericalUtils #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/aetherical_utils.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+dirname = File.basename(__FILE__).sub(/.rb/,"")
+
+Dir[File.dirname(__FILE__) + "/#{dirname}/**/*.rb"].sort.each do |path|
+  require "#{path}"
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/aetherical_utils.rb'}"
+puts "Loading aetherical_utils gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+GEM_NAME = 'aetherical_utils' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'war'
+
+require 'rubygems'
+begin
+  require 'newgem'
+  require 'rubyforge'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + "/../lib/#{GEM_NAME}/version.rb"
+
+version  = AethericalUtils::VERSION::STRING
+download = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+def rubyforge_project_id
+  RubyForge.new.autoconfig["group_ids"][RUBYFORGE_PROJECT]
+end
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.html.erb')
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text_template = fsrc.read
+  body_text = ERB.new(body_text_template).result(binding)
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)