reenrb 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef0b76de4c05fb0949d2b65b6b7f79d3265fb1474e109de5186a788b1c32602c
-  data.tar.gz: 5c4a47408deed235d05236615380fdc35a099f4049d7fce833e3a06af48c2d96
+  metadata.gz: 8f607120ef687c5ace8a02b12e3fb6306abc16aa45b6f906f3e853f995df9a51
+  data.tar.gz: 0d4b19262e64584508daf56c0ec2024603ff1a375d134fc000774d1e9233714e
 SHA512:
-  metadata.gz: 3fe1b3c16fb10bdaa39c095acef4611822c2c07934081dfc1d223f2103d3cf07a3d819b50b5a1351cec1538d0fb24e03fd77d58eeef2bb212405a1c624b2f602
-  data.tar.gz: 88bd9ad15855e04911bd87b2d620843a254c31c0b84a4919c18cdaa314b8bd8c6953280450e8cefbbc32af1489e4c5034322bff26c4a63cdc2a9c57810b04348
+  metadata.gz: 420f2980c0e6a22ddeb7dbfc9a6abc62a9c8845f19f0902ba975c13996e87c371da9dd003b1d70fbdca9a14ebfeae36e85bd883671bb8b9eec27aa622a1e4fe1
+  data.tar.gz: 971cade35548d6fbde58a07ebd3707f34e95da5933e37c37d4eef1f8f108a1714b789aa873ccbcd2331a0214c330bd93a83c4b4f52f295f04130802efff0a726

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.2.1)
+    reenrb (0.2.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -14,26 +14,29 @@ Or add this line to your Ruby application's Gemfile for programmatic use:
 gem 'reenrb'
 ```
 
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install reenrb
-
 ## Usage
 
 ### Command line
 
 From command line, run `reen` with file list:
 
-    reen [file ...]
+    reen files [options]
+
+where `files` are a list of files or wildcard pattern (defaults to `*`; see examples)
+
+Options include:
+
+- `--help` or `-h`' to see options help
+- `--editor EDITOR` or `-e EDITOR`' to set the editor (defaults to $VISUAL or $EDITOR otherwise) such as `emacs` or `vi`. For Visual Studio Code use `'code -w'` to block until editor finishes.
+- `--review` or `-r` request to review and confirm changes
 
 Examples:
 
-    reen *
-    reen myfolder/**/*.mov
+    reen                    # reen all files (*)
+    reen **/*               # reen all files in all subfolders
+    reen myfolder/**/*.mov  # reen all mov files in subfolders
+    reen *.md --editor vi   # reen all markdown files using vi
+    reen --editor 'code -w' # reen all markdown files using vscode
 
 ### Ruby application
 
@@ -45,13 +48,10 @@ require 'reenrb'
 glob = Dir.glob("*")
 reen = Reenrb::Reen.new(editor: nil)
 
-reen.execute(glob) do |tmpfile_path|
-  lines = File.read(tmpfile_path).split("\n")
-
+reen.execute(glob) do |file|
   # Rename LICENSE.txt -> LICENSE.md
-  index = lines.index { |l| l.include? "LICENSE.txt" }
-  lines[index] = lines[index].gsub("txt", "md")
-  File.write(tmpfile_path, lines.join("\n"))
+  index = file.list.index { |l| l.include? "LICENSE.txt" }
+  file.list[index] = file.list[index].gsub("txt", "md")
 end
 ```
 

data/Rakefile

@@ -4,7 +4,7 @@ require "bundler/gem_tasks"
 require "rake/testtask"
 
 Rake::TestTask.new(:spec) do |t|
-  t.libs << "tspecest"
+  t.libs << "spec"
   t.libs << "lib"
   t.test_files = FileList["spec/**/spec_*.rb"]
 end
@@ -14,18 +14,18 @@ task :respec do
 end
 
 namespace :example do
-  task :config do
+  task :helper do
     require_relative "spec/fixture_helper"
   end
 
   desc "Recreates the example fixture folder"
-  task :recreate => :config do
+  task :recreate => :helper do
     FixtureHelper.recreate_example_dir
     puts "Example fixture recreated"
   end
 
   desc "Deletes the example fixture folder"
-  task :remove => :config do
+  task :remove => :helper do
     FixtureHelper.remove_example_dirs
     puts "Example fixture removed"
   end

data/bin/reen

@@ -1,22 +1,87 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-EDITOR_MSG = "Editor not set in $EDITOR or $VISUAL -- please set one of those environment variables"
-
-def exit_with_error(err)
-  puts err
-  exit(false)
-end
-
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 require "reenrb"
+require "optparse"
+
+# Reen command line application
+class ReenCLI
+  EDITOR_MSG = "Editor not set in $EDITOR or $VISUAL -- please set one of those environment variables"
+  Options = Struct.new(:editor, :review) do
+    def initialize(editor: nil, review: false)
+      editor ||= ENV["VISUAL"] || ENV["EDITOR"] # rubocop:disable Style/FetchEnvVar
+      super(editor, review)
+    end
+  end
+
+  attr_reader :options, :files
+
+  def initialize(args)
+    @options = Options.new
+    optparse = OptionParser.new { |parser| setup_options(parser) }
+    optparse.parse!(args, into: @options)
+
+    exit_with_msg(EDITOR_MSG) unless options.editor
+
+    @files = args.empty? ? Dir.glob("*") : args
+  rescue OptionParser::InvalidOption => e
+    puts "#{e.message}\n\n"
+    exit_with_msg(optparse)
+  end
+
+  def setup_options(parser)
+    parser.banner = "Usage: reen files [options]"
+    parser.version = Reenrb::VERSION
 
-file_list = ARGV || Dir.glob("*")
-editor = ENV["VISUAL"] || ENV["EDITOR"] # rubocop:disable Style/FetchEnvVar
-exit_with_error(EDITOR_MSG) if editor.empty?
+    parser.on("-e", "--editor EDITOR", "Specify EDITOR to use")
+    parser.on("-r", "--review", "Require review and confirmation of changes")
 
-results = Reenrb::Reen.new(editor: editor).execute(file_list)
+    parser.on("-h", "--help", "Show help for options") do
+      exit_with_msg(parser)
+    end
+  end
 
-changes = results.change_requested
+  def exit_with_msg(message)
+    puts message
+    exit(false)
+  end
 
-puts changes.summarize
+  def review_changes
+    puts
+    puts @requests.change_requested.summarize
+    print "\nContinue? (y/n) "
+    confirmation = %w[y yes].include?($stdin.gets.chomp.downcase)
+    exit_with_msg("Nothing changed") unless confirmation
+  end
+
+  def check_inputs
+    @files = files.empty? ? Dir.glob("*") : files
+    exit_with_msg(EDITOR_MSG) unless options.editor
+  end
+
+  def user_review?
+    @options.review && @requests.changes_requested?
+  end
+
+  def call
+    @requests = Reenrb::Reen.new(editor: options.editor).request(files)
+    review_changes if user_review?
+
+    changes = @requests
+              .execute_all
+              .change_requested
+
+    if user_review? && changes.all_executed?
+      puts "Changes made"
+    else
+      puts changes.summarize
+    end
+  end
+end
+
+begin
+  ReenCLI.new(ARGV).call
+rescue Reenrb::Error => e
+  puts "#{e.message}\n"
+end

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/{changes.rb → reenrb/changes.rb}

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "change"
+
 module Reenrb
   # Change to an orignal file
   class Changes
@@ -9,35 +11,43 @@ module Reenrb
       @list = changes_list
     end
 
-    def execute!
+    def execute_all
       @list.map(&:execute)
       self
     end
 
-    # Inspection
+    # Queries
 
     def rename_requested
-      Changes.new(@list.select { |c| c.change == :rename })
+      Changes.new(@list.select(&:request_rename?))
     end
 
     def delete_requested
-      Changes.new(@list.select { |c| c.change == :delete })
+      Changes.new(@list.select(&:request_delete?))
     end
 
     def change_requested
-      Changes.new(@list.reject { |c| c.change == :none })
+      Changes.new(@list.reject(&:request_nothing?))
     end
 
     def rejected
-      Changes.new(@list.select { |c| c.status == :rejected })
+      Changes.new(@list.select(&:rejected?))
     end
 
     def accepted
-      Changes.new(@list.select { |c| c.status == :accepted })
+      Changes.new(@list.select(&:accepted?))
     end
 
     def executed
-      Changes.new(@list.select { |c| c.status == :executed })
+      Changes.new(@list.select(&:executed?))
+    end
+
+    def failed
+      Changes.new(@list.select(&:failed?))
+    end
+
+    def any?
+      !@list.empty?
     end
 
     def count
@@ -55,7 +65,7 @@ module Reenrb
     # Predicates
 
     def no_changes_requested?
-      list.map(&:change).all? :none
+      list.map(&:change).all? Change::CHANGE::NONE
     end
 
     def changes_requested?

data/lib/reenrb/changes_file.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "tempfile"
+
+module Reenrb
+  # Manages a temporary file with requested changes
+  class ChangesFile
+    INSTRUCTIONS = <<~COMMENTS
+      # Edit the names of any files/folders to rename or move them
+      # - Put a preceeding dash to delete a file or empty folder
+
+    COMMENTS
+
+    attr_accessor :list
+
+    def initialize(requested_list)
+      @list_file = Tempfile.new("reenrb-")
+      @list_file.write(INSTRUCTIONS)
+      @list_file.write(requested_list.join("\n"))
+      @list_file.close
+    end
+
+    def allow_changes(editor, &block)
+      await_editor(editor) if editor
+      @list = File.read(path).split("\n").map(&:strip)
+                  .reject { |line| line.start_with?("#") || line.empty? }
+
+      block&.call(self)
+      @list
+    end
+
+    private
+
+    def path
+      @list_file.path
+    end
+
+    def await_editor(editor)
+      `#{editor} #{@list_file.path}`
+    end
+  end
+end

data/lib/reenrb/reen.rb

@@ -0,0 +1,40 @@
+# 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 remove any file/folder names (no changes made)"
+
+    attr_reader :changes
+
+    def initialize(editor: "emacs", options: {})
+      @editor = editor
+      @options = options
+    end
+
+    def request(original_list, &block)
+      changed_list = ChangesFile.new(original_list).allow_changes(@editor, &block)
+
+      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_all
+    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.2.1"
+  VERSION = "0.3.0"
 end

data/lib/reenrb.rb

@@ -1,55 +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
-  # 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reenrb
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Soumya Ray
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-06 00:00:00.000000000 Z
+date: 2022-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -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,108 +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 consider
-      if request_full_directory? && request_delete?
-        @status = STATUS::REJECTED
-        @reason = "Directories with files cannot be changed"
-      else
-        @status = STATUS::ACCEPTED
-      end
-    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
-
-    # Inspection
-
-    def request_directory?
-      Dir.exist? @original
-    end
-
-    def request_delete?
-      @change == CHANGE::DELETE
-    end
-
-    def request_empty_directory?
-      Dir.empty? @original
-    end
-
-    def executed?
-      @status == STATUS::EXECUTED
-    end
-
-    def request_full_directory?
-      request_directory? && !request_empty_directory?
-    end
-
-    def executed_or_rejected?
-      %i[executed rejected].include? @status
-    end
-
-    # Decoration
-
-    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_file.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require "tempfile"
-
-module Reenrb
-  # Manages a temporary file with requested changes
-  class ChangesFile
-    def initialize(requested_list)
-      @list_file = Tempfile.new("reenrb-")
-      @list_file.write(requested_list.join("\n"))
-      @list_file.close
-    end
-
-    def path
-      @list_file.path
-    end
-
-    def allow_changes(&block)
-      block.call(self)
-      File.read(path).split("\n")
-    end
-
-    def blocking_edit(editor)
-      `#{editor} #{@list_file.path}`
-    end
-  end
-end