ar_left_over_guardian 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d751711240250e9e26a880c0df29a57011ee837
-  data.tar.gz: 909e6714aab80a46565b4d840f49371956f489b4
+  metadata.gz: 7bd41421d24e0733bc844c0f22c975c3844041b4
+  data.tar.gz: 7fe50c1c7b834dc750e3097ea1c544f17db27648
 SHA512:
-  metadata.gz: 17490e66bf5ac59a56eee3c3cbcfc34d055f815b352dda9e930d5372dd8b685db72253063d67a51afe7d189db139a177c5832c543715c5f79a3173d4dfd30202
-  data.tar.gz: 39948e4e1ba8daf578baac0dbedb3d1c76b4a81e0128db79793a80654aad8b3052897f8539665f09518b721bccfe0b46a33d3d447e70d34dce37e2e99c08f3e8
+  metadata.gz: a7113abaf02efa91c53f2d42548819ffc3d24a1a60fbbc3b4c232a1b23fac30b72a6d8f88c46f766fb0e537b63c1480527af317714f27d8f069c6bccb573ba81
+  data.tar.gz: 3124b5c9fd0839350d7ed3fae2af65697d35a15422cc4628c8d5a17932d9f832d1e46791ceadff1ac7a8c1f75ce741ac5167b2527b735294afee01d5af56b752

data/Gemfile

@@ -4,3 +4,9 @@ source 'https://rubygems.org'
 gemspec
 
 gem "rspec"
+
+group :development do
+  gem "contracts", github: "egonSchiele/contracts.ruby"
+  gem "yard"
+  gem "yard-contracts", github: "sfcgeorge/yard-contracts"
+end

data/ar_left_over_guardian.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "contracts-noop"
+
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
 end

data/lib/ar_left_over_guardian.rb

@@ -1,18 +1,31 @@
 require "ar_left_over_guardian/version"
+require "ar_left_over_guardian/custom_contracts"
 
+# Fails your test suite if tests doesn't clean up any database records
+# after itself. Assumes models have `.count` method.
 module ARLeftOverGuardian
-  def self.init(models)
-    Instance.new(models)
-  end
+  include Contracts
+  include CustomContracts
 
   class DidntCleanup < StandardError; end
 
+  # Instance of left over guardian, which keeps track of all models
+  # counts before test and after test, and expects them to be the same
   class Instance
+    include Contracts
+    include CustomContracts
+
+    # Creates new instance
+    Contract ArrayOf[Model] => self
     def initialize(models)
       @models = models.reject(&method(:abstract?))
       @counts = current_counts(false)
+      self
     end
 
+    # Verifies if counts before test and after are the same.
+    # @raise [DidntCleanup] When counts don't match
+    Contract None => nil
     def verify
       left_overs = get_left_overs
       return if left_overs.empty?
@@ -24,6 +37,7 @@ module ARLeftOverGuardian
 
     attr_reader :counts, :models
 
+    Contract None => ArrayOf[Model]
     def get_left_overs
       current_counts.each_with_index.inject([]) do |acc, (count, index)|
         if count != counts[index]
@@ -33,20 +47,30 @@ module ARLeftOverGuardian
       end
     end
 
+    Contract Bool => ArrayOf[Num]
     def current_counts(reset = true)
       models.map { |model|
         reset_model(model, reset).count
       }
     end
 
+    Contract Model => Bool
     def abstract?(model)
       model.respond_to?(:abstract_class?) && model.abstract_class?
     end
 
+    Contract Model, Bool => Model
     def reset_model(model, reset)
       return model unless reset
       RSpec::Mocks.space.proxy_for(model).reset if defined?(RSpec::Mocks)
       model
     end
   end
+
+  # Initializes instance of left over guardian with given list of
+  # models
+  Contract ArrayOf[Model] => Instance
+  def self.init(models)
+    Instance.new(models)
+  end
 end

data/lib/ar_left_over_guardian/custom_contracts.rb

@@ -0,0 +1,13 @@
+require "contracts/noop"
+
+Contracts::Noop.when_contracts_available do
+  puts "Running with contracts in development mode"
+end
+
+module ARLeftOverGuardian
+  module CustomContracts
+    include Contracts
+
+    Model = RespondTo[:count]
+  end
+end

data/lib/ar_left_over_guardian/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ar_left_over_guardian
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Alexey Fedorov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-24 00:00:00.000000000 Z
+date: 2015-03-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: contracts-noop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -55,6 +69,7 @@ files:
 - Rakefile
 - ar_left_over_guardian.gemspec
 - lib/ar_left_over_guardian.rb
+- lib/ar_left_over_guardian/custom_contracts.rb
 - lib/ar_left_over_guardian/version.rb
 - spec/ar_left_over_guardian_spec.rb
 - spec/spec_helper.rb
@@ -85,3 +100,4 @@ summary: Active Record Left Over Guardian.
 test_files:
 - spec/ar_left_over_guardian_spec.rb
 - spec/spec_helper.rb
+has_rdoc: