controlled_versioning 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd795072f67c6ec02a2c3217abf58ac0b22f790f
-  data.tar.gz: 778a4f6609c7ad684b166806bfcf8d5f359b957d
+  metadata.gz: 8839d624630b52a42a4956e23fd40aba03ea9498
+  data.tar.gz: 9e4b13aebd887b5566b15a7cb883fabf114685dc
 SHA512:
-  metadata.gz: dd82eb94ea2ebb8fe81c2610ade2c980fabeca3c978aa628e41f304afbc53550ea51149bdedf135a4b267cf945f143f7518bc4f1bc631bb489c0d4837a81108b
-  data.tar.gz: 72176d86e0287e0058a7c3a425dacd4a4589ad793870d2a4a43fd3d6a4ab84579a1c3e85a70f6bde117def3be6b04ed400939d9483097b466da8ef89b7117f18
+  metadata.gz: 5fb843057ee753a5ed1d0520766bd3d85db4f0e562dfa0d7140f55d2c4602f535f93c960425211ef0dfac2925a0f3aa5173c63919e9e864ac7bdfd355b4b223d
+  data.tar.gz: 4eb85655b003fc7fa64e716980140997eefcdf99d4a8c2725c7ba105119021c72cbe5eb375a576038ceeb0b9368cb77c59d0e749483f14555a3d9123e4578b55

data/Rakefile

@@ -14,8 +14,15 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
+Bundler::GemHelper.install_tasks
 
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+require "rspec/core/rake_task"
 
+task :default => :spec
 
-Bundler::GemHelper.install_tasks
-
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  # spec.rspec_opts = ['-cfs --backtrace']
+end

data/lib/controlled_versioning.rb

@@ -1,9 +1,13 @@
 # Core
+require "controlled_versioning/version"
+
+require "controlled_versioning/initial_version"
+require "controlled_versioning/initial_version/factory"
+
 require "controlled_versioning/revision"
-require "controlled_versioning/revision_auditor"
-require "controlled_versioning/revision_builder"
-require "controlled_versioning/revision_accepter"
-require "controlled_versioning/initial_version_builder"
+require "controlled_versioning/revision/auditor"
+require "controlled_versioning/revision/factory"
+require "controlled_versioning/revision/publisher"
 
 # Add utility classes
 require "support/array_converter"
@@ -36,7 +40,7 @@ module ControlledVersioning
           nested_associations.present?
         end
 
-        attr_accessor :user
+        attr_accessor :user, :notes
 
         after_create :create_initial_version
 
@@ -88,12 +92,12 @@ module ControlledVersioning
         assign_attributes(suggested_attributes)
         if invalid?
           errors
-        elsif !RevisionAuditor.new(self).changes_original?
+        elsif !Revision::Auditor.new(self).changes_original?
           errors[:base] << I18n.t("errors.messages.no_revisions_made")
           errors
         else
           version = versions.build
-          RevisionBuilder.new(versionable: self, version: version).version
+          Revision::Factory.new(versionable: self, version: version).build
           version.save
           version
         end
@@ -101,7 +105,7 @@ module ControlledVersioning
 
       private
       def create_initial_version
-        InitialVersionBuilder.new(self)
+        InitialVersion::Factory.new(self).build
       end
     end
   end

data/lib/controlled_versioning/initial_version.rb

@@ -0,0 +1,11 @@
+class InitialVersion < Version
+
+  private
+  def versionable_nested_within
+    versionable.nested_within
+  end
+
+  def versionable_parent
+    versionable.public_send(versionable_nested_within)
+  end
+end

data/lib/controlled_versioning/{initial_version_builder.rb → initial_version/factory.rb}

@@ -1,26 +1,27 @@
-class InitialVersionBuilder < Revision
+class InitialVersion::Factory < InitialVersion
 
   attr_reader :versionable, :version
   def initialize(versionable)
     @versionable = versionable
     @version = build_version_type
-    build_initial_version
+  end
+
+  def build
+    build_version_attributes
+    version.save
   end
 
   private
   def build_version_type
-    if is_a_nested_association?
-      parent.initial_version.version_children.build(versionable: versionable)
+    if versionable_is_a_nested_association?
+      versionable_parent.initial_version.version_children.
+        build(versionable: versionable)
     else
-      versionable.versions.build(initial: true)
+      versionable.versions.build(initial: true, notes: versionable_notes, user:
+        versionable_user)
     end
   end
 
-  def build_initial_version
-    build_version_attributes
-    version.save
-  end
-
   def build_version_attributes
     versionable_attributes.each do |attr|
       attr = AttributeEncapsulator.new(attr)
@@ -34,16 +35,4 @@ class InitialVersionBuilder < Revision
       new_value: attr.value)
   end
 
-  def is_a_nested_association?
-    versionable.is_a_nested_association?
-  end
-
-  def nested_within
-    versionable.nested_within
-  end
-
-  def parent
-    versionable.public_send(nested_within)
-  end
-
 end

data/lib/controlled_versioning/revision.rb

@@ -1,22 +1,10 @@
-class Revision
+class Revision < Version
 
   private
-  def versionable_attributes
-    versionable.versionable_attributes
-  end
-
-  def changed_attributes
+  def versionable_changed_attributes
     versionable.changed_attributes
   end
 
-  def nested_associations
-    versionable.class.nested_associations
-  end
-
-  def version_attributes
-    version.version_attributes
-  end
-
   def version_children
     version.version_children
   end

data/lib/controlled_versioning/{revision_auditor.rb → revision/auditor.rb}

@@ -1,4 +1,4 @@
-class RevisionAuditor < Revision
+class Revision::Auditor < Revision
 
   attr_reader :versionable
   def initialize(versionable)
@@ -16,13 +16,13 @@ class RevisionAuditor < Revision
   def changes_at_least_one_attribute?
     versionable_attributes.each do |attr|
       attr = AttributeEncapsulator.new(attr)
-      return true if changed_attributes.include?(attr.key)
+      return true if versionable_changed_attributes.include?(attr.key)
     end
     return false
   end
 
   def changes_at_least_one_nested_association?
-    nested_associations.each do |association|
+    versionable_nested_associations.each do |association|
       return true if association_changed?(association)
     end
     return false
@@ -37,6 +37,6 @@ class RevisionAuditor < Revision
 
   def child_changed?(child)
     child.new_record? || child.marked_for_destruction? ||
-      RevisionAuditor.new(child).changes_original?
+      Revision::Auditor.new(child).changes_original?
   end
 end

data/lib/controlled_versioning/{revision_builder.rb → revision/factory.rb}

@@ -1,27 +1,34 @@
-class RevisionBuilder < Revision
+class Revision::Factory < Revision
 
   attr_reader :versionable, :version
   def initialize(args)
     @versionable = args[:versionable]
     @version = args[:version]
-    build_revision
   end
 
-  private
-  def build_revision
+  def build
     mark_for_removal
+    add_notes
     build_attributes
     build_children
   end
 
+  private
   def mark_for_removal
     version.marked_for_removal = true if versionable.marked_for_destruction?
   end
 
+  def add_notes
+    unless versionable_is_a_nested_association?
+      version.notes = versionable_notes
+      version.user = versionable_user
+    end
+  end
+
   def build_attributes
     versionable_attributes.each do |attr|
       attr = AttributeEncapsulator.new(attr)
-      if changed_attributes.include?(attr.key)
+      if versionable_changed_attributes.include?(attr.key)
         build_attribute(attr)
       end
     end
@@ -35,7 +42,7 @@ class RevisionBuilder < Revision
   end
 
   def build_children
-    nested_associations.each do |association|
+    versionable_nested_associations.each do |association|
       versionable.public_send(association).each do |child|
         build_child(child)
       end
@@ -43,9 +50,9 @@ class RevisionBuilder < Revision
   end
 
   def build_child(child)
-    if RevisionAuditor.new(child).changes_original?
+    if Revision::Auditor.new(child).changes_original?
       version_child = build_version_child(child)
-      RevisionBuilder.new(versionable: child, version: version_child)
+      Revision::Factory.new(versionable: child, version: version_child).build
     end
   end
 

data/lib/controlled_versioning/{revision_accepter.rb → revision/publisher.rb}

@@ -1,18 +1,17 @@
-class RevisionAccepter < Revision
+class Revision::Publisher < Revision
 
   attr_reader :version, :versionable
   def initialize(version)
     @version = version
     @versionable = version.versionable
-    accept_revision
   end
 
-  private
   def accept_revision
     create_or_update_versionable
     update_version_children
   end
 
+  private
   def create_or_update_versionable
     versionable.present? ? update_versionable : create_versionable
   end
@@ -40,7 +39,7 @@ class RevisionAccepter < Revision
     if child.marked_for_removal?
       destroy_child(child)
     else
-      RevisionAccepter.new(child)
+      Revision::Publisher.new(child).accept_revision
     end
   end
 

data/lib/controlled_versioning/version.rb

@@ -1,3 +1,27 @@
-module ControlledVersioning
-  VERSION = "0.6.1"
-end
+class Version
+
+  private
+  def versionable_attributes
+    versionable.versionable_attributes
+  end
+
+  def version_attributes
+    version.version_attributes
+  end
+
+  def versionable_is_a_nested_association?
+    versionable.is_a_nested_association?
+  end
+
+  def versionable_nested_associations
+    versionable.class.nested_associations
+  end
+
+  def versionable_notes
+    versionable.notes
+  end
+
+  def versionable_user
+    versionable.user
+  end
+end

data/lib/controlled_versioning/version_number.rb

@@ -0,0 +1,3 @@
+module ControlledVersioning
+  VERSION_NUMBER = "0.6.2"
+end

data/lib/generators/templates/create_versions.rb

@@ -12,18 +12,24 @@ class CreateVersions < ActiveRecord::Migration
 
       t.boolean  :marked_for_removal, null: false, default: false
 
-      t.boolean  :approved, null: false, default: false
+      t.boolean  :accepted, null: false, default: false
       t.boolean  :declined, null: false, default: false
       t.boolean  :pending, null: false, default: true
 
       t.datetime :created_at
     end
     add_index :versions, :initial
+    add_index :versions, :accepted
+    add_index :versions, :declined
+    add_index :versions, :pending
     add_index :versions, [:versionable_type, :versionable_id]
   end
 
   def self.down
     remove_index :versions, :initial
+    remove_index :versions, :accepted
+    remove_index :versions, :declined
+    remove_index :versions, :pending
     remove_index :versions, [:verstionable_type, :versionable_id]
     drop_table :versions
   end

data/lib/generators/templates/version.rb

@@ -8,8 +8,8 @@ class ControlledVersioning::Version < ActiveRecord::Base
   validates :versionable, presence: true
 
   def accept
-    RevisionAccepter.new(self)
-    update_attributes(pending: false, approved: true)
+    Revision::Publisher.new(self).accept_revision unless initial?
+    update_attributes(pending: false, accepted: true)
   end
 
   def decline

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: controlled_versioning
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - timothythehuman
@@ -128,11 +128,13 @@ files:
 - lib/generators/templates/version.rb
 - lib/generators/templates/create_version_attributes.rb
 - lib/generators/controlled_versioning/install_generator.rb
-- lib/controlled_versioning/revision_accepter.rb
-- lib/controlled_versioning/revision_builder.rb
+- lib/controlled_versioning/initial_version.rb
+- lib/controlled_versioning/version_number.rb
+- lib/controlled_versioning/initial_version/factory.rb
 - lib/controlled_versioning/revision.rb
-- lib/controlled_versioning/revision_auditor.rb
-- lib/controlled_versioning/initial_version_builder.rb
+- lib/controlled_versioning/revision/factory.rb
+- lib/controlled_versioning/revision/auditor.rb
+- lib/controlled_versioning/revision/publisher.rb
 - lib/controlled_versioning/version.rb
 - lib/controlled_versioning.rb
 - MIT-LICENSE