filename_increment 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ea5858882ee73443603452fcba99a4691bf7c69bf70f16eadeda434df02380fd
+  data.tar.gz: 2e0fd301ebde9d9abffa067979baedae51467d2da0bf28a2972e440d73b49cff
+SHA512:
+  metadata.gz: 9ad677398faf5e60db470a6659685d44e25ecd6406103a2a5f5b5b55f07932c4722aa1719c8c91bd2d403b2fcf545e53f53eeebd1507c1ae427715dfcfaa9217
+  data.tar.gz: 23e17d53ea2ad3663e6ffcb36d33ff797d466d9f72f1ad0d990fcc978b3708ae113c18c094bf23bd74091aefc3d3d9e814fbf3c92b9b379fd9ca98406e3a5417

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/

data/.ruby-gemset

@@ -0,0 +1 @@
+filename_increment

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.0

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dimidev@olympusone. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in filename_increment.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Dimitrios Panagkasidis
+
+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,113 @@
+# filename_increment
+Please consider starring the project to show your heart and support.
+
+Project is based on this [repo](https://github.com/jonschlinkert/add-filename-increment), show him some love please ;).
+>When copying or moving files, it's common for operating systems to automatically 
+>add an increment or 'copy' to duplicate file names. This does that for Ruby applications, with automatic platform 
+>detection and support for Linux, MacOs, and Windows conventions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'filename_increment'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install filename_increment
+
+## Usage
+All methods automatically detect the platform to use, unless platform is defined on the options.
+
+```ruby
+FilenameIncrement.new('foo/bar.txt', platform: 'linux').to_s
+# foo/bar (copy).txt
+FilenameIncrement.new('foo/bar.txt', platform: 'win32').to_s
+# foo/bar (2).txt
+FilenameIncrement.new('foo/bar.txt', platform: 'darwin').to_s
+# foo/bar copy.txt
+```
+
+## Options
+
+### options.fs
+
+**Description**: Check the file system, and automatically increment the file based on existing files. Thus, if the file name is `foo.txt`, and `foo (2).txt` already exists, the file will automatically be renamed to `foo (3).txt`.
+
+Also uses the correct conventions for Linux, Windows (win32), and MacOS (darwin).
+
+**Type**: `boolean`
+
+**Default**: `nil`
+
+### options.platform
+
+**Description**: Specify the platform conventions to use.
+
+**Type**: `String`
+
+**Default**: Uses `Gem::Platform.local.os`. Valid values are `linux`, `win32` and `darwin`.
+
+## Operating Systems
+
+* [Linux](#linux)
+* [MacOS](#macos)
+* [Windows](#windows)
+
+**Supported Operating Systems**
+
+Currently Windows, Darwin (MacOS), and Linux are supported. This library attempts to automatically use the correct conventions for each operating system. Please [create an issue](../../issues/new) if you ecounter a bug.
+
+If you use an operating system with different conventions, and you would like for this library to add support, please [create an issue](../../issues/new) with a detailed description of those conventions, or feel free to do a [pull request](.github/contributing.md).
+
+### Linux
+
+When a file is copied or moved, and the destination file path already exists, Linux uses the following conventions for incrementing the file name.
+
+| **Source path** | **Destination path** | **Type** | **Directory<sup>1</sup>** |
+| --- | --- | --- | --- |
+| `foo.txt` | `foo (copy).txt`, `foo (another copy).txt`, `foo (3rd copy).txt`, ... | file | Same directory as source |
+| `foo` | `foo (copy)`, `foo (another copy)`, `foo (3rd copy)`, ... | directory | Same directory as source |
+
+<small><sup>1</sup> _On Linux, when a file or folder is copied or moved to a different directory and another file or folder with the same name exists in that directory, you are prompted to choose a new name for the file or folder, or to cancel or skip the operation._ </small>
+
+### MacOS
+
+When a file is copied or moved, and the destination file path already exists, MacOS uses the following conventions for incrementing the file name.
+
+| **Source path** | **Destination path** | **Type** | **Directory<sup>1</sup>** |
+| --- | --- | --- | --- |
+| `foo.txt` | `foo copy.txt`, `foo copy 2.txt`, ... | file | Same directory as source |
+| `foo.txt` | `foo 2.txt`, `foo 3.txt`, ... | file | Different directory than source |
+| `foo` | `foo copy`, `foo copy 2`, ... | directory | Same directory as source |
+
+<small><sup>1</sup> _MacOS uses different conventions for incrementing file names when the source file is copied, moved or renamed to a different directory, versus when the file is copied into the same directory._ </small>
+
+### Windows
+
+When a file is copied or moved, and the destination file path already exists, Windows uses the following conventions for incrementing the file name.
+
+| **Source path** | **Destination path** | **Type** | **Directory<sup>1</sup>** |
+| --- | --- | --- | --- |
+| `foo.txt` | `foo - Copy.txt` | file | Same directory as source |
+| `foo.txt` | `foo (2).txt` | file | Different directory than source |
+| `foo (2).txt` | `foo (3).txt` | file | Different directory than source |
+| `foo` | `foo - Copy` | directory | Same directory as source |
+| `foo - Copy` | `foo - Copy (2)` | directory | Same directory as source |
+
+<small><sup>1</sup> _Windows uses different conventions for incrementing file names when the source file is copied, moved or renamed to a different directory, versus when the file is copied into the same directory. Also, when a folder is copied to a new directory, and the new directory already has a folder with the same name, Windows just merges the folders automatically._ </small>
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the FilenameIncrement project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/filename_increment/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/TODO.md

@@ -0,0 +1,3 @@
+## TODO
+- [ ] Add more extensive test
+- [ ] Add option to parameterize path (underscored)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "filename_increment"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/filename_increment.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/filename_increment/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "filename_increment"
+  spec.version = FilenameIncrement::VERSION
+  spec.authors = ["Dimitrios Panagkasidis"]
+  spec.email = ["dimidev@olympusone.com"]
+
+  spec.summary = %q{Automatically add an increment or 'copy' to duplicate file names}
+  spec.description = %q{When copying files, it's common for operating systems to append a numerical increment or
+                        the word 'copy' to a file name to prevent the existing file from being overwritten.
+                        This library allows you to do the same thing in your Ruby application.}
+  spec.homepage = "https://rubygems.org/gems/filename_increment"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/olympusone/filename_increment"
+  spec.metadata["changelog_uri"] = "https://github.com/olympusone/filename_increment/CHANGELOG.md"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/filename_increment.rb

@@ -0,0 +1,102 @@
+require "filename_increment/version"
+require 'pathname'
+
+class FilenameIncrement
+  class Error < StandardError; end
+
+  class FileNotFound < IOError; end
+
+  ORDINALS = %w[th st nd rd]
+
+  attr_reader :path
+
+  def initialize(filepath, options = {})
+    @options = options
+
+    @platform = @options[:platform] || Gem::Platform.local.os
+    @file = parse(filepath)
+    @start = @options[:start] || 1
+
+    @file = parse(filepath)
+
+    if @start == 1 && (@platform == 'win32' || @platform == 'windows')
+      @start += 1
+    end
+
+    if @options[:fs].is_a? TrueClass
+      if File.exist?(filepath)
+        name = @file[:name]
+        dest = filepath
+
+        while File.exist?(dest)
+          @start += 1
+          @file[:basename] = format(name, @start) + @file[:extname]
+
+          dest = File.join(@file[:dirname], @file[:basename])
+        end
+      else
+        # raise error if file not found
+        raise FileNotFound.new('File not found')
+      end
+    else
+      @file[:basename] = format(@file[:name], @start) + @file[:extname]
+    end
+
+    @path = Pathname.new(@file[:dirname]).join(@file[:basename])
+  end
+
+  def to_s
+    @path.cleanpath.to_s
+  end
+
+  private
+
+  def parse(filepath)
+    pathname = Pathname.new(filepath)
+
+    path = {path: filepath}
+    path[:dirname] = pathname.dirname
+    path[:basename] = pathname.basename
+    path[:name] = pathname.basename(pathname.extname)
+    path[:extname] = pathname.extname
+
+    path
+  end
+
+  def ordinal(number)
+    raise TypeError.new('expected a number') unless number.is_a? Numeric
+
+    ORDINALS[((number % 100) - 20) % 10] || ORDINALS[number % 100] || ORDINALS[0]
+  end
+
+  def to_ordinal(number)
+    raise TypeError.new('expected a number') unless number.is_a? Numeric
+
+    "#{number}#{ordinal(number)}"
+  end
+
+  def format(stem, number)
+    case @platform
+    when 'win32', 'windows'
+      number > 1 ? "#{stem} (#{number})" : stem
+    when 'linux'
+      if number == 0
+        stem
+      elsif number == 1
+        "#{stem} (copy)"
+      elsif number == 2
+        "#{stem} (another copy)"
+      else
+        "#{stem} (#{to_ordinal(number)} copy)"
+      end
+    when 'darwin'
+      if number == 1
+        "#{stem} copy"
+      elsif number > 1
+        "#{stem} (#{stem} copy #{number})"
+      end
+    else
+      number > 1 ? "#{stem} (#{number})" : stem
+    end
+  end
+end

data/lib/filename_increment/version.rb

@@ -0,0 +1,3 @@
+class FilenameIncrement
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: filename_increment
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dimitrios Panagkasidis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-03 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  When copying files, it's common for operating systems to append a numerical increment or
+                          the word 'copy' to a file name to prevent the existing file from being overwritten.
+                          This library allows you to do the same thing in your Ruby application.
+email:
+- dimidev@olympusone.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- bin/console
+- bin/setup
+- filename_increment.gemspec
+- lib/filename_increment.rb
+- lib/filename_increment/version.rb
+homepage: https://rubygems.org/gems/filename_increment
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/filename_increment
+  source_code_uri: https://github.com/olympusone/filename_increment
+  changelog_uri: https://github.com/olympusone/filename_increment/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Automatically add an increment or 'copy' to duplicate file names
+test_files: []