paperclip-eitheror 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 977bcd0b0e3c7535687ef21d01803b7c616659c6
+  data.tar.gz: fe78f2825400ace39fc663f90d90d4fce0b1388e
+SHA512:
+  metadata.gz: bbc423e8ba839df5f6cae5d71c84342b568bd19a67383c79e07ba9bfed32975ea41fe756710adb04480811f5f14debddf810c5568339f164926905d5a2ce18e1
+  data.tar.gz: 8765c21b4b21be2f15d6d7fbf2d3d13551ba873cf59ccf8433db2df9a27523085e557da80f168093c23a6c035f484d6a00bd5d3d44086956528c12c007635daa

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.13.6

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 matheus.abegg@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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in paperclip-eitheror.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Matheus Abegg
+
+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,199 @@
+# Paperclip::Eitheror
+[![Build Status](https://travis-ci.org/powerhome/paperclip-eitheror.svg?branch=master)](https://travis-ci.org/powerhome/paperclip-eitheror)
+
+A [Paperclip](https://github.com/thoughtbot/paperclip/) Storage which supports a secondary (called 'or') storage as a fallback while using the primary one (called 'either').
+
+The purpose of this gem is to help us while migrating our assets to a different place, a better place <3
+
+Dependency versions are locked to the current versions we have running.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'paperclip-eitheror'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install paperclip-eitheror
+
+## Usage
+
+Given you have the gem installed and some model, you need to configure your attachment with `storage: :eitheror`, and set up the primary (`either`) and the secondary/fallback (`or`) storages:
+
+```ruby
+has_attached_file :avatar, {
+  storage: :eitheror,
+  either: {
+    storage: :fog
+  },
+  or: {
+    storage: :filesystem
+  }
+}
+```
+
+You can use specific configuration by passing them on one of the storages config. For instance:
+
+```ruby
+has_attached_file :avatar, {
+  storage: :eitheror,
+  either: {
+    storage: :fog,
+    path: ':attachment/:id/:style/:filename',
+    url: ':attachment/:id/:style/:filename'
+  },
+  or: {
+    storage: :filesystem,
+    path: ':rails_root/public/attachments/:class/:attachment/:style/:filename'
+  }
+}
+```
+
+The configuration for each storage inherits whatever attributes are defined at the configuration top level config, and existing attributes may be overridden with storage specific values. For example:
+
+```ruby
+has_attached_file :avatar, {
+  storage: :eitheror,
+  url: '/api/v1/attachments/:attachment/:id/:style',
+  path: ':rails_root/public/attachments/:class/:attachment/:style/:filename',
+  either: {
+    storage: :fog,
+    path: ':attachment/:id/:style/:filename',
+    url: ':attachment/:id/:style/:filename'
+  },
+  or: {
+    storage: :filesystem,
+  }
+}
+```
+
+In the example above, the storage **or** will inherit the attributes `path` and `url` from the base configuration, while `either` will provide its own `path` and `url` attributes. The following configuration is equivalent:
+
+```ruby
+has_attached_file :avatar, {
+  storage: :eitheror,
+  either: {
+    storage: :fog,
+    path: ':attachment/:id/:style/:filename',
+    url: ':attachment/:id/:style/:filename'
+  },
+  or: {
+    storage: :filesystem,
+    url: '/api/v1/attachments/:attachment/:id/:style',
+    path: ':rails_root/public/attachments/:class/:attachment/:style/:filename',
+  }
+}
+```
+
+That is particularly useful when globally configuring `paparclip-eitheror`.
+
+## Global Configuration
+
+On large codebases it might become very tedious and error prone to chase down all paperclip usages and adapt their configuration to use `paperclip-eitheror`. An alternative is to configure `paperclip` default options to use `paperclip-eitheror` as the default storage.
+
+```ruby
+# config/initializers/paperclip.rb
+
+Paperclip::Attachment.default_options[:storage] = :eitheror
+Paperclip::Attachment.default_options[:either] = {
+  storage: :fog,
+  path: ':attachment/:id/:style/:filename',
+  url: ':attachment/:id/:style/:filename',
+}
+
+Paperclip::Attachment.default_options[:or] = {
+  storage: :filesystem,
+}
+```
+
+Since storages inherit configuration from the base config, you would not have to change any of your existing models and in this case the **or** storage would inherit the configuration on your models acting as your existing storage.
+
+In case you need a particular model to **NOT** be affected by the global configuration, you can explicitly define the storage type you want the model to use as part of its `has_attached_file` options:
+
+```ruby
+class User < ActiveRecord::Base
+  has_attached_file :avatar, storage: :filesystem
+end
+```
+
+# `:autosync`
+
+You can configure `paperclip-eitheror` to automatically synchronize attachments from the **or** (fallback) storage to **either** (primary).
+
+When `:autosync` is set to `true`, whenever an attachment which exists only on **or** is accessed, the attachment will be synced to the primary storage and access (such as `path` and `url`) will be provided through the primary storage.
+
+```ruby
+has_attached_file :avatar, {
+  storage: :eitheror,
+  autosync: true,
+  ...
+}
+```
+
+# Method aliasing/overriding
+
+Different storages provide different ways of accessing attachments.
+For instance, when using `:fog` storage, you have access to methods which only make sense to that particular storage.
+Or when you're migrating your assets from a `:filesystem` storage to a `:fog` storage, you might not want to go after every reference to `attachment.url` in your code in order to change it to `attachment.public_url`.
+
+`paperclip-eitheror` gives you the ability to provide an `:alias` key, which then will allow you to tell it how to behave when such scenario happens.
+
+For instance:
+
+```ruby
+has_attached_file :avatar, {
+  storage: :eitheror,
+  either: {
+    storage: :fog,
+    alias: {
+      url: :public_url
+    }
+  },
+  or: {
+    storage: :filesystem,
+  }
+}
+```
+
+Int he example above we're telling `paperclip-eitheror` that whenever `avatar.url` is called, the `:fog` storage will delegate it to `attachment.public_url`. Mapping `fog.url` to `fog.public_url` seems like a very straight-forward mapping.
+
+Not always mapping from one method to another is going to be that simple, you can write you own overrides by mapping a method to a `lambda`, like so:
+
+```ruby
+has_attached_file :avatar, {
+  storage: :eitheror,
+  either: {
+    storage: :fog,
+    alias: {
+      url: ->(either_storage, or_storage, attachment, *args) do
+        puts "Look, I can do whatever I want"
+      end
+    }
+  },
+  or: {
+    storage: :filesystem,
+  }
+}
+```
+
+The `lambda` will receive as parameters both storages (**either** and **or**), the attachment instance and any other arguments given when the method was called.
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/powerhome/paperclip-eitheror. 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](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/lib/paperclip-eitheror.rb

@@ -0,0 +1,2 @@
+require "paperclip/eitheror/version"
+require "paperclip/storage/eitheror"

data/lib/paperclip/eitheror/version.rb

@@ -0,0 +1,5 @@
+module Paperclip
+  module Eitheror
+    VERSION = "0.1.0"
+  end
+end

data/lib/paperclip/storage/eitheror.rb

@@ -0,0 +1,95 @@
+module Paperclip
+  module Storage
+    module Eitheror
+      def self.extended base
+        base.instance_eval do
+          @either = Attachment.new(base.name, base.instance, base.options.merge(base.options[:either]))
+          @or = Attachment.new(base.name, base.instance, base.options.merge(base.options[:or]))
+
+          define_aliases @either, base.options[:either].fetch(:alias, {})
+          define_aliases @or, base.options[:or].fetch(:alias, {})
+        end
+      end
+
+      def sync
+        @either.assign @or
+        @either.save
+      end
+
+      def synced?
+        @either.exists?
+      end
+
+      def syncable?
+        @or.exists?
+      end
+
+      def path(style_name = default_style)
+        usable_storage.path(style_name)
+      end
+
+      def url(style_name = default_style, options = {})
+        usable_storage.url(style_name, options)
+      end
+
+      def flush_writes
+        storage = usable_storage
+        storage.instance_variable_set(:@queued_for_write, @queued_for_write)
+        storage.flush_writes
+
+        @queued_for_write = {}
+      end
+
+      def flush_deletes
+        all_storages.each do |storage|
+          storage.instance_variable_set(:@queued_for_delete, @queued_for_delete)
+          storage.flush_deletes
+        end
+
+        @queued_for_delete = []
+      end
+
+      def queue_some_for_delete(*styles)
+        @queued_for_delete += styles.flatten.uniq.map do |style|
+          all_storages.map { |s| s.path(style) if s.exists?(style) }
+        end.flatten.compact
+      end
+
+      def queue_all_for_delete
+        queue_some_for_delete([:original, *styles.keys].uniq)
+        super
+      end
+
+      def method_missing method, *args
+        usable_storage.send(method, *args)
+      end
+
+      private
+      def all_storages
+        [@either, @or]
+      end
+
+      def usable_storage
+        return @either if !@or.exists? || @either.exists?
+        options[:autosync] && sync ? @either : @or
+      end
+
+      def define_aliases target, aliases = {}
+        aliases.each do |name, value|
+          block = is_callable?(value) ?
+            ->(*args) { value.call(@either, @or, self, *args) } :
+            ->(*args) { target.send(value, *args) }
+          create_method(target, name, &block)
+        end
+      end
+
+      def is_callable?(o)
+        o.respond_to?(:call)
+      end
+
+      def create_method(target, name, &block)
+        target.class.send(:define_method, name, &block)
+      end
+    end
+  end
+end

data/paperclip-eitheror.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'paperclip/eitheror/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "paperclip-eitheror"
+  spec.version       = Paperclip::Eitheror::VERSION
+  spec.authors       = ["Matheus Abegg"]
+  spec.email         = ["matheus.abegg@gmail.com"]
+
+  spec.summary       = "Storage for Paperclip which will fallback in case of" \
+    " a file not existing on the primary storage."
+  spec.homepage      = "https://github.com/powerhome/paperclip-eitheror"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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"]
+
+  spec.add_dependency "paperclip", "= 4.3.1"
+
+  spec.add_development_dependency "activerecord", "= 3.2.22.5"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: paperclip-eitheror
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matheus Abegg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.22.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.22.5
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- matheus.abegg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/paperclip-eitheror.rb
+- lib/paperclip/eitheror/version.rb
+- lib/paperclip/storage/eitheror.rb
+- paperclip-eitheror.gemspec
+homepage: https://github.com/powerhome/paperclip-eitheror
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Storage for Paperclip which will fallback in case of a file not existing
+  on the primary storage.
+test_files: []