dm-svn 0.2.0

data/.gitignore

@@ -0,0 +1,23 @@
+.DS_Store
+log/*
+tmp/*
+TAGS
+*~
+.#*
+schema/schema.rb
+schema/*_structure.sql
+schema/*.sqlite3
+schema/*.sqlite
+schema/*.db
+*.sqlite
+*.sqlite3
+*.db
+src/*
+.hgignore
+.hg/*
+.svn/*
+.project
+.loadpath
+lib/wistle/tmp/*
+config/recaptcha.yml
+*qt_temp*

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dm-svn"
+    gem.summary = %Q{Sync content from a Subversion repository to a DataMapper model}
+    gem.description = %Q{dm-svn allows you to store data in a Subversion
+repository, then sync that data to a DataMapper model (for example, to a
+relational database. Essentially, it allows you app quicker access to the
+Subversion data.}
+    gem.email = "jmorgan@morgancreative.net"
+    gem.homepage = "http://github.com/jm81/dm-svn"
+    gem.authors = ["Jared Morgan"]
+    gem.add_dependency('dm-core', '>= 0.10.0')
+    gem.add_dependency('dm-aggregates', '>= 0.10.0')
+    gem.add_dependency('dm-validations', '>= 0.10.0')
+    gem.add_dependency('jm81-svn-fixture', '>= 0.1.1')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dm-svn #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/dm-svn.gemspec

@@ -0,0 +1,85 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dm-svn}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jared Morgan"]
+  s.date = %q{2009-10-11}
+  s.description = %q{dm-svn allows you to store data in a Subversion
+repository, then sync that data to a DataMapper model (for example, to a
+relational database. Essentially, it allows you app quicker access to the
+Subversion data.}
+  s.email = %q{jmorgan@morgancreative.net}
+  s.files = [
+    ".gitignore",
+     "Rakefile",
+     "VERSION",
+     "dm-svn.gemspec",
+     "lib/dm-svn.rb",
+     "lib/dm-svn/config.rb",
+     "lib/dm-svn/model.rb",
+     "lib/dm-svn/svn.rb",
+     "lib/dm-svn/svn/categorized.rb",
+     "lib/dm-svn/svn/changeset.rb",
+     "lib/dm-svn/svn/node.rb",
+     "lib/dm-svn/svn/sync.rb",
+     "spec/dm-svn/config_spec.rb",
+     "spec/dm-svn/database.yml",
+     "spec/dm-svn/fixtures/articles_comments.rb",
+     "spec/dm-svn/mock_models.rb",
+     "spec/dm-svn/model_spec.rb",
+     "spec/dm-svn/spec_helper.rb",
+     "spec/dm-svn/svn/categorized_spec.rb",
+     "spec/dm-svn/svn/changeset_spec.rb",
+     "spec/dm-svn/svn/node_spec.rb",
+     "spec/dm-svn/svn/sync_spec.rb",
+     "spec/dm-svn/svn_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jm81/dm-svn}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Sync content from a Subversion repository to a DataMapper model}
+  s.test_files = [
+    "spec/dm-svn/config_spec.rb",
+     "spec/dm-svn/fixtures/articles_comments.rb",
+     "spec/dm-svn/mock_models.rb",
+     "spec/dm-svn/model_spec.rb",
+     "spec/dm-svn/spec_helper.rb",
+     "spec/dm-svn/svn/categorized_spec.rb",
+     "spec/dm-svn/svn/changeset_spec.rb",
+     "spec/dm-svn/svn/node_spec.rb",
+     "spec/dm-svn/svn/sync_spec.rb",
+     "spec/dm-svn/svn_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<dm-core>, [">= 0.10.0"])
+      s.add_runtime_dependency(%q<dm-aggregates>, [">= 0.10.0"])
+      s.add_runtime_dependency(%q<dm-validations>, [">= 0.10.0"])
+      s.add_runtime_dependency(%q<jm81-svn-fixture>, [">= 0.1.1"])
+    else
+      s.add_dependency(%q<dm-core>, [">= 0.10.0"])
+      s.add_dependency(%q<dm-aggregates>, [">= 0.10.0"])
+      s.add_dependency(%q<dm-validations>, [">= 0.10.0"])
+      s.add_dependency(%q<jm81-svn-fixture>, [">= 0.1.1"])
+    end
+  else
+    s.add_dependency(%q<dm-core>, [">= 0.10.0"])
+    s.add_dependency(%q<dm-aggregates>, [">= 0.10.0"])
+    s.add_dependency(%q<dm-validations>, [">= 0.10.0"])
+    s.add_dependency(%q<jm81-svn-fixture>, [">= 0.1.1"])
+  end
+end

data/lib/dm-svn.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'dm-core'
+require 'dm-aggregates' # Only needed by specs, but this seems the easiest place to require.
+require 'dm-validations'
+require 'svn/client'
+
+module DmSvn
+  VERSION = '0.2.0'
+end
+
+require 'dm-svn/config'
+require 'dm-svn/svn'
+require 'dm-svn/model'

data/lib/dm-svn/config.rb

@@ -0,0 +1,38 @@
+module DmSvn
+  class Config
+    OPTS = [:uri, :username, :password,
+            :body_property, :property_prefix, :extension]
+    
+    attr_accessor *OPTS
+    attr_accessor :path_from_root # Used by Sync.
+    
+    def initialize
+      # Set defaults
+      @body_property = 'body'
+      @property_prefix = 'ws:'
+      @extension = 'txt'
+
+      # Try to set variables from database.yml.
+      # The location of database.yml should, I suppose, be configurable.
+      # Oh, well.
+      if Object.const_defined?("RAILS_ROOT")
+        f = "#{RAILS_ROOT}/config/database.yml"
+        env = Kernel.const_defined?("RAILS_ENV") ? RAILS_ENV : "development"
+      elsif Object.const_defined?("Merb")
+        f = "#{Merb.root}/config/database.yml"
+        env = Merb.env.to_sym || :development
+      end
+      
+      if f
+        config = YAML.load(IO.read(f))[env]
+        OPTS.each do |field|
+          config_field = config["svn_#{field}"] || config["svn_#{field}".to_sym]
+          if config_field
+            instance_variable_set("@#{field}", config_field)
+          end
+        end
+      end
+      
+    end
+  end
+end

data/lib/dm-svn/model.rb

@@ -0,0 +1,12 @@
+module DmSvn
+  class Model
+    include DataMapper::Resource
+  
+    property :id, Serial
+    property :name, String
+    property :revision, Integer
+    
+    # DmSvn::Config object
+    attr_accessor :config
+  end
+end

data/lib/dm-svn/svn.rb

@@ -0,0 +1,144 @@
+module DmSvn
+  module Svn
+    
+    class << self
+      def included(klass) # Set a few 'magic' properties
+        klass.extend(ClassMethods)
+        
+        # svn_name could be just a name, or a full path, always excluding
+        # extension. If directories are stored in a model (not yet supported),
+        # it contains the full path (from the config.uri).
+        klass.property :svn_name, DataMapper::Types::Text, :lazy => false
+        klass.property :svn_created_at, DateTime
+        klass.property :svn_updated_at, DateTime
+        klass.property :svn_created_rev, String
+        klass.property :svn_updated_rev, String
+        klass.property :svn_created_by, String
+        klass.property :svn_updated_by, String
+        
+        # On create, set svn_created_* attrs based on svn_updated_* attrs
+        klass.before :create do
+          attribute_set(:svn_created_at, svn_updated_at)
+          attribute_set(:svn_created_rev, svn_updated_rev)
+          attribute_set(:svn_created_by, svn_updated_by)
+        end
+      end
+    end
+    
+    # +name+ could be reasonably used for another property, but may normally
+    # be assumed to be the 'svn_name'.
+    def name
+      @svn_name
+    end
+    
+    # The path from the svn root for the model. For the moment, just an alias
+    # of +svn_name+.
+    def path
+      @svn_name
+    end
+    
+    # Set the path. This may be responsible for moving the record to a different
+    # parent, etc.
+    def path=(value)
+      attribute_set(:svn_name, value)
+    end
+    
+    # Move to a different path and save
+    def move_to(new_path)
+      self.path = new_path
+      self.save
+    end
+    
+    # Update properties (body and other properties) from a DmSvn::Svn::Node
+    # or similar (expects #body as a String and #properties as a Hash).
+    # This method calls #save.
+    def update_from_svn(node)
+      attribute_set(self.class.config.body_property, node.body) if node.body
+      self.path = node.short_path
+      
+      node.properties.each do | attr, value |
+        if self.respond_to?("#{attr}=")
+          self.__send__("#{attr}=", value)
+        end
+      end
+      
+      if !valid?
+        puts "Invalid #{node.short_path} at revision #{node.revision}"
+        puts " - " + errors.full_messages.join(".\n - ")
+      end
+      
+      save
+    end
+    
+    module ClassMethods
+      def config
+        @config ||= Config.new
+      end
+      
+      # Override belongs_to to add +:svn+ option. If :svn => true is
+      # included in the options, SvnSync will also sync the +belongs_to+ model.
+      # For example, <code>belongs_to :category, :svn => true</code>, means
+      # that the Category model will also be updated by SvnSync, and be based on
+      # folders. Folders can have svn properties set, and/or a meta.yml file
+      # with properties.
+      # def belongs_to(name, options={})
+      #   
+      # end
+      
+      # Override DataMapper's +property+ class method to accept as an option
+      # +body_property+. Setting this option tells DmSvn::Svn that this field
+      # will store the contents of the repository file.
+      def property(name, type, options = {})
+        if options.delete(:body_property)
+          config.body_property = name.to_s
+        end
+        
+        super(name, type, options)
+      end
+      
+      # DataMapper uses +repository+, so prepend "svn_"
+      def svn_repository
+        return @svn_repository if @svn_repository
+        
+        @svn_repository = DmSvn::Model.first(:name => self.name)
+        @svn_repository ||= DmSvn::Model.create(:name => self.name, :revision => 0)
+        @svn_repository.config = config
+        @svn_repository
+      end
+      
+      def sync
+        DmSvn::Svn::Sync.new(svn_repository).run
+      end
+      
+      # Override normal get behavior to try to get based on path if the argument
+      # is a String. Extra args are ignored by default.
+      def get(path_or_id, *args)
+        if path_or_id.is_a?(String)
+          get_by_path(path_or_id)
+        else
+          super
+        end
+      end
+      
+      # Try to get by path. If not, create a new record and so set its path.
+      def get_or_create(path)
+        i = get_by_path(path)
+        return i if i
+        
+        i = create
+        i.path = path
+        i.save
+        return i
+      end
+      
+      def get_by_path(path)
+        first(:svn_name => path)
+      end
+    end
+    
+  end
+end
+
+%w{sync changeset node categorized}.each do |f|
+  require "dm-svn/svn/#{f}"
+end

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

@@ -0,0 +1,113 @@
+module DmSvn
+  module Svn
+    
+    module ClassMethods
+      
+      # Override belongs_to to add a :dm-svn option if :dm-svn => true, include
+      # Categorized and set up @svn_category and @svn_category_model instance
+      # methods.
+      def belongs_to(what, options = {})
+        svn = options.delete(:svn)
+        if svn
+          @svn_category = what
+          @svn_category_model = options[:class_name] || what.to_s.camel_case
+          include(DmSvn::Svn::Categorized)
+        end
+        
+        super
+      end
+      
+      # Method name for accessing the parent instance.
+      def svn_category
+        @svn_category
+      end
+      
+      # Name of the parent model class (as a String)
+      def svn_category_model
+        @svn_category_model
+      end
+      
+    end
+    
+    # This module is including when belongs_to is called with :dm-svn => true.
+    # It overrides #path and #path= to take into account categories (folders in 
+    # the Subversion repository). It also overrides .get to accept get_parent
+    # argument.
+    module Categorized
+      class << self
+        def included(klass)
+          klass.extend(ClassMethods)
+        end
+      end
+      
+      # The path from the svn root for the model. Includes any folders.
+      def path
+        cat = self.send(self.class.svn_category)
+        
+        if cat && !cat.path.blank?
+          return cat.path + "/" + @svn_name
+        end
+        
+        return @svn_name
+      end
+    
+      # Set the path. This is responsible for moving the record to a different
+      # parent, etc.
+      def path=(value)
+        value = value[1..-1] while value[0..0] == "/"
+        ary = value.split("/")
+        immediate = ary.pop
+        parent = ary.join("/")
+        
+        if parent.blank?
+          self.send("#{self.class.svn_category}=", nil)
+        else
+          category_model = Object.const_get(self.class.svn_category_model)
+          category = category_model.get_or_create(parent)
+          self.send("#{self.class.svn_category}=", category)
+        end
+        
+        attribute_set(:svn_name, immediate)
+      end
+      
+      module ClassMethods
+        
+        # Get by path, which gets parent (possibly recursively) first.
+        def get_by_path(value)
+          value = value[1..-1] while value[0..0] == "/"
+          ary = value.split("/")
+          immediate = ary.pop
+          parent = ary.join("/")
+          
+          if parent.blank?
+            first(:svn_name => immediate, "#{self.svn_category}_id".to_sym => nil)
+          else
+            category_model = Object.const_get(self.svn_category_model)
+            category = category_model.get_by_path(parent)
+            return nil if category.nil?
+            first(:svn_name => immediate, "#{self.svn_category}_id".to_sym => category.id)
+          end
+        end
+        
+        # Add get_parent argument. If true and a path is not found for the 
+        # model, try to find path in parent model (if any).
+        def get(path_or_id, get_parent = false)
+          if path_or_id.is_a?(String)
+            i = get_by_path(path_or_id)
+            if i || !get_parent
+              return i 
+            else # if get_parent
+              category_model = Object.const_get(@svn_category_model)
+              return nil if category_model == self.class
+              category_model.get_by_path(path_or_id)
+            end
+          else
+            super(path_or_id)
+          end
+        end
+        
+      end
+    
+    end
+  end
+end