la_maquina 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d18a4ef4eed5cd9ae9141c6177b17710a1df9242
+  data.tar.gz: 1be1594aad8a4ca3d445aaf9e73393a6d9a567cf
+SHA512:
+  metadata.gz: 126281d86542110b43fe57c135f483cafb5fdbd0ce34e236570447e5597dd8302e20071946f47a766a4c0ea671b370f4c796486d96daf986c7d953d264e46eb1
+  data.tar.gz: db6e7be277c7d39881edf1f3b64582ff081e27f83e7392e5af00160863c0fb36f8e2ad82c3f903fc25100a874736931ff973cb61f4f33e463b2c985f2c32b8fe

data/Gemfile

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in cache_machine.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+rails_version = ENV["RAILS_VERSION"] || "default"
+
+rails = case rails_version
+when "default"
+ ">= 4.2.0"
+else
+ "~> #{rails_version}"
+end
+
+gem "rails", rails
+gem "redis"
+gem "redis-namespace"
+
+gem 'test_after_commit', :group => :test
+gem 'simplecov', :group => :test

data/Gemfile.lock

@@ -0,0 +1,130 @@
+PATH
+  remote: .
+  specs:
+    cache_machine (0.0.8)
+      redis
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.0)
+      actionpack (= 4.2.0)
+      actionview (= 4.2.0)
+      activejob (= 4.2.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.0)
+      actionview (= 4.2.0)
+      activesupport (= 4.2.0)
+      rack (~> 1.6.0)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    actionview (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    activejob (4.2.0)
+      activesupport (= 4.2.0)
+      globalid (>= 0.3.0)
+    activemodel (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+    activerecord (4.2.0)
+      activemodel (= 4.2.0)
+      activesupport (= 4.2.0)
+      arel (~> 6.0)
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.0)
+    builder (3.2.2)
+    docile (1.1.5)
+    erubis (2.7.0)
+    globalid (0.3.3)
+      activesupport (>= 4.1.0)
+    hike (1.2.3)
+    i18n (0.7.0)
+    json (1.8.2)
+    loofah (2.0.1)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.4.3)
+    mini_portile (0.6.2)
+    minitest (5.5.1)
+    multi_json (1.10.1)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    rack (1.6.0)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.0)
+      actionmailer (= 4.2.0)
+      actionpack (= 4.2.0)
+      actionview (= 4.2.0)
+      activejob (= 4.2.0)
+      activemodel (= 4.2.0)
+      activerecord (= 4.2.0)
+      activesupport (= 4.2.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.0)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.5)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.1)
+      loofah (~> 2.0)
+    railties (4.2.0)
+      actionpack (= 4.2.0)
+      activesupport (= 4.2.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    redis (3.2.1)
+    redis-namespace (1.5.1)
+      redis (~> 3.0, >= 3.0.4)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    sprockets (2.12.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.2.4)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    sqlite3 (1.3.10)
+    test_after_commit (0.4.0)
+      activerecord (>= 3.2)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  cache_machine!
+  rails (>= 4.2.0)
+  rake
+  redis
+  redis-namespace
+  simplecov
+  sqlite3
+  test_after_commit

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Greg Orlov
+
+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/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Greg Orlov
+
+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,86 @@
+# La Maquina
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'la_maquina'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install la_maquina
+
+## Usage
+
+
+
+### Pistons
+
+Once the `Ciguenal` is called it fires the `Piston`s, the behavior of which is entirely up to you. 
+
+So, let's say, we have a couple objects that look like:
+
+```ruby
+class DannyTrejo < ActiveRecord::Base
+  has_many :machetes
+
+  searchable do 
+    double  :machete_sharpness, multiple: true do
+      machetes.map(&:sharpness)
+    end
+  end
+end
+```
+```ruby
+class Machete < ActiveRecord::Base
+  belongs_to :danny_trejo
+
+  include LaMaquina::Volante
+  updates :danny_trejo
+end
+```
+and we want to let `DannyTrejo` know when his `Machete` has been updated so that we can reindex him.
+
+`Machete` is set up to fire on update, so we'll set up a listener Piston that looks like this:
+
+```ruby
+class SunspotPiston < LaMaquina::Piston
+  class << self
+    def fire!(klass = "", id = nil)
+      indexed_class.find(id).index!
+    end
+
+    private
+
+    def indexed_class(klass)
+      {"danny_trejo" => DannyTrejo}[klass] or raise "can't index class #{klass}!"
+    end
+  end
+end
+
+```
+Which finds the klass, does a find on it and fires off [Sunspot](https://github.com/sunspot/sunspot#reindexing-objects) `index!` 
+
+### Setup
+
+The setup is pretty straightforward: you do all the setting up in `config/la_maquina.rb'. 
+
+The 2 things you have to do are: set up the pistons(if they need configuring) and install them.
+For example, if you're using the CachePiston and need to set up Redis, here's how your `la_maquina.rb` will look
+
+LaMaquina::Pistons::CachePiston.redis = Redis::Namespace.new(:cache_piston, redis: MyRedisInstance)
+LaMaquina::Ciguenal.install MyPiston, LaMaquina::Pistons::CachePiston
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/la_maquina/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CacheMachine'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/la_maquina.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'la_maquina/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "la_maquina"
+  spec.version       = LaMaquina::VERSION
+  spec.authors       = ["Greg Orlov"]
+  spec.email         = ["greg@avvo.com"]
+  spec.summary       = %q{depnendency tree update notifications}
+  spec.description   = %q{lets you have inter-model update notifications without having to make database connections}
+  spec.homepage      = "https://github.com/gaorlov/la_maquina"
+  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.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "sqlite3"
+
+end

data/lib/la_maquina/ciguenal.rb

@@ -0,0 +1,23 @@
+module LaMacquina
+  class Ciguenal
+
+    class << self
+      def self.notify!(klass = "", id = nil)
+        pistons.each do |piston|
+          piston.fire! klass, id
+        end
+      end
+
+      def self.install(*pistons)
+        pistons.each do |piston|
+          self.pistons << piston
+        end
+      end
+
+      protected
+
+      attr_accessor :pistons
+      self.pistons = []
+    end
+  end
+end

data/lib/la_maquina/piston.rb

@@ -0,0 +1,9 @@
+module LaMaquina
+  class Piston
+
+    def self.fire!(klass = "", id = nil)
+      throw "A piston has to implement 'fire!'"
+    end
+
+  end
+end

data/lib/la_maquina/pistons/cache_piston.rb

@@ -0,0 +1,37 @@
+module Pistons
+  class CachePiston < LaMaquina::Piston
+    class << self
+      attr_accessor :redis
+
+      def fire!(klass = "", id = nil)
+
+        updated_at = SecureRandom.uuid()
+        redis_key_string = redis_key klass, id
+        # make a class var with a default
+
+        cache_key = "#{redis_key_string}/#{updated_at}"
+        redis.set redis_key_string, cache_key
+
+        cache_key
+      end
+
+      def cache_key(klass, id)
+
+        redis_key_string = redis_key klass, id
+
+        key = redis.get redis_key_string
+        # key found
+        return key if key
+
+        # there's no key; we can't very well rerun nil for cache_key. Let's make a new entry
+        touch_cache klass, id
+      end
+
+      protected
+
+      def redis_key(klass, id)
+        "#{klass}/#{id}"
+      end
+    end
+  end
+end

data/lib/la_maquina/version.rb

@@ -0,0 +1,3 @@
+module LaMaquina
+  VERSION = "0.0.2"
+end

data/lib/la_maquina/volante.rb

@@ -0,0 +1,81 @@
+module LaMaquina
+  module Volante
+    extend ActiveSupport::Concern
+    include ActiveRecord::Callbacks
+
+    included do
+
+      class << self
+        attr_reader :notified_objects
+        notified_objects = []
+
+        def notifies(object, opts = {})
+          notified_objects << {:object => object, :options => opts}
+        end
+      end
+
+      after_commit  :notify!
+    end
+
+    def notify!
+      notified_objects.each do |notified|
+
+        object  = notified[:object]
+        options = notified[:options]
+
+        comm_object = options[:using]
+
+        klass = notified_klass( object, options )
+        id    = notified_id( object, options )
+
+        begin
+          if comm_object
+            comm_object.notify(:notified_class => klass, :notified_id => id, :notifier_class => LaMaquina.format_object_name(self))
+          else
+            LaMaquina::Ciguenal.notify!(klass, id)
+          end
+        rescue => e
+          LaMaquina.update_error_handler.call( e,
+                                                  :notified_class => klass,
+                                                  :notified_id => id,
+                                                  :subordinate_class => LaMaquina.format_object_name(self),
+                                                  :subordinate_id => self.id)
+        end
+      end
+    end
+
+    private
+
+    def notified_klass(object, options)
+      if object == :self
+        return LaMaquina.format_object_name(self)
+      end
+
+      if options[:polymorphic]
+        return LaMaquina.format_class_name(self.send("#{object}_type"))
+      end
+      
+      if options[:class_name]
+        return LaMaquina.format_class_name(options[:class_name])
+      end
+      
+      if options[:class]
+        return LaMaquina.format_class_name(options[:class])
+      end
+      
+      return object
+    end
+
+    def notified_id(object, options)
+      if object == :self
+        return self.id 
+      end
+
+      if options[:through]
+        return self.send(options[:through]).send("#{object}_id") 
+      end
+
+      self.send("#{object}_id")
+    end
+  end
+end

data/lib/la_maquina.rb

@@ -0,0 +1,20 @@
+require "la_maquina/version"
+
+module LaMaquina
+  autoload :Ciguenal,     'la_maquina/ciguenal'
+  autoload :Piston,       'la_maquina/piston'
+  autoload :Volante,      'la_maquina/volante'
+
+  autoload :CachePiston,  'la_maquina/pistons/cache_piston'
+
+
+  mattr_accessor :update_error_handler
+
+  def self.format_object_name(object)
+    object.class.to_s.demodulize.underscore
+  end
+
+  def self.format_class_name(klass)
+    klass.to_s.demodulize.underscore
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/models/admin.rb

@@ -0,0 +1,11 @@
+class Admin < ActiveRecord::Base
+  has_many :admin_traits
+  has_many :traits, :through => :admin_traits
+
+  has_many :properties, :as => :user
+
+  include CacheMachine::SubordinateCacheObject
+  updates_cache_master :self
+
+  updates_cache_master :self, :comm_object => ::DummyCacheMachineCommObject
+end

data/test/dummy/app/models/admin_trait.rb

@@ -0,0 +1,9 @@
+class AdminTrait < ActiveRecord::Base
+  belongs_to :user, :class_name => "Admin"
+  belongs_to :thing, :class_name => "Trait"
+
+  include CacheMachine::SubordinateCacheObject
+
+  updates_cache_master :user, :class => Admin
+  updates_cache_master :thing, :class_name => "Trait"
+end

data/test/dummy/app/models/admin_trait_modifier.rb

@@ -0,0 +1,8 @@
+class AdminTraitModifier < ActiveRecord::Base
+  belongs_to :admin_trait
+
+  include CacheMachine::SubordinateCacheObject
+
+  updates_cache_master :user, :through => :admin_trait, :class_name => "Admin"
+  updates_cache_master :thing, :through => :admin_trait, :class => Trait
+end

data/test/dummy/app/models/danny_trejo.rb

@@ -0,0 +1,5 @@
+class DannyTrejo < ActiveRecord::Base
+  
+  has_many :machetes
+
+end

data/test/dummy/app/models/guest.rb

@@ -0,0 +1,10 @@
+class Guest < ActiveRecord::Base
+  has_many :guest_traits
+  has_many :traits, :through => :guest_traits
+
+  has_many :properties, :as => :user
+
+  include CacheMachine::SubordinateCacheObject
+
+  updates_cache_master :self
+end

data/test/dummy/app/models/guest_trait.rb

@@ -0,0 +1,9 @@
+class GuestTrait < ActiveRecord::Base
+  belongs_to :guest
+  belongs_to :trait
+
+  include CacheMachine::SubordinateCacheObject
+
+  updates_cache_master :guest
+  updates_cache_master :trait
+end

data/test/dummy/app/models/guest_trait_modifier.rb

@@ -0,0 +1,7 @@
+class GuestTraitModifier < ActiveRecord::Base
+  belongs_to :guest_trait
+
+  include CacheMachine::SubordinateCacheObject
+
+  updates_cache_master :guest, :through => :guest_trait
+end

data/test/dummy/app/models/machete.rb

@@ -0,0 +1,8 @@
+class Machete < ActiveRecord::Base
+
+  belongs_to :danny_trejo
+  
+  include LaMaquina::Volante
+  notifies :danny_trejo
+
+end

data/test/dummy/app/models/property.rb

@@ -0,0 +1,7 @@
+class Property < ActiveRecord::Base
+  belongs_to :user, :polymorphic => true
+
+  include CacheMachine::SubordinateCacheObject
+
+  updates_cache_master :user, :polymorphic => true
+end

data/test/dummy/app/models/standalone.rb

@@ -0,0 +1,4 @@
+class Standalone < ActiveRecord::Base
+  include CacheMachine::SubordinateCacheObject
+  updates_cache_master :self, :comm_object => ::ExplodingCacheMachineCommObject
+end

data/test/dummy/app/models/trait.rb

@@ -0,0 +1,4 @@
+class Trait < ActiveRecord::Base
+  has_many :guest_traits
+  has_many :admin_traits
+end