observe 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+/doc/

data/.travis.yml

@@ -0,0 +1,13 @@
+rvm:
+  - 1.8.7 
+  - 1.9.2
+  - 1.9.3
+  - rbx-2.0
+  - jruby
+  - ruby-head
+  - ree
+
+notifications:
+  irc: "irc.freenode.org#flowof.info"
+  recipients:
+    - rob@flowof.info

data/.yardopts

@@ -0,0 +1,10 @@
+-M redcarpet
+-m markdown
+--private
+--no-private
+--hide-void-return
+--no-cache
+- 
+LICENSE.txt
+
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in captainhook.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (C) 2011 by Robert Gleeson
+
+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/README.md

@@ -0,0 +1,60 @@
+__OVERVIEW__
+
+| Project         | Observe 
+|:----------------|:--------------------------------------------------
+| Homepage        | https://github.com/robgleeson/observe
+| Documentation   | http://rubydoc.info/gems/observe/frames 
+| Author          | Rob Gleeson             
+
+
+__DESCRIPTION__
+
+  A simple interface for adding observers to any class.  
+  The interface is similar to and takes ideas from the 'Observable' module in the Ruby standard library.
+
+__DIFFERENCES__
+
+  There are a few differences between 'Observe' and the 'Observable' module:
+
+  * An observer is any object that responds to `call`.  
+    Proc objects can be observers out of the box.
+
+  * Observers belong to 'groups'.  
+    In the example below, `:ignition` is a group, as is `:brakes`.
+
+  * There is no `changed` method.    
+    If you want to notify observers, go ahead & use `notify_observers`.   
+    If there is state that needs to be true before observers can be notified, you can use `if(…)`.
+
+__EXAMPLE__
+
+    class Car
+
+      include Observe
+
+      def initialize
+        add_observer(:ignition) { .. }  
+        add_observer(:brakes) { .. } 
+      end
+
+      def drive
+        notify_observers(:ignition)
+        puts "Vroom Vroom."
+        notify_observers(:brakes)
+      end
+
+    end
+
+    Car.new.drive
+
+__INSTALL__
+
+  gem install observe
+
+__LICENSE__
+
+  
+  See LICENSE.txt
+
+
+ 

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.name       = :test
+  t.test_files = FileList["test/*.rb"]
+end
+
+task :default => :test

data/lib/observe.rb

@@ -0,0 +1,82 @@
+module Observe
+
+  @observer = Struct.new(:group, :object)
+
+  class << self 
+    attr_reader :observer
+  end
+
+  #
+  # Add a observer to a class.
+  # 
+  # @example
+  #   add_observer(:group) { puts "Hello!" }
+  #
+  # @param [#to_sym] group
+  #   The name of a group that an observer belongs to.
+  #   
+  # @param [#call] observer
+  #   Any object that can respond to call.
+  #
+  # @return [void]
+  #
+  def add_observer group, observer=nil, &block
+    if block_given?
+      observers << Observe.observer.new(group.to_sym, block)
+    elsif observer
+      observers << Observe.observer.new(group.to_sym, observer) 
+    else
+      raise ArgumentError, "A block or object is expected, but none given." 
+    end
+  end
+  private :add_observer
+
+  #
+  # Notify a observer.
+  # 
+  # @example
+  #   notify_observers :group
+  #
+  # @param [#to_sym] group
+  #   The name of a group
+  #   
+  # @return [void]
+  #
+  def notify_observers group, *args
+    observers.each do |observer|
+      if observer.group == group.to_sym 
+        observer.object.call(*args)
+      end
+    end
+  end
+  private :notify_observers
+
+  #
+  # Destroy a observer.
+  #
+  # @example
+  #   destroy_observers :group
+  #
+  # @param [#to_sym] group
+  #   The name of a group.
+  #   Without this argument, all observers are destroyed.
+  #
+  # @return [void]
+  #
+  def destroy_observers group=nil
+    if group.nil?
+      observers.clear
+    else
+      observers.delete_if do |observer|
+        observer.group == group.to_sym
+      end
+    end
+  end
+  private :destroy_observers
+
+  def observers
+    @observers = @observers || []
+  end
+  private :observers
+
+end

data/observe.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = "observe"
+  s.version     = "0.1.0"
+  s.authors     = ["Rob Gleeson"]
+  s.email       = ["rob@flowof.info"]
+  s.homepage    = "https://github.com/robgleeson/observe"
+  s.summary     = "A simple interface for adding observers to any class."
+  s.description = s.summary
+
+  s.rubyforge_project = "observe"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "minitest", "~> 2.5"
+  s.add_development_dependency "rake"    , "~> 0.9.2"
+end

data/test/observe_test.rb

@@ -0,0 +1,85 @@
+require File.expand_path("setup.rb", File.dirname(__FILE__))
+
+describe Observe do
+
+  context 'add_observers' do
+    before do
+      klass = Class.new do
+        include Observe
+
+        public :add_observer
+        public :observers
+      end
+
+      @subject = klass.new
+    end
+
+    it "must add a observer." do
+      @subject.add_observer(:group) { }
+      @subject.observers.size.must_equal(1)
+    end
+
+    it "must add two observers to the same group." do
+      @subject.add_observer(:group)  { }
+      @subject.add_observer(:group)  { }
+      @subject.add_observer(:fail) { }
+
+      @subject.observers.select { |o| o.group == :group }.size.must_equal(2)
+    end
+
+    it 'must raise an ArgumentError if no block or object is given.' do
+      proc { @subject.add_observer(:group) }.must_raise(ArgumentError)
+    end
+  end
+
+  context 'notify_observers' do
+    before do
+      klass = Class.new do
+        include Observe
+        attr_reader :notified
+
+        def initialize
+          add_observer(:group) { @notified = true }
+        end
+
+        def notify!
+          notify_observers(:group)
+        end
+      end
+
+      @subject = klass.new
+    end
+
+    it 'must notify observers.' do
+      @subject.notify!
+      @subject.notified.must_equal(true)
+    end
+  end
+
+  context 'destroy_observers' do
+    before do
+      klass = Class.new do
+        include Observe
+
+        def initialize
+          add_observer(:group) { }
+        end
+
+        def destroy!
+          destroy_observers(:group)
+        end
+
+        public :observers
+      end
+
+      @subject = klass.new
+    end
+
+    it 'must destroy all observers.' do
+      @subject.destroy!
+      @subject.observers.must_be_empty
+    end
+  end
+
+end
+

data/test/setup.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+require 'observe'
+require 'minitest/spec'
+require 'minitest/autorun'
+
+alias :context :describe

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: observe
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Rob Gleeson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70221281267820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: *70221281267820
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70221281267300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70221281267300
+description: A simple interface for adding observers to any class.
+email:
+- rob@flowof.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- .yardopts
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/observe.rb
+- observe.gemspec
+- test/observe_test.rb
+- test/setup.rb
+homepage: https://github.com/robgleeson/observe
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3874655113757391792
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3874655113757391792
+requirements: []
+rubyforge_project: observe
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A simple interface for adding observers to any class.
+test_files:
+- test/observe_test.rb
+- test/setup.rb