Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gamtiq/amd-proc-plugin
AMD proc! plugin that loads resource file and applies some transformation to its contents
https://github.com/gamtiq/amd-proc-plugin
Last synced: about 7 hours ago
JSON representation
AMD proc! plugin that loads resource file and applies some transformation to its contents
- Host: GitHub
- URL: https://github.com/gamtiq/amd-proc-plugin
- Owner: gamtiq
- Created: 2013-08-30T19:46:13.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2014-07-02T18:02:33.000Z (over 10 years ago)
- Last Synced: 2024-04-14T23:00:02.510Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 223 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## AMD proc! plugin.
Compatible with [curl.js](https://github.com/cujojs/curl) and [require.js](http://requirejs.org/).
This plugin loads resource file using specified plugin, applies some procedure/transformation to resource's content and returns result of transformation.
If no procedure is applied the original resource's content will be returned.
The procedure that should be applied can be specified at the end of resource name after exclamation sign `!` in the following form:
`![...]`
where `separator` is `^` by default (can be configured).
Parameters are optional. They are strings that will be passed into the procedure after resource's content (which is zero parameter).
For example:
`path/to/some/template!compile^debug`
where `compile` is the name of registered/configured procedure, `debug` is the string that should be passed into the procedure
after template's content.
If procedure name is not specified in the resource name, the default procedure will be used.
When procedure name is not specified in the resource name, the resource loader also should be omitted in the resource name.
Otherwise plugin does not work correctly.
So default procedure can be used only with default resource loader (see below).
## Configuration
The following configuration settings are supported (name - type - description):
* `defaultExt` - `String` - default file extension that is used if it is not specified inside resource name;
the default value is `'html'`.
* `default` - `Function`, `Object`, `String` - the procedure that should be used by default when procedure is not specified inside resource name;
can be a function, an object that has method with name `execute`, or a name of one of registered/configured procedures.
* `loader` - `String` - default loader/plugin (without trailing exclamation sign) that should be used when loader is not specified inside resource name;
the default value is `'text'`.
* `paramSeparator` - `String` - separator for procedure parameters that are specified inside resource name;
the default value is `'^'`.
* `proc` - `Object` - map of registered procedures; keys are names of procedures, values are corresponding procedures;
procedure can be a function or an object that has method with name `execute`;
the resource's content will be passed into the function/method to get the result that plugin will return.
Configuration example for `curl.js`:
```js
curl.config({
packages: {
proc: {
location: "path/to/plugins/proc",
main: "proc"
}
},
pluginPath: "path/to/plugins",
plugins: {
proc: {
proc: {
template: function(text) {
...
},
reverse: function(text) {
return text.split("").reverse().join("");
}
},
"default": "reverse"
}
}
});
```
Configuration example for `require.js`:
```js
require.config({
packages: [
{
name: "proc",
location: "path/to/plugins/proc",
main: "proc"
}
],
paths: {
text: "path/to/plugins/text"
},
config: {
"proc/proc": {
proc: {
template: function(text) {
...
},
reverse: function(text) {
return text.split("").reverse().join("");
}
},
"default": "reverse"
}
}
});
```
Configuration settings have priority over settings that are set by module API functions (see below).
## Dependencies
* `./util/base` module
* plugins to load resources (for example, `text` plugin)
## Usage
```javascript
// loads some/folder/view.html using default loader and applies the default procedure (supposed that 'html' is set as default extension)
define(['proc!some/folder/view'], function(view) {...});
// loads some/folder/view.tmpl using default loader and applies template procedure
define(['proc!some/folder/view.tmpl!template'], function(view) {...});
// loads some/folder/data.json using json! loader plugin and applies prepare procedure
define(['proc!json!some/folder/data.json!prepare'], function(data) {...});
// loads some/folder/data.json using json! loader plugin and applies value procedure with specified parameter
define(['proc!json!some/folder/data.json!value^path.to.value'], function(someValue) {...});
```
## Module API
The following functions can be used to configure plugin's work.
All functions except `getProc` are chainable i.e. they return `this`.
Usage example:
```javascript
curl(["path/to/plugin/proc"], function(proc) {
proc.setProc("p1", function() {...})
.setProc("p2", {data: ..., execute: function() {...}})
.setDefaultProc("p1")
.setParamSeparator("#");
});
```
Settings made by the following functions can be used along with configuration settings but the latter have priority.
### setProc(sProcName: String, proc: Function|Object)
Registers/adds the procedure to the list of available procedures.
The value of `sProcName` parameter is used to get access to the procedure.
The `proc` parameter specifies procedure that is used to process a resource.
The value of the `proc` parameter can be a function or an object that has method with name `execute`.
The resource will be passed into the function/method to get the result that plugin will return.
### getProc(sProcName: String): Function|Object
Returns available/registered procedure with the specified name.
Returns `null` if procedure with the name is not registered.
### removeProc(sProcName: String)
Removes the procedure from the list of available/registered procedures.
### setDefaultProc(proc: Function|Object|String)
Sets the procedure that should be used by default when no procedure is specified inside resource name.
The value of `proc` parameter can be a function, an object that has method with name `execute`, or a name of one of available procedures.
### setDefaultExt(sExt: String)
Sets the default file extension that is used if it is not specified inside resource name.
### setDefaultLoader(sExt: sLoader)
Sets the default loader/plugin that should be used when it is not specified inside resource name.
The value of the parameter should represent plugin name without the trailing exclamation sign (e.g. `'text'` or '[view](https://github.com/gamtiq/amd-view-plugin)').
### setParamSeparator(sSeparator: String)
Sets the separator for procedure parameters that are specified inside resource name.
## Related project
Possibly you might find helpful [amd-view-plugin](https://github.com/gamtiq/amd-view-plugin).
## Licence
MIT