simple_listener 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 519777b538e5a4342b750ea8592f96a9d16d5387
+  data.tar.gz: 07b821e3bcabab68ed884912f345b8b22b187d6e
+SHA512:
+  metadata.gz: 8915c43daf253069511cf7ac0da35c8893c862f744752de2fc69bb37941317b6408ee09251707725d5feb86a30a0673a999e4948a96c1941825df609c9dd1042
+  data.tar.gz: efc8a925c773336c6179661a427a96425735b8544a3a513ae5f16e2e0c24c41f3d8448c484793ae382c9739240d9189d7fa400935f4d62b41e990d9b9db81d86

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-version
+.ruby-gemset

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Tomas Valent
+
+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 @@
+# SimpleListener
+
+Simplest most light-weight possible implementation of Listener / Observer.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_listener'
+
+And then execute:
+
+    $ bundle
+
+## Plain Ruby usage:
+
+```
+class Book
+  attr_accessor :author_name
+
+  def save
+    call_listeners(:before_create)
+    # ... + do some database stuff
+  end
+end
+
+class AssignAuthorListener
+  def initialize(user)
+    @user = user
+  end
+
+  def before_create(resource)
+    resource.author_name = user.name
+  end
+end
+
+require 'ostruct'
+class DummyController
+  def create
+    @book = Book.new
+    @book.add_listener(AssignAuthorListener.new(current_user))
+    @book.save
+
+    # @book.author_name # => Tomas
+  end
+
+  def current_user
+    OpenStruct.new(name: "Tomas")
+  end
+end
+```
+
+## Ruby on Rails usage
+
+
+since Rails 3.something you have the option to do `around_save`.
+
+```
+class Book < ActiveRecord::Base
+  around_save :notify_listeners
+
+  def notify_listeners
+    is_create_save   = !persisted?
+    if is_create_save
+      call_listeners(:before_create)
+    else
+      call_listeners(:before_update)
+    end
+
+    yield # will do the actual saving to DB ...call :save
+
+    if is_create_save
+      call_listeners(:on_create)
+    else
+      call_listeners(:on_update)
+    end
+  end
+end
+```
+
+## Credit
+
+Idea for this gem is based on pattern shown in Avdi Grimm Ruby Tapas episode #031 Observer Variations
+
+All hail Avdi !!!
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/simple_listener/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/lib/simple_listener.rb

@@ -0,0 +1,15 @@
+require "simple_listener/version"
+
+module SimpleListener
+  def add_listener(listener)
+    (@listeners ||= []) << listener
+  end
+
+  def call_listeners(event_name, *args)
+    @listeners && @listeners.each do |listener|
+      if listener.respond_to?(event_name)
+        listener.public_send(event_name, self, *args)
+      end
+    end
+  end
+end

data/lib/simple_listener/version.rb

@@ -0,0 +1,3 @@
+module SimpleListener
+  VERSION = "1.0.0"
+end

data/simple_listener.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_listener/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_listener"
+  spec.version       = SimpleListener::VERSION
+  spec.authors       = ["Tomas Valent"]
+  spec.email         = ["equivalent@eq8.eu"]
+  spec.summary       = %q{Ruby listener/observer lib}
+  spec.description   = %q{simplest possible Ruby listener lib}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6"
+  spec.add_development_dependency "rake"
+end

data/test/listener_test.rb

@@ -0,0 +1,53 @@
+require "minitest/autorun"
+require 'simple_listener'
+
+class Book
+  include SimpleListener
+
+  attr_accessor :author,:persisted
+
+  def save
+    call_listeners(:before_create)
+    call_listeners(:before_update) # just to demonstrate Rails save
+    self.persisted = true
+    call_listeners(:after_create)  # just to demonstrate Rails save
+    call_listeners(:after_update)  # just to demonstrate Rails save
+  end
+end
+
+class AssignAuthorListener
+  attr_reader :user
+
+  def initialize(user)
+    @user = user
+  end
+
+  def before_create(book)
+    book.author = user
+  end
+end
+
+describe Book do
+  before do
+    @book = Book.new
+  end
+
+  describe "when called without listeners" do
+    it "must not set any values" do
+      @book.save
+      @book.author.must_be_nil
+    end
+  end
+
+  describe "when called with listener" do
+    before do
+      @current_user = Object.new
+      @book.add_listener(AssignAuthorListener.new(@current_user))
+    end
+
+    it 'must set attributes related to that listener' do
+      @book.save
+      @book.author.must_equal @current_user
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: simple_listener
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tomas Valent
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: simplest possible Ruby listener lib
+email:
+- equivalent@eq8.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_listener.rb
+- lib/simple_listener/version.rb
+- simple_listener.gemspec
+- test/listener_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.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby listener/observer lib
+test_files:
+- test/listener_test.rb