la_maquina 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d18a4ef4eed5cd9ae9141c6177b17710a1df9242
-  data.tar.gz: 1be1594aad8a4ca3d445aaf9e73393a6d9a567cf
+  metadata.gz: 1ce3d8574213b0db902e504ad4b66e30e0961951
+  data.tar.gz: 258fec304013d1b468633d04c4cbc4f3408522a5
 SHA512:
-  metadata.gz: 126281d86542110b43fe57c135f483cafb5fdbd0ce34e236570447e5597dd8302e20071946f47a766a4c0ea671b370f4c796486d96daf986c7d953d264e46eb1
-  data.tar.gz: db6e7be277c7d39881edf1f3b64582ff081e27f83e7392e5af00160863c0fb36f8e2ad82c3f903fc25100a874736931ff973cb61f4f33e463b2c985f2c32b8fe
+  metadata.gz: 18fbd41257b6fa9a3e423887fa2a0c345b1e51e5d0bd4de656abdd69430215f508060a54696fdebc2318e06ab9845e12f68a5b0749e814456c4b4323aa208864
+  data.tar.gz: 37f9ca36e459a12e4bdf199381af7eb8b007f38a9a5e2a5a62a52ffa35d54256c42addd9bcfedbcb6998b4a27d459d94d56a0ebc00a79c52818ff0de0fdb83b7

data/.gitignore

@@ -0,0 +1,2 @@
+coverage/
+test/dummy/log/*

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    cache_machine (0.0.8)
-      redis
+    la_maquina (0.0.2)
 
 GEM
   remote: https://rubygems.org/
@@ -120,7 +119,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.6)
-  cache_machine!
+  la_maquina!
   rails (>= 4.2.0)
   rake
   redis

data/README.md

@@ -42,7 +42,7 @@ class Machete < ActiveRecord::Base
   belongs_to :danny_trejo
 
   include LaMaquina::Volante
-  updates :danny_trejo
+  notifies :danny_trejo
 end
 ```
 and we want to let `DannyTrejo` know when his `Machete` has been updated so that we can reindex him.
@@ -50,7 +50,7 @@ and we want to let `DannyTrejo` know when his `Machete` has been updated so that
 `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 SunspotPiston < LaMaquina::Piston::Base
   class << self
     def fire!(klass = "", id = nil)
       indexed_class.find(id).index!
@@ -69,13 +69,32 @@ Which finds the klass, does a find on it and fires off [Sunspot](https://github.
 
 ### Setup
 
-The setup is pretty straightforward: you do all the setting up in `config/la_maquina.rb'. 
+The setup is pretty straightforward: you do all the setting up in `config/initializers/la_maquina.rb`. 
 
-The 2 things you have to do are: set up the pistons(if they need configuring) and install them.
+The 3 things you have to do are: set up the pistons(if they need configuring), install them, and configure the error_handler.
 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
+```ruby
+LaMaquina::Piston::CachePiston.redis = Redis::Namespace.new(:cache_piston, redis: Redis.new)
+LaMaquina::Ciguenal.install LaMaquina::Piston::CachePiston, TestPiston
+LaMaquina.error_notifier = LaMaquina::ErrorNotifier::HoneybadgerNotifier
+```
+#### ErrorNotifier
+LaMaquina by default comes with an `ErrorNotifier::Base` that will explode in a very unhelpful manner. To override it, you need to change it in the config above and roll a new `ErrorNotifier` that responds to `notify(error, details)`. For example, if you're using Honeybadger, you can use the included `LaMaquina::ErrorNotifiers::HoneybadgerNotifier, which looks like:
+```ruby
+class HoneybadgerNotifier < LaMaquina::ErrorNotifier::Base
+  self.notify(error = nil, details = {})
+    Honeybadger.notify( :error_class => "CacheMachineError: #{error.class.name}",
+                        :error_message => error.message,
+                        :parameters => details
+                      )
+  end
+end
+```
+If you *don't* care about your exceptions and want to ignore them, there's a notifier you can use, `SilentNotifier`, making that last line in your `config/initializers/la_maquina.rb` be
+```ruby
+LaMaquina::Cinegual.error_notifier = LaMaquina::ErrorNotifier::SilentNotifier
+```
 
 ## Contributing
 

data/Rakefile

@@ -8,7 +8,7 @@ require 'rdoc/task'
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'CacheMachine'
+  rdoc.title    = 'LaMaquina'
   rdoc.options << '--line-numbers'
   rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')

data/lib/la_maquina/ciguenal.rb

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

data/lib/la_maquina/error_notifier/base.rb

@@ -0,0 +1,11 @@
+module LaMaquina
+  module ErrorNotifier
+    class Base
+      
+      def self.notify(error, details = {})
+        throw "There's no ErrorNotifier set or id doesn't implement `notify` as it should."
+      end
+      
+    end
+  end
+end

data/lib/la_maquina/error_notifier/honeybadger_notifier.rb

@@ -0,0 +1,12 @@
+module LaMaquina
+  module ErrorNotifier
+    class HoneybadgerNotifier < LaMaquina::ErrorNotifier::Base
+      def notify(error, details = {})
+        Honeybadger.notify( :error_class => "CacheMachineError: #{error.class.name}",
+                            :error_message => error.message,
+                            :parameters => details
+                          )
+      end
+    end
+  end
+end

data/lib/la_maquina/error_notifier/silent_notifier.rb

@@ -0,0 +1,10 @@
+module LaMaquina
+  module ErrorNotifier
+    class SilentNotifier < LaMaquina::ErrorNotifier::Base
+
+      def self.notify(error, details = {})
+        # don't blame me! you're the one who didn't set the notifier!
+      end
+    end
+  end
+end

data/lib/la_maquina/error_notifier.rb

@@ -0,0 +1,6 @@
+module LaMaquina
+  module ErrorNotifier
+    autoload :Base,                 'la_maquina/error_notifier/base'
+    autoload :HoneybadgerNotifier,  'la_maquina/error_notifier/honeybadger_notifier'
+  end
+end

data/lib/la_maquina/piston/base.rb

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

data/lib/la_maquina/piston/cache_piston.rb

@@ -0,0 +1,39 @@
+module LaMaquina
+  module Piston
+    class CachePiston < LaMaquina::Piston::Base
+      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
+end

data/lib/la_maquina/piston.rb

@@ -1,9 +1,6 @@
 module LaMaquina
-  class Piston
-
-    def self.fire!(klass = "", id = nil)
-      throw "A piston has to implement 'fire!'"
-    end
-
+  module Piston
+    autoload :Base,         'la_maquina/piston/base'
+    autoload :CachePiston,  'la_maquina/piston/cache_piston'
   end
 end

data/lib/la_maquina/version.rb

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

data/lib/la_maquina/volante.rb

@@ -4,11 +4,15 @@ module LaMaquina
     include ActiveRecord::Callbacks
 
     included do
-
+      
       class << self
-        attr_reader :notified_objects
-        notified_objects = []
+        attr_accessor :notified_objects
+      end
 
+      self.notified_objects = []
+
+      
+      class << self
         def notifies(object, opts = {})
           notified_objects << {:object => object, :options => opts}
         end
@@ -18,7 +22,7 @@ module LaMaquina
     end
 
     def notify!
-      notified_objects.each do |notified|
+      self.class.notified_objects.each do |notified|
 
         object  = notified[:object]
         options = notified[:options]
@@ -35,11 +39,11 @@ module LaMaquina
             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)
+          LaMaquina.error_notifier.notify(  e,
+                                            :notified_class => klass,
+                                            :notified_id => id,
+                                            :notifier_class => LaMaquina.format_object_name(self),
+                                            :notifier_id => self.id)
         end
       end
     end

data/lib/la_maquina.rb

@@ -1,14 +1,13 @@
 require "la_maquina/version"
 
 module LaMaquina
-  autoload :Ciguenal,     'la_maquina/ciguenal'
-  autoload :Piston,       'la_maquina/piston'
-  autoload :Volante,      'la_maquina/volante'
+  autoload :Ciguenal,             'la_maquina/ciguenal'
+  autoload :ErrorNotifier,        'la_maquina/error_notifier'
+  autoload :Piston,               'la_maquina/piston'
+  autoload :Volante,              'la_maquina/volante'
 
-  autoload :CachePiston,  'la_maquina/pistons/cache_piston'
-
-
-  mattr_accessor :update_error_handler
+  mattr_accessor :error_notifier
+  error_notifier ||= LaMaquina::ErrorNotifier::Base
 
   def self.format_object_name(object)
     object.class.to_s.demodulize.underscore

data/test/ciguenal_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class CiguenalTest < ActiveSupport::TestCase
+  
+  def setup
+    @admin = admins(:wheel)
+  end
+ 
+  def test_can_fire_pistons
+    @admin.name = "lol"
+    @admin.save!
+
+    assert_equal "admin/#{@admin.id}", $fire_message
+  end
+
+  # def test_touch_cache_updates_cache_key
+  #   key = LaMaquina::Ciguenal.cache_key :admin, @admin.id
+
+  #   sleep(1)
+  #   LaMaquina::Ciguenal.touch_cache :admin, @admin.id
+
+  #   assert_not_equal key, LaMaquina::Ciguenal.cache_key(:admin, @admin.id)
+  # end
+
+  # def test_cache_key_generates_new_key
+  #   Redis.current.del LaMaquina::Ciguenal.redis_key(:admin, @admin.id)
+
+  #   assert_not_nil LaMaquina::Ciguenal.cache_key(:admin, @admin.id)
+  # end
+end

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

@@ -4,8 +4,8 @@ class Admin < ActiveRecord::Base
 
   has_many :properties, :as => :user
 
-  include CacheMachine::SubordinateCacheObject
-  updates_cache_master :self
+  include LaMaquina::Volante
+  notifies :self
 
-  updates_cache_master :self, :comm_object => ::DummyCacheMachineCommObject
+  notifies :self, :using => ::DummyCommObject
 end

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

@@ -2,8 +2,8 @@ class AdminTrait < ActiveRecord::Base
   belongs_to :user, :class_name => "Admin"
   belongs_to :thing, :class_name => "Trait"
 
-  include CacheMachine::SubordinateCacheObject
+  include LaMaquina::Volante
 
-  updates_cache_master :user, :class => Admin
-  updates_cache_master :thing, :class_name => "Trait"
+  notifies :user, :class => Admin
+  notifies :thing, :class_name => "Trait"
 end

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

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

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

@@ -4,7 +4,7 @@ class Guest < ActiveRecord::Base
 
   has_many :properties, :as => :user
 
-  include CacheMachine::SubordinateCacheObject
+  include LaMaquina::Volante
 
-  updates_cache_master :self
+  notifies :self
 end

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

@@ -2,8 +2,8 @@ class GuestTrait < ActiveRecord::Base
   belongs_to :guest
   belongs_to :trait
 
-  include CacheMachine::SubordinateCacheObject
+  include LaMaquina::Volante
 
-  updates_cache_master :guest
-  updates_cache_master :trait
+  notifies :guest
+  notifies :trait
 end

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

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

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

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

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

@@ -1,4 +1,5 @@
 class Standalone < ActiveRecord::Base
-  include CacheMachine::SubordinateCacheObject
-  updates_cache_master :self, :comm_object => ::ExplodingCacheMachineCommObject
+  include LaMaquina::Volante
+
+  notifies :self, :comm_object => ::ExplodingCommObject
 end

data/test/dummy/config/application.rb

@@ -3,7 +3,7 @@ require File.expand_path('../boot', __FILE__)
 require 'rails/all'
 
 Bundler.require(*Rails.groups)
-require "cache_machine"
+require "la_maquina"
 
 module Dummy
   class Application < Rails::Application

data/test/dummy/config/initializers/la_maquina.rb

@@ -0,0 +1,3 @@
+LaMaquina::Piston::CachePiston.redis = Redis::Namespace.new(:cache_piston, redis: Redis.new)
+LaMaquina::Ciguenal.install LaMaquina::Piston::CachePiston, TestPiston
+LaMaquina.error_notifier = LaMaquina::ErrorNotifier::TestNotifier

data/test/dummy/lib/dummy_comm_object.rb

@@ -0,0 +1,5 @@
+class DummyCommObject
+  def self.notify! params
+    $dummy_params = params
+  end
+end

data/test/dummy/lib/exploding_comm_object.rb

@@ -0,0 +1,5 @@
+class ExplodingCommObject
+  def self.notify! params
+    raise "oh noes!"
+  end
+end

data/test/dummy/lib/test_notifier.rb

@@ -0,0 +1,6 @@
+class TestNotifier < LaMaquina::ErrorNotifier::Base
+  def self.notify(error, details = {})
+    $error    = error
+    $details  = details
+  end
+end

data/test/dummy/lib/test_piston.rb

@@ -0,0 +1,5 @@
+class TestPiston < LaMaquina::Piston::Base
+  def self.fire!(klass = "", id = nil)
+    $fire_message = "#{klass}/#{id}"
+  end
+end

data/test/la_maquina_test.rb

@@ -3,13 +3,13 @@ require 'test_helper'
 class LaMaquinaTest < ActiveSupport::TestCase
 
   def test_object_name_formatting
-    assert_equal "admin",      LaMaquina.format_object_name(admins(:su))
+    assert_equal "admin",       LaMaquina.format_object_name(admins(:su))
     assert_equal "admin_trait", LaMaquina.format_object_name(admin_traits(:wheels_something_else))
   end
 
 
   def test_class_name_formatting
-    assert_equal "admin",      LaMaquina.format_class_name(Admin)
+    assert_equal "admin",       LaMaquina.format_class_name(Admin)
     assert_equal "admin_trait", LaMaquina.format_class_name(AdminTrait)
   end
 end

data/test/volante_test.rb

@@ -0,0 +1,136 @@
+require 'test_helper'
+
+
+class MasterCacheObjectTest < ActiveSupport::TestCase
+
+ 
+  # def test_update_subordinate_objects_suports_explicit_class_and_class_name
+  #   admin_attr = admin_traits(:wheels_something_else)
+  #   admin_key  = CacheMachine::MasterCacheObject.cache_key :admin, admin_attr.user.id
+  #   trait_key  = CacheMachine::MasterCacheObject.cache_key :trait, admin_attr.thing.id
+
+  #   # sleep to prevent key clash
+  #   sleep(1)
+
+  #   admin_attr.value = "lol"
+  #   admin_attr.save!
+
+  #   assert_not_equal admin_key, CacheMachine::MasterCacheObject.cache_key(:admin, admin_attr.user.id)
+  #   assert_not_equal trait_key, CacheMachine::MasterCacheObject.cache_key(:trait, admin_attr.thing.id)
+  # end
+
+  # def test_update_subordinate_object_can_update_self
+  #   wheel = admins(:wheel)
+  #   key   = CacheMachine::MasterCacheObject.cache_key :admin, wheel.id
+
+  #   sleep(1)
+    
+  #   wheel.name = "WHEEL!"
+  #   wheel.save!
+    
+  #   assert_not_equal key, CacheMachine::MasterCacheObject.cache_key(:admin, wheel.id)
+  # end
+
+
+  # def test_update_subordinate_object_supports_implict_class
+
+  #   guest_attr = guest_traits(:gregs_something)
+  #   guest_key  = CacheMachine::MasterCacheObject.cache_key :guest, guest_attr.guest.id
+  #   trait_key  = CacheMachine::MasterCacheObject.cache_key :trait, guest_attr.trait.id
+
+  #   # sleep to prevent key clash
+  #   sleep(1)
+
+  #   guest_attr.value = "who cares"
+  #   guest_attr.save!
+
+  #   assert_not_equal guest_key, CacheMachine::MasterCacheObject.cache_key(:guest, guest_attr.guest.id)
+  #   assert_not_equal trait_key, CacheMachine::MasterCacheObject.cache_key(:trait, guest_attr.trait.id)
+  # end
+
+  # def test_update_subordinate_object_supports_polymorphism
+  #   su_whatever = properties(:su_whatever)
+  #   gregs_thing = properties(:gregs_thing)
+    
+  #   su_key      = CacheMachine::MasterCacheObject.cache_key :admin, su_whatever.user.id
+  #   gt_key      = CacheMachine::MasterCacheObject.cache_key :guest, gregs_thing.user.id
+
+  #   sleep(1)
+
+  #   su_whatever.value = "blah"
+  #   gregs_thing.value = "blah blah"
+
+  #   su_whatever.save!
+  #   gregs_thing.save!
+
+  #   assert_not_equal su_key, CacheMachine::MasterCacheObject.cache_key(:admin, su_whatever.user.id)
+  #   assert_not_equal gt_key, CacheMachine::MasterCacheObject.cache_key(:guest, gregs_thing.user.id)
+  # end
+  
+  # def test_subordingate_object_creation_updates_master
+  #   greg  = guests(:greg)
+  #   key   = CacheMachine::MasterCacheObject.cache_key :guest, greg.id
+
+  #   sleep(1)
+    
+  #   greg.guest_traits.create!(:value => "some bullshit")
+    
+  #   assert_not_equal key, CacheMachine::MasterCacheObject.cache_key(:guest, greg.id)
+  # end
+
+  # def test_subordingate_object_destruction_updates_master
+  #   wheel       = admins(:wheel)
+  #   wheel_attr  = admin_traits(:wheels_something_else)
+    
+  #   key         = CacheMachine::MasterCacheObject.cache_key :admin, wheel.id
+
+  #   sleep(1)
+    
+  #   wheel_attr.destroy
+    
+  #   assert_not_equal key, CacheMachine::MasterCacheObject.cache_key(:admin, wheel.id)
+  # end
+
+  # def test_subordinate_object_can_update_through
+  #   modifier  = guest_trait_modifiers(:gregs_something_modifier)
+  #   key       = CacheMachine::MasterCacheObject.cache_key(:guest, modifier.guest_trait.guest.id)
+
+  #   sleep(1)
+
+  #   modifier.modifier = "something something darkside"
+  #   modifier.save!
+
+  #   assert_not_equal key, CacheMachine::MasterCacheObject.cache_key(:guest, modifier.guest_trait.guest.id)
+  # end
+
+  # def test_subordinate_object_can_update_through_with_explicit_target_class
+  #   modifier  = admin_trait_modifiers(:wheels_something_else_modifier)
+  #   admin_key = CacheMachine::MasterCacheObject.cache_key :admin, modifier.admin_trait.user.id
+  #   trait_key = CacheMachine::MasterCacheObject.cache_key :trait, modifier.admin_trait.thing.id
+
+  #   sleep(1)
+
+  #   modifier.modifier = "something something darkside"
+  #   modifier.save!
+
+  #   assert_not_equal admin_key, CacheMachine::MasterCacheObject.cache_key(:admin, modifier.admin_trait.user.id)
+  #   assert_not_equal trait_key, CacheMachine::MasterCacheObject.cache_key(:trait, modifier.admin_trait.thing.id)
+  # end
+
+  # def test_touch_cache_through_gem
+  #   admin = admins(:su)
+  #   admin.update_attribute(:name, "lol")
+
+  #   assert_equal $dummy_cache_params[:subordinate_class], "admin"
+  # end
+
+  # def test_touch_cache_can_handle_comm_object_failures
+  #   thing = standalones(:thing)
+  #   thing.value = "something new"
+  #   thing.save
+
+  #   assert_equal $error.class, RuntimeError
+  #   assert_equal $error.to_s,  "oh noes!"
+  #   assert_equal $deets[:master_class], "standalone"
+  # end
+end