koine-file_system 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b02b461d46bf0edbd0c7027d3c7ef04be78c32f99ea563de5457a61f14332088
+  data.tar.gz: 1c27d7c265bb498143550ee7d5e24d78fda1bbdd91af546de4014f04aa6ef673
+SHA512:
+  metadata.gz: 122c2d01ba655d302eb49dfbe02e59c985f882482a8be9fcd0e2c0cf01aca1f7cd286b9d09b8fed592aab36b6176ccb10cabb7db3a5ac80a40c3133b93f06362
+  data.tar.gz: '0158203d6180178e1becdc7d2efadf6a670a080dfee0eab04002f01ca8f8d07b2256db13ac946c8d0d592cef109b050f04f208dd1834113f64c9cde14a3407ea'

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/Gemfile.lock
+/spec/fixtures/sandbox

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,66 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/MethodLength:
+  Exclude:
+   - 'db/migrate/**.rb'
+
+Layout/LineLength:
+  Max: 100
+  Exclude:
+   - 'db/seeds.rb'
+
+Style/Documentation:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Naming/RescuedExceptionsVariableName:
+  PreferredName: 'exception'
+
+Style/FormatStringToken:
+  EnforcedStyle: template
+
+RSpec:
+  Exclude:
+    - 'spec/factories/**/*'
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+AllCops:
+  Exclude:
+    - 'node_modules/**/*'
+    - 'script/**/*'
+    - 'log/**/*'
+    - 'docker/**/*'
+    - 'doc/**/*'
+    - 'bin/**/*'
+    - 'Rakefile'
+    - 'config.ru'
+    - 'config/**/*'
+    - 'db/schema.rb'
+    - 'node_modules/**/*'
+    - 'vendor/**/*'

data/.travis.yml

@@ -0,0 +1,11 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4
+
+script:
+  - RAILS_ENV=test bundle exec rspec
+  - bundle exec rubocop --version
+  - bundle exec rubocop -a

data/CHANGELOG

@@ -0,0 +1,2 @@
+Change log
+-----------------

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 marcelo.jacobus@gmail.com. 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,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in koine-file_system.gemspec
+gemspec
+
+gem 'coveralls', '~> 0.8.23'
+gem 'rake', '~> 12.0'
+gem 'reek'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '0.79.0'
+gem 'rubocop-performance'
+gem 'rubocop-rspec'
+gem 'simplecov', '~> 0.16.1'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Marcelo Jacobus
+
+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,46 @@
+# Koine::FileSystem
+
+This will [hopefully] be a file system abstraction as good as the [PHP League's Flysystem](https://github.com/thephpleague/flysystem).
+
+[![Build Status](https://travis-ci.org/mjacobus/koine-file_system.svg?branch=master)](https://travis-ci.org/mjacobus/koine-file_system)
+[![Coverage Status](https://coveralls.io/repos/github/mjacobus/koine-file_system/badge.svg?branch=master)](https://coveralls.io/github/mjacobus/koine-file_system?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/ae41e3facbadaabaa463/maintainability)](https://codeclimate.com/github/mjacobus/koine-file_system/maintainability)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'koine-file_system'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install koine-file_system
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 tags, 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/mjacobus/koine-file_system. 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/mjacobus/koine-file_system/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
+
+Everyone interacting in the Koine::FileSystem project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mjacobus/koine-file_system/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "koine/file_system"
+
+# 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/koine-file_system.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'lib/koine/file_system/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'koine-file_system'
+  spec.version       = Koine::FileSystem::VERSION
+  spec.authors       = ['Marcelo Jacobus']
+  spec.email         = ['marcelo.jacobus@gmail.com']
+
+  spec.summary       = 'File System abstraction'
+  spec.description   = 'File System abstraction'
+  spec.homepage      = 'https://github.com/mjacobus/koine-file_system'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/mjacobus/koine-file_system'
+  spec.metadata['changelog_uri'] = 'https://github.com/mjacobus/koine-file_system/blob/CHANGELOG'
+
+  # 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(__dir__)) 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/koine/file_system.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'koine/file_system/version'
+require 'koine/file_system/file_system'
+require 'koine/file_system/path_sanitizer'
+require 'koine/file_system/adapters/base'
+require 'koine/file_system/adapters/local'
+
+module Koine
+  module FileSystem
+    class Error < StandardError; end
+    class FileNotFound < Error; end
+  end
+end

data/lib/koine/file_system/adapters/base.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+module Koine
+  module FileSystem
+    module Adapters
+      # rubocop:disable Lint/UnusedMethodArgument
+      class Base
+        # @param path [String]  path
+        #
+        # @return string
+        #
+        # @raise [FileNotFound] when file does not exist or cannot be read
+        def read(path)
+          raise NotImplementedError
+        end
+
+        # @param path [String]  path
+        #
+        # @return Boolean
+        #
+        # @raise [FileNotFound] when file does not exist or cannot be read
+        def read_stream(path)
+          raise NotImplementedError
+        end
+
+        # @param path [String]  path
+        # @param contents [String] the content
+        # @param options [<Hash>] the options
+        #
+        # @return [void]
+        def write(path, contents, options: {})
+          raise NotImplementedError
+        end
+
+        # @param path [String]  path
+        # @param contents [String] the content
+        # @param options [<Hash>] the options
+        #
+        # @return [void]
+        def write_stream(path, contents, options: {})
+          raise NotImplementedError
+        end
+
+        # @param path [String]  path
+        # @param contents [String] the new content
+        # @param options [<Hash>] the options
+        #
+        # @return [void]
+        #
+        # @raise [FileNotFound] when file does not exist or cannot be read
+        def update(path, contents, options: {})
+          raise NotImplementedError
+        end
+
+        # @param path [String]  path
+        # @param contents [String] the new content
+        # @param options [<Hash>] the options
+        #
+        # @return [void]
+        #
+        # @raise [FileNotFound] when file does not exist or cannot be read
+        def update_stream(path, contents, options: {})
+          raise NotImplementedError
+        end
+
+        # @param path [String]  path
+        #
+        # @return Boolean
+        def has?(path)
+          raise NotImplementedError
+        end
+
+        # @param path [String]  path
+        #
+        # @return [void]
+        #
+        # @raise [FileNotFound] when file does not exist or cannot be read
+        def delete(path)
+          raise NotImplementedError
+        end
+
+        # @param path [String]  path
+        #
+        # @return [String]
+        #
+        # @raise [FileNotFound] when file does not exist or cannot be read
+        def read_and_delete(path)
+          raise NotImplementedError
+        end
+
+        # @param from [String]  path
+        # @param to [String]  path
+        #
+        # @return [void]
+        #
+        # @raise [FileNotFound] when source file does not exist or cannot be read
+        def rename(from, to)
+          raise NotImplementedError
+        end
+
+        # @param from [String]  path
+        # @param to [String]  path
+        #
+        # @return [void]
+        #
+        # @raise [FileNotFound] when source file does not exist or cannot be read
+        def copy(from, to)
+          raise NotImplementedError
+        end
+
+        # @param path [String]  path
+        #
+        # @return [String]
+        #
+        # @raise [FileNotFound] when source file does not exist or cannot be read
+        def mime_type(path)
+          raise NotImplementedError
+        end
+
+        # @param path [String]  path
+        #
+        # @return [Integer] Number of bytes
+        #
+        # @raise [FileNotFound] when file does not exist or cannot be read
+        def size(path)
+          raise NotImplementedError
+        end
+
+        # @param path [String]  path
+        #
+        # @return [void]
+        def create_dir(path)
+          raise NotImplementedError
+        end
+
+        # @param path [String]  path
+        #
+        # @return [void]
+        def delete_dir(path)
+          raise NotImplementedError
+        end
+
+        # @param path [String]  path
+        # @param recursive [Bool]  path
+        #
+        # @return [void]
+        def list(path, recursive: false)
+          raise NotImplementedError
+        end
+
+        private
+
+        def raise_not_found(file)
+          raise FileNotFound, "File not found: #{file}"
+        end
+      end
+      # rubocop:enable Lint/UnusedMethodArgument
+    end
+  end
+end

data/lib/koine/file_system/adapters/local.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module Koine
+  module FileSystem
+    module Adapters
+      # rubocop:disable Lint/UnusedMethodArgument
+      class Local < Base
+        def initialize(root:, path_sanitizer: PathSanitizer.new)
+          @root = root
+          @path_sanitizer = path_sanitizer
+        end
+
+        def read(path)
+          if has?(path)
+            file = File.open(full_path(path), 'rb')
+            content = file.read
+            file.close
+            return content
+          end
+          raise_not_found(path)
+        end
+
+        def has?(path)
+          File.exist?(full_path(path))
+        end
+
+        def write(path, content, options: {})
+          path = full_path(path)
+          ensure_target_dir(path)
+          File.open(path, 'w') do |f|
+            f.write(content)
+          end
+        end
+
+        def list(dir = '', recursive: false)
+          Dir[create_list_pattern(dir, recursive)].map do |file|
+            metadata_for(file)
+          end
+        end
+
+        def size(path)
+          File.size(full_path(path))
+        end
+
+        private
+
+        # rubocop:disable Metrics/MethodLength
+        def metadata_for(file)
+          relative_path = file.sub("#{@root}/", '')
+          type = File.directory?(file) ? 'dir' : 'file'
+          filename = File.basename(file)
+
+          {
+            path: relative_path,
+            type: type,
+            extension: type == 'dir' ? nil : filename.split('.').last,
+            filename: filename,
+            dirname: File.dirname(relative_path),
+            timestamp: File.mtime(file),
+            size: size(relative_path)
+          }
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        def full_path(path)
+          File.expand_path(sanitize_path(path), @root)
+        end
+
+        def ensure_target_dir(path)
+          dir = File.dirname(path)
+          unless Dir.exist?(dir)
+            FileUtils.mkdir_p(dir)
+          end
+        end
+
+        def sanitize_path(path)
+          @path_sanitizer.sanitize(path)
+        end
+
+        def create_list_pattern(dir, recursive)
+          dir = sanitize_path(dir)
+          parts = [@root]
+
+          unless dir.empty?
+            parts << dir
+          end
+
+          if recursive
+            parts << '**'
+          end
+
+          parts << '*'
+          parts.join('/')
+        end
+      end
+      # rubocop:enable Lint/UnusedMethodArgument
+    end
+  end
+end

data/lib/koine/file_system/file_system.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Koine
+  module FileSystem
+    # Inspired on
+    # https://flysystem.thephpleague.com/v1/docs/usage/filesystem-api/
+    class FileSystem
+      def initialize(adapter)
+        @adapter = adapter
+      end
+
+      def read(path, &block)
+        @adapter.read(path, &block)
+      end
+
+      def read_stream(path, &block)
+        @adapter.read_stream(path, &block)
+      end
+
+      def write(path, contents, options: {})
+        @adapter.write(path, contents, options: options)
+      end
+
+      def write_stream(path, contents, options: {})
+        @adapter.write_stream(path, contents, options: options)
+      end
+
+      def update(path, contents, options: {})
+        @adapter.update(path, contents, options: options)
+      end
+
+      def update_stream(path, contents, options: {})
+        @adapter.update_stream(path, contents, options: options)
+      end
+
+      def has?(path)
+        @adapter.has?(path)
+      end
+
+      def delete(path)
+        @adapter.delete(path)
+      end
+
+      def read_and_delete(path)
+        @adapter.read_and_delete(path)
+      end
+
+      def rename(from, to)
+        @adapter.rename(from, to)
+      end
+
+      def copy(from, to)
+        @adapter.copy(from, to)
+      end
+
+      def mime_type(path)
+        @adapter.mime_type(path)
+      end
+
+      def size(path)
+        @adapter.size(path)
+      end
+
+      def create_dir(path)
+        @adapter.create_dir(path)
+      end
+
+      def delete_dir(path)
+        @adapter.delete_dir(path)
+      end
+
+      def list(path, recursive: false)
+        @adapter.list(path, recursive: recursive)
+      end
+    end
+  end
+end

data/lib/koine/file_system/path_sanitizer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module Koine
+  module FileSystem
+    class PathSanitizer
+      def sanitize(path)
+        path.to_s.gsub('/../', '/').gsub(%r{\.?\./}, '')
+      end
+    end
+  end
+end

data/lib/koine/file_system/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Koine
+  module FileSystem
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: koine-file_system
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcelo Jacobus
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-10 00:00:00.000000000 Z
+dependencies: []
+description: File System abstraction
+email:
+- marcelo.jacobus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- koine-file_system.gemspec
+- lib/koine/file_system.rb
+- lib/koine/file_system/adapters/base.rb
+- lib/koine/file_system/adapters/local.rb
+- lib/koine/file_system/file_system.rb
+- lib/koine/file_system/path_sanitizer.rb
+- lib/koine/file_system/version.rb
+homepage: https://github.com/mjacobus/koine-file_system
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/mjacobus/koine-file_system
+  source_code_uri: https://github.com/mjacobus/koine-file_system
+  changelog_uri: https://github.com/mjacobus/koine-file_system/blob/CHANGELOG
+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.0.3
+signing_key: 
+specification_version: 4
+summary: File System abstraction
+test_files: []