ir_helper 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e10d8fb83d7346b07073b7fd54f27c48e769b70
+  data.tar.gz: 393df95bbd2b9fe1e2740a7b8cbe91a3fb19009b
+SHA512:
+  metadata.gz: e2548c6e1739347dc163191011b22692fc5233fd9e9df51b15c3e057c7b1025402a176740dc86aaf1ab8937598b8548ad1b618e8df7c902a07ebf20cb9e7ce7c
+  data.tar.gz: e4e9767006f1b435297b12bd588a37dd8eeafb5ad39e218ffae0ba130ef0016a793f4097d0a2f8d8134415ddee92e93ec2097c3546ad93aeabd63d335614fadc

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 James Nicol
+
+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,111 @@
+# IrHelper
+
+This gem includes helpers to build the appropriate URLs for images served via an [image-resizer](https://github.com/jimmynicol/image-resizer) instance.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ir-helper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ir-helper
+
+## Configuration
+Configuring this gem is done via:
+
+    IrHelper.configure do |config|
+      # add your configuration here...
+    end
+
+For a rails project this is best done via an [initializer](http://guides.rubyonrails.org/configuring.html).
+
+The available config options are:
+
+### CDN
+This is a required setting.
+
+    config.cdn = 'https://my.cdn.com'
+
+
+### Modifiers
+This gem comes with all the available modifiers that are supported natively by `image-resizer` but also allows you add your own modifier strings if you have built custom options into your own implementation.
+
+    # config.add_modifier(key, alias='', values=[])
+    config.add_modifiers(:x, :xtra, ['one', 'two'])
+
+### Sources
+As with modifiers you can add more external source options. Natively Facebook, Twitter, Youtube and Vimeo are supported but should you chose to add another to that list you can configure the gem with them
+
+    # config.add_source(name, option)
+    config.add_source(:myspace, :ms_id)
+
+### Ruby method aliases
+If you need for whatever reason to alias the helper methods provided you can do that via config aswell.
+
+    config.add_alias :ir_image_tag, :something_else
+
+### Javascript aliases
+You can also override any of the JS method names, including the global object name.
+
+    config.add_js_alias :js_class, 'MyAwesomeResizer'
+    config.add_js_alias :js_image_tag, 'something'
+
+## Usage
+
+The functionality in this gem has two parts, a ruby view helper and a javascript helper.
+
+### Ruby View Helper
+
+You can generate an image tag in the same way the regular [helper](http://guides.rubyonrails.org/layouts_and_rendering.html#asset-tag-helpers) does, just with adding a valid set of modifiers
+
+    <div class="content">
+      <%= ir_image_tag('https://s3.amazonaws.com/sample.bucket/path/to/image.jpg', h:200, w:300) %>
+      <%= ir_image_tag(fb_uid: 'missnine', s:100) %>
+    </div>
+
+You can generate a background image string
+
+    <div style="<%= ir_background('https://s3.amazonaws.com/sample.bucket/path/to/image.jpg', h:200, w:300) %>"></div>
+
+Or just return the url as needed
+
+    <div class="content">
+      <%= ir_url('https://s3.amazonaws.com/sample.bucket/path/to/image.jpg', h:200, w:300) %>
+    </div>
+
+### Javascript Helper
+
+The Javascript helper is generated from the config data as an `.erb` file on load. So all of the new modifiers or sources added will be reflected, as well as any aliases set.
+
+The JS helper (`image_resizer.js`) is either attached as a global, or can be loaded via AMD or CommonJS if you are using those techniques. It has the same helper methods as the ruby helper.
+
+    <script>
+      var imgUrl = 'https://s3.amazonaws.com/sample.bucket/path/to/image.jpg';
+      $('#image-tag').append(IR.irImageTag(imgUrl, {s:200}));
+      $('#image-bg').attr('style', IR.irBackground(imgUrl, {s:200}));
+      $('#image-url').text(IR.irImageTag(imgUrl, {s:200}));
+    </script>
+    <div id="image-tag"></div>
+    <div id="image-bg"></div>
+    <div id="image-url"></div>
+
+## Tests
+The ruby helpers are tested with RSpec and they can be run with either:
+
+    $ guard
+    $ rspec
+
+
+## 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

data/app/assets/javascripts/image_resizer.js.erb

@@ -0,0 +1,201 @@
+/**
+Javascript helper for building `image-resizer` url endpoints
+ - this file is partially built via the parent ruby process to include the
+   available modifiers and custom class/method names.
+*/
+(function(root, factory) {
+  'use strict';
+
+  // AMD: import Backbone and underscore into the factory
+  if (typeof define === 'function' && define.amd) {
+    define([], function(){
+      return factory(root);
+    });
+
+  // CommonJS: for Node.js or Browserify
+  } else if (typeof exports !== 'undefined') {
+    module.exports = factory(root);
+
+  // Finally, as a browser global.
+  } else {
+    root.<%= IrHelper.js_class %> = factory(root);
+  }
+
+}(this, function(root){
+  'use strict';
+
+  // Private methods
+  function parseArgs(){
+    var source, modifiers;
+    source = typeof arguments[0] === 'string' ? arguments[0] : null;
+    if (source){
+      modifiers = arguments[1];
+    } else {
+      modifiers = arguments[0];
+    }
+    return { source: source, modifiers: modifiers };
+  };
+
+  function generateEndpoint(source, modifiers){
+    var uri, cdn, mods, path;
+
+    uri  = source ? URI(source) : null;
+    cdn  = IR.CDN.replace(/\/$/, '');
+    mods = modStr(uri, modifiers);
+    path = buildPath(uri, modifiers);
+
+    return cdn + mods + path;
+  };
+
+  function modSet(key){
+    var k, v;
+    for (k in IR.modifiers){
+      v = IR.modifiers[k];
+      if (k === key || v.alias === key){
+        return v;
+      }
+    }
+    return null;
+  };
+
+  function sourceOption(key){
+    var mods = IR.modifiers.e.values
+    for (var k in mods){
+      if (key === mods[k]){
+        return [k, mods[k]];
+      }
+    }
+    return null;
+  };
+
+  function modStr(uri, modifiers){
+    var modArr = [];
+    if (modifiers){
+      modArr = buildModArr(modifiers);
+    }
+    if (uri && urlDomain(uri.hostname) === 'facebook'){
+      modArr.push('efacebook');
+    }
+    return modArr.length > 0 ? '/' + modArr.join('-') : '';
+  };
+
+  function buildModArr(modifiers){
+    var modArr, k, v, mSet, src;
+
+    modArr = [];
+    for (k in modifiers){
+      v = modifiers[k];
+      mSet = modSet(k);
+      src = sourceOption(k);
+      if (mSet){
+        if (mSet.values){
+          if (mSet.values[v]){
+            modArr.push(k + v);
+          }
+        } else {
+          modArr.push(k + v);
+        }
+      } else if (src) {
+        modArr.push('e' + src[0]);
+      }
+    }
+
+    return modArr;
+  };
+
+  function buildPath(uri, modifiers){
+    if(uri){
+      switch(urlDomain(uri.hostname)){
+        case 's3':
+          return s3Object(uri);
+          break;
+        case 'facebook':
+          return fbUid(uri);
+          break;
+        default:
+          ''
+      }
+    } else {
+      for (var k in modifiers){
+        if (sourceOption(k)){
+          return '/' + modifiers[k] + '.jpg';
+        }
+      }
+    }
+  };
+
+  function urlDomain(host){
+    var domain = 'other';
+    if (/s3.amazonaws.com/i.test(host)){
+      domain = 's3';
+    }
+    if (/facebook.com/i.test(host)){
+      domain = 'facebook';
+    }
+    return domain;
+  };
+
+  function s3Object(uri){
+    if (uri.hostname === 's3.amazonaws.com'){
+      return '/' + uri.pathname.split('/').slice(2).join('/');
+    } else {
+      return uri.pathname;
+    }
+  };
+
+  function URI(url){
+    var parser = document.createElement('a');
+    parser.href = url;
+    return parser;
+  };
+
+  function fbUid(uri){
+    return uri.pathname.split('/')[1];
+  };
+
+  function altTag(url){
+    return url.split('/').pop().split('.')[0];
+  };
+
+  function IR(){}
+
+  // Public methods
+  IR.irImageTag = function(){
+    var args = parseArgs.apply(this, arguments),
+        url = generateEndpoint(args.source, args.modifiers),
+        alt = altTag(url);
+
+    return '<img alt="' + alt + '" src="' + url + '" />';
+  };
+
+  IR.irBackground = function(){
+    var args = parseArgs.apply(this, arguments),
+        url = generateEndpoint(args.source, args.modifiers);
+    return 'background-image:url(' + url + ')';
+  };
+
+  IR.irUrl = function(){
+    var args = parseArgs.apply(this, arguments);
+    return generateEndpoint(args.source, args.modifiers);
+  };
+
+  // Public constants
+  IR.modifiers = <%= IrHelper.modifiers.to_json %>;
+
+  IR.CDN = <%= IrHelper.cdn.to_json %>;
+
+  IR.VERSION = <%= IrHelper::VERSION.to_json %>;
+
+  // Alias any methods that have been listed in the config
+  <% unless IrHelper.js_image_tag.nil? %>
+  IR.<%= IrHelper.js_image_tag %> = IR.irImageTag;
+  <% end %>
+  <% unless IrHelper.js_background.nil? %>
+  IR.<%= IrHelper.js_background %> = IR.irBackground;
+  <% end %>
+  <% unless IrHelper.js_url.nil? %>
+  IR.<%= IrHelper.js_url %> = IR.irUrl;
+  <% end %>
+
+  return IR;
+}));

data/app/helpers/ir_helper/view_helper.rb

@@ -0,0 +1,12 @@
+require 'ir_helper/helper'
+
+module IrHelper
+  # Series of view helpers building url strings for image-resizer endpoints
+  module ViewHelper
+    def self.included(base)
+      base.class_eval do
+        include ::IrHelper::Helper
+      end
+    end
+  end
+end

data/lib/ir_helper/engine.rb

@@ -0,0 +1,7 @@
+module IrHelper
+  class Engine < ::Rails::Engine
+    # initializer 'image-resizer-rails.assets.precompile' do |app|
+    #   app.config.assets.precompile << 'image_resizer'
+    # end
+  end
+end

data/lib/ir_helper/helper.rb

@@ -0,0 +1,149 @@
+require 'uri'
+
+module IrHelper
+  # Series of view helpers building url strings for image-resizer endpoints
+  module Helper
+    def ir_image_tag(*args)
+      src = generate_ir_endpoint(args)
+      return nil if src.nil?
+      if respond_to?(:image_tag)
+        image_tag src
+      else
+        "<img src='#{src}' />"
+      end
+    end
+
+    def ir_background(*args)
+      url = generate_ir_endpoint(args)
+      url ? "background-image:url(#{url})" : nil
+    end
+
+    def ir_url(*args)
+      generate_ir_endpoint(args)
+    end
+
+    private
+
+    def parse_arguments(args)
+      if args[0].is_a?(String) || args[0].nil?
+        [args[0], args[1..-1]]
+      else
+        [nil, args]
+      end
+    end
+
+    def cdn
+      ::IrHelper.cdn
+    end
+
+    def self.img_tag_name
+      ::IrHelper.image_tag_name
+    end
+
+    def mods
+      ::IrHelper.modifiers
+    end
+
+    def mod_set(key)
+      mods.each do |k, v|
+        return v if key == k || v[:alias] == key
+      end
+      nil
+    end
+
+    def sources
+      mods[:e][:values]
+    end
+
+    def source_option(key)
+      sources.each do |k, v|
+        return [k, v] if key == v
+      end
+      nil
+    end
+
+    def generate_ir_endpoint(args)
+      fail NoCDNException if cdn.nil?
+
+      source, modifiers = parse_arguments(args)
+      uri = source ? URI(source) : nil
+      modifier_str = mod_str(uri, modifiers)
+      path = build_path(uri, modifiers)
+
+      if path
+        "#{cdn.gsub(/\/$/, '')}#{modifier_str}#{path}"
+      else
+        nil
+      end
+    end
+
+    def mod_str(uri, modifiers)
+      mod_arr = []
+      unless modifiers.nil? || modifiers[0].nil?
+        mod_arr = build_mod_arr(modifiers)
+      end
+      mod_arr << 'efacebook' if uri && url_domain(uri.host) == :facebook
+      mod_arr.compact
+      mod_arr.length > 0 ? "/#{mod_arr.join('-')}" : ''
+    end
+
+    def build_mod_arr(modifiers)
+      modifiers[0].map do |k, v|
+        mset = mod_set(k)
+        src = source_option(k)
+        if mset
+          if mset.include? :values
+            mset[:values].include?(v) ? "#{k}#{v}" : nil
+          else
+            "#{k}#{v}"
+          end
+        elsif src
+          "e#{src.first}"
+        else
+          nil
+        end
+      end
+    end
+
+    def build_path(uri, modifiers)
+      if uri
+        case url_domain(uri.host)
+        when :s3
+          s3_object uri
+        when :facebook
+          "/#{fb_uid(uri)}.jpg"
+        else
+        end
+      else
+        modifiers[0].each do |k, v|
+          return "/#{v}.jpg" if source_option(k)
+        end
+        nil
+      end
+    end
+
+    def url_domain(host)
+      return :s3 if /s3.amazonaws.com/i =~ host
+      return :facebook if /facebook.com/i =~ host
+      :other
+    end
+
+    def s3_object(uri)
+      # test to see which type of s3 url we have
+      if uri.host == 's3.amazonaws.com'
+        # this version has the bucket at the first part of the path
+        "/#{uri.path.split('/')[2..-1].join('/')}"
+      else
+        # this version has the bucket included in the host
+        uri.path
+      end
+    end
+
+    def fb_uid(uri)
+      uri.path.split('/')[1]
+    end
+  end
+
+  class NoCDNException < Exception; end
+  class NotS3SourceException < Exception; end
+end

data/lib/ir_helper/version.rb

@@ -0,0 +1,3 @@
+module IrHelper
+  VERSION = '0.2.0'
+end

data/lib/ir_helper.rb

@@ -0,0 +1,92 @@
+require 'ir_helper/version'
+require 'ir_helper/helper'
+require 'ir_helper/engine' if defined?(Rails)
+
+module IrHelper
+
+  class << self
+    attr_accessor :cdn
+    attr_reader :js_class, :js_image_tag, :js_background, :js_url
+
+    def configure(&block)
+      yield self
+    end
+
+    def reset_config
+      @cdn = nil
+      @ir_image_tag = nil
+      @ir_background = nil
+      @ir_url = nil
+      @js_class = 'ImageResizer'
+      @js_image_tag = nil
+      @js_background = nil
+      @js_url = nil
+      @modifiers = default_modifiers
+    end
+
+    def modifiers
+      @modifiers ||= default_modifiers
+    end
+
+    def add_modifier(key, img_tag = '', values = [])
+      @modifiers[key.to_sym] = { alias: img_tag, values: values }
+    end
+
+    def add_source(name, option)
+      @modifiers[:e][:values][name.to_sym] = option.to_sym
+    end
+
+    def js_class
+      @js_class ||= 'IR'
+    end
+
+    def add_alias(type, name)
+      Helper.class_eval do |base|
+        base.send(:alias_method, name.to_sym, type.to_sym)
+      end
+    end
+
+    def add_js_alias(type, name)
+      instance_variable_set "@#{type.to_s}", name
+    end
+
+    def to_hash
+      {
+        cdn: cdn,
+        ir_image_tag: ir_image_tag,
+        ir_background: ir_background,
+        ir_url: ir_url,
+        js_class: js_class,
+        js_image_tag: js_image_tag,
+        js_background: js_background,
+        js_url: js_url,
+        modifiers: modifiers
+      }
+    end
+
+    private
+
+    def default_modifiers
+      {
+        w: { alias: :width },  h: { alias: :height },
+        s: { alias: :square },
+        c: { alias: :crop, values: %w(fit fill cut scale) },
+        g: { alias: :gravity, values: %w(c n s e w ne nw se sw) },
+        y: { alias: :top }, x: { alias: :left },
+        e: { alias: :external, values: default_sources },
+        f: { alias: :filter }
+      }
+    end
+
+    def default_sources
+      {
+        facebook: :fb_uid,
+        twitter:  :tw_uid,
+        youtube:  :youtube_id,
+        vimeo:    :vimeo_id
+      }
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: ir_helper
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- James Nicol
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 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: jasmine
+  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: guard
+  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: guard-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: awesome_print
+  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'
+description: Helpers for use with image-resizer service
+email:
+- james.andrew.nicol@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- app/assets/javascripts/image_resizer.js.erb
+- app/helpers/ir_helper/view_helper.rb
+- lib/ir_helper.rb
+- lib/ir_helper/engine.rb
+- lib/ir_helper/helper.rb
+- lib/ir_helper/version.rb
+homepage: https://github.com/jimmynicol/ir-helper
+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.2.2
+signing_key: 
+specification_version: 4
+summary: View helpers and JS file
+test_files: []