apender 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66fb5c0b4aedbedb0583f4881782380314309c7bb4942d53aead05ff0daa5eb6
-  data.tar.gz: ff1ff8c3918edec89cbfdf79a9ce40222268d26d3f7882682d10632f017cdc29
+  metadata.gz: 7c15c0bef36e8548a32a35a52f827c3e25fb948a7ce6bd8f4baec87834c481fa
+  data.tar.gz: 053a45680b3b6c711e898bc9ad5f369efa70664f2b4f8af2291e344424a04f29
 SHA512:
-  metadata.gz: fb3743f39a42d79e6db87b16da9b73558ca705a74815037bbefa89de6564046e2a6fb4aadbac98d504d6c93f8b620d7e481c356669c49fff78c15af895e5bf1b
-  data.tar.gz: 67c4baff60dfb0a5693183a145173dfacf4f0aeb0e9221f8fee333d075211358b3a7856f5051ff6d9bf808adadaf7d190c3544e4c2a6d1697731b05f3b7aeada
+  metadata.gz: 8058260e2c20bb766deba3a88c3c49389f36ff3b2e3f4d3f8398ada32a666cd275bb4b6c03f8790ffd60017aab6cab9b79c26cf2ddd177442f4be3687087afc8
+  data.tar.gz: c0c8d276cc408a5c718036cdd1b0fb1e617da1d9cef8baebf191a3b3cb9cc1f29039295aeeb5f776dd611c3340e1f94b45a1de3615f6fa28dd11e22e4851b2a7

data/CHANGELOG.md

@@ -1,5 +1,40 @@
-## [Unreleased]
+# Changelog
+
+All notable changes to Apender are documented in this file.
+
+This project follows a simple versioning format based on [Semantic Versioning](https://semver.org/).
+
+## [0.2.0] - 2026-11-01
+
+### Added
+- Replace specific lines using `-l` or `--line`.
+- Add content to existing lines using `-a` or `--add`.
+- Automatically create missing lines when targeting a line beyond the end of a file.
+- Add automated tests for the main functionality.
+
+### Changed
+- Expand command-line help with the new options.
+- Improve project metadata and documentation.
+
+### Notes
+- Line numbers start at 1.
+- `-a` requires `-l`.
+- `-n` cannot be combined with `-l`.
+- Content written to a specific line must be a single line.
 
 ## [0.1.0] - 2026-11-01
 
-- Initial release
+### Added
+- Initial release of Apender.
+- Append text to existing files using `-c` or `--content`.
+- Append empty lines using `-n` or `--null`.
+- Specify target files using `-p` or `--path`.
+- Automatically insert a newline when the file does not end with one.
+- Preserve existing file contents.
+- Display command-line help with `--help`.
+- Error handling for missing files and invalid arguments.
+
+### Notes
+- Files are not created automatically.
+- `-c` and `-n` cannot be used together.
+- Initial release published on RubyGems.

data/CODE_OF_CONDUCT.md

@@ -1,10 +1,63 @@
 # Code of Conduct
 
-"apender" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+## Our Pledge
 
-* Participants will be tolerant of opposing views.
-* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
-* When interpreting the words and actions of others, participants should always assume good intentions.
-* Behaviour which can be reasonably considered harassment will not be tolerated.
+We are committed to making participation in the Apender project a welcoming, respectful, and harassment-free experience for everyone.
 
-If you have any concerns about behaviour within this project, please contact us at ["TODO: Write your email address"](mailto:"TODO: Write your email address").
+We welcome contributions from people of all backgrounds and experience levels.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment:
+
+- Being respectful and considerate.
+- Welcoming different opinions and perspectives.
+- Giving and accepting constructive feedback.
+- Helping newcomers feel welcome.
+- Taking responsibility for mistakes and learning from them.
+- Focusing on what is best for the project and its community.
+
+Examples of unacceptable behavior:
+
+- Harassment, discrimination, or personal attacks.
+- Insulting or threatening other contributors.
+- Publishing private information without permission.
+- Trolling, deliberate intimidation, or disruptive behavior.
+- Any other conduct that would be inappropriate in a professional community.
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior.
+
+They may remove, edit, or reject contributions that violate this Code of Conduct.
+
+## Scope
+
+This Code of Conduct applies to all project spaces, including:
+
+- GitHub issues and pull requests.
+- Discussions and comments.
+- Project-related communication channels.
+- Any other space where someone represents the Apender project.
+
+## Reporting
+
+If you experience or witness unacceptable behavior, please report it through the GitHub repository:
+
+https://github.com/Nic24nix/apender/issues
+
+Please include as much relevant information as possible.
+
+## Enforcement
+
+Project maintainers will review reports and take appropriate action.
+
+They may remove inappropriate content, reject contributions, or restrict participation in the project when necessary.
+
+## Attribution
+
+This Code of Conduct is inspired by the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.
+
+For more information, visit:
+
+https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

data/LICENSE.txt

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2026 TODO: Write your name
+Copyright (c) 2026 Nic24nix
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,9 @@ 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 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.
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

data/README.md

@@ -1,43 +1,140 @@
 # Apender
 
-TODO: Delete this and the text below, and describe your gem
+**A simple Ruby CLI tool to append content to existing files and edit specific lines.**
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/apender`. To experiment with that code, run `bin/console` for an interactive prompt.
+Apender is a lightweight command-line utility written in Ruby. It allows you to append text or empty lines to files, replace specific lines, and add content to existing lines without overwriting the rest of the file.
+
+## Features
+
+- Append text to existing files.
+- Append empty lines.
+- Replace content on specific lines.
+- Add content to existing lines without replacing their contents.
+- Automatically create missing lines when targeting a line beyond the end of a file.
+- Preserve all existing file contents.
+- Automatically insert a newline when the file doesn't end with one.
+- Simple command-line interface.
+- Does not create files that don't exist.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+### RubyGems
+
+```bash
+gem install apender
+```
+
+### Arch Linux / CachyOS
 
-Install the gem and add to the application's Gemfile by executing:
+Once available in the AUR:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+paru -S apender
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+### From source
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+git clone https://github.com/Nic24nix/apender.git
+cd apender
+gem build apender.gemspec
+gem install --user-install ./apender-0.2.0.gem
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Append text
+
+```bash
+append -p ~/notes.txt -c "Hello, world!"
+```
+
+This appends `Hello, world!` to the end of `notes.txt`.
+
+### Append an empty line
 
-## Development
+```bash
+append -p ~/notes.txt -n
+```
+
+This appends an empty line to the file.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Replace a specific line
 
-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).
+```bash
+append -p ~/notes.txt -c "New content" -l 3
+```
 
-## Contributing
+This replaces the content of line 3.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/apender. 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/[USERNAME]/apender/blob/master/CODE_OF_CONDUCT.md).
+### Add content to an existing line
+
+```bash
+append -p ~/notes.txt -c " More text" -l 1 -a
+```
+
+This adds content to the end of line 1 without replacing its existing content.
+
+### Display help
+
+```bash
+append --help
+```
+
+## Options
+
+| Option | Description |
+|---|---|
+| `-p PATH`, `--path PATH` | Path to the existing file |
+| `-c CONTENT`, `--content CONTENT` | Text to write |
+| `-n`, `--null` | Append an empty line |
+| `-l LINE`, `--line LINE` | Select a specific line |
+| `-a`, `--add` | Add content to an existing line |
+| `-h`, `--help` | Display help |
+
+**Note:** You must use either `-c` or `-n`, not both. `-a` requires `-l`, and `-n` cannot be combined with `-l`.
+
+## Examples
+
+Starting with a file containing:
+
+```text
+Shopping list
+Milk
+Bread
+```
+
+Run:
+
+```bash
+append -p shopping.txt -c "Eggs"
+append -p shopping.txt -n
+append -p shopping.txt -c "Butter" -l 3
+append -p shopping.txt -c " Shopping" -l 1 -a
+```
+
+The resulting file:
+
+```text
+Shopping list Shopping
+Milk
+Butter
+Eggs
+
+```
+
+## Requirements
+
+- Ruby 3.2 or newer
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Apender is released under the MIT License. See [LICENSE.txt](LICENSE.txt).
+
+## Repository
+
+[github.com/Nic24nix/apender](https://github.com/Nic24nix/apender)
 
-## Code of Conduct
+---
 
-Everyone interacting in the Apender project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/apender/blob/master/CODE_OF_CONDUCT.md).
+Made with Ruby 🩷

data/exe/append

@@ -7,7 +7,7 @@ require "optparse"
 options = {}
 
 parser = OptionParser.new do |opts|
-  opts.banner = "Usage: append -p PATH (-c CONTENT | -n)"
+  opts.banner = "Usage: append -p PATH (-c CONTENT | -n) [-l LINE] [-a]"
 
   opts.on("-p PATH", "--path PATH", "File path") do |path|
     options[:path] = path
@@ -20,6 +20,14 @@ parser = OptionParser.new do |opts|
   opts.on("-n", "--null", "Append an empty line") do
     options[:null] = true
   end
+
+  opts.on("-l LINE", "--line LINE", Integer, "Target line number") do |line|
+    options[:line] = line
+  end
+
+  opts.on("-a", "--add", "Add content to the existing line") do
+    options[:add] = true
+  end
 end
 
 begin
@@ -32,10 +40,23 @@ begin
           "Use either -c CONTENT or -n, not both"
   end
 
+  if options[:add] && !options[:line]
+    raise OptionParser::InvalidArgument, "-a requires -l LINE"
+  end
+
+  if options[:line] && options[:null]
+    raise OptionParser::InvalidArgument, "-l cannot be used with -n"
+  end
+
   if options[:null]
     Apender.newline(options[:path])
   else
-    Apender.append(options[:path], options[:content])
+    Apender.append(
+      options[:path],
+      options[:content],
+      line: options[:line],
+      add: !!options[:add]
+    )
   end
 
 rescue OptionParser::ParseError, Apender::Error => e

data/lib/apender/version.rb

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

data/lib/apender.rb

@@ -1,4 +1,3 @@
-
 # frozen_string_literal: true
 
 require_relative "apender/version"
@@ -6,9 +5,14 @@ require_relative "apender/version"
 module Apender
   class Error < StandardError; end
 
-  def self.append(path, content)
+  def self.append(path, content, line: nil, add: false)
     raise Error, "File does not exist: #{path}" unless File.file?(path)
 
+    if line
+      write_line(path, content, line, add)
+      return
+    end
+
     File.open(path, "a") do |file|
       unless File.zero?(path)
         last_byte = File.binread(path, 1, File.size(path) - 1)
@@ -19,6 +23,33 @@ module Apender
     end
   end
 
+  def self.write_line(path, content, line, add)
+    raise Error, "Line number must be greater than 0" unless line.positive?
+    raise Error, "Content must be a single line" if content.include?("\n")
+
+    original = File.read(path)
+    trailing_newline = original.end_with?("\n")
+
+    lines = original.split("\n", -1)
+    lines.pop if trailing_newline
+
+    while lines.length < line
+      lines << ""
+    end
+
+    if add
+      lines[line - 1] ||= ""
+      lines[line - 1] += content
+    else
+      lines[line - 1] = content
+    end
+
+    result = lines.join("\n")
+    result += "\n" if trailing_newline
+
+    File.write(path, result)
+  end
+
   def self.newline(path)
     raise Error, "File does not exist: #{path}" unless File.file?(path)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apender
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nicolau
@@ -9,6 +9,8 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
+description: Apender is a lightweight Ruby CLI tool that appends content to files,
+  replaces specific lines, and adds text to existing lines.
 email:
 - nic13araujo@proton.me
 executables:
@@ -25,11 +27,13 @@ files:
 - lib/apender.rb
 - lib/apender/version.rb
 - sig/apender.rbs
-homepage: https://github.com
+homepage: https://github.com/Nic24nix/apender
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com
+  homepage_uri: https://github.com/Nic24nix/apender
+  source_code_uri: https://github.com/Nic24nix/apender/tree/master
+  changelog_uri: https://github.com/Nic24nix/apender/blob/master/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -46,5 +50,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: Add content on the next line of a file
+summary: A simple CLI tool to append and edit file lines
 test_files: []