images 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: feedb77e3f8fe894b5e6aa2aee41612a4c4c1d96
+  data.tar.gz: 034a32f25d188816a098f64b3ea6b176f57b1720
+SHA512:
+  metadata.gz: aa4a02ad345e990d47a2966b041a32ad334ebf8206552e1762438b090755ae8c9660a0fe892a6f258618b81c09b6a60797b6a688fca8489b07b0e4580f910d74
+  data.tar.gz: 2694d27281087b4e5faea5486ca9ca9c815229055a5ca8b703d613cc2de198a46d2a3aeb2e46a8b900487c38fc2fb40d2899ff9d945b7e649eeef6d6fd0a6e4e

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Gabe Scholz, Brewhouse Software
+
+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,66 @@
+# Images
+
+Loads all image urls in your Rails project into a global JavaScript constant.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'images'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install images
+
+## Usage
+
+Add `//= require images` line to your `application.js`. It will create an
+`Images` global JavaScript variable with urls for all images in your
+`app/assets/images` folder.
+
+For example, given that you have an image folder structure such as this:
+
+```
+.
+└── app
+    └── assets
+        └── images
+            └── nested
+            |   ├── Image3.bmp
+            |   ├── Image4.bmp
+            |   └── deeply_nested
+            |       └── Image5.svg
+            ├── image1.jpg
+            └── image2.svg
+```
+
+Will create:
+
+```js
+// window.Images
+{
+  nested: {
+    Image3_bmp_path: "/assets/Image3-...",
+    Image4_bmp_path: "/assets/Image4-...",
+    deeply_nested: {
+      Image5_svg_path: "/assets/Image5-..."
+    }
+  },
+  image1_jpg_path: "/assets/image1-...",
+  image2_svg_path: "/assets/image2-..."
+}
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/BrewhouseTeam/images/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,6 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = Dir.glob("test/**/*_test.rb")
+end

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

@@ -0,0 +1,22 @@
+(function (window, undefined) {
+  var Images = <%= Images.load.to_json %>;
+
+  function deepFreeze (obj) {
+    Object.freeze(obj);
+    for (var propKey in obj) {
+      var prop = obj[propKey];
+      if (!obj.hasOwnProperty(propKey) || !(typeof prop === 'object') || Object.isFrozen(prop)) {
+        continue;
+      }
+      deepFreeze(prop);
+    }
+    return obj;
+  }
+
+  if (Object.freeze !== undefined && Object.isFrozen !== undefined) {
+    deepFreeze(Images);
+  }
+
+  window.Images = Images;
+
+}(window));

data/images.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+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"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.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"
+end

data/lib/images/builder.rb

@@ -0,0 +1,50 @@
+module Images
+  class Builder
+
+    def initialize(args)
+      @directory = args.fetch(:directory)
+      @helper = args.fetch(:helper)
+    end
+
+    def call
+      images_paths
+        .map { |path| get_short_path(path) }
+        .reduce({}) { |acc, path|
+          split = split_path(path)
+          asset = @helper.call(path)
+          append_nested_path(acc, split, asset)
+        }
+    end
+
+    private
+
+    def get_short_path(path)
+      Pathname.new(path).relative_path_from(@directory)
+    end
+
+    def split_path(path)
+      *folders, file = path.to_s.split(File::SEPARATOR)
+      folders + [file.gsub(".", "_") + "_path"]
+    end
+
+    def append_nested_path(acc, path, asset)
+      acc ||= {}
+      key = path.shift
+
+      value = if path.length > 0
+                append_nested_path(acc[key], path, asset)
+              else
+                asset
+              end
+
+      acc[key] = value
+      acc
+    end
+
+    def images_paths
+      paths = @directory.join("**/*.*")
+      Dir.glob(paths)
+    end
+
+  end
+end

data/lib/images/engine.rb

@@ -0,0 +1,6 @@
+require "rails"
+
+module Images
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/images/url_helper.rb

@@ -0,0 +1,11 @@
+require "actionview"
+
+module Images
+  class UrlHelper
+    include ::ActionView::Helpers::AssetUrlHelper
+
+    def call(path)
+      asset_url(path)
+    end
+  end
+end

data/lib/images/version.rb

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

data/lib/images.rb

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

data/test/builder_test.rb

@@ -0,0 +1,32 @@
+require "minitest/autorun"
+require "pathname"
+require_relative "../lib/images/builder"
+
+class Images::BuilderTest < Minitest::Test
+  def setup
+    @directory = Pathname.new(Dir.pwd).join("test", "fixtures")
+    @helper = ->(path) { "stub" }
+
+    @builder = Images::Builder.new({
+      directory: @directory,
+      helper: @helper
+    })
+  end
+
+  def test_builder
+    result = @builder.call
+    expected = {
+      "nested" => {
+        "Image3_bmp_path" => "stub",
+        "Image4_bmp_path" => "stub",
+        "deeply_nested" => {
+          "Image5_svg_path" => "stub"
+        }
+      },
+      "image1_jpg_path" => "stub",
+      "image2_svg_path" => "stub"
+    }
+
+    assert_equal(result, expected)
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: images
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gabe Scholz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.7.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Loads all image urls in your Rails project into a global JavaScript constant.
+email:
+- gabe@brewhouse.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/images.js.erb
+- circle.yml
+- images.gemspec
+- lib/images.rb
+- lib/images/builder.rb
+- lib/images/engine.rb
+- lib/images/url_helper.rb
+- lib/images/version.rb
+- test/builder_test.rb
+- test/fixtures/image1.jpg
+- test/fixtures/image2.svg
+- test/fixtures/nested/Image3.bmp
+- test/fixtures/nested/Image4.bmp
+- test/fixtures/nested/deeply_nested/Image5.svg
+homepage: https://www.github.com/BrewhouseTeam/images
+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.1
+signing_key: 
+specification_version: 4
+summary: Loads all image urls in your Rails project into a global JavaScript constant.
+test_files:
+- test/builder_test.rb
+- test/fixtures/image1.jpg
+- test/fixtures/image2.svg
+- test/fixtures/nested/Image3.bmp
+- test/fixtures/nested/Image4.bmp
+- test/fixtures/nested/deeply_nested/Image5.svg