shout 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a91e27be479d63ef940f9f61631c9249731b23f5
+  data.tar.gz: 0b155a9e8cc93e3631b6b71f6558ad5a985892b7
+SHA512:
+  metadata.gz: 8850dbe034e3ae92442a514c495e5b10f082be4832b24f5827dcd64c4774bf8cd6c184d63567bfec87ec62bbfce6290d7f8e3eb41cd339c57e0c4f3642a1ac23
+  data.tar.gz: 8dac0aea72845cdc2e84b368ba5f86bc24a23421ccb4066d5a63ea0153ee4967122ec155c0b86b4ea3d72c6c8a5f00008a6adfc62783b041dc1755ff03fd2d67

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,7 @@
+cache: bundler
+language: ruby
+rvm: 
+- 1.9.3
+- 2.1
+- 2.1-head
+- ruby-head

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tim Snowhite
+
+MIT License
+
+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,93 @@
+# Shout
+
+A class-level observer pattern for ActiveRecord.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'shout'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shout
+
+## Usage
+
+Shout provides two mixins: Observable, and Listener.
+
+
+## Observable
+
+``` ruby
+class Snowcone < Struct.new(:state, :flavors)
+
+  # To publish events, include the Observable module.
+  include Shout::Observable
+  
+  # List the events you'll publish. This cuts down on typos in the
+  # observing classes.
+  shout_events([
+                    :empty, 
+                    :filled, 
+                    :flavored, 
+                    :purchased, 
+                    :eaten, 
+                    :thrown_away,
+                    ])
+  # List your observing classes. This ensures that callbacks run in 
+  # a deterministic order across all environments.
+  shout_observers([:Accounting])
+
+  # Then in your instances, use the #run_callbacks method
+  # to notify Listeners that an event has occurred.
+  def state!(event)
+      self.run_shout_callbacks(event)
+  end
+end
+```
+
+## Listener
+
+``` ruby
+class Accounting
+  
+  # To listen to events on other objects, include Listener.
+  include Shout::Listener
+
+  # And reference the class name you'll be observing. 
+  # You can only observe one class.
+  self.observes= :Snowcone
+
+  # Implement the initialize method with an argument for the 
+  # observed instance.
+  def initialize(snowcone)
+  end
+
+  # Set callbacks for the events you'd like to listen to.
+  shout_callback :purchased, :credit_bank_account
+  shout_callback :flavored, :mark_flavor_used
+  shout_callback :filled, :mark_ice_used
+
+  # And point them at methods in your class.
+  def credit_bank_account(cash)
+  end
+  def mark_flavor_used(flavor)
+  end
+  def mark_ice_used
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*test.rb']
+#  t.verbose = true
+end
+task :default => :test

data/examples/snowcone.rb

@@ -0,0 +1,74 @@
+require 'shout'
+BANK_ACCOUNT = {
+             :credits => [],
+             }
+INVENTORY = {
+       :banana_syrup => 1,
+       :blue_raspberry_syrup => 3,
+       :bubblegum_syrup => 5,
+       :ice => 1000,
+       }
+
+class Accounting
+  def initialize(snowcone)
+    @snowcone = snowcone
+  end
+  def credit_bank_account(cash)
+    BANK_ACCOUNT[:credits].push(cash)
+  end
+  def mark_flavor_used(flavor)
+    INVENTORY[:"#{flavor}_syrup"] -= 1
+  end
+  def mark_ice_used
+    INVENTORY[:ice] -= 1
+  end
+end
+
+class Snowcone < Struct.new(:state, :flavors)
+  include Shout::Observable
+  shout_events([
+                    :empty, 
+                    :filled, 
+                    :flavored, 
+                    :purchased, 
+                    :eaten, 
+                    :thrown_away,
+               ])
+  shout_observers([
+                   :Accounting,
+                  ])
+  def initialize
+    @state = :empty
+    @flavors = []
+  end
+  def flavor(flavor)
+    @flavors.push(flavor)
+    self.run_shout_callbacks(:flavored, flavor)
+  end
+  def state!(event)
+    self.run_shout_callbacks(event)
+    self.state = event
+  end
+  def purchase(cost)
+    self.run_shout_callbacks(:purchased, cost)
+    self.state= :purchased
+  end
+end
+
+class Accounting
+  include Shout::Listener
+  self.observes= :Snowcone
+
+  shout_callback :purchased, :credit_bank_account
+  shout_callback :flavored, :mark_flavor_used
+  shout_callback :filled, :mark_ice_used
+end
+
+class Barista
+  def self.order(*flavors)
+    s=Snowcone.new
+    s.state!(:filled)
+    flavors.map{|i| s.flavor(i)}
+    s
+  end
+end

data/lib/shout.rb

@@ -0,0 +1,23 @@
+require "shout/version"
+require 'shout/observable'
+require 'shout/listener'
+module Shout
+  module_function
+  def constantize(camel_cased_word)
+    names = camel_cased_word.split('::')
+    
+    # Trigger a builtin NameError exception including the ill-formed constant in the message.
+    Object.const_get(camel_cased_word) if names.empty?
+    
+    # Remove the first blank element in case of '::ClassName' notation.
+    names.shift if names.size > 1 && names.first.empty?
+    
+    names.inject(Object) do |constant, name|
+      if constant == Object
+        constant.const_get(name)
+      else
+        candidate = constant.const_get(name)
+      end
+    end
+  end
+end

data/lib/shout/listener.rb

@@ -0,0 +1,70 @@
+module Shout
+
+  module Listener #include me
+
+    ## Implementor Methods
+    def initialize(observed)
+      raise ArgumentError.new("Must be overriden in implementors.")
+    end
+
+    ## Internal Methods
+    def self.included(mod)
+      mod.extend(ClassMethods)
+      mod.callbacks = []
+    end
+
+    def update_with_shout_event(name, *params)
+        a=self.class.callbacks_for_event(name)
+        a.map{|meth| self.send(meth,*params) }
+    end
+
+    module ClassMethods
+      ## Implementor Methods
+
+      # Sets the class which this observer will observe. A required call.
+      def observes=(observes)
+        @observes = observes
+        valid_observable?
+        observes_class.observer_class_names_check.push(self.name.to_sym)
+      end
+      # Registers a callback which will be executed when the
+      # observes_class's instances call run_callbacks(name).
+      def shout_callback(name, method)
+        valid_event?(name)
+        callbacks.push([name,method])
+      end
+      def test_event(name, instance, *params)
+        listener = new(instance)
+        listener.update_with_shout_event(name, *params)
+      end
+
+      ## Internal Methods
+      attr_reader :observes
+      attr_accessor :callbacks
+      def observes_class
+        Shout.constantize(self.observes.to_s)
+      rescue NameError => e
+        nil
+      end
+      def valid_observable?
+        unless observes_class
+          raise ArgumentError.new("#{self}.observes = #{observes.inspect}. #{observes.inspect} can't be found as a constant.")
+        end
+        unless observes_class < ::Shout::Observable
+          raise ArgumentError.new("#{self}.observes == #{self.observes} does not inherit from ::Shout::Observable.")
+        end
+      end
+      def valid_event?(event)
+        if observes_class.events_notified_misspellings.has_key?(event)
+          raise ArgumentError.new("#{self.class}: Well well well, you've found an area of cognitive dissonance! Use #{observes_class.events_notified_misspellings[event].inspect} instead of #{event}.")
+        end
+        unless observes_class.events_notified.include?(event)
+          raise ArgumentError.new("#{self.class}: Oh lordy, this is embarassing. #{event.inspect} is totally not available in #{observes_class}.\nAvailable events:\n#{observes_class.events_notified.inspect}")
+        end
+      end
+      def callbacks_for_event(n)
+        self.callbacks.select{|name,method| name == n}.map{|name,method| method}
+      end
+    end
+  end
+end

data/lib/shout/observable.rb

@@ -0,0 +1,89 @@
+require 'observer' # stdlib
+module Shout
+  module Observable #include me
+    
+    ## ImplementorMethods
+    
+    # Really this is for clarity until everyone is cool with the implementation.
+    def self.run_callbacks(instance,event,*params)
+      instance.run_shout_callbacks(event,*params)
+    end
+    
+    def run_shout_callbacks(event, *params)
+                                      # HMMM: not sure how I feel
+      self.class.load_observers(self) # about this. See #idemp_observer.
+      self.notify_shout_observers(event, *params)
+    end
+    def notify_shout_observers(event, *params)
+      self.shout_observer_list.each do |k,i|
+        i.update_with_shout_event(event, *params)
+      end
+    end
+    
+    ## Internal Methods
+    def self.included(mod)
+      mod.send(:extend, ClassMethods)
+    end
+    
+    attr_accessor :shout_observer_list
+    
+    # This is done this way because I want to be able to #new these
+    # up at the time an event comes in, rather than using and
+    # after_initialize callback.
+    def idemp_observer(k,i)
+      self.shout_observer_list ||= []
+      return if self.shout_observer_list.assoc(k)
+      self.shout_observer_list.push([i.class, i])
+    end
+      
+  end
+  
+  module ClassMethods #extend me
+    
+    ## Implementor Methods
+    def shout_events(event_names)
+      self.events_notified += event_names.map(&:to_sym)
+    end
+    def shout_misspellings(event_misspellings)
+      self.events_notified_misspellings.merge!(event_misspellings)
+    end
+    def shout_observers(listener_classes)
+      self.observer_class_names += listener_classes
+    end
+    
+    ## Internal Methods
+    attr_accessor :observer_class_names
+    attr_accessor :observer_class_names_check
+    attr_accessor :events_notified
+    attr_accessor :events_notified_misspellings
+    def self.extended(mod)
+      mod.observer_class_names = []
+      mod.observer_class_names_check = []
+      mod.events_notified = []
+      mod.events_notified_misspellings = {}
+    end
+    def check_observer_classes
+      return if @checked
+      here_not_there = (observer_class_names - observer_class_names_check)
+      there_not_here = (observer_class_names_check - observer_class_names)
+      unless here_not_there == there_not_here
+        missing = (here_not_there + there_not_here)
+
+        meths = "#{self}.shout_observers(#{missing.map(&:inspect)}) and "+
+          missing.map{|observer|
+            "#{observer}.observes=#{self.name.to_sym.inspect}"
+          }.join(' and ')
+        
+        raise ArgumentError.new("#{self}: Please call both #{meths} to observe #{self}. This is done to ensure determinism in the load order in development, test, and production environments.")
+      end
+      @checked = true
+    end
+    def load_observers(instance)
+      check_observer_classes
+      self.observer_class_names.map{|name|
+        k = Shout.constantize(name.to_s)
+        instance.idemp_observer(k,k.new(instance))
+      }
+    end
+  end
+end

data/lib/shout/version.rb

@@ -0,0 +1,3 @@
+module Shout
+  VERSION = "0.0.1"
+end

data/shout.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shout/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shout"
+  spec.version       = Shout::VERSION
+  spec.authors       = ["Tim Snowhite"]
+  spec.email         = ["tim@snowhitesolutions.com"]
+  spec.description   = %q{A class-level observer pattern for ActiveRecord.}
+  spec.summary       = %q{Publish and subscribe to events on your models.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/test/shout_test.rb

@@ -0,0 +1,24 @@
+gem 'minitest', '~>5.0'
+require 'minitest/autorun'
+require File.expand_path('../../examples/snowcone', __FILE__)
+class ShoutTest < Minitest::Test
+  def test_example
+    snowcone = Barista.order(:blue_raspberry,:banana,:bubblegum)
+    snowcone.purchase(5.00)
+    snowcone.state!(:eaten)
+    snowcone.state!(:thrown_away)
+    assert_equal(
+                 [
+                  999, 
+                  0,
+                  [5.00],
+                 ],
+                 
+                 [
+                  INVENTORY[:ice],
+                  INVENTORY[:banana_syrup],
+                  BANK_ACCOUNT[:credits],
+                 ]
+                 )
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: shout
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tim Snowhite
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A class-level observer pattern for ActiveRecord.
+email:
+- tim@snowhitesolutions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/snowcone.rb
+- lib/shout.rb
+- lib/shout/listener.rb
+- lib/shout/observable.rb
+- lib/shout/version.rb
+- shout.gemspec
+- test/shout_test.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Publish and subscribe to events on your models.
+test_files:
+- test/shout_test.rb