lowks / radpath

Path library for Elixir inspired by Python's pathlib

Radpath

A library for dealing with paths in Elixir largely inspired by Python's pathlib.

Getting Started

To use Radpath, add a dependency in your mix:

def deps do
  [ { :Radpath, github: "lowks/Radpath"}]
end

then mix deps.get fetches dependencies and compiles Radpath.

Status

Developed whenever I can find the time.

Running Tests

Running tests against a stable release of Elixir defined by 'STABLE_ELIXIR_VERSION' in the Makefile:

make ci

Running tests against your system's Elixir:

make

Docs (Lite Version)

To list down files in a path:

Radpath.files("/home/lowks/Documents")

or if you wanted to filter out certain files with pdf extensions:

Radpath.files("/home/lowks/Documents", "pdf")

Listing down only directories:

Radpath.dirs("/home/lowks")                  

To create symlink:

Radpath.symlink(source, destination)

To create tempfile:

{status, fd, file_path}  = Radpath.mktempfile
IO.write fd, "hoho"
File.close fd
File.read! filepath
"hoho"
File.rm! filepath

This uses all the defaults

To customize the location plus the extension:

{_, fd, filepath} = Radpath.mktempfile(".log", "/home/lowks/Downloads")
IO.write fd, "hoho"
File.read! filepath
"hoho"
File.close! filepath

The default is ".log". Checkout the rest of the docs in the docs folder.

Run mix docs to generate a nice docs in a local folder or you can read them online: Radpath hexdocs

Check out test examples for usage.

radpath's Issues

Radpath.rename

Radpath.rename('source_file.txt', 'dest_file.txt')

enhance zip so that accepts a bitstring as well

enhance zip so that accepts a bitstring as well

Inconsistent way of how files deals with empty results

Radpath.dirs() returns [] and Radpath.files() returns an error when there are no results.

Add a sha1sum function

Add a sha1sum after the underlying library is ready (erlware_commons).

Add a islink? function

Add a islink? function to check for symlinks

Create sections for mix.exs

Create different sections in mix.exs so that different environment can be used allowing to specify different dependencies for different environments.

A "send" function

I am wondering would something like this would be useful ?

Radpath.files(["pdf","doc"]) |> Radpath.send(destination)

Essentially it's a mv operation.

create an ensure function ala py.path

create an ensure function ala py.path where it ensures the creation of :

1. Folders and
2. Files

Update wrecker.yml

Update wrecker.yml based on this: https://github.com/bitwalker/elixir-protobuf/blob/master/wercker.yml

Add travis build

Add travis build

Do a release for version 0.0.4.1

Do a release for version 0.0.4.1

Add test for mktempfile

Add test for mktempfile

Add the ability to create zip files.

Add the ability to create zip archives somewhere along lines like this:

Radpath.files("/tmp", "log") |> Radpath.zip("myzip.zip")

or

Radpath.dirs("/tmp") |> Radpath.zip("myzip2.zip")

Enable back full zip test.

Enable back full zip test.

try out expose to test private functions

https://github.com/pragdave/private

Create a Makefile

Create a makefile ala amrita to lessen the pain that an old version Erlang from travis and drone gives.

There are some functions inside of Radpath that missing doc strings. Add them.

There are some functions inside of Radpath that missing doc strings. Add them.

files second argument does not support char lists.

Radpath files function does not support char lists in Lists

Radpath.files("path" , ['zip'])

Enable regex in dirs function

Enable regex in dirs function

Add credo

Add credo: https://github.com/rrrene/credo

Release newly baked Radpath!

Release newly baked Radpath!

discontinue support for older version of Elixir

discontinue support for older version of Elixir

relative_path function

Put in a relative_path function which does this:

iex(1)> Radpath.relative_path("/tmp/lowks/", "/tmp/lowks/iam.txt")
"iam.txt"
iex(2)> Radpath.relative_path("/tmp/lowks/", "/tmp/lowks/hoho/iam.txt")
"hoho/iam.txt"

files should support list input as well

Radpath.dirs supports list as input but Radpath.files does not. This should be standardized.

Let zip handle a list

Something like this:

Radpath.files("/home/lowks/Documents", "doc") |> Radpath.zip("mystuff.zip")

Enable docstring tests

Enable docstring tests

zip function creates a zip even when the directories to be zipped don't exist

zip function creates a zip even when the directories to be zipped don't exist. This create a non usable zip file.

Simplify travis.yml

Simplify travis.yml

Must test with latest version of elixir

Must test with latest version of elixir

Let mktempfile return a filename.

Let mktempfile return a filename, at least then there is a handle of what to do with it.

Add the ability for tempfile to get deleted automatically

Using temp there is already that function, however it just seems a tad clunky to fit in what we are doing. Find out a way of doing it.

Upgrade to 0.1.3.1 (Deprecations)

[String] String.to_char_list/1 is deprecated in favor of List.from_char_data/1 (this is a soft deprecation, no warnings will be emitted)

Correct the format of docs in @docs

Correct the format of docs in @docs so that is shows up correctly in iex.

Remove unwanted dependencies from production

Remove unwanted dependencies from production ENV

Move all the '|>' characters to the front

Move all the |> characters to the front following standards. Much better for reading too.

Use Amrita for tests

Seems like there is a new test framework that has some features that ExUnit don't like the ability to run one test at a time which I like,

https://github.com/josephwilk/amrita

Look into moving test to use this.

Build on travis breaking

The build on Travis is breaking with the log below:

Using worker: worker-linux-2-1.bb.travis-ci.org:travis-linux-16

git.1

$ git clone --depth=50 --branch=master git://github.com/lowks/Radpath.git lowks/Radpath

Cloning into 'lowks/Radpath'...

remote: Counting objects: 247, done.

remote: Compressing objects: 100% (109/109), done.

remote: Total 247 (delta 124), reused 241 (delta 118)

Receiving objects: 100% (247/247), 67.04 KiB | 0 bytes/s, done.

Resolving deltas: 100% (124/124), done.

Checking connectivity... done.

$ cd lowks/Radpath
git.3

$ git checkout -qf 5c8e4cdbf14b0fa740fe298ef3612910ac04d98c

$ source $HOME/otp/R16B03-1/activate

Applying fix for NPM certificates
before_install.1

$ git clone git://github.com/elixir-lang/elixir

Cloning into 'elixir'...

remote: Reusing existing pack: 57806, done.

remote: Counting objects: 108, done.

remote: Compressing objects: 100% (107/107), done.

remote: Total 57914 (delta 38), reused 4 (delta 0)

Receiving objects: 100% (57914/57914), 21.80 MiB | 14.32 MiB/s, done.

Resolving deltas: 100% (29028/29028), done.

Checking connectivity... done.

$ cd elixir && make && cd ..

==> elixir (compile)

ERROR: OTP release R16B03-1 does not match required regex (17).*

ERROR: compile failed while processing /home/travis/build/lowks/Radpath/elixir/lib/elixir: rebar_abort

make: *** [erlang] Error 1

The command "make" failed and exited with 2 during before_install.

Your build has been stopped.

Going to try this fix: basho/riak#131

Remove snap-ci badge

Snap-CI service is no more so can remove.

Add ability to make tempfiles

Add ability to make tempfiles

Add .gitignore file too

Add .gitignore file to the repo.