images 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: feedb77e3f8fe894b5e6aa2aee41612a4c4c1d96
-  data.tar.gz: 034a32f25d188816a098f64b3ea6b176f57b1720
+  metadata.gz: 172495945000043ea025a0cc3e22a97a029f55f1
+  data.tar.gz: 4a42fe568c5c7b54a7542ee4369624de91d8bde3
 SHA512:
-  metadata.gz: aa4a02ad345e990d47a2966b041a32ad334ebf8206552e1762438b090755ae8c9660a0fe892a6f258618b81c09b6a60797b6a688fca8489b07b0e4580f910d74
-  data.tar.gz: 2694d27281087b4e5faea5486ca9ca9c815229055a5ca8b703d613cc2de198a46d2a3aeb2e46a8b900487c38fc2fb40d2899ff9d945b7e649eeef6d6fd0a6e4e
+  metadata.gz: 3a5f7c7a46fc7454faa44de2160263a4cb4872482dd6687e4513bffc968c4a2f56e7e970b1c580dd89bff64526703462510393d3966cd663d8ac6d73f223ea0d
+  data.tar.gz: 30e08ab318a65c7968d60c417bca32ee8b2857fcdcb2d79617e915babdc99ce0846ea3044f054669c16df80df388a9961993c87ca740a166ac4c35054498fbc2

data/.gitignore

@@ -1,14 +1,8 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache

data/Gemfile

@@ -1,3 +1,15 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
+# Declare your gem's dependencies in images.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,146 @@
+PATH
+  remote: .
+  specs:
+    images (0.0.2)
+      rails (~> 4.2.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.3)
+      actionpack (= 4.2.3)
+      actionview (= 4.2.3)
+      activejob (= 4.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.3)
+      actionview (= 4.2.3)
+      activesupport (= 4.2.3)
+      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.3)
+      activesupport (= 4.2.3)
+      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.3)
+      activesupport (= 4.2.3)
+      globalid (>= 0.3.0)
+    activemodel (4.2.3)
+      activesupport (= 4.2.3)
+      builder (~> 3.1)
+    activerecord (4.2.3)
+      activemodel (= 4.2.3)
+      activesupport (= 4.2.3)
+      arel (~> 6.0)
+    activesupport (4.2.3)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    arel (6.0.2)
+    builder (3.2.2)
+    capybara (2.4.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    capybara-webkit (1.3.0)
+      capybara (>= 2.0.2, < 2.5.0)
+      json
+    childprocess (0.5.3)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.1.0)
+    erubis (2.7.0)
+    ffi (1.9.8)
+    globalid (0.3.5)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    launchy (2.4.3)
+      addressable (~> 2.3)
+    loofah (2.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    method_source (0.8.2)
+    mime-types (2.6.1)
+    mini_portile (0.6.2)
+    minitest (5.7.0)
+    multi_json (1.11.1)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    pry (0.10.1)
+      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.3)
+      actionmailer (= 4.2.3)
+      actionpack (= 4.2.3)
+      actionview (= 4.2.3)
+      activejob (= 4.2.3)
+      activemodel (= 4.2.3)
+      activerecord (= 4.2.3)
+      activesupport (= 4.2.3)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.3)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.6)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    railties (4.2.3)
+      actionpack (= 4.2.3)
+      activesupport (= 4.2.3)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    rubyzip (1.1.6)
+    selenium-webdriver (2.42.0)
+      childprocess (>= 0.5.0)
+      multi_json (~> 1.0)
+      rubyzip (~> 1.0)
+      websocket (~> 1.0.4)
+    slop (3.6.0)
+    sprockets (3.2.0)
+      rack (~> 1.0)
+    sprockets-rails (2.3.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    sqlite3 (1.3.10)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    websocket (1.0.7)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  capybara
+  capybara-webkit
+  images!
+  launchy
+  minitest (~> 5.7.0)
+  pry
+  rake (~> 10.0)
+  selenium-webdriver
+  sqlite3

data/{LICENSE.txt → MIT-LICENSE}

@@ -1,6 +1,4 @@
-Copyright (c) 2015 Gabe Scholz, Brewhouse Software
-
-MIT License
+Copyright 2015 Gabe Scholz, Brewhouse Software
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -57,6 +57,21 @@ Will create:
 }
 ```
 
+## Configuration
+
+By default this gem uses all of the image types included in `Mime::EXTENSION_LOOKUP` plus `svg`.
+To add other file types to this list, simply append the file extension to `config.images.whitelist`
+in your `application.rb`. For example,
+
+```ruby
+module MyApp
+  class Application < Rails::Application
+    # ...
+    config.images.whitelist += ['exe']
+  end
+end
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/BrewhouseTeam/images/fork )

data/Rakefile

@@ -1,6 +1,34 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
 
-Rake::TestTask.new do |t|
-  t.test_files = Dir.glob("test/**/*_test.rb")
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Images'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

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

@@ -1,5 +1,5 @@
 (function (window, undefined) {
-  var Images = <%= Images.load.to_json %>;
+  var Images = <%= Images.generate.to_json %>;
 
   function deepFreeze (obj) {
     Object.freeze(obj);

data/images.gemspec

@@ -3,23 +3,29 @@ lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "images/version"
 
-Gem::Specification.new do |spec|
-  spec.name          = "images"
-  spec.version       = Images::VERSION
-  spec.authors       = ["Gabe Scholz"]
-  spec.email         = ["gabe@brewhouse.io"]
-  spec.summary       = %q{Loads all image urls in your Rails project into a global JavaScript constant.}
-  spec.description   = %q{Loads all image urls in your Rails project into a global JavaScript constant.}
-  spec.homepage      = "https://www.github.com/BrewhouseTeam/images"
-  spec.license       = "MIT"
+Gem::Specification.new do |s|
+  s.name          = "images"
+  s.version       = Images::VERSION
+  s.authors       = ["Gabe Scholz"]
+  s.email         = ["gabe@brewhouse.io"]
+  s.summary       = %q{Loads all image urls in your Rails project into a global JavaScript constant.}
+  s.description   = %q{Loads all image urls in your Rails project into a global JavaScript constant.}
+  s.homepage      = "https://www.github.com/BrewhouseTeam/images"
+  s.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.test_files    = spec.files.grep(%r{^(test)/})
-  spec.require_paths = ["lib"]
+  s.files         = `git ls-files -z`.split("\x0")
+  s.test_files    = s.files.grep(%r{^(test)/})
+  s.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.7.0"
-  spec.add_dependency "rails", "~> 4"
-  spec.add_dependency "actionview", "~> 4"
+  s.add_development_dependency "bundler", "~> 1.6"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "minitest", "~> 5.7.0"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "capybara"
+  s.add_development_dependency "capybara-webkit"
+  s.add_development_dependency "selenium-webdriver"
+  s.add_development_dependency "launchy"
+  s.add_development_dependency "pry"
+
+  s.add_dependency "rails", "~> 4.2.3"
 end

data/lib/images/builder.rb

@@ -1,4 +1,4 @@
-module Images
+class Images
   class Builder
 
     def initialize(args)
@@ -6,9 +6,10 @@ module Images
       @helper = args.fetch(:helper)
     end
 
-    def call
+    def call(options)
       images_paths
         .map { |path| get_short_path(path) }
+        .select { |path| options.whitelist.include?(path.extname.slice(1,10)) }
         .reduce({}) { |acc, path|
           split = split_path(path)
           asset = @helper.call(path)

data/lib/images/engine.rb

@@ -1,6 +1,15 @@
 require "rails"
 
-module Images
+class Images
   class Engine < ::Rails::Engine
+    config.images = ActiveSupport::OrderedOptions.new
+
+    # by default use the image mime types provided by Mime + svg
+    default_image_extnames =
+      Mime::EXTENSION_LOOKUP
+        .select { |ext, mime| mime.to_s.match("image/") }
+        .keys
+
+    config.images.whitelist = default_image_extnames + ["svg"]
   end
 end

data/lib/images/options.rb

@@ -0,0 +1,6 @@
+class Images
+  OPTION_KEYS = [:whitelist]
+
+  class Options < Struct.new(*OPTION_KEYS)
+  end
+end

data/lib/images/url_helper.rb

@@ -1,6 +1,4 @@
-require "actionview"
-
-module Images
+class Images
   class UrlHelper
     include ::ActionView::Helpers::AssetUrlHelper
 

data/lib/images/version.rb

@@ -1,3 +1,3 @@
-module Images
-  VERSION = "0.0.1"
+class Images
+  VERSION = "0.0.2"
 end

data/lib/images.rb

@@ -1,18 +1,23 @@
 require "images/version"
 require "images/engine"
-require "images/url_helper"
 require "images/builder"
+require "images/url_helper"
+require "images/options"
 
-module Images
+class Images
 
-  def load
+  def self.generate
     directory = ::Rails.root.join('app', 'assets', 'images')
     helper = Images::UrlHelper.new
 
+    options = Images::Options.new(
+      Rails.configuration.images.whitelist
+    )
+
     Images::Builder.new({
       directory: directory,
       helper: helper
-    }).call
+    }).call(options)
   end
 
 end

data/test/builder_test.rb

@@ -1,30 +1,30 @@
-require "minitest/autorun"
-require "pathname"
-require_relative "../lib/images/builder"
+require "test_helper"
 
 class Images::BuilderTest < Minitest::Test
   def setup
-    @directory = Pathname.new(Dir.pwd).join("test", "fixtures")
-    @helper = ->(path) { "stub" }
+    directory = Pathname.new(Dir.pwd).join("test", "fixtures")
+    helper = ->(path) { "#{path}--stub" }
 
     @builder = Images::Builder.new({
-      directory: @directory,
-      helper: @helper
+      directory: directory,
+      helper: helper
     })
   end
 
   def test_builder
-    result = @builder.call
+    options = OpenStruct.new({whitelist: ['jpg', 'bmp', 'svg']})
+    result = @builder.call(options)
+
     expected = {
       "nested" => {
-        "Image3_bmp_path" => "stub",
-        "Image4_bmp_path" => "stub",
+        "Image3_bmp_path" => "nested/Image3.bmp--stub",
+        "Image4_bmp_path" => "nested/Image4.bmp--stub",
         "deeply_nested" => {
-          "Image5_svg_path" => "stub"
+          "Image5_svg_path" => "nested/deeply_nested/Image5.svg--stub"
         }
       },
-      "image1_jpg_path" => "stub",
-      "image2_svg_path" => "stub"
+      "image1_jpg_path" => "image1.jpg--stub",
+      "image2_svg_path" => "image2.svg--stub"
     }
 
     assert_equal(result, expected)

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .
+//= require images

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/controllers/welcome_controller.rb

@@ -0,0 +1,4 @@
+class WelcomeController < ApplicationController
+  def index
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "images"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)