Git Product home page Git Product logo

Koine::Filesystem

This will [hopefully] be a file system abstraction as good as the PHP League's Flysystem.

Build Status Coverage Status Maintainability

Installation

Add this line to your application's Gemfile:

gem 'koine-filesystem'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install koine-filesystem

Usage

adapter = Koine::Filesystem::Adapters::Local.new(
  root: '/users/my_user/sandbox'
)

fs = Koine::Filesystem::Filesystem.new(adapter)

files = fs.list('files', recursive: true)

# it returns a collectin of hash. But I am thingking of either returning a PORO file object
# or returning an object that carries the file system along with it so it can do stuff like

files.each do |file|
  file.directory?
  file.path
  file.name
  file.extension
  file.read
  file.read_stream
  file.upload_to(other_fs, path: 'foo/bar/baz.txt')
end

[Partially] Supported adapters

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.

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.

License

The gem is available as open source under the terms of the MIT License.

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.

Marcelo Jacobus's Projects

adv360-pro-zmk icon adv360-pro-zmk

Production repository for the all-new Advantage360 Professional using ZMK engine

apresentacao-zend-doctrine-240410 icon apresentacao-zend-doctrine-240410

Apresentação sobre "Desenvolvendo aplicações web com Zend Framework e Doctrine php" - FLISOL 2010 - Festival Latino-Americano de Instalação de Software Livre

cep icon cep

API that gets address by cep

cnes icon cnes

Cliente HTTP para Cadastro Nacional de Estabelecimentos de Saúde

css icon css

The CSS design system that powers GitHub

debug icon debug

A place to add dummy code simulating real problems and ask for help

design-patterns-ruby icon design-patterns-ruby

sample code for several design patterns in ruby. Inspired (copied) in domnikl/DesignPatternsPHP

devcast icon devcast

Example application to use with lotus rb.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.