state-notifier 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e931e03a15112ee3a7b45ce3375dfeff90a3c9eb
+  data.tar.gz: 47cd597c6dc61ffe65ca1d0d20918e2dbd5f83f4
+SHA512:
+  metadata.gz: 4cf56313b6d07339a654f413ab672c8b27c413a669f87b998e1534b1657980b973b5bad8642594bb22bc4b041e264b9972558a37d3f857963c7ea282b8ab6e95
+  data.tar.gz: ca07eefdab07244721a0abff9b515e0abf6a18bd90ed4df59914a8a113305b30ee840a5fe37ac64a419ed3dd77acc3efb58850c9fcf5cabd2e7cda8567f1e319

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Vitaly Kushner
+
+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,66 @@
+# State::Notifier
+
+TODO: Simple gem to notify 'subscribers' about record state changes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'state-notifier'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install state-notifier
+
+## Usage
+
+    class Event
+      belongs_to :provider, ...
+      has_many :participants, ...
+
+      include StateNotifier
+      notification_targets :provider, :participants
+
+      state_machine do
+        ...
+        state :canceled
+
+        event :cancel do
+          transition all => :canceled
+        end
+      end
+
+      def foo
+        notify_targets :foo
+      end
+    end
+
+    class User
+      def event_created
+        # called for provider when event created (no participants yet)
+      end
+
+      def event_foo
+        # custom event
+      end
+
+      def event_cancel
+        # called on event 'cancel'
+      end
+
+      def event_canceled
+        # called when transitioning into 'canceled' state.
+      end
+    end
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/state_notifier.rb

@@ -0,0 +1,46 @@
+require "state_notifier/version"
+
+module StateNotifier
+  extend ActiveSupport::Concern
+
+  def notify_targets(event)
+    name = self.class.name.underscore
+    method = [name, event] * '_'
+
+    targets = self.class.notification_targets.map {|m| send(m)}.flatten
+    Rails.logger.debug "StateNotifier: notifying #{method}, #{targets.size} targets"
+
+    targets.each do |t|
+      t.send(method, self) if t.respond_to?(method)
+    end
+  end
+
+  def notify_transition(transition)
+    notify_targets transition.event
+    notify_targets transition.to unless transition.to == transition.from
+  end
+
+  included do
+    after_create {notify_targets :created}
+    after_update {notify_targets :updated  unless (changed - self.class.reserved_attributes).empty?}
+    if respond_to?(:state_machine)
+      state_machine do
+        after_transition { |record, transition| record.notify_transition transition }
+      end
+    end
+  end
+
+  module ClassMethods
+    def notification_targets(*values)
+      if values.present?
+        @notification_targets = values
+      else
+        @notification_targets
+      end
+    end
+
+    def reserved_attributes
+      %w[created_at updated_at state]
+    end
+  end
+end

data/lib/state_notifier/version.rb

@@ -0,0 +1,3 @@
+module StateNotifier
+  VERSION = "0.0.1"
+end

data/state-notifier.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'state_notifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "state-notifier"
+  spec.version       = StateNotifier::VERSION
+  spec.authors       = ["Vitaly Kushner"]
+  spec.email         = ["vitaly@astrails.com"]
+  spec.description   = %q{Simple gem to notify 'subscribers' about record state changes.}
+  spec.summary       = %q{Simple gem to notify 'subscribers' about record state changes.}
+  spec.homepage      = "https://github.com/vitaly/state-notifier"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "activesupport"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: state-notifier
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vitaly Kushner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple gem to notify 'subscribers' about record state changes.
+email:
+- vitaly@astrails.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/state_notifier.rb
+- lib/state_notifier/version.rb
+- state-notifier.gemspec
+homepage: https://github.com/vitaly/state-notifier
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Simple gem to notify 'subscribers' about record state changes.
+test_files: []