reenrb 0.1.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '083216d43618c82f4f477057c5b388be39385ce3afe3984fdbb6ba59d2e9ab1c'
-  data.tar.gz: 15d221f549392c5830f2b709d98078d572cf4638a6f5a661ab2d495626868d9e
+  metadata.gz: 2253d4b2aa304bfac8b7e4659fee9ca3b514a22d4a0bb323be9619883b9448c0
+  data.tar.gz: 3f82b6afbbe84b70878d153b56f6f75a72c2570df3b2b292c0d42a4a0057e973
 SHA512:
-  metadata.gz: 782c7fdb66213cf0d5de16acacdea2cacfc3a01b87ad0e8376e7729434a29cc2577209477faaef9c23d14513e6050b7997697f365d8f40e2aa9665f73ebfe4c5
-  data.tar.gz: db2ef58c4c56b262a60c85b0a70b6b12dda8d05dcf7fd504c44fce710f89a0709802e8e378f0a56fb551b1c9ea8cad6d623877de5c594787206ea6fa496b7a84
+  metadata.gz: 331ad4055d5abc194ec73fb0be6ac7479d3d2d8c41fb37980edc9c772f998a7b469da386e6b8e9c9dfe594802f9f1e39daa0081f0e109a1278fa41b1fb666a24
+  data.tar.gz: 39d3af74b266effdb9ad82c513412539edd75b2573e97a36f41850027822c4a22029fa0b1fe6b298de177f9d794c86e80c88349dcb05b2b19541c998a572e2c2

data/CHANGELOG.md

@@ -1,5 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
 ## [Unreleased]
 
+## [0.2.1] - 2022-11-05
+
+### Changed
+
+- Simplified API for passing block to request/execute
+
 ## [0.1.0] - 2022-11-05
 
-- Initial release
+- Initial release: CLI and API working

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    reenrb (0.1.0)
+    reenrb (0.2.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -43,7 +43,7 @@ Use programmatically using the `reenrb` gem. In the example below, we specify th
 require 'reenrb'
 
 glob = Dir.glob("*")
-reen = Reenrb::Reen.new(options: { mock_editor: true })
+reen = Reenrb::Reen.new(editor: nil)
 
 reen.execute(glob) do |tmpfile_path|
   lines = File.read(tmpfile_path).split("\n")
@@ -55,6 +55,8 @@ reen.execute(glob) do |tmpfile_path|
 end
 ```
 
+You may also pass a block with an editor specified, in which case the block is run after the editor has finished.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/reen

@@ -17,6 +17,6 @@ exit_with_error(EDITOR_MSG) if editor.empty?
 
 results = Reenrb::Reen.new(editor: editor).execute(file_list)
 
-changes = Reenrb::Changes.new(results).change_requested
+changes = results.change_requested
 
 puts changes.summarize

data/lib/reenrb/actions/delete.rb

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

data/lib/reenrb/actions/file_rename.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Reenrb
+  module Actions
+    # Renames files
+    class FileRename
+      def initialize(old_name, new_name)
+        @old_name = old_name
+        @new_name = new_name
+      end
+
+      def call
+        File.rename(@old_name, @new_name)
+        nil
+      rescue Errno::ENOENT
+        "No such target file or directory"
+      end
+    end
+  end
+end

data/lib/reenrb/actions/nothing.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Reenrb
+  module Actions
+    # Does nothing to items
+    class DoNothing
+      def initialize(old_name, new_name)
+        @old_name = old_name
+        @new_name = new_name
+      end
+
+      def call
+        nil
+      end
+    end
+  end
+end

data/lib/reenrb/change.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require_relative "actions/delete"
+require_relative "actions/file_rename"
+require_relative "actions/nothing"
+
+module Reenrb
+  # Change to an orignal file
+  class Change
+    attr_reader :original, :requested, :change, :status
+
+    module STATUS
+      ACCEPTED = :accepted
+      REJECTED = :rejected
+      EXECUTED = :executed
+      FAILED   = :failed
+    end
+
+    module CHANGE
+      NONE = :none
+      DELETE = :delete
+      RENAME = :rename
+    end
+
+    ACTION_HANDLER = {
+      CHANGE::NONE => Actions::DoNothing,
+      CHANGE::DELETE => Actions::FileDelete,
+      CHANGE::RENAME => Actions::FileRename
+    }.freeze
+
+    CHANGES_DESC = {
+      CHANGE::NONE => "Nothing",
+      CHANGE::DELETE => "Deleting",
+      CHANGE::RENAME => "Renaming"
+    }.freeze
+
+    def initialize(original, requested)
+      @original = original
+      @requested = requested
+      @change = compare
+      consider
+    end
+
+    def compare
+      if original == requested
+        CHANGE::NONE
+      elsif requested.start_with? "-"
+        CHANGE::DELETE
+      else
+        CHANGE::RENAME
+      end
+    end
+
+    def consider
+      if request_full_dir? && request_delete?
+        @status = STATUS::REJECTED
+        @reason = "Directories with files cannot be changed"
+      else
+        @status = STATUS::ACCEPTED
+      end
+    end
+
+    def execute
+      return(self) if not_accepted?
+
+      @status = STATUS::EXECUTED
+      error = ACTION_HANDLER[@change].new(original, requested).call
+
+      if error
+        @status = STATUS::FAILED
+        @reason = error
+      end
+
+      self
+    end
+
+    # Predicates
+
+    def request_dir? = Dir.exist?(@original)
+
+    def request_nothing? = @change == CHANGE::NONE
+
+    def request_rename? = @change == CHANGE::RENAME
+
+    def request_delete? = @change == CHANGE::DELETE
+
+    def request_empty_dir? = Dir.empty?(@original)
+
+    def accepted? = @status == STATUS::ACCEPTED
+
+    def not_accepted? = !accepted?
+
+    def executed? = @status == STATUS::EXECUTED
+
+    def rejected? = @status == STATUS::REJECTED
+
+    def failed? = @status == STATUS::FAILED
+
+    def request_full_dir? = request_dir? && !request_empty_dir?
+
+    def executed_or_rejected? = %i[executed rejected].include?(@status)
+
+    # Decoration
+
+    def to_s
+      file_desc =
+        case @change
+        when CHANGE::RENAME
+          "#{@original} -> #{@requested}"
+        else
+          @original
+        end
+
+      reason_desc = rejected? || failed? ? " (failed: #{@reason})" : ""
+
+      "#{CHANGES_DESC[@change]}: #{file_desc}#{reason_desc}"
+    end
+  end
+end

data/lib/reenrb/changes.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative "change"
+
+module Reenrb
+  # Change to an orignal file
+  class Changes
+    attr_reader :list
+
+    def initialize(changes_list)
+      @list = changes_list
+    end
+
+    def execute!
+      @list.map(&:execute)
+      self
+    end
+
+    # Queries
+
+    def rename_requested
+      Changes.new(@list.select(&:request_rename?))
+    end
+
+    def delete_requested
+      Changes.new(@list.select(&:request_delete?))
+    end
+
+    def change_requested
+      Changes.new(@list.reject(&:request_nothing?))
+    end
+
+    def rejected
+      Changes.new(@list.select(&:rejected?))
+    end
+
+    def accepted
+      Changes.new(@list.select(&:accepted?))
+    end
+
+    def executed
+      Changes.new(@list.select(&:executed?))
+    end
+
+    def count
+      @list.size
+    end
+
+    # Decoration
+
+    def summarize
+      return "Nothing changed" if @list.empty?
+
+      @list.map(&:to_s).join("\n")
+    end
+
+    # Predicates
+
+    def no_changes_requested?
+      list.map(&:change).all? Change::CHANGE::NONE
+    end
+
+    def changes_requested?
+      !no_changes_requested?
+    end
+
+    def all_executed?
+      @list.all?(&:executed?)
+    end
+  end
+end

data/lib/reenrb/reen.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Reenrb
+  # Renames pattern of files with given editor
+  # Examples:
+  #   Reenrb::Reen.new(editor: "code -w").call("spec/fixtures/example/*")
+  #   Reenrb::Reen.new(editor: nil).call("spec/fixtures/example/*") { ... }
+  class Reen
+    DEL_ERROR = "Do not delete any file/folder names"
+
+    attr_reader :changes
+
+    def initialize(editor: "emacs", options: {})
+      @editor = editor
+      @options = options
+    end
+
+    def request(original_list, &block) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      changed_list = ChangesFile.new(original_list).allow_changes do |file|
+        file.blocking_edit(@editor) if @editor
+
+        if block
+          lines = File.read(file.path).split("\n")
+          new_lines = block.call(lines) || lines
+          File.write(file.path, new_lines.join("\n"))
+        end
+      end
+
+      raise(Error, DEL_ERROR) if changed_list.size != original_list.size
+
+      @changes = compare_lists(original_list, changed_list)
+                 .then { |change_array| Changes.new(change_array) }
+    end
+
+    def execute(original_list, &block)
+      @changes ||= request(original_list, &block)
+      @changes = @changes.execute!
+    end
+
+    private
+
+    def compare_lists(original_list, changed_list)
+      original_list.zip(changed_list).map do |original, revised|
+        Change.new(original, revised)
+      end
+    end
+  end
+end

data/lib/reenrb/version.rb

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

data/lib/reenrb.rb

@@ -1,48 +1,11 @@
 # frozen_string_literal: true
 
 require_relative "reenrb/version"
-require_relative "changes_file"
-require_relative "change"
-require_relative "changes"
+require_relative "reenrb/changes_file"
+require_relative "reenrb/change"
+require_relative "reenrb/changes"
+require_relative "reenrb/reen"
 
 module Reenrb
   class Error < StandardError; end
-
-  # Renames pattern of files with given editor
-  # Example:
-  #   Reenrb::Reen.new(editor: "code -w").call("spec/fixtures/example/*")
-  class Reen
-    DEL_ERROR = "Do not delete any file/folder names"
-
-    attr_reader :changes
-
-    def initialize(editor: "emacs", options: {})
-      @editor = editor
-      @options = options
-    end
-
-    def request(original_list, &block)
-      # original_list = Dir.glob(pattern)
-      changed_list = ChangesFile.new(original_list).allow_changes do |file|
-        @options[:mock_editor] ? block.call(file.path) : file.blocking_edit(@editor)
-      end
-
-      raise(Error, DEL_ERROR) if changed_list.size != original_list.size
-
-      @changes = compare_lists(original_list, changed_list)
-    end
-
-    def execute(original_list, &block)
-      @changes ||= request(original_list, &block)
-      @changes = @changes.map(&:execute)
-    end
-
-    private
-
-    def compare_lists(original_list, changed_list)
-      original_list.zip(changed_list).map do |original, revised|
-        Change.new(original, revised)
-      end
-    end
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reenrb
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Soumya Ray
@@ -110,10 +110,14 @@ files:
 - README.md
 - Rakefile
 - bin/reen
-- lib/change.rb
-- lib/changes.rb
-- lib/changes_file.rb
 - lib/reenrb.rb
+- lib/reenrb/actions/delete.rb
+- lib/reenrb/actions/file_rename.rb
+- lib/reenrb/actions/nothing.rb
+- lib/reenrb/change.rb
+- lib/reenrb/changes.rb
+- lib/reenrb/changes_file.rb
+- lib/reenrb/reen.rb
 - lib/reenrb/version.rb
 - reenrb.gemspec
 - sig/reenrb.rbs

data/lib/change.rb

@@ -1,100 +0,0 @@
-# frozen_string_literal: true
-
-module Reenrb
-  # Change to an orignal file
-  class Change
-    attr_reader :original, :requested, :change, :status
-
-    module STATUS
-      ACCEPTED = :accepted
-      REJECTED = :rejected
-      EXECUTED = :executed
-    end
-
-    module CHANGE
-      NONE = :none
-      DELETE = :delete
-      RENAME = :rename
-    end
-
-    CHANGES_DESC = {
-      none: "Nothing",
-      delete: "Deleting",
-      rename: "Renaming"
-    }.freeze
-
-    def initialize(original, requested)
-      @original = original
-      @requested = requested
-      @change = compare
-      consider
-    end
-
-    def compare
-      if original == requested
-        :none
-      elsif requested.start_with? "-"
-        :delete
-      else
-        :rename
-      end
-    end
-
-    def request_directory?
-      Dir.exist? @original
-    end
-
-    def request_delete?
-      @change == CHANGE::DELETE
-    end
-
-    def request_empty_directory?
-      Dir.empty? @original
-    end
-
-    def request_full_directory?
-      request_directory? && !request_empty_directory?
-    end
-
-    def consider
-      if request_full_directory? && request_delete?
-        @status = STATUS::REJECTED
-        @reason = "Directories with files cannot be changed"
-      else
-        @status = STATUS::ACCEPTED
-      end
-    end
-
-    def executed_or_rejected
-      %i[executed rejected].include? @status
-    end
-
-    def execute
-      return(self) if executed_or_rejected
-
-      case @change
-      when :rename
-        File.rename(@original, @requested)
-      when :delete
-        File.delete(@original)
-      end
-
-      @status = STATUS::EXECUTED
-      self
-    end
-
-    def to_s
-      file_desc =
-        case @change
-        when :rename
-          "#{@original} -> #{@requested}"
-        else
-          @original
-        end
-
-      reason_desc = @status == STATUS::REJECTED ? " (failed: #{@reason})" : ""
-
-      "#{CHANGES_DESC[@change]}: #{file_desc}#{reason_desc}"
-    end
-  end
-end

data/lib/changes.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Reenrb
-  # Change to an orignal file
-  class Changes
-    attr_reader :list
-
-    def initialize(changes_list)
-      @list = changes_list
-    end
-
-    def none
-      Changes.new(@list.select { |c| c.change == :none })
-    end
-
-    def rename_requested
-      Changes.new(@list.select { |c| c.change == :rename })
-    end
-
-    def delete_requested
-      Changes.new(@list.select { |c| c.change == :delete })
-    end
-
-    def change_requested
-      Changes.new(@list.reject { |c| c.change == :none })
-    end
-
-    def rejected
-      Changes.new(@list.select { |c| c.status == :rejected })
-    end
-
-    def accepted
-      Changes.new(@list.select { |c| c.status == :accepted })
-    end
-
-    def executed
-      Changes.new(@list.select { |c| c.status == :executed })
-    end
-
-    def summarize
-      return "Nothing changed" if @list.empty?
-
-      @list.map(&:to_s).join("\n")
-    end
-  end
-end