poof 0.0.0.dev

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b06203891a68ed6a363e5bc896d4afa8efad1c4
+  data.tar.gz: dc4fedf4fe3582d90bf95bace3b401e760d583ef
+SHA512:
+  metadata.gz: c8f27ea89c66c1d1c0245469188e0a69f1e63351c2e4a4ffb1aa18a8a0b566b794a5393656d35438d4d9f104f7572fdaf2d96f50d0c8951519fdad0f2d11e245
+  data.tar.gz: b93b03274ac93140f7d60eae7f98caec24aa15426448394898033e39fac92af43e7d700eaf6d76ec282f31f8c429bc13deb6cff6181a35d49663751454f99a5a

data/.gitignore

@@ -0,0 +1,23 @@
+### Ruby template
+*.gem
+*.rbc
+/coverage/
+/spec/reports/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+.idea/
+
+## Gemfile for development
+#Gemfile
+#Gemfile.lock
+
+## Stupid OSX cruft
+.DS_Store

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gem 'simplecov', :require => false, :group => :test           # MIT https://github.com/colszowka/simplecov/blob/master/MIT-LICENSE
+gem 'yard'                                                    # MIT https://github.com/lsegal/yard/blob/master/LICENSE + Ruby license for one file from the Ruby source lib/parser/ruby/legacy/ruby_lex.rb
+gem 'rspec'                                                   # MIT https://github.com/rspec/rspec/blob/master/License.txt
+gem 'byebug'
+gem "activerecord", ">= 4.1.5"                                # MIT https://github.com/rails/rails/blob/master/activerecord/MIT-LICENSE

data/Gemfile.lock

@@ -0,0 +1,58 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.1.7)
+      activesupport (= 4.1.7)
+      builder (~> 3.1)
+    activerecord (4.1.7)
+      activemodel (= 4.1.7)
+      activesupport (= 4.1.7)
+      arel (~> 5.0.0)
+    activesupport (4.1.7)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    byebug (4.0.5)
+      columnize (= 0.9.0)
+    columnize (0.9.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    i18n (0.7.0)
+    json (1.8.2)
+    minitest (5.4.3)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 4.1.5)
+  byebug
+  rspec
+  simplecov
+  yard

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Mattermark
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,3 @@
+[![Circle CI](https://circleci.com/gh/Referly/poof.svg?style=svg)](https://circleci.com/gh/Referly/poof)
+# poof
+poof Ruby Gem - a gem for cleaning up test ActiveRecord instances

data/Rakefile

@@ -0,0 +1,10 @@
+require "rake"
+require 'rspec/core/rake_task'
+
+task default: [:spec] do
+  ENV['RACK_ENV'] = 'test'
+end
+
+task :spec do
+  RSpec::Core::RakeTask.new(:spec)
+end

data/circle.yml

@@ -0,0 +1,9 @@
+machine:
+
+  timezone:
+    America/Los_Angeles # Set the timezone
+
+  # Version of ruby to use
+  ruby:
+    version:
+      2.1.3

data/lib/poof.rb

@@ -0,0 +1,137 @@
+require 'active_support/callbacks'
+module Poof
+
+  # This module is what should be included into the RSpec config so that poof! is available
+  # within specs.
+  module Syntax
+    def poof!(entity)
+      Magic.poof! entity
+    end
+  end
+
+  class Magic
+    # This method acts provides a monotonically increasing integer value
+    # As an example if you wanted to make ten companies and didn't want arbitrary names
+    # you could start all of them with the same string and prepend the next_safe_key
+    # to the domain, ensuring the possibility of uniqueness for the test
+    #
+    # @return [Integer] the next safe key that can be used to avoid unique key collisions
+    def self.next_safe_key
+      @next_safe_key ||= 1
+      @next_safe_key += 1
+    end
+
+    # Get the first item in the container
+    #
+    # @return [Object] the first item in the container
+    def self.get_first
+      @container ||= Array.new
+      first = @container.first if @container.length > 0
+      first ||= nil
+    end
+
+    # Get the last item in the container
+    #
+    # @return [Object] the last item in the container
+    def self.get_last
+      @container ||= Array.new
+      last = @container.last if @container.length > 0
+      last ||= nil
+    end
+
+    # Get an object matching the description of its factory that is tracked by the container
+    # for later reference or teardown
+    #
+    # @param factory_name [Symbol] the name of the factory you want the container to use
+    # @param attributes [Hash] hash where keys are attribute names and values are attribute values
+    # @return [Object] the instance generated for the factory you requested
+    def self.get(factory_name, attributes = {})
+      @container ||= Array.new
+      e = FactoryGirl.create(factory_name, attributes)
+      @container << e
+      e
+    end
+
+    # Invoking this method will cause the argument entity to be really_destroy!'d or destroy!'d on next cleanup
+    #
+    # @param entity [Model] the model entity that should be lazily destroyed
+    # @param [Model] the entity that was passed as an argument is returned
+    def self.poof!(entity)
+      @hit_list ||= Array.new
+      @hit_list << entity
+      entity
+    end
+
+    # This method applies any coercion in the factory's class that would normally occur
+    # when getting an instance's attribute (for AR objects this is like calling foo.bar
+    # as opposed to foo.read_attribute :bar)
+    #
+    # @param factory_name [Symbol] the name of the factory that should be used for coercing the attribute
+    # @param attribute_name [Symbol] the name of attribute that needs to called on the instance created by the factory
+    # @return [Object] the resulting value of calling the instance's method having the name of attribute_name's value
+    def self.get_attribute(factory_name, attribute_name)
+      e = self.get factory_name
+      e.send attribute_name
+    end
+
+    # This is the general teardown method, it removes any check_orm's that have been applied
+    # to any class for which the container has generated instances, and then it attempts to delete
+    # (using hard deletes when possible) all of the instances it created
+    def self.cleanup
+      @container ||= Array.new
+      @container.each do |dependency|
+        disable_check_orm(dependency.class)
+        teardown_method = :really_destroy! if dependency.respond_to? :really_destroy!
+        teardown_method ||= :destroy!
+        dependency.send(teardown_method)
+      end
+      @hit_list ||= Array.new
+      @hit_list.each do |trash|
+        disable_check_orm(trash.class)
+        teardown_method = :really_destroy! if trash.respond_to? :really_destroy!
+        teardown_method ||= :destroy!
+        trash.send(teardown_method)
+      end
+    end
+
+    # Selectively targets check_orm_xxx callbacks to be disabled (skipped) in the callback chains
+    #
+    # @param klasses [Class, Symbol, Array<Class, Symbol>] A Class, Symbol representing a factory_girl factory, or an array Classes or Symbols
+    # @param events_to_disable [Symbol, Array] A symbol or array of Symbols that define which kind of callbacks to disable
+    def disable_check_orm(klasses, events_to_disable = [:create, :update, :destroy])
+      if klasses.is_a? Array
+        klasses.map { |klass| disable_check_orm klass, events_to_disable }
+      else
+        klass = klasses
+        if events_to_disable.is_a? Array
+          events_to_disable.map { |event| disable_check_orm klass, event }
+        else
+          event_to_disable = events_to_disable
+          # Allow the user to pass a symbol instead of a class and instantiate it using the factory
+          # might want to switch to using .new instead, but then you have to figure out how to locate
+          # the klasses modularized name from just a symbol representing the class
+          if klass.is_a? Symbol
+            klass = build(klass).class
+          end
+          # The name of the actual callback method for destroy is check_orm_delete/check_orm_delete_derived, so need to attach properly
+          callback_suffix = :delete if event_to_disable == :destroy
+          callback_suffix ||= event_to_disable
+          # Get the array of registered check_orm_xxx callbacks from the main authorizer on klass
+          registered_check_orm_callbacks = klass.registered_check_orm_callbacks if klass.respond_to? :registered_check_orm_callbacks
+          registered_check_orm_callbacks ||= []
+          # callbacks_to_skip refers to which callbacks should get passed to the skip_callback method (these are the callbacks that should be effectively disabled)
+          callbacks_to_skip = registered_check_orm_callbacks.select { |cb| cb.to_s.include? callback_suffix.to_s }
+          callbacks_to_skip ||= []
+          callbacks_to_skip.map { |cb| klass.skip_callback(event_to_disable, :before, cb) }
+        end
+      end
+    end
+
+    class << self
+      alias_method :start, :cleanup
+      alias_method :restart, :cleanup
+      alias_method :new_context, :cleanup
+      alias_method :end, :cleanup
+    end
+  end
+end

data/poof.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name        = 'poof'
+  s.version     = '0.0.0.dev'
+  s.date        = '2015-05-08'
+  s.summary     = "Automatically cleanup and destroy ActiveRecord objects created during tests."
+  s.description = "An alternative to DatabaseCleaner for automatically ensuring that objects created during
+                  tests are removed from the database."
+  s.authors     = ["Courtland Caldwell"]
+  s.email       = 'courtland@mattermark.com'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.homepage    =
+      'https://github.com/Referly/poof'
+  s.add_runtime_dependency "activerecord", "~> 4.1", ">= 4.1.5"
+  s.add_development_dependency "rake", "~> 10.3"
+  s.add_development_dependency "simplecov", "~> 0.10"
+  s.add_development_dependency "yard", "~> 0.8"
+  s.add_development_dependency "rspec", "~> 3.2"
+  s.add_development_dependency "byebug", "~> 4.0"
+  s.license     = "MIT"
+end

data/simplecov_custom_profiles.rb

@@ -0,0 +1,4 @@
+require 'simplecov'
+SimpleCov.profiles.define 'poof' do
+  add_filter '/spec'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require_relative '../simplecov_custom_profiles'
+SimpleCov.start 'poof'
+require 'rspec/support/spec'
+require 'byebug'
+require 'poof'

data/spec/syntax_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Poof::Syntax do
+
+  context 'when mixed into the Rspec configuration' do
+
+    before do
+
+      RSpec.configure do |conf|
+        conf.include described_class
+      end
+    end
+
+    subject do
+
+      RSpec.describe 'test example' do
+
+        let(:record) { double('ActiveRecord Instance') }
+
+        it 'responds to poof!' do
+          expect(Poof::Magic).to receive(:poof!).with(record).once
+          expect { poof! record }.to_not raise_error
+        end
+      end
+    end
+
+    it 'exposes the public API to Rspec examples' do
+      subject
+    end
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: poof
+version: !ruby/object:Gem::Version
+  version: 0.0.0.dev
+platform: ruby
+authors:
+- Courtland Caldwell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.5
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: |-
+  An alternative to DatabaseCleaner for automatically ensuring that objects created during
+                    tests are removed from the database.
+email: courtland@mattermark.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- circle.yml
+- lib/poof.rb
+- poof.gemspec
+- simplecov_custom_profiles.rb
+- spec/spec_helper.rb
+- spec/syntax_spec.rb
+homepage: https://github.com/Referly/poof
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Automatically cleanup and destroy ActiveRecord objects created during tests.
+test_files:
+- spec/spec_helper.rb
+- spec/syntax_spec.rb
+has_rdoc: