contextr 0.0.3 → 0.1.0

data/History.txt

@@ -1,19 +1,6 @@
-+++ 0.0.3 2007-05-22
+== 0.1.0 2007-09-07
 
-+ 3 major changes
-  + Added #add_context_sensor and #with_current_context
-  + Added #activate_layers and #deactivate_layers
-  + Added support for class side methods
-
-+++ 0.0.2 2007-05-08
-
-+ 1 major change:
-  + Changed the wrapper execution order to a hopefully more natural ordering
-  + Added documentation
-+ 1 minor change:
-  + finished transition from unit tests to rspec based specification
-
-+++ 0.0.1 2007-05-08
-
-+ 1 major enhancement:
-  + Initial release
+* major changes
+  * reimplemented the whole stack
+  * changed the API significantly
+  * no backwards compatibility at all

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 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

@@ -1,33 +1,29 @@
-COPYING.txt
 History.txt
-LICENSE.txt
+License.txt
 Manifest.txt
 README.txt
 Rakefile
-examples/education.rb
-examples/fibonacci.rb
-examples/with_current_context.rb
+examples/general.rb
+examples/ordering.rb
 lib/contextr.rb
-lib/contextr/contextr.rb
+lib/contextr/class_methods.rb
+lib/contextr/core_ext.rb
+lib/contextr/core_ext/module.rb
+lib/contextr/core_ext/object.rb
+lib/contextr/event_machine.rb
 lib/contextr/layer.rb
+lib/contextr/modules/mutex_code.rb
+lib/contextr/modules/unique_id.rb
+lib/contextr/public_api.rb
 lib/contextr/version.rb
-lib/core_ext/class.rb
-lib/core_ext/module.rb
-lib/core_ext/proc.rb
+lib/ext/active_support_subset.rb
 lib/ext/dynamic.rb
-lib/ext/method_nature.rb
-rake/group_spec_task.rb
-rake/specific_group_spec_task.rb
 scripts/txt2html
 setup.rb
-spec/contextr/contextr_api_spec.rb
-spec/contextr/contextr_class_side_spec.rb
-spec/contextr/contextr_functional_spec.rb
-spec/core_ext/module_spec.rb
-spec/core_ext/proc_spec.rb
+spec/contextr_spec.rb
+spec/spec.opts
 spec/spec_helper.rb
-tasks/annotations.rb
-test/contextr/test_contextr.rb
+test/test_contextr.rb
 test/test_helper.rb
 website/index.html
 website/index.txt

data/README.txt

@@ -1,50 +1,3 @@
-= ContextR
+README for contextr
+===================
 
-A context-oriented programming library for Ruby. 
-
-Inspired by ContextL (Pascal Costanza) and ContextS (Robert Hirschfeld) with 
-thanks to Christian Neukirchen for giving the name and lots of ideas.
-
-For more information see 
-- http://contextr.rubyforge.org/
-- http://www.contextr.org/ or 
-- http://www.swa.hpi.uni-potsdam.de/cop/
-
-This code is published under the same license as Ruby. See LICENSE.txt for more 
-information.
-
-(c) 2007 - Gregor Schmidt - Berlin, Germany
-
-= Usage
-
-  require 'rubygems'
-  require 'contextr'
-
-  class A
-    def a
-      puts "a"
-    end
- 
-    layer :foo
-
-    foo.post :a do | n |
-      n.return_value += "_with_context"
-    end
-  end
-
-  A.new.a      # => "a"
-
-  ContextR::with_layers( :foo ) do
-    A.new.a    # => "a_with_context"
-  end
-
-= Starting Points
-
-For a more detailed description
-- visit the project homepage at RubyForge[http://contextr.rubyforge.org/]
-- have a look at the +examples+ folder in the ContextR distribution
-
-For detailed API descriptions have a look at the following classes and modules
-- Class
-- ContextR::LayerInClass 
-- ContextR::ClassMethods

data/Rakefile

@@ -8,19 +8,48 @@ require 'rake/rdoctask'
 require 'rake/contrib/rubyforgepublisher'
 require 'fileutils'
 require 'hoe'
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts 'To use rspec for testing you must install rspec gem:'
+  puts '$ sudo gem install rspec'
+  exit
+end
+
 include FileUtils
 require File.join(File.dirname(__FILE__), 'lib', 'contextr', 'version')
 
-AUTHOR = 'schmidt'  # can also be an array of Authors
+AUTHOR = 'Gregor Schmidt'  # can also be an array of Authors
 EMAIL = "ruby@schmidtwisser.de"
 DESCRIPTION = "The goal is to equip Ruby with an API to allow context-oriented programming."
 GEM_NAME = 'contextr' # what ppl will type to install your gem
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}"
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  @rubyforge_username ||= @config["username"]
+end
+
 RUBYFORGE_PROJECT = 'contextr' # The unix name for your project
 HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
 DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
 
 NAME = "contextr"
-REV = File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
 VERS = ContextR::VERSION::STRING + (REV ? ".#{REV}" : "")
 CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
 RDOC_OPTS = ['--quiet', '--title', 'contextr documentation',
@@ -45,7 +74,7 @@ hoe = Hoe.new(GEM_NAME, VERS) do |p|
   p.url = HOMEPATH
   p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
   p.test_globs = ["test/**/test_*.rb"]
-  p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
+  p.clean_globs |= CLEAN  #An array of file patterns to delete on clean.
   
   # == Optional
   p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
@@ -53,6 +82,9 @@ hoe = Hoe.new(GEM_NAME, VERS) do |p|
   #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
 end
 
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\n\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
 
 desc 'Generate website files'
 task :website_generate do
@@ -63,19 +95,26 @@ end
 
 desc 'Upload website files to rubyforge'
 task :website_upload do
-  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
-  host = "#{config["username"]}@rubyforge.org"
-  remote_dir = "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/"
-  # remote_dir = "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
   local_dir = 'website'
-  sh %{rsync -av --exclude=".*/" #{local_dir}/ #{host}:#{remote_dir}}
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
 end
 
 desc 'Generate and upload website files'
-task :website => [:website_generate, :website_upload]
+task :website => [:website_generate, :website_upload, :publish_docs]
 
 desc 'Release the website and new gem version'
-task :deploy => [:check_version, :website, :release]
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
 
 task :check_version do
   unless ENV['VERSION']
@@ -88,83 +127,11 @@ task :check_version do
   end
 end
 
-#desc 'Submit the docs HTML files to RubyForge'
-#task :docs_publish => [ :docs ] do
-#  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
-#  host = "#{config["username"]}@rubyforge.org"
-#  remote_dir = "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/api"
-#  local_dir = 'doc'
-#  sh %{rsync -av --delete-excluded --exclude=".*/" #{local_dir}/ #{host}:#{remote_dir}}
-#end
-
-# Most of this code was taken from the Rubinius Rakefile. 
-# Thanks for the help.
-
-ROOT = File.expand_path(File.dirname(__FILE__))
-
-def load_files(files)
-  files.each do |path|
-    begin
-      require(path)
-    rescue Object => e
-      STDERR.puts "Unable to load #{path}. #{e.message} (#{e.class})"
-    end
-  end
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/*_spec.rb']
 end
-def require_files(files)
-  files.each do |path|
-    begin
-      require(path)
-    rescue Object => e
-      STDERR.puts "Unable to load #{path}. #{e.message} (#{e.class})"
-    end
-  end
-end
-
-begin
-    require 'spec/rake/spectask'
-rescue LoadError
-    raise <<-EOM
-Unable to load spec/rake/spectask. RSpec is a requirement to build Rubinius.
-Please install RSpec before building (http://rspec.rubyforge.org).
-    EOM
-end
-
-# Task class extensions
-paths = Dir[ File.join(File.dirname(__FILE__), 'rake/*') ]
-require_files(paths)
-#
-# Other tasks 
-paths = Dir[ File.join(File.dirname(__FILE__), 'tasks/*') ]
-load_files(paths)
-
-desc "Run all specs and tests"
-task :default => [ :spec, :test ]
-
-task :spec => 'spec:all'
-
-# Generate all the spec tasks
-namespace :spec do
-
-  spec_targets = %w(contextr core_ext)
-
-  spec_targets.each do | group |
-    spec_files = Dir[ File.join( File.dirname(__FILE__), 
-                      "spec/#{group}/*_spec.rb") ]
-
-    GroupSpecTask.new( group )
-
-    namespace group do
-      spec_files.each do | file |
-        SpecificGroupSpecTask.new( File.basename( file, '_spec.rb'), group )
-      end
-    end
-  end
-  
-  desc "Run all specs."
-  task :all => spec_targets.collect! { | group | 'spec:' << group }
-end
-
-desc "Run all benchmarks - currently none"
-task :benchmark
 
+desc "Run specs and tests by default"
+task :default => [:spec, :test]

data/examples/general.rb

@@ -0,0 +1,152 @@
+require File.dirname(__FILE__) + "/../lib/contextr.rb"
+
+module Common
+  module AddressMethods
+    def to_s
+      [yield(:next), yield(:receiver).address].join("; ")
+    end
+  end
+end
+
+class Student < Struct.new(:first_name, :last_name, :address, :university)
+  def to_s
+    [first_name, last_name].join(" ")
+  end
+
+  module EducationMethods
+    def to_s
+      [yield(:next), yield(:receiver).university].join("; ")
+    end
+  end
+
+  include Common
+  include EducationMethods => :education
+  include AddressMethods => :address
+end
+
+class University < Struct.new(:name, :address)
+  def to_s
+    name
+  end
+
+  include Common
+  include AddressMethods => :address
+end
+
+module Fibonacci
+  module ClassMethods
+    def compute(fixnum)
+      if fixnum == 1 or fixnum == 0
+        fixnum
+      elsif fixnum < 0
+        raise ArgumentError, "Fibonacci not defined for negative numbers"
+      else
+        compute(fixnum - 1) + compute(fixnum - 2)
+      end
+    end
+
+    module LoggingMethods
+      def compute(fixnum)
+        print "."
+        yield(:next, fixnum)
+      end
+    end
+
+    module CacheMethods
+      def cache
+        @cache ||={}
+      end
+
+      def compute(fixnum)
+        cache[fixnum] ||= yield(:next, fixnum)
+      end
+    end
+  end
+
+  self.extend(ClassMethods)
+  include :class_side => true,
+           ClassMethods::CacheMethods    => :cache,
+           ClassMethods::LoggingMethods  => :logging
+end
+
+puts
+puts "Example on Instance Side"
+module Example
+  module ClassMethods
+    def show
+      me = Student.new("Gregor", "Schmidt", "Berlin")
+      hpi = University.new("HPI", "Potsdam")
+      me.university = hpi
+      print(me)
+    end
+
+    def print(me)
+      puts me
+      with_addresses do
+        puts me
+      end
+      with_education do
+        puts me
+      end
+      with_education do
+        with_addresses do
+          puts me
+        end
+      end
+    end
+
+    def with_addresses
+      ContextR::with_layers :address do
+        yield
+      end
+    end
+
+    def with_education
+      ContextR::with_layers :education do
+        yield
+      end
+    end
+  end
+  self.extend(ClassMethods)
+end
+Example.show
+
+puts
+puts "Example with changed instance methods after behaviour registration"
+class Student
+  def to_s
+    [first_name, last_name].reverse.join(", ")
+  end
+end
+Example.show
+
+puts
+puts "Example with changed behaviour methods after their registration"
+module Student::EducationMethods
+  def to_s
+    [yield(:next), yield(:receiver).university].join("\n - ")
+  end
+end
+Example.show
+
+puts
+puts "Example on Class Side"
+class ExampleClassSide
+  module ClassMethods
+    def show(int = 3)
+      puts Fibonacci.compute(int)
+      ContextR::with_layers :cache do
+        puts Fibonacci.compute(int)
+      end
+      ContextR::with_layers :logging do
+        puts Fibonacci.compute(2 * int)
+
+        ContextR::with_layers :cache do
+          puts Fibonacci.compute(2 * int)
+        end
+      end
+    end
+  end
+  self.extend(ClassMethods)
+end
+ExampleClassSide.show