conflict 0.1.0

data/LICENSE

@@ -0,0 +1,174 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

data/README

@@ -0,0 +1,23 @@
+= Conflict -- Notifies a developer of conflicts between his/her work and that of other developers.
+
+Conflict is an open source project composed of two parts: Conflict clients and a Conflict server.
+A Conflict client is a transparent process running on the workstation of each developer.
+It stays in the background, reporting local file system changes to the Conflict server.
+
+== Installing Conflict Server
+
+ $ gem install conflict
+
+== Running Conflict Server
+
+To run the Conflict server with default settings ...
+
+ $ conflict
+
+To run the Conflict server on TCP/IP port 123 ...
+
+ $ conflict -port 123
+
+To run the Conflict server with event expiration set to one minute ...
+
+ $ conflict -ttl 60

data/Rakefile

@@ -0,0 +1,63 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require 'rake'
+require 'rake/testtask'
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'test/common.rb'
+#require 'rake/contrib/rubyforgepublisher'
+
+desc 'Run unit tests.'
+task :default => :test
+
+desc 'Test Conflict'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+spec = Gem::Specification.new do |s|
+  s.name = 'conflict'
+  s.version = '0.1.0'
+  s.author = 'Dennis Byrne'
+  s.email = 'dbyrne@thoughtworks.com'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'Notifies a developer of conflicts between his/her work and that of other developers'
+
+  s.files = [ 'Rakefile', 'README', 'LICENSE' ]
+  s.files = s.files + Dir.glob( 'lib/**/*' ).delete_if { |item| item.include?( '\.svn' ) }
+  s.files = s.files + Dir.glob( 'bin/**/*' ).delete_if { |item| item.include?( '\.svn' ) }
+  s.files = s.files + Dir.glob( 'test/**/*' ).delete_if { |item| item.include?( '\.svn' ) }
+  
+  s.bindir = 'bin'
+  s.executables = ['conflict']
+  s.require_path = 'lib'
+  s.rubyforge_project = 'conflict'
+  s.autorequire = 'conflict'
+  s.homepage = 'http://sourceforge.net/projects/conflict'
+  s.has_rdoc = false
+  s.requirements << 'none'
+  s.test_files = FileList["{test}/*test.rb"].to_a # do not include integration tests
+end
+ 
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  #p.need_tar = true
+  #p.need_zip = true
+end

data/bin/conflict

@@ -0,0 +1,13 @@
+begin
+  require 'conflict'
+rescue LoadError
+  require 'rubygems'
+  require 'conflict'
+end
+
+port = ARGV.index('-port') ? ARGV[ARGV.index('-port') + 1] : nil
+ttl = ARGV.index('-ttl') ? ARGV[ARGV.index('-ttl') + 1] : nil
+
+s = Conflict::Server::new({:port=>port, :ttl=>ttl})
+trap("INT"){ s.stop }
+s.start

data/lib/conflict.rb

@@ -0,0 +1,27 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require 'webrick'
+require 'rexml/document'
+require 'yaml'
+
+require 'conflict/core'
+require 'conflict/domain'
+require 'conflict/parsers'
+
+#require 'sqlite3'
+#require 'logger'

data/lib/conflict/core.rb

@@ -0,0 +1,170 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Conflict
+
+DIFF_URL = "/diff"
+STATUS_URL = "/status.xml"
+PORT = 80 # tcp/ip
+TTL = 43200 # event staleness, 12 hours in secs
+
+class Server
+  
+  def initialize cfg={}
+    @cfg = {}
+    @cfg[:port] = cfg[:port] ||= PORT
+    @cfg[:ttl] = cfg[:ttl] ||= TTL
+  end
+  
+  def start
+  
+    @s = WEBrick::HTTPServer.new(:Port => @cfg[:port],:AccessLog => [])
+    
+    @db = DataBase::new
+      
+    @s.mount_proc(DIFF_URL){|request, res|
+      RequestValidator::new().validate request
+      client = request.query['client'].to_s.strip
+      events = RequestParser::new(@cfg[:ttl]).parse request.query['diff'], request.query['info'], client
+      conflicts = @db.find_conflicts(client, events)
+      res.body = conflicts.to_yaml
+    }
+    
+    @s.mount_proc(STATUS_URL){|request, res|
+      body = ['<status><events>']
+      @db.to_a.each do | event | body << event.to_xml end
+      body << '</events></status>'
+      res.body = body * ""
+    }
+    
+    @s.mount_proc('/clear'){|request, res|
+      @db.clear
+    }
+    
+    @s.start
+  end
+  
+  def to_s
+    "port " + @cfg[:port].to_s + ", event TTL " + @cfg[:ttl].to_s 
+  end
+  
+  def stop
+    @s.shutdown
+    puts "Conflict Server stopped: " + self.to_s
+  end
+  
+end
+
+class RequestValidator
+  
+  def validate request
+    
+    request_method = request.request_method
+    
+    raise "only POST HTTP requests supported, not " + request_method if ! "POST".eql?(request_method)
+    
+    client = request.query['client'].to_s.strip
+    
+    raise "client parameter is nil or empty" if nil.eql?(client) || client.empty?    
+    
+    diff = request.query['diff']
+      
+    raise "diff parameter is nil" if nil.eql?(diff)
+    
+    info = request.query['info']
+    
+    raise "info parameter cannot be nil or empty" if nil.eql?(info) || info.empty?
+    
+    raise "diff count " + diff.list.size.to_s + " != info count " + info.list.size.to_s if diff.list.size != info.list.size
+  end
+  
+end
+
+class DataBase
+
+  def initialize
+    @db = [] # yes, it is seriously just an array
+  end
+  
+  def find_conflicts client, events
+    
+    validate_input client, events
+
+    purge client
+    
+    conflicts = []
+    
+    if events.size > 0
+      events.each do | event | # keep this until we get performance problems
+        @db.each do | historic_event |
+          conflicts << Conflict::new( event, historic_event) if event.resource.eql?(historic_event.resource)
+        end
+      end
+      @db = @db | events 
+    end
+    
+    conflicts
+  end
+  
+  def size
+    @db.size
+  end
+  
+  def clear
+    @db.clear
+  end
+  
+  def to_a
+    @db.clone # don't return the real implementation
+  end
+  
+  private
+  def purge client # remove all history for this client
+    now = Time.now # use one reference, so same rule is applied to all
+    temp = []
+    # one day we'll need to find a way to not lose the client history, for reporting
+    @db.each do | e | 
+      temp << e if ! e.client.eql?( client ) and now < e.expires
+    end
+    @db = temp
+  end
+
+  def validate_input client, events
+
+    raise ConflictException::new("client cannot be empty") if nil.eql?(client) || client.empty?
+    raise ConflictException::new("events cannot be nil") if nil.eql?(events)
+  
+    resources = []
+  
+    events.each do | e |
+      raise ConflictException::new("client " + client.to_s + " does not match client of event: " + e.to_s) if ! client.eql?(e.client)
+      raise ConflictException::new("duplicate resource '" + e.resource + "' reported for " + client) if resources.index(e.resource)
+      resources << e.resource
+    end
+  
+  end
+
+end
+
+class ConflictException < Exception
+  attr_reader :msg
+  def intialize msg
+    @msg = msg
+  end
+end
+
+end