has_versions 0.4.9 → 0.5.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: has_versions
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-16 00:00:00.000000000 Z
+date: 2012-06-22 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: i18n
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,16 +26,16 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: simple_uuid
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -59,38 +43,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.0
 description: ActiveModel versioning
 email:
 - grantr@gmail.com
@@ -113,40 +65,22 @@ files:
 - features/support/env.rb
 - has_versions.gemspec
 - lib/has_versions.rb
-- lib/has_versions/apply.rb
-- lib/has_versions/apply/simple.rb
 - lib/has_versions/attributes.rb
 - lib/has_versions/configuration.rb
-- lib/has_versions/diff.rb
-- lib/has_versions/diff/simple.rb
-- lib/has_versions/merge.rb
-- lib/has_versions/merge/always_conflicted.rb
-- lib/has_versions/merge/base.rb
-- lib/has_versions/merge/choose_first.rb
-- lib/has_versions/merge/diff3.rb
-- lib/has_versions/merge/fast_forward.rb
-- lib/has_versions/merge/merge_base.rb
-- lib/has_versions/merge/octopus.rb
-- lib/has_versions/merge/three_way.rb
 - lib/has_versions/orm/cassandra_object.rb
 - lib/has_versions/reset.rb
-- lib/has_versions/reset/simple.rb
+- lib/has_versions/version_methods/diff.rb
+- lib/has_versions/version_methods/log.rb
 - lib/has_versions/versioned.rb
-- spec/has_versions/apply_spec.rb
-- spec/has_versions/configuration_spec.rb
-- spec/has_versions/diff_spec.rb
-- spec/has_versions/merge/diff3_spec.rb
-- spec/has_versions/merge/merge_base_spec.rb
-- spec/has_versions/merge/octopus_spec.rb
-- spec/has_versions/merge/three_way_spec.rb
-- spec/has_versions/reset_spec.rb
-- spec/has_versions/stage_spec.rb
-- spec/has_versions/versioned_spec.rb
-- spec/spec_helper.rb
-- spec/support/matchers/be_a_uuid.rb
-- spec/support/version.rb
 - test/has_versions/attributes_test.rb
-- test/test_helper.rb
+- test/has_versions/configuration_test.rb
+- test/has_versions/reset_test.rb
+- test/has_versions/version_methods/diff_test.rb
+- test/has_versions/version_methods/log_test.rb
+- test/has_versions/versioned_test.rb
+- test/helper.rb
+- test/support/test_model.rb
+- test/support/test_version.rb
 homepage: ''
 licenses:
 - MIT
@@ -176,18 +110,12 @@ test_files:
 - features/has_versions.feature
 - features/step_definitions/has_versions_steps.rb
 - features/support/env.rb
-- spec/has_versions/apply_spec.rb
-- spec/has_versions/configuration_spec.rb
-- spec/has_versions/diff_spec.rb
-- spec/has_versions/merge/diff3_spec.rb
-- spec/has_versions/merge/merge_base_spec.rb
-- spec/has_versions/merge/octopus_spec.rb
-- spec/has_versions/merge/three_way_spec.rb
-- spec/has_versions/reset_spec.rb
-- spec/has_versions/stage_spec.rb
-- spec/has_versions/versioned_spec.rb
-- spec/spec_helper.rb
-- spec/support/matchers/be_a_uuid.rb
-- spec/support/version.rb
 - test/has_versions/attributes_test.rb
-- test/test_helper.rb
+- test/has_versions/configuration_test.rb
+- test/has_versions/reset_test.rb
+- test/has_versions/version_methods/diff_test.rb
+- test/has_versions/version_methods/log_test.rb
+- test/has_versions/versioned_test.rb
+- test/helper.rb
+- test/support/test_model.rb
+- test/support/test_version.rb

data/lib/has_versions/apply/simple.rb

@@ -1,34 +0,0 @@
-module HasVersions
-  module Apply
-
-    # takes a list of diff (patch) hashes and returns a copy of self with the patches applied in order.
-    # raises ApplyFailed if the patch does not apply
-    # diff format is:
-    #  {
-    #    attribute_name: [a, b]
-    #  }
-    #
-    #TODO should this be allowed to change the schema?
-    # it will if the hash returns nil for unset keys
-
-    module Simple
-      def apply(*patches)
-        self.class.new.tap do |version| #TODO is new the right thing here? it doe scall initialize (allocate does not)
-          ours = snapshot.dup #TEST is it necessary to deep dup the snapshot?
-          
-          patches.each do |patch|
-            patch.each do |key, (a, b)|
-              if ours[key] == a
-                ours[key] = b #TEST is it necessary to dup the value?
-              else
-                raise ApplyFailed, "Expected #{key} to be #{a.inspect}, was #{ours[key].inspect}" #TODO should this contain more information about what failed?
-              end
-            end
-          end
-
-          version.snapshot = ours
-        end
-      end
-    end
-  end
-end

data/lib/has_versions/apply.rb

@@ -1,9 +0,0 @@
-module HasVersions
-  class ApplyFailed < VersioningError; end
-
-  module Apply
-    extend ActiveSupport::Autoload
-
-    autoload :Simple
-  end
-end

data/lib/has_versions/diff/simple.rb

@@ -1,27 +0,0 @@
-module HasVersions
-  module Diff
-    # takes a version and returns a diff (patch) from self
-    # version must respond to #snapshot with an attributes hash (or something that responds to [] and keys)
-    # diff format is:
-    #  {
-    #    attribute_name: [a, b]
-    #  }
-
-    module Simple
-      def diff(other)
-        ours = snapshot
-        theirs = other.snapshot
-        all_keys = (ours.keys + theirs.keys).uniq
-        
-        output = {}.with_indifferent_access
-        all_keys.each do |key|
-          next unless target.versioning_codable?(key)
-          our_value = target.versioning_decode_value(key, ours[key])
-          their_value = target.versioning_decode_value(key, theirs[key])
-          output[key] = [our_value, their_value] if our_value != their_value
-        end
-        output
-      end
-    end
-  end
-end

data/lib/has_versions/diff.rb

@@ -1,7 +0,0 @@
-module HasVersions
-  module Diff
-    extend ActiveSupport::Autoload
-
-    autoload :Simple
-  end
-end

data/lib/has_versions/merge/always_conflicted.rb

@@ -1,9 +0,0 @@
-module HasVersions
-  module Merge
-    class AlwaysConflicted < Base
-      def conflicted?
-        true
-      end
-    end
-  end
-end

data/lib/has_versions/merge/base.rb

@@ -1,22 +0,0 @@
-module HasVersions
-  module Merge
-    class Base
-      attr_accessor :versions, :options
-      attr_accessor :resolution, :conflicts
-
-      def initialize(versions, options={})
-        @versions = versions
-        @options = options
-        @conflicts = {}.with_indifferent_access
-      end
-
-      def merge
-        # implemented by subclasses
-      end
-
-      def conflicted?
-        !self.conflicts.empty?
-      end
-    end
-  end
-end

data/lib/has_versions/merge/choose_first.rb

@@ -1,9 +0,0 @@
-module HasVersions
-  module Merge
-    class ChooseFirst < Base
-      def merge
-        self.resolution = versions.first
-      end
-    end
-  end
-end

data/lib/has_versions/merge/diff3.rb

@@ -1,66 +0,0 @@
-module HasVersions
-  module Merge
-    module Diff3
-
-      # 3-way merge, extended to support more than one other
-      # base ours *theirs.uniq  take
-      # A    A    [A]           A (ours)
-      # A    B    [A]           B (ours)
-      # A    A    [B]           B (theirs)
-      # B    A    [A]           A (ours)
-      # B    A    [A,B]         conflict
-      # B    A    [C]           conflict
-      #
-      # cases where values are missing:
-      # m    A     A            A
-      # m    B     A            conflict
-      # A    m     A            A
-      # A    m     B            B
-      # A    A     m            A
-      # A    B     m            B
-      # m    m     A            A
-      # m    A     m            A
-      #
-      # returns an array [clean, result]
-      # where clean is a boolean
-      # and result is an array in the conflicts case, or a single value in the clean case
-
-      def diff3(base, ours, *theirs)
-        theirs = theirs.uniq
-
-        # if there is more than one possible value, it is already a conflict
-        if theirs.size > 1
-          # add ours to conflicts if it is different from base
-          if ours != base && !theirs.include?(ours)
-            theirs << ours
-          end
-          return [false, theirs]
-        end
-
-        theirs = theirs.first
-
-        if ours == base && base == theirs
-          [true, ours]
-        elsif base == theirs
-          [true, ours]
-        elsif ours == base
-          [true, theirs]
-        elsif ours == theirs
-          [true, ours]
-        elsif ours == :_missing
-          [true, theirs]
-        elsif theirs == :_missing
-          [true, ours]
-        else
-          [false, [ours, theirs]]
-        end
-      end
-
-      private
-
-      def value_or_missing(snapshot, key)
-        snapshot.keys.include?(key) ? snapshot[key] : :_missing
-      end
-    end
-  end
-end

data/lib/has_versions/merge/fast_forward.rb

@@ -1,34 +0,0 @@
-module HasVersions
-  module Merge
-    class FastForward < Base
-      # Takes exactly two versions and resolves the merge using ancestry.
-      # One of the two versions must be an ancestor of the other.
-      #
-      # expects versions to define contains? which returns true if the given version
-      # is an ancestor of the receiver
-      # eg if v1 is an ancestor of v2, then
-      # v2.contains?(v1) #=> true
-      #
-      # raises MergeFailed if anything but two versions are given, or if neither version
-      # is an ancestor of the other.
-
-      def initialize(versions, options={})
-        super
-        if versions.size != 2
-          raise HasVersions::MergeFailed, "Cannot fast forward merge with #{versions.size} versions"
-        end
-      end
-
-      def merge
-        v1, v2 = versions
-        if v1.contains?(v2)
-          self.resolution = v1
-        elsif v2.contains?(v1)
-          self.resolution = v2
-        else
-          raise HasVersions::MergeFailed, "cannot fast forward if neither version is an ancestor"
-        end
-      end
-    end
-  end
-end

data/lib/has_versions/merge/merge_base.rb

@@ -1,75 +0,0 @@
-module HasVersions
-  module Merge
-    module MergeBase
-      # Finds optimal merge bases for any number of versions
-      # Essentially a copy of git's algorithm
-      # Expects versions to respond to parents with an array of parent versions
-      def merge_bases(versions)
-        versions = versions.dup
-        one = versions.shift
-        twos = versions
-        
-        bases = determine_merge_bases(one, twos)
-        if twos.include?(one)
-          return bases
-        end
-
-        if bases.size == 1
-          return bases
-        end
-
-        bases.each_with_index do |base1, i|
-          next if base1 == bases.last
-          
-          bases.each_with_index do |base2, j|
-            next if base1.nil? || base2.nil?
-            sub_bases = determine_merge_bases(base1, [base2])
-            sub_bases.each do |sub_base|
-              bases[i] = nil if sub_base == base1
-              bases[j] = nil if sub_base == base2
-            end
-          end
-        end
-
-        bases.compact
-      end
-
-      private
-
-      def determine_merge_bases(one, twos)
-        stale = Set.new
-        parent1 = Set.new
-        parent2 = Set.new
-        result = Set.new
-
-        interesting = []
-
-        if twos.include?(one)
-          return [one]
-        end
-
-        parent1 << one
-        parent2 += twos
-
-        interesting << one
-        interesting += twos
-        
-        while !(interesting - stale.to_a).empty?
-          candidate = interesting.shift
-          if parent1.include?(candidate) && parent2.include?(candidate) && !stale.include?(candidate)
-            result << candidate
-          end
-
-          candidate.parents.each do |parent|
-            stale << parent if stale.include?(candidate)
-            parent1 << parent if parent1.include?(candidate)
-            parent2 << parent if parent2.include?(candidate)
-            interesting << parent
-          end
-        end
-
-        result.to_a.reject { |r| stale.include?(r) }
-      end
-    end
-  end
-end

data/lib/has_versions/merge/octopus.rb

@@ -1,42 +0,0 @@
-module HasVersions
-  module Merge
-    # Merge >2 versions
-    # Works by doing a 3-way merge for first 2 versions, then merging the result with
-    # the next version for each version given.
-    # eg for 4 versions there are three merges: v1+v2, then (v1+v2)+v3, then ((v1+v2)+v3)+v4
-    # conflicts will be an accumulation of all conflicting values from each merge
-    class Octopus < Base
-      def initialize(versions, options={})
-        super
-        if versions.size <= 2
-          raise HasVersions::MergeFailed, "Cannot octopus merge with #{versions.size} versions, expect >2"
-        end
-      end
-
-      def merge
-        self.resolution = versions.inject(resolution) do |res, version|
-          if res
-            merge = ThreeWay.new([res, version], options)
-            merge.merge
-            add_conflicts(merge.conflicts)
-            res = merge.resolution
-          else
-            res = version
-          end
-          res
-        end
-        resolution.parents = versions
-        resolution
-      end
-
-      private
-      def add_conflicts(conflicts)
-        conflicts.each do |attribute, values|
-          self.conflicts[attribute] ||= []
-          self.conflicts[attribute] += values
-          self.conflicts[attribute].uniq!
-        end
-      end
-    end
-  end
-end

data/lib/has_versions/merge/three_way.rb

@@ -1,53 +0,0 @@
-module HasVersions
-  module Merge
-    # Merges two versions using ancestry and 3-way diff
-    # expects versions to respond to parents= to set parents
-    # does not check ancestry when setting parents - use FastForward if one version
-    # is an ancestor of another or they are identical
-    class ThreeWay < Base
-      include MergeBase
-      include Diff3
-
-      def initialize(versions, options={})
-        super
-        if versions.size != 2
-          raise HasVersions::MergeFailed, "Cannot 3-way merge with #{versions.size} versions, expect 2"
-        end
-      end
-
-      # assume the first version is ours
-      def merge
-        version_class = options[:version_class] || versions.first.class
-        # find merge base or bases
-        bases = merge_bases(versions)
-        # raise if there is more than one base
-        # TODO could potentially just choose one (that's what git does)
-        raise MergeFailed, "More than one merge base" if bases.size > 1
-
-        base = bases.first.try(:snapshot) || {}.with_indifferent_access
-        ours = versions.first.snapshot
-        theirs = versions.last.snapshot
-
-        self.resolution = version_class.new
-        self.resolution.parents = versions
-
-        # get the full list of attributes in each version and the merge base
-        attributes = (versions.collect { |v| v.snapshot.keys }.flatten + base.keys).uniq
-
-        # do 3-way merge on each attribute
-        attributes.each do |key|
-          clean, result = diff3(value_or_missing(base, key), value_or_missing(ours, key), value_or_missing(theirs, key))
-          if clean
-            resolution.snapshot[key] = result
-          else
-            resolution.snapshot[key] = ours[key]
-            conflicts[key] = result
-          end
-        end
-
-        resolution
-      end
-    end
-  end
-end
-

data/lib/has_versions/merge.rb

@@ -1,32 +0,0 @@
-module HasVersions
-
-  class MergeFailed < VersioningError; end
-
-  class MergeConflict < MergeFailed
-    attr_accessor :conflicts
-    attr_accessor :result
- 
-    def initialize(conflicts=nil, result=nil)
-      @conflicts = conflicts
-      @result = result
-    end
-  end
-
-  module Merge
-    extend ActiveSupport::Autoload
-
-    autoload :Base
-
-    autoload :FastForward
-    autoload :ThreeWay
-    autoload :Octopus
-
-    # strategies for testing
-    autoload :ChooseFirst
-    autoload :AlwaysConflicted
-
-    autoload :Diff3
-    autoload :MergeBase
-
-  end
-end

data/lib/has_versions/reset/simple.rb

@@ -1,19 +0,0 @@
-module HasVersions
-  module Reset
-    # reset should:
-    # take a version
-    # update self with the attributes from the version
-    # return updated self
-
-    module Simple
-      def reset!(version)
-        self.class.versioned_fields.each do |name|
-          value = versioning_decode_value(name, version.snapshot[name])
-          __send__("#{name}=", value)
-        end
-        self
-      end
-
-    end
-  end
-end

data/spec/has_versions/apply_spec.rb

@@ -1,33 +0,0 @@
-require 'spec_helper'
-
-class ApplyingVersion < Version; end
-
-describe ApplyingVersion do
-  class ApplyingVersion
-    include HasVersions::Apply::Simple
-  end
- 
-  let (:foo1) { described_class.new(name: 'foo1') }
-  let (:foo2) { described_class.new(name: 'foo2') }
-
-  let (:patch1) { {name: ['foo1', 'foo2']}.with_indifferent_access }
-  let (:patch2) { {name: ['foo2', 'foo1'], stripey: [nil, 'socks']}.with_indifferent_access }
-  let (:patch3) { {name: ['foo2', 'foo3']}.with_indifferent_access }
-
-  it 'should patch the snapshot' do
-    foo1.apply(patch1).snapshot.should include(name: 'foo2')
-  end
-
-  it 'should raise on non-applying patch' do
-    expect { foo1.apply(patch2) }.to raise_error(HasVersions::ApplyFailed)
-  end
-
-  it 'should apply patches adding attributes', :focus => true do
-    foo2.apply(patch2).snapshot.should include(name: 'foo1')
-    foo2.apply(patch2).snapshot.should include(stripey: 'socks')
-  end
-
-  it 'should apply multiple patches' do
-    foo1.apply(patch1, patch3).snapshot.should include(name: 'foo3')
-  end
-end