beholders 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9c40da88f21b467f2c08f4b42f5263cc139f124
+  data.tar.gz: 760eccd15ce7a1629d47fa24a10a2d209a374122
+SHA512:
+  metadata.gz: 02f47a0450a1cbfb80c69fbc40521ba4e3382392e2686c7e0b5aa74aa0fed90cde467e4827f471752243b5aebdc356ba3bf96b68fb2758e70a83e6e309a772ed
+  data.tar.gz: f7bd366e5f947c575eae87cba5977cc099979cac3e3cb2c91d7ec7f72193d6001ef3ea2debc8492ec45330fdbe7309bbbd8e559940795c66d0bd2e415a0f0a2f

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2
+  - 2.3
+  - 2.4
+gemfile:
+  - gemfiles/rails_4_0.gemfile
+  - gemfiles/rails_4_2.gemfile
+  - gemfiles/rails_5_0.gemfile
+  - Gemfile
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jfarey@yozu.co.uk. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in beholders.gemspec
+gemspec
+
+gem 'rails', "~> 5.1"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 John Farey
+
+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,115 @@
+[![Build Status](https://travis-ci.org/Bogadon/beholders.svg?branch=master)](https://travis-ci.org/Bogadon/beholders) [![Maintainability](https://api.codeclimate.com/v1/badges/68dc74886f0f54f3be5e/maintainability)](https://codeclimate.com/github/Bogadon/beholders/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/68dc74886f0f54f3be5e/test_coverage)](https://codeclimate.com/github/Bogadon/beholders/test_coverage)
+
+# Beholders
+
+A lightweight implementation of the [observer pattern] for rails active record models.
+
+Originally developed as an alternative to [rails-observers] with the goal of:
+- Better support for current versions of rails.
+- Encourage the [single responsibility principle] in design- beholders are explicitly added by name to a model, rather than inferred based on its name. This lets you have multiple observers each named for their specific domain.
+
+Supports rails 4.0+ (tested up to 5.1).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'beholders'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install beholders
+
+## Usage
+
+Getting started example:
+
+```ruby
+# Observers are added to a model like:
+class Train < ApplicationRecord
+  observed_by "TimelineManager"
+  observed_by "PlatformAnnouncer"
+  observed_by "Planner::RisksCacher"
+end
+
+# Your observers inherit from Beholder
+class TimelineManager < Beholder
+  # Define public methods for each callback hook you want to trigger on
+  # They should accept 1 arg, the instance of an observed model
+  def after_create_commit(subject)
+    TimelineEntry.create!(subject: subject)
+  end
+end
+
+class PlatformAnnouncer < Beholder
+  def after_update_commit(subject)
+    return unless subject.previous_changes.include? :arrival_time
+    # broadcast an event to your action cable channel
+  end
+end
+
+```
+
+ActiveRecord::Base class methods:
+
+Class names are passed as a string to prevent redundant autoloading.
+```ruby
+observed_by "BeholderClassName"
+```
+
+Callback hooks:
+
+Define as public methods with a single argument (model instance) in your beholders to trigger during that callback stage of the model.
+```ruby
+after_save
+after_create
+after_update
+after_destroy
+
+after_commit
+after_create_commit
+after_update_commit
+after_destroy_commit
+```
+
+Beholders are enabled by default and can be disabled/enabled individually and globally, which is probably most useful for test isolation. The following class methods are available:
+
+```ruby
+class MyBeholder < Beholder; end
+
+MyBeholder.disable!  # disable MyBeholder
+MyBeholder.disabled? # true
+MyBeholder.enable!   # enable MyBeholder
+MyBeholder.disabled? # false
+
+Beholder.disable_all! # disable Beholder and all descendant classes
+Beholder.enable_all!  # enable Beholder and all descendant classes
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Bogadon/beholders. 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).
+
+## Code of Conduct
+
+Everyone interacting in the Beholders project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Bogadon/beholders/blob/master/CODE_OF_CONDUCT.md).
+
+[observer pattern]: https://en.wikipedia.org/wiki/Observer_pattern
+[rails-observers]: https://github.com/rails/rails-observers
+[single responsibility principle]: https://en.wikipedia.org/wiki/Single_responsibility_principle

data/Rakefile

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

data/beholders.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "beholders/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "beholders"
+  spec.version       = Beholders::VERSION
+  spec.authors       = ["John Farey"]
+  spec.email         = ["jfarey@yozu.co.uk", "kazimierzz@gmail.com"]
+
+  spec.summary       = %q{Lightweight SRP encouraging observers for rails}
+  spec.description   = %q{Add single responsibility observers to your rails models}
+  spec.homepage      = "https://www.github.com/Bogadon"
+  spec.license       = "MIT"
+
+  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_dependency "activerecord", ">= 3"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_development_dependency "simplecov"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "beholders"
+
+# 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/gemfiles/rails_4_0.gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem 'rails', "~> 4.0"
+
+# Specify your gem's dependencies in beholders.gemspec
+gemspec path: "../"
+

data/gemfiles/rails_4_2.gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem 'rails', "~> 4.2"
+
+# Specify your gem's dependencies in beholders.gemspec
+gemspec path: "../"
+

data/gemfiles/rails_5_0.gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem 'rails', "~> 5.0"
+
+# Specify your gem's dependencies in beholders.gemspec
+gemspec path: "../"
+

data/lib/beholders.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "beholders/version"
+
+require "beholders/railtie"
+
+require "beholders/beholder"

data/lib/beholders/beholder.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+class Beholder
+
+  def self.inherited(subclass)
+    super
+    subclass.disabled = subclass.superclass.disabled?
+  end
+
+  def self.disable!
+    @disabled = true
+  end
+
+  def self.enable!
+    @disabled = false
+  end
+
+  def self.disabled?
+    @disabled
+  end
+
+  def self.disabled=(value)
+    @disabled = value
+  end
+
+  def self.self_and_descendants
+    [self] + descendants
+  end
+
+  def self.enable_all!
+    self_and_descendants.each(&:enable!)
+  end
+
+  def self.disable_all!
+    self_and_descendants.each(&:disable!)
+  end
+
+  def self.trigger(action, model)
+    return if disabled?
+    new.public_send(action, model) if method_defined? action
+  end
+
+end
+

data/lib/beholders/callback_hooks.rb

@@ -0,0 +1,41 @@
+module Beholders
+  module CallbackHooks
+    BEHOLDER_CB_RAILS_3 = %i[
+      after_save
+      after_create
+      after_update
+      after_destroy
+      after_commit
+    ].freeze
+
+    BEHOLDER_CB_RAILS_5 = [
+      *BEHOLDER_CB_RAILS_3,
+      :after_create_commit,
+      :after_update_commit,
+      :after_destroy_commit
+    ].freeze
+
+    # Pass class name as string not class, for same reason rails 5.1 deprecates
+    # the latter:
+    # https://github.com/rails/rails/blob/5-1-stable/activerecord/CHANGELOG.md
+    def observed_by(observer)
+      instance_eval do
+        available_callbacks(self).each do |cb|
+          send cb, -> { observer.constantize.trigger(cb, self) }
+        end
+      end
+    end
+
+    private
+
+    def available_callbacks(klass)
+      if klass.respond_to?(:after_create_commit)
+        BEHOLDER_CB_RAILS_5
+      else
+        BEHOLDER_CB_RAILS_3
+      end
+    end
+
+  end
+end
+

data/lib/beholders/railtie.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+require 'beholders/callback_hooks'
+
+module Beholders
+
+  class Railtie < Rails::Railtie
+    initializer 'beholders.add_to_active_record' do
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.send(:extend, CallbackHooks)
+      end
+    end
+  end
+
+end

data/lib/beholders/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Beholders
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: beholders
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- John Farey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: sqlite3
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Add single responsibility observers to your rails models
+email:
+- jfarey@yozu.co.uk
+- kazimierzz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- beholders.gemspec
+- bin/console
+- bin/setup
+- gemfiles/rails_4_0.gemfile
+- gemfiles/rails_4_2.gemfile
+- gemfiles/rails_5_0.gemfile
+- lib/beholders.rb
+- lib/beholders/beholder.rb
+- lib/beholders/callback_hooks.rb
+- lib/beholders/railtie.rb
+- lib/beholders/version.rb
+homepage: https://www.github.com/Bogadon
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Lightweight SRP encouraging observers for rails
+test_files: []