lorikeet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 850cc78e4587fbdd4ccea67ea78e1012bd2db6ec
+  data.tar.gz: 7339a55d2000abccbd90361f3ccef332a88de2ed
+SHA512:
+  metadata.gz: 3f28f4f72b3170388482eff31b66e0744cc69e925500edf4b2801426f1a314e6435247e4e311a7ade3c5b54c395f28492433dbe4010958fe899301a9de4c5b48
+  data.tar.gz: 047ce50587497a2ec3d094998e766d2a6ec8c076dc3c582d3484b6a85a2c7059e42521afaa93fa2b4256edb68e2eae27fc2c54a8b1f49d5da15cdc460ffc58b1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Steven Weiss
+
+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,25 @@
+Lorikeet
+========
+
+Lorikeet is a tiny library for implementing the observer pattern.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lorikeet'
+```
+
+And then you can install Lorikeet with bundler with via:
+
+    $ bundle
+
+Or without bundler:
+
+    $ gem install lorikeet
+
+For RubyMotion, you must also require the gem inside your Gemfile:
+
+    $ require 'lorikeet'

data/Rakefile

@@ -0,0 +1,5 @@
+task :spec do
+  Dir.glob('./spec/**/*_spec.rb').each { |file| require file }
+end
+
+task default: :spec

data/lib/lorikeet.rb

@@ -0,0 +1,50 @@
+module Lorikeet
+  class Observable
+    def initialize(context, observers = [])
+      @context   = context
+      @observers = observers
+    end
+
+    def include?(observer)
+      observers.include?(observer)
+    end
+
+    def <<(observer)
+      observers << observer unless observers.include?(observer)
+    end
+
+    def delete(observer)
+      observers.delete(observer)
+    end
+
+    def action
+      yield(context)
+
+      observers.each { |o| o.send(o.callback_id, context) }
+    end
+
+    private
+
+    attr_reader :context, :observers
+  end
+
+  module Observer
+    DEFAULT_CALLBACK_ID = :callback
+
+    def observe(observable, callback_id = nil)
+      if callback_id
+        self.callback_id = callback_id
+      end
+
+      observable << self
+    end
+
+    def callback_id
+      @callback_id ||= DEFAULT_CALLBACK_ID
+    end
+
+    def callback_id=(sym)
+      @callback_id = sym
+    end
+  end
+end

data/lib/lorikeet/version.rb

@@ -0,0 +1,3 @@
+module Lorikeet
+  VERSION = '0.1.0'.freeze
+end

data/lorikeet.gemspec

@@ -0,0 +1,12 @@
+require_relative './lib/lorikeet/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'lorikeet'
+  s.summary  = 'Lorikeet'
+  s.version  = Lorikeet::VERSION
+  s.authors  = ['Steve Weiss']
+  s.email    = ['weissst@mail.gvsu.edu']
+  s.homepage = 'https://github.com/sirscriptalot/lorikeet'
+  s.license  = 'MIT'
+  s.files    = `git ls-files`.split("\n")
+end

data/spec/lorikeet_spec.rb

@@ -0,0 +1,118 @@
+require          'minitest/autorun'
+require_relative '../lib/lorikeet'
+
+class Counter
+  attr_reader :count
+
+  def initialize(count = 0)
+    @count = 0
+  end
+
+  def increment
+    @count += 1
+  end
+
+  def decrement
+    @count -= 1
+  end
+end
+
+class Observer
+  include Lorikeet::Observer
+
+  attr_reader :received
+
+  def callback(context)
+    @received = context
+  end
+end
+
+describe 'Lorikeet::Observable' do
+  before do
+    @observable = Lorikeet::Observable.new(Counter.new)
+    @observer   = Observer.new
+  end
+
+  describe '#include?' do
+    it 'returns bool for if observer is in observers' do
+      refute @observable.include?(@observer)
+
+      @observable.instance_variable_set(:@observers, [@observer])
+
+      assert @observable.include?(@observer)
+    end
+  end
+
+  describe '#<<' do
+    it 'adds the observer if it does not exist' do
+      refute @observable.include?(@observer)
+
+      @observable << @observer
+
+      assert @observable.include?(@observer)
+    end
+  end
+
+  describe '#delete' do
+    it 'removes the observer from observers' do
+      @observable << @observer
+
+      assert @observable.include?(@observer)
+
+      @observable.delete(@observer)
+
+      refute @observable.include?(@observer)
+    end
+  end
+
+  describe '#action' do
+    before do
+      @observer.observe(@observable)
+
+      @observable.action do |context|
+        @context = context
+      end
+    end
+
+    it 'passes context to the given block' do
+      assert @context == @observable.instance_variable_get(:@context)
+    end
+
+    it 'passes context to observer callbacks' do
+      assert @observer.received == @observable.instance_variable_get(:@context)
+    end
+  end
+end
+
+describe 'Lorikeet::Observer' do
+  before do
+    @observable = Lorikeet::Observable.new(Counter.new)
+    @observer   = Observer.new
+  end
+
+  describe '#observe' do
+    it 'adds self to the observable\'s observers' do
+      @observer.observe @observable
+
+      assert @observable.include?(@observer)
+    end
+
+    it 'sets the callback_id if provided' do
+      @observer.observe @observable
+
+      assert @observer.callback_id == Lorikeet::Observer::DEFAULT_CALLBACK_ID
+
+      @observer.observe @observable, :custom_callback_id
+
+      assert @observer.callback_id == :custom_callback_id
+    end
+  end
+
+  describe '#callback_id' do
+    it 'returns DEFAULT_CALLBACK_ID when nil' do
+      @observer.instance_variable_set(:@callback_id, nil)
+
+      assert @observer.callback_id == Lorikeet::Observer::DEFAULT_CALLBACK_ID
+    end
+  end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: lorikeet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steve Weiss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-07 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- weissst@mail.gvsu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lorikeet.rb
+- lib/lorikeet/version.rb
+- lorikeet.gemspec
+- spec/lorikeet_spec.rb
+homepage: https://github.com/sirscriptalot/lorikeet
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Lorikeet
+test_files: []