voltron 0.2.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f75ee10db1c67be76630fbde0171570e47148831be889eb03e88c6bac48d4dc6
+  data.tar.gz: 3ce73bd1a9018ec0cd5a5141245388fb9cb779b742964b21bf6e7caa180c19c8
+SHA512:
+  metadata.gz: 85234a7d92da9c47826948272ffaedefce7a836a5e3679bd90000eeb127c72460fbc8a872264c3aa68c6002d6f4ff29579d0e47415420fba8db2d6c2e2083ae2
+  data.tar.gz: '08d7f7db6cacce3aff55bc7fdaf531ffdfb37eac0ba7dffd0c55ff658cb47dec68e6dae6301ed58368f1efc446e4d18b5344f65af4d4ad91a56faf5c681bec59'

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+tmp/
+log/
+voltron-*.gem
+*.bak
+*.sqlite3

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+  - 2.3.1
+  - 2.3.3
+  - 2.4.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at eric.hainer@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in voltron.gemspec
+gemspec
+
+group :development do
+  gem 'sass'
+end
+
+group :test do
+  gem 'coveralls', require: false
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Eric
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Eric Hainer
+
+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,36 @@
+[![Coverage Status](https://coveralls.io/repos/github/ehainer/voltron/badge.svg?branch=master)](https://coveralls.io/github/ehainer/voltron?branch=master)
+[![Build Status](https://travis-ci.org/ehainer/voltron.svg?branch=master)](https://travis-ci.org/ehainer/voltron)
+[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)
+
+# Voltron
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/voltron`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'voltron', '~> 0.2.6'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install voltron
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/voltron. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [GNU General Public License](https://www.gnu.org/licenses/gpl-3.0.en.html).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/assets/javascripts/voltron-core.js

@@ -0,0 +1,282 @@
+window.Voltron = (function(cmd){
+  var command = cmd.split('/', 2);
+  var module = command[0];
+  var method = command[1] || 'initialize';
+
+  if(Voltron.hasModule(module)){
+    var mod = Voltron.getModule(module);
+    if($.isFunction(mod[method])){
+      return mod[method].apply(mod, Array.prototype.slice.call(arguments, 1));
+    }else{
+      Voltron.debug('error', 'Module %o does not define the method %o', module, method);
+    }
+  }else{
+    Voltron.debug('error', 'Module with name %o does not exist.', module);
+  }
+  return false;
+});
+
+$.extend(Voltron, {
+  _config: {},
+  _observer: {},
+  _modules: {},
+  _classes: {},
+  _logLevels: ['debug', 'info', 'warn', 'error', 'fatal', 'unknown'],
+  _logMapping: {
+    log: 0,
+    info: 1,
+    warn: 2,
+    error: 3
+  },
+
+  _inherited: {
+    _name: null,
+
+    name: function(){
+      return this._name;
+    },
+
+    getDependencies: function(){
+      return this._dependencies;
+    },
+
+    canReceiveEvents: function(){
+      return Voltron.canRun(this.name());
+    },
+  },
+
+  initialize: function(conf){
+    if(!conf) conf = {};
+    $.extend(this._config, conf);
+
+    // Try and create a module with the name of the current controller
+    //if(this.hasModule(this.getConfig('controller'))){
+    //  this.ready(Voltron.loadModule, this.getConfig('controller'));
+    //}
+  },
+
+  // When ready, fire the callback function, passing in any additional args
+  ready: function(callback, args){
+    $(document).ready(function(){
+      if(!$.isArray(args)) args = [args];
+      callback.apply(Voltron, args);
+    });
+    return this;
+  },
+
+  debug: function(){
+    // IE/Edge only expose console when dev tools is open. Check for it's existence before attempting to call log/warn/error/info
+    if(this.isDebugging() && console){
+      var logLevelDefined = arguments.length > 2 && typeof arguments[1] == 'number';
+      var method = arguments[0];
+      var level = (logLevelDefined ? arguments[1] : this._logMapping[method]);
+      var args = Array.prototype.slice.call(arguments, (logLevelDefined ? 2 : 1));
+      if(level >= this.getLogLevel()){
+        console[method].apply(console, args);
+      }
+    }
+    return this;
+  },
+
+  getLogLevel: function(){
+    var level = this.getConfig('log_level', 0);
+    if(typeof level == 'number'){
+      return (level >= 0 && level <= 5 ? level : 5); // If in range, return the number, otherwise: 'unknown'
+    }
+    var index = this._logLevels.indexOf(level);
+    return (index >= 0 && index <= 5 ? index : 5); // Return the index of the defined level, otherwise: 'unknown'
+  },
+
+  getBaseUrl: function(){
+    if(!location.origin) location.origin = location.protocol + '//' + location.host;
+    return location.origin;
+  },
+
+  getPath: function(url){
+    if(!url) url = window.location.href;
+    return url.replace(this.getBaseUrl(), '');
+  },
+
+  // Get a config value, optionally define a default value in the event the config param is not defined
+  getConfig: function(key, def){
+    var out = this._config;
+    if(!key) return out;
+    var paths = key.replace(/(^\/+)|(\/+$)/g, '').split('/');
+
+    $.each(paths, function(index, path){
+      if(out[path] != undefined){
+        out = out[path];
+      }else{
+        out = def;
+        return false;
+      }
+    });
+
+    return out;
+  },
+
+  canRun: function(name){
+    var module = this._modules[name.toLowerCase()];
+    return module['run'] === true || ((this.isController(module['run']) || this.isController(name)) && module['run'] !== false);
+  },
+
+  // Set a config value. Supports xpath syntax to change nested key values
+  // i.e. setConfig('a/b/c', true); will change the value of "c" to true
+  setConfig: function(key, value){
+    var out = this._config;
+    var paths = key.replace(/(^\/+)|(\/+$)/g, '').split('/');
+    var change = paths.pop();
+
+    $.each(paths, function(index, path){
+      if(out[path] != undefined){
+        out = out[path];
+      }else{
+        out = out[path] = {};
+      }
+    });
+
+    out[change] = value;
+    return this;
+  },
+
+  // Similar to setConfig, except this will instead treat the config `key` value as an array, and add the value to it
+  addConfig: function(key, value){
+    if(!this._config[key]) this._config[key] = [];
+    this._config[key].push(value);
+    return this;
+  },
+
+  getAuthToken: function(){
+    return this.getConfig('auth_token', '');
+  },
+
+  // Are we in debug mode?
+  isDebugging: function(){
+    return this.getConfig('debug', false);
+  },
+
+  isController: function(controllers){
+    return $.map([controllers].flatten().compact(), function(c){ return c.toLowerCase(); }).includes(this.getConfig('controller'));
+  },
+
+  // Dispatch an event, optionally providing some additional params to pass to the event listener callback
+  dispatch: function(event, params, modules){
+    if(!$.isPlainObject(params)) params = {};
+    if(!modules) modules = Object.keys(this._modules);
+    var method = Voltron('Dispatch/getDispatchMethod', event, '');
+    params = $.extend(true, { element: null, event: $.Event(event), data: {} }, params);
+
+    $.each([modules].flatten(), $.proxy(function(index, module){
+      var mod = this.getModule(module);
+      if(mod){
+        if($.isFunction(mod[method])){
+          Voltron.debug('info', 'Dispatching %o to %o module with observer object: %o', method, mod.name(), params);
+          mod[method].call(mod, params);
+        }else{
+          Voltron.debug('log', 'Attempted to dispatch %o in %o module with observer object: %o', method, mod.name(), params);
+        }
+      }
+    }, this));
+    return null;
+  },
+
+  // Check if a module with the given name has been added
+  hasModule: function(id){
+    return this._modules[id.toLowerCase()] && $.isFunction(this._modules[id.toLowerCase()]['module']);
+  },
+
+  // Add a module, specifying the name (id), the module itself (should be an object or a function that returns such)
+  // Optionally provide `true`, or an array of controller names as the last argument to auto instantiate when added either
+  // all the time (if true), or on the specified controllers
+  addModule: function(){
+    var id = arguments[0];
+    var depends = $.isFunction(arguments[1]) ? [] : arguments[1];
+    var module  = $.isFunction(arguments[1]) ? arguments[1] : arguments[2];
+    var run     = $.isFunction(arguments[1]) ? arguments[2] : arguments[3];
+
+    if(!this.hasModule(id)){
+      id = $.camelCase(id).replace(/\b[a-z]/g, function(letter){
+        return letter.toUpperCase();
+      });
+      this[id] = module;
+      this._modules[id.toLowerCase()] = { module: module, run: run, depends: [depends].flatten() };
+    }
+
+    this.ready(function(){
+      var sortedModules = Object.keys(Voltron._modules);
+      sortedModules.sort();
+
+      for(var i=0; i<sortedModules.length; i++){
+        this.loadModule(sortedModules[i]);
+      }
+    });
+    return this;
+  },
+
+  // Get a module with the given name from the list of modules
+  getModule: function(name, args){
+    var id = name.toLowerCase();
+    var module = this._modules[id];
+
+    name = $.camelCase(name).replace(/\b[a-z]/g, function(letter){
+      return letter.toUpperCase();
+    });
+
+    if(this.hasModule(id)){
+      return this.loadModule(name, true, args);
+    }else{
+      this.debug('warn', 'Module with name %o does not exist.', name);
+    }
+    return false;
+  },
+
+  loadModule: function(name, force, args){
+    var id = name.toLowerCase();
+
+    name = $.camelCase(name).replace(/\b[a-z]/g, function(letter){
+      return letter.toUpperCase();
+    });
+
+    if(!args) args = [];
+    if(!this._classes[id]){
+      var module = new this._modules[id]['module']($);
+      // Add some inherited methods... shortcuts, if you will
+      module = $.extend(module, this._inherited);
+      // Add the name to the module
+      module._name = name;
+      // Add the dependencies to the module
+      module._dependencies = this._modules[id]['depends'];
+
+      if(force || this.canRun(name)){
+        this._classes[id] = module;
+
+        var dependencies = this._classes[id].getDependencies();
+        for(var i=0; i<dependencies.length; i++){
+          if(dependencies[i] == '*'){
+            var sortedModules = Object.keys(this._modules);
+            sortedModules.sort();
+            for(var j=0; j<sortedModules.length; j++){
+              this.loadModule(sortedModules[j], true);
+            }
+          }else{
+            this.loadModule(dependencies[i], true);
+          }
+        }
+
+        // If there is an initialize function, call it, dispatching before/after events
+        if($.isFunction(this._classes[id].initialize)){
+          this._classes[id].initialize.apply(this._classes[id], args);
+        }
+        // Tell the user we've created the module
+        this.debug('info', 'Instantiated %o', name);
+      }
+    }
+    return this._classes[id]
+  }
+});
+
+if(typeof V != 'undefined'){
+  if(console) console.warn('The window variable %o is already defined, so shortcut to %o will not be defined.', 'V', 'Voltron');
+}else{
+  window.V = window.Voltron;
+}