categories 1.0.0

data/History.txt

@@ -0,0 +1,3 @@
+=== 1.0.0 / 2008-02-09
+
+* Initial Release

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Simon Menke
+
+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,11 @@
+History.txt
+LICENSE.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/categories.rb
+spec/categories_class_spec.rb
+spec/categories_class_with_module_spec.rb
+spec/categories_instance_spec.rb
+spec/categories_instance_with_module_spec.rb
+spec/spec.opts

data/README.txt

@@ -0,0 +1,65 @@
+= categories
+
+* http://5xm.org (home)
+
+== DESCRIPTION:
+
+Easily create class and module extentions.
+
+== SYNOPSIS:
+
+  category :Hello do
+    before_include do
+      # this gets executed before the include
+      ...
+    end
+    after_include do
+      # this gets executed after the include
+      ...
+    end
+    for_class do
+      # class methods go here
+      ...
+    end
+    for_instance do
+      # instance methods go here
+      ...
+    end
+  end
+  
+  class Person
+    include Hello
+  end
+
+== REQUIREMENTS:
+
+* activesupport (OPTIONAL)
+
+== INSTALL:
+
+* sudo gem install categories
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Simon Menke
+
+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,97 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require 'spec'
+require 'spec/rake/spectask'
+require 'spec/rake/verify_rcov'
+require './lib/categories.rb'
+
+module Spec 
+   class << self; def run; false; end; end 
+end 
+
+Spec::Rake::SpecTask.new :spec do |t|
+  t.spec_files = FileList['spec/*_spec.rb']
+  t.spec_opts << "-O spec/spec.opts"
+end
+
+task :default => :spec
+
+Hoe.new('categories', Class::Category::VERSION) do |p|
+  p.rubyforge_name = 'categories'
+  p.author = 'Simon Menke'
+  p.email = 'simon@5xm.org'
+  p.summary = 'Easily create class and module extentions.'
+  # p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = "http://5xm.org"
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+
+desc "Run all specs with rcov and store coverage report in doc/output/coverage"
+Spec::Rake::SpecTask.new(:spec_rcov) do |t|
+  t.spec_files = FileList['spec/*.rb']
+  t.spec_opts << "-O spec/spec.opts"
+  t.rcov = true
+  t.rcov_dir = 'coverage'
+  t.rcov_opts = ['--exclude', 'pkg,spec,\.autotest,\/Library']
+end
+
+desc "Verify that coverage is 100%"
+RCov::VerifyTask.new(:verify_rcov => :spec_rcov) do |t|
+  t.index_html = "coverage/index.html"
+  t.threshold = 100
+end
+
+desc "Heckle each module and class in turn"
+task :heckle => :verify_rcov do
+  root_module = "Class::Category"
+  spec_files = FileList['spec/*_spec.rb']
+  
+  current_module, current_method = nil, nil
+  heckle_caught_modules = Hash.new { |hash, key| hash[key] = [] }
+  unhandled_mutations = 0
+  
+  IO.popen("spec -O spec/spec.opts --heckle #{root_module} #{spec_files}") do |pipe|
+    while line = pipe.gets
+      line = line.chomp
+      
+      if line =~ /^\*\*\*  ((?:\w+(?:::)?)+)#(\w+)/
+        current_module, current_method = $1, $2
+      elsif line == "The following mutations didn't cause test failures:"
+        heckle_caught_modules[current_module] << current_method
+      elsif line == "+++ mutation"
+        unhandled_mutations += 1 
+      end
+            
+      puts line
+    end
+  end
+  
+  if unhandled_mutations > 0
+    error_message_lines = ["*************\n"]
+    
+    error_message_lines << 
+      "Heckle found #{unhandled_mutations} " + 
+      "mutation#{"s" unless unhandled_mutations == 1} " +
+      "that didn't cause spec violations\n"
+
+    heckle_caught_modules.each do |mod, methods|
+      error_message_lines <<
+        "#{mod} contains the following poorly-specified methods:"
+      methods.each do |m| 
+        error_message_lines << " - #{m}"
+      end
+      error_message_lines << ""
+    end
+    
+    error_message_lines <<
+      "Get your act together and come back " +
+      "when your specs are doing their job!"
+    
+    puts "*************"
+    raise error_message_lines.join("\n")
+  else
+    puts "Well done! Your code withstood a heckling."
+  end
+end

data/lib/categories.rb

@@ -0,0 +1,84 @@
+
+class Class # :nodoc:
+  class Category
+    VERSION = '1.0.0'  
+    
+    def initialize(mod, &block)  # :nodoc:
+      category_model = mod if mod.is_a? Module
+      category_model.const_set("CATEGORY",self)
+      category_model.instance_eval do
+        def self.included(klass)  # :nodoc:
+          category = const_get("CATEGORY")
+          klass.instance_eval(&category.send(:before_include_proc))
+          klass.instance_eval do
+            extend  category.send(:for_class_module)
+            include category.send(:for_instance_module)
+          end
+          klass.instance_eval(&category.send(:after_include_proc))
+        end
+      end
+      self.instance_eval(&block)
+    end
+    
+    # This block is executed before the category is included in the host class or module.
+    def before_include(&block)
+      self.before_include_proc = block
+    end
+    
+    # This block is executed after the category is included in the host class or module.
+    def after_include(&block)
+      self.after_include_proc = block
+    end
+    
+    # This block defines all the class/module methods of the category.
+    def for_class(&block)
+      self.for_class_module = Module.new(&block)
+    end
+    
+    # This block defines all the instance methods of the category.
+    def for_instance(&block)
+      self.for_instance_module = Module.new(&block)
+    end
+    
+  private
+    
+    attr_accessor :before_include_proc, :after_include_proc, :for_instance_module, :for_class_module, :category_model # :nodoc:
+    
+    def before_include_proc # :nodoc:
+      @before_include_proc ||= Proc.new { || nil }
+    end
+    
+    def after_include_proc # :nodoc:
+      @after_include_proc ||= Proc.new { || nil }
+    end
+    
+    def for_class_module # :nodoc:
+      @for_class_module ||= Module.new
+    end
+    
+    def for_instance_module # :nodoc:
+      @for_instance_module ||= Module.new
+    end
+  end
+end
+
+module Kernel
+  # defines a category.
+  # If module_or_name is a String or a Symbol then a new Module will be created in the current scope with this name.
+  # If a Module is passed then this Module will be used as the category Module.
+  # 
+  # If String responds to camelcase it will be camelcased for you.
+  def category(module_or_name, &block)
+    mod = nil
+    if module_or_name.is_a? ::Module
+      mod = module_or_name
+    else
+      module_or_name = module_or_name.to_s.camelcase if module_or_name.to_s.respond_to? :camelcase
+      mod = ""
+      mod = "::#{self}" if (self.is_a? ::Module or self.is_a? ::Class) and self.to_s != "main"
+      mod = Object.module_eval("module #{mod}::#{module_or_name} ; end ; #{mod}::#{module_or_name}", __FILE__, __LINE__)
+    end
+    Class::Category.new(mod,&block)
+  end
+end
+

data/spec/categories_class_spec.rb

@@ -0,0 +1,48 @@
+
+class BaseA ; end
+
+describe BaseA do
+  
+  before :all do
+    category :BaseAClassExtention do
+      before_include do
+        class << self
+          attr_accessor :name
+        end
+      end
+      after_include do
+        class << self
+          alias_method :hello_alias, :hello
+        end
+      end
+      for_class do
+        def hello
+          "Hello #{name}"
+        end
+      end
+    end
+    BaseA.send :include, BaseAClassExtention
+  end
+  
+  it "should respond to name" do
+    BaseA.should respond_to(:name)
+  end
+  
+  it "should respond to name=" do
+    BaseA.should respond_to("name=")
+  end
+  
+  it "should respond to hello" do
+    BaseA.should respond_to(:hello)
+  end
+  
+  it "should respond to hello_alias" do
+    BaseA.should respond_to(:hello_alias)
+  end
+  
+  it "should execute properly" do
+    BaseA.name = "World"
+    BaseA.hello.should be_eql("Hello World")
+  end
+  
+end

data/spec/categories_class_with_module_spec.rb

@@ -0,0 +1,49 @@
+
+class BaseD ; end
+module BaseDClassExtention ; end
+
+describe BaseD do
+  
+  before :all do
+    category :BaseDClassExtention do
+      before_include do
+        class << self
+          attr_accessor :name
+        end
+      end
+      after_include do
+        class << self
+          alias_method :hello_alias, :hello
+        end
+      end
+      for_class do
+        def hello
+          "Hello #{name}"
+        end
+      end
+    end
+    BaseD.send :include, BaseDClassExtention
+  end
+  
+  it "should respond to name" do
+    BaseD.should respond_to(:name)
+  end
+  
+  it "should respond to name=" do
+    BaseD.should respond_to("name=")
+  end
+  
+  it "should respond to hello" do
+    BaseD.should respond_to(:hello)
+  end
+  
+  it "should respond to hello_alias" do
+    BaseD.should respond_to(:hello_alias)
+  end
+  
+  it "should execute properly" do
+    BaseD.name = "World"
+    BaseD.hello.should be_eql("Hello World")
+  end
+  
+end

data/spec/categories_instance_spec.rb

@@ -0,0 +1,44 @@
+class BaseB ; end
+
+describe BaseB, "instance" do
+  
+  before :all do
+    category :BaseBInstanceExtention do
+      before_include do
+        attr_accessor :name
+      end
+      after_include do
+        alias_method :hello_alias, :hello
+      end
+      for_instance do
+        def hello
+          "Hello #{name}"
+        end
+      end
+    end
+    BaseB.send :include, BaseBInstanceExtention
+    @base = BaseB.new
+  end
+  
+  it "should respond to name" do
+    @base.should respond_to(:name)
+  end
+  
+  it "should respond to name=" do
+    @base.should respond_to("name=")
+  end
+  
+  it "should respond to hello" do
+    @base.should respond_to(:hello)
+  end
+  
+  it "should respond to hello_alias" do
+    @base.should respond_to(:hello_alias)
+  end
+  
+  it "should execute properly" do
+    @base.name = "World"
+    @base.hello.should be_eql("Hello World")
+  end
+  
+end

data/spec/categories_instance_with_module_spec.rb

@@ -0,0 +1,45 @@
+class BaseC ; end
+module BaseCInstanceExtention ; end 
+
+describe BaseB, "instance" do
+  
+  before :all do
+    category BaseCInstanceExtention do
+      before_include do
+        attr_accessor :name
+      end
+      after_include do
+        alias_method :hello_alias, :hello
+      end
+      for_instance do
+        def hello
+          "Hello #{name}"
+        end
+      end
+    end
+    BaseC.send :include, BaseCInstanceExtention
+    @base = BaseC.new
+  end
+  
+  it "should respond to name" do
+    @base.should respond_to(:name)
+  end
+  
+  it "should respond to name=" do
+    @base.should respond_to("name=")
+  end
+  
+  it "should respond to hello" do
+    @base.should respond_to(:hello)
+  end
+  
+  it "should respond to hello_alias" do
+    @base.should respond_to(:hello_alias)
+  end
+  
+  it "should execute properly" do
+    @base.name = "World"
+    @base.hello.should be_eql("Hello World")
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--color
+-r lib/categories.rb
+-f specdoc

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: categories
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Simon Menke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-02-11 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.0
+    version: 
+description: Easily create class and module extentions.
+email: simon@5xm.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- LICENSE.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- LICENSE.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/categories.rb
+- spec/categories_class_spec.rb
+- spec/categories_class_with_module_spec.rb
+- spec/categories_instance_spec.rb
+- spec/categories_instance_with_module_spec.rb
+- spec/spec.opts
+has_rdoc: true
+homepage: http://5xm.org
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: categories
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Easily create class and module extentions.
+test_files: []
+