ezfile 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a2f6fbd88171adda8e1e4d3a2003853181a4eac5c009d8c5066583a0168aa13
+  data.tar.gz: d1d569ec887eed48ec21c75f531882ba5e1f4fdb1b6fc5ee57b9a25535688934
+SHA512:
+  metadata.gz: 73193bb2241a4843a933eb9d2c983ae80476710b9a9375e68d8d5f686c822c4e5e7635e12171094059413682b3ac0937831997f25e91172264037e798c02d4ac
+  data.tar.gz: 43e92b5cc62f6903ce91be0177331a298fd92f8ceaaf7686daf74f93ac08eaf90f7d6b2e98575214493e79ef8130f13b89d2cbafce1a602113c30f337271ee3e

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-11-10
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 aa
+
+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,77 @@
+# Ezfile
+
+Ezfile is a file util more safety than another gem `FileUtils`
+
+`copy_file` , `mainname`, `move_file`, `rename`, `remainame`
+
+## Installation
+
+
+    gem install ezfile
+
+
+## Usage
+
+```ruby
+require 'ezfile'
+
+pwd = Dir.pwd
+
+Ezfile.files("*")
+  .group_by{|fname| Ezfile.mainname}
+  .select{|mname, fs| fs.any{|f| Ezfile.extname(f) == ".ass"}}
+  .each do |fname, fs|
+     ass = File.combine(pwd, fname +".ass")
+     mp4 = File.combine(pwd, fname +".mp4")
+     outf = fname+".done.mp4"
+     system %Q(ffmpeg -i #{mp4.inspect} -vf subtitles=#{ass.inspect} -c:v h264_nvenc "./out/#{outf}")
+  end
+```
+Use `Ezfile.help` to get help.
+```ruby
+Ezfile.help
+
+<<-EOF
+              require FileUtils and Dir, File.
+          methods:
+           MOVE :
+          ::move_file file_path target_dir, mkdir: false
+              move file to target directory
+              ! if directory is non-exist,
+              throw an error.
+          ::move_file  file_path, target_dir
+              if non-exist, mkdir
+           QUERY :   its syntax like Explorer Search
+          ::file_list  target_dir = "*"     alias ::files
+          ::dir_list  target_dir = "*"      alias ::dirs
+              show list of files/directories, of target_dir.
+              ! using Dir.glob(target_dir)
+          ::glob query
+              the same as Dir.glob(query)
+
+           RENAME :
+          ::rebasename_file src_file_path, new_basename
+              it change a file's basename, and ensure never move it or change its parent node.
+
+           DELETE :
+            ::ensure_permanently_delete_file target_file     alias ::files
+            ::ensure_permanently_delete_directory_and_its_descendant target_dir     alias ::files
+EOF
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/saisui/ezfilerb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/saisui/ezfilerb/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/ezfile/version.rb

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

data/lib/ezfile.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+require_relative "Ezfile/version"
+require 'colorize'
+
+module Ezfile
+  class Error < StandardError; end
+  # Your code goes here...
+end
+
+module Ezfile
+  class << self
+
+  # == Exception ==
+  # -[x] Dest Dir has a SAME NAME node | 目的地文件夹内存在同名文件/文件夹（节点）
+  # -[x] Source File doesn't exist | 源文件不存在
+  # -[x] Dest Dir doesn't exist | 目的地文件夹不存在
+  # -[x] Path String has a space character | 路径名包含空格
+  # -[ ] Abs Path Cannot with Relative Path | 绝对路径不能与相对路径组合
+
+  # nut_a.black.you.one
+
+  def test_rebasename path, new_basename
+      File.join(File.dirname(File.expand_path(path)), new_basename + File.extname(path))
+  end
+
+  # -[x] cannot move file or change its parent node | 重命名不改变源文件父节点，不移动源文件。
+  def rebasename_file nodepath, new_basename
+
+      if new_basename.split(/[\/\\]/).size == 0
+          return throw puts  "  wrong  ".on_light_yellow + " That's no new basename"
+      elsif new_basename.split(/[\/\\]/).size >= 2
+          return throw puts  "  FORBIDDEN  ".light_white.on_yellow + " do not move its parent node, don't input a path"
+      end
+
+      src_dirpath = File.dirname File.expand_path(nodepath)
+
+      unless File.exist? nodepath
+          return throw puts  "  ERROR  ".light_white.on_red + " File " + "non-exist".red
+      end
+      new_name = new_basename + File.extname(nodepath)
+      unless Dir.entries(File.dirname nodepath).include? new_name
+          File.rename nodepath, File.join(src_dirpath, new_name)
+      end
+  end
+
+  # < means headpoint of a basename, > means lastpoint of a basename. like ^ and $ in RegEx
+  # basename   <name.dot1.dot2.ext>
+  # tailname   .dot1.dot2.ext>    # [A-Za-z_\-\.]*$
+  # mainname   <name    .dot1.dot2
+  # headname   <name
+
+  def tailname fname
+      Ezfile.basename(fname).match(/((\.[0-9A-Za-z\-_]+)+$)/)[0]
+  end
+
+  def headname fname
+      File.basename(fname)[0...-tailname(fname).size]
+  end
+
+  def mainname file_name
+      File.basename file_name, ".*"
+  end
+
+
+  def its_dir_base_ext file_path
+      [File.dirname(file_path), File.basename(file_path, ".*"), File.extname(file_path)]
+  end
+
+  def basename file_name, suffix = ""
+      File.basename file_name, suffix
+  end
+
+  def move_file file_path, target_dir, mkdir: false, rename: false, rename_fmt: "__%C"
+      unless File.exist? file_path
+          return throw puts "  ERROR  ".light_white.on_red + " File " + "non-exist".red
+      end
+      file_name = File.basename file_path
+
+      # src_exist = File.exist? file_path
+      # src_is_file = File.file? file_path rescue false
+      # dest_exist = Dir.exist? target_dir
+      # dest_is_dir = File.directory? target_dir rescue false
+      # not_same_name = target_dir_entries.include? file_name rescue false
+
+      isit_should_move = false
+
+      if Dir.exist? target_dir
+          target_dir_entries = Dir.entries target_dir
+          if target_dir_entries.include? file_name
+              if rename == true
+
+                  rename_count = 0
+                  # nDigits = rename_fmt.count("#")
+                  begin
+                      rename_count += 1
+                      # rename_postfix = rename_fmt.gsub(/#*/, "%0#{nDigits}d" % rename_count)
+                      src_dirpath, file_basename, file_ext = its_dir_base_ext(file_path)
+                      new_basename = file_basename + "__mv_rename_#{rename_count}"
+                      new_name = new_basename + file_ext
+
+                      new_name_file_path = File.join(src_dirpath, new_name)
+                  end while target_dir_entries.include? new_name
+
+                  rebasename_file(file_path, new_basename)
+                  return move_file(new_name_file_path, target_dir)
+              end
+              return throw puts  "  ERROR  ".light_white.on_red + %Q(   === Destination already has a same name node! -- "#{file_name.red}" ===)
+          end
+          isit_should_move = true
+      elsif mkdir == true
+          Dir.mkdir target_dir
+          isit_should_move = true
+      else
+          return throw puts  "  ERROR  ".light_white.on_red + " Destination Directory doesn't exist!"
+      end
+
+      if isit_should_move
+          FileUtils.move file_path, target_dir
+      end
+  end
+
+  def copy_file file_path, dest_file_path
+      if File.exist? dest_file_path
+          return throw puts  "  FORBIDDEN  ".light_white.on_yellow + " There is a same name node, cannot " + " COVER ".light_white.on_red.bold + " another existen node, Because will " + " LOSE ".light_white.on_red + " the FILE."
+      end
+      FileUtils.copy_file file_path, dest_file_path
+  end
+
+  def move_file_mkdir file_path, target_dir
+      self.move_file file_name, target_dir, mkdir: true
+  end
+
+  def file_list dir = "*"
+      Dir.glob(dir).select{File.file? _1}
+  end
+
+  def dir_list dir = "*"
+      Dir.glob(dir).select{File.directory? _1}
+  end
+
+  alias files file_list
+  alias dirs dir_list
+  alias movefile move_file
+  alias movefile_mkdir move_file_mkdir
+  alias copyfile copy_file
+
+  def glob query
+      Dir.glob(query)
+  end
+
+  def ensure_permanently_delete_file file_path
+      if File.file? file_path
+          FileUtils.remove_file file_path
+      end
+  end
+  def ensure_permanently_delete_directory_and_its_descendant dir_path
+      if File.direcotry? dir_path
+          FileUtils.remove_dir dir_path
+      end
+  end
+
+  def help
+      puts <<-EOF
+              require #{"FileUtils".red} and #{"Dir".red}, #{"File".red}.
+          methods:
+          #{" MOVE ".bold.underline.on_red}:
+          #{"::move_file".cyan} file_path target_dir, mkdir: false
+              move file to target directory
+              ! if directory is non-exist,
+              throw an error.
+          #{"::move_file ".cyan} file_path, target_dir
+              if non-exist, mkdir
+          #{" QUERY ".bold.underline.on_green}:   its syntax like #{"Explorer Search".underline}
+          #{"::file_list ".cyan} target_dir = "*"     alias #{"::files".cyan}
+          #{"::dir_list ".cyan} target_dir = "*"      alias #{"::dirs".cyan}
+              show list of files/directories, of target_dir.
+              ! using #{"Dir.glob(target_dir)".italic.underline.yellow}
+          #{"::its_dir_base_ext ".cyan} file_path
+              return an array of file's dirpath basename extname.
+          #{"::glob".cyan} query
+              the same as #{"Dir.glob(query)".italic.underline.yellow}
+
+          #{" RENAME ".bold.underline.on_yellow}:
+          #{"::rebasename_file".cyan} src_file_path, new_basename
+              it change a file's basename, and ensure never move it or change its parent node.
+
+          #{" DELETE ".bold.underline.on_red}:
+              #{"::ensure_permanently_delete_file".cyan} target_file     alias #{"::files".cyan}
+              #{"::ensure_permanently_delete_directory_and_its_descendant".cyan} target_dir     alias #{"::files".cyan}
+      EOF
+  end
+
+  end
+end

data/sig/ezfile.rbs

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

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: ezfile
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- saisui
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-10 00:00:00.000000000 Z
+dependencies: []
+description: 'More Safety than FileUtils. Like #move_file, #copy_file, #rename_file.
+  If that destination string including a space, it will be a correct node name. If
+  that destination directory has a same name file, move will throw an Error of if
+  send a keyvalue -- rename: true, it will be renamed by order Number.'
+email:
+- example@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ezfile.rb
+- lib/ezfile/version.rb
+- sig/ezfile.rbs
+homepage: https://github.com/saisui/ezfilerb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/saisui/ezfilerb
+  source_code_uri: https://github.com/saisui/ezfilerb
+  changelog_uri: https://github.com/saisui/ezfilerb/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.21
+signing_key:
+specification_version: 4
+summary: A filetool for windows, It's more safety
+test_files: []