la_maquina 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ce3d8574213b0db902e504ad4b66e30e0961951
-  data.tar.gz: 258fec304013d1b468633d04c4cbc4f3408522a5
+  metadata.gz: e3e37589f3930b79eecc19e0743e9b6b1fcf1d9f
+  data.tar.gz: c332e847878318ab3db7c764f7f19738b41d2338
 SHA512:
-  metadata.gz: 18fbd41257b6fa9a3e423887fa2a0c345b1e51e5d0bd4de656abdd69430215f508060a54696fdebc2318e06ab9845e12f68a5b0749e814456c4b4323aa208864
-  data.tar.gz: 37f9ca36e459a12e4bdf199381af7eb8b007f38a9a5e2a5a62a52ffa35d54256c42addd9bcfedbcb6998b4a27d459d94d56a0ebc00a79c52818ff0de0fdb83b7
+  metadata.gz: 22aad45ed90d3542aedb927e47399297c0369fd17fcf6b786958704a75a62c1382832f99525987c477856c24f595e95c1ee9ad2b2bbc6a094a4e70c0ff0885ab
+  data.tar.gz: ae9ddc8d32213ca73d940d3eea5abb1dce9e984f4423be28bf4750d432c0d4a03d53e5b4db7f8f9bc6b5b5adfce687e44873dba279735036b7b883a872fa54a0

data/.gitignore

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

data/Gemfile

@@ -18,5 +18,10 @@ gem "rails", rails
 gem "redis"
 gem "redis-namespace"
 
+# solr
+gem 'sunspot_rails'
+gem 'sunspot_solr' # optional pre-packaged Solr distribution for use in development
+gem 'progress_bar'
+
 gem 'test_after_commit', :group => :test
 gem 'simplecov', :group => :test

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    la_maquina (0.0.2)
+    la_maquina (0.0.3)
 
 GEM
   remote: https://rubygems.org/
@@ -47,6 +47,7 @@ GEM
     erubis (2.7.0)
     globalid (0.3.3)
       activesupport (>= 4.1.0)
+    highline (1.6.21)
     hike (1.2.3)
     i18n (0.7.0)
     json (1.8.2)
@@ -60,6 +61,11 @@ GEM
     multi_json (1.10.1)
     nokogiri (1.6.6.2)
       mini_portile (~> 0.6.0)
+    options (2.3.2)
+    pr_geohash (1.0.0)
+    progress_bar (1.0.3)
+      highline (~> 1.6.1)
+      options (~> 2.3.0)
     rack (1.6.0)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -91,6 +97,8 @@ GEM
     redis (3.2.1)
     redis-namespace (1.5.1)
       redis (~> 3.0, >= 3.0.4)
+    rsolr (1.0.12)
+      builder (>= 2.1.2)
     simplecov (0.9.1)
       docile (~> 1.1.0)
       multi_json (~> 1.0)
@@ -106,6 +114,14 @@ GEM
       activesupport (>= 3.0)
       sprockets (>= 2.8, < 4.0)
     sqlite3 (1.3.10)
+    sunspot (2.2.0)
+      pr_geohash (~> 1.0)
+      rsolr (~> 1.0.7)
+    sunspot_rails (2.2.0)
+      nokogiri
+      rails (>= 3)
+      sunspot (= 2.2.0)
+    sunspot_solr (2.2.0)
     test_after_commit (0.4.0)
       activerecord (>= 3.2)
     thor (0.19.1)
@@ -120,10 +136,13 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.6)
   la_maquina!
+  progress_bar
   rails (>= 4.2.0)
   rake
   redis
   redis-namespace
   simplecov
   sqlite3
+  sunspot_rails
+  sunspot_solr
   test_after_commit

data/README.md

@@ -1,6 +1,6 @@
 # La Maquina
 
-TODO: Write a gem description
+Model graph traversal 
 
 ## Installation
 
@@ -22,7 +22,7 @@ Or install it yourself as:
 
 ### Pistons
 
-Once the `Ciguenal` is called it fires the `Piston`s, the behavior of which is entirely up to you. 
+Once the `Engine` 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:
 
@@ -41,8 +41,8 @@ end
 class Machete < ActiveRecord::Base
   belongs_to :danny_trejo
 
-  include LaMaquina::Volante
-  notifies :danny_trejo
+  include LaMaquina::Notifier
+  notifies_about :danny_trejo
 end
 ```
 and we want to let `DannyTrejo` know when his `Machete` has been updated so that we can reindex him.
@@ -52,8 +52,8 @@ and we want to let `DannyTrejo` know when his `Machete` has been updated so that
 ```ruby
 class SunspotPiston < LaMaquina::Piston::Base
   class << self
-    def fire!(klass = "", id = nil)
-      indexed_class.find(id).index!
+    def fire!( notified_class, id, notifier_class = "" )
+      indexed_class(notified_class).find(id).index!
     end
 
     private
@@ -76,7 +76,7 @@ For example, if you're using the CachePiston and need to set up Redis, here's ho
 
 ```ruby
 LaMaquina::Piston::CachePiston.redis = Redis::Namespace.new(:cache_piston, redis: Redis.new)
-LaMaquina::Ciguenal.install LaMaquina::Piston::CachePiston, TestPiston
+LaMaquina::Engine.install LaMaquina::Piston::CachePiston, TestPiston
 LaMaquina.error_notifier = LaMaquina::ErrorNotifier::HoneybadgerNotifier
 ```
 #### ErrorNotifier

data/lib/la_maquina/dependency_map/base.rb

@@ -0,0 +1,19 @@
+module LaMaquina
+  module DependencyMap
+    class Base
+      def initialize( path = nil )
+        if path
+          self.map = YAML.load_file(path).with_indifferent_access
+        end
+      end
+
+      def mapping_for(*args)
+        raise "A dependency map has to implement 'mapping_for'"
+      end
+
+      protected
+
+      attr_accessor :map
+    end
+  end
+end

data/lib/la_maquina/dependency_map/constant_map.rb

@@ -0,0 +1,13 @@
+module LaMaquina
+  module DependencyMap
+    class ConstantMap < LaMaquina::DependencyMap::Base
+      
+      def mapping_for(notified_class, id)
+        notified_class.camelize.constantize
+      rescue => e
+        LaMaquina.error_notifier.notify(  e,
+                                          missing_class: notified_class )
+      end
+    end
+  end
+end

data/lib/la_maquina/dependency_map/yaml_map.rb

@@ -0,0 +1,15 @@
+module LaMaquina
+  module DependencyMap
+    class YamlMap < LaMaquina::DependencyMap::Base
+      def mapping_for(*args)
+        submap = map
+        args.each do |key|
+          submap = submap[key]
+        end
+        submap
+      rescue => e
+        LaMaquina.error_notifier.notify( e )
+      end
+    end
+  end
+end

data/lib/la_maquina/dependency_map.rb

@@ -0,0 +1,7 @@
+module LaMaquina
+  module DependencyMap
+    autoload :Base,         'la_maquina/dependency_map/base'
+    autoload :ConstantMap,  'la_maquina/dependency_map/constant_map'
+    autoload :YamlMap,      'la_maquina/dependency_map/yaml_map'
+  end
+end

data/lib/la_maquina/engine.rb

@@ -0,0 +1,39 @@
+module LaMaquina
+  class Engine
+
+    class << self
+      protected
+
+      attr_accessor :pistons
+    end
+    self.pistons = []
+
+    class << self 
+
+      def notify!( notified_class, id, notifier_class = "" )
+        pistons.each do |piston|
+          begin
+            # We can't thread this because Rails executes this code before the commit somehow. 
+            # What. yeah. I don't know either.
+            
+            # Thread.new{
+            piston.fire! notified_class, id, notifier_class
+            # }.join
+          rescue => e
+            LaMaquina.error_notifier.notify(  e,
+                                              misfiring_piston: piston,
+                                              notified_class: notified_class,
+                                              notified_id: id,
+                                              notifier_class: notifier_class )
+          end
+        end
+      end
+
+      def install(*attrs)
+        attrs.each do |piston|
+          self.pistons << piston
+        end
+      end
+    end
+  end
+end

data/lib/la_maquina/error_notifier/base.rb

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

data/lib/la_maquina/{volante.rb → notifier.rb}

@@ -1,5 +1,5 @@
 module LaMaquina
-  module Volante
+  module Notifier
     extend ActiveSupport::Concern
     include ActiveRecord::Callbacks
 
@@ -13,7 +13,7 @@ module LaMaquina
 
       
       class << self
-        def notifies(object, opts = {})
+        def notifies_about(object, opts = {})
           notified_objects << {:object => object, :options => opts}
         end
       end
@@ -32,18 +32,20 @@ module LaMaquina
         klass = notified_klass( object, options )
         id    = notified_id( object, options )
 
+        notifier_class = LaMaquina.format_object_name(self)
+
         begin
           if comm_object
-            comm_object.notify(:notified_class => klass, :notified_id => id, :notifier_class => LaMaquina.format_object_name(self))
+            comm_object.notify(:notified_class => klass, :notified_id => id, :notifier_class => notifier_class)
           else
-            LaMaquina::Ciguenal.notify!(klass, id)
+            LaMaquina::Engine.notify! klass, id, notifier_class
           end
         rescue => e
           LaMaquina.error_notifier.notify(  e,
-                                            :notified_class => klass,
-                                            :notified_id => id,
-                                            :notifier_class => LaMaquina.format_object_name(self),
-                                            :notifier_id => self.id)
+                                            notified_class: klass,
+                                            notified_id: id,
+                                            notifier_class: notifier_class,
+                                            notifier_id: self.id)
         end
       end
     end

data/lib/la_maquina/piston/base.rb

@@ -2,8 +2,8 @@ module LaMaquina
   module Piston
     class Base
 
-      def self.fire!(klass = "", id = nil)
-        throw "A piston has to implement 'fire!'"
+      def self.fire!( notified_class, id, notifier_class = "" )
+        raise "A piston has to implement 'fire!'"
       end
       
     end

data/lib/la_maquina/piston/cache_piston.rb

@@ -4,32 +4,35 @@ module LaMaquina
       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
+        def fire!( notified_class, id, notifier_class = "" )
+          update_cache notified_class, id
         end
 
-        def cache_key(klass, id)
+        def cache_key(notified_class, id)
 
-          redis_key_string = redis_key klass, id
+          key = redis_key notified_class, id
 
-          key = redis.get redis_key_string
+          cache_key = redis.get key
           # key found
-          return key if key
+          return cache_key if cache_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
+          update_cache notified_class, id
         end
 
         protected
 
+        def update_cache( notified_class, id)
+          uuid = SecureRandom.uuid()
+          key = redis_key notified_class, id
+          # make a class var with a default
+
+          cache_key = "#{key}/#{uuid}"
+          redis.set key, cache_key
+
+          cache_key
+        end
+
         def redis_key(klass, id)
           "#{klass}/#{id}"
         end

data/lib/la_maquina/piston/sunspot_piston.rb

@@ -0,0 +1,22 @@
+module LaMaquina
+  module Piston
+    class SunspotPiston < LaMaquina::Piston::Base
+
+      class << self
+        def fire!( notified_class, id, notifier_class = "" )  
+          target_class = map.mapping_for notified_class, id
+          target       = target_class.find(id)
+          target.solr_index!
+        rescue => e
+          LaMaquina.error_notifier.notify(  e,
+                                            notified_class: klass,
+                                            notified_id: id,
+                                            notifier_class: notifier_class )
+        end
+        
+        attr_accessor :map
+      end
+      self.map = LaMaquina::DependencyMap::ConstantMap.new
+    end
+  end
+end

data/lib/la_maquina/piston.rb

@@ -1,6 +1,7 @@
 module LaMaquina
   module Piston
-    autoload :Base,         'la_maquina/piston/base'
-    autoload :CachePiston,  'la_maquina/piston/cache_piston'
+    autoload :Base,           'la_maquina/piston/base'
+    autoload :CachePiston,    'la_maquina/piston/cache_piston'
+    autoload :SunspotPiston,  'la_maquina/piston/sunspot_piston'
   end
 end

data/lib/la_maquina/version.rb

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

data/lib/la_maquina.rb

@@ -1,10 +1,11 @@
 require "la_maquina/version"
 
 module LaMaquina
-  autoload :Ciguenal,             'la_maquina/ciguenal'
+  autoload :DependencyMap,        'la_maquina/dependency_map'
+  autoload :Engine,               'la_maquina/engine'
   autoload :ErrorNotifier,        'la_maquina/error_notifier'
   autoload :Piston,               'la_maquina/piston'
-  autoload :Volante,              'la_maquina/volante'
+  autoload :Notifier,             'la_maquina/notifier'
 
   mattr_accessor :error_notifier
   error_notifier ||= LaMaquina::ErrorNotifier::Base

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

@@ -4,8 +4,12 @@ class Admin < ActiveRecord::Base
 
   has_many :properties, :as => :user
 
-  include LaMaquina::Volante
-  notifies :self
+  searchable do 
+    text :name
+  end
 
-  notifies :self, :using => ::DummyCommObject
+  include LaMaquina::Notifier
+  notifies_about :self
+
+  notifies_about :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 LaMaquina::Volante
+  include LaMaquina::Notifier
 
-  notifies :user, :class => Admin
-  notifies :thing, :class_name => "Trait"
+  notifies_about :user, :class => Admin
+  notifies_about :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 LaMaquina::Volante
+  include LaMaquina::Notifier
 
-  notifies :user, :through => :admin_trait, :class_name => "Admin"
-  notifies :thing, :through => :admin_trait, :class => Trait
+  notifies_about :user, :through => :admin_trait, :class_name => "Admin"
+  notifies_about :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 LaMaquina::Volante
+  include LaMaquina::Notifier
 
-  notifies :self
+  notifies_about :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 LaMaquina::Volante
+  include LaMaquina::Notifier
 
-  notifies :guest
-  notifies :trait
+  notifies_about :guest
+  notifies_about :trait
 end

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

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

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

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

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

@@ -1,5 +1,5 @@
 class Standalone < ActiveRecord::Base
-  include LaMaquina::Volante
+  include LaMaquina::Notifier
 
-  notifies :self, :comm_object => ::ExplodingCommObject
+  notifies_about :self, using: ::ExplodingCommObject
 end

data/test/dummy/config/database.yml

@@ -17,10 +17,12 @@ development:
 # re-generated from your development database when you run "rake".
 # Do not set this db to the same as development or production.
 test:
-  adapter: sqlite3
-  database: ":memory:"
-  pool: 5
-  timeout: 5000
+  <<: *default
+  database: db/test.sqlite3
+  # adapter: sqlite3
+  # database: ":memory:"
+  # pool: 5
+  # timeout: 5000
 
 production:
   <<: *default

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

@@ -1,3 +1,9 @@
 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
+ExtendedSunspotPiston.yaml_map = LaMaquina::DependencyMap::YamlMap.new( Rails.root + 'config/la_maquina/dependency_maps/sunspot_piston.yml' )
+
+LaMaquina::Engine.install LaMaquina::Piston::CachePiston,
+                          LaMaquina::Piston::SunspotPiston,
+                          PrimitivePiston,
+                          ExtendedSunspotPiston
+                          
+LaMaquina.error_notifier = TestNotifier

data/test/dummy/config/la_maquina/dependency_maps/bad_map.yml

@@ -0,0 +1 @@
+admin: lol

data/test/dummy/config/la_maquina/dependency_maps/sunspot_piston.yml

@@ -0,0 +1 @@
+admin: admin

data/test/dummy/config/sunspot.yml

@@ -0,0 +1,5 @@
+test:
+  solr:
+    hostname: localhost
+    port: 8980
+    log_level: OFF

data/test/dummy/db/schema.rb

@@ -12,5 +12,4 @@
 # It's strongly recommended that you check this file into your version control system.
 
 ActiveRecord::Schema.define(version: 0) do
-
 end

data/test/dummy/lib/dummy_comm_object.rb

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

data/test/dummy/lib/exploding_comm_object.rb

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

data/test/dummy/lib/exploding_piston.rb

@@ -0,0 +1,5 @@
+class ExplodingPiston < LaMaquina::Piston::Base
+  def self.fire!( notified_class, id, notifier_class = "" )
+    raise "NOPE! LOL"
+  end
+end

data/test/dummy/lib/extended_sunspot_piston.rb

@@ -0,0 +1,13 @@
+class ExtendedSunspotPiston < LaMaquina::Piston::SunspotPiston
+  class << self
+    def fire!( notified_class, id, notifier_class = "" )
+      if yaml_map.mapping_for notified_class
+        super
+        $last_reindexed = notified_class
+      end
+    end
+
+    attr_accessor :yaml_map
+  end
+  self.map = LaMaquina::DependencyMap::ConstantMap.new
+end

data/test/dummy/lib/primitive_piston.rb

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

data/test/dummy/lib/test_notifier.rb

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