txtar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c3d5a0ac3f1ef80e7b05d6ca40ee08ebdcd8d4ac14f005b5823418de8201851c
+  data.tar.gz: 275f3a075743905ce0ff4c7ba1fbf40c4e17d02b3e78d121a58938d004f92160
+SHA512:
+  metadata.gz: 9fc8e657e22ff2e1248cec5bb63c04aa237094c0cf85e014a6b9a9a21e601117c56c3afba62852014b90e7d368b61f98920756d0c8b35a0d7ed6bfc9cd919c1f
+  data.tar.gz: 7e22091f120b02102db270ef37c8cb886bb11cf84e61bc0dfdb96977ec0a4e0589377cbc9aea67d60a163ffe8ec2bafa41b28136c6e32ea859477ebc8ff9cb4d

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.2
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,18 @@
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at <hello@sul.im>. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    txtar (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    minitest (5.14.2)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.0.2)
+    rexml (3.2.4)
+    rubocop (1.7.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    rubocop-minitest (0.10.2)
+      rubocop (>= 0.87, < 2.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  minitest (~> 5.14)
+  rake (~> 13.0)
+  rubocop (~> 1.7)
+  rubocop-minitest (~> 0.10)
+  rubocop-rake (~> 0.5)
+  txtar!
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Alexander Sulim
+
+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,99 @@
+# Txtar
+
+A Ruby implementation of [`txtar`](https://github.com/golang/tools/tree/master/txtar) Go package.
+
+## Background
+
+I found `txtar` package while working on my Go projects and really liked the
+idea. Txtar archives helped me to package test fixtures in clean and human-friendly
+way.
+
+Recently tinkering on a Ruby project, I decided to use txtar files to packages
+samples of input/output data in tests. As there is no Ruby gem that implements
+the spec, I decided to make one :)
+
+## Txtar format spec
+
+The format spec copied from `txtar` Go package source code:
+
+> Txtar format
+>
+> A txtar archive is zero or more comment lines and then a sequence of file entries.
+> Each file entry begins with a file marker line of the form "-- FILENAME --"
+> and is followed by zero or more file content lines making up the file data.
+> The comment or file content ends at the next file marker line.
+> The file marker line must begin with the three-byte sequence "-- "
+> and end with the three-byte sequence " --", but the enclosed
+> file name can be surrounding by additional white space,
+> all of which is stripped.
+>
+> If the txtar file is missing a trailing newline on the final line,
+> parsers should consider a final newline to be present anyway.
+>
+> There are no possible syntax errors in a txtar archive.
+
+## Install
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'txtar'
+```
+
+And then execute:
+
+```ShellSession
+$ bundle install
+```
+
+Or install it yourself as:
+
+```ShellSession
+$ gem install txtar
+```
+
+## Usage
+
+Personally I use txtar files to package test fixtures. Below you see a simple
+example of the gem could be used.
+
+```ruby
+# main.rb
+require "txtar"
+
+text = <<~TXT.strip
+  It's a comment for the txtar archive. The comment might
+  contain multiple lines.
+  -- sample.txt --
+  Hello, world.
+  -- sample.rb --
+  puts "Hello, world."
+TXT
+
+txtar = Txtar::Archive.parse(data: text)
+pp txtar
+```
+```ShellSession
+$ ruby main.rb
+#<Txtar::Archive:0x00007f9d81ae50a8
+ @comment=
+  "It's a comment for the txtar archive. The comment might\n" +
+  "contain multiple lines.\n",
+ @files=
+  [#<Txtar::File:0x00007f9d81ae5210
+    @data="Hello, world.\n",
+    @name="sample.txt">,
+   #<Txtar::File:0x00007f9d81ae50f8
+    @data="puts \"Hello, world.\"\n",
+    @name="sample.rb">]>
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/soulim/txtar. 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/soulim/txtar/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). The original idea and the spec of txtar archives belongs to The Go Authors.
+
+Copyright (c) 2020 Alexander Sulim

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+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
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "txtar"
+
+# 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/lib/txtar.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "txtar/archive"
+require_relative "txtar/version"
+
+# Txtar implements a trivial text-based file archive format.
+#
+# The goals for the format are:
+#
+#   - be trivial enough to create and edit by hand.
+#   - be able to store trees of text files describing go command test cases.
+#   - diff nicely in git history and code reviews.
+#
+# Non-goals include being a completely general archive format,
+# storing binary data, storing file modes, storing special files like
+# symbolic links, and so on.
+#
+# It's a Ruby implementation of txtar Go package.
+#
+# See https://git.io/JLyDn
+module Txtar
+end

data/lib/txtar/archive.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative "file"
+
+module Txtar
+  # An Archive is a collection of files.
+  # It might have an optional comment, as well.
+  class Archive
+    # Each file entry begins with a file marker line of the form "-- FILENAME --"
+    # and is followed by zero or more file content lines making up the file data.
+    #
+    # The comment or file content ends at the next file marker line.
+    # The file marker line must begin with the three-byte sequence "-- "
+    # and end with the three-byte sequence " --", but the enclosed
+    # file name can be surrounding by additional white space,
+    # all of which is stripped.
+    #
+    # See https://git.io/JLyG7
+    FILE_MARKER = Regexp.new('^-{2}\s{1}(?<filename>.*)\s{1}-{2}$')
+    LINE_SEPARATOR = "\n"
+
+    attr_reader :comment,
+                :files
+
+    class << self
+      # Parses given String and returns a Txtar::Archive instance.
+      def parse(data:)
+        data = add_missing_newline(data.dup)
+        lines = data.lines(LINE_SEPARATOR)
+
+        new(comment: extract_comment(lines),
+            files: extract_files(lines))
+      end
+
+      private
+
+      # A comment is any content before the first file marker.
+      def extract_comment(lines)
+        lines.take_while { |line| !line.match?(FILE_MARKER) }
+             .join
+      end
+
+      # A comment (any content before the first file marker) is dropped and all
+      # other lines are treated as file blocks.
+      def extract_files(lines)
+        lines.drop_while { |line| !line.match?(FILE_MARKER) }
+             .slice_before(FILE_MARKER).map do |slice|
+               # The first element of the slice is a file marker. Therefore it's
+               # removed from the slice and parsed separately.
+               file_marker = slice.shift.match(FILE_MARKER)
+               File.new(name: file_marker[:filename],
+                        data: slice.join)
+             end
+      end
+
+      # According to the spec, if the txtar file is missing a trailing newline
+      # on the final line, parsers should consider a final newline to be present
+      # anyway.
+      def add_missing_newline(data)
+        return data if data.end_with?(LINE_SEPARATOR)
+
+        data << LINE_SEPARATOR
+      end
+    end
+
+    def initialize(comment: nil, files: [])
+      @comment = comment
+      @files = files
+    end
+  end
+end

data/lib/txtar/file.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Txtar
+  # A File is a single file in an archive.
+  class File
+    attr_reader :name,
+                :data
+
+    def initialize(name:, data: nil)
+      @name = name
+      @data = data
+    end
+  end
+end

data/lib/txtar/version.rb

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

data/txtar.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/txtar/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "txtar"
+  spec.version       = Txtar::VERSION
+  spec.authors       = ["Alexander Sulim"]
+  spec.email         = ["hello@sul.im"]
+
+  spec.summary       = "Ruby implementation of txtar Go package."
+  spec.description   = ""
+  spec.homepage      = "https://github.com/soulim/txtar"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/soulim/txtar"
+  # TODO: Add CHANGELOG.md
+  # spec.metadata["changelog_uri"] = ""
+
+  # 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 { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "minitest", "~> 5.14"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rubocop", "~> 1.7"
+  spec.add_development_dependency "rubocop-minitest", "~> 0.10"
+  spec.add_development_dependency "rubocop-rake", "~> 0.5"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: txtar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Sulim
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: ''
+email:
+- hello@sul.im
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/txtar.rb
+- lib/txtar/archive.rb
+- lib/txtar/file.rb
+- lib/txtar/version.rb
+- txtar.gemspec
+homepage: https://github.com/soulim/txtar
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/soulim/txtar
+  source_code_uri: https://github.com/soulim/txtar
+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.1.4
+signing_key: 
+specification_version: 4
+summary: Ruby implementation of txtar Go package.
+test_files: []