RubyGems - amd - Versions diffs - 0.1.1 - Mend

amd 0.1.1

Files changed (75) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +82 -0
data/Rakefile +37 -0
data/app/assets/config/amd_manifest.js +1 -0
data/app/assets/javascripts/amd/amd.js.coffee.erb +70 -0
data/app/controllers/amd/application_controller.rb +5 -0
data/app/controllers/amd/assets_controller.rb +4 -0
data/app/helpers/amd/application_helper.rb +4 -0
data/app/jobs/amd/application_job.rb +4 -0
data/app/mailers/amd/application_mailer.rb +6 -0
data/app/models/amd/application_record.rb +5 -0
data/app/views/layouts/amd/application.html.erb +14 -0
data/config/routes.rb +3 -0
data/lib/amd.rb +5 -0
data/lib/amd/controller_helper.rb +11 -0
data/lib/amd/engine.rb +20 -0
data/lib/amd/version.rb +3 -0
data/lib/tasks/amd_tasks.rake +4 -0
data/test/amd_test.rb +7 -0
data/test/dummy/Rakefile +6 -0
data/test/dummy/app/assets/config/manifest.js +5 -0
data/test/dummy/app/assets/javascripts/application.js +13 -0
data/test/dummy/app/assets/javascripts/cable.coffee +11 -0
data/test/dummy/app/assets/stylesheets/application.css +15 -0
data/test/dummy/app/channels/application_cable/channel.rb +5 -0
data/test/dummy/app/channels/application_cable/connection.rb +5 -0
data/test/dummy/app/controllers/application_controller.rb +5 -0
data/test/dummy/app/helpers/application_helper.rb +2 -0
data/test/dummy/app/jobs/application_job.rb +2 -0
data/test/dummy/app/mailers/application_mailer.rb +4 -0
data/test/dummy/app/models/application_record.rb +3 -0
data/test/dummy/app/views/layouts/application.html.erb +15 -0
data/test/dummy/app/views/layouts/mailer.html.erb +13 -0
data/test/dummy/app/views/layouts/mailer.text.erb +1 -0
data/test/dummy/bin/bundle +3 -0
data/test/dummy/bin/rails +4 -0
data/test/dummy/bin/rake +4 -0
data/test/dummy/bin/setup +34 -0
data/test/dummy/bin/update +29 -0
data/test/dummy/config.ru +8 -0
data/test/dummy/config/application.rb +15 -0
data/test/dummy/config/boot.rb +5 -0
data/test/dummy/config/cable.yml +10 -0
data/test/dummy/config/database.yml +25 -0
data/test/dummy/config/environment.rb +5 -0
data/test/dummy/config/environments/development.rb +62 -0
data/test/dummy/config/environments/production.rb +87 -0
data/test/dummy/config/environments/test.rb +42 -0
data/test/dummy/config/initializers/active_record_belongs_to_required_by_default.rb +6 -0
data/test/dummy/config/initializers/application_controller_renderer.rb +6 -0
data/test/dummy/config/initializers/assets.rb +11 -0
data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/test/dummy/config/initializers/callback_terminator.rb +6 -0
data/test/dummy/config/initializers/cookies_serializer.rb +5 -0
data/test/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/test/dummy/config/initializers/inflections.rb +16 -0
data/test/dummy/config/initializers/mime_types.rb +4 -0
data/test/dummy/config/initializers/per_form_csrf_tokens.rb +4 -0
data/test/dummy/config/initializers/request_forgery_protection.rb +4 -0
data/test/dummy/config/initializers/session_store.rb +3 -0
data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
data/test/dummy/config/locales/en.yml +23 -0
data/test/dummy/config/puma.rb +47 -0
data/test/dummy/config/routes.rb +3 -0
data/test/dummy/config/secrets.yml +22 -0
data/test/dummy/public/404.html +67 -0
data/test/dummy/public/422.html +67 -0
data/test/dummy/public/500.html +66 -0
data/test/dummy/public/apple-touch-icon-precomposed.png +0 -0
data/test/dummy/public/apple-touch-icon.png +0 -0
data/test/dummy/public/favicon.ico +0 -0
data/test/integration/navigation_test.rb +8 -0
data/test/test_helper.rb +20 -0
metadata +202 -0

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8fa8e2b124a30e3226b93f35556da9c39f28131b
+  data.tar.gz: f6eec3642198a8cb3540cb0c0367dc28453c0dbb
+SHA512:
+  metadata.gz: 2626adab9ceac40f945f70893627a02d0417b925273315e68f4ef5be03ab71eb9cb5866858e4334d4e7e563d33e0218ef5f8690ad6ca4221d836f0366681e745
+  data.tar.gz: 1ca6546f31fa1babee26fa8e517f20eae2453401f3b0c0173106049f74af583fc627181be75990bb7a537a73f2a7bd499784d8a9712446ac1373aa89888cb6d6

data/MIT-LICENSE ADDED

@@ -0,0 +1,20 @@
+Copyright 2016 Sameer Rahmani
+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 ADDED

@@ -0,0 +1,82 @@
+# AMD
+Async module definition for rails assets pipeline. It's simple, fast and can be used with assets pipeline manifest structure.
+For example you still can have your assets pipeline manifest but load several js files in async fashion base on your controller
+path.
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'amd'
+```
+And then execute:
+```bash
+$ bundle
+```
+Or install it yourself as:
+```bash
+$ gem install amd
+```
+Require `amd/amd` on your js manifest like this:
+```javascript
+//application.js
+//= require amd/amd
+```
+**NOTE:** If you're using `Turbolinks` without `jquery-turbolinks` make sure to add the `guess_module` function to your `page:changed`
+event handler.
+and finally add this snippet to your layout's body tag:
+```eruby
+<body ... data-action='<%= AMD::Engine.amd_module(self) %>'>
+```
+Now sit back and enjoy using `AMD`.
+## Usage
+By default `amd` tries to load a js module based on your controller details for example for 'xyz/some_resource#index` controller and
+action, `amd` tries to load a file with this address `/assets/xyz/amd/some_resource/index` (`/assets` is the prefix of assets pipe line of rails)
+the default module path construct like this:
+```ruby
+# amd_dir is 'amd' by default
+asset_path("#{controller_path}/#{amd_dir}/#{controller_name}/#{action}")
+```
+To define an AMD module you need to create file based on the described module path with `.amd.(js|js.coffee)` or any lang prefix that you use.
+AMD gem add these files to precompile list. `AMD` gem has a simple DSL that you should use in your code in order to use a very basic dependency
+injection for your module.
+To define a module you can do as follow:
+```javascript
+define('module_name', ['dependency_A', 'dependency_B'], function(dependency_a, dependency_b) {
+  // your module code.
+  return your_module_object;
+});
+```
+You are probably familiar with this syntax.
+**NOTE:** module_name should be the same as module_path, in face `AMD` uses your module_name as module_path.
+This is all you need but for an advance use, there is a `require` function which load a module using its name.
+You may need this
+## Credit
+![Yellowen](http://www.yellowen.com/images/logo.png)
+**AMD**  is maintained and funded by Yellowen. Whenever a code snippet is borrowed or inspired by
+existing code, we try to credit the original developer/designer in our source code. Let us know if you
+think we have forgotten to do this, and we will do our best to locate the problem and fix it in a timely
+manner.
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile ADDED

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+require 'rdoc/task'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Amd'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+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/config/amd_manifest.js ADDED

	@@ -0,0 +1 @@
1	+ //= link_directory ../javascripts/amd .js

data/app/assets/javascripts/amd/amd.js.coffee.erb ADDED

@@ -0,0 +1,70 @@
+window.__amd_table__ = {}
+window.modules       = {}
+# Guess the js module to load from the action name
+window.guess_module = ->
+  action_module = $("body").data('action');
+  require action_module
+# Lookup the module path
+window.to_module_path = (dep) ->
+  path = dep #window.__amd_table__[dep]
+  if path == undefined
+    console.warn "Can't find url of '" + dep + "' module in amd table."
+    return undefined
+  return path
+# Fetch the js module
+window.fetch_js = (url, callback) ->
+  console.log("Fetching ", url)
+  # Adding the script tag to the head as suggested before
+  body        = document.getElementsByTagName('body')[0]
+  script      = document.createElement 'script'
+  script.type = 'text/javascript'
+  script.src  = "<%= AMD::Engine.amd_dir %>/" + url
+  # Then bind the event to the callback function.
+  # There are several events for cross browser compatibility.
+  script.onreadystatechange = callback
+  script.onload             = callback
+  # Fire the loading
+  body.appendChild script
+window.define = (name, deps, fn) ->
+  console.group('Define ' + name)
+  modules_to_inject = []
+  window.modules[name] = {
+    name: name,
+    deps: deps,
+    fn: fn
+  }
+  console.log('Dependencies: ', deps)
+  deps.each (dep) ->
+    m = window.modules[dep]
+    if m == undefined
+      m = require(dep)
+    modules_to_inject.push m if m != undefined
+    # end each
+  console.groupEnd('Define ' + name);
+  fn.apply(fn, modules_to_inject)
+window.require = (module_name) ->
+  path = to_module_path(module_name)
+  if path != undefined
+    m = fetch_js path, ->
+      console.log('Module "' + module_name +"' loaded")
+    return m
+  return undefined

data/app/controllers/amd/application_controller.rb ADDED

@@ -0,0 +1,5 @@
+module Amd
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/amd/assets_controller.rb ADDED

@@ -0,0 +1,4 @@
+class AMD::AssetsController < ::ApplicationController
+  include ::AMD::ControllerHelper
+end

data/app/helpers/amd/application_helper.rb ADDED

@@ -0,0 +1,4 @@
+module AMD
+  module ApplicationHelper
+  end
+end

data/app/jobs/amd/application_job.rb ADDED

@@ -0,0 +1,4 @@
+module Amd
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/amd/application_mailer.rb ADDED

@@ -0,0 +1,6 @@
+module Amd
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/amd/application_record.rb ADDED

@@ -0,0 +1,5 @@
+module Amd
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/amd/application.html.erb ADDED

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Amd</title>
+  <%= stylesheet_link_tag    "amd/application", media: "all" %>
+  <%= javascript_include_tag "amd/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>

data/config/routes.rb ADDED

@@ -0,0 +1,3 @@
+AMD::Engine.routes.draw do
+  get '/amd/:asset', to: 'assets#finder'
+end

data/lib/amd.rb ADDED

@@ -0,0 +1,5 @@
+require 'amd/engine'
+module AMD
+  # Your code goes here...
+end

data/lib/amd/controller_helper.rb ADDED

@@ -0,0 +1,11 @@
+module AMD::ControllerHelper
+  def finder
+    path = "#{params[:asset]}.amd"
+    # It's important that the arg passed to asset_path already
+    # be in precompile list
+    module_path = ActionController::Base.helpers.asset_path(path,
+                                                            type: :javascript)
+    redirect_to module_path
+  end
+end

data/lib/amd/engine.rb ADDED

@@ -0,0 +1,20 @@
+module AMD
+  class Engine < ::Rails::Engine
+    isolate_namespace AMD
+    initializer 'amd.configuration.assets' do |app|
+      app.config.assets.precompile = %w( *.amd.js* amd.js.coffee ) + app.config.assets.precompile
+    end
+    def setup
+      yield self
+    end
+    mattr_accessor :amd_dir
+    @@amd_dir = 'amd'
+    def self.amd_module(controller)
+      "#{controller.controller_path}/amd/#{controller.controller_name}/#{controller.action_name}"
+    end
+  end
+end

data/lib/amd/version.rb ADDED

@@ -0,0 +1,3 @@
+module AMD
+  VERSION = '0.1.1'
+end

data/lib/tasks/amd_tasks.rake ADDED

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :amd do
+#   # Task goes here
+# end

data/test/amd_test.rb ADDED

@@ -0,0 +1,7 @@
+require 'test_helper'
+class Amd::Test < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Amd
+  end
+end

data/test/dummy/Rakefile ADDED

@@ -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/config/manifest.js ADDED

@@ -0,0 +1,5 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link amd_manifest.js

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

@@ -0,0 +1,13 @@
+// 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. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/javascripts/cable.coffee ADDED

@@ -0,0 +1,11 @@
+# Action Cable provides the framework to deal with WebSockets in Rails.
+# You can generate new channels where WebSocket features live using the rails generate channel command.
+#
+# Turn on the cable connection by removing the comments after the require statements (and ensure it's also on in config/routes.rb).
+#
+#= require action_cable
+#= require_self
+#= require_tree ./channels
+#
+# @App ||= {}
+# App.cable = ActionCable.createConsumer()

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

@@ -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 other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/channels/application_cable/channel.rb ADDED

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file. Action Cable runs in a loop that does not support auto reloading.
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/test/dummy/app/channels/application_cable/connection.rb ADDED

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file. Action Cable runs in a loop that does not support auto reloading.
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

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

@@ -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/helpers/application_helper.rb ADDED

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

data/test/dummy/app/jobs/application_job.rb ADDED

	@@ -0,0 +1,2 @@
1	+ class ApplicationJob < ActiveJob::Base
2	+ end

data/test/dummy/app/mailers/application_mailer.rb ADDED

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/test/dummy/app/models/application_record.rb ADDED

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end