secretary-rails 1.0.0.beta1

data/spec/lib/generators/secretary/install_generator_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'generator_spec/test_case'
+require 'generators/secretary/install_generator'
+
+describe Secretary::InstallGenerator do
+  include GeneratorSpec::TestCase
+  destination File.expand_path("../../../../tmp", __FILE__)
+
+  before do
+    prepare_destination
+    run_generator
+  end
+
+  it 'copies the migration file' do
+    assert_migration "db/migrate/create_versions"
+  end
+end

data/spec/lib/secretary/config_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Secretary::Config do
+  let(:config) { Secretary::Config.new }
+  subject { config }
+
+  its(:user_class) { should eq "::User" }
+  its(:ignored_attributes) { should eq ['id', 'created_at', 'updated_at'] }
+end

data/spec/lib/secretary/has_secretary_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe Secretary::HasSecretary do
+  let(:user) { create :user }
+
+  let(:new_story) {
+    build :story,
+      :headline         => "Cool Story, Bro",
+      :body             => "Some cool text.",
+      :logged_user_id   => user.id
+  }
+
+  let(:other_story) {
+    create :story,
+      :headline         => "Cooler Story, Bro",
+      :body             => "Some cooler text.",
+      :logged_user_id   => user.id
+  }
+
+
+  describe "::has_secretary?" do
+    it "returns false if no has_secretary declared" do
+      User.has_secretary?.should eq false
+    end
+
+    it "returns true if @_has_secretary is true" do
+      Story.has_secretary?.should eq true
+    end
+  end
+
+
+  describe "::has_secretary" do
+    it "sets @_has_secretary to true" do
+      Story.has_secretary?.should eq true
+    end
+
+    it 'adds the model to Secretary.versioned_models' do
+      Story # Load the class
+      Secretary.versioned_models.should include "Story"
+    end
+
+    it "adds the has_many association for versions" do
+      new_story.versions.to_a.should eq Array.new
+    end
+
+    it "has logged_user_id" do
+      new_story.should respond_to :logged_user_id
+      new_story.should respond_to :logged_user_id=
+    end
+
+    it "generates a version on create" do
+      Secretary::Version.count.should eq 0
+      new_story.save!
+      Secretary::Version.count.should eq 1
+      new_story.versions.count.should eq 1
+    end
+
+    it "generates a version when a record is changed" do
+      other_story.update_attributes(headline: "Some Cool Headline?!")
+      Secretary::Version.count.should eq 2
+      other_story.versions.size.should eq 2
+    end
+
+    it "doesn't generate a version if no attributes were changed" do
+      other_story.save!
+      other_story.versions.size.should eq 1
+      other_story.save!
+      other_story.versions.size.should eq 1
+    end
+
+    it "destroys all versions when the object is destroyed" do
+      other_story.update_attributes!(headline: "Changed the headline")
+      other_story.versions.size.should eq 2
+      Secretary::Version.count.should eq 2
+      other_story.destroy
+      Secretary::Version.count.should eq 0
+    end
+  end
+
+
+  describe '#changes' do
+    it 'is the built-in changes reverse-merged with custom changes' do
+      story = create :story, headline: "Original Headline"
+      story.headline = "Updated Headline!"
+      story.custom_changes['assets'] = [[], { a: 1, b: 2 }]
+
+      story.changes.should eq Hash[{
+        'headline' => ['Original Headline', "Updated Headline!"],
+        'assets'   => [[], { 'a' => 1, 'b' => 2 }]
+      }]
+    end
+  end
+
+
+  describe '#changed?' do
+    it 'checks if custom changes are present as well' do
+      other_story.changed?.should eq false
+      other_story.custom_changes['assets'] = [[], { a: 1, b: 2 }]
+      other_story.changed?.should eq true
+    end
+  end
+
+
+  describe '#custom_changes' do
+    it 'is a hash into which you can put things' do
+      other_story.custom_changes['something'] = ['old', 'new']
+    end
+
+    it 'gets cleared after saved' do
+      other_story.custom_changes["something"] = ["old", "new"]
+      other_story.custom_changes.should eq Hash[{"something" => ["old", "new"]}]
+      other_story.save!
+      other_story.custom_changes.should eq Hash[]
+    end
+  end
+end

data/spec/lib/secretary/tracks_association_spec.rb

@@ -0,0 +1,214 @@
+require 'spec_helper'
+
+describe Secretary::TracksAssociation do
+  describe '::tracks_association' do
+    it "raises an error if the model isn't versioned" do
+      -> {
+        User.tracks_association
+      }.should raise_error Secretary::NotVersionedError
+    end
+
+    it 'adds the associations to the versioned attributes' do
+      Person.versioned_attributes.should include "animals"
+      Person.versioned_attributes.should include "hobbies"
+    end
+  end
+
+
+  describe 'dirty association' do
+    let(:person) { create :person }
+    let(:animal) { create :animal }
+
+    it 'sets associations_were' do
+      person.animals << animal
+      person.animals_were.should eq []
+    end
+
+    it 'marks the association as changed when the association is changed' do
+      person.animals << animal
+      person.animals_changed?.should eq true
+    end
+
+    it 'clears out the dirty association after commit' do
+      person.animals << animal
+      person.animals_changed?.should eq true
+      person.save!
+      person.animals_changed?.should eq false
+    end
+  end
+
+
+  describe "adding to association collections" do
+    let(:person) { create :person }
+    let(:animal) { build :animal, name: "Bob", color: "dog" }
+
+    it "creates a new version when adding" do
+      person.animals = [animal]
+      person.save!
+
+      person.versions.count.should eq 2
+      version = person.versions.last
+      version.object_changes["animals"][0].should eq []
+
+      version.object_changes["animals"][1].should eq [
+        {"name" => "Bob", "color" => "dog"}
+      ]
+    end
+
+    it 'makes a version when adding' do
+      person  = create :person
+      animal  = build :animal, name: "Bryan", color: 'lame'
+
+      person.animals << animal
+      person.save!
+      person.versions.count.should eq 2
+
+      versions = person.versions.order('version_number').to_a
+      versions.last.object_changes["animals"][0].should eq []
+      versions.last.object_changes["animals"][1].should eq [{
+        "name" => "Bryan",
+        "color" => "lame"
+      }]
+    end
+
+    it 'makes a version when removing' do
+      person  = build :person
+      animal  = build :animal, name: "Bryan", color: 'lame'
+      person.animals = [animal]
+      person.save!
+      person.versions.count.should eq 1
+
+      person.animals = []
+      person.save!
+      person.versions.count.should eq 2
+
+      versions = person.versions.order('version_number').to_a
+      versions.last.object_changes["animals"][0].should eq [{
+        "name" => "Bryan",
+        "color" => "lame"
+      }]
+      versions.last.object_changes["animals"][1].should eq []
+    end
+  end
+
+
+  describe 'with accepts_nested_attributes_for' do
+    let(:animal) { create :animal, name: "Henry", color: "blind" }
+    let(:person) { create :person }
+
+    it 'adds a new version when adding to collection' do
+      animals_attributes = [
+        {
+          "name" => "George",
+          "color" => "yes"
+        }
+      ]
+
+      person.animals_attributes = animals_attributes
+      person.save!
+      person.versions.count.should eq 2
+
+      version = person.versions.order('version_number').last
+      version.object_changes["animals"][0].should eq []
+      version.object_changes["animals"][1].should eq [{
+        "name" => "George",
+        "color" => "yes"
+      }]
+    end
+
+    it 'adds a new version when changing something in collection' do
+      animals_attributes = [
+        {
+          "id" => animal.id,
+          "name" => "Lemon"
+        }
+      ]
+
+      person.animals << animal
+      person.save!
+      person.versions.count.should eq 2
+      person.animals_attributes = animals_attributes
+      person.save!
+      person.versions.count.should eq 3
+
+      version = person.versions.order('version_number').last
+      version.object_changes["animals"][0].should eq [{
+        "name" => "Henry",
+        "color" => "blind"
+      }]
+      version.object_changes["animals"][1].should eq [{
+        "name" => "Lemon",
+        "color" => "blind"
+      }]
+    end
+
+    it 'adds a new version when removing something from collection' do
+      animals_attributes = [
+        {
+          "id" => animal.id,
+          "_destroy" => "1"
+        }
+      ]
+
+      person.animals << animal
+      person.save!
+      person.versions.count.should eq 2
+      person.animals_attributes = animals_attributes
+      person.save!
+      person.versions.count.should eq 3
+
+      version = person.versions.order('version_number').last
+      version.object_changes["animals"][0].should eq [{
+        "name" => "Henry",
+        "color" => "blind"
+      }]
+      version.object_changes["animals"][1].should eq []
+    end
+
+    it 'does not add a new version if nothing has changed' do
+      animals_attributes = [
+        {
+          "id" => animal.id,
+          "name" => "Henry"
+        }
+      ]
+
+      person.animals << animal
+      person.save!
+      person.versions.count.should eq 2
+       # this doesn't call before_add/remove callbacks
+      person.animals_attributes = animals_attributes
+      person.save!
+      person.versions.count.should eq 2
+    end
+  end
+
+
+  describe '#association_changed?' do
+    let(:person) { create :person }
+    let(:animal) { create :animal }
+
+    it 'is true if the association has changed' do
+      person.animals_changed?.should eq false
+      person.animals << animal
+      person.animals_changed?.should eq true
+    end
+
+    it 'is false after the parent object has been saved' do
+      person.animals << animal
+      person.animals_changed?.should eq true
+      person.save!
+      person.animals_changed?.should eq false
+    end
+
+    it 'is false if the association has not changed' do
+      person.animals << animal
+      person.animals_changed?.should eq true
+      person.save!
+      person.animals_changed?.should eq false
+
+      person.animals = [animal]
+      person.animals_changed?.should eq false
+    end
+  end
+end

data/spec/lib/secretary/versioned_attributes_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Secretary::VersionedAttributes do
+  describe '::versioned_attributes' do
+    it 'uses the attributes set in the model' do
+      Animal.versioned_attributes.should eq ["name", "color"]
+    end
+
+    it 'uses the column names minus the global ignores if nothing is set' do
+      Location.versioned_attributes.should eq ["title", "address", "people"]
+    end
+
+    it 'subtracts unversioned attributes if they are set' do
+      Person.versioned_attributes.should_not include "name"
+      Person.versioned_attributes.should_not include "ethnicity"
+    end
+  end
+
+
+  describe '#versioned_changes' do
+    let(:person) { create :person }
+
+    it 'is empty for non-dirty objects' do
+      person.versioned_changes.should eq Hash[]
+    end
+
+    it "return a hash of changes for just the attributes we want" do
+      person.age  = 120
+      person.name = "Freddie"
+
+      person.versioned_changes.should eq Hash[{
+        "age" => [100, 120]
+      }]
+    end
+  end
+
+
+  describe '#versioned_attributes' do
+    let(:animal) { create :animal, name: "Henry", color: "henry" }
+
+    it 'is only the attributes we want' do
+      animal.versioned_attributes.should eq Hash[{
+        "name" => "Henry",
+        "color" => "henry"
+      }]
+    end
+  end
+
+
+  describe '#versioned_attribute?' do
+    let(:person) { create :person }
+
+    it 'is true if the attribute should be versioned' do
+      person.versioned_attribute?("age").should eq true
+      person.versioned_attribute?(:age).should eq true
+    end
+
+    it 'is false if the attribute should not be versioned' do
+      person.versioned_attribute?("name").should eq false
+      person.versioned_attribute?("id").should eq false
+    end
+  end
+end

data/spec/lib/secretary_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Secretary do
+  describe "::configure" do
+    it "accepts a block with the config object" do
+      Secretary.configure do |config|
+        config.should be_a Secretary::Config
+      end
+    end
+
+    it "sets Secretary.config to the new Config object" do
+      config = Secretary.configure
+      Secretary.config.should eq config
+    end
+  end
+
+
+  describe '::config' do
+    it 'creates a new configuration if none is set' do
+      Secretary.config.should be_a Secretary::Config
+    end
+
+    it 'uses the set configuration if available' do
+      id = Secretary.configure.object_id
+      Secretary.config.object_id.should eq id
+    end
+  end
+
+
+  describe '::versioned_models' do
+    it 'lists the name of all the versioned models' do
+      Story # load the class
+      Secretary.versioned_models.should include "Story"
+
+      class Something < ActiveRecord::Base
+        self.table_name = "stories"
+        has_secretary
+      end
+
+      Secretary.versioned_models.should include "Story"
+      Secretary.versioned_models.should include "Something"
+    end
+  end
+end

data/spec/models/secretary/version_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe Secretary::Version do
+  describe "::generate" do
+    it "generates a new version for passed-in object" do
+      story   = create :story
+      version = Secretary::Version.generate(story)
+
+      Secretary::Version.count.should eq 2
+      story.versions.last.should eq version
+    end
+  end
+
+
+  describe "generating description" do
+    let(:story) {
+      build :story, headline: "Cool story, bro", body: "Cool text, bro."
+    }
+
+    it "generates a description with object name on create" do
+      story.save!
+      story.versions.last.description.should eq "Created Story ##{story.id}"
+    end
+
+    it "generates a description with the changed attributes on update" do
+      story.save!
+      story.update_attributes(headline: "Another Headline", body: "New Body")
+      story.versions.last.description.should eq "Changed headline and body"
+    end
+  end
+
+
+  describe "incrementing version number" do
+    it "sets version_number to 1 if no other versions exist for this object" do
+      story = create :story
+      story.versions.last.version_number.should eq 1
+    end
+
+    it "increments version number if versions already exist" do
+      story = create :story, headline: "Some Headline"
+      story.versions.last.version_number.should eq 1
+      story.update_attributes(headline: "Cooler story, bro.")
+      story.versions.last.version_number.should eq 2
+      story.update_attributes(headline: "Coolest story, bro!")
+      story.versions.last.version_number.should eq 3
+    end
+  end
+
+
+  describe '#attribute_diffs' do
+    it 'is a hash of attribute keys, and Diffy::Diff objects' do
+      story = create :story, headline: "Cool story, bro"
+      story.update_attributes!(headline: "Updated Headline")
+
+      version = story.versions.last
+      version.attribute_diffs.keys.should eq ["headline"]
+      version.attribute_diffs["headline"].should be_a Diffy::Diff
+    end
+  end
+
+
+  describe '#title' do
+    it "is the simple title for the version" do
+      story = create :story
+      story.versions.last.title.should eq "Story ##{story.id} v1"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+ENV["RAILS_ENV"] ||= 'test'
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'combustion'
+Combustion.initialize! :active_record
+
+require 'rspec/rails'
+require 'factory_girl'
+load 'factories.rb'
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+  config.include FactoryGirl::Syntax::Methods
+  config.mock_with :rspec
+  config.order = "random"
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+end

data/spec/tmp/db/migrate/20131105082639_create_versions.rb

@@ -0,0 +1,18 @@
+class SecretaryCreateVersions < ActiveRecord::Migration
+  def change
+    create_table "versions" do |t|
+      t.integer  "version_number"
+      t.string   "versioned_type"
+      t.integer  "versioned_id"
+      t.string   "user_id"
+      t.text     "description"
+      t.text     "object_changes"
+      t.datetime "created_at"
+    end
+
+    add_index "versions", ["created_at"]
+    add_index "versions", ["user_id"]
+    add_index "versions", ["version_number"]
+    add_index "versions", ["versioned_type", "versioned_id"]
+  end
+end