reen 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c32624b91f88178dd9a68dc09229916804beffff846e04074e4f76a5eb299739
-  data.tar.gz: ef4cde36ed7202532276d761da152004dcb2f322814d7ed8d82c6de78ba4c920
+  metadata.gz: d84332445053fed05a469540f848b194b7ddc94374b5ae42e805e84681e53f9b
+  data.tar.gz: 966507f2ef7e0d07c273c758dd9242535acba82414876376d5f73432a4868c54
 SHA512:
-  metadata.gz: e139aa0f8f927448c3e566a37868b5c29697e91b46f9fa3043d12dce53d015e64b1791474e36178d40b1b937b76032ab1fcce8caebfa5c45081a79251cee1c56
-  data.tar.gz: f9e20a1defcf449536eb2e8ca160ef7ee6eb26831527015df85cb2839b88cc97fb3ca2300ab27d00e388ea22af95c978c0d972932a80e2881638390f2c4b3c81
+  metadata.gz: 245fbb2118dd45f596c4794f9e59df822a7bf91ce1c5dc38d7ecfdf356d6ca4333cf8360b490e3d01ff184c741069934b499b3d61f7792b26f9733624427cfb2
+  data.tar.gz: 6c4e07c278d6ba23a9930f0f04f334004b80caba6bdb53389f2f495b5f4ccbf8e15ce46c7f9d883967700b423791cb1dc2dffc5b1fb39be3a9300a59fc6d3c77

data/README.md

@@ -103,7 +103,7 @@ Use Reen programmatically using the `reen` gem. In the example below, we specify
 require 'reen'
 
 glob = Dir.glob("*")
-reen = Reen::Reen.new(editor: nil)
+reen = Reen::Renamer.new(editor: nil)
 
 reen.execute(glob) do |file|
   # Rename LICENSE.txt -> LICENSE.md (gsub works on the path portion)

data/bin/reen

@@ -3,90 +3,9 @@
 
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 require "reen"
-require "optparse"
-
-# Reen command line application
-class ReenCLI
-  EDITOR_MSG = "Editor not set in $VISUAL or $EDITOR -- 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) # rubocop:disable Metrics/MethodLength
-    parser.banner = "Usage: reen files [options]"
-    parser.version = Reen::VERSION
-
-    parser.on("-e", "--editor [EDITOR]", "Use EDITOR (default: $EDITOR)") do |ed|
-      @options.editor = ed || ENV["EDITOR"] # rubocop:disable Style/FetchEnvVar
-    end
-    parser.on("-v", "--visual [EDITOR]", "Use EDITOR (default: $VISUAL)") do |ed|
-      @options.editor = ed || ENV["VISUAL"] # rubocop:disable Style/FetchEnvVar
-    end
-    parser.on("-r", "--review", "Require review and confirmation of changes")
-
-    parser.on("-h", "--help", "Show help for options") do
-      exit_with_msg(parser)
-    end
-  end
-
-  def exit_with_msg(message)
-    puts message
-    exit(false)
-  end
-
-  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 = Reen::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
+  Reen::ReenCLI.new(ARGV).call
 rescue Reen::Error => e
   puts "#{e.message}\n"
 end

data/lib/reen/application/reen_cli.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module Reen
+  # Reen command line application
+  class ReenCLI
+    EDITOR_MSG = "Editor not set in $VISUAL or $EDITOR -- 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) # rubocop:disable Metrics/MethodLength
+      parser.banner = "Usage: reen files [options]"
+      parser.version = Reen::VERSION
+
+      parser.on("-e", "--editor [EDITOR]", "Use EDITOR (default: $EDITOR)") do |ed|
+        @options.editor = ed || ENV["EDITOR"] # rubocop:disable Style/FetchEnvVar
+      end
+      parser.on("-v", "--visual [EDITOR]", "Use EDITOR (default: $VISUAL)") do |ed|
+        @options.editor = ed || ENV["VISUAL"] # rubocop:disable Style/FetchEnvVar
+      end
+      parser.on("-r", "--review", "Require review and confirmation of changes")
+
+      parser.on("-h", "--help", "Show help for options") do
+        exit_with_msg(parser)
+      end
+    end
+
+    def exit_with_msg(message)
+      puts message
+      exit(false)
+    end
+
+    def review_changes
+      puts
+      puts @changes.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_wants_review?
+      @options.review && @requests.changes_requested?
+    end
+
+    def call
+      @service = Renamer.new(editor: options.editor)
+      @requests = @service.request(files)
+      @changes = @requests.change_requested
+
+      review_changes if user_wants_review?
+      @service.execute_changes
+
+      if user_wants_review? && @changes.all_executed?
+        puts "Changes made"
+      else
+        puts @changes.summarize
+      end
+    end
+  end
+end

data/lib/reen/application/renamer.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative "../infrastructure/actions/delete"
+require_relative "../infrastructure/actions/force_delete"
+require_relative "../infrastructure/actions/rename"
+require_relative "../infrastructure/actions/nothing"
+
+module Reen
+  # Renames pattern of files with given editor
+  # Examples:
+  #   Reen::Renamer.new(editor: "code -w").call("spec/fixtures/example/*")
+  #   Reen::Renamer.new(editor: nil).call("spec/fixtures/example/*") { ... }
+  class Renamer
+    DEL_ERROR = "Do not remove any file/folder names (no changes made)"
+
+    ACTION_HANDLER = {
+      Change::CHANGE::NONE => Actions::DoNothing,
+      Change::CHANGE::DELETE => Actions::Delete,
+      Change::CHANGE::FORCE_DELETE => Actions::ForceDelete,
+      Change::CHANGE::RENAME => Actions::Rename
+    }.freeze
+
+    attr_reader :changes
+
+    def initialize(editor: "emacs", options: {})
+      @editor = editor
+      @options = options
+    end
+
+    def request(original_list, &block)
+      @entry_list = PathEntryList.new(original_list)
+      changed_list = ChangesFile.new(@entry_list).allow_changes(@editor, &block)
+
+      raise(Error, DEL_ERROR) if changed_list.size != @entry_list.count
+
+      @changes = detect_changes(@entry_list, changed_list)
+    end
+
+    def execute(original_list, &block)
+      @changes ||= request(original_list, &block)
+      execute_changes
+      @changes
+    end
+
+    def execute_changes
+      @changes.list.each do |change|
+        next if change.not_accepted?
+
+        error = ACTION_HANDLER[change.change].new(change.original, change.requested).call
+        error ? change.mark_failed(error) : change.mark_executed
+      end
+    end
+
+    private
+
+    def detect_changes(entry_list, changed_list)
+      changed_by_number = PathEntryList.from_numbered(changed_list)
+      entries = entry_list.to_a
+
+      changes = changed_by_number.map do |number, revised|
+        Change.new(entries[number - 1], revised)
+      end
+
+      Changes.new(changes)
+    end
+  end
+end

data/lib/reen/{change.rb → domain/change.rb}

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "actions/delete"
-require_relative "actions/force_delete"
-require_relative "actions/rename"
-require_relative "actions/nothing"
-
 module Reen
   # Change to an orignal file
   class Change
@@ -29,13 +24,6 @@ module Reen
       FOLDER = :folder
     end
 
-    ACTION_HANDLER = {
-      CHANGE::NONE => Actions::DoNothing,
-      CHANGE::DELETE => Actions::Delete,
-      CHANGE::FORCE_DELETE => Actions::ForceDelete,
-      CHANGE::RENAME => Actions::Rename
-    }.freeze
-
     CHANGES_DESC = {
       CHANGE::NONE => "Nothing",
       CHANGE::DELETE => "Deleting",
@@ -87,18 +75,13 @@ module Reen
       end
     end
 
-    def execute
-      return self if not_accepted?
-
+    def mark_executed
       @status = STATUS::EXECUTED
-      error = ACTION_HANDLER[@change].new(@original, @requested).call
-
-      if error
-        @status = STATUS::FAILED
-        @reason = error
-      end
+    end
 
-      self
+    def mark_failed(reason)
+      @status = STATUS::FAILED
+      @reason = reason
     end
 
     # Predicates

data/lib/reen/{changes.rb → domain/changes.rb}

@@ -11,11 +11,6 @@ module Reen
       @list = changes_list
     end
 
-    def execute_all
-      @list.map(&:execute)
-      self
-    end
-
     # Queries
 
     def rename_requested

data/lib/reen/{path_entry_list.rb → domain/path_entry_list.rb}

@@ -27,6 +27,9 @@ module Reen
       end
     end
 
+    # Parses "[NN] path" lines into { number => path } hash.
+    # Preserves line order (Ruby hash insertion order), so callers get editor order.
+    # Silently skips lines that don't match the [NN] pattern.
     def self.from_numbered(lines)
       lines.each_with_object({}) do |line, hash|
         match = line.match(/^\[(\d+)\] (.*)/)

data/lib/reen/{changes_file.rb → infrastructure/changes_file.rb}

@@ -24,6 +24,8 @@ module Reen
       @list_file.close
     end
 
+    # Returns only valid "[NN] path" entry lines (comments and blanks stripped).
+    # Line order reflects the user's editor arrangement.
     def allow_changes(editor, &block)
       await_editor(editor) if editor
       @list = File.read(path).split("\n").map(&:strip)

data/lib/reen/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Reen
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/reen.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 require_relative "reen/version"
-require_relative "reen/path_entry"
-require_relative "reen/path_entry_list"
-require_relative "reen/changes_file"
-require_relative "reen/change"
-require_relative "reen/changes"
-require_relative "reen/reen"
+require_relative "reen/domain/path_entry"
+require_relative "reen/domain/path_entry_list"
+require_relative "reen/domain/change"
+require_relative "reen/domain/changes"
+require_relative "reen/infrastructure/changes_file"
+require_relative "reen/application/renamer"
+require_relative "reen/application/reen_cli"
 
 module Reen
   class Error < StandardError; end

data/reen.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/reen/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "reen"
+  spec.version = Reen::VERSION
+  spec.authors = ["Soumya Ray"]
+  spec.email = ["soumya.ray@gmail.com"]
+
+  spec.summary = "Renames or deletes a pattern of files using your favorite editor"
+  spec.description = "Renames or deletes a pattern of files using your favorite editor"
+  spec.homepage = "https://github.com/soumyaray/reen"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["rubygems_mfa_required"] = "true"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "bin"
+  spec.executables << "reen"
+  spec.require_paths = ["lib"]
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/{reenrb.rbs → reen.rbs}

@@ -1,4 +1,4 @@
-module Reenrb
+module Reen
   VERSION: String
   # See the writing guide of rbs: https://github.com/ruby/rbs#guides
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reen
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Soumya Ray
@@ -21,25 +21,26 @@ files:
 - ".markdownlint.json"
 - ".rubocop.yml"
 - CHANGELOG.md
-- CLAUDE.feature-numbered-lists.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/reen
 - lib/reen.rb
-- lib/reen/actions/delete.rb
-- lib/reen/actions/force_delete.rb
-- lib/reen/actions/nothing.rb
-- lib/reen/actions/rename.rb
-- lib/reen/change.rb
-- lib/reen/changes.rb
-- lib/reen/changes_file.rb
-- lib/reen/path_entry.rb
-- lib/reen/path_entry_list.rb
-- lib/reen/reen.rb
+- lib/reen/application/reen_cli.rb
+- lib/reen/application/renamer.rb
+- lib/reen/domain/change.rb
+- lib/reen/domain/changes.rb
+- lib/reen/domain/path_entry.rb
+- lib/reen/domain/path_entry_list.rb
+- lib/reen/infrastructure/actions/delete.rb
+- lib/reen/infrastructure/actions/force_delete.rb
+- lib/reen/infrastructure/actions/nothing.rb
+- lib/reen/infrastructure/actions/rename.rb
+- lib/reen/infrastructure/changes_file.rb
 - lib/reen/version.rb
-- sig/reenrb.rbs
+- reen.gemspec
+- sig/reen.rbs
 homepage: https://github.com/soumyaray/reen
 licenses:
 - MIT

data/CLAUDE.feature-numbered-lists.md

@@ -1,145 +0,0 @@
-# Numbered List Prefixes for Editor
-
-> **IMPORTANT**: This plan must be kept up-to-date at all times. Assume context can be cleared at any time — this file is the single source of truth for the current state of this work. Update this plan before and after task and subtask implementations.
-
-## Branch
-
-`feature-numbered-lists`
-
-## Goal
-
-Add numbered prefixes (e.g., `[01]`, `[002]`) to the file list shown in the editor so users can freely reorder entries without losing track of which original file each line corresponds to. Matching changes back to originals uses the number, not line position. Also fix the dash-operator ambiguity by requiring a space after `-`/`--` to distinguish delete operations from literal filenames starting with dashes. Introduce `PathEntry` and `PathEntryList` domain objects to replace raw path strings — `PathEntry` wraps a file path and answers filesystem queries, `PathEntryList` is a collection that owns numbered serialization for the editor.
-
-## Strategy: Vertical Slice
-
-1. **Refactor** — Introduce `PathEntry`/`PathEntryList` domain objects, migrate existing code (all tests pass)
-2. **Fix** — Require space after `-`/`--` for delete operators (dash ambiguity fix)
-3. **Feature** — Add numbered prefixes and number-based matching
-4. **Verify** — Manual test with real editor confirms behavior
-
-## Current State
-
-- [x] Plan created
-- [x] Slice 0: PathEntry/PathEntryList refactor
-- [x] Slice 1: Dash-operator ambiguity fix
-- [x] Slice 2: Numbered prefixes
-- [x] Slice 3: Number-based matching
-- [x] Slice 4: Documentation
-- [ ] Slice 5: Verification
-
-## Key Findings
-
-- `Change` currently owns filesystem queries (`request_dir?`, `request_file?`, `request_empty_dir?`, `request_full_dir?`) by checking `@original` path directly. These should move to `PathEntry`.
-- `Change` will hold an `PathEntry` instead of a raw `@original` string. `Change#original` delegates to `PathEntry#path`.
-- `PathEntryList` wraps an array of `PathEntry` objects. Constructed from `Dir.glob` results (array of strings). Owns numbered serialization (writing `[NN] path` lines) and parsing (stripping prefixes, returning number-keyed entries).
-- `ChangesFile#initialize` currently writes `requested_list.join("\n")` — will instead take an `PathEntryList` and call its serialization.
-- `ChangesFile#allow_changes` reads back lines, strips comments/blanks — will delegate prefix parsing to `PathEntryList`.
-- `Reen#request` does positional matching via `original_list.zip(changed_list)` — changes to number-based matching via `PathEntryList`.
-- `Reen#request` raises if list sizes differ (line deletion guard) — still valid with numbered approach.
-- `Change#extract_request` parses operator prefixes (`-`, `--`) greedily, which means renaming to `-` or `--` is impossible. Fix: require a space after `-`/`--` to trigger delete.
-- Tests manipulate `file.list` directly (mock editor) — the list exposed to the block will include number prefixes so test blocks simulate what a real user sees/edits.
-- Number width is auto-sized: `format("%0#{width}d")` where `width = list.size.to_s.length`.
-
-## Questions
-
-- ~~Should `Change` know about number prefixes?~~ No — `ChangesFile` handles writing and stripping prefixes. `Change` and `Reen` see clean filenames. `Reen#compare_lists` changes from positional zip to number-keyed matching.
-- ~~Should dashes go before or after number prefixes?~~ After. Dashes are operators on the filename, numbers are stable anchors: `[01] - file` = delete, `[01] -file` = rename to `-file`. Require space after `-`/`--` to distinguish.
-- [ ] Should reordering be reflected in the output summary? (Probably not needed for v1.)
-
-## Scope
-
-**In scope**:
-
-- `PathEntry` (`lib/reenrb/path_entry.rb`): wraps a file path, provides `file?`, `dir?`, `empty_dir?`, `full_dir?`, `path`
-- `PathEntryList` (`lib/reenrb/path_entry_list.rb`): collection of `PathEntry`, constructed from string array, owns numbered serialization/parsing
-- `Change`: refactor to hold `PathEntry` instead of raw string, delegate filesystem queries to `PathEntry`
-- `Change#extract_request`: require space after `-`/`--` for delete operators (fixes dash-name ambiguity)
-- `ChangesFile`: use `PathEntryList` for writing/reading, numbered prefixes, updated instructions
-- `Reen`: accept `PathEntryList` (or build one from string array), number-based matching
-- Tests for: `PathEntry`, `PathEntryList`, dash-space fix, prefix formatting/stripping, reordered matching
-
-**Out of scope**:
-
-- Reporting reorder information to the user
-- Any CLI flag to disable numbering
-- `Changes` refactor (stays as-is, wraps array of `Change`)
-- File/folder creation via unnumbered lines (touch/mkdir) — future feature, separate branch
-
-## Tasks
-
-> **Strict TDD cycle**: For each slice — (1) run full suite to confirm green baseline, (2) write failing tests (RED), (3) run tests to confirm they fail, (4) implement (GREEN), (5) run full suite to confirm all pass. **Check off each step immediately after completing it.**
-
-### Slice 0: Introduce PathEntry and PathEntryList domain objects (refactor)
-
-- [x] 0.0 Run full suite — confirm green baseline (11 tests, 0 failures)
-- [x] 0.1 RED — Write failing tests in `spec/spec_path_entry.rb`:
-  - [x] 0.1a `PathEntry` wraps a path and delegates `file?`, `dir?`, `empty_dir?`, `full_dir?`
-  - [x] 0.1b `PathEntryList` constructs from array of strings, iterates as `PathEntry` objects
-  - [x] 0.1c `PathEntryList#paths` returns array of path strings
-- [x] 0.2 Run new tests — confirm RED (6 errors, uninitialized constant)
-- [x] 0.3 GREEN — Implement `PathEntry` (`lib/reenrb/path_entry.rb`)
-- [x] 0.4 GREEN — Implement `PathEntryList` (`lib/reenrb/path_entry_list.rb`)
-- [x] 0.5 Run new tests — confirm GREEN (6 runs, 27 assertions, 0 failures)
-- [x] 0.6 Refactor `Change` to hold `PathEntry`, delegate filesystem queries
-- [x] 0.7 Refactor `Reen` and `ChangesFile` to accept/use `PathEntryList`
-- [x] 0.8 Run full suite — confirm all tests pass (17 runs, 58 assertions, 0 failures)
-
-### Slice 1: Fix dash-operator ambiguity in Change
-
-- [x] 1.0 Run full suite — confirm green baseline (17 runs, 0 failures)
-- [x] 1.1 RED — Write failing tests in `spec/spec_change.rb`:
-  - [x] 1.1a `- filename` (with space) triggers delete
-  - [x] 1.1b `-filename` (no space) triggers rename to `-filename`
-  - [x] 1.1c `-- filename` (with space) triggers force delete
-  - [x] 1.1d `--filename` (no space) triggers rename to `--filename`
-- [x] 1.2 Run new tests — confirm RED (1.1b and 1.1d fail as expected)
-- [x] 1.3 GREEN — Updated `Change#extract_request` regex: `^(--|-)·(?<name>.*)` with fallback `^()(?<name>.*)`
-- [x] 1.4 Run full suite — confirm GREEN (21 runs, 64 assertions, 0 failures)
-
-### Slice 2: Numbered prefixes in PathEntryList and ChangesFile
-
-- [x] 2.0 Run full suite — confirm green baseline (21 runs, 0 failures)
-- [x] 2.1 RED — Write failing tests:
-  - [x] 2.1a `PathEntryList#to_numbered` serializes as `[NN] path` lines (auto-sized width)
-  - [x] 2.1b `PathEntryList.from_numbered` parses `[NN] path` lines back to number-keyed entries
-  - [x] 2.1c (deferred to Slice 4 — documentation)
-- [x] 2.2 Run new tests — confirm RED (3 errors, undefined method `to_numbered`)
-- [x] 2.3 GREEN — Implement `PathEntryList#to_numbered` and `PathEntryList.from_numbered`
-- [x] 2.4 GREEN — Update `ChangesFile` to use numbered serialization
-- [x] 2.5 GREEN — Update `INSTRUCTIONS` constant with reorder/number/dash-space guidance
-- [x] 2.6 Run full suite — deferred to Slice 3 (existing tests broke as expected, fixed there)
-
-### Slice 3: Number-based matching in Reen
-
-- [x] 3.0 (combined with Slice 2 — baseline was 21 runs before numbered output broke existing tests)
-- [x] 3.1 RED — Write failing tests in `spec/spec_reorder.rb`:
-  - [x] 3.1a `Reen#request` correctly matches reordered entries to originals by number (reverse, rename+move)
-  - [x] 3.1b `Reen#request` still raises error when lines are removed
-- [x] 3.2 Run new tests — confirm RED (3.1a failed, 3.1b passed)
-- [x] 3.3 GREEN — Changed `Reen#compare_lists` to use `PathEntryList.from_numbered` for number-keyed matching
-- [x] 3.4 GREEN — Updated existing tests: delete/force-delete use `.sub("] ", "] - ")` pattern
-- [x] 3.5 Run full suite — confirm all pass (27 runs, 110 assertions, 0 failures)
-
-### Slice 4: Documentation
-
-- [x] 4.1 Update README.md: documented numbered prefixes, dash-space syntax, reordering, programmatic examples
-- [x] 4.2 CLI help in `bin/reen` — no changes needed (uses banner/options only, editing syntax is in INSTRUCTIONS)
-- [x] 4.3 `ChangesFile::INSTRUCTIONS` — updated in Slice 2.5, verified
-
-### Slice 5: Verification
-
-- [x] 5.1 Run full suite (`bundle exec rake`) — 29 tests, 115 assertions, 0 failures. RuboCop: only pre-existing offenses, no new ones.
-- [ ] 5.2 Manual verification with real editor (user to perform)
-
-## Completed
-
-- Slice 0: PathEntry/PathEntryList refactor — `PathEntry` wraps paths with filesystem queries, `PathEntryList` is an Enumerable collection. `Change` delegates to `PathEntry`. `Reen` and `ChangesFile` accept `PathEntryList`. All 17 tests pass.
-- Slice 1: Dash-operator ambiguity fix — `Change#extract_request` now requires space after `-`/`--` for delete operators. `-file` is rename to `-file`, `- file` is delete. All 21 tests pass.
-- Slice 2: Numbered prefixes — `PathEntryList#to_numbered` and `.from_numbered` implemented. `ChangesFile` writes `[NN] path` lines and updated `INSTRUCTIONS`.
-- Slice 3: Number-based matching — `Reen#compare_lists` uses `from_numbered` for number-keyed matching instead of positional zip. Reordering works. All 27 tests pass (110 assertions).
-- Slice 4: Documentation — README updated with numbered prefixes, dash-space syntax, reordering docs, programmatic examples. CLI help unchanged (banner only). INSTRUCTIONS verified.
-- Slice 5: Verification — 29 tests, 115 assertions, 0 failures. No new RuboCop offenses. Manual editor test pending.
-
----
-
-Last updated: 2026-03-10

data/lib/reen/reen.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Reen
-  # Renames pattern of files with given editor
-  # Examples:
-  #   Reen::Reen.new(editor: "code -w").call("spec/fixtures/example/*")
-  #   Reen::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)
-      @entry_list = PathEntryList.new(original_list)
-      changed_list = ChangesFile.new(@entry_list).allow_changes(@editor, &block)
-
-      raise(Error, DEL_ERROR) if changed_list.size != @entry_list.count
-
-      @changes = compare_lists(@entry_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(entry_list, changed_list)
-      changed_by_number = PathEntryList.from_numbered(changed_list)
-      entries = entry_list.to_a
-
-      entries.each_with_index.map do |entry, i|
-        number = i + 1
-        revised = changed_by_number[number]
-        Change.new(entry, revised)
-      end
-    end
-  end
-end