From d120dd2af55f9fdbcb9dfa8301d97d74fb3b7f77 Mon Sep 17 00:00:00 2001 From: Sergi Tur Badenas Date: Fri, 14 Apr 2017 15:27:20 +0200 Subject: [PATCH] Added support for multiple environments. Added examples for every environment. Updated docs README.md --- .babelrc | 4 + .gitignore | 3 + README.md | 90 +++++++- examples/browser/index.html | 103 +++++++++ examples/browser/package.json | 19 ++ examples/browser/register.js | 48 ++++ examples/es6/.babelrc | 14 ++ examples/es6/.editorconfig | 9 + examples/es6/.eslintignore | 2 + examples/es6/.eslintrc.js | 28 +++ examples/es6/.gitignore | 6 + examples/es6/.postcssrc.js | 8 + examples/es6/README.md | 21 ++ examples/es6/build/build.js | 35 +++ examples/es6/build/check-versions.js | 48 ++++ examples/es6/build/dev-client.js | 9 + examples/es6/build/dev-server.js | 89 ++++++++ examples/es6/build/utils.js | 71 ++++++ examples/es6/build/vue-loader.conf.js | 12 + examples/es6/build/webpack.base.conf.js | 67 ++++++ examples/es6/build/webpack.dev.conf.js | 35 +++ examples/es6/build/webpack.prod.conf.js | 120 ++++++++++ examples/es6/config/dev.env.js | 6 + examples/es6/config/index.js | 38 ++++ examples/es6/config/prod.env.js | 3 + examples/es6/index.html | 27 +++ examples/es6/package.json | 73 +++++++ examples/es6/src/App.vue | 17 ++ .../es6/src/components/InitializeIcheck.js | 20 ++ examples/es6/src/components/RegisterForm.vue | 122 +++++++++++ examples/es6/src/main.js | 24 ++ examples/es6/static/.gitkeep | 0 examples/lib/acacha-forms.min.js | 1 + examples/node/index.js | 20 ++ examples/server/db.json | 206 ++++++++++++++++++ examples/server/package.json | 19 ++ examples/server/server.js | 14 ++ examples/server/validate.js | 17 ++ package.json | 12 +- src/Form.js | 21 ++ webpack.config.js | 42 ++++ 41 files changed, 1517 insertions(+), 6 deletions(-) create mode 100644 .babelrc create mode 100644 examples/browser/index.html create mode 100644 examples/browser/package.json create mode 100644 examples/browser/register.js create mode 100644 examples/es6/.babelrc create mode 100644 examples/es6/.editorconfig create mode 100644 examples/es6/.eslintignore create mode 100644 examples/es6/.eslintrc.js create mode 100644 examples/es6/.gitignore create mode 100644 examples/es6/.postcssrc.js create mode 100644 examples/es6/README.md create mode 100644 examples/es6/build/build.js create mode 100644 examples/es6/build/check-versions.js create mode 100644 examples/es6/build/dev-client.js create mode 100644 examples/es6/build/dev-server.js create mode 100644 examples/es6/build/utils.js create mode 100644 examples/es6/build/vue-loader.conf.js create mode 100644 examples/es6/build/webpack.base.conf.js create mode 100644 examples/es6/build/webpack.dev.conf.js create mode 100644 examples/es6/build/webpack.prod.conf.js create mode 100644 examples/es6/config/dev.env.js create mode 100644 examples/es6/config/index.js create mode 100644 examples/es6/config/prod.env.js create mode 100644 examples/es6/index.html create mode 100644 examples/es6/package.json create mode 100644 examples/es6/src/App.vue create mode 100644 examples/es6/src/components/InitializeIcheck.js create mode 100644 examples/es6/src/components/RegisterForm.vue create mode 100644 examples/es6/src/main.js create mode 100644 examples/es6/static/.gitkeep create mode 100644 examples/lib/acacha-forms.min.js create mode 100644 examples/node/index.js create mode 100644 examples/server/db.json create mode 100644 examples/server/package.json create mode 100644 examples/server/server.js create mode 100644 examples/server/validate.js create mode 100644 webpack.config.js diff --git a/.babelrc b/.babelrc new file mode 100644 index 0000000..7b1c321 --- /dev/null +++ b/.babelrc @@ -0,0 +1,4 @@ +{ + "presets": ["es2015"], + "plugins": ["babel-plugin-add-module-exports"] +} \ No newline at end of file diff --git a/.gitignore b/.gitignore index 141b3e5..ee07027 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,6 @@ node_modules/ .idea/ npm-debug.log dist/ +examples/browser/node_modules/ +examples/server/node_modules/ +examples/es6/node_modules/ \ No newline at end of file diff --git a/README.md b/README.md index 20e2ef0..60dcb2a 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,17 @@ Form objects pattern implementation for Javascript. npm install acacha-forms --save ``` +Or you can use [unpkg](https://unpkg.com) in your html files: + +```html + +``` + # Usage +See also examples folder with full code examples + +## ES6 imports After package installation you could user this package using ES6 import: ```javascript @@ -31,10 +40,83 @@ form.post('/register') }) .catch( error => { console.log('Register error!') + console.log(form.errors.all()) }) ``` -# Form objects pattern +## Node.js require + +After package installation you could user this package using ES6 import: + +```javascript +import Form from 'acacha-forms' +``` + +Then you can create any form object using constructor, for example a Register User form: + +```javascript +let form = new Form( { name: 'Sergi Tur', email: 'sergiturbadenas@gmail.com', password: '123456', password_confirmation: '123456', terms: 'true' } ) +``` +And the use form methods like post to submit form: + +```javascript +form.post('/register') + .then( response => { + console.log('Register done!') + //do what you need to do if register is ok + }) + .catch( error => { + console.log('Register error!') + console.log(form.errors.all()) + }) +``` + +## Browser + +# Examples + +See examples folder. Three examples are provided: + +- **browser**: Example of how to use use this library in a simple web page. +- **node**: Example of use use this library using node.js require. +- **es6**: Example of use use this library using import es6 sintax (using [vuejs framework](https://vuejs.org/)). + +All three examples requires to work a "server". You can execute the server provider al **server folder** which uses [json-server](https://github.com/typicode/json-server). + +## Server + +First remember to run the server example. Run the server typing: + +```bash +cd examples/server +npm install +node server.js +``` + +## Browser + +First remember to run the server example. Run the browser example typing: + +```bash +cd examples/browser +npm install +``` + +An open index.html file in your favourite browser. + +## es6 + +First remember to run the server example. Run the es6 (with vue.js) example typing: + +```bash +cd examples/es6 +npm install +npm run dev +``` + +And open URL http://localhost:8080 + +# About Form objects pattern More info about this pattern at: @@ -44,13 +126,13 @@ More info about this pattern at: - https://laracasts.com/series/learn-vue-2-step-by-step/episodes/21 -# Other similar packages or software +## Other similar packages or software - https://github.com/laracasts/Vue-Forms - https://github.com/edstevo/laravel-vue-form - [Laravel Spark](https://spark.laravel.com/) : see more info about forms at [docs](https://spark.laravel.com/docs/4.0/forms). -# Laracasts +## Laracasts This video series: @@ -61,7 +143,7 @@ This video series: Inspired the creation of this package. Also [Laravel Spark](https://spark.laravel.com/) . - # Resources +# Resources - [Form Objects at acacha.org wiki](http://acacha.org/mediawiki/Form_objects): in Catalan Language - https://laracasts.com/series/learn-vue-2-step-by-step/episodes/19 diff --git a/examples/browser/index.html b/examples/browser/index.html new file mode 100644 index 0000000..d8ed089 --- /dev/null +++ b/examples/browser/index.html @@ -0,0 +1,103 @@ + + + + + + AdminLTE 2 | Registration Page + + + + + + + + + + + + + + + + + + +
+ + +
+ + + + + + +
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+
+
+
+ +
+
+ +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + diff --git a/examples/browser/package.json b/examples/browser/package.json new file mode 100644 index 0000000..cee94dc --- /dev/null +++ b/examples/browser/package.json @@ -0,0 +1,19 @@ +{ + "name": "browser-example-for-acacha-forms", + "version": "1.0.0", + "description": "An example app to demonstrate acacha-forms library usage with browser", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "author": "Sergi Tur Badenas (http://acacha.org)", + "license": "ISC", + "dependencies": { + "admin-lte": "^2.3.11", + "bootstrap": "^3.3.7" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/acacha/forms.git" + } +} diff --git a/examples/browser/register.js b/examples/browser/register.js new file mode 100644 index 0000000..09cc4d8 --- /dev/null +++ b/examples/browser/register.js @@ -0,0 +1,48 @@ +/* globals AcachaForm FormData $ */ + +/** + * Submit register form. + * + * @param errors + */ +function register () { // eslint-disable-line no-unused-vars + clearErrors() + + const API_URL = 'http://localhost:3000/users' + + let form = new AcachaForm(new FormData(document.getElementById('registerForm'))) + + form.post(API_URL) + .then(response => { + console.log('Register done!') + $('#success').show() + }) + .catch(error => { + console.log('Register error! : ' + error) + console.log(form.errors) + showErrors(form.errors.all()) + }) +} + +/** + * Clear errors. + * + * @param errors + */ +function clearErrors (errors) { + $('#success').hide() + $('#errors').hide() + $('#errors ul').empty() +} + +/** + * Show errors. + * + * @param errors + */ +function showErrors (errors) { + $.each(errors, function (index, value) { + $('#errors ul').append('
  • ' + value + '
    • ') + }) + $('#errors').show() +} diff --git a/examples/es6/.babelrc b/examples/es6/.babelrc new file mode 100644 index 0000000..13f0e47 --- /dev/null +++ b/examples/es6/.babelrc @@ -0,0 +1,14 @@ +{ + "presets": [ + ["env", { "modules": false }], + "stage-2" + ], + "plugins": ["transform-runtime"], + "comments": false, + "env": { + "test": { + "presets": ["env", "stage-2"], + "plugins": [ "istanbul" ] + } + } +} diff --git a/examples/es6/.editorconfig b/examples/es6/.editorconfig new file mode 100644 index 0000000..9d08a1a --- /dev/null +++ b/examples/es6/.editorconfig @@ -0,0 +1,9 @@ +root = true + +[*] +charset = utf-8 +indent_style = space +indent_size = 2 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true diff --git a/examples/es6/.eslintignore b/examples/es6/.eslintignore new file mode 100644 index 0000000..34af377 --- /dev/null +++ b/examples/es6/.eslintignore @@ -0,0 +1,2 @@ +build/*.js +config/*.js diff --git a/examples/es6/.eslintrc.js b/examples/es6/.eslintrc.js new file mode 100644 index 0000000..4d9a3da --- /dev/null +++ b/examples/es6/.eslintrc.js @@ -0,0 +1,28 @@ +// http://eslint.org/docs/user-guide/configuring + +module.exports = { + root: true, + parser: 'babel-eslint', + parserOptions: { + sourceType: 'module' + }, + env: { + browser: true, + jquery: true + }, + // https://github.com/feross/standard/blob/master/RULES.md#javascript-standard-style + extends: 'standard', + // required to lint *.vue files + plugins: [ + 'html' + ], + // add your custom rules here + 'rules': { + // allow paren-less arrow functions + 'arrow-parens': 0, + // allow async-await + 'generator-star-spacing': 0, + // allow debugger during development + 'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0 + } +} diff --git a/examples/es6/.gitignore b/examples/es6/.gitignore new file mode 100644 index 0000000..09552ad --- /dev/null +++ b/examples/es6/.gitignore @@ -0,0 +1,6 @@ +.DS_Store +node_modules/ +dist/ +npm-debug.log* +yarn-debug.log* +yarn-error.log* diff --git a/examples/es6/.postcssrc.js b/examples/es6/.postcssrc.js new file mode 100644 index 0000000..ea9a5ab --- /dev/null +++ b/examples/es6/.postcssrc.js @@ -0,0 +1,8 @@ +// https://github.com/michael-ciniawsky/postcss-load-config + +module.exports = { + "plugins": { + // to edit target browsers: use "browserlist" field in package.json + "autoprefixer": {} + } +} diff --git a/examples/es6/README.md b/examples/es6/README.md new file mode 100644 index 0000000..cf2dd27 --- /dev/null +++ b/examples/es6/README.md @@ -0,0 +1,21 @@ +# es6-example-for-acacha-forms + +> An example app to demonstrate acacha-forms library usage with es6 and vue + +## Build Setup + +``` bash +# install dependencies +npm install + +# serve with hot reload at localhost:8080 +npm run dev + +# build for production with minification +npm run build + +# build for production and view the bundle analyzer report +npm run build --report +``` + +For detailed explanation on how things work, checkout the [guide](http://vuejs-templates.github.io/webpack/) and [docs for vue-loader](http://vuejs.github.io/vue-loader). diff --git a/examples/es6/build/build.js b/examples/es6/build/build.js new file mode 100644 index 0000000..6b8add1 --- /dev/null +++ b/examples/es6/build/build.js @@ -0,0 +1,35 @@ +require('./check-versions')() + +process.env.NODE_ENV = 'production' + +var ora = require('ora') +var rm = require('rimraf') +var path = require('path') +var chalk = require('chalk') +var webpack = require('webpack') +var config = require('../config') +var webpackConfig = require('./webpack.prod.conf') + +var spinner = ora('building for production...') +spinner.start() + +rm(path.join(config.build.assetsRoot, config.build.assetsSubDirectory), err => { + if (err) throw err + webpack(webpackConfig, function (err, stats) { + spinner.stop() + if (err) throw err + process.stdout.write(stats.toString({ + colors: true, + modules: false, + children: false, + chunks: false, + chunkModules: false + }) + '\n\n') + + console.log(chalk.cyan(' Build complete.\n')) + console.log(chalk.yellow( + ' Tip: built files are meant to be served over an HTTP server.\n' + + ' Opening index.html over file:// won\'t work.\n' + )) + }) +}) diff --git a/examples/es6/build/check-versions.js b/examples/es6/build/check-versions.js new file mode 100644 index 0000000..100f3a0 --- /dev/null +++ b/examples/es6/build/check-versions.js @@ -0,0 +1,48 @@ +var chalk = require('chalk') +var semver = require('semver') +var packageConfig = require('../package.json') +var shell = require('shelljs') +function exec (cmd) { + return require('child_process').execSync(cmd).toString().trim() +} + +var versionRequirements = [ + { + name: 'node', + currentVersion: semver.clean(process.version), + versionRequirement: packageConfig.engines.node + }, +] + +if (shell.which('npm')) { + versionRequirements.push({ + name: 'npm', + currentVersion: exec('npm --version'), + versionRequirement: packageConfig.engines.npm + }) +} + +module.exports = function () { + var warnings = [] + for (var i = 0; i < versionRequirements.length; i++) { + var mod = versionRequirements[i] + if (!semver.satisfies(mod.currentVersion, mod.versionRequirement)) { + warnings.push(mod.name + ': ' + + chalk.red(mod.currentVersion) + ' should be ' + + chalk.green(mod.versionRequirement) + ) + } + } + + if (warnings.length) { + console.log('') + console.log(chalk.yellow('To use this template, you must update following to modules:')) + console.log() + for (var i = 0; i < warnings.length; i++) { + var warning = warnings[i] + console.log(' ' + warning) + } + console.log() + process.exit(1) + } +} diff --git a/examples/es6/build/dev-client.js b/examples/es6/build/dev-client.js new file mode 100644 index 0000000..18aa1e2 --- /dev/null +++ b/examples/es6/build/dev-client.js @@ -0,0 +1,9 @@ +/* eslint-disable */ +require('eventsource-polyfill') +var hotClient = require('webpack-hot-middleware/client?noInfo=true&reload=true') + +hotClient.subscribe(function (event) { + if (event.action === 'reload') { + window.location.reload() + } +}) diff --git a/examples/es6/build/dev-server.js b/examples/es6/build/dev-server.js new file mode 100644 index 0000000..782dc6f --- /dev/null +++ b/examples/es6/build/dev-server.js @@ -0,0 +1,89 @@ +require('./check-versions')() + +var config = require('../config') +if (!process.env.NODE_ENV) { + process.env.NODE_ENV = JSON.parse(config.dev.env.NODE_ENV) +} + +var opn = require('opn') +var path = require('path') +var express = require('express') +var webpack = require('webpack') +var proxyMiddleware = require('http-proxy-middleware') +var webpackConfig = require('./webpack.dev.conf') + +// default port where dev server listens for incoming traffic +var port = process.env.PORT || config.dev.port +// automatically open browser, if not set will be false +var autoOpenBrowser = !!config.dev.autoOpenBrowser +// Define HTTP proxies to your custom API backend +// https://github.com/chimurai/http-proxy-middleware +var proxyTable = config.dev.proxyTable + +var app = express() +var compiler = webpack(webpackConfig) + +var devMiddleware = require('webpack-dev-middleware')(compiler, { + publicPath: webpackConfig.output.publicPath, + quiet: true +}) + +var hotMiddleware = require('webpack-hot-middleware')(compiler, { + log: () => {} +}) +// force page reload when html-webpack-plugin template changes +compiler.plugin('compilation', function (compilation) { + compilation.plugin('html-webpack-plugin-after-emit', function (data, cb) { + hotMiddleware.publish({ action: 'reload' }) + cb() + }) +}) + +// proxy api requests +Object.keys(proxyTable).forEach(function (context) { + var options = proxyTable[context] + if (typeof options === 'string') { + options = { target: options } + } + app.use(proxyMiddleware(options.filter || context, options)) +}) + +// handle fallback for HTML5 history API +app.use(require('connect-history-api-fallback')()) + +// serve webpack bundle output +app.use(devMiddleware) + +// enable hot-reload and state-preserving +// compilation error display +app.use(hotMiddleware) + +// serve pure static assets +var staticPath = path.posix.join(config.dev.assetsPublicPath, config.dev.assetsSubDirectory) +app.use(staticPath, express.static('./static')) + +var uri = 'http://localhost:' + port + +var _resolve +var readyPromise = new Promise(resolve => { + _resolve = resolve +}) + +console.log('> Starting dev server...') +devMiddleware.waitUntilValid(() => { + console.log('> Listening at ' + uri + '\n') + // when env is testing, don't need open it + if (autoOpenBrowser && process.env.NODE_ENV !== 'testing') { + opn(uri) + } + _resolve() +}) + +var server = app.listen(port) + +module.exports = { + ready: readyPromise, + close: () => { + server.close() + } +} diff --git a/examples/es6/build/utils.js b/examples/es6/build/utils.js new file mode 100644 index 0000000..b1d54b4 --- /dev/null +++ b/examples/es6/build/utils.js @@ -0,0 +1,71 @@ +var path = require('path') +var config = require('../config') +var ExtractTextPlugin = require('extract-text-webpack-plugin') + +exports.assetsPath = function (_path) { + var assetsSubDirectory = process.env.NODE_ENV === 'production' + ? config.build.assetsSubDirectory + : config.dev.assetsSubDirectory + return path.posix.join(assetsSubDirectory, _path) +} + +exports.cssLoaders = function (options) { + options = options || {} + + var cssLoader = { + loader: 'css-loader', + options: { + minimize: process.env.NODE_ENV === 'production', + sourceMap: options.sourceMap + } + } + + // generate loader string to be used with extract text plugin + function generateLoaders (loader, loaderOptions) { + var loaders = [cssLoader] + if (loader) { + loaders.push({ + loader: loader + '-loader', + options: Object.assign({}, loaderOptions, { + sourceMap: options.sourceMap + }) + }) + } + + // Extract CSS when that option is specified + // (which is the case during production build) + if (options.extract) { + return ExtractTextPlugin.extract({ + use: loaders, + fallback: 'vue-style-loader' + }) + } else { + return ['vue-style-loader'].concat(loaders) + } + } + + // https://vue-loader.vuejs.org/en/configurations/extract-css.html + return { + css: generateLoaders(), + postcss: generateLoaders(), + less: generateLoaders('less'), + sass: generateLoaders('sass', { indentedSyntax: true }), + scss: generateLoaders('sass'), + stylus: generateLoaders('stylus'), + styl: generateLoaders('stylus') + } +} + +// Generate loaders for standalone style files (outside of .vue) +exports.styleLoaders = function (options) { + var output = [] + var loaders = exports.cssLoaders(options) + for (var extension in loaders) { + var loader = loaders[extension] + output.push({ + test: new RegExp('\\.' + extension + '$'), + use: loader + }) + } + return output +} diff --git a/examples/es6/build/vue-loader.conf.js b/examples/es6/build/vue-loader.conf.js new file mode 100644 index 0000000..7aee79b --- /dev/null +++ b/examples/es6/build/vue-loader.conf.js @@ -0,0 +1,12 @@ +var utils = require('./utils') +var config = require('../config') +var isProduction = process.env.NODE_ENV === 'production' + +module.exports = { + loaders: utils.cssLoaders({ + sourceMap: isProduction + ? config.build.productionSourceMap + : config.dev.cssSourceMap, + extract: isProduction + }) +} diff --git a/examples/es6/build/webpack.base.conf.js b/examples/es6/build/webpack.base.conf.js new file mode 100644 index 0000000..f47b326 --- /dev/null +++ b/examples/es6/build/webpack.base.conf.js @@ -0,0 +1,67 @@ +var path = require('path') +var utils = require('./utils') +var config = require('../config') +var vueLoaderConfig = require('./vue-loader.conf') + +function resolve (dir) { + return path.join(__dirname, '..', dir) +} + +module.exports = { + entry: { + app: './src/main.js' + }, + output: { + path: config.build.assetsRoot, + filename: '[name].js', + publicPath: process.env.NODE_ENV === 'production' + ? config.build.assetsPublicPath + : config.dev.assetsPublicPath + }, + resolve: { + extensions: ['.js', '.vue', '.json'], + alias: { + 'vue$': 'vue/dist/vue.esm.js', + '@': resolve('src') + } + }, + module: { + rules: [ + { + test: /\.(js|vue)$/, + loader: 'eslint-loader', + enforce: 'pre', + include: [resolve('src'), resolve('test')], + options: { + formatter: require('eslint-friendly-formatter') + } + }, + { + test: /\.vue$/, + loader: 'vue-loader', + options: vueLoaderConfig + }, + { + test: /\.js$/, + loader: 'babel-loader', + include: [resolve('src'), resolve('test')] + }, + { + test: /\.(png|jpe?g|gif|svg)(\?.*)?$/, + loader: 'url-loader', + options: { + limit: 10000, + name: utils.assetsPath('img/[name].[hash:7].[ext]') + } + }, + { + test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/, + loader: 'url-loader', + options: { + limit: 10000, + name: utils.assetsPath('fonts/[name].[hash:7].[ext]') + } + } + ] + } +} diff --git a/examples/es6/build/webpack.dev.conf.js b/examples/es6/build/webpack.dev.conf.js new file mode 100644 index 0000000..5470402 --- /dev/null +++ b/examples/es6/build/webpack.dev.conf.js @@ -0,0 +1,35 @@ +var utils = require('./utils') +var webpack = require('webpack') +var config = require('../config') +var merge = require('webpack-merge') +var baseWebpackConfig = require('./webpack.base.conf') +var HtmlWebpackPlugin = require('html-webpack-plugin') +var FriendlyErrorsPlugin = require('friendly-errors-webpack-plugin') + +// add hot-reload related code to entry chunks +Object.keys(baseWebpackConfig.entry).forEach(function (name) { + baseWebpackConfig.entry[name] = ['./build/dev-client'].concat(baseWebpackConfig.entry[name]) +}) + +module.exports = merge(baseWebpackConfig, { + module: { + rules: utils.styleLoaders({ sourceMap: config.dev.cssSourceMap }) + }, + // cheap-module-eval-source-map is faster for development + devtool: '#cheap-module-eval-source-map', + plugins: [ + new webpack.DefinePlugin({ + 'process.env': config.dev.env + }), + // https://github.com/glenjamin/webpack-hot-middleware#installation--usage + new webpack.HotModuleReplacementPlugin(), + new webpack.NoEmitOnErrorsPlugin(), + // https://github.com/ampedandwired/html-webpack-plugin + new HtmlWebpackPlugin({ + filename: 'index.html', + template: 'index.html', + inject: true + }), + new FriendlyErrorsPlugin() + ] +}) diff --git a/examples/es6/build/webpack.prod.conf.js b/examples/es6/build/webpack.prod.conf.js new file mode 100644 index 0000000..da44b65 --- /dev/null +++ b/examples/es6/build/webpack.prod.conf.js @@ -0,0 +1,120 @@ +var path = require('path') +var utils = require('./utils') +var webpack = require('webpack') +var config = require('../config') +var merge = require('webpack-merge') +var baseWebpackConfig = require('./webpack.base.conf') +var CopyWebpackPlugin = require('copy-webpack-plugin') +var HtmlWebpackPlugin = require('html-webpack-plugin') +var ExtractTextPlugin = require('extract-text-webpack-plugin') +var OptimizeCSSPlugin = require('optimize-css-assets-webpack-plugin') + +var env = config.build.env + +var webpackConfig = merge(baseWebpackConfig, { + module: { + rules: utils.styleLoaders({ + sourceMap: config.build.productionSourceMap, + extract: true + }) + }, + devtool: config.build.productionSourceMap ? '#source-map' : false, + output: { + path: config.build.assetsRoot, + filename: utils.assetsPath('js/[name].[chunkhash].js'), + chunkFilename: utils.assetsPath('js/[id].[chunkhash].js') + }, + plugins: [ + // http://vuejs.github.io/vue-loader/en/workflow/production.html + new webpack.DefinePlugin({ + 'process.env': env + }), + new webpack.optimize.UglifyJsPlugin({ + compress: { + warnings: false + }, + sourceMap: true + }), + // extract css into its own file + new ExtractTextPlugin({ + filename: utils.assetsPath('css/[name].[contenthash].css') + }), + // Compress extracted CSS. We are using this plugin so that possible + // duplicated CSS from different components can be deduped. + new OptimizeCSSPlugin({ + cssProcessorOptions: { + safe: true + } + }), + // generate dist index.html with correct asset hash for caching. + // you can customize output by editing /index.html + // see https://github.com/ampedandwired/html-webpack-plugin + new HtmlWebpackPlugin({ + filename: config.build.index, + template: 'index.html', + inject: true, + minify: { + removeComments: true, + collapseWhitespace: true, + removeAttributeQuotes: true + // more options: + // https://github.com/kangax/html-minifier#options-quick-reference + }, + // necessary to consistently work with multiple chunks via CommonsChunkPlugin + chunksSortMode: 'dependency' + }), + // split vendor js into its own file + new webpack.optimize.CommonsChunkPlugin({ + name: 'vendor', + minChunks: function (module, count) { + // any required modules inside node_modules are extracted to vendor + return ( + module.resource && + /\.js$/.test(module.resource) && + module.resource.indexOf( + path.join(__dirname, '../node_modules') + ) === 0 + ) + } + }), + // extract webpack runtime and module manifest to its own file in order to + // prevent vendor hash from being updated whenever app bundle is updated + new webpack.optimize.CommonsChunkPlugin({ + name: 'manifest', + chunks: ['vendor'] + }), + // copy custom static assets + new CopyWebpackPlugin([ + { + from: path.resolve(__dirname, '../static'), + to: config.build.assetsSubDirectory, + ignore: ['.*'] + } + ]) + ] +}) + +if (config.build.productionGzip) { + var CompressionWebpackPlugin = require('compression-webpack-plugin') + + webpackConfig.plugins.push( + new CompressionWebpackPlugin({ + asset: '[path].gz[query]', + algorithm: 'gzip', + test: new RegExp( + '\\.(' + + config.build.productionGzipExtensions.join('|') + + ')$' + ), + threshold: 10240, + minRatio: 0.8 + }) + ) +} + +if (config.build.bundleAnalyzerReport) { + var BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPlugin + webpackConfig.plugins.push(new BundleAnalyzerPlugin()) +} + +module.exports = webpackConfig diff --git a/examples/es6/config/dev.env.js b/examples/es6/config/dev.env.js new file mode 100644 index 0000000..efead7c --- /dev/null +++ b/examples/es6/config/dev.env.js @@ -0,0 +1,6 @@ +var merge = require('webpack-merge') +var prodEnv = require('./prod.env') + +module.exports = merge(prodEnv, { + NODE_ENV: '"development"' +}) diff --git a/examples/es6/config/index.js b/examples/es6/config/index.js new file mode 100644 index 0000000..196da1f --- /dev/null +++ b/examples/es6/config/index.js @@ -0,0 +1,38 @@ +// see http://vuejs-templates.github.io/webpack for documentation. +var path = require('path') + +module.exports = { + build: { + env: require('./prod.env'), + index: path.resolve(__dirname, '../dist/index.html'), + assetsRoot: path.resolve(__dirname, '../dist'), + assetsSubDirectory: 'static', + assetsPublicPath: '/', + productionSourceMap: true, + // Gzip off by default as many popular static hosts such as + // Surge or Netlify already gzip all static assets for you. + // Before setting to `true`, make sure to: + // npm install --save-dev compression-webpack-plugin + productionGzip: false, + productionGzipExtensions: ['js', 'css'], + // Run the build command with an extra argument to + // View the bundle analyzer report after build finishes: + // `npm run build --report` + // Set to `true` or `false` to always turn it on or off + bundleAnalyzerReport: process.env.npm_config_report + }, + dev: { + env: require('./dev.env'), + port: 8080, + autoOpenBrowser: true, + assetsSubDirectory: 'static', + assetsPublicPath: '/', + proxyTable: {}, + // CSS Sourcemaps off by default because relative paths are "buggy" + // with this option, according to the CSS-Loader README + // (https://github.com/webpack/css-loader#sourcemaps) + // In our experience, they generally work as expected, + // just be aware of this issue when enabling this option. + cssSourceMap: false + } +} diff --git a/examples/es6/config/prod.env.js b/examples/es6/config/prod.env.js new file mode 100644 index 0000000..773d263 --- /dev/null +++ b/examples/es6/config/prod.env.js @@ -0,0 +1,3 @@ +module.exports = { + NODE_ENV: '"production"' +} diff --git a/examples/es6/index.html b/examples/es6/index.html new file mode 100644 index 0000000..58720de --- /dev/null +++ b/examples/es6/index.html @@ -0,0 +1,27 @@ + + + + + + AdminLTE 2 | Registration Page + + + + + + + + + + + + + +
    + + + + diff --git a/examples/es6/package.json b/examples/es6/package.json new file mode 100644 index 0000000..21a3ef9 --- /dev/null +++ b/examples/es6/package.json @@ -0,0 +1,73 @@ +{ + "name": "es6-example-for-acacha-forms", + "version": "1.0.0", + "description": "An example app to demonstrate acacha-forms library usage with es6 and vue", + "author": "Sergi Tur Badenas ", + "private": true, + "scripts": { + "dev": "node build/dev-server.js", + "start": "node build/dev-server.js", + "build": "node build/build.js", + "lint": "eslint --ext .js,.vue src" + }, + "dependencies": { + "admin-lte": "^2.3.11", + "axios": "^0.16.1", + "bootstrap": "^3.3.7", + "icheck": "^1.0.2", + "jquery": "^3.1.1", + "vue": "^2.2.2" + }, + "devDependencies": { + "autoprefixer": "^6.7.2", + "babel-core": "^6.22.1", + "babel-eslint": "^7.1.1", + "babel-loader": "^6.2.10", + "babel-plugin-transform-runtime": "^6.22.0", + "babel-preset-env": "^1.2.1", + "babel-preset-stage-2": "^6.22.0", + "babel-register": "^6.22.0", + "chalk": "^1.1.3", + "connect-history-api-fallback": "^1.3.0", + "copy-webpack-plugin": "^4.0.1", + "css-loader": "^0.26.1", + "eslint": "^3.14.1", + "eslint-friendly-formatter": "^2.0.7", + "eslint-loader": "^1.6.1", + "eslint-plugin-html": "^2.0.0", + "eslint-config-standard": "^6.2.1", + "eslint-plugin-promise": "^3.4.0", + "eslint-plugin-standard": "^2.0.1", + "eventsource-polyfill": "^0.9.6", + "express": "^4.14.1", + "extract-text-webpack-plugin": "^2.0.0", + "file-loader": "^0.10.0", + "friendly-errors-webpack-plugin": "^1.1.3", + "html-webpack-plugin": "^2.28.0", + "http-proxy-middleware": "^0.17.3", + "webpack-bundle-analyzer": "^2.2.1", + "semver": "^5.3.0", + "shelljs": "^0.7.6", + "opn": "^4.0.2", + "optimize-css-assets-webpack-plugin": "^1.3.0", + "ora": "^1.1.0", + "rimraf": "^2.6.0", + "url-loader": "^0.5.8", + "vue-loader": "^11.1.4", + "vue-style-loader": "^2.0.0", + "vue-template-compiler": "^2.2.4", + "webpack": "^2.2.1", + "webpack-dev-middleware": "^1.10.0", + "webpack-hot-middleware": "^2.16.1", + "webpack-merge": "^2.6.1" + }, + "engines": { + "node": ">= 4.0.0", + "npm": ">= 3.0.0" + }, + "browserslist": [ + "> 1%", + "last 2 versions", + "not ie <= 8" + ] +} diff --git a/examples/es6/src/App.vue b/examples/es6/src/App.vue new file mode 100644 index 0000000..3d3936e --- /dev/null +++ b/examples/es6/src/App.vue @@ -0,0 +1,17 @@ + + + + diff --git a/examples/es6/src/components/InitializeIcheck.js b/examples/es6/src/components/InitializeIcheck.js new file mode 100644 index 0000000..c93ecbb --- /dev/null +++ b/examples/es6/src/components/InitializeIcheck.js @@ -0,0 +1,20 @@ +export default { + mounted () { + this.initialitzeICheck() + }, + methods: { + initialitzeICheck () { + var component = this + $('input').iCheck({ + checkboxClass: 'icheckbox_square-blue', + radioClass: 'iradio_square-blue', + increaseArea: '20%' + }).on('ifChecked', function (event) { + component.form.set('terms', true) + component.form.errors.clear('terms') + }).on('ifUnchecked', function (event) { + component.form.set('terms', '') + }) + } + } +} diff --git a/examples/es6/src/components/RegisterForm.vue b/examples/es6/src/components/RegisterForm.vue new file mode 100644 index 0000000..3be90dd --- /dev/null +++ b/examples/es6/src/components/RegisterForm.vue @@ -0,0 +1,122 @@ + + + + + diff --git a/examples/es6/src/main.js b/examples/es6/src/main.js new file mode 100644 index 0000000..d521d28 --- /dev/null +++ b/examples/es6/src/main.js @@ -0,0 +1,24 @@ +// The Vue build version to load with the `import` command +// (runtime-only or standalone) has been set in webpack.base.conf with an alias. +import Vue from 'vue' +import App from './App' + +import 'bootstrap/dist/css/bootstrap.css' +import 'admin-lte/dist/css/AdminLTE.css' +import 'admin-lte/plugins/iCheck/square/blue.css' + +window.$ = window.jQuery = require('jquery') +require('bootstrap') +require('admin-lte') +require('icheck') + +window.axios = require('axios') + +Vue.config.productionTip = false + +/* eslint-disable no-new */ +new Vue({ + el: '#app', + template: '', + components: { App } +}) diff --git a/examples/es6/static/.gitkeep b/examples/es6/static/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/examples/lib/acacha-forms.min.js b/examples/lib/acacha-forms.min.js new file mode 100644 index 0000000..4a0d1c2 --- /dev/null +++ b/examples/lib/acacha-forms.min.js @@ -0,0 +1 @@ +!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t(require("axios")):"function"==typeof define&&define.amd?define("AcachaForm",["axios"],t):"object"==typeof exports?exports.AcachaForm=t(require("axios")):e.AcachaForm=t(e.axios)}(this,function(e){return function(e){function t(n){if(r[n])return r[n].exports;var i=r[n]={i:n,l:!1,exports:{}};return e[n].call(i.exports,i,i.exports,t),i.l=!0,i.exports}var r={};return t.m=e,t.c=r,t.i=function(e){return e},t.d=function(e,r,n){t.o(e,r)||Object.defineProperty(e,r,{configurable:!1,enumerable:!0,get:n})},t.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return t.d(r,"a",r),r},t.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},t.p="",t(t.s=2)}([function(e,t,r){"use strict";function n(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")}Object.defineProperty(t,"__esModule",{value:!0});var i=function(){function e(e,t){for(var r=0;r0}},{key:"hasErrors",value:function(){return this.any()}},{key:"all",value:function(){return this.errors}},{key:"has",value:function(e){return this.errors.hasOwnProperty(e)}},{key:"get",value:function(e){if(this.has(e))return"string"==typeof this.errors[e]?this.errors[e]:this.errors[e][0]}},{key:"record",value:function(e){this.set(e)}},{key:"set",value:function(e){this.errors=e}},{key:"clear",value:function(e){if(e)return void delete this.errors[e];this.errors={}}},{key:"forget",value:function(e){this.clear(e)}}]),e}();t.default=s,e.exports=t.default},function(t,r){t.exports=e},function(e,t,r){"use strict";function n(e){return e&&e.__esModule?e:{default:e}}function i(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")}Object.defineProperty(t,"__esModule",{value:!0});var s=function(){function e(e,t){for(var r=0;r { + console.log('Register done!') + }) + .catch(error => { + console.log('Register error! : ' + error) + console.log(form.errors.all()) + }) diff --git a/examples/server/db.json b/examples/server/db.json new file mode 100644 index 0000000..782e49d --- /dev/null +++ b/examples/server/db.json @@ -0,0 +1,206 @@ +{ + "users": [ + { + "id": 1, + "name": "Pepe Pardo Jeans", + "email": "pepepardo@jeans.com", + "password": "supersecrethere" + }, + { + "id": 2, + "name": "Pepa Parda Jeans", + "email": "pepaparda@jeans.com", + "password": "supersecret2here" + }, + { + "name": "Sergi Tur", + "email": "sergiturbadenas@gmail.com", + "password": "123456", + "password_confirmation": "123456", + "terms": "true", + "id": 3 + }, + { + "name": "Sergi Tur", + "email": "sergiturbadenas@gmail.com", + "password": "123456", + "password_confirmation": "123456", + "terms": "true", + "id": 4 + }, + { + "name": "Sergi Tur", + "email": "sergiturbadenas@gmail.com", + "password": "123456", + "password_confirmation": "123456", + "terms": "true", + "id": 5 + }, + { + "name": "Sergi Tur", + "email": "sergiturbadenas@gmail.com", + "password": "123456", + "password_confirmation": "123456", + "terms": "true", + "id": 6 + }, + { + "name": "PEPE KJORASD ASD", + "email": "dsa@gmailasdads.com", + "password": "123456", + "password_confirmation": "123456", + "terms": "true", + "id": 7 + }, + { + "name": "", + "email": "", + "password": "", + "confirmation_password": "", + "id": 8 + }, + { + "name": "PROVA", + "email": "", + "password": "", + "confirmation_password": "", + "id": 9 + }, + { + "name": "Berla", + "email": "asd@sdasad.es", + "password": "123456", + "confirmation_password": "13saddas", + "terms": "on", + "id": 10 + }, + { + "name": "sdasadsdasda", + "email": "", + "password": "", + "confirmation_password": "", + "id": 11 + }, + { + "name": "sdasadsdasda", + "email": "asdsadsda@dasas.es", + "password": "", + "confirmation_password": "", + "id": 12 + }, + { + "name": "sdasadsdasda", + "email": "asd@sdasad.es", + "password": "", + "confirmation_password": "", + "id": 13 + }, + { + "name": "sadsdasda", + "email": "asd@sdasad.es", + "password": "", + "confirmation_password": "", + "id": 14 + }, + { + "name": "asd", + "email": "asd@sdasad.es", + "password": "", + "confirmation_password": "", + "id": 15 + }, + { + "name": "Sergi Tur Badenas", + "email": "sergiturbadenas@gmail.com", + "password": "prova", + "confirmation_password": "prova", + "terms": "on", + "id": 16 + }, + { + "name": "Sergi Tur Badenas", + "email": "sad@das.es", + "password": "", + "confirmation_password": "", + "id": 17 + }, + { + "name": "Sergi Tur Badenas", + "email": "sergiturbadenas@gmail.com", + "password": "", + "confirmation_password": "", + "id": 18 + }, + { + "name": "sad", + "email": "asd@sdasad.es", + "password": "", + "confirmation_password": "", + "id": 19 + }, + { + "name": "dasdsa", + "email": "sa@das.es", + "password": "", + "password_confirmation": "", + "terms": "", + "id": 20 + }, + { + "name": "PROVA", + "email": "sdasdadsasdasdasda@dsa.es", + "password": "", + "password_confirmation": "", + "terms": true, + "id": 21 + }, + { + "name": "asd", + "email": "acacha@gmail.com", + "password": "", + "password_confirmation": "", + "terms": "", + "id": 22 + }, + { + "name": "Sergi Tur Badenas", + "email": "sergiturbadenas@gmail.com", + "password": "", + "password_confirmation": "", + "terms": "", + "id": 23 + }, + { + "name": "Sergi Tur Badenas", + "email": "sergiturbadenas@gmail.com", + "password": "", + "password_confirmation": "", + "terms": "", + "id": 24 + }, + { + "name": "Sergi Tur Badenas", + "email": "sergiturbadenas@gmail.com", + "password": "", + "password_confirmation": "", + "terms": "", + "id": 25 + }, + { + "name": "Sergi Tur Badenas", + "email": "sergiturbadenas@gmail.com", + "password": "", + "password_confirmation": "", + "terms": "", + "id": 26 + }, + { + "name": "asd", + "email": "asd@das.esa", + "password": "", + "password_confirmation": "", + "terms": "", + "id": 27 + } + ] +} \ No newline at end of file diff --git a/examples/server/package.json b/examples/server/package.json new file mode 100644 index 0000000..ac1f51b --- /dev/null +++ b/examples/server/package.json @@ -0,0 +1,19 @@ +{ + "name": "server-example-for-acacha-forms", + "version": "1.0.0", + "description": "", + "main": "server.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1", + "start": "node server.js" + }, + "author": "Sergi Tur Badenas (http://acacha.org)", + "license": "ISC", + "dependencies": { + "json-server": "^0.9.6" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/acacha/forms.git" + } +} diff --git a/examples/server/server.js b/examples/server/server.js new file mode 100644 index 0000000..e7647b7 --- /dev/null +++ b/examples/server/server.js @@ -0,0 +1,14 @@ +const jsonServer = require('json-server') +const validate = require('./validate') +const server = jsonServer.create() +const router = jsonServer.router('db.json') +const middlewares = jsonServer.defaults() + +server.use(middlewares) +server.use(jsonServer.bodyParser) +server.use(validate) +server.use(router) + +server.listen(3000, () => { + console.log('JSON Server is running') +}) diff --git a/examples/server/validate.js b/examples/server/validate.js new file mode 100644 index 0000000..3d01e18 --- /dev/null +++ b/examples/server/validate.js @@ -0,0 +1,17 @@ +module.exports = (req, res, next) => { + var response = {} + var errors = false + if (req.body.name === '') { + errors = true + response.name = ['The name field is required'] + } + if (req.body.email === '') { + errors = true + response.email = ['The email field is required'] + } + if (errors) { + res.status(422).send(JSON.stringify(response)) + } else { + next() + } +} diff --git a/package.json b/package.json index 49192e1..489752f 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,9 @@ "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "lint": "eslint --ext .js src/", - "build": "babel src --presets babel-preset-es2015 --out-dir dist", + "lint-examples": "eslint --ext .js examples/node/index.js examples/server/*.js examples/browser/*.js", + "build": "cross-env NODE_ENV=production webpack -p --progress --colors; cp dist/acacha-forms.min.js examples/lib", + "dev": "cross-env NODE_ENV=development webpack --progress --colors --watch", "prepublish": "npm run build" }, "repository": { @@ -25,12 +27,18 @@ "homepage": "https://github.com/acacha/forms#readme", "devDependencies": { "babel-cli": "^6.23.0", + "babel-loader": "^6.4.1", + "babel-plugin-add-module-exports": "^0.2.1", "babel-preset-es2015": "^6.22.0", + "cross-env": "^4.0.0", "eslint": "^3.17.1", "eslint-config-standard": "^7.0.1", + "eslint-friendly-formatter": "^2.0.7", + "eslint-loader": "^1.7.1", "eslint-plugin-promise": "^3.5.0", "eslint-plugin-standard": "^2.1.1", - "eslint-plugin-you-dont-need-lodash-underscore": "^5.0.4" + "eslint-plugin-you-dont-need-lodash-underscore": "^5.0.4", + "webpack": "^2.3.3" }, "dependencies": { "axios": "^0.15.3" diff --git a/src/Form.js b/src/Form.js index 1458b11..e3e66ea 100644 --- a/src/Form.js +++ b/src/Form.js @@ -1,3 +1,5 @@ +/* global FormData */ + import Errors from './Errors' import axios from 'axios' @@ -9,6 +11,8 @@ export default class Form { * @param fields */ constructor (fields) { + fields = this.convertFromFormData(fields) + this.clearOnSubmit = false this.originalFields = fields @@ -22,6 +26,23 @@ export default class Form { } } + /** + * Convert from FormData. + * + * @param fields + * @returns {*} + */ + convertFromFormData (fields) { + if (fields instanceof FormData) { + var rv = {} + for (var pair of fields.entries()) { + if (pair[1] !== undefined) rv[pair[0]] = pair[1] + } + return rv + } + return fields + } + /** * Retrieve the field form. * diff --git a/webpack.config.js b/webpack.config.js new file mode 100644 index 0000000..51e97fd --- /dev/null +++ b/webpack.config.js @@ -0,0 +1,42 @@ +const path = require('path') + +var isProd = (process.env.NODE_ENV === 'production') + +var outputFile = 'acacha-forms.js' + +if (isProd) { + outputFile = 'acacha-forms.min.js' +} + +module.exports = { + entry: './src/Form.js', + output: { + path: path.resolve(__dirname, './dist'), + filename: outputFile, + libraryTarget: 'umd', + library: 'AcachaForm', + umdNamedDefine: true + }, + externals: { + 'axios': { + commonjs: 'axios', + commonjs2: 'axios', + amd: 'axios', + root: 'axios' + } + }, + module: { + rules: [{ + enforce: 'pre', + test: /\.js$/, + exclude: /node_modules/, + loader: 'eslint-loader' + }, + { + test: /\.js$/, + exclude: /node_modules/, + loader: 'babel-loader' + } + ] + } +}