has-imgix-attachment 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24496d71ccc8016329b19bcc8a99cb4a0f6c8624
+  data.tar.gz: e0f03d6e4e906c0e380fb438ff7222092d0aa80d
+SHA512:
+  metadata.gz: e1eb677b7ee1faf5edfc8a3e3f4b2c0e9e71f4d4bf5fdcfa568ad6208403351e9d89ab67291e72272c844571e882f85e839926aa1c70369920daa3682810a89f
+  data.tar.gz: a53c6db47b61b8a98a2e431c1c70c0280ac255d016039929757c1ee405f7b183441e297186f5dd3d0a519430ba0240350b79193cadf97f3960b971bfb9ec3b86

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in imgix.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ryan Abbott
+
+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,79 @@
+# has-imgix-attachment
+
+has-imgix-attachment allows you to easier work with the [imgix](http://www.imgix.com/) API through model defined attributes for easier retrieval.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'has-imgix-attachment'
+
+And then execute:
+
+    $ bundle
+
+## Model Configuration
+
+To add imgix to your model, you simply need to call the `has-imgix-attachment` method on your model.
+
+```ruby
+class Post < ActiveRecord::Base
+  has_imgix_attachment :photo,
+    :subdomain => "imgix-subdomain",
+    :default   => "default.png",
+    :prefix    => "photos",
+    :styles =>  {
+      :thumbnail  => {
+        :h    => 90,
+        :w    => 110,
+        :fit  => "crop"
+      },
+      :large  => {
+        :h    => 480,
+        :w    => 640,
+        :fit  => "crop"
+      }
+    }
+end
+```
+
+The `has-imgix-attachment` method will take accept a name, and a list of options. The first value is the name and of the field that we'll create (which can also be referenced with `imgix_attachment`). Below is a list of valid options that can follow the name.
+
+### Options
+
+* `subdomain` - Subdomain defined within your imgix account
+* `default` - Name of the image to be used as a default image (must appear in the bucket with all other images)
+* `prefix` - If your bucket has folders, supply the folder name here
+* `filename_field` - Override the default column name for the image filename. Default: **filename**
+* `file_size_field` - Override the default column name for the image file size. Default: **file_size**
+* `content_type_field` - Override the default column name for the image content type. Default: **content_type**
+* `styles` - Hash that defines all the variations of the image you'd like to be able to refer to
+
+**NOTE:** Examples of the model configurations can be found in the [`spec/support/models.rb`](spec/support/models.rb) file.
+
+## Usage
+
+The gem comes with a view helper ``imgix_tag`` which is just an extension of the ``image_tag``.
+
+```ruby
+<%= imgix_tag(@post.photo, "large") %>
+```
+will generate the same thing as, just a less verbose shortcut
+```ruby
+<%= imgix_tag(@post.imgix_attachment, "large") %>
+```
+
+imgix_tag will accept all the same additional options that image_tag supports
+
+## 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'`)
+    * Please make sure to include the appropriate specs
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+See [LICENSE.txt](LICENSE.txt).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "imgix"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/imgix.rb

@@ -0,0 +1,12 @@
+require "imgix/version"
+require 'imgix/config'
+require 'imgix/style'
+require 'imgix/attachment'
+require 'imgix/model_extensions'
+require 'imgix/instance_methods'
+require 'imgix/action_view/helpers'
+require 'imgix/railtie' if defined? Rails
+
+
+module Imgix
+end

data/lib/imgix/action_view/helpers.rb

@@ -0,0 +1,19 @@
+module Imgix
+  module ActionView
+    module Helpers
+      # Simple image_tag override that uses imgix as the source
+      def imgix_tag(object, style, html_options = {})
+        image_tag(imgix_url(object, style), html_options)
+      end
+
+      # Helper that will return only a url
+      def imgix_url(object, style)
+        if object && object.respond_to?('url')
+          object.url(style)
+        else
+          Attachment.url(object, style)
+        end
+      end
+    end
+  end
+end

data/lib/imgix/attachment.rb

@@ -0,0 +1,89 @@
+module Imgix
+  class Attachment
+    attr_reader :name, :instance, :options, :styles
+
+    def initialize(name, instance, options = {})
+      @name     = name
+      @instance = instance
+      @options  = options
+    end
+
+    # generate the full imgix url for the provided style
+    def url(style = nil)
+      # construct the pieces of the url
+      full_url = [@instance.base_url, @options[:prefix], filename].compact.join("/")
+
+      # append imgix params to the filename before returning
+      styled_filename(full_url, style)
+    end
+
+    def self.url(filename, style)
+      # url including source previx
+      full_url = [@instance.base_url, @options[:prefix], filename].compact.join("/")
+
+      # add the style options and return
+      styled_filename(full_url, style)
+    end
+
+    # Determine the field/column name to find the filename in
+    def filename_field
+      @options.fetch(:filename_field, "filename")
+    end
+
+    # Determine the field/column name to find the content_type in
+    def content_type_field
+      @options.fetch(:content_type_field, "content_type")
+    end
+
+    # Determine the field/column name to find the file size in
+    def file_size_field
+      @options.fetch(:file_size_field, "file_size")
+    end
+
+    # Retrieve the filename from the instance provided
+    def filename
+      # attempt to get the value from the database, but fall back
+      # to a default image supplied
+      @instance.send(self.filename_field) || @options[:default]
+    end
+
+    # Retrieve the content type from the instance provided
+    def content_type
+      @instance.send(self.content_type_field)
+    end
+
+    # Retrieve the file_size from the instance provided
+    def file_size
+      @instance.send(self.file_size_field)
+    end
+
+    # Append query parameters to the filename of this attachment
+    def styled_filename(url, style)
+      if style.present? && self.styles.include?(style.to_sym)
+        return [url, self.style(style).to_s].join("?")
+      end
+
+      # default to the basic url, without any options
+      return url
+    end
+
+    # Retrieve a particular style of this attachment
+    def style(style = nil)
+      # look for the provided style, return an empty has by default
+      self.styles.fetch(style.to_sym, {})
+    end
+
+    # Retrieve all styles provided for this attachment
+    def styles
+      # initialize an empty hash
+      styles = {}
+
+      @options.fetch(:styles, {}).each_pair do |name, options|
+        styles[name.to_sym] = Imgix::Style.new(name, self, options)
+      end
+
+      # returns the hash of Imgix::Style objects
+      styles
+    end
+  end
+end

data/lib/imgix/config.rb

@@ -0,0 +1,41 @@
+module Imgix
+    class Config
+        DEFAULT_IMGIX_ATTACHMENT_ATTR = :photo
+        DEFAULT_IMGIX_PROTOCOL = "https"
+        DEFAULT_IMGIX_BASE_URL = "imgix.net"
+
+        attr_reader :base_url, :subdomain, :protocol
+
+        def field_name(name = nil)
+            if name.nil?
+                @field_name || Imgix::Config::DEFAULT_IMGIX_ATTACHMENT_ATTR
+            else
+                @field_name = name
+            end
+        end
+
+        def base_url(url = nil)
+            if url.nil?
+                @base_url || Imgix::Config::DEFAULT_IMGIX_BASE_URL
+            else
+                @base_url = url
+            end
+        end
+
+        def subdomain(_subdomain = nil)
+            if _subdomain.nil?
+                @subdomain || Imgix::Config::DEFAULT_IMGIX_PROTOCOL
+            else
+                @subdomain = _subdomain
+            end
+        end
+
+        def protocol(_protocol = nil)
+            if _protocol.nil?
+                @protocol || Imgix::Config::DEFAULT_IMGIX_PROTOCOL
+            else
+                @protocol = _protocol
+            end
+        end
+    end
+end

data/lib/imgix/instance_methods.rb

@@ -0,0 +1,18 @@
+module Imgix
+  module InstanceMethods
+    # def attachment_for(name, options)
+    #   @_attachments ||= {}
+    #   @_attachments[name] ||= Imgix::Attachment.new(name, self, options)
+    # end
+
+    # Detrmine the base url given the imgix configurations
+    def base_url
+        url = URI::Generic.build(
+            scheme: self.class.imgix_config.protocol(),
+            host: [self.class.imgix_config.subdomain(), self.class.imgix_config.base_url()].join(".")
+        )
+
+        return url
+    end
+  end
+end

data/lib/imgix/model_extensions.rb

@@ -0,0 +1,41 @@
+require 'active_support/concern'
+
+module Imgix
+  module ModelExtensions
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def imgix_config
+        @imgix_config ||= Imgix::Config.new
+      end
+
+      def has_imgix_attachment(name, options = {})
+        include InstanceMethods
+
+        imgix_config.base_url(options.delete(:base_url))
+        imgix_config.protocol(options.delete(:protocol))
+        imgix_config.subdomain(options.delete(:subdomain))
+
+        define_method(name) do |*args|
+          a = Imgix::Attachment.new(name, self, options)
+        end
+
+        # simple helper method to use instead of having to use
+        # the name provided
+        define_method("imgix_attachment") do ||
+          self.send(name)
+        end
+
+        # Define how the setter of our attachment works
+        # define_method "#{name}=" do |file|
+        #   attachment_for(name).assign(file)
+        # end
+
+        # Determine if the attachment is valid
+        # define_method "#{name}?" do
+        #   attachment_for(name).file?
+        # end
+      end
+    end
+  end
+end

data/lib/imgix/railtie.rb

@@ -0,0 +1,13 @@
+module Imgix
+  class Railtie < ::Rails::Railtie
+    initializer 'imgix.model_additions' do
+      ActiveSupport.on_load(:active_record) do
+        include Imgix::ModelExtensions
+      end
+
+      ActiveSupport.on_load(:action_view) do
+        include Imgix::ActionView::Helpers
+      end
+    end
+  end
+end

data/lib/imgix/style.rb

@@ -0,0 +1,32 @@
+module Imgix
+  class Style
+    attr_reader :name, :options
+
+    VALID_PARAMS = [:auto, :bg, :blend, :blendalign, :blendalpha,
+      :blendcrop, :blendfit, :blendheight, :blendmode, :blendpadding,
+      :blendsize, :blendwidth, :blur, :border, :bri, :colors, :con,
+      :crop, :dl, :dpr, :exp, :fit, :flip, :fm, :gam, :h, :high, :htn,
+      :hue, :invert, :mark, :markalign, :markfit, :markh, :markpad,
+      :markscale, :markw, :mask, :mono, :nr, :nrs, :or, :page, :palette,
+      :prefix, :px, :q, :rect, :rot, :sat, :sepia, :shad, :sharp, :txt,
+      :txtalign, :txtclip, :txtclr, :txtfit, :txtfont, :txtline, :txtlineclr,
+      :txtpad, :txtshad, :txtsize, :txtwidth, :vib, :w]
+
+    def initialize(name, attachment, options = {})
+      @name       = name
+      @attachment = attachment
+      @options    = options
+      if @options.is_a?(Hash)
+        @options = @options.delete_if {|k, v| !Imgix::Style.is_param_valid?(k) }
+      end
+    end
+
+    def to_s
+      self.options.to_param
+    end
+
+    def self.is_param_valid?(param)
+      VALID_PARAMS.include?(param.to_sym)
+    end
+  end
+end

data/lib/imgix/version.rb

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

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: has-imgix-attachment
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Abbott
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rake
+  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: database_cleaner
+  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: pry
+  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: rack
+  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: capybara
+  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-rails
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem to assist with the display of imgix images
+email:
+- ryan@lateralventures.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/imgix.rb
+- lib/imgix/action_view/helpers.rb
+- lib/imgix/attachment.rb
+- lib/imgix/config.rb
+- lib/imgix/instance_methods.rb
+- lib/imgix/model_extensions.rb
+- lib/imgix/railtie.rb
+- lib/imgix/style.rb
+- lib/imgix/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []