bottled_observers 0.1.0.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a32f5a4c6ac1a64683f4b80e60a69a7536d3584
+  data.tar.gz: 338109d77dd2f7eeffbfc3295e6d271c16f68524
+SHA512:
+  metadata.gz: b75f44850891b606243876455843af74217cd09662fd8157f72f6af1d3ef5e3f18a824138f924b6ecc1551076494b4fcef13231a00372019b96df5ea1a4547ea
+  data.tar.gz: ffa4db46b39e685ae4e579b08594f86e227b67f67c17d615daeec33061917ea3fecd24d1a9468ee070058a7e77080a9a834f846d94289110549b570acae6429a

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.15.0.pre.3

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 john.hayes.reed@gmail.com. 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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bottled_observers.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 John Hayes-Reed
+
+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,43 @@
+# BottledObservers
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bottled_observers`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bottled_observers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bottled_observers
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/bottled_observers. 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 BottledObservers project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/bottled_observers/blob/master/CODE_OF_CONDUCT.md).

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 "bottled_observers"
+
+# 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/bottled_observers.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bottled_observers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bottled_observers'
+  spec.version       = BottledObservers::VERSION
+  spec.authors       = ['John Hayes-Reed']
+  spec.email         = ['john.hayes.reed@gmail.com']
+
+  spec.summary       = 'A Rails compatible Observer pattern solution made to '\
+                       'make your life easy.'
+  spec.description   = 'This Gem provides two interfaces, one to make items '\
+                       'observable, and another to easily create classes to '\
+                       'observe them.'
+  spec.homepage      = 'https://github.com/John-Hayes-Reed/bottled_observers'
+  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_development_dependency 'bundler', '~> 1.15.a'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/bottled_observers.rb

@@ -0,0 +1,6 @@
+require 'bottled_observers/version'
+require 'bottled_observers/bottled_observer'
+require 'bottled_observers/bottled_observable'
+require 'bottled_observers/bottled_observer_errors'
+# @abstract Main Parent module for bottled_observers gem.
+module BottledObservers; end

data/lib/bottled_observers/bottled_observable.rb

@@ -0,0 +1,85 @@
+# @abstract A module to make any instance observable by a BottledObserver.
+module BottledObservable
+  # Gives a list of the instances current subscriptions.
+  #
+  # @example
+  #   @model_a.subscriptions
+  #   #=> []
+  #
+  #   @model_b.subscriptions
+  #   # => [#<LastUpdatedAtObserver:0x00...>]
+  #
+  # @return [Array]
+  def subscriptions
+    @subscriptions ||= []
+  end
+
+  # Adds an observer to the instances subscription list.
+  #
+  # @param observer [BottledObserver] The observer to be added to the list.
+  # @param args [Hash] Additional Arguments to be passed to the observer.
+  #
+  # @example
+  #   @model.add_subscription(LastUpdatedAtObserver)
+  #
+  # @return [void]
+  def add_subscription(observer, **args)
+    subscriptions << observer.new(self, args.merge({method_source: __method__}))
+  end
+
+  # Removes an observer from the instances subscriptions list.
+  #
+  # @param observer [BottledObserver] The observer class to remove.
+  #
+  # @example
+  #   @model.remove_subscription(LastUpdatedAtObserver)
+  #
+  # @return [void]
+  def remove_subscription(observer)
+    puts observer
+    subscriptions.delete_if { |ob| ob.class == observer }
+  end
+
+  # Removes all current subscriptions.
+  #
+  # @example
+  #   @model.remove_subscriptions
+  # @return [void]
+  def remove_subscriptions
+    puts 'entered'
+    subscriptions.map(&:class).each(&method(:remove_subscription))
+  end
+
+  # Calls the update method of all subscriptions and returns the modified state
+  #   back to false.
+  #
+  # @return [void]
+  def publish
+    subscriptions.each(&:call) if publishable?
+    modified false
+  end
+
+  # Changes the observable state of the instance.
+  #
+  # @param state [true, false] Defaults to true.
+  # @param _opts [Hash]
+  # @options opts [Symbol] :subscription
+  #
+  # @return [void]
+  def modified(state = true, **_opts)
+    raise TypeError unless state == true || state == false
+    @observable_state = state
+  end
+
+  # Gives the instance's current observable state.
+  #
+  # @example
+  #   @model.publishable? #=> false
+  #   @model.modified
+  #   @model.publishable? #=> true
+  #
+  # @return [true, false]
+  def publishable?
+    @observable_state ||= false
+  end
+end

data/lib/bottled_observers/bottled_observer.rb

@@ -0,0 +1,40 @@
+# @abstract A module that turns a class into an Observer Object.
+module BottledObserver
+  # Initializes a new Observer and starts observing a subscription.
+  #
+  # @param subscription [*] The instance that the observer watches.
+  # @param options [Hash] Any options an observer instance may need.
+  #
+  # @example
+  #   LastUpdatedAtObserver.new(@model)
+  #   #=> #<LastUpdatedAtObserver:0x00...>
+  #
+  # @return [void]
+  def initialize(subscription, **options)
+    raise BottledObserverErrors::SubscriptionRequired unless subscription
+    raise BottledObserverErrors::SubscriptionObjectNotObservable unless
+      subscription.singleton_class < BottledObservable
+
+    method_source = options.delete(:method_source)
+    @subscription = subscription
+    @options = options
+
+    subscribe unless method_source =~ /add_subscription/
+  end
+
+  private
+
+  # Start observing the subscription by adding itself to the observers list.
+  #
+  # @return [void]
+  def subscribe
+    @subscription.add_subscription self.class
+  end
+
+  # Checks if the subscription state is modified or not.
+  #
+  # @return [void]
+  def modified?
+    @subscription.observable_state
+  end
+end

data/lib/bottled_observers/bottled_observer_errors.rb

@@ -0,0 +1,4 @@
+module BottledObserverErrors
+  class SubscriptionRequired < StandardError; end
+  class SubscriptionObjectNotObservable < StandardError; end
+end

data/lib/bottled_observers/version.rb

@@ -0,0 +1,3 @@
+module BottledObservers
+  VERSION = :'0.1.0.alpha.1'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: bottled_observers
+version: !ruby/object:Gem::Version
+  version: 0.1.0.alpha.1
+platform: ruby
+authors:
+- John Hayes-Reed
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.a
+- !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: This Gem provides two interfaces, one to make items observable, and another
+  to easily create classes to observe them.
+email:
+- john.hayes.reed@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bottled_observers.gemspec
+- lib/bottled_observers.rb
+- lib/bottled_observers/bottled_observable.rb
+- lib/bottled_observers/bottled_observer.rb
+- lib/bottled_observers/bottled_observer_errors.rb
+- lib/bottled_observers/version.rb
+homepage: https://github.com/John-Hayes-Reed/bottled_observers
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: A Rails compatible Observer pattern solution made to make your life easy.
+test_files: []