reenrb 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c68c858766fec42e13e8d8d70ea0c60fa1a0e56c445aa148645931ed95ab1bb
-  data.tar.gz: df29a4fdad7a40025640bfb85826e1a38487423656cd59cb0e72fd897a28128c
+  metadata.gz: 7e28aaaf5fa1575c823af2027760cad2904c1d7e248ec79362dbd9c7f3762153
+  data.tar.gz: a300132794589824a89c9d17e75fd277537603b7ce7064a9ac341ba49ef423c7
 SHA512:
-  metadata.gz: 0bd3acf09e88085731e698a952d20d8368a6b1eebfaadab2ac0128dff60b1f66c6ba635c30a4ef96b00b7d15b1aeac8d0c7e91f147971be38d0c26448138edab
-  data.tar.gz: ab1fdc1f3dab04893568aa4223cf05e6e99731e0517f241f61bcd1ccd74bd22fb40185d7b775b1175e09354a279e1a218d22a0d4afa3c96a7680c40ffbbba6b2
+  metadata.gz: c6aa3d99aa7b58e4c0c22fd109d33b9f5a57348fff6df8aff9874d97ea03125566a97b486b344fe6dcb9ad29d816b47f42c1603adfdad2cbd210a5fd1d183873
+  data.tar.gz: eae4c53636ff0f0146bbc79358b6044214a4e303f65f98aedc80fcd59cf1c37eb9d32ef71fd058936acff7e80a7e87bf525346a980aab55af296ffa05fd8e328

data/README.md

@@ -2,6 +2,8 @@
 
 Reen-rb is a utility written in Ruby (requires Ruby installed on your machine) that mass renames/deletes files by allowing the user to modify a list. It includes a command line executable called `reen` that opens the user's default editor to permit interactive changes, or can be used programatically by modifying the list of file names using a code block.
 
+[![Reen usage introduction](https://img.youtube.com/vi/yJfDRfJr3os/0.jpg)](https://www.youtube.com/watch?v=yJfDRfJr3os)
+
 ## Installation
 
 To install the command line utility, use:
@@ -38,9 +40,55 @@ Examples:
     reen *.md --editor vi   # reen all markdown files using vi
     reen --editor 'code -w' # reen all markdown files using vscode
 
+### Specifying changes through the editor
+
+Upon running Reen on file list, your editor will open with a list of file/folder names. For example:
+
+```
+LICENSE.txt
+README.md
+SETUP.txt
+bin
+bin/help
+bin/myexec
+tests
+tests/fixtures
+tests/fixtures/a.json
+tests/fixtures/b.json
+tests/fixtures/c.json
+tests/helper.code
+tests/tests.code
+```
+
+Specify changes to each file you wish changed modifying it in your editor:
+
+- Change the file/folder name to rename it (the rename could cause a move if you change its path; restrictions will be reported)
+- Prepend using `-` to delete a file or empty folder
+- Prepend using `--` to force delete a file or non-empty folder (recursively)
+
+For example, if we wanted to change the above list of files/folders in the editor to (a) rename `LICENSE.txt` to `LICENSE.md`, (b) delete `SETUP.txt`, and (c) recursively delete the `bin/` folder, then we would change the filenames to look like:
+
+```
+LICENSE.md
+README.md
+-SETUP.txt
+--bin
+bin/help
+bin/myexec
+tests
+tests/fixtures
+tests/fixtures/a.json
+tests/fixtures/b.json
+tests/fixtures/c.json
+tests/helper.code
+tests/tests.code
+```
+
+Upon saving and exiting the editor, Reen will execute all the changes.
+
 ### Ruby application
 
-Use programmatically using the `reenrb` gem. In the example below, we specify that we do not want to use an actual editor to modify the list, but rather alter the list file using a block.
+Use Reen programmatically using the `reenrb` gem. In the example below, we specify that we do not want to use an actual editor to modify the list, but rather alter the list file using a block.
 
 ```ruby
 require 'reenrb'

data/lib/reenrb/actions/delete.rb

@@ -3,7 +3,7 @@
 module Reenrb
   module Actions
     # Deletes a file
-    class FileDelete
+    class Delete
       def initialize(old_name, new_name)
         @old_name = old_name
         @new_name = new_name

data/lib/reenrb/actions/force_delete.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Reenrb
+  module Actions
+    # Deletes a file
+    class ForceDelete
+      def initialize(old_name, new_name)
+        @old_name = old_name
+        @new_name = new_name
+      end
+
+      def call
+        FileUtils.rm_rf(@old_name)
+        nil
+      rescue Errno::ENOENT
+        "Could not force delete"
+      end
+    end
+  end
+end

data/lib/reenrb/actions/{file_rename.rb → rename.rb}

@@ -3,7 +3,7 @@
 module Reenrb
   module Actions
     # Renames files
-    class FileRename
+    class Rename
       def initialize(old_name, new_name)
         @old_name = old_name
         @new_name = new_name

data/lib/reenrb/change.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "actions/delete"
-require_relative "actions/file_rename"
+require_relative "actions/force_delete"
+require_relative "actions/rename"
 require_relative "actions/nothing"
 
 module Reenrb
@@ -19,44 +20,71 @@ module Reenrb
     module CHANGE
       NONE = :none
       DELETE = :delete
+      FORCE_DELETE = :force_delete
       RENAME = :rename
     end
 
+    module OBJECT
+      FILE = :file
+      FOLDER = :folder
+    end
+
     ACTION_HANDLER = {
       CHANGE::NONE => Actions::DoNothing,
-      CHANGE::DELETE => Actions::FileDelete,
-      CHANGE::RENAME => Actions::FileRename
+      CHANGE::DELETE => Actions::Delete,
+      CHANGE::FORCE_DELETE => Actions::ForceDelete,
+      CHANGE::RENAME => Actions::Rename
     }.freeze
 
     CHANGES_DESC = {
       CHANGE::NONE => "Nothing",
       CHANGE::DELETE => "Deleting",
+      CHANGE::FORCE_DELETE => "Force deleting",
       CHANGE::RENAME => "Renaming"
     }.freeze
 
     def initialize(original, requested)
       @original = original
-      @requested = requested
-      @change = compare
-      consider
+      extract_request(requested)
+      decide_object
+      decide_change
+      decide_status_reason
     end
 
-    def compare
-      if original == requested
-        CHANGE::NONE
-      elsif requested.start_with? "-"
-        CHANGE::DELETE
-      else
-        CHANGE::RENAME
-      end
+    def extract_request(str)
+      op_chars = "[-]"
+      obj_chars = "."
+      requested = str.match(/^(?<op>#{op_chars}*)(?<name>#{obj_chars}*)/)
+
+      @operator = requested[:op]
+      @requested = requested[:name].strip
+    end
+
+    def decide_change
+      @change =
+        if @operator == "--"
+          CHANGE::FORCE_DELETE
+        elsif @operator == "-"
+          CHANGE::DELETE
+        elsif @original != @requested
+          CHANGE::RENAME
+        else
+          CHANGE::NONE
+        end
     end
 
-    def consider
+    def decide_object
+      @object = OBJECT::FILE if request_file?
+      @object = OBJECT::FOLDER if request_dir?
+    end
+
+    def decide_status_reason
       if request_full_dir? && request_delete?
         @status = STATUS::REJECTED
         @reason = "Directories with files cannot be changed"
       else
         @status = STATUS::ACCEPTED
+        @reason = ""
       end
     end
 
@@ -64,7 +92,7 @@ module Reenrb
       return(self) if not_accepted?
 
       @status = STATUS::EXECUTED
-      error = ACTION_HANDLER[@change].new(original, requested).call
+      error = ACTION_HANDLER[@change].new(@original, @requested).call
 
       if error
         @status = STATUS::FAILED
@@ -78,6 +106,8 @@ module Reenrb
 
     def request_dir? = Dir.exist?(@original)
 
+    def request_file? = File.file?(@original)
+
     def request_nothing? = @change == CHANGE::NONE
 
     def request_rename? = @change == CHANGE::RENAME

data/lib/reenrb/changes_file.rb

@@ -36,7 +36,7 @@ module Reenrb
     end
 
     def await_editor(editor)
-      `#{editor} #{@list_file.path}`
+      system("#{editor} #{@list_file.path}")
     end
   end
 end

data/lib/reenrb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Reenrb
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/reenrb.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rerun", "~> 0.13"
   spec.add_development_dependency "rubocop", "~> 1.21"
   spec.add_development_dependency "rubyzip", "~> 2.3"
+  spec.add_development_dependency "simplecov"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reenrb
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Soumya Ray
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-11 00:00:00.000000000 Z
+date: 2022-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Renames or deletes a pattern of files using your favorite editor
 email:
 - soumya.ray@gmail.com
@@ -111,8 +125,9 @@ files:
 - bin/reen
 - lib/reenrb.rb
 - lib/reenrb/actions/delete.rb
-- lib/reenrb/actions/file_rename.rb
+- lib/reenrb/actions/force_delete.rb
 - lib/reenrb/actions/nothing.rb
+- lib/reenrb/actions/rename.rb
 - lib/reenrb/change.rb
 - lib/reenrb/changes.rb
 - lib/reenrb/changes_file.rb