controlled_versioning 0.6.3 → 0.7.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjljZWI4NTFhMTI4YjAxMjIzM2Q1NjQ2NjhhODQ5ZmI4ZGI0NGMyYQ==
+    NDg0NzM1MTM3ZWQxODQ0NWE0OWFlYTlmZDYzOThjYThkOGUxYmY4ZA==
   data.tar.gz: !binary |-
-    OTBlYTk4N2ExNWViZThhNzA2ZDYzMDEyMmQ5YzFhMmYzZWUzOWQ5MQ==
+    NzVkOTAwNTMxZWNkMDU0YzNmNzE5NmZhNTc1ZDk4ZGI4MmRhM2E1Mw==
 SHA512:
   metadata.gz: !binary |-
-    ZWRhZGI3ZTQ1YzBiYmIzNmZkMzQzNDUyY2VkMTRmYzBlYTNkMDhjNDY0ZjMy
-    OTc2ZDdmNTllNGVmYmY3N2QxMDk1MmJlMmQ0MjA0ZmRlYTA1ZmMwYzJkN2Ey
-    ZjlkZGY5ZmY4NzJmNDBjOWM1ZjlmYTQxNjE4N2NhZTFmMGUyOWU=
+    ODY3N2JiYzZkMTI4NWQ1YWViODA0NjAzMmM4NjExM2QyYTdiNDc5ZDIxZjUz
+    NTliZmVmNTFlYWI4NzFhY2M3YTk0MWJjZGRlNDUzYTM3YzQ2MTRmMTQ0NmE0
+    MTk4MWVmYmE3NDQzMzYxN2RiYjFjOTU2OWZiMDdiOTZlOTgyYjU=
   data.tar.gz: !binary |-
-    ZWZhNjA5OTRjNmM1MzhiNzgyNjE3NjkzMjY3OWU3ZjM1YzJhY2QxZmIxYzc1
-    NjhhOTRmNzFlZGQ5Mzc5Nzc0Y2Q2MzNhYjkwYjRjNDE0YzE5ZjBjMDQ0ZDk2
-    Yzk5YzVmOWJiMGU4Yzg1YWJhNGM3MzE2NjNiZTg4MDhjZjE2MTc=
+    OWJhOTE5MTNjNDkwM2JlZjNiYjM3ZTQxZTljZjYzNjRkZjlhYjY0OWUzMDc5
+    NmJmY2FiN2E0Zjk4NTU5MGI5NmE1Y2U1ODY1YzlkY2VmMmEwMjFjODU4MGEy
+    NmI0ZDc5MTQxNzhiYWVkMTJiOTE4NDdjY2YxODIxNjY5M2MyMjE=

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2014 Timothy Baron
+Copyright 2014 YOURNAME
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,9 +1,3 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
 require 'rdoc/task'
 
 RDoc::Task.new(:rdoc) do |rdoc|

data/app/assets/javascripts/controlled_versioning/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/controlled_versioning/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/controlled_versioning/application_controller.rb

@@ -0,0 +1,4 @@
+module ControlledVersioning
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/controlled_versioning/application_helper.rb

@@ -0,0 +1,4 @@
+module ControlledVersioning
+  module ApplicationHelper
+  end
+end

data/app/models/controlled_versioning/version.rb

@@ -0,0 +1,23 @@
+module ControlledVersioning
+  class Version < ActiveRecord::Base
+    belongs_to :versionable, polymorphic: true
+    belongs_to :user
+    has_many :version_attributes, as: :version
+    has_many :version_children, as: :version
+
+    validates :versionable, presence: true
+
+    scope :pending, -> { where(pending: true) }
+    scope :accepted, -> { where(accepted: true) }
+    scope :declined, -> { where(declined: true) }
+
+    def accept
+      Revision::Publisher.new(self).accept_revision unless initial?
+      update_attributes(pending: false, accepted: true)
+    end
+
+    def decline
+      update_attributes(pending: false, declined: true)
+    end
+  end
+end

data/app/models/controlled_versioning/version_attribute.rb

@@ -0,0 +1,8 @@
+module ControlledVersioning
+  class VersionAttribute < ActiveRecord::Base
+
+    belongs_to :version, polymorphic: true
+
+    validates :name, presence: true
+  end
+end

data/app/models/controlled_versioning/version_child.rb

@@ -0,0 +1,9 @@
+module ControlledVersioning
+  class VersionChild < ActiveRecord::Base
+
+    belongs_to :versionable, polymorphic: true
+    belongs_to :version, polymorphic: true
+    has_many :version_attributes, as: :version
+    has_many :version_children, as: :version
+  end
+end

data/app/views/layouts/controlled_versioning/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>ControlledVersioning</title>
+  <%= stylesheet_link_tag    "controlled_versioning/application", media: "all" %>
+  <%= javascript_include_tag "controlled_versioning/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/lib/controlled_versioning/engine.rb

@@ -0,0 +1,16 @@
+module ControlledVersioning
+  class Engine < ::Rails::Engine
+    isolate_namespace ControlledVersioning
+  end
+end
+
+module ControlledVersioning
+  class Engine < ::Rails::Engine
+    config.generators do |g|
+      g.test_framework      :rspec,        :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/controlled_versioning/version_number.rb

@@ -1,3 +1,3 @@
 module ControlledVersioning
-  VERSION_NUMBER = "0.6.3"
+  VERSION_NUMBER = "0.7.2"
 end

data/lib/controlled_versioning.rb

@@ -1,3 +1,5 @@
+require "controlled_versioning/engine"
+
 # Core
 require "controlled_versioning/version"
 

data/spec/controlled_versioning_spec.rb

@@ -0,0 +1,316 @@
+require 'spec_helper'
+
+describe "ControlledVersioning" do
+
+  it 'sets the initial version contributor if one is provided' do
+    user = create(:user)
+    resource = create(:versionable_resource, user: user)
+    expect(resource.initial_version.user).to eq user
+  end
+
+  it 'does not set the initial version contributor if one is not provided' do
+    resource = create(:versionable_resource)
+    expect(resource.initial_version.user).to be_nil
+  end
+
+  it 'sets the revision contributor if they are provided' do
+    user = create(:user)
+    resource = create(:versionable_resource)
+    revision = resource.submit_revision(r_string: "new string",
+          r_float: 90.1, user: user)
+    expect(revision.user).to eq user
+  end
+
+  it 'does not set the revision contributor if they are not provided' do
+    resource = create(:versionable_resource)
+    revision = resource.submit_revision(r_string: "new string",
+          r_float: 90.1)
+    expect(revision.user).to be_nil
+  end
+
+  it 'writes initial version notes if they are provided' do
+    notes = "These are my notes"
+    resource = create(:versionable_resource, notes: notes)
+    expect(resource.initial_version.notes).to eq notes
+  end
+
+  it 'does not write initial version notes if they are not provided' do
+    resource = create(:versionable_resource)
+    expect(resource.initial_version.notes).to be_nil
+  end
+
+  it 'writes revision notes if they are provided' do
+    notes = "These are my notes"
+    resource = create(:versionable_resource)
+    revision = resource.submit_revision(r_string: "new string",
+          r_float: 90.1, notes: notes)
+    expect(revision.notes).to eq notes
+  end
+
+  it 'does not write revision notes if they are not provided' do
+    resource = create(:versionable_resource)
+    revision = resource.submit_revision(r_string: "new string",
+          r_float: 90.1)
+    expect(revision.notes).to be_nil
+  end
+
+  context 'has a scope that' do
+    before :each do
+      @resource = create(:versionable_resource)
+      @accepted_1 = @resource.submit_revision(r_string: "accepted 1")
+      @accepted_2 = @resource.submit_revision(r_string: "accepted 2")
+      @declined_1 = @resource.submit_revision(r_string: "declined 1")
+      @declined_2 = @resource.submit_revision(r_string: "declined 2")
+      @pending_1 = @resource.initial_version
+      @pending_2 = @resource.submit_revision(r_string: "pending 2")
+      @accepted_1.accept
+      @accepted_2.accept
+      @declined_1.decline
+      @declined_2.decline
+    end
+
+    it 'returns an array of pending versions' do
+      expect(@resource.versions.pending).to match_array(
+        [@pending_1, @pending_2])
+    end
+
+    it 'returns an array of accepted versions' do
+      expect(@resource.versions.accepted).to match_array(
+        [@accepted_1, @accepted_2])
+    end
+
+    it 'returns an array of declined versions' do
+      expect(@resource.versions.declined).to match_array(
+        [@declined_1, @declined_2])
+    end
+  end
+
+  context 'by default' do
+    before :each do
+      @resource = create(:versionable_resource)
+    end
+
+    it 'returns a list of versionable attributes' do
+      expect(@resource.versionable_attributes).to eq(
+        @resource.attributes.except("id", "updated_at", "created_at"))
+    end
+
+    it 'returns the initial version' do
+      @resource.versions.create
+      @resource.versions.create
+      expect(@resource.initial_version).to eq(
+        @resource.versions.find_by(initial: true))
+    end
+
+    it "rejects revisions with invalid changes" do
+      version = @resource.submit_revision(r_string: "new string",
+        r_float: 9000000.1)
+      expect(version).to have(1).error_on(:r_float)
+    end
+
+    it "rejects revisions that make no changes" do
+      version = @resource.submit_revision(@resource.versionable_attributes)
+      expect(version).to have(1).error
+    end
+
+    context 'handles revision' do
+      before :each do
+        @version = @resource.submit_revision(r_string: "new string",
+          r_float: 90.1)
+      end
+
+      it 'by creating versions with the suggested attributes' do
+        @resource.reload
+        r_string = @version.version_attributes.find_by(name: "r_string")
+        r_float = @version.version_attributes.find_by(name: "r_float")
+        expect(r_string.old_value).to eq("my string")
+        expect(r_string.new_value).to eq("new string")
+        expect(r_float.old_value).to eq("3.14")
+        expect(r_float.new_value).to eq("90.1")
+        expect(@resource.r_string).to eq("my string")
+        expect(@resource.r_float).to eq(3.14)
+      end
+
+      it "by skipping non-revised attributes" do
+        expect(@version.version_attributes.find_by(name: "r_text")).to be_nil
+      end
+
+      it 'by updating model data if its revisions are accepted' do
+        @version.accept
+        @resource.reload
+        @version.reload
+        expect(@resource.r_string).to eq "new string"
+        expect(@resource.r_float).to eq 90.1
+        expect(@version.pending).to eq false
+        expect(@version.declined).to eq false
+        expect(@version.accepted).to eq true
+      end
+
+      it 'by maintaining model data if its revisions are declined' do
+        @version.decline
+        @resource.reload
+        @version.reload
+        expect(@resource.r_string).to eq "my string"
+        expect(@resource.r_float).to eq 3.14
+        expect(@version.pending).to eq false
+        expect(@version.declined).to eq true
+        expect(@version.accepted).to eq false
+      end
+
+      it 'by not updating model data if the initial version is accepted' do
+        @version.accept
+        @resource.initial_version.accept
+        @resource.reload
+        expect(@resource.r_string).to eq "new string"
+        expect(@resource.r_float).to eq 90.1
+      end
+    end
+  end
+
+  context 'with nested attributes' do
+    before :each do
+      @resource = create(:parent_with_grand_children)
+    end
+
+    it 'creates version children' do
+      expect(@resource.initial_version.version_children.length).to eq 3
+      expect(@resource.initial_version.version_children.last.version_children.
+        length).to eq 3
+    end
+
+    it 'rejects invalid children' do
+      first_child_resource = @resource.child_resources.first
+      version = @resource.submit_revision(child_resources_attributes: [
+        {id: first_child_resource.id, r_float: 90000000000.6}
+      ])
+      expect(version).to have(1).error
+    end
+
+    context 'handles revision' do
+      before :each do
+        @first_child_resource = @resource.child_resources[0]
+        @version = @resource.submit_revision(child_resources_attributes: [
+          {id: @first_child_resource.id, r_string: "new string"}
+        ])
+      end
+
+      it 'by creating versions for its children' do
+        expect(@version.version_children.length).to eq 1
+        changed_attribute = @version.version_children.
+                            find_by(versionable: @first_child_resource).
+                            version_attributes.find_by(name: "r_string")
+        expect(changed_attribute.new_value).to eq "new string"
+        expect(changed_attribute.old_value).to eq "my string"
+      end
+
+      it 'by updating its children data if its revisions are approved' do
+        @version.accept
+        @first_child_resource.reload
+        expect(@first_child_resource.r_string).to eq "new string"
+      end
+    end
+
+    context 'handles revision for deeply nested children' do
+      before :each do
+        @first_child_resource = @resource.child_resources[0]
+        @first_grand_child_resource = @first_child_resource.
+                                      grand_child_resources.first
+        @version = @resource.submit_revision(child_resources_attributes: [
+          {id: @first_child_resource.id, grand_child_resources_attributes: [
+            {id: @first_grand_child_resource.id, r_string: "new string"}
+          ]}
+        ])
+        @child_version = @version.version_children.
+                         find_by(versionable_id: @first_child_resource.id)
+      end
+
+      it 'by creating versions for the full family' do
+        expect(@child_version.version_children.length).to eq 1
+        changed_attribute = @child_version.version_children.
+                            find_by(versionable: @first_grand_child_resource).
+                            version_attributes.find_by(name: "r_string")
+        expect(changed_attribute.new_value).to eq "new string"
+        expect(changed_attribute.old_value).to eq "my string"
+      end
+
+      it 'by updating its deeply nested data if its revisions are approved' do
+        @version.accept
+        @first_grand_child_resource.reload
+        expect(@first_grand_child_resource.r_string).to eq "new string"
+      end
+    end
+
+    context 'handles new children' do
+      before :each do
+        @version = @resource.submit_revision(child_resources_attributes: [
+          {r_float: 14.0}
+        ])
+        @child_version = @version.version_children.first
+      end
+
+      it 'by creating version for new children' do
+        expect(@version.version_children.length).to eq 1
+      end
+
+      it 'by creating attributes for new children' do
+        changed_attribute = @child_version.version_attributes.
+                            find_by(name: "r_float")
+        expect(changed_attribute.new_value).to eq "14.0"
+        expect(changed_attribute.old_value).to be_nil
+      end
+
+      it 'by creating new children when approved' do
+        @version.accept
+        @resource.reload
+        expect(@resource.child_resources.find_by(r_float: 14.0)).to_not be_nil
+      end
+    end
+
+    context 'handles child destruction' do
+      before :each do
+        @first_child_resource = @resource.child_resources[0]
+        @version = @resource.submit_revision(child_resources_attributes: [
+          {id: @first_child_resource.id, _destroy: "1"}
+        ])
+        @child_version = @version.version_children.find_by(versionable_id:
+                         @first_child_resource.id)
+      end
+
+      it 'by creating a version for the marked child' do
+        expect(@version.version_children.length).to eq 1
+      end
+
+      it 'by marking a resource for removal if _destroy is sent' do
+        expect(@child_version.marked_for_removal).to be true
+      end
+
+      it 'by preserving a resource until its mark is approved' do
+        @first_child_resource.reload
+        expect(@first_child_resource).to be_an_instance_of(ChildResource)
+      end
+
+      it 'by removing a resource if its mark was approved' do
+        @version.accept
+        @resource.reload
+        expect(@resource.child_resources.length).to eq 2
+      end
+    end
+  end
+
+  context 'with versionable_attributes' do
+    it 'returns a list of versionable attributes' do
+      resource = create(:partially_inclusive_versionable_resource)
+      expect(resource.versionable_attributes).to eq(
+        resource.attributes.slice("r_boolean", "r_date"))
+    end
+  end
+
+  context 'with nonversionable_attributes' do
+    it 'returns a list of versionable attributes' do
+      resource = create(:partially_exclusive_versionable_resource)
+      expect(resource.versionable_attributes).to eq(
+        resource.attributes.except("id", "updated_at", "created_at",
+          "r_boolean", "r_date"))
+    end
+  end
+end