https://github.com/sleeplessbyte/shrine-configurable_storage

:package: Register Shrine storages using a key and lazy configure that storage later.
https://github.com/sleeplessbyte/shrine-configurable_storage

shrine storage-adapter

Last synced: about 2 months ago
JSON representation

:package: Register Shrine storages using a key and lazy configure that storage later.

• Host: GitHub
• URL: https://github.com/sleeplessbyte/shrine-configurable_storage
• Owner: SleeplessByte
• License: mit
• Created: 2018-06-09T17:27:33.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-05-06T08:15:29.000Z (8 months ago)
• Last Synced: 2024-10-18T19:46:37.552Z (3 months ago)
• Topics: shrine, storage-adapter
• Language: Ruby
• Homepage: https://rubygems.org/gems/shrine-configurable_storage
• Size: 20.5 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Shrine::Plugins::ConfigurableStorage

[![Build Status](https://travis-ci.com/SleeplessByte/shrine-configurable_storage.svg?branch=master)](https://travis-ci.com/SleeplessByte/shrine-configurable_storage)

[![Gem Version](https://badge.fury.io/rb/shrine-configurable_storage.svg)](https://badge.fury.io/rb/shrine-configurable_storage)

[![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)

[![Maintainability](https://api.codeclimate.com/v1/badges/583cd9c332f3b5346dec/maintainability)](https://codeclimate.com/github/SleeplessByte/shrine-configurable_storage/maintainability)

Register Shrine storages using a key and lazy configure that storage later.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'shrine-configurable_storage'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install shrine-configurable_storage

## Usage

Setup your configurable, lazy, dynamic storage by adding the plugin and calling configure.

```Ruby

require 'shrine/plugins/configurable_storage'

class MyUploader < Shrine

  plugin :configurable_storage

  configurable_storage_name :foo

end

# Somewhere else

Shrine::Plugins::ConfigurableStorage.configure do |config|

  config[:foo] = {

    cache: Shrine::Storage::FileSystem.new(...),

    store: Shrine::Storage::S3.new(...)

  }

end

```

You can use the `:default` key (`config[:default] =`) to add fallback storage(s). You can add as many storages as you

want, and just like before, you're not limited to cache and store. When finding a storage, the name will be used to find

the set of storages and fallback to `:default`.

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 `shrine-configurable_storage.gemspec.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/SleeplessByte/shrine-configurable_storage.

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to

the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## 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 Shrine::ConfigurableStorage project’s codebases, issue trackers, chat rooms and mailing

lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/shrine-configurable_storage/blob/master/CODE_OF_CONDUCT.md).