repository-manager 0.1.24 → 0.1.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3143ce6c4c30c092465f7df4d8a6d034af441c20
-  data.tar.gz: e8312b152f841ae69fcd5edb97e72d403c00b502
+  metadata.gz: 1cdc3ac29c2dc1407eeaa3fc1471f821f4c473f6
+  data.tar.gz: 581c7a987d26e143705e1d711560c5f36e442486
 SHA512:
-  metadata.gz: cadd9617228aca58a60b5eaf42d2adc4407d845e67dde41e689f2d8fc9c5b9cd8090d5804e20320d7b2cf5dbaadebd8961749c2a59e0c8308c8670f3be8b6a89
-  data.tar.gz: c9d6f0071279a2c4dd565bc43176502e7fb98b8b2e1cdfbe5420d140495745f765692691341b02ad555b0aa999efc9ac33266abcc8e46ee36244e3f9b8b2a00a
+  metadata.gz: 5a9b3bc0edccafabddd82c4f74734a4a5288cf0d27a6688ba1b93c5d8947315234a99a6a081296c3f8f2308ce5fa38a3b39fd1fcf77f232dc0ffcffb1a84d549
+  data.tar.gz: 60f9161a4018fa0cdba2bf0734e978e9d83bc4432a795d8b6bbce58299270d50e8450efecadd4c75699660f04ed990400b704b09ab9baaaba8da7939c150ba41

data/README.md

@@ -120,7 +120,7 @@ The two methods do the same, but the one with the "!" returns an Exception error
 
 ### How can I create/delete/move a repo_item (file or folder)
 
-You just have to call the `has_repository` methods `create_file`, `create_folder`, `move_repo_item` or `delete_repo_item`.
+You just have to call the `has_repository` methods `create_file`, `create_folder`, `move_repo_item`, `copy_repo_item` or `delete_repo_item`. [Check here for all `has_repository` methods]  (https://github.com/Texicitys/repository-manager/wiki/Has_repository-methods).
 
 ```ruby
 # user1 wants to create a folder in his repository
@@ -174,7 +174,7 @@ test_folder = user1.create_folder('Test folder')
 #   |-- 'Test folder'
 
 # user1 want to move 'The new folder' in 'Test folder'
-user1.move_repo_item(the_new_folder, source_folder: test_folder)
+user1.move_repo_item(the_new_folder, test_folder)
 
 # user1 own repository :
 #   |-- 'Root folder'
@@ -193,6 +193,17 @@ user1.rename_repo_item(the_new_folder, 'The renamed folder')
 #   |  |-- 'The renamed folder'
 #   |  |  |-- 'file.txt'
 
+# user1 want to copy 'Root folder' into 'Test folder'
+user1.copy_repo_item(source_folder, test_folder)
+
+# user1 own repository :
+#   |-- 'Root folder'
+#   |-- 'file2.jpg'
+#   |-- 'Test folder'
+#   |  |-- 'Root folder'
+#   |  |-- 'The renamed folder'
+#   |  |  |-- 'file.txt'
+
 # Delete a repo_item
 # Note : user1 needs the ':can_delete => true' permission in the folder : the_new_folder (else the method returns `false`).
 user1.delete_repo_item(test_folder)
@@ -453,6 +464,47 @@ path = the_folder.download
 the_folder.delete_zip
 ```
 
+### Errors handling
+
+When an error happen, you (and the user also) want to know what was the source of this problem. I tried to make it the most simple as possible.
+
+For the two `has_repository` methods `create_file` and `create_folder`, the errors are pushed into the `options` hash parameter with the key `errors` (`options[:errors]`)
+
+
+```ruby
+# We want to redirect back with the notice 'Folder created' if the folder is created, and show the error(s) otherwise
+options = {source_folder: repo_item, sender: current_user}
+if @item = @group.create_folder(params[:repo_folder][:name], options)
+    redirect_to back, notice: 'Folder created'
+else
+    redirect_to back, alert: options[:errors].first # Contains the first text message error
+
+options[:errors] # Contains array of errors
+
+# Same for create_file
+options = {source_folder: repo_item, sender: current_user}
+if @item = @group.create_file(params[:repo_file][:file], options)
+    redirect_to back, notice: 'File created'
+else
+    redirect_to back, alert: options[:errors].first # Contains the first text message(s) error(s)
+
+options[:errors] # Contains array of errors
+```
+
+For the other `has_repository` methods, the error is added to the first object passed in parameter (for instance: `repo_item` or `sharing`)
+
+
+```ruby
+# We want to catch the error if it has one
+if @group.delete_repo_item(@repo_item)
+    redirect_to :back, notice: 'Item deleted'
+else
+    # repo_item.errors ==> Contains the errors
+    redirect_to :back, alert: repo_item.errors.messages[:delete].first
+end
+```
+
+
 ## TODO
 
 - Do the rename file method

data/lib/repository_manager/has_repository.rb

@@ -311,7 +311,7 @@ module RepositoryManager
         end
       end
 
-      # Move the repo_item. If you let all options empty, the item is moving into the self.root
+      # Move the repo_item
       # target =>  move into this source_folder
       # if target == nil, move to the root
       def move_repo_item!(repo_item, target = nil)
@@ -401,7 +401,7 @@ module RepositoryManager
         FileUtils.rm_rf(self.get_default_download_path())
       end
 
-      #Return the permissions of the sharing (can_add, can_remove)
+      # Return the permissions of the sharing (can_add, can_remove)
       def get_sharing_permissions(sharing)
         sharing.get_permissions(self)
       end
@@ -464,7 +464,7 @@ module RepositoryManager
         can_do_to?('remove', sharing)
       end
 
-      # You can here add new members in the sharing
+      # Add new members in the sharing
       # Param member could be an object or an array of object
       def add_members_to!(sharing, members, options = RepositoryManager.default_sharing_permissions)
         permissions = get_sharing_permissions(sharing)
@@ -485,7 +485,7 @@ module RepositoryManager
         end
       end
 
-      # You can here remove members in the sharing
+      # Remove members in the sharing
       # Param member could be an object or an array of object
       def remove_members_from!(sharing, members)
         if can_remove_from?(sharing)

data/lib/repository_manager/version.rb

@@ -1,3 +1,3 @@
 module RepositoryManager
-  VERSION = '0.1.24'
+  VERSION = '0.1.25'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: repository-manager
 version: !ruby/object:Gem::Version
-  version: 0.1.24
+  version: 0.1.25
 platform: ruby
 authors:
 - Yves Baumann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-06 00:00:00.000000000 Z
+date: 2014-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails