data_miner 2.0.3 → 2.1.0

data/CHANGELOG

@@ -1,3 +1,14 @@
+2.1.0 / 2012-05-10
+
+* Enhancements
+
+  * Don't use "perform" as a class or instance method name - it can interfere with Resque or Sidekiq.
+  * Don't lock DataMiner::Run#perform. Provide instructions for how people can do this manually.
+
+* Bug fixes
+
+  * Don't blow up trying to get current database name on SQLite3
+
 2.0.3 / 2012-05-07
 
 * Enhancements

data/Gemfile

@@ -10,6 +10,7 @@ gem 'mysql2'
 gem 'rake'
 gem 'yard'
 gem 'earth'
+gem 'lock_method'
 if RUBY_VERSION >= '1.9'
   gem 'unicode_utils'
 end

data/data_miner.gemspec

@@ -24,5 +24,4 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'errata', '>=1.0.1'
   s.add_runtime_dependency 'active_record_inline_schema'
   s.add_runtime_dependency 'aasm'
-  s.add_runtime_dependency 'lock_method', '>=0.5.1'
 end

data/lib/data_miner.rb

@@ -58,7 +58,7 @@ class DataMiner
   # @param [optional, Array<String>] model_names Names of models to be run.
   #
   # @return [Array<DataMiner::Run>]
-  def perform(model_names = DataMiner.model_names)
+  def start(model_names = DataMiner.model_names)
     Script.uniq do
       model_names.map do |model_name|
         model_name.constantize.run_data_miner!
@@ -67,7 +67,7 @@ class DataMiner
   end
 
   # legacy
-  alias :run :perform
+  alias :run :start
 
   # Where DataMiner logs to. Defaults to +Rails.logger+ or +ActiveRecord::Base.logger+ if either is available.
   #

data/lib/data_miner/active_record_class_methods.rb

@@ -1,5 +1,4 @@
 require 'active_record'
-require 'lock_method'
 
 class DataMiner
   # Class methods that are mixed into models (i.e. ActiveRecord::Base)
@@ -24,7 +23,7 @@ class DataMiner
     #
     # @return [DataMiner::Run]
     def run_data_miner!
-      data_miner_script.perform
+      data_miner_script.start
     end
     
     # Run the data miner scripts of parent associations. Useful for dependencies. Safe to call using +process+.

data/lib/data_miner/run.rb

@@ -7,27 +7,29 @@ class DataMiner
   # To create the table, use +DataMiner::Run.auto_upgrade!+, possibly in +db/seeds.rb+ or a database migration.
   class Run < ::ActiveRecord::Base
     class << self
-      # If a previous run died, you may find yourself getting +LockMethod::Locked+ exceptions.
+      # If a previous run died and you have manually enabled locking, you may find yourself getting +LockMethod::Locked+ exceptions.
+      #
+      # @note Starting in 2.1.0, runs are no longer locked by default. This method remains in case you want to re-apply locking.
       # 
       # @param [String] model_names What locks to clear.
       #
       # @return [nil]
+      #
+      # @example Re-enable locking (since it was turned off by default in 2.1.0)
+      #   require 'data_miner'
+      #   require 'lock_method'
+      #   DataMiner::Run.lock_method :start
       def clear_locks(model_names = DataMiner.model_names)
+        return unless defined?(::LockMethod)
         model_names.each do |model_name|
           dummy = new
           dummy.model_name = model_name
-          dummy.lock_method_clear :perform
+          dummy.lock_method_clear :start
         end
         nil
       end
-
-      # @private
-      def perform(model_name, &blk)
-        run = new
-        run.model_name = model_name
-        run.perform(&blk)
-      end
     end
+
     # Raise this exception to skip the current run without causing it to fail.
     #
     # @example Avoid running certain data miner scripts too often (because they take too long).
@@ -69,7 +71,7 @@ class DataMiner
     validates_presence_of :model_name
 
     # @private
-    def perform
+    def start
       save!
       begin
         catch :data_miner_succeed do
@@ -89,11 +91,11 @@ class DataMiner
       end
       self
     end
-    lock_method :perform
 
     # @private
     def as_lock
-      [Run.connection.current_database, model_name]
+      database_name = Run.connection.instance_variable_get(:@config).try(:[], :database)
+      [database_name, model_name]
     end
   end
 end

data/lib/data_miner/script.rb

@@ -199,7 +199,7 @@ class DataMiner
     # @note A primitive "call stack" is kept that will prevent infinite loops. So, if Country's data miner script calls Province's AND vice-versa, each one will only be run once.
     #
     # @return [DataMiner::Run]
-    def perform
+    def start
       model_name = model.name
       # $stderr.write "0 - #{model_name}\n"
       # $stderr.write "A - current_uniq - #{Script.current_uniq ? 'true' : 'false'}\n"
@@ -213,9 +213,11 @@ class DataMiner
         Script.current_stack.clear
       end
       Script.current_stack << model_name
-      Run.perform(model_name) do
+      run = Run.new
+      run.model_name = model_name
+      run.start do
         steps.each do |step|
-          step.perform
+          step.start
           model.reset_column_information
         end
       end

data/lib/data_miner/step/import.rb

@@ -83,7 +83,7 @@ class DataMiner
       end
 
       # @private
-      def perform
+      def start
         table.each do |row|
           record = model.send "find_or_initialize_by_#{@key}", attributes[@key].read(row)
           attributes.each { |_, attr| attr.set_from_row record, row }

data/lib/data_miner/step/process.rb

@@ -37,7 +37,7 @@ class DataMiner
       end
       
       # @private
-      def perform
+      def start
         DataMiner::Script.uniq do
           if blk
             model.instance_eval(&blk)

data/lib/data_miner/step/tap.rb

@@ -57,7 +57,7 @@ class DataMiner
       end
       
       # @private
-      def perform
+      def start
         [ source_table_name, model.table_name ].each do |possible_obstacle|
           if connection.table_exists? possible_obstacle
             connection.drop_table possible_obstacle

data/lib/data_miner/version.rb

@@ -1,3 +1,3 @@
 class DataMiner
-  VERSION = '2.0.3'
+  VERSION = '2.1.0'
 end

data/test/test_safety.rb

@@ -2,6 +2,9 @@
 require 'helper'
 require 'earth'
 
+require 'lock_method'
+DataMiner::Run.lock_method :start
+
 # use earth, which has a plethora of real-world data_miner blocks
 Earth.init :locality, :pet, :load_data_miner => true, :apply_schemas => true
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: data_miner
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-07 00:00:00.000000000 Z
+date: 2012-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: remote_table
@@ -125,22 +125,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: lock_method
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.5.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.5.1
 description: Download, pull out of a ZIP/TAR/GZ/BZ2 archive, parse, correct, and import
   XLS, ODS, XML, CSV, HTML, etc. into your ActiveRecord models. You can also convert
   units.