reenrb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5350da1a685dccdcd5298a94beed380476f381a8e75ebb8a02b655bca0185bd7
+  data.tar.gz: d9fac2a8bbce0dc7ff8c6d71a1e100ac2decdee5bc0036878ff74056653af7a3
+SHA512:
+  metadata.gz: 5f5b124d9f7552d06380ed3f1c8eea08e1c707a9f8d5ef1feb80373ce5c24ec71ee2b2b4f661a7f4a2cb22fc780270a2163e9fb523b334b1bab30dfa518fc4c6
+  data.tar.gz: e3508d642009b303cd23692403d41ab8de61f0e8a805aeeade650dcb3954cdbd851c74a41b0c008dca3a40e3b31419308cda371e99f9d3fc433650813292a0a0

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-11-05
+
+- Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in reenrb.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    reenrb (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    ffi (1.15.5)
+    json (2.6.2)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    minitest (5.16.3)
+    minitest-rg (5.2.0)
+      minitest (~> 5.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.6.0)
+    rerun (0.13.1)
+      listen (~> 3.0)
+    rexml (3.2.5)
+    rubocop (1.38.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    rubyzip (2.3.2)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  minitest-rg (~> 5.0)
+  rake (~> 13.0)
+  reenrb!
+  rerun (~> 0.13)
+  rubocop (~> 1.21)
+  rubyzip (~> 2.3)
+
+BUNDLED WITH
+   2.3.8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Soumya Ray
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# Reenrb
+
+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.
+
+## Installation
+
+To install the command line utility, use:
+
+    $ gem install reenrb
+
+Or add this line to your Ruby application's Gemfile for programmatic use:
+
+```ruby
+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 ...]
+
+Examples:
+
+    reen *
+    reen myfolder/**/*.mov
+
+### 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.
+
+```ruby
+require 'reenrb'
+
+glob = Dir.glob("*")
+reen = Reenrb::Reen.new(options: { mock_editor: true })
+
+reen.execute(glob) do |tmpfile_path|
+  lines = File.read(tmpfile_path).split("\n")
+
+  # 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"))
+end
+```
+
+## 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/soumyaray/reenrb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << "tspecest"
+  t.libs << "lib"
+  t.test_files = FileList["spec/**/spec_*.rb"]
+end
+
+task :respec do
+  sh "rerun -c --ignore 'spec/fixtures/*' rake spec"
+end
+
+namespace :example do
+  task :config do
+    require_relative "spec/fixture_helper"
+  end
+
+  desc "Recreates the example fixture folder"
+  task :recreate => :config do
+    FixtureHelper.recreate_example_dir
+    puts "Example fixture recreated"
+  end
+
+  desc "Deletes the example fixture folder"
+  task :remove => :config do
+    FixtureHelper.remove_example_dirs
+    puts "Example fixture removed"
+  end
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/reen

@@ -0,0 +1,22 @@
+#!/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"
+
+file_list = ARGV || Dir.glob("*")
+editor = ENV["VISUAL"] || ENV["EDITOR"]
+exit_with_error(EDITOR_MSG) if editor.empty?
+
+results = Reenrb::Reen.new(editor: editor).execute(file_list)
+
+changes = Reenrb::Changes.new(results).change_requested
+
+puts changes.summarize

data/lib/change.rb

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

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

data/lib/changes_file.rb

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

data/lib/reenrb/version.rb

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

data/lib/reenrb.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "reenrb/version"
+require_relative "changes_file"
+require_relative "change"
+require_relative "changes"
+
+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] ? yield(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

data/reenrb.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/reenrb/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "reenrb"
+  spec.version = Reenrb::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/reenrb"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7"
+
+  # 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["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  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"]
+
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rubyzip", "~> 2.3"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-rg", "~> 5.0"
+  spec.add_development_dependency "rerun", "~> 0.13"
+  spec.add_development_dependency "rubocop", "~> 1.21"
+
+  # 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

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

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: reenrb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Soumya Ray
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-rg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rerun
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: Renames or deletes a pattern of files using your favorite editor
+email:
+- soumya.ray@gmail.com
+executables:
+- reen
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/reen
+- lib/change.rb
+- lib/changes.rb
+- lib/changes_file.rb
+- lib/reenrb.rb
+- lib/reenrb/version.rb
+- reenrb.gemspec
+- sig/reenrb.rbs
+homepage: https://github.com/soumyaray/reenrb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/soumyaray/reenrb
+  source_code_uri: https://github.com/soumyaray/reenrb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Renames or deletes a pattern of files using your favorite editor
+test_files: []