arca 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e3c9c827e804d9e159cd1287dd96d2f51a73b7c
-  data.tar.gz: 2258bba04de95cb191e8db9819ff6b170cd96ab0
+  metadata.gz: ca8734a74ea5a5b2ab9c36ec62439ecb515a9669
+  data.tar.gz: 2638b950202f3f0c760bebeb7bf4f39ebc75adcb
 SHA512:
-  metadata.gz: a769d84288997f5dcb1557d3e8061b2c215a1bf492f63da1c9d84d4b37a6552a59b90a53f6531104e0b2ecfe0cdf20b88b34c6611d243b85385cfff04a24ae85
-  data.tar.gz: cbebb0af251cfbd5d8900d85aaaa9c973e8ca29a03cb9d73a94d0591f640b6cf6e7f5e03455859bea967346a01e2481bbae49949b6fb06ca8573c8dc3228a74b
+  metadata.gz: b4dfcbd12c0f48b3c33db3de0be2855edc7bb829b8fc7712f7a9666c27c8480cf7d6e8730a8a64859a1cc8ab27ff110d0d5b01da799e49ed2ecbf036a9463f5d
+  data.tar.gz: edc74a7ad1d0e13e57802db09dcacb9c0c9b45f4c8e3c366d7727870a721b5b137259ea8c5e3bed544cee82a85df663d64fe03dca9f89dcea466e2f5154512a4

data/README.md

@@ -16,20 +16,21 @@ Add the gem to your Gemfile and run `bundle`.
 gem 'arca'
 ```
 
-Add an initializer to require the library and configure it (`config/initializers/arca.rb` for example). There's no magic here and Arca doesn't assume your root project path or the path to your `ActiveRecord` models so you have to specify those paths yourself in the initializer.
+In your test helper (`test/test_helper.rb` for example) require the Arca library and include the `Arca::Collector` in `ActiveRecord::Base`.
 
 ```
 require "arca"
 
-Arca.root_path = Rails.root
-Arca.model_path = Rails.root.join("app", "models")
+class ActiveRecord::Base
+  include Arca::Collector
+end
 ```
 
-Include `Arca::Collector` in the models you want to analyze. It must be included before any callbacks so I recommend including it right after the class definition.
+In this example the `Annoucements` module is included in `Ticket` and defines it's own callback.
+
 
 ```ruby
 class Ticket < ActiveRecord::Base
-  include Arca::Collector
   include Announcements
 
   before_save :set_title, :set_body
@@ -53,8 +54,6 @@ class Ticket < ActiveRecord::Base
 end
 ```
 
-In this example the `Annoucements` module is included in `Ticket` and defines it's own callback.
-
 ```ruby
 module Announcements
   def self.included(base)
@@ -69,7 +68,7 @@ module Announcements
 end
 ```
 
-Next use `Arca[Ticket].report` to analyze the callbacks for the `Ticket` class.
+Use `Arca[Ticket].report` to analyze the callbacks for the `Ticket` class.
 
 ```ruby
 > Arca.root_path = `pwd`.chomp

data/arca.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "arca"
-  spec.version       = "1.0.0"
+  spec.version       = "2.0.0"
   spec.date          = "2015-07-11"
   spec.summary       = "ActiveRecord callback analyzer"
   spec.description   = "Arca is a callback analyzer for ActiveRecord ideally suited for digging yourself out of callback hell"

data/lib/arca/callback_analysis.rb

@@ -80,6 +80,7 @@ module Arca
     # Public: Boolean representing whether the callback target is located in the
     # same file where the callback is defined.
     def external_target?
+      return false if target_symbol == :block
       target_file_path != callback_file_path
     end
 

data/lib/arca/collector.rb

@@ -4,35 +4,22 @@ module Arca
   # about how callbacks are being used.
   module Collector
 
-    # Error raised if Arca.model_root_path is nil.
-    class ModelRootPathRequired < StandardError; end
-
     # Internal: Regular expression used for extracting the file path and line
     # number from a caller line.
-    ARCA_LINE_PARSER_REGEXP = /\A(.+)\:(\d+)\:in\s(.+)\z/
-    private_constant :ARCA_LINE_PARSER_REGEXP
+    ARCA_CALLBACK_FINDER_REGEXP = /\A(.+)\:(\d+)\:in\s`.+'\z/
+    private_constant :ARCA_CALLBACK_FINDER_REGEXP
 
     # Internal: Array of conditional symbols.
-    ARCA_CONDITIONALS = [:if, :unless]
+    ARCA_CONDITIONALS = [:if, :unless, :on]
     private_constant :ARCA_CONDITIONALS
 
     # http://ruby-doc.org/core-2.2.1/Module.html#method-i-included
     def self.included(base)
-      # Raise error if Arca.model_root_path is nil.
-      raise ModelRootPathRequired if Arca.model_root_path.nil?
-
-      # Get the file path to the model class that included the collector.
-      model_file_path, = caller[0].partition(":")
-
       base.class_eval do
-        # Define :arca_callback_data for storing the data we collect.
-        define_singleton_method :arca_callback_data do
-          @callbacks ||= {}
+        define_singleton_method(:arca_callback_data) do
+          @arca_callback_data ||= Hash.new {|k,v| k[v] = [] }
         end
 
-        # Collect the model_file_path.
-        arca_callback_data[:model_file_path] = model_file_path
-
         # Find the callback methods defined on this class.
         callback_method_symbols = singleton_methods.grep /^(after|around|before)\_/
 
@@ -42,23 +29,32 @@ module Arca
 
           # Redefine the callback method so that data can be collected each time
           # the callback is used for this class.
-          define_singleton_method(callback_method.name) do |*args|
+          define_singleton_method(callback_method.name) do |*args, &block|
             # Duplicate args before modifying.
             args_copy = args.dup
 
-            # Get the options hash from the end of the args Array if it exists.
-            options = args_copy.pop if args[-1].is_a?(Hash)
+            # Add target_symbol :block to args_copy if a block was given.
+            if block
+              args_copy << :block
+            else
+              # Get the options hash from the end of the args Array if it exists.
+              options = args_copy.pop if args[-1].is_a?(Hash)
+            end
+
+            # Get the callback file path and line number from the caller stack.
+            callback_file_path, callback_line_number = ARCA_CALLBACK_FINDER_REGEXP.match(caller.first)[1..2]
+
+            # Extract the model file path from the caller stack.
+            caller.each do |line|
+              if match = /\A(.+):\d+:in\s`<class:#{name.split("::").last}>'/.match(line)
+                self.arca_callback_data[:model_file_path] = match[1]
+                break
+              end
+            end
 
             # Iterate through the rest of the args. Each remaining arguement is
             # a Symbol representing the callback target method.
             args_copy.each do |target_symbol|
-
-              # Find the caller line where the callback is used.
-              line = caller.find {|line| line =~ /#{Regexp.escape(Arca.model_root_path)}/ }
-
-              # Parse the line in order to extract the file path and line number.
-              callback_line_matches     = line.match(ARCA_LINE_PARSER_REGEXP)
-
               # Find the conditional symbol if it exists in the options hash.
               conditional_symbol = ARCA_CONDITIONALS.
                 find {|conditional| options && options.has_key?(conditional) }
@@ -76,8 +72,8 @@ module Arca
               # this callback_symbol.
               arca_callback_data[callback_symbol] << {
                 :callback_symbol                => callback_symbol,
-                :callback_file_path             => callback_line_matches[1],
-                :callback_line_number           => callback_line_matches[2].to_i,
+                :callback_file_path             => callback_file_path,
+                :callback_line_number           => callback_line_number.to_i,
                 :target_symbol                  => target_symbol,
                 :conditional_symbol             => conditional_symbol,
                 :conditional_target_symbol      => conditional_target_symbol
@@ -86,7 +82,7 @@ module Arca
             end
 
             # Bind the callback method to self and call it with args.
-            callback_method.bind(self).call(*args)
+            callback_method.bind(self).call(*args, &block)
           end
         end
       end

data/lib/arca/report.rb

@@ -1,5 +1,8 @@
+require "forwardable"
+
 module Arca
   class Report
+    extend Forwardable
 
     # Arca::Report takes an Arca::Model and compiles the analyzed callback data
     # into a short overview report for the model.
@@ -51,8 +54,8 @@ module Arca
       number_of_unique_conditionals(model.analyzed_callbacks_array)
     end
 
-    delegate :lines_between_count, :external_callbacks_count,
-      :external_targets_count, :external_conditionals_count, :to => :model
+    def_delegators :model, :lines_between_count, :external_callbacks_count,
+      :external_targets_count, :external_conditionals_count
 
     # Public: Integer representing the possible number of permutations stemming
     # from conditionals for an instance of the model being reported during the

data/lib/arca.rb

@@ -20,7 +20,7 @@ module Arca
     Arca::Model.new(klass)
   end
 
-  # Public: (optional) Writer method for configuring the root path of the
+  # Public: Writer method for configuring the root path of the
   # project where  Arca is being used. Setting Arca.root_path will makes
   # inspecting analyzed callbacks easier by shortening absolute paths to
   # relative paths.
@@ -32,19 +32,7 @@ module Arca
 
   # Public: String representing the root path for the project.
   def self.root_path
-    @root_path
-  end
-
-  # Public: (required) Writer method for configuring the root path to the models
-  # for the project where Arca is being used. This path is required by the
-  # Arca::Collector for finding the correct line in the caller Array.
-  def self.model_root_path=(path)
-    @model_root_path = path.to_s
-  end
-
-  # Public: String representing the path to the models for the project.
-  def self.model_root_path
-    @model_root_path
+    @root_path ||= Dir.pwd
   end
 
   # Public: Helper method for turning absolute paths into relative paths.
@@ -55,8 +43,8 @@ module Arca
   def self.relative_path(path)
     return if path.nil?
 
-    if @root_path
-      path.sub(/^#{Regexp.escape(@root_path) || ""}\//, "")
+    if root_path
+      path.sub(/^#{Regexp.escape(root_path) || ""}\//, "")
     else
       path
     end

data/test/fixtures/announcements.rb

@@ -1,6 +1,7 @@
 module Announcements
   def self.included(base)
     base.class_eval do
+      before_save { puts "pre-save announcement callback" }
       after_save :announce_save
     end
   end

data/test/fixtures/ticket.rb

@@ -1,5 +1,4 @@
 class Ticket < ActiveRecord::Base
-  include Arca::Collector
   include Announcements
 
   before_save :set_title, :set_body

data/test/lib/arca/callback_analysis_test.rb

@@ -84,9 +84,9 @@ class Arca::CallbackAnalysisTest < Minitest::Test
   end
 
   def test_target_line_number
-    assert_equal 8, announce_save.target_line_number
-    assert_equal 8, set_title.target_line_number
-    assert_equal 16, upcase_title.target_line_number
+    assert_equal 9, announce_save.target_line_number
+    assert_equal 7, set_title.target_line_number
+    assert_equal 15, upcase_title.target_line_number
   end
 
   def test_external_target?
@@ -96,9 +96,9 @@ class Arca::CallbackAnalysisTest < Minitest::Test
   end
 
   def test_lines_to_target
-    assert_equal 4, announce_save.lines_to_target
-    assert_equal 3, set_title.lines_to_target
-    assert_equal 10, upcase_title.lines_to_target
+    assert_equal 5, announce_save.lines_to_target
+    assert_equal 2, set_title.lines_to_target
+    assert_equal 9, upcase_title.lines_to_target
   end
 
   def test_conditional_symbol
@@ -122,12 +122,12 @@ class Arca::CallbackAnalysisTest < Minitest::Test
   def test_conditional_target_line_number
     assert_nil announce_save.conditional_target_line_number
     assert_nil set_title.conditional_target_line_number
-    assert_equal 20, upcase_title.conditional_target_line_number
+    assert_equal 19, upcase_title.conditional_target_line_number
   end
 
   def test_lines_to_conditional_target
     assert_nil announce_save.lines_to_conditional_target
     assert_nil set_title.lines_to_conditional_target
-    assert_equal 14, upcase_title.lines_to_conditional_target
+    assert_equal 13, upcase_title.lines_to_conditional_target
   end
 end

data/test/lib/arca/collector_test.rb

@@ -3,51 +3,50 @@ require_relative "../../test_helper"
 class Arca::CollectorTest < Minitest::Test
   def test_collects_callback_data
     callbacks = Ticket.arca_callback_data
+    assert_equal 1, callbacks[:after_save].size
+    assert_equal 4, callbacks[:before_save].size
 
     callback = callbacks[:after_save][0]
     assert_equal :after_save, callback[:callback_symbol]
     assert_match "test/fixtures/announcements.rb", callback[:callback_file_path]
-    assert_equal 4, callback[:callback_line_number]
+    assert_equal 5, callback[:callback_line_number]
     assert_equal :announce_save, callback[:target_symbol]
     assert_nil callback[:conditional_symbol]
     assert_nil callback[:conditional_target_symbol]
 
     callback = callbacks[:before_save][0]
     assert_equal :before_save, callback[:callback_symbol]
+    assert_match "test/fixtures/announcements.rb", callback[:callback_file_path]
+    assert_equal 4, callback[:callback_line_number]
+    assert_equal :block, callback[:target_symbol]
+    assert_nil callback[:conditional_symbol]
+    assert_nil callback[:conditional_target_symbol]
+
+    callback = callbacks[:before_save][1]
+    assert_equal :before_save, callback[:callback_symbol]
     assert_match "test/fixtures/ticket.rb", callback[:callback_file_path]
-    assert_equal 5, callback[:callback_line_number]
+    assert_equal 4, callback[:callback_line_number]
     assert_equal :set_title, callback[:target_symbol]
     assert_nil callback[:conditional_symbol]
     assert_nil callback[:conditional_target_symbol]
 
-    callback = callbacks[:before_save][1]
+    callback = callbacks[:before_save][2]
     assert_equal :before_save, callback[:callback_symbol]
     assert_match "test/fixtures/ticket.rb", callback[:callback_file_path]
-    assert_equal 5, callback[:callback_line_number]
+    assert_equal 4, callback[:callback_line_number]
     assert_equal :set_body, callback[:target_symbol]
     assert_nil callback[:conditional_symbol]
     assert_nil callback[:conditional_target_symbol]
 
-    callback = callbacks[:before_save][2]
+    callback = callbacks[:before_save][3]
     assert_equal :before_save, callback[:callback_symbol]
     assert_match "test/fixtures/ticket.rb", callback[:callback_file_path]
-    assert_equal 6, callback[:callback_line_number]
+    assert_equal 5, callback[:callback_line_number]
     assert_equal :upcase_title, callback[:target_symbol]
     assert_equal :if, callback[:conditional_symbol]
     assert_equal :title_is_a_shout?, callback[:conditional_target_symbol]
   end
 
-  def test_arca_model_root_path_is_required
-    model_root_path = Arca.model_root_path
-    Arca.instance_variable_set(:@model_root_path, nil)
-
-    assert_raises(Arca::Collector::ModelRootPathRequired) do
-      require_relative "../../fixtures/bar"
-    end
-
-    Arca.model_root_path = model_root_path
-  end
-
   def test_callback_is_reapplied_with_original_args
     foo = Foo.new
     refute       foo.boop?

data/test/lib/arca/model_test.rb

@@ -12,7 +12,7 @@ class Arca::ModelTest < Minitest::Test
   def test_source_location
     source_location = model.source_location(:set_title)
     assert_match "test/fixtures/ticket.rb", source_location[:file_path]
-    assert_equal 8, source_location[:line_number]
+    assert_equal 7, source_location[:line_number]
   end
 
   def test_source_location_with_method_symbol_with_no_associated_method
@@ -28,25 +28,25 @@ class Arca::ModelTest < Minitest::Test
   end
 
   def test_analyzed_callbacks
-    assert_equal 3, model.analyzed_callbacks[:before_save].size
+    assert_equal 4, model.analyzed_callbacks[:before_save].size
     assert_equal 1, model.analyzed_callbacks[:after_save].size
   end
 
   def test_analyzed_callbacks_array
-    assert_equal 4, model.analyzed_callbacks_array.size
+    assert_equal 5, model.analyzed_callbacks_array.size
     assert model.analyzed_callbacks_array[0].is_a?(Arca::CallbackAnalysis)
   end
 
   def test_analyzed_callbacks_count
-    assert_equal 4, model.analyzed_callbacks_count
+    assert_equal 5, model.analyzed_callbacks_count
   end
 
   def test_lines_between_count
-    assert_equal 6, model.lines_between_count
+    assert_equal 5, model.lines_between_count
   end
 
   def test_external_callbacks_count
-    assert_equal 1, model.external_callbacks_count
+    assert_equal 2, model.external_callbacks_count
   end
 
   def test_external_targets_count

data/test/test_helper.rb

@@ -1,10 +1,11 @@
 $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 require "active_record"
 require "minitest/autorun"
-
 require "arca"
-Arca.root_path = `pwd`.chomp
-Arca.model_root_path = Arca.root_path + "/test/fixtures"
+
+class ActiveRecord::Base
+  include Arca::Collector
+end
 
 require_relative "fixtures/announcements"
 require_relative "fixtures/ticket"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arca
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jonathan Hoyt
@@ -70,7 +70,6 @@ files:
 - lib/arca/model.rb
 - lib/arca/report.rb
 - test/fixtures/announcements.rb
-- test/fixtures/bar.rb
 - test/fixtures/foo.rb
 - test/fixtures/ticket.rb
 - test/lib/arca/callback_analysis_test.rb
@@ -105,7 +104,6 @@ specification_version: 4
 summary: ActiveRecord callback analyzer
 test_files:
 - test/fixtures/announcements.rb
-- test/fixtures/bar.rb
 - test/fixtures/foo.rb
 - test/fixtures/ticket.rb
 - test/lib/arca/callback_analysis_test.rb

data/test/fixtures/bar.rb

@@ -1,3 +0,0 @@
-class Bar < ActiveRecord::Base
-  include Arca::Collector
-end