attachs 0.4.5 → 4.0.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3945fa2265a2f9ddfe93516b5476fa84688811f1
-  data.tar.gz: 2e50c546d315e7c33fbfe139b9f9c971d48b62ae
+  metadata.gz: af92d781bacb0959c5de57b14471a72591c85071
+  data.tar.gz: cd0da9ce6108a4029cacfab38f284d6ee7a655ab
 SHA512:
-  metadata.gz: 3bfa61b0d19c30e29b47d0f8532ed3507918f6344f49743e4f0348320b93fc74d66c4cc977c32f06715932b8cc8b6ed6025e0334d8d6ba57ab4530fd631a0239
-  data.tar.gz: 6ebd136c2d1373b8c7afa4feab958f91e8a5329758eef3cda01453c48c1ec0150b577f5a412e3e7a7dc3e47aa717a4ce1e2fec48d3a42b3b984dee21306809c2
+  metadata.gz: 97c0b6d55ca5fb851f150f319f0df8e04b2dfb30e4162251aa23d7cf8d0fdd2a6624781368207a4a794eb339b1e795b06635fdb8fc44d0d7b8e529309ca86157
+  data.tar.gz: 93844d464cfc4f11389e7b7d96ae7d61d9670bc376ae52b9b9690b771ee7feb21108d337962540d58454ef9e0d3b602e3e9f586b3792c8e403f7467c9662b640

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2015 Mathías Montossi
+Copyright 2016 Mathías Montossi
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -5,7 +5,18 @@
 
 # Attachs
 
-Minimalistic toolkit to attach files to records.
+Json based attachments for records in rails.
+
+## Why
+
+I did this gem to:
+
+- Save attachments into one json column.
+- Handle multiple attachments without the need of a separate model.
+- Have a way to delete orphan files.
+- Use graphicsmagick out of the box.
+- Delete and rename attachments asynchronous.
+- Keep renamed files to improve seo.
 
 ## Install
 
@@ -19,292 +30,146 @@ Then bundle:
 $ bundle
 ```
 
-NOTE: ImageMagick is needed.
-
-## Configuration
-
-Generate the configuration file:
+To install GraphicsMagick you can use homebrew:
 ```
-rails g attachs:install
+$ brew install graphicsmagick
 ```
 
-The defaults values are:
-```ruby
-Attachs.configure do |config|
-  config.s3 = { ssl: false }
-  config.base_url = ''
-  config.styles = {}
-  config.cachebuster = true
-  config.interpolations = {}
-  config.convert_options = {}
-  config.global_styles = []
-  config.global_convert_options= ''
-  config.default_storage = :local
-  config.default_processors = [:thumbnail]
-  config.default_path = '/:timestamp-:filename'
-end
-```
-
-## Usage
-
-Add the column to your table:
-```ruby
-create_table :users do |t|
-  t.attachment :avatar
-end
-```
-
-Define the attachment in your model:
-```ruby
-class User < ActiveRecord::Base
-  has_attached_file :avatar
-end
-```
-
-## Paths
+## Configuration
 
-To customize the path to some model:
-```ruby
-class User < ActiveRecord::Base
-  has_attached_file :avatar, path: '/:type/:timestamp/:filename'
-end
+Generate the configuration file:
 ```
-
-To create custom interpolations:
-```ruby
-Attachs.configure do |config|
-  config.interpolations = {
-    category: -> (attachment) { attachment.record.category }
-  }
-end
+$ bundle exec rails g attachs:install
 ```
 
-NOTE: Look into lib/attachs/storages/base.rb to find a list of the system interpolations.
-
-## Styles
-
-Define the styles of the attachment:
+Set the global settings:
 ```ruby
 Attachs.configure do |config|
-  config.styles = {
-    small: '120x120!',  # forces the exact size
-    medium: '240x240#', # resizes and crops to fill the desire space
-    big: '360x360'      # resizes to contain the imagen in the desire space
-  }
-end
-```
+  config.convert_options = '-strip -quality 82'
+  config.region = 'us-east-1'
+  config.bucket = 'some-bucket'
+  config.base_url = 'https://cdn.mydomain.com'
 
-Then reference them in your model:
-```ruby
-class User < ActiveRecord::Base
-  has_attached_file :avatar, styles: [:small, :medium]
+  config.interpolation :name do |record|
+    record.name
+  end
 end
 ```
 
-To set styles for all attachments:
-```ruby
-Attachs.configure do |config|
-  config.global_styles = [:big]
-end
-```
+## Usage
 
-## Convert
+### Definitions
 
-To define global convert options:
+Add the columns to your tables:
 ```ruby
-Attachs.configure do |config|
-  config.global_convert_options = '-quality 75 -strip'
+class AddAttachments < ActiveRecord::Migration
+  def change
+    add_column :shops, :logo, :jsonb, default: {}
+    add_column :products, :pictures, :jsonb, default: []
+  end
 end
 ```
 
-To set convert options to some styles only:
+Define the attachments in your models:
 ```ruby
-Attachs.configure do |config|
-  config.convert_options = {
-    medium: '-trim'
-  }
+class Shop < ActiveRecord::Base
+  has_attachment(
+    :logo,
+    path: ':id/:name.png',
+    default_path: 'missing.png'
+  )
 end
-```
 
-## Security
-
-To make the attachment private:
-```ruby
-class User < ActiveRecord::Base
-  has_attached_file :avatar, private: true
+class Product < ActiveRecord::Base
+  has_attachments(
+    :pictures,
+    path: ':id/:style.:extension',
+    styles: {
+      tiny: '25x25',
+      small: '150x150#',
+      medium: '300x300!',
+      large: '600x'
+    }
+  )
 end
 ```
 
-NOTE: Private attachments will be saved into /private folder.
+NOTE: The out of the box interpolations are: filename, basename, extension, attribute, content_type, size.
 
-## Validations
+### Validations
 
 To validate the presence of the attachment:
 ```ruby
 class User < ActiveRecord::Base
-  has_attached_file :avatar
-  validates_attachment_presence_of :avatar
+  has_attachment :pictures
+  validates_attachment_presence_of :pictures
 end
 ```
 
 To validate the size of the attachment:
 ```ruby
 class User < ActiveRecord::Base
-  has_attached_file :avatar
-  validates_attachment_size_of :avatar, in: 1..5.megabytes
+  has_attachment :pictures
+  validates_attachment_size_of :pictures, in: 1..5.megabytes
 end
 ```
 
 To validate the content type of the attachment:
 ```ruby
 class User < ActiveRecord::Base
-  has_attached_file :avatar
-  validates_attachment_content_type_of :avatar, with: /\Aimage/
-  # Or using a list
-  validates_attachment_content_type_of :avatar, in: %w(image/jpg image/png)
+  has_attachment :pictures
+  validates_attachment_content_type_of :pictures, with: /\Aimage/
 end
 ```
 
-## I18n
+NOTE: Look into lib/attachs/locales yamls to known the keys.
 
-To translate the messages the keys are:
-```
-errors.messages.attachment_presence
-errors.messages.attachment_size_in
-errors.messages.attachment_size_less_than
-errors.messages.attachment_size_greater_than
-errors.messages.attachment_content_type_with
-errors.messages.attachment_content_type_in
-```
-
-NOTE: Look into lib/attachs/locales yamls.
-
-## Forms
+### Forms
 
 Your forms continue to work the same:
 ```erb
-<%= form_for @user do |f| %>
-  <%= f.file_field :avatar %>
+<%= form_for @shop do |f| %>
+  <%= f.file_field :logo %>
 <% end %>
 ```
 
-## Urls
-
-The url method points to the original file:
-```erb
-<%= image_tag user.avatar.url %>
-```
-
-To point to some particular style:
+You can manage collections with fields_for:
 ```erb
-<%= image_tag user.avatar.url(:small) %>
-```
-
-The defauft url is used when there is no upload:
-```ruby
-class User < ActiveRecord::Base
-  has_attached_file :avatar, default_url: '/missing.png'
-end
-```
-
-NOTE: If storage is s3 you can pass ssl: true to force https.
-
-## Cachebuster
-
-All the urls end with a timestamp helper to prevent unwanted caching:
-```
-example.com/media/photo.jpg?1234567890
-```
-
-To disable cachebuster globally:
-```ruby
-Attachs.configure do |config|
-  config.cachebuster = false
-end
+<%= form_for @product do |f| %>
+  <%= f.fields_for :pictures do |ff| %>
+    <%= ff.file_field :value %>
+    <%= ff.number_field :position %>
+  <% end %>
+<% end %>
 ```
 
-To disable cachebuster in a model:
-```ruby
-class User < ActiveRecord::Base
-  has_attached_file :avatar, cachebuster: false
-end
-```
+### Urls
 
-To disable cachebuster for some url:
+The url method points to the original file:
 ```erb
-<%= image_tag user.avatar.url(cachebuster: false) %>
-```
-
-## Storage
-
-To override the storage in the model:
-```ruby
-class User < ActiveRecord::Base
-  has_attached_file :avatar, storage: :s3
-end
-```
-
-To configure the s3 credentials:
-```ruby
-Attachs.configure do |config|
-  config.s3 = {
-    bucket: 'xxx',
-    access_key_id: 'xxx',
-    secret_access_key: 'xxx'
-  }
-end
+<%= image_tag shop.logo.url %>
 ```
 
-## Processors
-
-To create a custom processor:
-```ruby
-class Attachs::Processors::CustomThumbnail
-
-  def initialize(attachment, source)
-    # Custom initialization
-  end
-
-  def process(style, destination)
-    # Custom logic
-  end
-
-end
+To point to some particular style:
+```erb
+<%= image_tag shop.logo.url(:small) %>
 ```
 
-To change the processors in the model:
-```ruby
-class User < ActiveRecord::Base
-  has_attached_file :avatar, processors: [:custom_thumbnail]
-end
-```
+### Tasks
 
-To change the default processors:
-```ruby
-Attachs.configure do |config|
-  config.default_processors = [:custom_thumbnail]
-end
+To reprocess all styles:
 ```
-
-## CDN
-
-To configure a cdn:
-```ruby
-Attachs.configure do |config|
-  config.base_url = 'http://cdn.example.com'
-end
+$ bundle exec rake attachs:reprocess
 ```
 
-## Tasks
-
-To refresh all the styles of some attachment:
+To fix missing styles:
 ```
-bundle exec rake attachs:refresh:all class=user attachment=avatar
+$ bundle exec rake attachs:fix_missings
 ```
 
-To refresh missing styles of some attachment:
+To remove orphan files:
 ```
-bundle exec rake attachs:refresh:missing class=user attachment=avatar
+$ bundle exec rake attachs:clear
 ```
 
 ## Credits

data/Rakefile

@@ -4,19 +4,6 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Attachs'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-
-
-
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
@@ -26,7 +13,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
+  t.warning = false
 end
 
-
 task default: :test

data/lib/attachs.rb

@@ -1,45 +1,112 @@
-require 'open3'
-require 'attachs/attachment'
+require 'attachs/extensions/active_record/validations/attachment_validator'
+require 'attachs/extensions/active_record/validations/attachment_content_type_validator'
+require 'attachs/extensions/active_record/validations/attachment_presence_validator'
+require 'attachs/extensions/active_record/validations/attachment_size_validator'
+require 'attachs/extensions/active_record/base'
+require 'attachs/jobs/base'
+require 'attachs/jobs/delete_job'
+require 'attachs/jobs/update_job'
 require 'attachs/processors/base'
-require 'attachs/processors/thumbnail'
+require 'attachs/processors/image'
 require 'attachs/storages/base'
-require 'attachs/storages/local'
 require 'attachs/storages/s3'
-require 'attachs/types/base'
-require 'attachs/types/default'
-require 'attachs/types/regular'
-require 'attachs/active_record/base'
-require 'attachs/active_record/connection_adapters'
-require 'attachs/active_record/migration'
-require 'attachs/active_record/validators'
-require 'attachs/active_record/validators/attachment_content_type_validator'
-require 'attachs/active_record/validators/attachment_presence_validator'
-require 'attachs/active_record/validators/attachment_size_validator'
+require 'attachs/attachment'
+require 'attachs/builder'
+require 'attachs/collection'
+require 'attachs/concern'
+require 'attachs/configuration'
+require 'attachs/console'
+require 'attachs/interpolations'
 require 'attachs/railtie'
+require 'attachs/version'
+require 'open3'
 
 module Attachs
   class << self
 
     def configure
-      yield config
-    end
-
-    def config
-      @config ||= begin
-        ActiveSupport::OrderedOptions.new.tap do |config|
-          config.s3 = { ssl: false }
-          config.base_url = ''
-          config.styles = {}
-          config.cachebuster = true
-          config.interpolations = {}
-          config.convert_options = {}
-          config.global_styles = []
-          config.global_convert_options= ''
-          config.default_storage = :local
-          config.default_processors = [:thumbnail]
-          config.default_path = '/:timestamp-:filename'
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def storage
+      @storage ||= Storages::S3.new
+    end
+
+    def interpolations
+      @interpolations ||= Interpolations.new
+    end
+
+    def models
+      if Rails.configuration.cache_classes == false
+        Rails.application.eager_load!
+      end
+      ActiveRecord::Base.descendants.select do |model|
+        model.included_modules.include?(Attachs::Concern) && model.descendants.none?
+      end
+    end
+
+    def each
+      models.each do |model|
+        model.find_each do |record|
+          model.attachments.each do |attribute, options|
+            yield record.send(attribute)
+          end
+        end
+      end
+    end
+
+    def exists?(path)
+      queries = models.map do |model|
+        model.attachments.map do |attribute, options|
+          joins = []
+          if options[:multiple]
+            joins << "LEFT JOIN JSONB_ARRAY_ELEMENTS(#{model.table_name}.#{attribute}) attachments ON TRUE"
+            joins << "LEFT JOIN JSONB_EACH_TEXT(attachments->'paths') paths ON TRUE"
+            joins << "LEFT JOIN JSONB_ARRAY_ELEMENTS_TEXT(attachments->'old_paths') old_paths ON TRUE"
+          else
+            joins << "LEFT JOIN JSONB_EACH_TEXT(#{model.table_name}.#{attribute}->'paths') paths ON TRUE"
+            joins << "LEFT JOIN JSONB_ARRAY_ELEMENTS_TEXT(#{model.table_name}.#{attribute}->'old_paths') old_paths ON TRUE"
+          end
+          joins = joins.join(' ')
+          conditions = ['paths.value = :path OR old_paths.value = :path', path: path]
+          model.select('1 AS one').from(model.table_name).joins(joins).where(conditions).to_sql
         end
       end
+      query = queries.flatten.join(' UNION ')
+      ActiveRecord::Base.connection.execute(query).any?
+    end
+
+    def clear
+      storage.find_each do |path|
+        unless exists?(path)
+          Rails.logger.info "Deleting #{path}"
+          storage.delete path
+        end
+      end
+    end
+
+    def reprocess
+      each do |attachment|
+        class_name = attachment.record.class.name
+        id = attachment.record.id
+        attribute = attachment.record_attribute
+        Rails.logger.info "Reprocessing #{class_name} ##{id} => #{attribute}"
+        attachment.reprocess
+      end
+    end
+
+    def fix_missings
+      each do |attachment|
+        class_name = attachment.record.class.name
+        id = attachment.record.id
+        attribute = attachment.record_attribute
+        Rails.logger.info "Fix missings of #{class_name} ##{id} => #{attribute}"
+        attachment.fix_missings
+      end
     end
 
   end