administrate-field-paperclip 0.0.1 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3d41e35ed69b05f97239bfc3d8761ce29c423d55
-  data.tar.gz: 1243a8110b8f491f69a82c3fdeb9cd9fa60d4e82
+SHA256:
+  metadata.gz: e1912688400a8648c80a6e0b6da6edceea2e572cff2d4c13424d8541c2fcb5b0
+  data.tar.gz: 4ad6e9d18d822c98496e844c8fcd7a86eeb160b5f9d829a4723a825fd57fcb08
 SHA512:
-  metadata.gz: '01836a41e2120c6a1a2873770be1abe15893cc4082b914a2a224711164c7230c51942ddf6f4d1fc9f7244a7750b2465469f24e622cec89bd0048e13706eee0d2'
-  data.tar.gz: b731b352618d245bcfb251be6b1e12f9f459925ce6ec8cf5c065903fdc0046b057f62ad379c87e53abd05d67c9f549405ea873a448eda74d36199f9bb4b4e557
+  metadata.gz: b67d0174d9202a8345ef161dafe1b64011cfab05056e9be5fedf0d3f66410d557b64396e549ec8b812c97465832c2c6d2e99cf3324e29b2dbe692f774725c5df
+  data.tar.gz: 9267013c35eae198a6118166e5b615cc2eb3be69b0284fbf20447d47a48d34499bc9ccf80e402b50700728830f553d18966366205b1065ddd59bd8a0ddd8be04

data/.github/workflows/rubocop.yml

@@ -0,0 +1,11 @@
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - name: Run Rubocop
+      run: |
+        bundle install
+        bundle exec rubocop

data/.github/workflows/tests.yml

@@ -0,0 +1,22 @@
+name: Ruby
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ 2.4, 2.5, 2.6, 2.7, jruby ]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: sudo apt-get install libsqlite3-dev
+    - name: Build
+      run: |
+        ruby -v
+        bundle install --jobs 4 --retry 3
+    - name: Test with Rake
+      run: bundle exec rspec

data/.gitignore

@@ -7,4 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
-/*.gem
+/*.gem
+/spec/processed_images/
+/.byebug_history

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+Metrics/LineLength:
+  Max: 120
+
+Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# specs tend to get long
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/.simplecov

@@ -0,0 +1,11 @@
+SimpleCov.start 'rails' do
+  add_group 'app', 'app'
+  add_group 'lib', 'lib'
+
+  refuse_coverage_drop
+
+  formatter SimpleCov::Formatter::MultiFormatter.new([
+                                                       SimpleCov::Formatter::HTMLFormatter,
+                                                       Coveralls::SimpleCov::Formatter
+                                                     ])
+end

data/Gemfile

@@ -1,3 +1,3 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec

data/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2017 Fernando Briano
-
-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.
+MIT License
+
+Copyright (c) 2017 Fernando Briano
+
+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

@@ -1,25 +1,47 @@
-# Administrate::Field::Paperclip
-
-A plugin to integrate [Paperclip](https://github.com/thoughtbot/paperclip) fields in [Administrate](https://github.com/thoughtbot/administrate).
-
-# Instructions
-
-Add `administrate-field-paperclip` and `paperclip` to your Gemfile:
-
-```
-gem 'administrate-field-paperclip'
-gem 'paperclip'
-```
-
-Install:
-
-```
-$ bundle install
-```
-
-Follow the [instructions on Paperclip](https://github.com/thoughtbot/paperclip#quick-start) to get started with your models and migrations. Once you've added the Paperclip attribute to your models, edit your Administrate dashboards. If you added 'avatar' to 'User', then you should:
-
-* Add `avatar: Field::PaperclipField` to `ATTRIBUTE_TYPES`.
-* Add `:avatar` to `FORM_ATTRIBUTES`, `SHOW_PAGE_ATTRIBUTES` and (optionally) `COLLECTION_ATTRIBUTES`.
-
-Based on the [Administrate::Field::Image](https://github.com/thoughtbot/administrate-field-image) template.
+# Administrate::Field::Paperclip
+
+A plugin to integrate [Paperclip](https://github.com/thoughtbot/paperclip) fields in [Administrate](https://github.com/thoughtbot/administrate).
+
+**[Paperclip has been deprecated](https://thoughtbot.com/blog/closing-the-trombone)**, so starting in version 0.0.6, this gem depends on [kt-paperclip](https://github.com/kreeti/kt-paperclip), an ongoing fork of Paperclip. If you're still using the deprecated version of Paperclip, version 0.0.5 should still work for you.
+
+# Instructions
+
+Add `administrate-field-paperclip` and `kt-paperclip` to your Gemfile:
+
+```
+gem 'administrate-field-paperclip'
+gem 'kt-paperclip'
+```
+
+Install:
+
+```
+$ bundle install
+```
+
+## Usage
+
+Follow the [instructions on Paperclip](https://github.com/kreeti/kt-paperclip#quick-start) to get started with your models and migrations. Once you've added the Paperclip attribute to your models, edit your Administrate dashboards. If you added 'avatar' to 'User', then you should:
+
+```ruby
+class UserDashboard < Administrate::BaseDashboard
+  ATTRIBUTE_TYPES = {
+    avatar: Field::Paperclip,
+  }
+# ...
+```
+
+Then add `:avatar` to `FORM_ATTRIBUTES`, `SHOW_PAGE_ATTRIBUTES` and (optionally) `COLLECTION_ATTRIBUTES`.
+
+You can provide the field with options using `Field::Paperclip.with_options(options)`:
+
+* `thumbnail_style` (defaults to `'thumbnail'`) to control what image style is used to display the image in collection views
+* `big_style` (defaults to `'original'`) to control what image style is used to display the image on the show page.
+* `url_only` (defaults to `false`) to show only a URL (as a link) instead of trying to display an image.
+
+## [Contributors](https://github.com/picandocodigo/administrate-field-paperclip/graphs/contributors)
+
+* Klas Eskilson - https://github.com/klaseskilson
+* Rich - https://github.com/pedantic-git
+
+Based on the [Administrate::Field::Image](https://github.com/thoughtbot/administrate-field-image) template.

data/Rakefile

@@ -1,18 +1,16 @@
-#!/usr/bin/env rake
-
 begin
-  require "bundler/setup"
+  require 'bundler/setup'
 rescue LoadError
-  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 ##
 # Configure the test suite.
 ##
-require "rspec/core"
-require "rspec/core/rake_task"
+require 'rspec/core'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new
 

data/administrate-field-paperclip.gemspec

@@ -1,8 +1,8 @@
-$:.push File.expand_path('../lib', __FILE__)
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 
 Gem::Specification.new do |gem|
   gem.name = 'administrate-field-paperclip'
-  gem.version = '0.0.1'
+  gem.version = '0.0.6'
   gem.authors = ['Fernando Briano']
   gem.email = ['fernando@picandocodigo.net']
   gem.homepage = 'https://github.com/picandocodigo/administrate-field-paperclip'
@@ -14,8 +14,19 @@ Gem::Specification.new do |gem|
   gem.files = `git ls-files`.split("\n")
   gem.test_files = `git ls-files -- {test,spec,features}/*`.split('\n')
 
-  gem.add_dependency 'administrate', '~> 0.4'
-  gem.add_dependency 'rails', '~> 5.0'
+  gem.add_dependency 'administrate', '~> 0.13'
+  gem.add_dependency 'rails', '>= 4.2'
 
+  if defined?(JRUBY_VERSION)
+    gem.add_development_dependency 'activerecord-jdbcsqlite3-adapter' if defined?(JRUBY_VERSION)
+  else
+    gem.add_development_dependency 'byebug'
+    gem.add_development_dependency 'sqlite3', '~> 1.3.6'
+  end
+  gem.add_development_dependency 'coveralls'
+  gem.add_development_dependency 'factory_girl'
+  gem.add_development_dependency 'kt-paperclip'
   gem.add_development_dependency 'rspec', '~> 3.5'
+  gem.add_development_dependency 'rubocop'
+  gem.add_development_dependency 'simplecov'
 end

data/app/views/fields/paperclip/_index.html.erb

@@ -0,0 +1,5 @@
+<% if field.url_only? -%>
+<%= link_to field.url, field.url if field.url.present? %>
+<% else -%>
+<%= image_tag field.thumbnail %>
+<% end -%>

data/app/views/fields/paperclip/_show.html.erb

@@ -0,0 +1,5 @@
+<% if field.url_only? -%>
+<%= link_to field.url, field.url if field.url.present? %>
+<% else -%>
+<%= image_tag field.url if field.url.present? %>
+<% end -%>

data/lib/administrate/field/paperclip.rb

@@ -3,19 +3,38 @@ require 'rails'
 
 module Administrate
   module Field
-    class PaperclipField < Administrate::Field::Base
-      def url
-        data.url
+    class Paperclip < Administrate::Field::Base
+      class Engine < ::Rails::Engine
+      end
+
+      def style(size = big_style)
+        data.try(:url, size) || ''
       end
 
+      delegate :url, to: :data
+
       def thumbnail
-        data.url(:thumbnail)
+        style(thumbnail_style)
       end
 
-      def to_s
-        data
+      # Just display the URL as a link, rather than trying to make it an image
+      def url_only?
+        options.fetch(:url_only, false)
       end
-      class Engine < ::Rails::Engine
+
+      alias url style
+
+      private
+
+      DEFAULT_THUMBNAIL_STYLE = :thumbnail
+      DEFAULT_BIG_STYLE = :original
+
+      def thumbnail_style
+        options.fetch(:thumbnail_style, DEFAULT_THUMBNAIL_STYLE)
+      end
+
+      def big_style
+        options.fetch(:big_style, DEFAULT_BIG_STYLE)
       end
     end
   end

data/spec/factories/posts.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :post do
+    image { File.new(File.join('spec', 'fixtures', 'image.png')) }
+  end
+end

data/spec/models.rb

@@ -0,0 +1,16 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end
+
+class Post < ApplicationRecord
+  include Paperclip::Glue
+
+  has_attached_file :image,
+                    styles: {
+                      thumbnail: '4x4#',
+                      extra: '2x4>'
+                    }
+
+  # validates_attachment_content_type :image, content_type: /\Aimage\/.*\z/
+  do_not_validate_attachment_file_type :image
+end

data/spec/paperclip_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+RSpec.describe Administrate::Field::Paperclip do
+  let(:post) { create(:post) }
+  let(:page) { :show }
+  let(:field) { described_class.new(:image, post.image, page) }
+  let(:empty_field) { described_class.new(:image, nil, page) }
+
+  require 'administrate/field/paperclip'
+
+  describe '#to_partial_path' do
+    it 'returns a partial based on the page being rendered' do
+      expect(empty_field.to_partial_path).to eq("/fields/paperclip/#{page}")
+    end
+  end
+
+  PAPECLIP_FIELD_METHODS = %w[style thumbnail url].freeze
+  PAPECLIP_FIELD_METHODS.each do |method|
+    describe "##{method}" do
+      context 'when inner_attribute is not set' do
+        it 'should return a non-nil url' do
+          expect(field.send(method)).to_not eq ''
+        end
+      end
+
+      context 'when image attachment doesn\'t exist' do
+        it 'should return empty string' do
+          expect(empty_field.send(method)).to eq ''
+        end
+      end
+    end
+  end
+
+  describe '#thumbnail' do
+    context 'when thumbnail size is provided as an option' do
+      let(:field) { described_class.new(:image, post.image, page, thumbnail_style: :extra) }
+
+      it 'should return a string to the correct image' do
+        expect(field.thumbnail).to_not be_nil
+        expect(field.thumbnail).to include('extra')
+      end
+    end
+  end
+
+  describe '#style' do
+    context 'when big image style is provided as an option' do
+      let(:field) { described_class.new(:image, post.image, page, big_style: :extra) }
+
+      it 'should return a string to the correct image' do
+        expect(field.style).to_not be_nil
+        expect(field.style).to include('extra')
+      end
+    end
+
+    context 'when  image style is provided as a parameter' do
+      let(:field) { described_class.new(:image, post.image, page) }
+
+      it 'should return a string to the correct image' do
+        expect(field.style(:extra)).to_not be_nil
+        expect(field.style(:extra)).to include('extra')
+      end
+    end
+  end
+
+  describe '#url_only?' do
+    context 'with no options' do
+      it 'should be false' do
+        expect(field.url_only?).to be false
+      end
+    end
+    context 'with url_only option true' do
+      let(:field) { described_class.new(:image, post.image, page, url_only: true) }
+      it 'should be true' do
+        expect(field.url_only?).to be true
+      end
+    end
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,14 @@
+# make sure we have paperclip here
+require 'paperclip'
+
+# rubocop:disable Style/MixinUsage
+include Paperclip::Schema
+# rubocop:enable Style/MixinUsage
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :posts, force: true do |t|
+    t.attachment :image
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+# start coverage tracking
+require 'coveralls'
+require 'simplecov'
+SimpleCov.start
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+
+require 'administrate/field/paperclip'
+
+# config Paperclip for testing purposes
+require 'paperclip'
+Paperclip::Attachment.default_options[:storage] = :filesystem
+Paperclip::Attachment.default_options[:path] = '../processed_images'
+
+# enable debugging using byebug
+require 'byebug' unless defined?(JRUBY_VERSION)
+
+# start up factory_girl
+require 'factory_girl'
+
+# start db and load migrations and everything
+require 'active_record'
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+require_relative 'schema'
+require_relative 'models'
+
+# config rspec
+RSpec.configure do |config|
+  # configure factory girl
+  config.include FactoryGirl::Syntax::Methods
+  config.before(:suite) do
+    FactoryGirl.find_definitions
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: administrate-field-paperclip
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.6
 platform: ruby
 authors:
 - Fernando Briano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-07 00:00:00.000000000 Z
+date: 2020-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: administrate
@@ -16,28 +16,98 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: factory_girl
+  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: kt-paperclip
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +122,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: simplecov
+  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: Integrates Paperclip as a field for Administrate in Rails apps
 email:
 - fernando@picandocodigo.net
@@ -59,16 +157,28 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - administrate-field-paperclip.gemspec
-- app/views/fields/paperclip_field/_form.html.erb
-- app/views/fields/paperclip_field/_index.html.erb
-- app/views/fields/paperclip_field/_show.html.erb
+- app/views/fields/paperclip/_form.html.erb
+- app/views/fields/paperclip/_index.html.erb
+- app/views/fields/paperclip/_show.html.erb
 - lib/administrate/field/paperclip.rb
+- spec/factories/posts.rb
+- spec/fixtures/image.png
+- spec/models.rb
+- spec/paperclip_spec.rb
+- spec/processed_images/.keep
+- spec/schema.rb
+- spec/spec_helper.rb
 homepage: https://github.com/picandocodigo/administrate-field-paperclip
 licenses:
 - MIT
@@ -88,10 +198,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Paperclip field plugin for Administrate
 test_files: []
-has_rdoc: 

data/app/views/fields/paperclip_field/_index.html.erb

@@ -1 +0,0 @@
-<%= image_tag field.thumbnail %>

data/app/views/fields/paperclip_field/_show.html.erb

@@ -1 +0,0 @@
-<%= image_tag field.url if field.url.present? %>