repository-manager 0.2.1 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1e5f978c5051186f41883c8c77158e6158828be
-  data.tar.gz: 52a66c07f18e1d37ed4a4d457835b1ae0de9d140
+  metadata.gz: dbf60a439b0b337f819cdc38e21b42351783a93f
+  data.tar.gz: e366f2254bbb226188a71f07f0457139aac5641a
 SHA512:
-  metadata.gz: a7bcfa49b4121c96410a4fc5b0456735b7776e61086b00c8ab07f16ae5cd75b014a8fa1ace5eda185b77543f297f3a3366a38adfd17caa69c695a2fab59f9d2b
-  data.tar.gz: 3abbdfc0675b21a40a6d30f4b9f158599780db73082cebfd874d3a25b407ec12f409fae62afa6e544d6b4918e477b01b1c33cd2283279443047c66133a209ad1
+  metadata.gz: 46e363948f796a7f6830bf0a13d38e54a525a0484d3f3036597d14f55ac9f2dbc1923b28677364707d9e43298a857eb13da88fb6809b5661218f825c178b3190
+  data.tar.gz: 81cf606e9e4a4624fd484da3838396fb166a0af557db84575bb805747e2e33ecc84ae8f59b4b4e58d40ff767bf5eef49cc11277746aa825ead2a5f382a8bbbe5

data/README.md

@@ -55,18 +55,25 @@ RepositoryManager.setup do |config|
   # Default path for generating the zip file when a user want to download a folder
   # Default is : "download/#{member.class.to_s.underscore}/#{member.id}/#{self.class.to_s.underscore}/#{self.id}/"
   #config.default_zip_path = true
+
+  # Define if we enable or not the versioning on the repo_item
+  config.has_paper_trail = false
 end
 ```
 
-For instance, if you want that a default sharing is totally free (for edit, delete, etc), just put all default parameters to `true` :
+For instance, if you want that a default sharing is totally free (for edit, delete, etc), just put all default parameters to `true`. We want that paper_trail is activate:
 
 ```ruby
 RepositoryManager.setup do |config|
   config.default_repo_item_permissions = { can_read: true, can_create: true, can_update: true, can_delete: true, can_share: true }
   config.default_sharing_permissions = { can_add: true, can_remove: true }
+  config.has_paper_trail = true
 end
 ```
 
+NOTE : If you want to add paper_trail to the repo_item model. You first have to install PaperTrail in you project.
+More informations on the [documentation of the PaperTrail gem](https://github.com/airblade/paper_trail)
+
 
 See the chapter [Permissions](#permissions) for more details about the permissions.
 
@@ -522,6 +529,9 @@ end
 # repo_item.errors ==> Contains the errors
 ```
 
+## Documentation
+
+For more documentation go on the [Repository Manager Doc](http://rubydoc.info/gems/repository-manager/index).
 
 ## TODO
 

data/app/models/repository_manager/repo_file.rb

@@ -1,5 +1,5 @@
 class RepositoryManager::RepoFile < RepositoryManager::RepoItem
-  attr_accessible :file, :content_type, :file_size if RepositoryManager.protected_attributes?
+  attr_accessible :file, :content_type, :file_size, :checksum if RepositoryManager.protected_attributes?
 
   validates_presence_of :file
   mount_uploader :file, RepoFileUploader
@@ -29,24 +29,39 @@ class RepositoryManager::RepoFile < RepositoryManager::RepoItem
   #   :source_folder = the folder in witch you copy this item
   #   :owner = the owner of the item
   #   :sender = the sender of the item (if you don't specify sender.. The sender is still the same)
+  #   :overwrite = overwrite an item with the same name (default : see config 'auto_overwrite_item')
   def copy!(options = {})
+    !!options[:overwrite] == options[:overwrite] ? overwrite = options[:overwrite] : overwrite = RepositoryManager.auto_overwrite_item
+
     new_item = RepositoryManager::RepoFile.new
     new_item.file = File.open(self.file.current_path)
-
-    if options[:source_folder]
-      options[:source_folder].add!(new_item)
-    elsif options[:owner].repo_item_name_exist_in_root?(new_item.name)
-      self.errors.add(:copy, I18n.t('repository_manager.errors.repo_item.item_exist'))
-      raise RepositoryManager::ItemExistException.new("copy failed. The repo_file '#{new_item.name}' already exist in root.")
-    end
+    new_item.name = self.name
 
     options[:owner] ? new_item.owner = options[:owner] : new_item.owner = self.owner
-    if options[:sender]
-      new_item.sender = options[:sender]
-      #elsif options[:owner]
-      #  new_item.sender = options[:owner]
+    options[:sender] ? new_item.sender = options[:sender] : new_item.sender = self.sender
+
+    if options[:source_folder]
+      new_item = options[:source_folder].add!(new_item, do_not_save: true, overwrite: overwrite )
+    elsif options[:owner]
+      repo_item_with_same_name = options[:owner].get_item_in_root_by_name(new_item.name)
+      if repo_item_with_same_name and !overwrite
+        self.errors.add(:copy, I18n.t('repository_manager.errors.repo_item.item_exist'))
+        raise RepositoryManager::ItemExistException.new("copy failed. The repo_file '#{new_item.name}' already exist in root.")
+      elsif repo_item_with_same_name and overwrite
+        repo_item_with_same_name.file = new_item.file
+        repo_item_with_same_name.sender = new_item.sender
+        new_item = repo_item_with_same_name
+      end
     else
-      new_item.sender = self.sender
+      repo_item_with_same_name = self.owner.get_item_in_root_by_name(new_item.name)
+      if repo_item_with_same_name and !overwrite
+        self.errors.add(:copy, I18n.t('repository_manager.errors.repo_item.item_exist'))
+        raise RepositoryManager::ItemExistException.new("copy failed. The repo_file '#{new_item.name}' already exist in root.")
+      elsif repo_item_with_same_name and overwrite
+        repo_item_with_same_name.file = new_item.file
+        repo_item_with_same_name.sender = new_item.sender
+        new_item = repo_item_with_same_name
+      end
     end
 
     new_item.save!
@@ -67,6 +82,7 @@ class RepositoryManager::RepoFile < RepositoryManager::RepoItem
     if file.present? && file_changed?
       self.content_type = file.file.content_type
       self.file_size = file.file.size
+      self.checksum = Digest::MD5.file(file.path).hexdigest
     end
   end
 

data/app/models/repository_manager/repo_folder.rb

@@ -5,23 +5,42 @@ class RepositoryManager::RepoFolder < RepositoryManager::RepoItem
   validates :name, presence: true
 
   # Add a repo_item in the folder.
-  # second param destroy the repo_item if it can move it.
-  def add!(repo_item, destroy_if_fail = false)
+  # options
+  #   :destroy_if_fail = false // the repo_item if it can't move it.
+  #   :do_not_save = false // Save the repo_item after changing his param
+  #   :overwrite = overwrite an item with the same name (default : see config 'auto_overwrite_item')
+  # second param destroy the repo_item if it can't move it.
+  def add!(repo_item, options = {})
+    !!options[:overwrite] == options[:overwrite] ? overwrite = options[:overwrite] : overwrite = RepositoryManager.auto_overwrite_item
+
     # We check if this name already exist
-    #if repo_item.children.exists?(:name => repo_item.name)
-    if name_exist_in_children?(repo_item.name)
+    repo_item_with_same_name = get_children_by_name(repo_item.name)
+    if repo_item_with_same_name && !overwrite
       # we delete the repo if asked
-      repo_item.destroy if destroy_if_fail
+      repo_item.destroy if options[:destroy_if_fail]
       raise RepositoryManager::ItemExistException.new("add failed. The repo_item '#{repo_item.name}' already exist in the folder '#{name}'")
+    elsif repo_item_with_same_name && overwrite
+      # We destroy it
+      if repo_item_with_same_name.is_file?
+        #p "add: updates the file #{repo_item.name}"
+        repo_item_with_same_name.file = repo_item.file
+        repo_item_with_same_name.sender = repo_item.sender
+        repo_item_with_same_name.owner = repo_item.owner
+        repo_item = repo_item_with_same_name
+      else
+        repo_item_with_same_name.destroy!
+      end
     else
-      repo_item.update_attribute :parent, self
+      repo_item.parent = self
+      repo_item.save! unless options[:do_not_save]
     end
+    repo_item
   end
 
   def add(repo_item)
     begin
       add!(repo_item)
-    rescue RepositoryManager::ItemExistException
+    rescue RepositoryManager::ItemExistException, ActiveRecord::RecordInvalid, ActiveRecord::RecordNotSaved
       false
     end
   end
@@ -31,31 +50,41 @@ class RepositoryManager::RepoFolder < RepositoryManager::RepoItem
   #   :source_folder = the folder in witch you copy this item
   #   :owner = the owner of the item
   #   :sender = the sender of the item (if you don't specify sender.. The sender is still the same)
+  #   :overwrite = overwrite an item with the same name (default : see config 'auto_overwrite_item')
   def copy!(options = {})
+    !!options[:overwrite] == options[:overwrite] ? overwrite = options[:overwrite] : overwrite = RepositoryManager.auto_overwrite_item
+
     new_item = RepositoryManager::RepoFolder.new
     new_item.name = self.name
 
-    if options[:source_folder]
-      options[:source_folder].add!(new_item)
-    elsif options[:owner].repo_item_name_exist_in_root?(new_item.name)
-      self.errors.add(:copy, I18n.t('repository_manager.errors.repo_item.item_exist'))
-      raise RepositoryManager::ItemExistException.new("copy failed. The repo_folder '#{new_item.name}' already exist in root.")
-    end
-
     options[:owner] ? new_item.owner = options[:owner] : new_item.owner = self.owner
-    if options[:sender]
-      new_item.sender = options[:sender]
-      #elsif options[:owner]
-      #  new_item.sender = options[:owner]
+    options[:sender] ? new_item.sender = options[:sender] : new_item.sender = self.sender
+
+    if options[:source_folder]
+      options[:source_folder].add!(new_item, do_not_save: true)
+    elsif options[:owner]
+      repo_item_with_same_name = options[:owner].get_item_in_root_by_name(new_item.name)
+      if repo_item_with_same_name and !overwrite
+        self.errors.add(:copy, I18n.t('repository_manager.errors.repo_item.item_exist'))
+        raise RepositoryManager::ItemExistException.new("copy failed. The repo_folder '#{new_item.name}' already exist in root.")
+      elsif repo_item_with_same_name and overwrite
+        repo_item_with_same_name.destroy!
+      end
     else
-      new_item.sender = self.sender
+      repo_item_with_same_name = self.owner.get_item_in_root_by_name(new_item.name)
+      if repo_item_with_same_name and !overwrite
+        self.errors.add(:copy, I18n.t('repository_manager.errors.repo_item.item_exist'))
+        raise RepositoryManager::ItemExistException.new("copy failed. The repo_file '#{new_item.name}' already exist in root.")
+      elsif repo_item_with_same_name and overwrite
+        repo_item_with_same_name.destroy!
+      end
     end
 
-    new_item.save!
+    new_item.save
 
-    # Recursive method who copy all children.
+    # Recursive method which copy all children.
     children.each do |c|
-      c.copy!(source_folder: new_item, owner: options[:owner], sender: options[:sender])
+      c.copy!(source_folder: new_item, owner: options[:owner], sender: options[:sender], overwrite: overwrite)
     end
 
     new_item
@@ -134,7 +163,11 @@ class RepositoryManager::RepoFolder < RepositoryManager::RepoItem
   # Returns true or false if the name exist in this folder
   def name_exist_in_children?(name)
     #RepositoryManager::RepoItem.where(name: name).where(id: child_ids).first ? true : false
-    RepositoryManager::RepoItem.where('name = ?', name).where(id: child_ids).first ? true : false
+    get_children_by_name(name) ? true : false
+  end
+
+  def get_children_by_name(name)
+    RepositoryManager::RepoItem.where('name = ?', name).where(id: child_ids).first
   end
 
   private

data/app/models/repository_manager/repo_item.rb

@@ -5,6 +5,10 @@ class RepositoryManager::RepoItem < ActiveRecord::Base
 
   before_save :put_sender
 
+  if RepositoryManager.has_paper_trail
+    has_paper_trail
+  end
+
   has_ancestry cache_depth: true
 
   # Associate with the User Class
@@ -31,23 +35,42 @@ class RepositoryManager::RepoItem < ActiveRecord::Base
   # options
   #   :source_folder = the folder in witch you copy this item
   #   :owner = the owner of the item
+  #   :overwrite = overwrite an item with the same name (default : see config 'auto_overwrite_item')
   # If :source_folder = nil, move to the root (of same owner)
   def move!(options = {})
-    # If we are in source_folder, we check if it's ok
+    !!options[:overwrite] == options[:overwrite] ? overwrite = options[:overwrite] : overwrite = RepositoryManager.auto_overwrite_item
+
+    # If we are in source_folder, we check if it's a folder
     if options[:source_folder]
       unless options[:source_folder].is_folder?
         raise RepositoryManager::RepositoryManagerException.new("move failed. target '#{options[:source_folder].name}' can't be a file")
       end
-      if options[:source_folder].name_exist_in_children?(self.name)
+
+      children_with_same_name = options[:source_folder].get_children_by_name(self.name)
+      # If the name exist and we don't want to overwrite, we raise an error
+      if children_with_same_name and !overwrite
         self.errors.add(:move, I18n.t('repository_manager.errors.repo_item.item_exist'))
         raise RepositoryManager::ItemExistException.new("move failed. The repo_item '#{name}' already exist ine the folder '#{options[:source_folder].name}'")
+      elsif children_with_same_name and overwrite
+        # If a children with the same name exist and we want to overwrite, we have to destroy it
+        children_with_same_name.destroy!
       end
     # We are in root, we check if name exist in root
     # We stay in the same owner
-    elsif self.owner.repo_item_name_exist_in_root?(self.name)
-      self.errors.add(:move, I18n.t('repository_manager.errors.repo_item.item_exist'))
-      raise RepositoryManager::ItemExistException.new("move failed. The repo_item '#{name}' already exist ine the root")
+    else
+      # We check if a children with same name exist
+      children_with_same_name = self.owner.get_item_in_root_by_name(self.name)
+
+      # If it exist and we don t want to overwrite, we raise an error
+      if children_with_same_name and !overwrite
+        self.errors.add(:move, I18n.t('repository_manager.errors.repo_item.item_exist'))
+        raise RepositoryManager::ItemExistException.new("move failed. The repo_item '#{name}' already exist ine the root")
+      # else we destroy it
+      elsif children_with_same_name and overwrite
+        children_with_same_name.destroy!
+      end
     end
+
     # here, all is ok
     # We change the owner if another one is specify
     if options[:owner]
@@ -56,7 +79,7 @@ class RepositoryManager::RepoItem < ActiveRecord::Base
       self.owner = options[:source_folder].owner
     end
     # we update the tree with the new parent
-    self.update_attribute :parent, options[:source_folder]
+    self.parent = options[:source_folder]
     self.save!
     self
   end

data/db/migrate/20131018214212_create_repository_manager.rb

@@ -23,13 +23,14 @@ class CreateRepositoryManager < ActiveRecord::Migration
     create_table :rm_repo_items do |t|
       t.references :owner, polymorphic: true, index: true
       t.references :sender, polymorphic: true, index: true
-      t.string :ancestry
+      t.string :ancestry, index: true
       t.integer :ancestry_depth, :default => 0
       t.string :name
       t.float :file_size
       t.string :content_type
       t.string :file
       t.string :type
+      t.string :checksum
     end
   end
 end

data/lib/generators/repository_manager/templates/initializer.rb

@@ -1,7 +1,9 @@
 RepositoryManager.setup do |config|
 
   # Default repo_item permissions that an object has on the repo_item after a sharing.
-  config.default_repo_item_permissions = { can_read: true, can_create: false, can_update:false, can_delete:false, can_share: false }
+  config.default_repo_item_permissions = {
+    can_read: true, can_create: false, can_update:false, can_delete:false, can_share: false
+  }
 
   # Default sharing permissions that an object has when he is added in a sharing.
   config.default_sharing_permissions = { can_add: false, can_remove: false }
@@ -10,4 +12,10 @@ RepositoryManager.setup do |config|
   # WARNING: DO NOT CHANGE IF YOU DON'T KNOW WHAT YOU ARE DOING
   # Default is : "download/#{member.class.to_s.underscore}/#{member.id}/#{self.class.to_s.underscore}/#{self.id}/"
   #config.default_zip_path = true
+
+  # Define if we enable or not the versioning on the repo_item
+  config.has_paper_trail = false
+
+  # Define if a repo item with the same name will be automaticaly overwrited when a new item is create
+  config.auto_overwrite_item = false
 end

data/lib/repository-manager.rb

@@ -14,9 +14,11 @@ module RepositoryManager
   mattr_accessor :accept_nested_sharing
   @@accept_nested_share = false
 
-  #mattr_accessor :user_model
-  ##@@user_model = 'User'
-  #@@user_model = false
+  mattr_accessor :has_paper_trail
+  @@has_paper_trail = false
+
+  mattr_accessor :auto_overwrite_item
+  @@auto_overwrite_item = false
 
   class << self
     def setup

data/lib/repository_manager/has_repository.rb

@@ -101,6 +101,7 @@ module RepositoryManager
       # options :
       #   :source_folder = The directory in with the folder is created
       #   :sender = The object of the sender (ex : current_user)
+      #   :overwrite = overwrite an item with the same name (default : see config 'auto_overwrite_item')
       # Returns the object of the folder created if it is ok
       # Returns an Exception if the folder is not created
       #     RepositoryManagerException if the name already exist
@@ -113,6 +114,8 @@ module RepositoryManager
           end
         end
 
+        !!options[:overwrite] == options[:overwrite] ? overwrite = options[:overwrite] : overwrite = RepositoryManager.auto_overwrite_item
+
         # If he want to create a folder in a directory, we have to check if he have the permission
         if can_create?(source_folder)
 
@@ -126,13 +129,19 @@ module RepositoryManager
           folder.sender = options[:sender]
 
           # If we are in root path we check if we can add this folder name
-          if !source_folder && repo_item_name_exist_in_root?(name)
-            raise RepositoryManager::ItemExistException.new("create folder failed. The repo_item '#{name}' already exist in the root folder.")
+          if !source_folder
+            repo_item_with_same_name = get_item_in_root_by_name(name)
+            if repo_item_with_same_name && !overwrite
+              raise RepositoryManager::ItemExistException.new("create folder failed. The repo_item '#{name}' already exist in the root folder.")
+            elsif repo_item_with_same_name && overwrite
+              # We destroy the item with same name for overwrite it
+              repo_item_with_same_name.destroy!
+            end
+          else
+            # It raise an error if name already exist and destroy the folder
+            source_folder.add!(folder, do_not_save: true, overwrite: overwrite)
           end
 
-          # It raise an error if name already exist and destroy the folder
-          source_folder.add!(folder) if source_folder
-
           folder.save!
         else
           raise RepositoryManager::PermissionException.new("create_folder failed. You don't have the permission to create a folder in '#{source_folder.name}'")
@@ -181,7 +190,8 @@ module RepositoryManager
       #   :source_folder = The directory in with the folder is created
       #   :sender = The object of the sender (ex : current_user)
       #   :filename = The name of the file (if you want to rename it directly)
-      #
+      #   :overwrite = overwrite an item with the same name (default : see config 'auto_overwrite_item')
+
       # Param file can be a File, or a instance of RepoFile
       # Returns the object of the file created if it is ok
       # Returns an Exception if the folder is not created
@@ -195,6 +205,8 @@ module RepositoryManager
           end
         end
 
+        !!options[:overwrite] == options[:overwrite] ? overwrite = options[:overwrite] : overwrite = RepositoryManager.auto_overwrite_item
+
         # If he want to create a file in a directory, we have to check if he have the permission
         if can_create?(source_folder)
 
@@ -207,20 +219,39 @@ module RepositoryManager
             repo_file = RepositoryManager::RepoFile.new(file)
           end
 
-          options[:filename] ? repo_file.name = options[:filename] : repo_file.name = repo_file.file.url.split('/').last
+          options[:filename] ? file_name = options[:filename] : file_name = repo_file.file.url.split('/').last
 
+          repo_file.name = file_name
           repo_file.owner = self
           repo_file.sender = options[:sender]
 
-
           # If we are in root path we check if we can add this file name
-          if !source_folder && repo_item_name_exist_in_root?(repo_file.file.identifier)
-            raise RepositoryManager::ItemExistException.new("create file failed. The repo_item '#{repo_file.file.identifier}' already exist in the root folder.")
+          if !source_folder
+            repo_item_with_same_name = get_item_in_root_by_name(file_name)
+            if repo_item_with_same_name && !overwrite
+              raise RepositoryManager::ItemExistException.new("create file failed. The repo_item '#{file_name}' already exist in the root folder.")
+            elsif repo_item_with_same_name && overwrite
+              #We do not destroy, we update it !
+
+              # We update the file
+              repo_item_with_same_name.file = file
+
+              if file.class.name == 'RepositoryManager::RepoFile'
+                repo_item_with_same_name.file = file.file
+              elsif file.class.name == 'File' || file.class.name == 'ActionDispatch::Http::UploadedFile'
+                repo_item_with_same_name.file = file
+              else # "ActionController::Parameters"
+                repo_item_with_same_name.assign_attributes(file)
+              end
+              repo_item_with_same_name.sender = options[:sender]
+              #p "source: updates the file #{repo_item_with_same_name.name}"
+
+              repo_file = repo_item_with_same_name
+            end
+          else
+            # It raise an error if name already exist and destroy the file
+            repo_file = source_folder.add!(repo_file, do_not_save: true, overwrite: overwrite)
           end
-
-          # It raise an error if name already exist and destroy the file
-          source_folder.add!(repo_file) if source_folder
-
           repo_file.save!
         else
           raise RepositoryManager::PermissionException.new("create_file failed. You don't have the permission to create a file")
@@ -316,7 +347,9 @@ module RepositoryManager
       # options
       #   :source_folder =>  move into this source_folder
       #   if :source_folder == nil, move to the root
+      #   :overwrite = overwrite an item with the same name (default : see config 'auto_overwrite_item')
       def move_repo_item!(repo_item, options = {})
+        !!options[:overwrite] == options[:overwrite] ? overwrite = options[:overwrite] : overwrite = RepositoryManager.auto_overwrite_item
         target = options[:source_folder]
 
         if !can_read?(repo_item)
@@ -348,7 +381,7 @@ module RepositoryManager
           end
         end
         # If it has the permission, we move the repo_item in the source_folder
-        repo_item.move!(source_folder: target)
+        repo_item.move!(source_folder: target, overwrite: overwrite)
       end
 
       def move_repo_item(repo_item, options = {})
@@ -366,7 +399,10 @@ module RepositoryManager
       # options
       #   :source_folder => the folder in witch we want to copy the repo item
       #   :sender => the new sender (by default => still the old sender)
+      #   :overwrite = overwrite an item with the same name (default : see config 'auto_overwrite_item')
       def copy_repo_item!(repo_item, options = {})
+        !!options[:overwrite] == options[:overwrite] ? overwrite = options[:overwrite] : overwrite = RepositoryManager.auto_overwrite_item
+
         target = options[:source_folder]
 
         unless can_read?(repo_item)
@@ -374,7 +410,7 @@ module RepositoryManager
           raise RepositoryManager::PermissionException.new("copy repo_item failed. You don't have the permission to read the repo_item '#{repo_item.name}'")
         end
 
-        if target &&  !can_create?(target)
+        if target && !can_create?(target)
           repo_item.errors.add(:copy, I18n.t('repository_manager.errors.repo_item.copy.no_permission'))
           raise RepositoryManager::PermissionException.new("copy repo_item failed. You don't have the permission to create in the source_folder '#{target.name}'")
         end
@@ -387,7 +423,7 @@ module RepositoryManager
         end
 
         # If it has the permission, we move the repo_item in the source_folder
-        repo_item.copy!(source_folder: target, owner: owner, sender: options[:sender])
+        repo_item.copy!(source_folder: target, owner: owner, sender: options[:sender], overwrite: overwrite)
       end
 
       def copy_repo_item(repo_item, options = {})
@@ -516,7 +552,11 @@ module RepositoryManager
 
       # Returns true of false if the name exist in the root path of this instance
       def repo_item_name_exist_in_root?(name)
-        RepoItem.where('name = ?', name).where(owner: self).where(ancestry: nil).first ? true : false
+        get_item_in_root_by_name(name) ? true : false
+      end
+
+      def get_item_in_root_by_name(name)
+        RepoItem.where('name = ?', name).where(owner: self).where(ancestry: nil).first
       end
 
       private