artwork 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+.ruby-version

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Dimitar Dimitrov
+
+MIT License
+
+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,85 @@
+# Artwork
+
+Automated image size scaling view helpers for your frontend, but done in the
+backend. Works for any browser. Delivers the information needed for the
+calculations (browser window's dimentions and device's pixel ratio) via a
+cookie. Supports only Paperclip attachments.
+
+Example usage:
+
+    <%= artwork_tag person, :avatar, '100x' %>
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'artwork'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install artwork
+
+Add the following in your `application.js` manifest:
+
+    //= require artwork
+
+If you're using an older version of Rails which does not support the asset
+pipeline, run the following command from within the app to copy the necessary
+asset files in your `public/` folder first:
+
+    ./script/generate artwork_assets
+
+And then manually include them with `javascript_include_tag` in your layout(s).
+
+## Configuration
+
+Set the following variables in an app initializer:
+
+- `Artwork.supported_resolutions_list`
+- `Artwork.default_resolution`
+
+Name your Paperclip attachment styles using the following convention:
+
+    :'320x'
+    :'320x_2x'
+    :'320x_some_label'
+    :'320x_some_label_2x'
+    :'320x500'
+    :'320x500_2x'
+    :'320x500_crop'
+    :'320x500_crop_2x'
+    :'320x500_black_and_white_crop'
+    :'320x500_black_and_white_crop_2x'
+
+The artwork methods will recognize and work with these styles. All other naming
+conventions will be ignored and will bypass the artwork auto-sizing logic.
+
+## Usage Example
+
+Configure the gem by putting the following code in `config/initializers/artwork.rb`:
+
+    Artwork.default_resolution = 1440
+    Artwork.supported_resolutions_list = [1024, 1280, 1440, 1600, 1920, 2048, 3200, 3840]
+
+Include `Artwork::Model` in your models which have artworks.
+
+Include `Artwork::Model` in your `ApplicationController` or wherever you want
+to have the artwork functionality.
+
+Then you can use `Artwork.load_2x_images?`, `Artwork.current_resolution` and
+the `artwork_tag` view helper. Example:
+
+    <%= artwork_tag @film, :board, :'1440x', :image => {:class => 'poster'} %>
+    <%= artwork_tag @gallery, :cover, :'900x' %>
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/artwork/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/artwork.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'artwork/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'artwork'
+  spec.version       = Artwork::VERSION
+  spec.authors       = ['Dimitar Dimitrov']
+  spec.email         = ['dimitar@live.bg']
+  spec.summary       = 'Automated image size scaling view helpers.'
+  spec.description   = 'Works for any browser and uses cookies for transporting browser info to the backend.'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+
+  spec.add_dependency 'rails', '>= 2.3'
+  spec.add_dependency 'paperclip', '>= 2.3'
+end

data/generators/artwork/USAGE

@@ -0,0 +1,7 @@
+Usage:
+
+  script/generate artwork_assets
+
+Copy the necessary artwork static files to your public directory. Use only with
+Rails versions without the Asset pipeline. For Rails 3.1 and newer the assets
+are available via the pipeline.

data/generators/artwork/artwork_assets_generator.rb

@@ -0,0 +1,26 @@
+require 'fileutils'
+
+class ArtworkAssetsGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      has_assets = begin
+        Rails.configuration.assets
+      rescue
+        nil
+      end
+
+      if has_assets
+        puts <<-MESSAGE
+          The version of Rails you're using (#{Rails.version}) supports
+          the asset pipeline and the required assets will be automatically
+          available for your app. You just need to require them in your
+          manifest files. See how in the readme.
+        MESSAGE
+      else
+        assets_root = File.expand_path('../../../lib/assets', __FILE__)
+        FileUtils.cp_r Dir.glob("#{assets_root}/*"), Rails.root.join('public'), :verbose => true
+        puts 'Done.'
+      end
+    end
+  end
+end

data/lib/artwork.rb

@@ -0,0 +1,10 @@
+require 'artwork/version'
+require 'artwork/configuration'
+require 'artwork/model'
+require 'artwork/view'
+require 'artwork/controller'
+require 'artwork/engine' if Rails.const_defined?(:Engine)
+
+module Artwork
+  extend Configuration
+end

data/lib/artwork/configuration.rb

@@ -0,0 +1,75 @@
+module Artwork
+  module Configuration
+    def supported_resolutions_list
+      get_required :supported_resolutions_list
+    end
+
+    def supported_resolutions_list=(resolutions)
+      set :supported_resolutions_list, resolutions.map(&:to_i).sort
+    end
+
+    def default_resolution
+      get_required :default_resolution
+    end
+
+    def default_resolution=(resolution)
+      set :default_resolution, resolution
+    end
+
+    def load_2x_images?
+      get(:load_2x_images) || false
+    end
+
+    def load_2x_images=(flag)
+      set :load_2x_images, flag
+    end
+
+    def current_resolution
+      get(:current_resolution) || default_resolution
+    end
+
+    def current_resolution=(resolution)
+      set :current_resolution, resolution
+    end
+
+    def configure_for(request)
+      Artwork.load_2x_images     = fetch_2x_images_flag_from(request)
+      Artwork.current_resolution = current_resolution_from(request)
+    end
+
+    def reset_configuration
+      set :current_resolution, nil
+      set :load_2x_images, nil
+    end
+
+    private
+
+    def set(setting, value)
+      Thread.current[setting] = value
+    end
+
+    def get(setting)
+      Thread.current[setting]
+    end
+
+    def get_required(setting)
+      get(setting) or raise "Please set #{name}.#{setting}"
+    end
+
+    def fetch_2x_images_flag_from(request)
+      request.cookies['_load2ximgs'].to_i > 0
+    end
+
+    def current_resolution_from(request)
+      browser_width = request.cookies['_bSize'].to_i
+
+      return default_resolution if browser_width.zero?
+
+      supported_resolutions_list.each do |resolution|
+        return resolution if browser_width <= resolution
+      end
+
+      supported_resolutions_list.last
+    end
+  end
+end

data/lib/artwork/controller.rb

@@ -0,0 +1,19 @@
+module Artwork
+  module Controller
+    def self.included(controller)
+      controller.class_eval do
+        around_filter :initialize_artwork_env
+        helper View
+      end
+    end
+
+    private
+
+    def initialize_artwork_env
+      Artwork.configure_for request
+      yield
+    ensure
+      Artwork.reset_configuration
+    end
+  end
+end

data/lib/artwork/engine.rb

@@ -0,0 +1,4 @@
+module Artwork
+  class Engine < Rails::Engine
+  end
+end

data/lib/artwork/model.rb

@@ -0,0 +1,66 @@
+module Artwork
+  module Model
+    THUMBNAIL_NAME_PATTERN = /^[0-9]+x(\w*?)(_2x)?$/i.freeze
+
+    def artwork_thumb_for(attachment_name, size)
+      size = size.to_s
+      matching_thumb_name = nil
+
+      if size =~ THUMBNAIL_NAME_PATTERN
+        desired_size = size.to_i / ratio_for_current_resolution
+
+        available_attachments = []
+
+        # Pick attachments which follow our naming conventions, skipping retina images
+        attachment_styles_for(attachment_name).each do |thumb_name|
+          if thumb_name.to_s =~ THUMBNAIL_NAME_PATTERN
+            is_retina   = $2
+            thumb_width = thumb_name.to_s.to_i
+
+            available_attachments << [thumb_name, thumb_width] unless is_retina
+          end
+        end
+
+        # Sort attachments by width, in ascending order
+        available_attachments = available_attachments.sort_by do |thumb_name, thumb_width|
+          thumb_width
+        end
+
+        available_attachments.each do |thumb_name, thumb_width|
+          if desired_size <= thumb_width
+            matching_thumb_name = thumb_name
+            break
+          end
+        end
+
+        # If we did not find any matching attachment definitions,
+        # the desired size is probably larger than all of our thumb widths,
+        # So pick the last (largest) one we have.
+        matching_thumb_name ||= available_attachments.last.first
+      end
+
+      matching_thumb_name ||= size.to_sym
+
+      if Artwork.load_2x_images? and attachment_styles_for(attachment_name).include?(:"#{matching_thumb_name}_2x")
+        matching_thumb_name = :"#{matching_thumb_name}_2x"
+      end
+
+      matching_thumb_name.to_sym
+    end
+
+    def artwork_url(attachment_name, size, options = {})
+      thumb_name = artwork_thumb_for(attachment_name, size)
+      send(attachment_name).url(size, options)
+    end
+
+    def attachment_styles_for(attachment_name)
+      self.class.attachment_definitions[attachment_name.to_sym][:styles].keys
+    end
+
+    private
+
+    def ratio_for_current_resolution
+      Artwork.default_resolution.to_f / Artwork.current_resolution.to_f
+    end
+  end
+end

data/lib/artwork/version.rb

@@ -0,0 +1,3 @@
+module Artwork
+  VERSION = '0.0.1'
+end

data/lib/artwork/view.rb

@@ -0,0 +1,38 @@
+module Artwork
+  module View
+    def artwork_tag(record, attachment_name, size, options = {})
+      image_tag_options  = options[:image] || {}
+      img_holder_options = options[:img_holder] || {}
+
+      image_tag_options[:alt] ||= extract_title_from(record)
+
+      image_url = record.artwork_url attachment_name, size, options
+
+      if options[:auto_height]
+        image = record.send(attachment_name)
+
+        if image.height.present? and image.width.present?
+          padding = ((image.height.to_f / image.width) * 100).round(4)
+
+          img_holder_options[:style] = "padding-bottom:#{padding}%;"
+        end
+      end
+
+      content_tag :div, :class => attachment_name do
+        content_tag :div, img_holder_options.merge(:class => 'img-holder') do
+          image_tag image_url, image_tag_options
+        end
+      end
+    end
+
+    private
+
+    def extract_title_from(record)
+      if record.respond_to? :title
+        record.title
+      elsif record.respond_to? :name
+        record.name
+      end
+    end
+  end
+end

data/lib/assets/javascripts/artwork.js

@@ -0,0 +1,62 @@
+var Artwork = function () {
+	var self = this;
+
+	self.getSiteDomain = function () {
+		var hostParts = location.host.toString().split('.');
+		return hostParts.slice(hostParts.length - 2, hostParts.length).join('.');
+	}
+
+	self.getDevicePixelRatio = function () {
+		if (typeof window.devicePixelRatio === 'undefined') {
+			window.devicePixelRatio = 1.0;
+		}
+
+		return window.devicePixelRatio;
+	}
+
+	self.shouldLoad2xImages = function () {
+		return self.getDevicePixelRatio() >= 1.5;
+	}
+
+	self.getPixelRatioCookie = function () {
+		return $.cookie('_load2ximgs');
+	}
+
+	self.getBrowserResolutionCookie = function () {
+		return $.cookie('_bSize');
+	}
+
+	self.setPixelRatioCookie = function () {
+		var retinaFlag = self.shouldLoad2xImages() ? 1 : 0;
+		$.cookie('_load2ximgs', retinaFlag, {expires: 365, domain: '.' + self.getSiteDomain()});
+	}
+
+	self.setBrowserResolutionCookie = function () {
+		var windowSize = $(window).width() + 'x' + $(window).height();
+		$.cookie('_bSize', windowSize, {expires: 365, domain: '.' + self.getSiteDomain()});
+	}
+
+	self.activateResolutionIndependance = function () {
+		var oldPixelRatioCookie        = self.getPixelRatioCookie();
+		var oldBrowserResolutionCookie = self.getBrowserResolutionCookie();
+
+		self.setPixelRatioCookie();
+		self.setBrowserResolutionCookie();
+
+		var cookiesWork              = self.getPixelRatioCookie() !== null && self.getBrowserResolutionCookie() !== null;
+		var pixelRatioChanged        = oldPixelRatioCookie !== self.getPixelRatioCookie();
+		var browserResolutionChanged = oldBrowserResolutionCookie !== self.getBrowserResolutionCookie();
+
+		if (cookiesWork && (pixelRatioChanged || browserResolutionChanged)) {
+			// Force reload without using the cache
+			window.location.reload(true);
+			return;
+		}
+
+		$(window).resize(self.setBrowserResolutionCookie);
+	}
+
+	self.activateResolutionIndependance();
+};
+
+Artwork.instance = new Artwork();

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification 
+name: artwork
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dimitar Dimitrov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2014-06-10 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 6
+        version: "1.6"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: paperclip
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :runtime
+  version_requirements: *id004
+description: Works for any browser and uses cookies for transporting browser info to the backend.
+email: 
+- dimitar@live.bg
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- artwork.gemspec
+- generators/artwork/USAGE
+- generators/artwork/artwork_assets_generator.rb
+- lib/artwork.rb
+- lib/artwork/configuration.rb
+- lib/artwork/controller.rb
+- lib/artwork/engine.rb
+- lib/artwork/model.rb
+- lib/artwork/version.rb
+- lib/artwork/view.rb
+- lib/assets/javascripts/artwork.js
+has_rdoc: true
+homepage: ""
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Automated image size scaling view helpers.
+test_files: []
+