js-asset_paths 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0634b5efe0f04adce99e7a8214985004dcf43eff
+  data.tar.gz: 0c0913d6501909e21830cc712e12cea98178cc7f
+SHA512:
+  metadata.gz: dc925fe525271aeab99de6a8b7bb2045eac33374c88f215142ce75b47d1ef023227272ad56343e2ec6f7ed8899aaa11cbc88795de3d0225e8421b9b795edd4c4
+  data.tar.gz: bb1a26f2a9b9b8569d6fcb8e9415cf353663776f210c5ee354d1daa0d63cad8d4d04d43f6794217004f85ef71868a261b88821b472975253e8934cebe955941b

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 sonnym
+
+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,43 @@
+# JS Asset Paths
+
+Inspired by [js-routes](https://github.com/railsware/js-routes), JS Asset Paths makes the helper methods found in [ActionView::Helpers::AssetUrlHelper](http://rubydoc.info/docs/rails/ActionView/Helpers/AssetUrlHelper) available to the client.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'js-asset_paths'
+```
+
+Then require the js-asset_paths file in your `application.js`.
+
+``` js
+/*
+= require js-asset_paths
+*/
+```
+
+## Usage
+
+A global object called `PathHelper` will be created with the following methods:
+
+ - assetPath(source[, options])
+ - fontPath(source)
+ - imagePath(source)
+ - javascriptPath(source)
+ - stylesheetPath(source)
+
+These functions operate in the same manner as their server-side counterparts.
+
+## Explanation
+
+JS Asset Paths inspects the configuration options for the current environment and determines whether or not a digest will be appended to the pathname of asset files. An object correlating the truncated asset path with the actual path to the asset on the server is stored in the generated javascript and referenced during each call.
+
+## 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/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/js_asset_paths'
+  t.test_files = FileList['test/lib/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/app/assets/javascripts/js-asset_paths.js.erb

@@ -0,0 +1,38 @@
+<%# encoding: utf-8 %>
+
+var PathHelper = (function(definitions) {
+  var assetExtensions = <%= ActionView::Helpers::AssetUrlHelper::ASSET_EXTENSIONS.to_json %>;
+  var assetPublicDirectories = <%= ActionView::Helpers::AssetUrlHelper::ASSET_PUBLIC_DIRECTORIES.to_json %>;
+
+  return {
+    assetPath: function(source, opts) {
+      var key = source;
+
+      if (opts && opts.type) {
+        key = [assetPublicDirectories[opts.type], key].join("/");
+
+        if (source.split(".").length === 1) {
+          key = [key, assetExtensions[opts.type]].join(".");
+        }
+      }
+
+      return ["assets", definitions[key] || key].join("/");
+    },
+
+    fontPath: function(source) {
+      return this.assetPath(source, { type: "font" });
+    },
+
+    imagePath: function(source) {
+      return this.assetPath(source, { type: "image" });
+    },
+
+    javascriptPath: function(source) {
+      return this.assetPath(source, { type: "javascript" });
+    },
+
+    stylesheetPath: function(source) {
+      return this.assetPath(source, { type: "stylesheet" });
+    },
+  };
+})(<%= JsAssetPaths::Generator.generate! %>);

data/js_asset_paths.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'js_asset_paths/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'js-asset_paths'
+  spec.version       = JsAssetPaths::VERSION
+  spec.authors       = ['sonnym']
+  spec.email         = ['michaud.sonny@gmail.com']
+  spec.description   = 'Access paths to compiled assets from in javascript.'
+  spec.summary       = spec.description
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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_runtime_dependency(%q<rails>, ['>= 4.0'])
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry'
+end

data/lib/js-asset_paths.rb

@@ -0,0 +1,3 @@
+require 'js_asset_paths/version'
+require 'js_asset_paths/engine'
+require 'js_asset_paths/generator'

data/lib/js_asset_paths/engine.rb

@@ -0,0 +1,18 @@
+module JsAssetPaths
+  class Engine < Rails::Engine
+    JS_ASSET_PATHS_FILE = 'js-asset_paths'
+
+    isolate_namespace(JsAssetPaths)
+
+    initializer('js-assets_paths.compile', after: 'sprockets.environment') do |application|
+      application.assets.register_preprocessor('application/javascript', :'js-assets_path.compile') do |context, data|
+        if context.logical_path == JS_ASSET_PATHS_FILE
+          JsAssetPaths::Generator.environment = application
+          JsAssetPaths::Generator.context = context
+        end
+
+        data
+      end
+    end
+  end
+end

data/lib/js_asset_paths/generator.rb

@@ -0,0 +1,21 @@
+module JsAssetPaths
+  class Generator
+    cattr_accessor :environment, :context
+
+    def self.generate!
+      asset_hash.to_json
+    end
+
+    private
+
+    def self.asset_hash
+      manifest.files.reduce({}) do |memo, (key, value)|
+        memo.merge(value['logical_path'] => (context.digest_assets? ? key : value['logical_path']))
+      end
+    end
+
+    def self.manifest
+      Sprockets::Manifest.new(environment.assets.index, './public/assets')
+    end
+  end
+end

data/lib/js_asset_paths/version.rb

@@ -0,0 +1,3 @@
+module JsAssetPaths
+  VERSION = '0.1.0'
+end

data/lib/js_asset_paths.rb

@@ -0,0 +1,3 @@
+require 'js_asset_paths/version'
+require 'js_asset_paths/engine'
+require 'js_asset_paths/generator'

data/test/lib/engine_test.rb

@@ -0,0 +1,8 @@
+require_relative '../test_helper'
+
+describe JsAssetPaths::Engine do
+  it 'should do something' do
+    App.initialize!
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require 'minitest/autorun'
+
+require 'pry'
+
+ENV['RAILS_ENV'] = 'test'
+#require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+#require 'rails/test_help'
+require 'rails/all'
+
+require File.expand_path('../../lib/js_asset_paths.rb', __FILE__)
+
+class App < Rails::Application
+  config.eager_load = true
+
+  config.assets.enabled = true
+  config.assets.initialize_on_precompile = true
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: js-asset_paths
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sonnym
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !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: 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'
+description: Access paths to compiled assets from in javascript.
+email:
+- michaud.sonny@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/js-asset_paths.js.erb
+- js_asset_paths.gemspec
+- lib/js-asset_paths.rb
+- lib/js_asset_paths.rb
+- lib/js_asset_paths/engine.rb
+- lib/js_asset_paths/generator.rb
+- lib/js_asset_paths/version.rb
+- test/lib/engine_test.rb
+- test/test_helper.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.0.3
+signing_key: 
+specification_version: 4
+summary: Access paths to compiled assets from in javascript.
+test_files:
+- test/lib/engine_test.rb
+- test/test_helper.rb