paperclip_attributes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5406db14acb8c5918106761f9003cf02aab5085
+  data.tar.gz: 3ec4152c1976a21b15f36b11465cc9f8e4bd4098
+SHA512:
+  metadata.gz: 8ec98bdf38981b16b226b55c73f73303239a60c4f4d3324bc86318b50c9d5a72c12de0af1ed7c4919ba43994e5c4f9a75387fac0f799f648a5b6307c166e589e
+  data.tar.gz: 20fece050c4b3d71d336d445ff1e6effd6597da163187d2155901c34b8bbddf96a4e91126773ac0c43f2765d25057e030dde823c2ab4e985f2ed755eb8efb72c

data/.gitignore

@@ -0,0 +1,9 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+spec/dummy/public/system/*

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require rails_helper
+--format=doc

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+### v0.1.0
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in paperclip_attributes.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/Gemfile.lock

@@ -0,0 +1,167 @@
+PATH
+  remote: .
+  specs:
+    paperclip_attributes (0.1.0)
+      miro (~> 0.3.0)
+      paperclip (~> 4.3.6)
+      rails (~> 4.2.5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.5.2)
+      actionpack (= 4.2.5.2)
+      actionview (= 4.2.5.2)
+      activejob (= 4.2.5.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.5.2)
+      actionview (= 4.2.5.2)
+      activesupport (= 4.2.5.2)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.5.2)
+      activesupport (= 4.2.5.2)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.5.2)
+      activesupport (= 4.2.5.2)
+      globalid (>= 0.3.0)
+    activemodel (4.2.5.2)
+      activesupport (= 4.2.5.2)
+      builder (~> 3.1)
+    activerecord (4.2.5.2)
+      activemodel (= 4.2.5.2)
+      activesupport (= 4.2.5.2)
+      arel (~> 6.0)
+    activesupport (4.2.5.2)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    builder (3.2.2)
+    chunky_png (1.3.5)
+    climate_control (0.0.3)
+      activesupport (>= 3.0)
+    cocaine (0.5.8)
+      climate_control (>= 0.0.3, < 1.0)
+    coderay (1.1.1)
+    color (1.8)
+    concurrent-ruby (1.0.1)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    factory_girl (4.5.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.6.0)
+      factory_girl (~> 4.5.0)
+      railties (>= 3.0.0)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.0)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0221)
+    mimemagic (0.3.0)
+    mini_portile2 (2.0.0)
+    minitest (5.8.4)
+    miro (0.3.0)
+      cocaine
+      color
+      oily_png
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    oily_png (1.2.0)
+      chunky_png (~> 1.3.1)
+    paperclip (4.3.6)
+      activemodel (>= 3.2.0)
+      activesupport (>= 3.2.0)
+      cocaine (~> 0.5.5)
+      mime-types
+      mimemagic (= 0.3.0)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.5.2)
+      actionmailer (= 4.2.5.2)
+      actionpack (= 4.2.5.2)
+      actionview (= 4.2.5.2)
+      activejob (= 4.2.5.2)
+      activemodel (= 4.2.5.2)
+      activerecord (= 4.2.5.2)
+      activesupport (= 4.2.5.2)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.5.2)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.5.2)
+      actionpack (= 4.2.5.2)
+      activesupport (= 4.2.5.2)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (11.1.2)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-rails (3.4.2)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    slop (3.6.0)
+    sprockets (3.6.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.0.4)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.11)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  factory_girl_rails (~> 4.6.0)
+  paperclip_attributes!
+  pry
+  rspec-rails (~> 3.4.0)
+  sqlite3
+
+BUNDLED WITH
+   1.11.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Platanus
+
+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

@@ -0,0 +1,105 @@
+# Paperclip Attributes
+
+Rails Engine built on top of [Paperclip](https://github.com/thoughtbot/paperclip) gem to add attributes, as columns in your models, related to your attachments.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "paperclip_attributes"
+```
+
+```bash
+bundle install
+```
+
+## Usage
+
+To add new attributes, you need to run the following generator:
+
+```
+rails g paperclip_attributes Model attachment recipe1 recipe2
+```
+
+* `Model`: is the Active Record model containing the attachment you want to add attributes.
+* `attachment`: is the paperclip's attachment name on given model.
+* `recipes (recipe1 recipe2)`: is a list of recipes to extend the attachment. A recipe represents one or more attributes related to the attachment param. You can see a full list of recipes on the section below.
+
+The generator, will only create migrations to extend your attachments. So, after run it, you need to do:
+
+```
+rake db:migrate
+```
+
+Then, to enable the functionality in your model, you need to add the recipes to the attachment definition:
+
+```ruby
+class MyModel < ActiveRecord::Base
+  has_attached_file :attachment, attributes: [:recipe1, :recipe2]
+end
+```
+
+That's it!
+
+The process to extract attributes will be done on `before_save` callback.
+
+## Example
+
+```
+rails g paperclip_attributes User avatar dimensions color
+```
+
+In `User` model:
+
+```ruby
+class User < ActiveRecord::Base
+  has_attached_file :avatar, attributes: [:dimensions, :color]
+end
+```
+
+Then, with an `User` instance, you'll be able to do something like this:
+
+```ruby
+user = User.new
+user.avatar = some_file
+user.save!
+
+user.avatar_height #=> 200
+user.avatar_width #=> 400
+user.avatar_dominant_color #=> "#FF9900"
+
+```
+
+## Recipes
+
+### For images:
+
+#### `dimensions`:
+
+* `[attachment]_width`: the original width of the image.
+* `[attachment]_height`: the original height of the image.
+
+#### `color`:
+
+* `[attachment]_dominant_color`: the predominant color of the image.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits
+
+Thank you [contributors](https://github.com/platanus/paperclip_attributes/graphs/contributors)!
+
+<img src="http://platan.us/gravatar_with_text.png" alt="Platanus" width="250"/>
+
+Paperclip Attributes is maintained by [platanus](http://platan.us).
+
+## License
+
+Paperclip Attributes is © 2016 platanus, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.

data/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require 'bundler/setup'
+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    = 'PaperclipAttributes'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks

data/bin/rails

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/paperclip_attributes/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/generators/paperclip_attributes/USAGE

@@ -0,0 +1,17 @@
+Description:
+  This generator adds to a model's paperclip attachment the attributes passed as params.
+  - model: is the Active Record model containing the attachment you want to add attributes.
+  - attachment: is the paperclip's attachment on given model.
+  - recipes: is a list of recipes to extend the attachment. A recipe represents one or more attributes related to the attachment param.
+
+Example:
+  rails generate paperclip_attributes User avatar dimensions
+
+  This will create a migration at db/migrate like this:
+
+    class AddAvatarDimensionsToUsers < ActiveRecord::Migration
+      def change
+        add_column :users, :width, :integer
+        add_column :users, :height, :integer
+      end
+    end

data/lib/generators/paperclip_attributes/paperclip_attributes_generator.rb

@@ -0,0 +1,34 @@
+class PaperclipAttributesGenerator < Rails::Generators::Base
+  VALID_ATTRIBUTES = %w(dimensions color).freeze
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  argument :model, required: true, banner: "model"
+  argument :attachment, required: true, banner: "attachment"
+  argument :recipes, required: true, type: :array, banner: "recipe_one recipe_two..."
+
+  def generate_migration
+    generate "migration #{migration_name} #{migration_attributes}"
+  end
+
+  private
+
+  def migration_attributes
+    recipes.inject({}) do |result, attribute|
+      fail "Invalid attribute given" unless VALID_ATTRIBUTES.include?(attribute)
+      case attribute.to_sym
+      when :dimensions then result[:width] = result[:height] = :integer
+      when :color then result[:dominant_color] = :string
+      end
+      result
+    end.map { |k, v| "#{attachment}_#{k}:#{v}" }.join(" ")
+  end
+
+  def migration_name
+    "add_#{attachment}_#{recipes.join('_')}_to_#{table_name}"
+  end
+
+  def table_name
+    model.underscore.pluralize
+  end
+end

data/lib/paperclip/has_attached_file_override.rb

@@ -0,0 +1,21 @@
+module ::Paperclip
+  module ClassMethods
+    def has_attached_file(name, options = {})
+      add_attachment_attributes(name, options)
+      HasAttachedFile.define_on(self, name, options)
+    end
+
+    def add_attachment_attributes(name, options)
+      @attachmets_recipes ||= {}
+      @attachmets_recipes[name.to_sym] = options.fetch(:attributes, [])
+    end
+
+    def attachmets_recipes
+      @attachmets_recipes
+    end
+
+    def attachments_names
+      attachmets_recipes.keys
+    end
+  end
+end

data/lib/paperclip_attributes/attributes.rb

@@ -0,0 +1,34 @@
+module PaperclipAttributes
+  module Attributes
+    extend ActiveSupport::Concern
+
+    RECIPES = {
+      color: PaperclipAttributes::Commands::AddPhotoDominantColor,
+      dimensions: PaperclipAttributes::Commands::AddPhotoDimensions
+    }
+
+    included do
+      def changed_attachments_names
+        self.class.attachments_names.select do |column|
+          send("#{column}_updated_at_changed?")
+        end
+      end
+
+      def execute_attachment_recipes(attachment)
+        self.class.attachmets_recipes[attachment].each do |recipe|
+          cmd = RECIPES[recipe]
+          raise PaperclipAttributes::Error::UnknownRecipe.new unless cmd
+          cmd.new(self, attachment).perform
+        end
+      end
+
+      before_save do
+        changed_attachments_names.each do |changed_attachment|
+          execute_attachment_recipes(changed_attachment)
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, PaperclipAttributes::Attributes)

data/lib/paperclip_attributes/command.rb

@@ -0,0 +1,44 @@
+module PaperclipAttributes
+  module Command
+    extend ActiveSupport::Concern
+
+    included do
+      attr_reader :model, :column
+
+      def initialize(model, column)
+        @model = model
+        @column = column
+      end
+
+      def perform
+        raise PaperclipAttributes::Error::PerformNotImplemented.new
+      end
+
+      def image?
+        content_type = model.send("#{column}_content_type")
+        content_type =~ %r{^(image|(x-)?application)/(bmp|gif|jpeg|jpg|pjpeg|png|x-png)$}
+      end
+
+      def with_tempfile(&block)
+        tempfile = model.send(column).queued_for_write[:original]
+        return if tempfile.nil?
+        block.call(tempfile)
+      end
+
+      def with_img_tempfile(&block)
+        return unless image?
+        with_tempfile(&block)
+      end
+
+      def set_attribute(attribute, value)
+        writter_method = "#{column}_#{attribute}="
+
+        if !model.respond_to?(writter_method)
+          raise PaperclipAttributes::Error::AttributeNotFound.new
+        end
+
+        model.send(writter_method, value)
+      end
+    end
+  end
+end

data/lib/paperclip_attributes/commands/add_photo_dimensions.rb

@@ -0,0 +1,27 @@
+module PaperclipAttributes
+  module Commands
+    class AddPhotoDimensions
+      include PaperclipAttributes::Command
+
+      def perform
+        dimensions = extract_dimensions
+        add_dimensions_to_model(dimensions)
+      end
+
+      private
+
+      def extract_dimensions
+        with_img_tempfile do |tempfile|
+          geometry = Paperclip::Geometry.from_file(tempfile)
+          { width: geometry.width.to_i, height: geometry.height.to_i }
+        end
+      end
+
+      def add_dimensions_to_model(dimensions)
+        return unless dimensions
+        set_attribute(:width, dimensions[:width])
+        set_attribute(:height, dimensions[:height])
+      end
+    end
+  end
+end

data/lib/paperclip_attributes/commands/add_photo_dominant_color.rb

@@ -0,0 +1,35 @@
+module PaperclipAttributes
+  module Commands
+    class AddPhotoDominantColor
+      include PaperclipAttributes::Command
+
+      def perform
+        color = calculate_dominant_color
+        set_attribute(:dominant_color, color)
+      end
+
+      private
+
+      def calculate_dominant_color
+        with_img_tempfile do |tempfile|
+          Miro.options[:color_count] = 1
+          Miro.options[:method] = "histogram"
+          colors = Miro::DominantColors.new(tempfile.path)
+          lighten_color(colors.to_hex.first)
+        end
+      rescue
+        nil
+      end
+
+      def lighten_color(hex_color, amount = 0.2)
+        hex_color.delete!("#")
+
+        rgb = hex_color.scan(/../).map(&:hex).map do |color|
+          [(color.to_i + 255 * amount).round, 255].min
+        end
+
+        "#%02x%02x%02x" % rgb
+      end
+    end
+  end
+end

data/lib/paperclip_attributes/engine.rb

@@ -0,0 +1,15 @@
+module PaperclipAttributes
+  class Engine < ::Rails::Engine
+    config.generators do |g|
+      g.test_framework false
+    end
+
+    initializer "initialize" do
+      require_relative "./error"
+      require_relative "./command"
+      require_relative "./commands/add_photo_dimensions"
+      require_relative "./commands/add_photo_dominant_color"
+      require_relative "./attributes"
+    end
+  end
+end

data/lib/paperclip_attributes/error.rb

@@ -0,0 +1,21 @@
+module PaperclipAttributes
+  module Error
+    class UnknownRecipe < Exception
+      def initialize
+        super("the given recipe is invalid")
+      end
+    end
+
+    class AttributeNotFound < Exception
+      def initialize
+        super("you need to execute the paperclip_attributes generator with recipes you need")
+      end
+    end
+
+    class PerformNotImplemented < Exception
+      def initialize
+        super("override perform method in host class")
+      end
+    end
+  end
+end

data/lib/paperclip_attributes/version.rb

@@ -0,0 +1,3 @@
+module PaperclipAttributes
+  VERSION = "0.1.0"
+end

data/lib/paperclip_attributes.rb

@@ -0,0 +1,7 @@
+require "paperclip"
+require "miro"
+require "paperclip_attributes/engine"
+require_relative "./paperclip/has_attached_file_override"
+
+module PaperclipAttributes
+end

data/lib/tasks/paperclip_attributes_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :paperclip_attributes do
+#   # Task goes here
+# end