dm-svn 0.2.0

data/lib/dm-svn/svn/changeset.rb

@@ -0,0 +1,119 @@
+module DmSvn
+  module Svn
+
+    # Store information about a particular changeset, and runs the actual
+    # updates for that changeset. Aside from handling the
+    # list of changes, it can be passed to methods that need the revision,
+    # date and author.
+    class Changeset
+      include Comparable
+      
+      attr_reader :changes, :revision, :date, :author, :repos, :config
+      
+      def initialize(changes, revision, author, date, sync)
+        @changes, @revision, @author, @date = changes, revision, author, date
+        @model, @config, @repos, @sync = sync.model, sync.config, sync.repos, sync
+      end
+      
+      # Changesets are sorted by revision number, ascending.
+      def <=>(other)
+        self.revision <=> other.revision
+      end
+      
+      # Process this changeset.
+      # This doesn't account for possible move/replace conflicts (A node is moved,
+      # then the old node is replaced by a new one). I assume those are rare
+      # enough that I won't code around them, for now.
+      def process
+        return if changes.nil?
+        
+        modified, deleted, copied = [], [], []
+        
+        changes.each_pair do |path, change|
+          next if short_path(path).blank? || !path_in_root?(path)
+          
+          case change.action
+          when "M", "A", "R" # Modified, Added or Replaced
+            modified << path
+          when "D"
+            deleted << path
+          end
+          copied << [path, change.copyfrom_path] if change.copyfrom_path
+        end
+              
+        # Perform moves
+        copied.each do |copy|
+          del = deleted.find { |d| d == copy[1] }
+          if del
+            # Change the path. No need to perform other updates, as this is an
+            # "A" or "R" and thus is in the +modified+ Array.
+            record = get(del)
+            record.move_to(short_path(copy[0])) if record
+          end
+        end
+        
+        # Perform deletes
+        deleted.each do |path|
+          record = get(path)
+          record.destroy if record # May have been moved or refer to a directory
+        end
+        
+        # Perform modifies and adds
+        modified.each do |path|
+          node = Node.new(self, path)
+          
+          if @config.extension && 
+              node.file? &&
+              path !~ /\.#{@config.extension}\Z/ 
+            if path =~ /\.yml\Z/ && @model.svn_category_model
+              # Update parent directory, if applicable
+              path = path.split("/")[0..-2].join("/")
+              node = Node.new(self, path)
+            else
+              next
+            end
+          end
+          
+          record = get(path) || new_record(node)
+  
+          # update record
+          record.update_from_svn(node)
+        end
+      end
+    
+      # Get the relative path from config.uri
+      def short_path(path)
+        path = fs_path(path)
+        path = path.sub(/\.#{@config.extension}\Z/, '') if @config.extension
+        path
+      end
+      
+      # Path used to communicate with svn repos.
+      def fs_path(path)
+        path = path[@config.path_from_root.length..-1].to_s
+        path = path[1..-1] if path[0] == ?/
+        path
+      end
+          
+      private
+      
+      def path_in_root?(path)
+        return true if @config.path_from_root.blank?
+        path[0..@config.path_from_root.length - 1].to_s == @config.path_from_root
+      end
+      
+      # Get an object of the @model, by path.
+      def get(path)
+        @model.get(short_path(path), true)
+      end
+      
+      # Create a new object of the @model
+      def new_record(node)
+        node.file? ?
+          @model.new :
+          Object.const_get(@model.svn_category_model).new
+      end
+      
+    end
+  end
+end

data/lib/dm-svn/svn/node.rb

@@ -0,0 +1,128 @@
+module DmSvn
+  module Svn
+
+    # A Node (file or directory) at a path and revision [Changeset].
+    # In particular, this class exists to determine the type (file or directory)
+    # of the node and retrieve the body of a node (for files),
+    # and other properties, either stored in yaml or a Subversion properties
+    class Node
+      
+      attr_reader :path
+      
+      def initialize(changeset, path)
+        @changeset, @path = changeset, path
+      end
+      
+      # Shortened path (from Changeset#short_path)
+      def short_path
+        @changeset.short_path(@path)
+      end
+      
+      # Shortened path (from Changeset#fs_path)
+      def fs_path
+        @changeset.fs_path(@path)
+      end
+      
+      # Body of the node (nil for a directory)
+      def body
+        return nil unless file?
+        has_yaml_props? ?
+          yaml_split[1] :
+          data[0]
+      end
+      
+      # Properties of the node. The properties are accessed from three sources,
+      # listed by order of precedence:
+      # 1. YAML properties, either in meta.yml (directories), or at the
+      #    beginning of a file, between "---" and "..." lines.
+      # 2. Properties stored in subversion's property mechanism.
+      # 3. svn_updated_[rev|at|by] as determined by revision properties.
+      def properties
+        rev_properties.merge(svn_properties).merge(yaml_properties)
+      end
+      
+      # Is the Node a file?
+      def file?
+        repos.stat(fs_path, revision).file?
+      end
+    
+      # Is the Node a directory?
+      def directory?
+        repos.stat(fs_path, revision).directory?
+      end
+      
+      # Methods derived from Changeset instance variables.
+      %w{revision author repos date config}.each do |f|
+        define_method(f) do
+          @changeset.__send__(f)
+        end
+      end
+    
+      private
+      
+      # Get data as array of body, properties
+      def data
+        @data ||= file? ?
+          repos.file(fs_path, revision) :
+          repos.dir(fs_path, revision)
+      end
+      
+      # Properties based on the revision information: svn_updated_[rev|at|by]
+      # as a hash
+      def rev_properties
+        {
+          'svn_updated_at' => @changeset.date,
+          'svn_updated_by' => @changeset.author,
+          'svn_updated_rev' => @changeset.revision
+        }
+      end
+    
+      # Get properties stored as subversion properties, that begin with the
+      # Config#property_prefix.
+      def svn_properties
+        props = {}
+        data[1].each do |name, val|
+          if name =~ /\A#{config.property_prefix}(.*)/
+            props[$1] = val
+          end
+        end
+        props
+      end
+    
+      # Get YAML properties. For a directory, these are stored in meta.yml,
+      # for a file, they are stored at the beginning of the file: the first line
+      # will be "---" and the YAML will end before a line containing "..."
+      def yaml_properties
+        if directory?
+          fs_yaml_path = fs_path.blank? ? 'meta.yml' : File.join(fs_path, 'meta.yml')
+          yaml_path = File.join(@path, 'meta.yml')
+          repos.stat(fs_yaml_path, revision) ?
+            YAML.load(self.class.new(@changeset, yaml_path).body) :
+            {}
+        else
+          has_yaml_props? ?
+            YAML.load(yaml_split[0]) :
+            {}
+        end
+      end
+      
+      # Determine if file has yaml properties, by checking if the file starts
+      # with three leading dashes
+      def has_yaml_props?
+        file? && data[0][0..2] == "---"
+      end
+      
+      # Split a file between properties and body at a line with three dots.
+      # Left trim the body and there may have been blank lines added for
+      # clarity.
+      def yaml_split
+        data[0].gsub!("\r", "")
+        ary = data[0].split("\n...\n")
+        ary[1] = ary[1].lstrip
+        ary
+      end
+
+    end
+  end
+end
+   

data/lib/dm-svn/svn/sync.rb

@@ -0,0 +1,85 @@
+module DmSvn
+  module Svn
+    class Sync
+      
+      attr_reader :model, :config, :repos
+
+      def initialize(model_row)
+        @model_row = model_row
+        @model = Object.const_get(@model_row.name)
+        @config = @model_row.config
+      end
+      
+      # Get changesets
+      def changesets
+        sets = []
+        
+        @repos.log('', @model_row.revision, @repos.latest_revnum, 0, true, false
+            ) do |changes, rev, author, date, msg|
+          sets << Changeset.new(changes, rev, author, date, self)
+        end
+        
+        sets.sort
+      end
+      
+      # There is the possibility for uneccessary updates, as a database row may be
+      # modified several times (if modified in multiple revisions) in a single
+      # call. This is inefficient, but--for now--not enough to justify more
+      # complex code.
+      def run
+        connect(@config.uri)
+        return false if @repos.latest_revnum <= @model_row.revision
+        
+        changesets.each do |c| # Sorted by revision, ascending
+          c.process
+          # Update model_row.revision
+          row_update = @model_row.class.get(@model_row.id)
+          row_update.update(:revision => c.revision)
+        end
+        
+        # Ensure that @model_row.revision is now set to the latest (even if there
+        # weren't applicable changes in the latest revision).
+        row_update = @model_row.class.get(@model_row.id)
+        row_update.update(:revision => @repos.latest_revnum)
+        return true
+      end
+      
+      private
+      
+      def connect(uri)
+        @ctx = context(uri)
+       
+        # This will raise some error if connection fails for whatever reason.
+        # I don't currently see a reason to handle connection errors here, as I
+        # assume the best handling would be to raise another error.
+        @repos = ::Svn::Ra::Session.open(uri, {}, callbacks)
+        @config.path_from_root = @config.uri[(@repos.repos_root.length)..-1]
+        return true
+      end
+  
+      def context(uri)
+        # Client::Context, which paticularly holds an auth_baton.
+        ctx = ::Svn::Client::Context.new
+        if @config.username && @config.password
+          # TODO: What if another provider type is needed? Is this plausible?
+          ctx.add_simple_prompt_provider(0) do |cred, realm, username, may_save|
+            cred.username = @config.username
+            cred.password = @config.password
+          end
+        elsif URI.parse(uri).scheme == "file" 
+          ctx.add_username_prompt_provider(0) do |cred, realm, username, may_save|
+            cred.username = @config.username || "ANON"
+          end
+        else
+          ctx.auth_baton = ::Svn::Core::AuthBaton.new()
+        end
+        ctx
+      end
+    
+      # callbacks for Svn::Ra::Session.open. This includes the client +context+.
+      def callbacks
+        ::Svn::Ra::Callbacks.new(@ctx.auth_baton)
+      end
+    end
+  end
+end

data/spec/dm-svn/config_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe DmSvn::Config do
+  before(:each) do
+    @c = DmSvn::Config.new
+  end
+  
+  it "should initialize @body_property to 'body'" do
+    @c.body_property.should == 'body'
+  end
+
+  it "should modify @body_property" do
+    @c.body_property = 'contents'
+    @c.body_property.should == 'contents'
+  end
+  
+  it "should initialize @property_prefix to 'ws:'" do
+    @c.property_prefix.should == 'ws:'
+  end
+  
+  it "should initialize @extension to 'txt'" do
+    @c.extension.should == 'txt'
+  end
+  
+  it "should load config options from database.yml" do
+    Merb = Object.new
+    def Merb.root
+      '/path/to/merb'
+    end
+    
+    def Merb.env(*args)
+      :test
+    end
+    
+    f = "#{Merb.root}/config/database.yml"
+    yaml = File.read(File.dirname(__FILE__) + '/database.yml')
+    IO.should_receive(:read).with(f).and_return(yaml)
+ 
+    c = DmSvn::Config.new
+    c.username.should == 'login'
+    c.password.should == 'pw1234'
+    c.extension.should == 'doc'
+    c.body_property.should == 'body' # Didn't change
+    Object.__send__(:remove_const, :Merb)
+  end
+  
+  after(:all) do
+    # ensure this happens
+    Object.__send__(:remove_const, :Merb) if Object.const_defined?(:Merb)
+  end
+end

data/spec/dm-svn/database.yml

@@ -0,0 +1,16 @@
+---
+
+:development: &defaults
+  :adapter: sqlite3
+  :database: dev.db
+
+:test:
+  <<: *defaults
+  :database: test.db
+  :svn_username: login
+  :svn_password: pw1234
+  svn_extension: doc
+
+:production:
+  <<: *defaults
+  :database: pro.db

data/spec/dm-svn/fixtures/articles_comments.rb

@@ -0,0 +1,95 @@
+# This is a repository representing information for two models in one repo.
+
+SvnFixture.repo('articles_comments') do
+  revision(1, 'Create articles and comments directories',
+      :date => Time.parse("2007-01-01")) do
+    dir 'articles'
+    dir 'comments'
+  end
+  
+  revision 2, 'Create articles about computers and philosophy' do
+    dir 'articles' do
+      prop 'ws:title', 'Articles'
+      
+      file 'philosophy.txt' do
+        prop 'ws:title', 'Philosophy'
+        prop 'ws:published_at', (Time.now - 2 * 24 * 3600) # 2.days.ago
+        body 'My philosophy is to eat a lot of salsa!'
+      end
+      
+      file 'computers.txt' do
+        prop 'ws:title', 'Computers'
+        prop 'ws:published_at', (Time.now - 1 * 24 * 3600) # 1.day.ago
+        body 'Computers do not like salsa so much.'
+      end      
+    end
+  end
+  
+  revision 3, 'Write unpublished Article', :author => "author" do
+    dir 'articles' do
+      file 'unpublished.txt' do
+        prop 'ws:title', 'Private Thoughts'
+        body "See, it's not published.\nYou can't read it."
+      end
+    end
+  end
+  
+  revision 4, 'Decide to publish unpublished Article' do
+    dir 'articles' do
+      file 'unpublished.txt' do
+        prop 'ws:published_at', (Time.now - 3600) # 1.hour.ago
+      end
+    end
+  end
+  
+  revision 5, 'Update text of Computer article' do
+    dir 'articles' do
+      file 'computers.txt' do
+        body 'Computers do not like salsa very much.'
+      end
+    end
+  end
+  
+  revision 6, 'Add a couple of comments' do
+    dir 'comments' do
+      file 'computers_1.txt' do
+        prop 'ws:article', 'computers.txt'
+        body "They don't like most liquids"
+      end
+    end
+
+    dir 'comments' do
+      file 'computers_2.txt' do
+        prop 'ws:article', 'computers.txt'
+        body "OH, RLY?"
+      end
+    end
+  end
+  
+  revision 7, 'Moves and copies' do
+    dir 'articles' do
+      move 'unpublished.txt', 'just_published.txt'
+      copy 'computers.txt', 'computations.txt'
+    end
+  end
+  
+  revision 8, 'Delete computers.txt' do
+    dir 'articles' do
+      delete 'computers.txt'
+    end
+  end
+  
+  revision 9, 'Add nodes with YAML properties' do
+    dir 'articles' do
+      file 'meta.yml' do
+        body "title: Lots of Articles\nrandom_number: 7"
+      end
+      
+      file 'turtle.txt' do
+        body "---\ntitle: Turtle\nrandom_number: 2\n...\nHi, turtle."
+      end
+    end
+  end
+end
+
+SvnFixture.repo('articles_comments').commit