espinita 0.0.8 → 0.0.9

data/spec/models/models/general_model_spec.rb

@@ -20,14 +20,14 @@ describe GeneralModel do
 
     it "general auditable only method" do
       general_model.auditable only: [:name]
-      expect(general_model.permited_columns).to include("name")
-      expect(general_model.permited_columns.size).to eql 1
+      expect(general_model.permitted_columns).to include("name")
+      expect(general_model.permitted_columns.size).to eql 1
     end
 
     it "general auditable except method" do
       general_model.auditable except: [:name]
       expect(general_model.excluded_cols).to include("name")
-      expect(general_model.permited_columns).not_to include("name")
+      expect(general_model.permitted_columns).not_to include("name")
     end
   end
 
@@ -217,4 +217,220 @@ describe GeneralModel do
     end
   end
 
+  context "history_from_audits_for" do
+    before do
+      Timecop.freeze(Time.now.localtime)
+    end
+
+    after do
+      Timecop.return
+    end
+
+    let!(:later){ Time.now.localtime + 10.days }
+    let!(:even_later){ Time.now.localtime + 1.year }
+
+    let!(:general_model) do
+      [:create, :update, :destroy].each do |c|
+         GeneralModel.reset_callbacks(c)
+       end
+      GeneralModel.auditable on: [:update]
+      FactoryGirl.create(:general_model)
+    end
+
+    let!(:updated_model) do
+      general_model.update_attributes(name: "Foo", audit_comment: "Some comment" )
+      general_model
+    end
+
+    context "given a single column as an argument" do
+
+      it "should accept a symbol column name" do
+        expect(updated_model.history_from_audits_for(:name)).to eq([
+          {changes: {name:"Foo"}, changed_at: Time.now.localtime}
+        ])
+      end
+
+      it "should accept a string column name" do
+        expect(updated_model.history_from_audits_for("name")).to eq([
+          {changes: {name:"Foo"}, changed_at: Time.now.localtime}
+        ])
+      end
+
+      it "should handle multiple audits" do
+        Timecop.freeze(later) do
+          updated_model.update_attributes(name: "Baz", audit_comment: "Some comment" )
+        end
+        Timecop.freeze(even_later) do
+          updated_model.update_attributes(name: "Arglebargle", audit_comment: "Some comment" )
+        end
+        expect(updated_model.history_from_audits_for(:name)).to eq(
+          [
+            {changes: {name:"Arglebargle"}, changed_at: even_later},
+            {changes: {name:"Baz"}, changed_at: later},
+            {changes: {name:"Foo"}, changed_at: Time.now.localtime},
+          ]
+        )
+      end
+    end
+
+    context "for multiple specified columns" do
+
+      before do
+        Timecop.freeze(later) do
+          updated_model.update_attributes(name: "Baz", position: 42, audit_comment: "Some comment" )
+        end
+        Timecop.freeze(even_later) do
+          updated_model.update_attributes(name: "Arglebargle", settings: "Waffles", audit_comment: "Some comment" )
+        end
+      end
+
+      it "should return history including each specified column" do
+        expect(updated_model.history_from_audits_for([:name, :settings])).to eq(
+          [
+            {changes: {name: "Arglebargle", settings: "Waffles"}, changed_at: even_later},
+            {changes: {name: "Baz"}, changed_at: later},
+            {changes: {name: "Foo"}, changed_at: Time.now.localtime},
+          ]
+        )
+        expect(updated_model.history_from_audits_for([:position, :settings])).to eq(
+          [
+            {changes: {settings: "Waffles"}, changed_at: even_later},
+            {changes: {position: 42}, changed_at: later},
+          ]
+        )
+      end
+
+    end
+
+    it "should raise an error if the requested column does not exist" do
+      expect{ updated_model.history_from_audits_for(:waffles) }.to raise_error(ArgumentError)
+    end
+
+  end
+
+  context "restore_attributes!" do
+
+    let!(:general_model) do
+      [:create, :update, :destroy].each do |c|
+        GeneralModel.reset_callbacks(c)
+      end
+      GeneralModel.auditable on: [:update]
+      FactoryGirl.create(:general_model)
+    end
+
+    let!(:historical_model) do
+      recent = Time.now.localtime - 10.days
+      less_recent = Time.now.localtime - 50.days
+      ancient = Time.now.localtime - 1.year
+      # these timed changes must be made in reverse chrono order to make the audits work for testing
+      Timecop.freeze(ancient) do
+        general_model.update_attributes(name: "Walrus", position: 1, audit_comment: "Some comment" )
+      end
+      Timecop.freeze(less_recent) do
+        general_model.update_attributes(name: "Arglebargle", settings: "IHOP", position: 2, audit_comment: "Some comment" )
+      end
+      Timecop.freeze(recent) do
+        general_model.update_attributes(name: "Baz", settings: "", position: nil, audit_comment: "Some comment" )
+      end
+      general_model
+    end
+
+    context "given valid arguments" do
+
+      it "should restore a single property from a datetime" do
+        result = historical_model.restore_attributes!(:name, DateTime.now - 12.days)
+
+        expect(result).to be(true)
+        expect(historical_model.name).to eq("Arglebargle")
+      end
+
+      it "should restore multiple attributes from a datetime" do
+        result = historical_model.restore_attributes!([:name, :settings], DateTime.now - 57.days)
+
+        expect(result).to be(true)
+        expect(historical_model.name).to eq("Walrus")
+        expect(historical_model.settings).to eq("MyText")
+      end
+
+      it "should return false when no restoration change is performed" do
+        original = historical_model
+        result = historical_model.restore_attributes!(:settings, DateTime.now + 5.days)
+
+        expect(original).to match(historical_model)
+        expect(result).to be(false)
+      end
+
+    end
+
+    context "given invalid arguments" do
+
+      it "should raise when called with no arguments" do
+        expect{ historical_model.restore_attributes! }.to raise_error(ArgumentError)
+      end
+
+    end
+
+  end
+
+  context "restore_to_audit" do
+
+    let!(:general_model) do
+      [:create, :update, :destroy].each do |c|
+        GeneralModel.reset_callbacks(c)
+      end
+      GeneralModel.auditable on: [:update]
+      FactoryGirl.create(:general_model)
+    end
+
+    context "given valid arguments" do
+      it "should restore when given an audit id" do
+        original_model = general_model.dup
+
+        general_model.update_attributes(name: "Ringo", settings: "Walrus")
+        general_model.update_attributes(settings: "Walrus", position: 7)
+        general_model.update_attributes(name: "Ringo", position: 3)
+        general_model.restore_to_audit(general_model.audits.first.id)
+
+        expect(general_model.name).to eq(original_model.name)
+        expect(general_model.settings).to eq(original_model.settings)
+      end
+
+      it "should restore when given an audit record" do
+        original_model = general_model.dup
+
+        general_model.update_attributes(name: "Ringo", settings: "Walrus")
+        general_model.update_attributes(settings: "Walrus", position: 7)
+        general_model.update_attributes(name: "Ringo", position: 3)
+        general_model.restore_to_audit(general_model.audits.first.id)
+
+        expect(general_model.name).to eq(original_model.name)
+        expect(general_model.settings).to eq(original_model.settings)
+      end
+    end
+
+    context "given invalid arguments" do
+
+      let!(:other_model) do
+        other_model = general_model.dup
+        other_model.save
+        other_model.update_attributes(name: "Foo", settings: "Bar")
+        other_model
+      end
+
+      it "should raise when called with a valid audit id for a different model" do
+        expect{ general_model.restore_to_audit(other_model.audits.first.id) }.to raise_error
+      end
+
+      it "should raise when called with a valid audit record for a different model" do
+        expect{ general_model.restore_to_audit(other_model.audits.first) }.to raise_error
+      end
+
+      it "should raise when called with an invalid audit id" do
+        expect{ general_model.restore_to_audit(999999999) }.to raise_error
+      end
+
+    end
+
+  end
+
 end

data/spec/spec_helper.rb

@@ -6,12 +6,14 @@ ENV["RAILS_ENV"] ||= 'test'
 require File.expand_path("../../spec/dummy/config/environment", __FILE__)
 require 'rspec/rails'
 require 'rspec/autorun'
+require 'rspec/collection_matchers'
 
 require "factory_girl_rails"
 require "database_cleaner"
 require 'capybara'
 require 'capybara/rspec'
 require 'shoulda/matchers/integrations/rspec'
+require 'timecop'
 
 require "espinita"
 require 'support/schema'

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: espinita
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Miguel Michelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-03 00:00:00.000000000 Z
+date: 2015-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: request_store
   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: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: factory_girl_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-collection_matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -126,28 +126,42 @@ dependencies:
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Audit activerecord models like a boss
@@ -157,21 +171,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.md
+- Rakefile
 - app/models/espinita/audit.rb
 - config/database.yml
 - config/routes.rb
 - db/migrate/20131029200927_create_auditable_audits.rb
+- lib/espinita.rb
 - lib/espinita/auditor.rb
 - lib/espinita/auditor_behavior.rb
 - lib/espinita/auditor_request.rb
 - lib/espinita/engine.rb
 - lib/espinita/version.rb
-- lib/espinita.rb
 - lib/tasks/espinita_tasks.rake
-- MIT-LICENSE
-- Rakefile
-- README.md
 - spec/controllers/audits_controller_spec.rb
+- spec/dummy/README.rdoc
+- spec/dummy/Rakefile
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/javascripts/general_controller.js
 - spec/dummy/app/assets/stylesheets/application.css
@@ -186,6 +202,7 @@ files:
 - spec/dummy/bin/bundle
 - spec/dummy/bin/rails
 - spec/dummy/bin/rake
+- spec/dummy/config.ru
 - spec/dummy/config/application.rb
 - spec/dummy/config/boot.rb
 - spec/dummy/config/database.yml
@@ -202,7 +219,6 @@ files:
 - spec/dummy/config/initializers/wrap_parameters.rb
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
-- spec/dummy/config.ru
 - spec/dummy/db/migrate/20131029211126_create_general_models.rb
 - spec/dummy/db/migrate/20131030014901_create_users.rb
 - spec/dummy/db/schema.rb
@@ -211,8 +227,6 @@ files:
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
-- spec/dummy/Rakefile
-- spec/dummy/README.rdoc
 - spec/factories/auditable_audits.rb
 - spec/factories/general_models.rb
 - spec/factories/users.rb
@@ -231,17 +245,17 @@ 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: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Auditable Rails Engine.