controlled_versioning 0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 006bad30ccaea1ec63957fcf41c9987bf2ba5027
+  data.tar.gz: 75b870f39473c849265c9d8baa990be953c52b2d
+SHA512:
+  metadata.gz: 8978fffbb883fddfb408d0c27f634935e97be9fef9a573c83c2462acb4f12146064fd46d45ddaf8280646195adc24bd3404a5c9487fa489317411ee3a31201ba
+  data.tar.gz: 13f85a9d20a79641716580c601d801fc110f89b1dab9f60f59566c36b349dd19af898031818fc2aac4e2e6d03d06adadb80b4cb7fea0e888f7cbedc01128fb7f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Timothy Baron
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,3 @@
+= ControlledVersioning
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,21 @@
+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|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ControlledVersioning'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  errors:
+    messages:
+      no_revisions_made: "You must edit at least one attribute"

data/lib/controlled_versioning.rb

@@ -0,0 +1,110 @@
+# Core
+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"
+
+# Add utility classes
+require "support/array_converter"
+require "support/attribute_encapsulator"
+
+module ControlledVersioning
+  module ActsAsVersionable
+    extend ActiveSupport::Concern
+ 
+    included do
+    end
+ 
+    module ClassMethods
+      def acts_as_versionable(options = {})
+
+        send :include, InstanceMethods
+
+        def set_versionable_attribute_names(nonversionables)
+          nonversionables = [] unless nonversionables.present?
+          ArrayConverter.to_s!(nonversionables)
+          nonversionables += ["id", "updated_at", "created_at"]
+          attribute_names - nonversionables
+        end
+
+        def nested_associations
+          nested_attributes_options.keys
+        end
+
+        def has_nested_associations?
+          nested_associations.present?
+        end
+
+        attr_accessor :user
+
+        after_create :create_initial_version
+
+        cattr_accessor :nested_within
+        self.nested_within = options[:nested_within]
+
+        def is_a_nested_association?
+          nested_within.present?
+        end
+
+        if is_a_nested_association?
+          has_many :version_children,
+                   class_name: 'ControlledVersioning::VersionChild',
+                   as: :versionable
+        else
+          has_many :versions,
+                   lambda { order("created_at ASC")},
+                   class_name: 'ControlledVersioning::Version',
+                   as: :versionable
+        end
+
+        cattr_accessor :versionable_attribute_names
+        self.versionable_attribute_names = options[:versionable_attributes] ||
+                                           set_versionable_attribute_names(
+                                           options[:nonversionable_attributes])
+      end
+    end
+
+    module InstanceMethods
+      def is_a_nested_association?
+        self.class.is_a_nested_association?
+      end
+
+      def versionable_attributes
+        versionable_attributes = self.versionable_attribute_names
+        ArrayConverter.to_s!(versionable_attributes)
+        self.attributes.slice(*versionable_attributes)
+      end
+
+      def initial_version
+        if is_a_nested_association?
+          version_children.first
+        else
+          versions.find_by(initial: true)
+        end
+      end
+
+      def submit_revision(suggested_attributes)
+        assign_attributes(suggested_attributes)
+        if invalid?
+          errors
+        elsif !RevisionAuditor.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
+          version.save
+          version
+        end
+      end
+
+      private
+      def create_initial_version
+        InitialVersionBuilder.new(self)
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, ControlledVersioning::ActsAsVersionable

data/lib/controlled_versioning/initial_version_builder.rb

@@ -0,0 +1,49 @@
+class InitialVersionBuilder < Revision
+
+  attr_reader :versionable, :version
+  def initialize(versionable)
+    @versionable = versionable
+    @version = build_version_type
+    build_initial_version
+  end
+
+  private
+  def build_version_type
+    if is_a_nested_association?
+      parent.initial_version.version_children.build(versionable: versionable)
+    else
+      versionable.versions.build(initial: true)
+    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)
+      build_attribute(attr)
+    end
+  end
+
+  def build_attribute(attr)
+    version_attributes.build(
+      name: attr.key,
+      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

@@ -0,0 +1,34 @@
+class Revision
+
+  private
+  def versionable_attributes
+    versionable.versionable_attributes
+  end
+
+  def 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
+
+  def versionable_changes(key)
+    values = versionable.changes[key]
+    ValueChange.new(values[0], values[1])
+  end
+
+  def previous_value(key)
+    versionable_changes(key).previous_value
+  end
+
+  ValueChange = Struct.new(:previous_value, :new_value)
+end

data/lib/controlled_versioning/revision_accepter.rb

@@ -0,0 +1,51 @@
+class RevisionAccepter < 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
+
+  def create_or_update_versionable
+    versionable.present? ? update_versionable : create_versionable
+  end
+
+  def new_attributes
+    version_attributes.each_with_object({}) {|v, h| h[v.name] = v.new_value }
+  end
+
+  def create_versionable
+    version.versionable = version.versionable_type.constantize.
+                          create(new_attributes)
+  end
+
+  def update_versionable
+    versionable.update_attributes(new_attributes)
+  end
+
+  def update_version_children
+    version_children.each do |child|
+      update_or_destroy_child(child)
+    end
+  end
+
+  def update_or_destroy_child(child)
+    if child.marked_for_removal?
+      destroy_child(child)
+    else
+      RevisionAccepter.new(child)
+    end
+  end
+
+  def destroy_child(child)
+    child.versionable.destroy
+  end
+
+end

data/lib/controlled_versioning/revision_auditor.rb

@@ -0,0 +1,42 @@
+class RevisionAuditor < Revision
+
+  attr_reader :versionable
+  def initialize(versionable)
+    @versionable = versionable
+  end
+
+  def changes_original?
+    return true if versionable.marked_for_destruction?
+    return true if changes_at_least_one_attribute?
+    return true if changes_at_least_one_nested_association?
+    return false
+  end
+
+  private
+  def changes_at_least_one_attribute?
+    versionable_attributes.each do |attr|
+      attr = AttributeEncapsulator.new(attr)
+      return true if changed_attributes.include?(attr.key)
+    end
+    return false
+  end
+
+  def changes_at_least_one_nested_association?
+    nested_associations.each do |association|
+      return true if association_changed?(association)
+    end
+    return false
+  end
+
+  def association_changed?(association)
+    versionable.public_send(association).each do |child|
+      return true if child_changed?(child)
+    end
+    return false
+  end
+
+  def child_changed?(child)
+    child.new_record? || child.marked_for_destruction? ||
+      RevisionAuditor.new(child).changes_original?
+  end
+end

data/lib/controlled_versioning/revision_builder.rb

@@ -0,0 +1,60 @@
+class RevisionBuilder < Revision
+
+  attr_reader :versionable, :version
+  def initialize(args)
+    @versionable = args[:versionable]
+    @version = args[:version]
+    build_revision
+  end
+
+  private
+  def build_revision
+    mark_for_removal
+    build_attributes
+    build_children
+  end
+
+  def mark_for_removal
+    version.marked_for_removal = true if versionable.marked_for_destruction?
+  end
+
+  def build_attributes
+    versionable_attributes.each do |attr|
+      attr = AttributeEncapsulator.new(attr)
+      if changed_attributes.include?(attr.key)
+        build_attribute(attr)
+      end
+    end
+  end
+
+  def build_attribute(attr)
+    version_attributes.build(
+      name: attr.key,
+      new_value: attr.value,
+      old_value: previous_value(attr.key))
+  end
+
+  def build_children
+    nested_associations.each do |association|
+      versionable.public_send(association).each do |child|
+        build_child(child)
+      end
+    end
+  end
+
+  def build_child(child)
+    if RevisionAuditor.new(child).changes_original?
+      version_child = build_version_child(child)
+      RevisionBuilder.new(versionable: child, version: version_child)
+    end
+  end
+
+  def build_version_child(child)
+    if child.new_record?
+      version_children.build(versionable_type: child.class.name)
+    else
+      version_children.build(versionable: child)
+    end
+  end
+
+end

data/lib/controlled_versioning/version.rb

@@ -0,0 +1,3 @@
+module ControlledVersioning
+  VERSION = "0.6"
+end

data/lib/generators/controlled_versioning/install_generator.rb

@@ -0,0 +1,30 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module ControlledVersioning
+  class InstallGenerator < Rails::Generators::Base
+    include ::Rails::Generators::Migration
+
+    source_root File.expand_path('../../templates', __FILE__)
+
+    desc 'Generates (but does not run) a migration to add a versions table.'
+
+    def create_model_file
+      template "version.rb", "app/models/controlled_versioning/version.rb"
+      template "version_attribute.rb",
+        "app/models/controlled_versioning/version_attribute.rb"
+      template "version_child.rb",
+        "app/models/controlled_versioning/version_child.rb"
+      migration_template "create_versions.rb", "db/migrate/create_versions.rb"
+      migration_template "create_version_attributes.rb",
+        "db/migrate/create_version_attributes.rb"
+      migration_template "create_version_children.rb",
+        "db/migrate/create_version_children.rb"
+    end
+
+    def self.next_migration_number(dirname)
+      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+  end
+end

data/lib/generators/templates/create_version_attributes.rb

@@ -0,0 +1,17 @@
+class CreateVersionAttributes < ActiveRecord::Migration
+  def self.up
+    create_table :version_attributes do |t|
+      t.string   :version_type, null: false
+      t.integer  :version_id, null: false
+      t.string :name, null: false
+      t.text :old_value
+      t.text :new_value
+    end
+    add_index :version_attributes, [:version_type, :version_id]
+  end
+
+  def self.down
+    remove_index :version_attributes, [:version_type, :version_id]
+    drop_table :version_attributes
+  end
+end

data/lib/generators/templates/create_version_children.rb

@@ -0,0 +1,20 @@
+class CreateVersionChildren < ActiveRecord::Migration
+  def self.up
+    create_table :version_children do |t|
+      t.string   :version_type, null: false
+      t.integer  :version_id, null: false
+      t.string   :versionable_type
+      t.integer  :versionable_id
+
+      t.boolean  :marked_for_removal, null: false, default: false
+    end
+    add_index :version_children, [:version_type, :version_id]
+    add_index :version_children, [:versionable_type, :versionable_id]
+  end
+
+  def self.down
+    remove_index :version_children, [:version_type, :version_id]
+    remove_index :version_children, [:versionable_type, :versionable_id]
+    drop_table :version_children
+  end
+end

data/lib/generators/templates/create_versions.rb

@@ -0,0 +1,30 @@
+class CreateVersions < ActiveRecord::Migration
+  def self.up
+    create_table :versions do |t|
+      t.string   :versionable_type, null: false
+      t.integer  :versionable_id,   null: false
+
+      t.integer  :user_id
+
+      t.text     :notes
+
+      t.boolean  :initial, null: false, default: false
+
+      t.boolean  :marked_for_removal, null: false, default: false
+
+      t.boolean  :approved, 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, [:versionable_type, :versionable_id]
+  end
+
+  def self.down
+    remove_index :versions, :initial
+    remove_index :versions, [:verstionable_type, :versionable_id]
+    drop_table :versions
+  end
+end

data/lib/generators/templates/version.rb

@@ -0,0 +1,19 @@
+class ControlledVersioning::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
+
+  def accept
+    RevisionAccepter.new(self)
+    update_attributes(pending: false, approved: true)
+  end
+
+  def decline
+    update_attributes(pending: false, declined: true)
+  end
+
+end

data/lib/generators/templates/version_attribute.rb

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

data/lib/generators/templates/version_child.rb

@@ -0,0 +1,8 @@
+class ControlledVersioning::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

data/lib/support/array_converter.rb

@@ -0,0 +1,6 @@
+class ArrayConverter
+
+  def self.to_s!(array)
+    array.map! { |s| s.to_s } if array.present?
+  end
+end

data/lib/support/attribute_encapsulator.rb

@@ -0,0 +1,18 @@
+class AttributeEncapsulator
+
+  attr_reader :attr
+  def initialize(attr)
+    @attr = AttrStruct.new(attr[0], attr[1])
+  end
+
+  def key
+    attr.key
+  end
+
+  def value
+    attr.value
+  end
+
+  private
+  AttrStruct = Struct.new(:key, :value)
+end

data/lib/tasks/controlled_versioning_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :controlled_versioning do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: controlled_versioning
+version: !ruby/object:Gem::Version
+  version: '0.6'
+platform: ruby
+authors:
+- timothythehuman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-04 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: pg
+  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: debugger
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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: guard-spork
+  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'
+description: With Controlled Versioning, you can make any model versionable. This
+  will record suggested changes to the model, which can then be approved or declined
+  according to your application's design.
+email:
+- timothythehuman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- config/locales/en.yml
+- lib/tasks/controlled_versioning_tasks.rake
+- lib/support/attribute_encapsulator.rb
+- lib/support/array_converter.rb
+- lib/generators/templates/create_version_children.rb
+- lib/generators/templates/create_versions.rb
+- lib/generators/templates/version_attribute.rb
+- lib/generators/templates/version_child.rb
+- 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/revision.rb
+- lib/controlled_versioning/revision_auditor.rb
+- lib/controlled_versioning/initial_version_builder.rb
+- lib/controlled_versioning/version.rb
+- lib/controlled_versioning.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: https://github.com/timothythehuman/controlled_versioning
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.5
+signing_key: 
+specification_version: 4
+summary: Adds model versioning to a Rails app, with the ability to approve and declined
+  revisions.
+test_files: []