reenrb 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2253d4b2aa304bfac8b7e4659fee9ca3b514a22d4a0bb323be9619883b9448c0
-  data.tar.gz: 3f82b6afbbe84b70878d153b56f6f75a72c2570df3b2b292c0d42a4a0057e973
+  metadata.gz: 8f607120ef687c5ace8a02b12e3fb6306abc16aa45b6f906f3e853f995df9a51
+  data.tar.gz: 0d4b19262e64584508daf56c0ec2024603ff1a375d134fc000774d1e9233714e
 SHA512:
-  metadata.gz: 331ad4055d5abc194ec73fb0be6ac7479d3d2d8c41fb37980edc9c772f998a7b469da386e6b8e9c9dfe594802f9f1e39daa0081f0e109a1278fa41b1fb666a24
-  data.tar.gz: 39d3af74b266effdb9ad82c513412539edd75b2573e97a36f41850027822c4a22029fa0b1fe6b298de177f9d794c86e80c88349dcb05b2b19541c998a572e2c2
+  metadata.gz: 420f2980c0e6a22ddeb7dbfc9a6abc62a9c8845f19f0902ba975c13996e87c371da9dd003b1d70fbdca9a14ebfeae36e85bd883671bb8b9eec27aa622a1e4fe1
+  data.tar.gz: 971cade35548d6fbde58a07ebd3707f34e95da5933e37c37d4eef1f8f108a1714b789aa873ccbcd2331a0214c330bd93a83c4b4f52f295f04130802efff0a726

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/changes.rb

@@ -11,7 +11,7 @@ module Reenrb
       @list = changes_list
     end
 
-    def execute!
+    def execute_all
       @list.map(&:execute)
       self
     end
@@ -42,6 +42,14 @@ module Reenrb
       Changes.new(@list.select(&:executed?))
     end
 
+    def failed
+      Changes.new(@list.select(&:failed?))
+    end
+
+    def any?
+      !@list.empty?
+    end
+
     def count
       @list.size
     end

data/lib/reenrb/changes_file.rb

@@ -5,22 +5,37 @@ 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 path
-      @list_file.path
+    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
 
-    def allow_changes(&block)
-      block.call(self)
-      File.read(path).split("\n")
+    private
+
+    def path
+      @list_file.path
     end
 
-    def blocking_edit(editor)
+    def await_editor(editor)
       `#{editor} #{@list_file.path}`
     end
   end

data/lib/reenrb/reen.rb

@@ -6,7 +6,7 @@ module Reenrb
   #   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"
+    DEL_ERROR = "Do not remove any file/folder names (no changes made)"
 
     attr_reader :changes
 
@@ -15,16 +15,8 @@ module Reenrb
       @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
+    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
 
@@ -34,7 +26,7 @@ module Reenrb
 
     def execute(original_list, &block)
       @changes ||= request(original_list, &block)
-      @changes = @changes.execute!
+      @changes = @changes.execute_all
     end
 
     private

data/lib/reenrb/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reenrb
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  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