file_structure 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b0896ec610bd688790fad3b0f995766076ffee13148ff16ee3f9e9ae7a646b34
+  data.tar.gz: e3a445ce085c12d7a7971dbed9469b48247d0a130fdb91acb2b28696f84d9a62
+SHA512:
+  metadata.gz: 48cd8e05e96096a21265e5c3e69f7bc5bb2bf11e5094984006f938dc79fd186fcbe8ac9f97d31d11a431db756f940780741924abdac37fccdc555e51bba75f6a
+  data.tar.gz: c12c1441fd3dc451fdbe179bec7c4b0a90f8f473990de86273b9200db757aa75f173a12b35b7c071e5ccb1642b55c58aff5554666549cdafc95ba147dde4e2ee

data/.rubocop.yml

@@ -0,0 +1,45 @@
+# See list of defaults here: https://docs.rubocop.org/rubocop/index.html
+
+require:
+  - rubocop-performance
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+# ------------------------------------------------------------------------------
+# DEPARTMENT LAYOUT
+# ------------------------------------------------------------------------------
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent # default: special_inside_parentheses
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent # default: special_inside_parentheses
+
+Layout/LineLength:
+  Max: 80 # default: 120
+
+# ------------------------------------------------------------------------------
+# DEPARTMENT METRICS
+# ------------------------------------------------------------------------------
+
+Metrics/AbcSize:
+  Max: 20 # default: 17
+
+Metrics/BlockLength:
+  Exclude:
+    - file_structure.gemspec
+    - test/**/test_*.rb
+
+Metrics/MethodLength:
+  Max: 15 # default: 10
+
+# ------------------------------------------------------------------------------
+# DEPARTMENT STYLE
+# ------------------------------------------------------------------------------
+
+Style/Documentation:
+  Enabled: false # default: true

data/Gemfile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in file_structure.gemspec
+gemspec
+
+group :development do
+  gem 'rake', '~> 13.0'
+  gem 'rubocop', '~> 1.21', require: false
+  gem 'rubocop-minitest', '~> 0.17.2', require: false
+  gem 'rubocop-performance', '~> 1.13', require: false
+  gem 'rubocop-rake', '~> 0.6.0', require: false
+  gem 'yard', '~> 0.9.27', require: false
+end
+
+group :test do
+  gem 'minitest', '~> 5.0'
+  gem 'minitest-reporters', '~> 1.5'
+end
+
+group :development, :test do
+  gem 'debug', '~> 1.4'
+end

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    file_structure (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    debug (1.4.0)
+      irb (>= 1.3.6)
+      reline (>= 0.2.7)
+    io-console (0.5.11)
+    irb (1.4.1)
+      reline (>= 0.3.0)
+    minitest (5.15.0)
+    minitest-reporters (1.5.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    parallel (1.21.0)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
+    reline (0.3.1)
+      io-console (~> 0.5)
+    rexml (3.2.5)
+    rubocop (1.25.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    rubocop-minitest (0.17.2)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-performance (1.13.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  debug (~> 1.4)
+  file_structure!
+  minitest (~> 5.0)
+  minitest-reporters (~> 1.5)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  rubocop-minitest (~> 0.17.2)
+  rubocop-performance (~> 1.13)
+  rubocop-rake (~> 0.6.0)
+  yard (~> 0.9.27)
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Rémi Durieu
+
+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,54 @@
+# file_structure
+
+[![Test](https://github.com/durierem/file_structure/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/durierem/file_structure/actions/workflows/test.yml)
+[![Lint](https://github.com/durierem/file_structure/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/durierem/file_structure/actions/workflows/lint.yml)
+
+Define a file structure with a `Hash` with support for files, file content,
+directories and symlinks across the structure. Mount and unmount the structure
+in a directory on the file system.
+
+Useful for creating test environment for programs that manipulate
+files but can be used as is for something else entirely.
+
+## Usage
+
+```ruby
+# Example creating the following file hierarchy:
+# /tmp/mydir
+# ├── dir1
+# │  ├── dir2
+# │  │  └── file2
+# │  ├── file3
+# │  └── link_to_file2 -> /tmp/mydir/dir1/dir2/file2
+# └── file1
+
+fs = FileStructure.new([
+  { type: :file, name: 'file1' },
+  {
+    type: :directory,
+    name: 'dir1',
+    children: [
+      {
+        type: :directory,
+        name: 'dir2',
+        children: [
+          { type: :file, name: 'file2', ref: 'ref_file2', content: 'abc' }
+        ]
+      },
+      { type: :file, name: 'file3' },
+      { type: :symlink, name: 'link_to_file2', to: 'ref_file2' }
+    ]
+  }
+])
+
+fs.mount('/tmp/mydir') # also creates the /tmp/mydir directory if it doesn't exist
+fs.mounted? # => true
+fs.mountpoint # => "/tmp/mydir"
+fs.unmount # deletes all files in /tmp/mydir
+
+JSON.dump(fs.structure) # (bonus) easily serializable :D
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+RuboCop::RakeTask.new
+
+desc 'Generate documentation with Yard'
+task :doc do
+  sh 'yard doc --no-private'
+end
+
+task default: %i[test rubocop doc]

data/file_structure.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/file_structure/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'file_structure'
+  spec.version = FileStructure::VERSION
+  spec.authors = ['Rémi Durieu']
+  spec.email = ['mail@remidurieu.dev']
+
+  spec.summary = <<-TEXT
+    Manage file structures (ie: files and directories) on the file system.
+  TEXT
+  spec.description = <<-TEXT
+    Describe a file structure with a Ruby Hash. Supports files, file content,
+    directories and symlinks across the structure.
+
+    Mount and unmount the desired structured in a directory on the file system.
+
+    Useful for creating test environment for programs that manipulate
+    files but can be used as is for something else entirely.
+  TEXT
+  spec.homepage = 'https://github.com/durierem/file_structure'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  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|features)/|\.(?:git))})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/file_structure/contract.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class FileStructure
+  module Contract
+    module_function
+
+    class AssertionError < ArgumentError; end
+
+    # @param expression [Boolean] The expression to evaluate
+    # @param message [String] The message to attach to the raised error
+    #
+    # @raise [AssertionError] if the expression evaluates to false
+    #
+    # @api private
+    def assert(expression, message = '')
+      raise AssertionError, message unless expression
+    end
+  end
+end

data/lib/file_structure/validator.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+class FileStructure
+  # @private
+  class Validator
+    def initialize(structure)
+      @structure = structure
+    end
+
+    def valid?
+      valid_structure?(@structure)
+    end
+
+    private
+
+    def valid_structure?(structure)
+      return false unless structure.is_a?(Array)
+
+      structure.all? do |elem|
+        return false unless elem.is_a?(Hash)
+
+        case elem[:type]
+        when :file
+          valid_file?(elem)
+        when :symlink
+          valid_symlink?(elem)
+        when :directory
+          valid_directory?(elem)
+        else
+          false
+        end
+      end
+    end
+
+    def valid_file?(element)
+      attributes = %i[type name ref content]
+      element.key?(:name) && element.each_key.all? do |key|
+        attributes.include?(key)
+      end
+    end
+
+    def valid_symlink?(element)
+      attributes = %i[type name to]
+      element.key?(:name) && element.key?(:to) && element.each_key.all? do |key|
+        attributes.include?(key)
+      end
+    end
+
+    def valid_directory?(element)
+      attributes = %i[type name ref children]
+      element.key?(:name) &&
+        element.key?(:children) &&
+        element.each_key { |key| attributes.include?(key) } &&
+        valid_structure?(element[:children])
+    end
+  end
+end

data/lib/file_structure/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class FileStructure
+  VERSION = '0.1.0'
+end

data/lib/file_structure.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require_relative 'file_structure/contract'
+require_relative 'file_structure/validator'
+require_relative 'file_structure/version'
+
+# Manage files, directories and links described with a file structure
+# definition as a Ruby Hash. A valid file structure definition is an Array
+# of Hashes with the following possible file definitions:
+#
+# rubocop:disable Layout/LineLength
+# @example
+#   { name: 'myfile', type: :file, content: 'abc', ref: 'fileref'} # :content and :ref are optional
+#   { name: 'mydir' type: :directory, children: [<another valid file structure definition>], ref: 'dirref' } # :ref is optional
+#   { name: 'mylink', type: :link, to: 'fileref' } # link to 'myfile' refereced earlier by 'fileref'
+# rubocop:enable Layout/LineLength
+class FileStructure
+  attr_reader :structure, :mountpoint
+
+  # @param structure [Array<Hash>] a valid file structure definition.
+  # @raise [AssertionError] if the file structure is invalid
+  def initialize(structure)
+    Contract.assert(valid_file_structure?(structure), 'invalid file structure')
+
+    @structure = structure
+    @mountpoint = nil
+  end
+
+  # Effectively creates files and directories in the specified directory.
+  #
+  # @param dirname [String] the target directory
+  # @raise [AssertionError] if the FileStructure is already mounted
+  # @return void
+  # @see unmount
+  def mount(dirname)
+    Contract.assert(!mounted?, 'file structure is already mounted')
+
+    mountpoint = File.absolute_path(dirname)
+    FileUtils.mkdir_p(mountpoint) unless Dir.exist?(mountpoint)
+    begin
+      create_file_structure(mountpoint, @structure)
+    rescue StandardErrror => e
+      FileUtils.rm_r(Dir.glob("#{mountpoint}/*")) # clear residuals
+      raise e
+    end
+    @mountpoint = mountpoint
+  end
+
+  # Remove all files from the mountpoint.
+  #
+  # @return void
+  # @see mount
+  def unmount
+    Contract.assert(mounted?, 'file structure is not mounted')
+
+    FileUtils.rm_r(Dir.glob("#{@mountpoint}/*"))
+    @mountpoint = nil
+  end
+
+  def mounted?
+    !!@mountpoint
+  end
+
+  # Get the full path for a file in the mounted file structure.
+  #
+  # @example
+  #   path_for(:foo, :bar, :file)
+  #   # => "/path/to/mountpoint/foo/bar/file"
+  #
+  # @param args [Symbol, String Array<Symbol, String>] the recursive names to
+  #   the desired file or directory
+  # @return [String] the full path to the specified file/directory
+  # @raise [AssertionError] if the file structure is not mounted
+  def path_for(*args)
+    Contract.assert(mounted?, 'file structure is not mounted')
+
+    finder = [*args].flatten.map(&:to_sym)
+    build_path(finder, @structure)
+  end
+
+  private
+
+  def valid_file_structure?(structure)
+    FileStructure::Validator.new(structure).valid?
+  end
+
+  # @param finder [Array] such as :foo, :bar
+  # @param structure [Array] file structure definition
+  # @param path [String] starting path (recursive accumulator)
+  def build_path(finder, structure, path = @mountpoint)
+    return path if finder.empty? || structure.nil?
+
+    base = structure.find { |item| item[:name].to_s == finder.first.to_s }
+    return nil if base.nil?
+
+    build_path(
+      finder[1..],
+      base[:children],
+      File.join(path, base[:name])
+    )
+  end
+
+  # @param dirname [String] root directory
+  # @param structure [Array] file structure definition
+  # @param symlinks [Hash] current symlinks refs (recursive accumulator)
+  def create_file_structure(dirname, structure, symlinks = {})
+    structure.each do |element|
+      path = File.join(File.absolute_path(dirname), element[:name])
+      case element[:type]
+      when :file
+        File.write(path, element[:content])
+        symlinks.merge!(element[:ref] => path) if element[:ref]
+      when :symlink
+        FileUtils.symlink(symlinks[element[:to]], path)
+      when :directory
+        FileUtils.mkdir(path)
+        create_file_structure(path, element[:children], symlinks)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: file_structure
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rémi Durieu
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-02-26 00:00:00.000000000 Z
+dependencies: []
+description: |2
+      Describe a file structure with a Ruby Hash. Supports files, file content,
+      directories and symlinks across the structure.
+
+      Mount and unmount the desired structured in a directory on the file system.
+
+      Useful for creating test environment for programs that manipulate
+      files but can be used as is for something else entirely.
+email:
+- mail@remidurieu.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- file_structure.gemspec
+- lib/file_structure.rb
+- lib/file_structure/contract.rb
+- lib/file_structure/validator.rb
+- lib/file_structure/version.rb
+homepage: https://github.com/durierem/file_structure
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/durierem/file_structure
+  source_code_uri: https://github.com/durierem/file_structure
+  rubygems_mfa_required: 'true'
+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.3.7
+signing_key:
+specification_version: 4
+summary: 'Manage file structures (ie: files and directories) on the file system.'
+test_files: []