Skip to content

brewster1134/sourcerer

Repository files navigation

gem version dependencies docs build coverage code climate

SOURCERER

Consume local & remote sources with ease

From inside a ruby app, you can quickly grab entire directories of assets, either locally from a zip file or folder, or remotely from a git repo or zip file.


Install

gem install sourcerer_

Quick Usage

require 'sourcerer'

# download a remote github repo to your Documents folder
source = Sourcerer.new 'brewster1134/sourcerer', '~/Documents/sourcerer'

# use file globbing to return a custom array of files
source.files '**/*_helper.rb'
=> ["spec/spec_helper.rb"]

Supported Sources

  • git repo
    • local or remote
    • github shorthand (see example)
  • zip files
    • local or remote
  • local directories (although not very useful)
    • relative or absolute paths

Roadmap

  • Command line tool
  • Automate consuming multiple sources with a sourcerer.yaml file
  • Support for branches, tags & commits from a git repo

Development

Install Dependencies
# clone repo
git clone https://github.com/brewster1134/sourcerer.git
cd sourcerer

# install dependencies
bundle install

# run watcher for linting and tests
bundle exec guard

WTFPL