administrate-field-paperclip 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee16d28996faaddc47f31c7a8c5f817d46dd114a
-  data.tar.gz: 44f9346ebf5c4e3684c84aa057ddc36d084af810
+  metadata.gz: 8454ba2fb10fe33dfecd1f5696574581b6440996
+  data.tar.gz: 5421b704c17d70e9cfb983a547c184bfc2e6d4ea
 SHA512:
-  metadata.gz: 7db40f29e4215404bf99062c401e1c23c76c1649f50cfbf83f3967476a65660631bd6948afd028119dbb76507c2b93a3dcf3670458fa5742fae69f4ec8919826
-  data.tar.gz: 5bc6bc633197f93dae28a596574d7d58d6028be0e37cd005d4f74ae91307e0b9b83a199b3299b3421c7b3301898b7a4e2597b35c1d059dade0c5215397f06c4e
+  metadata.gz: 7005ebcfd36fc037ecc5a546ac331c110f33f79a4d952e8abf71c64e22bec5bb8aa41446b8024e748c01fbd477b5d1f19b9f4f9796a2d92012d554afac6c3d68
+  data.tar.gz: e9bbd9339a6224f7a5a018d52b272ad181340282678fcaf47f3bc33e23323cd7487437e13a2a30fd5bdc80421bf90b0459e9e6b6898631ba9cd59847af0e0625

data/.gitignore

@@ -1,10 +1,12 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/*.gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem
+/spec/processed_images/
+/.byebug_history

data/.rspec

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

data/.rubocop.yml

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

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/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.4.0
+  - 2.3.3
+  - 2.2.6
+  - 2.1.10
+cache: bundler
+install: bundle install
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/Gemfile

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

data/README.md

@@ -17,9 +17,29 @@ Install:
 $ bundle install
 ```
 
+## Usage
+
 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::Paperclip` to `ATTRIBUTE_TYPES`.
-* Add `:avatar` to `FORM_ATTRIBUTES`, `SHOW_PAGE_ATTRIBUTES` and (optionally) `COLLECTION_ATTRIBUTES`.
+```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,22 +1,21 @@
-#!/usr/bin/env rake
-
-begin
-  require "bundler/setup"
-rescue LoadError
-  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
-end
-
-require "bundler/gem_tasks"
-
-##
-# Configure the test suite.
-##
-require "rspec/core"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new
-
-##
-# By default, just run the tests.
-##
-task default: :spec
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler/gem_tasks'
+
+##
+# Configure the test suite.
+##
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+##
+# By default, just run the tests.
+##
+task default: :spec

data/administrate-field-paperclip.gemspec

@@ -1,21 +1,29 @@
-$:.push File.expand_path('../lib', __FILE__)
-
-Gem::Specification.new do |gem|
-  gem.name = 'administrate-field-paperclip'
-  gem.version = '0.0.2'
-  gem.authors = ['Fernando Briano']
-  gem.email = ['fernando@picandocodigo.net']
-  gem.homepage = 'https://github.com/picandocodigo/administrate-field-paperclip'
-  gem.summary = 'Paperclip field plugin for Administrate'
-  gem.description = 'Integrates Paperclip as a field for Administrate in Rails apps'
-  gem.license = 'MIT'
-
-  gem.require_paths = ['lib']
-  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_development_dependency 'rspec', '~> 3.5'
-end
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = 'administrate-field-paperclip'
+  gem.version = '0.0.3'
+  gem.authors = ['Fernando Briano']
+  gem.email = ['fernando@picandocodigo.net']
+  gem.homepage = 'https://github.com/picandocodigo/administrate-field-paperclip'
+  gem.summary = 'Paperclip field plugin for Administrate'
+  gem.description = 'Integrates Paperclip as a field for Administrate in Rails apps'
+  gem.license = 'MIT'
+
+  gem.require_paths = ['lib']
+  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_development_dependency 'byebug'
+  gem.add_development_dependency 'factory_girl'
+  gem.add_development_dependency 'fog'
+  gem.add_development_dependency 'paperclip'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'coveralls'
+  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

@@ -1 +1,5 @@
-<%= image_tag field.thumbnail %>
+<% 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

@@ -1 +1,5 @@
-<%= image_tag field.url if field.url.present? %>
+<% 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

@@ -1,22 +1,41 @@
-require 'administrate/field/base'
-require 'rails'
-
-module Administrate
-  module Field
-    class Paperclip < Administrate::Field::Base
-      def url
-        data.url
-      end
-
-      def thumbnail
-        data.url(:thumbnail)
-      end
-
-      def to_s
-        data
-      end
-      class Engine < ::Rails::Engine
-      end
-    end
-  end
-end
+require 'administrate/field/base'
+require 'rails'
+
+module Administrate
+  module Field
+    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
+        style(thumbnail_style)
+      end
+
+      # Just display the URL as a link, rather than trying to make it an image
+      def url_only?
+        options.fetch(:url_only, false)
+      end
+
+      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
+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,12 @@
+class Post < ActiveRecord::Base
+  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

@@ -1,14 +1,78 @@
-require "administrate/field/paperclip"
-
-describe Administrate::Field::Paperclip do
-  describe '#to_partial_path' do
-    it 'returns a partial based on the page being rendered' do
-      page = :show
-      field = Administrate::Field::Paperclip.new(:paperclip, '/a.jpg', page)
-
-      path = field.to_partial_path
-
-      expect(path).to eq("/fields/paperclip/#{page}")
-    end
-  end
-end
+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,11 @@
+# make sure we have paperclip here
+require 'paperclip'
+
+include Paperclip::Schema
+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,37 @@
+# start coverage tracking
+require 'coveralls'
+require 'simplecov'
+SimpleCov.start
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'administrate/field/paperclip'
+# config Paperclip for testing purposes
+require 'paperclip'
+require 'fog'
+Paperclip::Attachment.default_options[:storage] = :fog
+Paperclip::Attachment.default_options[:fog_credentials] = {
+  provider: 'Local',
+  local_root: File.join(__FILE__, '../processed_images'),
+}
+Paperclip::Attachment.default_options[:fog_directory] = ''
+Paperclip::Attachment.default_options[:fog_host] = 'http://localhost:3000'
+
+# enable debugging using byebug
+require 'byebug'
+
+# 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.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Fernando Briano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-14 00:00:00.000000000 Z
+date: 2017-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: administrate
@@ -38,6 +38,90 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.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'
+- !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: fog
+  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: 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: 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: 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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +136,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
@@ -60,6 +172,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -69,7 +185,13 @@ files:
 - 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