arca 2.1.2 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f324cf6265322de192ab2ffbe195da012723177
-  data.tar.gz: 2162c33d3bcfea839dcd6668d309176c970bd53f
+  metadata.gz: 1becb49c860d2d307b0a29e91a2d93e0bfe86845
+  data.tar.gz: b230fe2a8c7d72fc0d84767de6546d67ea707426
 SHA512:
-  metadata.gz: 7486c93a707e646e8329bf59f074d4ab47a76d2deed9efc3e5a3f9440ae78ad592118097677b5b5a5c15cccc433dfdcd34b474a58971ec4b9ca54704d0d3fcf2
-  data.tar.gz: 687bea23e7d21d3ab9cf533be2f91bd94b9598dfbfadb150f497b2dced75306b87fdfb0b842ca34370e67d227bd358d793a7c63c17dabc94b29d846dbcfa8f38
+  metadata.gz: fc86642a2abba3e45f437b4607ab54e775a009ea35611202907a3af1d7da8a59fc0fadc110467a5c66ce080f6133e9e409071c50c34254d1fa4d2611392f3777
+  data.tar.gz: bd855300d7bc35f2d5029ec4749cf72572f626a675402f4af92d759b81bb5821cf8b3fca86b1675fa59cb3cfd6afc8d38e52a192a68031a11096867e160094b2

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+gemfile:
+  - gemfiles/Gemfile_activerecord-3.2
+  - gemfiles/Gemfile_activerecord-4.2
+cache: bundler

data/README.md

@@ -1,12 +1,20 @@
 # ActiveRecord Callback Analyzer
 
-Arca is a callback analyzer for ActiveRecord like models ideally suited for digging yourself out of callback hell. Arca helps you answer questions like:
+Arca is a callback analyzer for ActiveRecord models ideally suited for digging yourself out of callback hell. At best it will help you move towards a [more maintainable design](http://adequate.io/culling-the-activerecord-lifecycle) and at worst it can be used in your test suite to give you feedback when callbacks change.
+
+Arca helps you answer questions like:
 
 * how spread out callbacks are for each model
-* how many callbacks use conditionals (`:if` and `:unless`)
+* how many callbacks use conditionals (`:if`, `:unless`, and `:on`)
 * how many possible permutations exist per callback type (`:commit`, `:create`, `:destroy`, `:find`, `:initialize`, `:rollback`, `:save`, `:touch`, `:update`, `:validation`) taking conditionals into consideration
 
-The Arca library has two main components, the collector and the reporter. Include the collector module in each ActiveRecord model you want to analyze and then use the reporter to analyze and present the data.
+The Arca library has two main components, the collector and the reporter. Include the collector module in ActiveRecord::Base before your models are loaded.
+
+## Requirements
+
+![travis-ci build status](https://travis-ci.org/jonmagic/arca.svg)
+
+Arca is tested against ActiveRecord 3.2 and 4.2 running on Ruby 1.9.3, 2.0.0, 2.1.0, and 2.2.0.
 
 ## Usage
 
@@ -19,11 +27,14 @@ gem 'arca'
 In your test helper (`test/test_helper.rb` for example) require the Arca library and include the `Arca::Collector` in `ActiveRecord::Base`.
 
 ```
+require "active_record"
 require "arca"
 
 class ActiveRecord::Base
   include Arca::Collector
 end
+
+# load your app
 ```
 
 In this example the `Annoucements` module is included in `Ticket` and defines it's own callback.
@@ -71,8 +82,6 @@ end
 Use `Arca[Ticket].report` to analyze the callbacks for the `Ticket` class.
 
 ```ruby
-> Arca.root_path = `pwd`.chomp
-=> "/Users/jonmagic/Projects/arca"
 > Arca[Ticket].report
 {
                    :model_name => "Ticket",
@@ -85,6 +94,11 @@ Use `Arca[Ticket].report` to analyze the callbacks for the `Ticket` class.
   :external_conditionals_count => 0,
       :calculated_permutations => 2
 }
+```
+
+Try out `Arca[Ticket].analyzed_callbacks` to see where and how each callback works and the order they run in.
+
+```ruby
 > Arca[Ticket].analyzed_callbacks
 {
   :before_save => [
@@ -162,6 +176,42 @@ Use `Arca[Ticket].report` to analyze the callbacks for the `Ticket` class.
 }
 ```
 
+I'm working [on a project](https://help.github.com/enterprise/2.3/admin/guides/migrations/) at [GitHub](https://github.com) that feels pain when callback behavior changes so I decided to build this tool to help us manage change better and hopefully in the long run move away from ActiveRecord callbacks for most things.
+
+For the first iteration I am hoping to use this tool in a set of model lint tests that break when callback behavior changes.
+
+```ruby
+  def assert_equal(expected, actual)
+    super(expected, actual, ARCA_FAILURE_MESSAGE)
+  end
+
+  def test_foo
+    report = Arca[Foo].report
+    expected = {
+      :model_name                  => "Foo",
+      :model_file_path             => "app/models/foo.rb",
+      :callbacks_count             => 30,
+      :conditionals_count          => 3,
+      :lines_between_count         => 1026,
+      :external_callbacks_count    => 12,
+      :external_targets_count      => 3,
+      :external_conditionals_count => 2,
+      :calculated_permutations     => 11
+    }
+
+    assert_equal expected, report.to_hash
+  end
+  ```
+
+  When change happens and that test fails it outputs a helpful error message.
+
+```
+---------------------------------------------
+Please /cc @github/migration on the PR if you
+have to update this test to make it pass.
+---------------------------------------------
+```
+
 ## License
 
 The MIT License (MIT)

data/arca.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "arca"
-  spec.version       = "2.1.2"
+  spec.version       = "2.1.3"
   spec.date          = "2015-08-07"
   spec.summary       = "ActiveRecord callback analyzer"
   spec.description   = "Arca is a callback analyzer for ActiveRecord ideally suited for digging yourself out of callback hell"
@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/jonmagic/arca"
   spec.license       = "MIT"
 
-  spec.add_development_dependency "active_record", "~> 4.2"
+  spec.add_development_dependency "activerecord",  "~> 4.2"
   spec.add_development_dependency "minitest",      "~> 5.7"
   spec.add_development_dependency "pry",           "~> 0.10"
   spec.add_development_dependency "rake",          "~> 10.4"

data/gemfiles/Gemfile_activerecord-3.2

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.2"
+gem "minitest",     "~> 5.7"
+gem "rake",         "~> 10.4"

data/gemfiles/Gemfile_activerecord-4.2

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.2"
+gem "minitest",     "~> 5.7"
+gem "rake",         "~> 10.4"

data/lib/arca/callback_analysis.rb

@@ -10,7 +10,7 @@ module Arca
     #
     # model         - Arca::Model instance.
     # callback_data - Hash with callback data collected by Arca::Collector.
-    def initialize(model:, callback_data:)
+    def initialize(model, callback_data)
       @model                     = model
       @callback_symbol           = callback_data.fetch(:callback_symbol)
       @callback_file_path        = callback_data.fetch(:callback_file_path)

data/lib/arca/model.rb

@@ -64,10 +64,7 @@ module Arca
       @analyzed_callbacks ||= CALLBACKS.inject({}) do |result, callback_symbol|
         Array(callbacks[callback_symbol]).each do |callback_data|
           result[callback_symbol] ||= []
-          callback_analysis = CallbackAnalysis.new({
-            :model         => self,
-            :callback_data => callback_data
-          })
+          callback_analysis = CallbackAnalysis.new(self, callback_data)
 
           unless callback_analysis.target_file_path_active_record?
             result[callback_symbol] << callback_analysis

data/test/lib/arca/callback_analysis_test.rb

@@ -6,44 +6,35 @@ class Arca::CallbackAnalysisTest < Minitest::Test
   end
 
   def announce_save
-    @announce_save ||= Arca::CallbackAnalysis.new({
-      :model => model,
-      :callback_data => {
-        :callback_symbol => :after_save,
-        :callback_file_path => "/Users/jonmagic/Projects/arca/test/fixtures/announcements.rb",
-        :callback_line_number => 4,
-        :target_symbol => :announce_save,
-        :conditional_symbol => nil,
-        :conditional_target_symbol => nil
-      }
+    @announce_save ||= Arca::CallbackAnalysis.new(model, {
+      :callback_symbol => :after_save,
+      :callback_file_path => "#{Arca.root_path}/test/fixtures/announcements.rb",
+      :callback_line_number => 4,
+      :target_symbol => :announce_save,
+      :conditional_symbol => nil,
+      :conditional_target_symbol => nil
     })
   end
 
   def set_title
-    @set_title ||= Arca::CallbackAnalysis.new({
-      :model => model,
-      :callback_data => {
-        :callback_symbol=>:before_save,
-        :callback_file_path => "/Users/jonmagic/Projects/arca/test/fixtures/ticket.rb",
-        :callback_line_number => 5,
-        :target_symbol => :set_title,
-        :conditional_symbol => nil,
-        :conditional_target_symbol => nil
-      }
+    @set_title ||= Arca::CallbackAnalysis.new(model, {
+      :callback_symbol=>:before_save,
+      :callback_file_path => "#{Arca.root_path}/test/fixtures/ticket.rb",
+      :callback_line_number => 5,
+      :target_symbol => :set_title,
+      :conditional_symbol => nil,
+      :conditional_target_symbol => nil
     })
   end
 
   def upcase_title
-    @upcase_title ||= Arca::CallbackAnalysis.new({
-      :model => model,
-      :callback_data => {
-        :callback_symbol => :before_save,
-        :callback_file_path => "/Users/jonmagic/Projects/arca/test/fixtures/ticket.rb",
-        :callback_line_number => 6,
-        :target_symbol => :upcase_title,
-        :conditional_symbol => :if,
-        :conditional_target_symbol => :title_is_a_shout?
-      }
+    @upcase_title ||= Arca::CallbackAnalysis.new(model, {
+      :callback_symbol => :before_save,
+      :callback_file_path => "#{Arca.root_path}/test/fixtures/ticket.rb",
+      :callback_line_number => 6,
+      :target_symbol => :upcase_title,
+      :conditional_symbol => :if,
+      :conditional_target_symbol => :title_is_a_shout?
     })
   end
 

data/test/test_helper.rb

@@ -4,7 +4,10 @@ require "minitest/autorun"
 require "arca"
 
 class ActiveRecord::Base
-  self.raise_in_transactional_callbacks = true
+  if respond_to?(:raise_in_transactional_callbacks)
+    self.raise_in_transactional_callbacks = true
+  end
+
   include Arca::Collector
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arca
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.3
 platform: ruby
 authors:
 - Jonathan Hoyt
@@ -11,7 +11,7 @@ cert_chain: []
 date: 2015-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: active_record
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -73,11 +73,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - arca.gemspec
+- gemfiles/Gemfile_activerecord-3.2
+- gemfiles/Gemfile_activerecord-4.2
 - lib/arca.rb
 - lib/arca/callback_analysis.rb
 - lib/arca/collector.rb

data/Gemfile.lock

@@ -1,26 +0,0 @@
-PATH
-  remote: .
-  specs:
-    arca (1.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    coderay (1.1.0)
-    method_source (0.8.2)
-    minitest (5.7.0)
-    pry (0.10.1)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rake (10.4.2)
-    slop (3.5.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  arca!
-  minitest (~> 5.7)
-  pry (~> 0.10.1)
-  rake (~> 10.4)