shout_out 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 72b4e70e107e6a99ac9a190cc173e024305acb04
+  data.tar.gz: cef0924b356ebea3dccd0f74d1010200418c4f4e
+SHA512:
+  metadata.gz: 3311721b678fb178eebd807449d37567399f7ade73fd5ef6b6cbfb0f1e227cb38370955e99f21821cf013552d676e80ed36b3560c6dda20279e79b76f041e74e
+  data.tar.gz: 4c4336e39871b088688f900b41f1a2513fa92688069a90f978086620c9a90b2348a79642a37d3e4cbae7984350b8d97e7b30c5a1c150874f11ce761099e50eb1

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+.idea

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Kevin Pheasey
+
+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,113 @@
+# Shout Out
+
+Shout Out allows for the abstraction of complex ActiveRecord callbacks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+gem 'shout_out'
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shout_out
+
+Then run the install generator
+
+    $ rails g shout_out:install
+
+This will create ApplicationShout in /app/shouts/application_shout.rb
+
+## Usage
+
+To generate a shout class for a model, just use the generator.
+
+    $ rails g shout_out:shout My::Model::Name
+
+This will create the appropriate class in the /app/shouts directory, i.e. ```/app/shouts/my/model/name_shout.rb```.
+
+Now you can define methods for any callback.
+
+```
+before_validation
+validate
+after_validation
+before_save
+after_save
+before_create
+after_create
+after_commit
+```
+
+## Example
+
+The below is an example of using shouts to handle cache invalidation on interdependent models.
+
+```ruby
+# /app/shouts/invoice_shout.rb
+class InvoiceShout < ApplicationShout
+
+  def after_save
+    touch_project
+    touch_report_ffa_efficiency
+    touch_report_ffa_hour_tracker
+  end
+
+  private
+
+  def touch_report_ffa_efficiency
+    if record.total_ffa_changed? && calculable? && !record.report_ffa_efficiency.new_record?
+      record.report_ffa_efficiency.touch
+    end
+  end
+
+  def touch_report_ffa_hour_tracker
+    changed = record.total_ffa_changed? || work_type_changed?(WorkType.codes[:ffa])
+
+    if changed && calculable? && record.report_ffa_hour_tracker
+      record.report_ffa_hour_tracker.touch
+    end
+  end
+
+  def touch_project
+    changed = record.product_comp_changed? || record.product_cost_changed? || record.labor_comp_changed?
+
+    if changed && calculable? && record.project
+      record.project.touch
+    end
+  end
+
+end
+```
+
+
+You can define common methods in ApplicationShout.
+
+```ruby
+# /app/shouts/application_shout.rb
+class ApplicationShout
+
+  ...
+
+  def calculable?
+    record.calculable? || record.calculable_changed?
+  end
+
+  def work_type_changed?(codes)
+    codes = [codes] unless code.is_a?(Array)
+    record.work_type_code_changed? && ([record.work_type_code, record.work_type_code_was] & codes).any?
+  end
+
+end
+```
+
+## Contributing
+
+- Fork it ( https://github.com/kpheasey/shout_out/fork )
+- Create your feature branch (git checkout -b my-new-feature)
+- Commit your changes (git commit -am 'Add some feature')
+- Push to the branch (git push origin my-new-feature)
+- Create a new Pull Request

data/Rakefile

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

data/lib/generators/shout_out/install/install_generator.rb

@@ -0,0 +1,12 @@
+module ShoutOut
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_file
+        template 'application_shout.rb', 'app/shouts/application_shout.rb'
+      end
+
+    end
+  end
+end

data/lib/generators/shout_out/install/templates/application_shout.rb

@@ -0,0 +1,8 @@
+class ApplicationShout
+  attr_reader :record
+
+  def initialize(record)
+    @record = record
+  end
+
+end

data/lib/generators/shout_out/shout/shout_generator.rb

@@ -0,0 +1,19 @@
+module ShoutOut
+  module Generators
+    class ShoutGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      argument :model_name, type: :string
+
+      def copy_file
+        if model_name.underscore.include? '_shout'
+          file = "app/shouts/#{model_name.underscore}.rb"
+        else
+          file = "app/shouts/#{model_name.underscore}_shout.rb"
+        end
+
+        template 'shout.rb', file
+      end
+      
+    end
+  end
+end

data/lib/generators/shout_out/shout/templates/shout.rb

@@ -0,0 +1,3 @@
+class <%= model_name.underscore.include?('_shout') ? model_name : "#{model_name}Shout" %> < ApplicationShout
+
+end

data/lib/shout_out/version.rb

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

data/lib/shout_out.rb

@@ -0,0 +1,31 @@
+require 'shout_out/version'
+require 'active_support/concern'
+
+module ShoutOut
+  extend ActiveSupport::Concern
+
+  included do
+    before_validation -> { shout(:before_validation, self) }
+    validate -> { shout(:validate, self) }
+    after_validation -> { shout(:after_validation, self) }
+    before_save -> { shout(:before_save, self) }
+    after_save -> { shout(:after_save, self) }
+    before_create -> { shout(:before_create, self) }
+    after_create -> { shout(:after_create, self) }
+    after_commit -> { shout(:after_commit, self) }
+  end
+
+  def shout(action, record)
+    begin
+      klass = "#{record.class.model_name}Shout".constantize
+    rescue NameError
+      return
+    end
+
+    klass.new(record).try(action)
+  end
+end
+
+class ActiveRecord::Base
+  include ShoutOut
+end

data/shout_out.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shout_out/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'shout_out'
+  spec.version       = ShoutOut::VERSION
+  spec.authors       = ['Kevin Pheasey']
+  spec.email         = ['kevin.pheasey@gmail.com']
+  spec.summary       = %q{Complex ActiveRecord callback abstraction.}
+  spec.description   = %q{Abstract complex ActiveRecord callbacks into Shouts.}
+  spec.homepage      = 'https://github.com/kpheasey/shout_out'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'rails', '>= 4.0', '< 5'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: shout_out
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin Pheasey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Abstract complex ActiveRecord callbacks into Shouts.
+email:
+- kevin.pheasey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/shout_out/install/install_generator.rb
+- lib/generators/shout_out/install/templates/application_shout.rb
+- lib/generators/shout_out/shout/shout_generator.rb
+- lib/generators/shout_out/shout/templates/shout.rb
+- lib/shout_out.rb
+- lib/shout_out/version.rb
+- shout_out.gemspec
+homepage: https://github.com/kpheasey/shout_out
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Complex ActiveRecord callback abstraction.
+test_files: []