reenrb 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5350da1a685dccdcd5298a94beed380476f381a8e75ebb8a02b655bca0185bd7
-  data.tar.gz: d9fac2a8bbce0dc7ff8c6d71a1e100ac2decdee5bc0036878ff74056653af7a3
+  metadata.gz: ef0b76de4c05fb0949d2b65b6b7f79d3265fb1474e109de5186a788b1c32602c
+  data.tar.gz: 5c4a47408deed235d05236615380fdc35a099f4049d7fce833e3a06af48c2d96
 SHA512:
-  metadata.gz: 5f5b124d9f7552d06380ed3f1c8eea08e1c707a9f8d5ef1feb80373ce5c24ec71ee2b2b4f661a7f4a2cb22fc780270a2163e9fb523b334b1bab30dfa518fc4c6
-  data.tar.gz: e3508d642009b303cd23692403d41ab8de61f0e8a805aeeade650dcb3954cdbd851c74a41b0c008dca3a40e3b31419308cda371e99f9d3fc433650813292a0a0
+  metadata.gz: 3fe1b3c16fb10bdaa39c095acef4611822c2c07934081dfc1d223f2103d3cf07a3d819b50b5a1351cec1538d0fb24e03fd77d58eeef2bb212405a1c624b2f602
+  data.tar.gz: 88bd9ad15855e04911bd87b2d620843a254c31c0b84a4919c18cdaa314b8bd8c6953280450e8cefbbc32af1489e4c5034322bff26c4a63cdc2a9c57810b04348

data/.rubocop.yml

@@ -2,6 +2,16 @@ AllCops:
   TargetRubyVersion: 3.0
   NewCops: enable
 
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+  - reenrb.gemspec
+
+Style/HashSyntax:
+  Enabled: true
+  Exclude:
+  - Rakefile
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    reenrb (0.1.0)
+    reenrb (0.2.1)
 
 GEM
   remote: https://rubygems.org/
@@ -45,6 +45,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   minitest (~> 5.0)

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

@@ -12,11 +12,11 @@ $LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 require "reenrb"
 
 file_list = ARGV || Dir.glob("*")
-editor = ENV["VISUAL"] || ENV["EDITOR"]
+editor = ENV["VISUAL"] || ENV["EDITOR"] # rubocop:disable Style/FetchEnvVar
 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/change.rb

@@ -40,22 +40,6 @@ module Reenrb
       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
@@ -65,12 +49,8 @@ module Reenrb
       end
     end
 
-    def executed_or_rejected
-      %i[executed rejected].include? @status
-    end
-
     def execute
-      return(self) if executed_or_rejected
+      return(self) if executed_or_rejected?
 
       case @change
       when :rename
@@ -83,6 +63,34 @@ module Reenrb
       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

data/lib/changes.rb

@@ -9,10 +9,13 @@ module Reenrb
       @list = changes_list
     end
 
-    def none
-      Changes.new(@list.select { |c| c.change == :none })
+    def execute!
+      @list.map(&:execute)
+      self
     end
 
+    # Inspection
+
     def rename_requested
       Changes.new(@list.select { |c| c.change == :rename })
     end
@@ -37,10 +40,30 @@ module Reenrb
       Changes.new(@list.select { |c| c.status == :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? :none
+    end
+
+    def changes_requested?
+      !no_changes_requested?
+    end
+
+    def all_executed?
+      @list.all?(&:executed?)
+    end
   end
 end

data/lib/reenrb/version.rb

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

data/lib/reenrb.rb

@@ -9,8 +9,9 @@ module Reenrb
   class Error < StandardError; end
 
   # Renames pattern of files with given editor
-  # Example:
+  # 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"
 
@@ -21,20 +22,26 @@ module Reenrb
       @options = options
     end
 
-    def request(original_list, &block)
-      # original_list = Dir.glob(pattern)
+    def request(original_list, &block) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       changed_list = ChangesFile.new(original_list).allow_changes do |file|
-        @options[:mock_editor] ? yield(file.path) : file.blocking_edit(@editor)
+        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.map(&:execute)
+      @changes = @changes.execute!
     end
 
     private

data/reenrb.gemspec

@@ -12,16 +12,15 @@ Gem::Specification.new do |spec|
   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.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."
 
-  # 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)})
@@ -31,12 +30,12 @@ Gem::Specification.new do |spec|
   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 "rake", "~> 13.0"
   spec.add_development_dependency "rerun", "~> 0.13"
   spec.add_development_dependency "rubocop", "~> 1.21"
+  spec.add_development_dependency "rubyzip", "~> 2.3"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reenrb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Soumya Ray
@@ -11,89 +11,89 @@ cert_chain: []
 date: 2022-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: rubyzip
+  name: minitest-rg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: minitest-rg
+  name: rerun
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
-  name: rerun
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '1.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '1.21'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '2.3'
 description: Renames or deletes a pattern of files using your favorite editor
 email:
 - soumya.ray@gmail.com
@@ -123,6 +123,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/soumyaray/reenrb
   source_code_uri: https://github.com/soumyaray/reenrb
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -131,7 +132,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="