0.02
No commit activity in last 3 years
No release in over 3 years
JS module system for Ruby on Rails 4 Assets Pipeline that solves scripts order issues
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 1.7
~> 10.0

Runtime

>= 4.0
 Project Readme

modulejs for Ruby on Rails 4 Assets Pipeline

Lightweight JavaScript module system (http://larsjung.de/modulejs/), v2.2.0. Inspired by article: https://www.reinteractive.net/posts/172-a-better-way-to-modularise-your-js-in-rails

When you want to use modules in JavaScript you should solve next problems:

  1. Load scripts with dependencies, usually in big concatenated JavaScript file
  2. Execute scripts and dependencies in proper order

Rails solves problem #1 by Assets Pipeline, modulejs solves problem #2.

Installation

Add this line to your application's Gemfile:

gem 'modulejs-rails'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install modulejs-rails

Usage

Require modulejs in Assets Pipeline manifest

//= require 'modulejs'

Define your own modules (this in functions points to window):

modulejs.define('bar', ['foo'], function (foo) {
    // module setup code and definitions
    return some_bar_object;
});

Or setup 3rd party code:

modulejs.define('foo', Foo);

And require them when needed:

var bar = modulejs.require('bar');
bar.doStuff();

See full documentation here: https://larsjung.de/modulejs/

Contributing

  1. Fork it ( https://github.com/ales-vilchytski/modulejs-rails/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