has_versions 0.3.0

data/.autotest

@@ -0,0 +1,12 @@
+require "test_notifier/runner/autotest"
+
+Autotest.add_hook(:initialize) {|at|
+  at.add_exception %r{^\.git}  # ignore Version Control System
+  at.add_exception %r{^./tmp}  # ignore temp files, lest autotest will run again, and again...
+  #  at.clear_mappings         # take out the default (test/test*rb)
+  at.add_mapping(%r{^lib/.*\.rb$}) {|f, _|
+    Dir['spec/**/*.rb']
+  }
+  nil
+}
+

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,42 @@
+# simplecov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--format nested
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    has_versions (0.3.0)
+      activesupport (~> 3)
+      i18n
+      simple_uuid
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.5)
+    builder (3.0.0)
+    cucumber (0.10.0)
+      builder (>= 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.3.2)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    diff-lcs (1.1.2)
+    gherkin (2.3.4)
+      json (~> 1.4.6)
+    i18n (0.5.0)
+    json (1.4.6)
+    reek (1.2.8)
+      ruby2ruby (~> 1.2)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    roodi (2.1.0)
+      ruby_parser
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    ruby2ruby (1.2.5)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.0.6)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.5)
+    simple_uuid (0.1.1)
+    simplecov (0.4.1)
+      simplecov-html (~> 0.4.3)
+    simplecov-html (0.4.3)
+    term-ansicolor (1.0.5)
+    yard (0.6.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  cucumber
+  has_versions!
+  reek (~> 1.2.8)
+  roodi (~> 2.1.0)
+  rspec (~> 2)
+  simplecov (>= 0.3.8)
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Grant Rodgers
+
+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,19 @@
+= has_versions
+
+Description goes here.
+
+== Contributing to has_versions
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Grant Rodgers. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,29 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+
+require 'roodi'
+require 'roodi_task'
+RoodiTask.new do |t|
+  t.verbose = false
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/features/has_versions.feature

@@ -0,0 +1,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/features/support/env.rb

@@ -0,0 +1,13 @@
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'has_versions'
+
+require 'rspec/expectations'

data/has_versions.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "has_versions/version"
+
+Gem::Specification.new do |s|
+  s.name = "has_versions"
+  s.version = HasVersions::VERSION
+
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Grant Rodgers"]
+  s.email       = ["grantr@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{ActiveModel versioning}
+  s.description = %q{ActiveModel versioning}
+
+  s.rubyforge_project = "has_versions"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.licenses = ["MIT"]
+
+  s.add_runtime_dependency("i18n", [">= 0"])
+  s.add_runtime_dependency("activesupport", ["~> 3"])
+  s.add_runtime_dependency("simple_uuid", [">= 0"])
+  s.add_development_dependency("rspec", ["~> 2"])
+  s.add_development_dependency("yard", ["~> 0.6.0"])
+  s.add_development_dependency("cucumber", [">= 0"])
+  s.add_development_dependency("bundler", ["~> 1.0.0"])
+  s.add_development_dependency("simplecov", [">= 0.3.8"])
+  s.add_development_dependency("reek", ["~> 1.2.8"])
+  s.add_development_dependency("roodi", ["~> 2.1.0"])
+end
+

data/lib/has_versions/apply/simple.rb

@@ -0,0 +1,34 @@
+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.with_indifferent_access #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

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

data/lib/has_versions/attributes.rb

@@ -0,0 +1,34 @@
+module HasVersions
+  module Attributes
+
+    def versioned_attributes
+      versioning_configuration.attributes.inject(HashWithIndifferentAccess.new) do |memo, (key, options)|
+
+        memo[key] = versioning_encode_value(__send__(key), options)
+        memo
+      end
+    end
+
+    private
+
+    def versioning_decode_value(value, options)
+      return value if value.nil?
+
+      if options[:expected] && !value.kind_of?(options[:expected]) && options[:decoder]
+        options[:decoder].call(value)
+      else
+        value
+      end
+    end
+
+    def versioning_encode_value(value, options)
+      return value if value.nil?
+
+      if options[:encoder]
+        options[:encoder].call(value)
+      else
+        value
+      end
+    end
+  end
+end

data/lib/has_versions/configuration.rb

@@ -0,0 +1,28 @@
+module HasVersions
+
+  class Configuration
+    attr_accessor :attributes
+    attr_accessor :types
+
+    DEFAULT_TYPES = {
+      set: { expected: Set, decoder: ->(value) { Set.new(value) } },
+      time_with_zone: { expected: ActiveSupport::TimeWithZone, encoder: ->(value) { value.utc.xmlschema(6) }, decoder: ->(value) { Time.xmlschema(value).in_time_zone } }
+    }.freeze
+
+    def initialize(&block)
+      @attributes = {}.with_indifferent_access
+      @types = DEFAULT_TYPES.with_indifferent_access
+      instance_eval(&block)
+    end
+
+    def type(name, options={})
+      @types[name] = options.with_indifferent_access
+    end
+
+    def attribute(name, options={})
+      options.merge!(@types[options[:type]]) if @types[options[:type]]
+      @attributes[name] = options.with_indifferent_access
+    end
+  end
+
+end

data/lib/has_versions/diff/simple.rb

@@ -0,0 +1,24 @@
+module HasVersions
+  module Diff
+    # takes a version and returns a diff (patch) from self
+    # version must respond to #snapshot with an attributes hash
+    # 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|
+          output[key] = [ours[key], theirs[key]] if ours[key] != theirs[key] #TEST is it necessary to dup the values?
+        end
+        output
+      end
+    end
+  end
+end

data/lib/has_versions/diff.rb

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

data/lib/has_versions/merge/stupid.rb

@@ -0,0 +1,44 @@
+module HasVersions
+  module Merge
+
+    # takes a list of versions and attempts to merge them with the current version.
+    # returns the merged version if successful
+    # raises MergeConflict if failed
+    #
+    # Doesn't attempt to determine common ancestry. The merge base is always the current version (self).
+    # Since there is no ancestry, conflict resolution is conservative. Any conflicting values generate a conflict.
+    #
+    # In general merging more than 1 version will generate a conflict.
+    module Stupid
+      include Diff3
+
+      def merge(*versions)
+        merged_version = self.class.new
+        merged_version.snapshot = snapshot.dup
+
+        # get the full list of attributes in each version and the merge base (self)
+        attributes = (versions.collect { |v| v.snapshot.keys }.flatten + snapshot.keys).uniq
+        conflicts = HashWithIndifferentAccess.new
+
+        # do 3-way merge on each attribute
+        attributes.each do |key|
+          theirs = versions.collect { |v| v.snapshot[key] }
+          clean, result = diff3(snapshot[key], snapshot[key], *theirs)
+
+          if clean
+            puts "clean: #{result.inspect}"
+            merged_version.snapshot[key] = result
+          else
+            conflicts[key] = result
+          end
+        end
+
+        # raise if conflicts is not empty
+        raise MergeConflict.new(conflicts, merged_version), conflicts.inspect unless conflicts.empty?
+        merged_version
+      end
+
+    end
+
+  end
+end

data/lib/has_versions/merge.rb

@@ -0,0 +1,61 @@
+module HasVersions
+
+  class MergeConflict < VersioningError
+    attr_accessor :conflicts
+    attr_accessor :result
+ 
+    def initialize(conflicts=nil, result=nil)
+      @conflicts = conflicts
+      @result = result
+    end
+  end
+
+  module Merge
+    extend ActiveSupport::Autoload
+
+    autoload :Stupid
+
+    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
+      #
+      # 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]
+        else
+          [false, [ours, theirs]]
+        end
+      end
+    end
+  end
+end

data/lib/has_versions/reset/simple.rb

@@ -0,0 +1,19 @@
+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)
+        versioning_configuration.attributes.each do |name, options|
+          value = versioning_decode_value(version.snapshot[name], options)
+          __send__("#{name}=", value)
+        end
+        self
+      end
+
+    end
+  end
+end

data/lib/has_versions/reset.rb

@@ -0,0 +1,15 @@
+module HasVersions
+  module Reset
+    extend ActiveSupport::Autoload
+
+    autoload :Simple
+ 
+    module FromVersion
+      def from_version(version)
+        new.tap do |object|
+          object.reset!(version)
+        end
+      end
+    end
+  end
+end

data/lib/has_versions/stage.rb

@@ -0,0 +1,121 @@
+#TODO this should move to a contrib gem
+module HasVersions
+  module Stage
+    # stage versions onto an object, returning true or false if there are conflicts.
+    # extends the object and each versioned attribute with methods to retrieve status, conflicts, and original value.
+    # extends the object with a resolution and conflicted/modified attribute lists
+    #
+    #TODO should this be part of the plugin?
+
+    def stage(*versions)
+      original = to_version
+
+      # try merging 
+      begin
+        merge_result = original.merge(*versions)
+        conflicts = HashWithIndifferentAccess.new
+      # if merge fails, get the conflicts and result
+      rescue MergeConflict => e
+        conflicts = e.conflicts
+        merge_result = e.result
+      end
+
+      reset!(merge_result)
+
+      stage_extend_self(versions, conflicts, original, merge_result)
+      stage_extend_attributes(conflicts, original)
+
+      conflicts.empty?
+    end
+    # devang also wants an api that is similar to the old one, with pending objects, and old values in the attributes.
+    # we can implement something that attaches a non-updated object in pending, with all the old apis
+
+    private
+
+    def stage_extend_self(staged, conflicts, original, merge_result)
+      # extend self with StagedAttribute and set conflicts and original
+      self.extend(StagedAttribute)
+      self.conflicts = conflicts
+      self.original = self.class.new.reset!(original) #TODO should this be a clone or new? should it inherit the key or id or other attributes?
+
+      # extend self with Staged and set the proper values
+      self.extend(Staged)
+      self.staged = staged
+      self.resolution = merge_result
+      # modified attributes is the conflicted keys plus the modified keys
+      self.modified_attributes = (conflicts.keys + original.diff(merge_result).keys).uniq
+    end
+
+    def stage_extend_attributes(conflicts, original)
+      # for each attribute, extend with StagedAttribute and set proper values
+      versioned_attributes.each do |key, value|
+        v.extend(StagedAttribute)
+        v.conflicts = conflicts[key] || []
+        v.original = original.snapshot[key]
+      end
+    end
+
+  end
+  
+  # included in attributes of staged objects
+  module StagedAttribute
+
+    def conflicted?
+      !@conflicts.empty?
+    end
+
+    def modified?
+      @original != self
+    end
+
+    def conflicts
+      @conflicts
+    end
+
+    def conflicts=(conflicts)
+      @conflicts = conflicts
+    end
+
+    def original
+      @original
+    end
+
+    def original=(original)
+      @original = original
+    end
+  end
+
+  # included in staged objects
+  # TODO maybe this should be included in the class up front
+  module Staged
+
+    def staged
+      @staged
+    end
+
+    def staged=(staged)
+      @staged = staged
+    end
+
+    def resolution
+      @resolution
+    end
+
+    def resolution=(resolution)
+      @resolution = resolution
+    end
+
+    def modified_attributes
+      @modified_attributes
+    end
+
+    def modified_attributes=(modified_attributes)
+      @modified_attributes = modified_attributes
+    end
+
+    def conflicted_attributes
+      @conflicts.keys
+    end
+  end
+
+end

data/lib/has_versions/version.rb

@@ -0,0 +1,4 @@
+module HasVersions
+  VERSION = "0.3.0"
+end
+