attachs 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4b7e169e9f30ad2bf78cb7f234ff71814200ad6
-  data.tar.gz: b8a1b2b599f222bf759809834c9e492389629ef0
+  metadata.gz: 174763ef00e837f637a02dadcf2c6e732304c911
+  data.tar.gz: 543f20a4cfbc0097daa613ec66bf31459191c260
 SHA512:
-  metadata.gz: 2ab3ab663652618fbe9bf500def726a1f101bbb695d7a7bd6ba30b57963fe1b4d2f6b3892d974764b850c53c5f9b0c08b6903acdd782a6e8ad3e258372a27c02
-  data.tar.gz: 45bf708582744d4c012e5b739f921a3c1fc72e4ec2824516dbf9dfa0be08d185956e952f7159f9f25755ca977a343534e3854567be38a598ab8ffaf50e68eb20
+  metadata.gz: 5fc324cf2d3df019d8d37501e9af50eb1169d3e88b6ba11c6be97afdfd22377d3dd8391e03fb170d051f852b1116da68ce195de93d22bab1f98edf5986bee561
+  data.tar.gz: a57ec77ecc61acebed6512bce22a18c0152fc26b9f488f86daeed88f055e44b4284388644bba3ef7500eeecb7f99469e86f94435a356c627b1f77f99800f4c94

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2013 Mattways
+Copyright 2014 Museways
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,254 @@
+[![Gem Version](https://badge.fury.io/rb/attachs.svg)](http://badge.fury.io/rb/attachs) [![Code Climate](https://codeclimate.com/github/museways/attachs/badges/gpa.svg)](https://codeclimate.com/github/museways/attachs) [![Build Status](https://travis-ci.org/museways/attachs.svg?branch=master)](https://travis-ci.org/museways/attachs)
+
+# Attachs
+
+Minimalistic toolkit to attach files to records.
+
+## Install
+
+Put this line in your Gemfile:
+```ruby
+gem 'attachs'
+```
+
+Then bundle:
+```
+$ bundle
+```
+
+NOTE: ImageMagick is needed.
+
+## Configuration
+
+Generate the configuration file:
+```
+rails g attachs:install
+```
+
+The defaults values are:
+```ruby
+Attachs.configure do |config|
+  config.styles = {}
+  config.interpolations = {}
+  config.global_styles = []
+  config.global_convert_options= ''
+  config.convert_options = {}
+  config.default_storage = :local
+  config.default_path = '/:timestamp-:filename'
+  config.base_url = ''
+  config.s3 = { ssl: false }
+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
+
+To customize the path to some model:
+```ruby
+class User < ActiveRecord::Base
+  has_attached_file :avatar, path: '/:type/:timestamp/:filename'
+end
+```
+
+To create custom interpolations:
+```ruby
+Attachs.configure do |config|
+  config.interpolations = {
+    category: -> (attachment) { attachment.record.category }
+  }
+end
+```
+
+NOTE: Look into lib/attachs/storages/base.rb to find a list of the system interpolations.
+
+## Styles
+
+Define the styles of the attachment:
+```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
+```
+
+Then reference them in your model:
+```ruby
+class User < ActiveRecord::Base
+  has_attached_file :avatar, styles: [:small, :medium]
+end
+```
+
+To set styles for all attachments:
+```ruby
+Attachs.configure do |config|
+  config.global_styles = [:big]
+end
+```
+
+## Convert
+
+To define global convert options:
+```ruby
+Attachs.configure do |config|
+  config.global_convert_options = '-quality 75 -strip'
+end
+```
+
+To set convert options to some styles only:
+```ruby
+Attachs.configure do |config|
+  config.convert_options = {
+    medium: '-trim'
+  }
+end
+```
+
+## Security
+
+To make the attachment private:
+```ruby
+class User < ActiveRecord::Base
+  has_attached_file :avatar, private: true
+end
+```
+
+NOTE: Private attachments will be saved into /private folder.
+
+## Validations
+
+To validate the presence of the attachment:
+```ruby
+class User < ActiveRecord::Base
+  has_attached_file :avatar
+  validates_attachment_presence_of :avatar
+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
+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)
+end
+```
+
+## I18n
+
+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
+
+Your forms continue to work the same:
+```erb
+<%= form_for @user do |f| %>
+  <%= f.file_field :avatar %>
+<% end %>
+```
+
+## Urls
+
+The url method points to the original file:
+```erb
+<%= image_tag user.avatar.url %>
+```
+
+To point to some particular style:
+```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.
+
+## 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
+```
+
+## CDN
+
+To configure a cdn:
+```ruby
+Attachs.configure do |config|
+  config.base_url = 'http://cdn.example.com'
+end
+```
+
+## Tasks
+
+To refresh all the styles of some attachment:
+```
+bundle exec rake attachs:refresh:all CLASS=User ATTACHMENT=avatar
+```
+
+To refresh missing styles of some attachment:
+```
+bundle exec rake attachs:refresh:missing CLASS=User ATTACHMENT=avatar
+```
+
+## Credits
+
+This gem is maintained and funded by [museways](http://museways.com).
+
+## License
+
+It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/Rakefile

@@ -14,8 +14,6 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
 
 
 

data/lib/attachs.rb

@@ -1,16 +1,43 @@
-require 'attachs/active_record/base'
-require 'attachs/magick/image'
+require 'open3'
+require 'attachs/attachment'
+require 'attachs/tools/magick'
+require 'attachs/storages/base'
 require 'attachs/storages/local'
 require 'attachs/storages/s3'
-require 'attachs/types/file'
-require 'attachs/types/image'
-require 'attachs/validators/base'
-require 'attachs/validators/attachment_content_type_validator'
-require 'attachs/validators/attachment_presence_validator'
-require 'attachs/validators/attachment_size_validator'
-require 'attachs/engine'
+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/railtie'
-require 'attachs/version'
 
 module Attachs
+  class << self
+
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= begin
+        ActiveSupport::OrderedOptions.new.tap do |config|
+          config.styles = {}
+          config.interpolations = {}
+          config.global_styles = []
+          config.global_convert_options= ''
+          config.convert_options = {}
+          config.default_storage = :local
+          config.default_path = '/:timestamp-:filename'
+          config.base_url = ''
+          config.s3 = { ssl: false }
+        end
+      end
+    end
+
+  end
 end

data/lib/attachs/active_record/base.rb

@@ -5,136 +5,99 @@ module Attachs
 
       protected
 
-      attr_reader :stored_attachments, :deleted_attachments
-
       def attachments
-        @attachments ||= {}
-      end
-      
-      def add_attachment(attr, value, options)
-        attachment = build_attachment_instance(value, options)
-        attachments[attr] = attachment
-        write_attribute attr, attachment.filename 
+        @attachments ||= {}.tap do |instances|
+          self.class.attachments.each do |attr, options|
+            instances[attr] = Attachs::Attachment.new(self, attr, options)
+          end
+        end
       end
 
-      def get_attachment(attr, options)
-        return attachments[attr] if attachments.has_key? attr
-        return nil unless read_attribute(attr) or options.has_key? :default
-        attachments[attr] = build_attachment_instance(read_attribute(attr), options)
+      def queued_attachments
+        @queued_attachments ||= { process: {}, destroy: {} }
       end
 
-      def remove_attachment(attr)
-        write_attribute attr, nil
+      def queue_attachment(attr, options, value)
+        unless queued_attachments[:destroy].has_key? attr
+          queued_attachments[:destroy][attr] = attachments[attr]
+        end
+        if queued_attachments[:process].has_key? attr and value.nil?
+          attachments[attr]
+        else
+          queued_attachments[:process][attr] = Attachs::Attachment.new(self, attr, options, value)
+        end
       end
 
-      def build_attachment_instance(source, options)
-        klass = options.has_key?(:type) ? options[:type].to_s.classify : 'File'
-        Attachs::Types.const_get(klass).new source, options
-      end
-      
-      def check_changed_attachments
-        @stored_attachments = []
-        @deleted_attachments = []
+      def commit_attachments
         self.class.attachments.each do |attr, options|
-          if changed_attributes.has_key? attr.to_s
-            stored = attributes[attr.to_s]
-            deleted = changed_attributes[attr.to_s]
-            add_changed_attachment stored, options, :stored if stored.present?
-            add_changed_attachment deleted, options, :deleted if deleted.present?
-          end
+          send "destroy_#{attr}=", nil
         end
-      end
-      
-      def iterate_attachments
-        self.class.attachments.each do |attr, options|
-          next unless instance = send(attr)
-          yield instance
+        queued_attachments[:destroy].each do |attr, attachment|
+          attachment.destroy
         end
-      end
-      
-      def add_changed_attachment(source, options, type)
-        (type == :stored ? stored_attachments : deleted_attachments) << (source.is_a?(String) ? build_attachment_instance(source, options) : source)
-      end
-      
-      def store_attachments
-        iterate_attachments { |a| a.store }
+        queued_attachments[:process].each do |attr, attachment|
+          attachment.process
+        end
+        queued_attachments[:destroy] = {}
+        queued_attachments[:process] = {}
       end
 
-      def delete_attachments
-        iterate_attachments { |a| a.delete }
-      end
-      
-      def remove_stored_attachments
-        stored_attachments.each { |a| a.delete }
+      def destroy_attachments
+        self.class.attachments.each do |attr, options|
+          send(attr).destroy
+        end
       end
-   
-      def remove_deleted_attachments
-        deleted_attachments.each { |a| a.delete }
-      end   
 
       module ClassMethods
 
-        [:file, :image].each do |type|
-          name = :"has_attached_#{type}"
-          define_method name do |*args|
-            options = args.extract_options!
-            options[:type] = type
-            define_attachment *args.map(&:to_sym).append(options)
+        def has_attached_file(*args)
+          options = args.extract_options!
+          unless attachable?
+            make_attachable
+          end
+          args.each do |attr|
+            define_attachment_methods attr, options
+            attachments[attr] = options
           end
-          alias_method :"attached_#{type}", name
         end
 
-        attr_reader :attachments
-    
-        def inherited(subclass)
-          subclass.instance_variable_set :@attachments, @attachments
-          super
+        def attachments
+          @attachments ||= {}
         end
 
         def attachable?
-          attachments.present?
+          attachments.any?
         end
 
-        protected
-        
-        def define_attachment(*args)
-          options = args.extract_options!
-          make_attachable unless attachable?
-          args.each do |attr|
-            define_attachment_attribute_methods attr, options
-            define_attachment_default_validations attr, options
-            attachments[attr] = options
-          end
+        def inherited(subclass)
+          subclass.instance_variable_set :@attachments, @attachments
+          super
         end
 
+        protected
+
         def make_attachable
-          before_save :store_attachments, :check_changed_attachments
-          after_save :remove_deleted_attachments
-          before_destroy :delete_attachments           
-          after_rollback :remove_stored_attachments 
-          @attachments = {}
+          after_save :commit_attachments
+          after_destroy :destroy_attachments
         end
 
-        def define_attachment_attribute_methods(attr, options)
+        def define_attachment_methods(attr, options)
           define_method "#{attr}=" do |value|
-            add_attachment attr, value, options if value.is_a? ActionDispatch::Http::UploadedFile or value.is_a? Rack::Test::UploadedFile
+            attachments[attr] = queue_attachment(attr, options, value)
           end
           define_method attr do
-            get_attachment attr, options
-          end 
-          define_method "delete_#{attr}=" do |value|
-            remove_attachment attr if value == '1'
-            instance_variable_set :"@delete_#{attr}", value
+            attachments[attr]
+          end
+          attr_reader "destroy_#{attr}"
+          define_method "destroy_#{attr}=" do |value|
+            instance_variable_set "@destroy_#{attr}", value
+            if [1, '1', true].include?(value) and !send(attr).upload?
+              send "#{attr}=", nil
+            end
           end
-          attr_reader :"delete_#{attr}"
-        end
-        
-        def define_attachment_default_validations(attr, options)
-          default_validations = Rails.application.config.attachs.default_validations[options[:type]]
-          validates attr, default_validations.dup if default_validations.present?
         end
 
-      end    
+      end
     end
   end
 end