carrierwave-delay 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20704d84f0ac32916ff6b65b64b196f8c5f6e9bd
+  data.tar.gz: e95125bc6d08ad9aa4d17d078d2721aecb4fe8ef
+SHA512:
+  metadata.gz: 152723909e3dfa2e186e1cbf5383ea467939e5bf637eb43a0fbd6493c6b54b1090f4af5668845b1eacc00ac69018dc94a1e213432ccd92b9ade3e746cb2b82ef
+  data.tar.gz: 46c3ad206ca748bca6fbb8edfd7313488204939073c82f089844f24498e053e3dfee8c5d42ad903c1a5186534db6b3446da4c4546c1dcf0bdd1cc24dbbc0c37b

data/.github/issue_template.md

@@ -0,0 +1,16 @@
+### Expected behavior
+Tell us what should happen
+
+### Actual behavior
+Tell us what happens instead
+
+### Steps to reproduce
+
+(Guidelines for creating a bug report are [available
+here](https://github.com/jonhue/carrierwave-delay/wiki/Bug-reports))
+
+### System configuration
+
+**Ruby version**:
+
+**Rails version**:

data/.github/pull_request_template.md

@@ -0,0 +1,21 @@
+### Summary
+
+Provide a general description of the code changes in your pull
+request... were there any bugs you had fixed? If so, mention them. If
+these bugs have open GitHub issues, be sure to tag them here as well,
+to keep the conversation linked together.
+
+### Other Information
+
+If there's anything else that's important and relevant to your pull
+request, mention that information here. This could include
+benchmarks, or other information.
+
+If you are updating any of the CHANGELOG files or are asked to update the
+CHANGELOG files by reviewers, please add the CHANGELOG entry at the top of the file.
+
+Finally, if your pull request affects documentation or any non-code
+changes, guidelines for those changes are [available
+here](https://github.com/jonhue/carrierwave-delay/wiki/Contributing)
+
+Thanks for contributing to carrierwave-delay!

data/.gitignore

@@ -0,0 +1,13 @@
+*.gem
+*.rbc
+.DS_Store
+.bundle
+.rvmrc
+.ruby-version
+.yardoc
+.rake_tasks~
+coverage/*
+doc/*
+log/*
+pkg/*
+.idea/*

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+    - 2.3.3
+install: bundle install --without development --deployment --jobs=3 --retry=3

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+### unreleased
+
+* nothing yet
+
+### 1.0.0 - 2017-10-11
+
+Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# 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 help@slooob.com. The project team will review and investigate all complaints, and will respond in a way that it deems 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,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+
+# Travis CI
+gem 'rspec-rails', '~> 3.6'
+
+# Development
+group :development do
+    gem 'rubocop', '~> 0.49', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,156 @@
+PATH
+  remote: .
+  specs:
+    carrierwave-delay (0.1.0)
+      rails (>= 4.0.0)
+      thor (~> 0.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.1.3)
+      actionpack (= 5.1.3)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.3)
+      actionpack (= 5.1.3)
+      actionview (= 5.1.3)
+      activejob (= 5.1.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.3)
+      actionview (= 5.1.3)
+      activesupport (= 5.1.3)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.3)
+      activesupport (= 5.1.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.3)
+      activesupport (= 5.1.3)
+      globalid (>= 0.3.6)
+    activemodel (5.1.3)
+      activesupport (= 5.1.3)
+    activerecord (5.1.3)
+      activemodel (= 5.1.3)
+      activesupport (= 5.1.3)
+      arel (~> 8.0)
+    activesupport (5.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    ast (2.3.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    erubi (1.6.1)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
+    i18n (0.8.6)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.6)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.2.0)
+    minitest (5.10.3)
+    nio4r (2.1.0)
+    nokogiri (1.8.0)
+      mini_portile2 (~> 2.2.0)
+    nokogiri (1.8.0-x86-mingw32)
+      mini_portile2 (~> 2.2.0)
+    parallel (1.12.0)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rack (2.0.3)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.1.3)
+      actioncable (= 5.1.3)
+      actionmailer (= 5.1.3)
+      actionpack (= 5.1.3)
+      actionview (= 5.1.3)
+      activejob (= 5.1.3)
+      activemodel (= 5.1.3)
+      activerecord (= 5.1.3)
+      activesupport (= 5.1.3)
+      bundler (>= 1.3.0)
+      railties (= 5.1.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.1.3)
+      actionpack (= 5.1.3)
+      activesupport (= 5.1.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (2.2.2)
+      rake
+    rake (12.0.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-rails (3.6.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+  x86-mingw32
+
+DEPENDENCIES
+  carrierwave-delay!
+  rspec-rails (~> 3.6)
+  rubocop (~> 0.49)
+
+BUNDLED WITH
+   1.13.7

data/INSTALL.md

@@ -0,0 +1 @@
+**Thank you for installing carrierwave-delay!**

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Slooob
+
+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/OWNERS.yaml

@@ -0,0 +1 @@
+- jonhue

data/README.md

@@ -0,0 +1,135 @@
+# carrierwave-delay - asynchronous processing with CarrierWave
+
+<img src="https://travis-ci.org/slooob/carrierwave-delay.svg?branch=master" /> [![Gem Version](https://badge.fury.io/rb/carrierwave-delay.svg)](https://badge.fury.io/rb/carrierwave-delay)
+
+With carrierwave-delay you can offload version processing of your Carrierwave uploaders to Sidekiq and ActiveJob instances.
+
+---
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+    * [Configuration](#configuration)
+* [To Do](#to-do)
+* [Contributing](#contributing)
+    * [Contributors](#contributors)
+    * [Semantic Versioning](#semantic-versioning)
+* [License](#license)
+
+---
+
+## Installation
+
+carrierwave-delay works with Rails 4.0 onwards. You can add it to your `Gemfile` with:
+
+```ruby
+gem 'carrierwave-delay'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install carrierwave-delay
+
+If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
+
+```ruby
+gem 'carrierwave-delay', github: 'slooob/carrierwave-delay'
+```
+
+## Usage
+
+Start by including `CarrierWave::Delay` in your uploader class and add `is_processing_delayed?` as condition to your defined versions:
+
+```ruby
+class ImageUploader < CarrierWave::Uploader::Base
+    include CarrierWave::Delay
+
+    version :small, if: :is_processing_delayed? do
+        process resize_to_fill: [50, 50]
+    end
+end
+```
+
+Then, define versions to be processed in your ActiveRecord class:
+
+```ruby
+class Post < ApplicationRecord
+    mount_uploader :image, ImageUploader
+    mount_uploader :logo, LogoUploader
+
+    carrierwave_delay [:image]
+end
+```
+
+### Configuration
+
+By adding class methods to your model, you are able to configure **queue** and **priority** of your background tasks:
+
+```ruby
+class Post < ApplicationRecord
+    mount_uploader :image, ImageUploader
+    mount_uploader :logo, LogoUploader
+
+    carrierwave_delay [:image]
+
+    def self.carrierwave_delay_queue
+        :carrierwave # defaults to `:default`
+    end
+    def self.carrierwave_delay_priority
+        10 # defaults to `20`
+    end
+end
+```
+
+---
+
+## To Do
+
+* Leave your suggestions [here](https://github.com/slooob/carrierwave-delay/issues/new)
+
+---
+
+## Contributing
+
+We hope that you will consider contributing to carrierwave-delay. Please read this short overview for some information about how to get started:
+
+[Learn more about contributing to this repository](https://github.com/slooob/carrierwave-delay/blob/master/CONTRIBUTING.md), [Code of Conduct](https://github.com/slooob/carrierwave-delay/blob/master/CODE_OF_CONDUCT.md)
+
+### Contributors
+
+Give the people some :heart: who are working on this project. See them all at:
+
+https://github.com/slooob/carrierwave-delay/graphs/contributors
+
+### Semantic Versioning
+
+carrierwave-delay follows Semantic Versioning 2.0 as defined at http://semver.org.
+
+## License
+
+MIT License
+
+Copyright (c) 2017 Slooob
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec
+
+task default: :spec

data/carrierwave-delay.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path(File.join('..', 'lib', 'carrierwave-delay', 'version'), __FILE__)
+
+Gem::Specification.new do |gem|
+    gem.name                  = 'carrierwave-delay'
+    gem.version               = CarrierwaveDelay::VERSION
+    gem.platform              = Gem::Platform::RUBY
+    gem.summary               = 'Asynchronous processing with CarrierWave'
+    gem.description           = 'With carrierwave-delay you can offload version processing of your Carrierwave uploaders to Sidekiq and ActiveJob instances.'
+    gem.authors               = ['Jonas Hübotter']
+    gem.email                 = 'developer@slooob.com'
+    gem.homepage              = 'https://developer.slooob.com/open-source'
+    gem.license               = 'MIT'
+
+    gem.files                 = `git ls-files`.split("\n")
+    gem.require_paths         = ['lib']
+
+    gem.post_install_message  = IO.read('INSTALL.md')
+
+    gem.required_ruby_version = '>= 2.0'
+
+
+    gem.add_dependency 'rails', '>= 4.0'
+    gem.add_dependency 'carrierwave', '~> 1.2'
+end

data/lib/carrierwave-delay.rb

@@ -0,0 +1,19 @@
+require 'rails'
+require 'carrierwave'
+
+module CarrierwaveDelay
+
+    require 'carrierwave-delay/version'
+
+    class Railtie < Rails::Railtie
+        initializer 'carrierwave-delay.active_record' do
+            ActiveSupport.on_load :active_record do
+                Sidekiq::Extensions.enable_delay! if defined? Sidekiq
+                require 'carrierwave/delay'
+                require 'carrierwave-delay/model'
+                include CarrierWaveDelay::Model
+            end
+        end
+    end
+
+end

data/lib/carrierwave-delay/model.rb

@@ -0,0 +1,40 @@
+module CarrierWaveDelay
+    module Model
+
+        extend ActiveSupport::Concern
+
+        included do
+            cattr_accessor :carrierwave_delay_columns
+        end
+
+        module ClassMethods
+
+            def carrierwave_delay columns
+                after_save :carrierwave_delay_process
+                self.carrierwave_delay_columns = columns
+            end
+
+            def carrierwave_delay_queue
+                :default
+            end
+            def carrierwave_delay_priority
+                20
+            end
+            
+        end
+
+        def recreate_delayed_versions!
+            self.class.carrierwave_delay_columns.each do |column|
+                send(column).is_processing_delayed = true
+                send(column).recreate_versions!
+            end
+        end
+
+        private
+
+        def carrierwave_delay_process
+            self.delay(queue: self.class.carrierwave_delay_queue, priority: self.class.carrierwave_delay_priority).recreate_delayed_versions!
+        end
+
+    end
+end

data/lib/carrierwave-delay/version.rb

@@ -0,0 +1,13 @@
+module CarrierwaveDelay
+
+    VERSION = '0.1.0'
+
+    class Version
+
+        def self.current
+            return 'carrierwave-delay ' + VERSION
+        end
+
+    end
+
+end

data/lib/carrierwave/delay.rb

@@ -0,0 +1,21 @@
+module CarrierWave
+    module Delay
+
+        extend ActiveSupport::Concern
+
+        def is_processing_delayed? img = nil
+            !! @is_processing_delayed
+        end
+
+        def is_processing_immediate? img = nil
+            ! is_processing_delayed?
+        end
+
+        def is_processing_delayed= value
+            @is_processing_delayed = value
+        end
+
+    end
+end
+
+# CarrierWave::Uploader::Versions.send :include, CarrierWave::Uploader::Versions::Delay

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: carrierwave-delay
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonas Hübotter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: With carrierwave-delay you can offload version processing of your Carrierwave
+  uploaders to Sidekiq and ActiveJob instances.
+email: developer@slooob.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/issue_template.md"
+- ".github/pull_request_template.md"
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- INSTALL.md
+- LICENSE
+- OWNERS.yaml
+- README.md
+- Rakefile
+- carrierwave-delay.gemspec
+- lib/carrierwave-delay.rb
+- lib/carrierwave-delay/model.rb
+- lib/carrierwave-delay/version.rb
+- lib/carrierwave/delay.rb
+homepage: https://developer.slooob.com/open-source
+licenses:
+- MIT
+metadata: {}
+post_install_message: "**Thank you for installing carrierwave-delay!**\n"
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Asynchronous processing with CarrierWave
+test_files: []