homie 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 02a83ffb1ca07691cc5e4563232c6b7fcf2b37301b6d25e49802da9d00a05e53
+  data.tar.gz: e38bc97637559253ed94e228bfd24b107e597f1b5be4c21ebac65752bb157eb7
+SHA512:
+  metadata.gz: 4d1eb81b22defd2e978d9c52e9f228b230859fd8e4451c746052f495bc7070644c3d1fb6c90f39705349b08931631cba9bdc75cf8ebe631ad04fd7a903705405
+  data.tar.gz: 6683f0fe3467c0cbedd4b81a186bb3764406e38bef3628b6bbf670c9b62c64fb8f5a09f7e13b917994bde1a7217951e629c09da83e7d79b8327635a61251a161

data/.gitignore

@@ -0,0 +1,14 @@
+.idea*
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.5

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in homie.gemspec
+gemspec
+
+gem 'homie', git: 'git://github.com/donasktello/homie.git'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 donasktello
+
+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,127 @@
+# Homie
+
+Welcome!
+
+Those of you who know why and when we need the Observer pattern  will definitely find this gem useful. Those of you who don't, should read about the Observer pattern and return here afterward.
+
+Ruby has a default module called Observable that reflect same idea but doesn't have such flexibility as Homie. 
+
+Homie will do the dirty work for you. It will call and execute all required logic sequentially. All you need is to:
+
+- consider Homie syntax
+- decompose the logic into the `subject` and `observers` bound to particular events
+- broadcast those events when they happen
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'homie'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install homie
+
+## Usage
+### About
+To implement Observer pattern and start using Homie first you should decompose logic into 2 object types:
+* `Subject` - the main part of logic, depending on the results of which the further part of logic should vary between scenarios.
+* `Observer` - those scenarios that will be executed depending on the Subject result.
+
+### Include into your `Subject` Homie module
+
+```ruby
+  include Homie
+```
+### Subscribing
+
+Bind `Observers` to your `Subject` on particular events. As an `Observer` it could be any object with a *call* method(that is an entry point for business logic) **OR** a block of code.
+
+To bind Observer use method `on(event_name, Observer)`.
+
+You have 2 options, how you could bind your observers:
+
+* When you want to incapsulate those observers.
+```ruby
+class UserCreator
+  include Homie
+
+  def initialize(params)
+    @params = params
+    
+    self.on(:succeeded, StatistictsGenerator.new)
+    self.on(:succeeded) { |user| EmailPublisher.send_email(user) }
+  end
+end
+```
+
+*Your observers should repeat signature of params passing by Subject in their method call or in a block of code.*
+
+* When incapsulation don't bother you **OR** you need to apply a closure for some context/method execution.
+
+```ruby
+class UsersController < ApplicationController
+  def create
+    UserCreator.new(params).
+      on(:succeeded) do |user|
+        render json: user, status: 201
+      end.
+      on(:failed) do |user|
+        render json: user.errors, status: 422
+      end.call
+  end
+end
+``` 
+
+*Subscribing supports chaining*.
+
+### Broadcasting
+To broadcast an event use method `broadcast(event_name, *arguments)`.
+*Broadcasting also support chaining.*
+
+```ruby
+class UserCreator
+  include Homie
+  
+  def initialize(params)
+    @params = params
+  end
+
+  def call
+    user = User.create!(@params)
+    broadcast :succeeded, user 
+  rescue ActiveRecord::RecordInvalid => invalid
+    broadcast :failed, invalid.record
+  end
+end
+```
+
+*You can incapsulate broadcasting of events or make public method calls as well.*
+
+I support the theory that says that two events are usually enough: **succeeded** or **failed**. 
+
+I have made shortcuts for these cases. 
+
+So 
+
+`broadcast :succeeded, user` is equal to `succeeded(user)`
+
+**and** 
+
+`broadcast :failed, user` is equal to `failed(user)`.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/donasktello/homie. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "homie"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/homie.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'homie/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "homie"
+  spec.version       = Homie::VERSION
+  spec.authors       = ["Viacheslav Shvetsov"]
+  spec.email         = ["shvetsov1988@gmail.com"]
+
+  spec.summary       = %q{Implementation of Observer pattern with using objects or code blocks.}
+  spec.description   = %q{Implementation of Observer pattern.}
+  spec.license       = "MIT"
+  spec.homepage       = "https://github.com/donasktello/homie"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/homie/version.rb

@@ -0,0 +1,3 @@
+module Homie
+  VERSION = '0.1.1'
+end

data/lib/homie.rb

@@ -0,0 +1,48 @@
+require "homie/version"
+
+module Homie
+  class ObserverNotPassedError < StandardError
+    MSG = 'You should pass at least one or more objects with method call OR block.'
+
+    def message; MSG end;
+  end
+
+  class EventNotSpecifiedError < StandardError
+    MSG = 'You should specify event name.'
+
+    def message; MSG end;
+  end
+
+  def on(event, *objects, &block)
+    raise(Homie::EventNotSpecifiedError) unless event && !event.empty?
+
+    raise(Homie::ObserverNotPassedError) unless objects.all? { |object|  object.respond_to?(:call) }
+
+    raise(Homie::ObserverNotPassedError) if (_observers = [*objects, block].compact).size == 0
+
+    observers[event] += _observers
+
+    self
+  end
+
+  def broadcast(event, *args)
+    observers[event].each { |observer| observer.call(*args) }
+
+    self
+  end
+
+  def succeeded(*args)
+    broadcast(:succeeded, *args)
+  end
+
+  def failed(*args)
+    broadcast(:failed, *args)
+  end
+
+  private
+
+  def observers
+    @observers ||= Hash.new { |hash, event| hash[event] = [] }
+  end
+end
+

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: homie
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Viacheslav Shvetsov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Implementation of Observer pattern.
+email:
+- shvetsov1988@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- homie.gemspec
+- lib/homie.rb
+- lib/homie/version.rb
+homepage: https://github.com/donasktello/homie
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Implementation of Observer pattern with using objects or code blocks.
+test_files: []