solidus_product_attachments 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81568f1eb44e9f922a8e4cf8efb1eb937312f5b3
-  data.tar.gz: 016454e4c6177400aa57c74e29857df7efe2e6df
+  metadata.gz: 80cc02a5360a349128560bfc8a7fb742e3f18051
+  data.tar.gz: 36ba3e7e2e45ff76dad104f33f9152896b27637c
 SHA512:
-  metadata.gz: 60156a9faa53d99e2f6d0a2e3ad0fd9d106fb295deb7865a8a55cf09c848b961721dfd9747318f0a2f34f17a7badd0faed39a97fbf8440a045b651893812c89d
-  data.tar.gz: d7da787ea96e2e931766815ad7048f271b1515fd60e8f52927e561b1de653dd7bcd2fe9ef701a2ddae95313e0148fbc070d0b08439421ca8fec5e7af1983699a
+  metadata.gz: 13dc6e736815335271c75da5513cf1d8a061ff7b72d77ece199f15c18b0225fb3dbe311c29cffee6c11e52d4ff70532bf964f4b6ff645fb8d06c6e4ad01f6fd8
+  data.tar.gz: 6f40d2cb9a434aeb58d1aa5cbfd408e002b1d4ae0e9336940370fe0bf06d3b3093e1a1ced4c514852e736b1abba587ee64fbfda07d60ff899e7f0f096eedb6e5

data/README.md

@@ -1,15 +1,13 @@
-SolidusProductAttachments
-=========================
+# Solidus Product Attachments
 
-Allows the administrator to add attachments to a product/variant.
+This Solidus extension allows the administrator to upload PDF files to a product or to a variant.
 
 [![Build Status](https://semaphoreci.com/api/v1/projects/c5f055f7-da80-440c-9f7b-c9c6c4a87bfa/2535219/shields_badge.svg)](https://semaphoreci.com/renuo/solidus_product_attachments)
+[![Gem Version](https://badge.fury.io/rb/solidus_product_attachments.svg)](https://badge.fury.io/rb/solidus_product_attachments)
 
+## Installation
 
-Installation
-------------
-
-Add solidus_product_attachments to your Gemfile:
+Add `solidus_product_attachments` to your `Gemfile`:
 
 ```ruby
 gem 'solidus_product_attachments'
@@ -22,21 +20,55 @@ bundle
 bundle exec rails g solidus_product_attachments:install
 ```
 
-Testing
--------
+## Usage
+
+### Backend
+
+The usage of this extension is made very easy. All you have to do is to include it in your `Gemfile` and run the installer. After doing this, you can go to a product's page in the admin view and you'll notice a new `Documents` tab.
+
+<img width="1205" alt="Product documents tab" src="https://user-images.githubusercontent.com/31915276/53641672-f26efc00-3c2f-11e9-841d-687e7c849957.png">
+
+The functionality of the documents upload is very similar to the images upload. You can upload a document per drag and drop or you can choose a file manually.
+
+### Frontend
+
+This extension does not come with a frontend implementation of a download option for the users. It's completely up to you 
+to add it, but you can inspire yourself from the following example:
 
-First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs, and [Rubocop](https://github.com/bbatsov/rubocop) static code analysis. The dummy app can be regenerated by using `rake test_app`.
+<img width="205" alt="Download option example" src="https://user-images.githubusercontent.com/31915276/53641960-c738dc80-3c30-11e9-82ef-df730bd0e357.png">
+
+And the code (only for the product downloads, without css):
+
+```erb
+<% if @product.attachments.any? %>
+  <div class="product-downloads">
+    <h2>I18n.t('spree.product_download_title')</h2>
+    <ul class="unstyled">
+      <% @product.attachments.each do |attachment| %>
+        <li>
+          <%= link_to attachment.alt.presence || attachment.attachment_file_name, attachment.attachment.url, target: '_blank' %>
+        </li>
+      <% end %>
+    </ul>
+  </div>
+<% end %>
+```
+
+## Testing
+
+First bundle your dependencies, then run `bundle exec rake`. This command will default to building the dummy app if it does not exist, then it will run the specs and [Rubocop](https://github.com/bbatsov/rubocop) static code analysis. The dummy app can be regenerated by using `bundle exec rake test_app`.
 
 ```shell
 bundle
 bundle exec rake
 ```
 
-When testing your applications integration with this extension you may use it's factories.
-Simply add this require statement to your spec_helper:
+When testing your application's integration with this extension, you may use its factories. In order to do this, simply add this require statement to your spec_helper:
 
 ```ruby
 require 'solidus_product_attachments/factories'
 ```
 
-Copyright (c) 2019 [Renuo AG](https://www.renuo.ch/en), released under the New BSD License
+## Copyright
+
+Copyright (c) 2019 [Renuo AG](https://www.renuo.ch/en), released under the New BSD License.

data/app/models/spree/attachment.rb

@@ -4,7 +4,9 @@ module Spree
                                attachment_updated_at id position type].freeze
     PERMITTED_ATTACHMENT_ATTRIBUTES = %i[alt attachment position viewable_id viewable_type].freeze
 
-    has_attached_file :attachment
+    has_attached_file :attachment,
+                      url: '/spree/attachments/:id/:basename.:extension',
+                      path: ':rails_root/public/spree/attachments/:id/:basename.:extension'
 
     validate :no_attachment_errors
     validates_attachment :attachment, content_type: { content_type: 'application/pdf' }

data/lib/solidus_product_attachments/testing_support/factories.rb

@@ -0,0 +1,5 @@
+require 'factory_bot'
+
+Dir["#{File.dirname(__FILE__)}/factories/**"].each do |f|
+  require File.expand_path(f)
+end

data/lib/solidus_product_attachments/testing_support/factories/attachments.rb

@@ -0,0 +1,7 @@
+require_relative '../support/assets'
+
+FactoryBot.define do
+  factory :attachment, class: Spree::Attachment do
+    attachment { fake_attachment }
+  end
+end

data/lib/solidus_product_attachments/testing_support/support/assets.rb

@@ -0,0 +1,3 @@
+def fake_attachment
+  Rack::Test::UploadedFile.new(File.join(__dir__, '..', 'fixtures', 'test_file.pdf'), 'application/pdf')
+end

data/lib/solidus_product_attachments/version.rb

@@ -1,3 +1,3 @@
 module SolidusProductAttachments
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus_product_attachments
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Renuo AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-28 00:00:00.000000000 Z
+date: 2019-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -247,6 +247,10 @@ files:
 - lib/generators/solidus_product_attachments/install/install_generator.rb
 - lib/solidus_product_attachments.rb
 - lib/solidus_product_attachments/engine.rb
+- lib/solidus_product_attachments/testing_support/factories.rb
+- lib/solidus_product_attachments/testing_support/factories/attachments.rb
+- lib/solidus_product_attachments/testing_support/fixtures/test_file.pdf
+- lib/solidus_product_attachments/testing_support/support/assets.rb
 - lib/solidus_product_attachments/version.rb
 homepage: https://www.renuo.ch
 licenses: