diff --git a/.gitignore b/.gitignore index 2e1a28ad..303cff41 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,12 @@ coverage node_modules dump.rdb npm-debug.log + +bin/**/* +lib/**/* +new_project/**/* +node_modules/**/* +test/**/* *.tgz /docs.js test/fixtures/project/client/static/assets/abc diff --git a/CHANGELOG.md b/CHANGELOG.md index 3312b46c..424edeac 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,15 @@ + +## [0.4.5](https://github.com/socketstream/socketstream/compare/0.4.4...v0.4.5) (2015-10-17) + + +### Features + +* **bundler:** multi source require of custom bundlers ([4b344a4](https://github.com/socketstream/socketstream/commit/4b344a4)) +* **gulp:** ss.tasks.use(gulp) API for gulpfile integration ([319b6a1](https://github.com/socketstream/socketstream/commit/319b6a1)) +* **test:** added a task for testing transporters 'test-socketstream' ([9ee6721](https://github.com/socketstream/socketstream/commit/9ee6721)) + + + ## [0.4.4](https://github.com/socketstream/socketstream/compare/0.4.3...v0.4.4) (2015-09-27) @@ -226,5 +238,3 @@ the browser, and goes against a principle of simplicity. The require lookup is n * Add task `grunt changelog` ([fa3ebef8](https://github.com/socketstream/socketstream/commit/fa3ebef82cac66c8c41625f131b5c7d7572d1297)) * **lib:** Users can now pass the NODE_ENV to set the environment ([09bb6c0d](https://github.com/socketstream/socketstream/commit/09bb6c0d69fbe4a290d6c6292e590a918ef985ac)) * **utils:** Add `ss.api.log` unified logging API ([5fcd9527](https://github.com/socketstream/socketstream/commit/5fcd952765580e3e7f4cb206e1810028039b2f0a)) - - diff --git a/CNAME b/CNAME new file mode 100644 index 00000000..ae6eb89b --- /dev/null +++ b/CNAME @@ -0,0 +1 @@ +socketstream.com \ No newline at end of file diff --git a/Gruntfile.js b/Gruntfile.js index 77369aad..a60f4bb5 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -92,7 +92,7 @@ module.exports = function(grunt) { 'grunt build:docs', 'grunt is-clean:master', 'grunt version', //remove "-SNAPSHOT" from the project's version in package.json - 'grunt changelog' + 'npm changelog' ], 'release-complete': [ 'git commit CHANGELOG.md package.json -n -m "chore(release): v%version%"', @@ -112,14 +112,7 @@ module.exports = function(grunt) { 'git merge master', 'git checkout master' ] - }, - changelog: { - options: { - dest: 'CHANGELOG.md', - templateFile: 'src/docs/changelog.tpl.md', - github: 'socketstream/socketstream' - } - }, + } }); // Rename our watch task to 'delta', then make actual 'watch' @@ -236,4 +229,4 @@ module.exports = function(grunt) { grunt.registerTask('release:prepare', 'Run all the tests, generates CHANGELOG.md since laste release and and clean up version to just "major.minor.patch"', ['shell:release-prepare']); grunt.registerTask('release:complete', 'Complete release by commiting CHANGELOG.md and package.json and adding version tag', ['shell:release-complete', 'shell:update-gh-pages']); grunt.registerTask('release:push', 'Push to origin tags, master and gh-pages branches', ['shell:release-push']); -} \ No newline at end of file +} diff --git a/README.md b/README.md index ce679354..6a3ad5a7 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ SocketStream is a framework for Realtime Web Apps -_Latest release: 0.4.4 ([view changelog](https://github.com/socketstream/socketstream/blob/master/HISTORY.md))_ +_Latest release: 0.4.5 ([view changelog](https://github.com/socketstream/socketstream/blob/master/HISTORY.md))_ [Live demo](http://demo.socketstream.com) | [Documentation](http://socketstream.github.io/socketstream/docs/) @@ -86,7 +86,7 @@ This upcoming is expected in late 2015. The current state can be found on the `n *Creator:* Owen Barnes -*Core Contributors:* +*Core Contributors:* - Paul Jensen - Roman Minkin diff --git a/_config.yml b/_config.yml new file mode 100644 index 00000000..2f7efbea --- /dev/null +++ b/_config.yml @@ -0,0 +1 @@ +theme: jekyll-theme-minimal \ No newline at end of file diff --git a/docs/js/docs-setup.js b/docs/js/docs-setup.js index 516caa83..ea78fc17 100644 --- a/docs/js/docs-setup.js +++ b/docs/js/docs-setup.js @@ -12,7 +12,7 @@ NG_DOCS={ "type": "overview", "moduleName": "index", "shortDescription": "Documentation", - "keywords": "app assets best cdns clients code demand developing documentation engine events exceptions experiment extending formats gazillion github handling io low-level message middleware models multiple overview packing practices production protocols reload request responder responders single-page socketstream support template templates tutorials workers wrappers" + "keywords": "app assets best cdns clients code demand developing documentation engine events exceptions experiment extending formats gazillion github handling indirectly io low-level message middleware models modules multiple node overview packing practices production protocols reload request responder responders single-page socketstream support template templates tutorials workers wrappers" }, { "section": "tutorials", @@ -149,6 +149,15 @@ NG_DOCS={ "shortDescription": "Loading Assets On Demand", "keywords": "additional allowing allows app application assets assume asynchronously automatic better blocking browser built-in caching call callback called client client-side code command contacting create default demand directly directory distinct example execute fancy file folder freeze function future good haven icloud ignore inside instantly js large ll load loaded loading module modules mount multiple namespace nature normal note overview pack requested requests require required retrieved returned root sadly safely sake search sections send server small socketstream ss sub-directories subsequent syntax tutorials var ve writing" }, + { + "section": "tutorials", + "id": "modules", + "shortName": "Modules", + "type": "overview", + "moduleName": "Modules", + "shortDescription": "Loading Modules from app", + "keywords": "allows api app assets build built builtin builtinpath bundlers choose code defaultid dependencies development engines extension-less filename formatters function install internal internally isn js load loaded loading main matched modules overview passed path plugins production project relative require socketstream ss supplied template time tutorials" + }, { "section": "tutorials", "id": "production_hosting", @@ -194,6 +203,15 @@ NG_DOCS={ "shortDescription": "Testing your app", "keywords": "actions add allow allows app array assert automatically brand calling calls choice combination commands compared complete considering convert create created describe directly directory equal example experimental exports feature file files framework function future github globally goal going grunt grunt-cli help implementing install instance javascript js json lines ll major memory mkdir mock module node node_modules note npm number output overview package params perfect problems publish recommend releases reporting req request require res responders response return rpc scripts server server-side session sessions socketstream square ss stage start started string subsequent test tested testing tests things time tostring transport tutorials typing unique userid var" }, + { + "section": "tutorials", + "id": "serving_http_resources", + "shortName": "Serving HTTP Resources", + "type": "overview", + "moduleName": "Serving HTTP Resources", + "shortDescription": "Serving HTTP Resources", + "keywords": "ahead aim application apps assets base based caches centralised change client communication connect content continue crucial define defining deprecated devices direction directly edge endpoints event examples express extended fits form future going good http ideally identified implementation king middleware middlewares mobile model needed online overview paradigm permissions personal phones portal prepared pulls push real-time reason replaced resources rest router routing semantics serving side socketstream span ss streaming traditional tutorials url ve version website work works world wrong" + }, { "section": "tutorials", "id": "sessions", @@ -275,15 +293,6 @@ NG_DOCS={ "shortDescription": "The default bundler of HTML, CSS & JS", "keywords": "add allow api arguments array asset assetcss assethtml assetjs assetloader assets assetstart assettype assetworker attempt browser build bundle bundler called case cleancss client client-side code collection config content css default define depending describes dir directory entries entry extension file files function functions html htmltags implementation importedfrom includes initcode javascript js leading lib library libs list load loader local method minified minify module modules multiple names output pack path pre-loaded production pulled relative require resolveassetlink resource return script server service slash source special start started stopped strings system systemassets systemmodule tag tmpl tominifiedcss tominifiedjs type uglify unload vars view worker wrapcode wrapped wrapper" }, - { - "section": "api", - "id": "bundler.webpack:webpack", - "shortName": "webpack", - "type": "service", - "moduleName": "bundler", - "shortDescription": "The webpack bundler of HTML, CSS & JS", - "keywords": "api asset assettype bundler client collection concept css custom demonstration directory entries functions html improved initcode js libs list method modules output pack purposes relative service systemassets type validate view webpack" - }, { "section": "api", "id": "client", @@ -308,8 +317,8 @@ NG_DOCS={ "shortName": "formatters", "type": "service", "moduleName": "client", - "shortDescription": "Formatter registry", - "keywords": "api client formatter formatters registry service" + "shortDescription": "This is for the module returned by require('socketstream').client.formatters.", + "keywords": "add api asset client config configuring define formatter formatters method module nameormodule object parameters rendering require returned service socketstream" }, { "section": "api", @@ -317,8 +326,8 @@ NG_DOCS={ "shortName": "formatters", "type": "service", "moduleName": "client", - "shortDescription": "This is for the module returned by require('socketstream').client.formatters.", - "keywords": "add api asset client config configuring define formatter formatters method module nameormodule object parameters rendering require returned service socketstream" + "shortDescription": "Formatter registry", + "keywords": "api client formatter formatters registry service" }, { "section": "api", @@ -417,15 +426,6 @@ NG_DOCS={ "shortDescription": "Contains method stubs for logging to console (by default) or", "keywords": "api apply arguments assigning calls choose console debug default error fairly function happened info informed keeping level log logging method override parameters plugins provider require service socketstream ss stubs switch sysadmin takes time trace tracing trivial unexpected var wakeup warn winston" }, - { - "section": "api", - "id": "ss.orchestrator", - "shortName": "ss.orchestrator", - "type": "service", - "moduleName": "ss", - "shortDescription": "Internal Orchestrator for starting the server or building resources.", - "keywords": "api building currently experimental internal note orchestrator resources server service ss starting" - }, { "section": "api", "id": "ss.publish:publish", diff --git a/docs/partials/api/bundler.default.default.html b/docs/partials/api/bundler.default.default.html index 40ffb290..d9ccedf6 100644 --- a/docs/partials/api/bundler.default.default.html +++ b/docs/partials/api/bundler.default.default.html @@ -1,4 +1,4 @@ - Improve this doc View source
default
+ Improve this doc View sourcedefault
bundler
The default bundler of HTML, CSS & JS
Provides the view and the pack functions with a list of entries for an asset type relative to the client directory. The default implementation is used.
@@ -26,41 +26,41 @@| [AssetEntry] | List of output entries |
Called when the server is started. Does nothing.
Return entries for the loader/start/module depending on includes.system client config and system assets. Multiple arguments will attempt to add module for the name. Special module names are 'loader' and 'start'.
| AssetEntry | Resource entries array |
Called when the server is stopped. Does nothing.
Before client-side code is sent to the browser any file which is NOT a library (e.g. /client/code/libs) is wrapped in a module wrapper (to keep vars local and allow you to require() one file in another).
The 'system' directory is a special case - any module placed in this dir will not have a leading slash
diff --git a/docs/partials/api/bundler.html b/docs/partials/api/bundler.html index bb2011e5..d57ea8e4 100644 --- a/docs/partials/api/bundler.html +++ b/docs/partials/api/bundler.html @@ -1,4 +1,4 @@ - Improve this doc View sourcebundler
+ Improve this doc View sourcebundler
webpack
-bundler
-
-The webpack bundler of HTML, CSS & JS
-This is just for demonstration purposes and to validate the custom bundler concept. It can be improved.
-Provides the view and the pack functions with a -list of entries for an asset type relative to the client directory.
-| Param | Type | Details |
|---|---|---|
| assetType | String | js/css/tmpl - |
| systemAssets | Object | Collection of libs, modules, initCode - |
| [AssetEntry] | List of output entries - |
define
+ Improve this doc View sourcedefine
client
formatters
+ Improve this doc View sourceformatters
client
This is for the module returned by require('socketstream').client.formatters.
| Param | Type | Details |
|---|---|---|
| nameOrModule | stringobject | the formatter object or name |
| config | object | parameters configuring the formatter |
client
+ Improve this doc View sourceclient
task
+ Improve this doc View sourcetask
client
templateEngine
+ Improve this doc View sourcetemplateEngine
client
This is for the module returned by require('socketstream').client.templateEngine.
Generate output (as a string) from Template Engines
function(out) {
if (typeof out === 'string') {
@@ -26,7 +26,7 @@
Use a template engine for the 'dirs' indicated (will use it on all '/' dirs within /client/templates by default)
To make templates in /client/ember-view available in Ember.
ss.client.templateEngine.use('ember','./ember-view');
diff --git a/docs/partials/api/events.html b/docs/partials/api/events.html
index 9e286439..463055d4 100644
--- a/docs/partials/api/events.html
+++ b/docs/partials/api/events.html
@@ -1,4 +1,4 @@
- Improve this doc View sourceevents
+ Improve this doc View sourceevents
diff --git a/docs/partials/api/http.index.index.html b/docs/partials/api/http.index.index.html
index b5c67e06..97dcc11b 100644
--- a/docs/partials/api/http.index.index.html
+++ b/docs/partials/api/http.index.index.html
@@ -1,4 +1,4 @@
- Improve this doc View sourceindex
+ Improve this doc View sourceindex
service in module http
@@ -9,7 +9,7 @@
which can be used by the application in any way it wishes.
Attached Middleware, Session store, staticCache, etc, to the this.middleware (var app = connect())
| Param | Type | Details |
|---|---|---|
| staticPath | String | Static path for connect for serving static assets as |
| sessionStore | Object | Session store instance object @@ -17,14 +17,14 @@ |
| Object | Updated, with attached Middleware, this.middleware( |
Merge optional settings
| Param | Type | Details |
|---|---|---|
| newSettings | Object | Object with settins, @link settings |
router
+ Improve this doc View sourcerouter
http
Right now the router is simply an EventEmitter. This may change in the future
Try the original route first for speed. If none exists, recursively fall back until we find a route, if possible This allows us to fully support HTML5 pushState 'mock routing' across multiple single-page clients
| Param | Type | Details |
|---|---|---|
| url | String | Url to route diff --git a/docs/partials/api/ss.add.html b/docs/partials/api/ss.add.html index e7cbd9c1..0290f838 100644 --- a/docs/partials/api/ss.add.html +++ b/docs/partials/api/ss.add.html @@ -1,4 +1,4 @@ - Improve this doc View source
|
| object | Destinations paths, relPaths, dir, containerDir |
Describe a system module.
| Param | Type | Details | |||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| name | String | Name of the system module to return in a descriptor | |||||||||||||||||||||||||||||||||||||||||||||||||||
| wrap | boolean | Shall the content be wrapped in
|
| Param | Type | Details | |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| type | 'code','lib','module' |
|
| Param | Type | Details | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| channel | stringarray | Name of the channel(s) | ||||||||||||||||||||||||||||||||||||
| event | string | Name of the event diff --git a/docs/partials/api/ss.root.html b/docs/partials/api/ss.root.html index edb8f814..8ee388ef 100644 --- a/docs/partials/api/ss.root.html +++ b/docs/partials/api/ss.root.html @@ -1,4 +1,4 @@ - Improve this doc View source
|
| Param | Type | Details |
|---|---|---|
| basepath | Object | Path to directory |
| Array|null | Array of files or isDir()+isDir()In synchronous mode returns if givven Returns
loadPackageJSON()+loadPackageJSON()Loads SocketStream's package.json file from the root directory Returns
readDirSync(start)+readDirSync(start)Reads the contents of a dir. Adapted from https://gist.github.com/825583 Parameters
utils
|
| Param | Type | Details |
|---|---|---|
| len | String | Length of the expected string |
| String | uuid string diff --git a/docs/partials/api/utils.unique_set.UniqueSet.html b/docs/partials/api/utils.unique_set.UniqueSet.html index 4a82d8a3..0d2641ab 100644 --- a/docs/partials/api/utils.unique_set.UniqueSet.html +++ b/docs/partials/api/utils.unique_set.UniqueSet.html @@ -1,4 +1,4 @@ - Improve this doc View source
|
| Array | Array of all the keys for specified |
Remove all specific key/value sets accotding to value
| Param | Type | Details |
|---|---|---|
| value | Mixed | Value as a link for removal all the sets |
| Boolean | Removal status diff --git a/docs/partials/tutorials/index.html b/docs/partials/tutorials/index.html index 961f7a3c..2b1364d2 100644 --- a/docs/partials/tutorials/index.html +++ b/docs/partials/tutorials/index.html @@ -28,6 +28,7 @@Best PracticesExtending SocketStream
+ |