Skip to content
This repository has been archived by the owner on Apr 5, 2023. It is now read-only.

Commit

Permalink
Lots of improvements from the dev branch.
Browse files Browse the repository at this point in the history
* Text editor
* Color picker
* Bower
* Tests using Karma
* Dist files
* README.md changes, new CONTRIBUTING.md
* Lots of bugfixes and performance improvements
  • Loading branch information
Alex Zirbel committed Jul 1, 2014
1 parent 55bef09 commit c265d6c
Show file tree
Hide file tree
Showing 178 changed files with 5,008 additions and 38,616 deletions.
19 changes: 18 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,26 @@
node_modules/
gh_pages/
build/
dist/
dependencies/compiled/*.*
test/runner.html
.DS_Store
*.swo
*.swp

# Bower dependencies
vendor/bootstrap
vendor/ember
vendor/font-awesome
vendor/handlebars
vendor/holder
vendor/jquery
vendor/jquery-browser
vendor/lodash
vendor/qunit
vendor/rangy
vendor/sinonjs
vendor/sinon-qunit

tests/**/*.js

npm-debug.log
147 changes: 147 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
# Contributing to Ember Widgets

Looking to contribute something to Ember Widgets? Here's how you can help.

Please take a moment to review this document in order to make the contribution
process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of
the developers managing and developing this open source project. In return,
they should reciprocate that respect in addressing your issue or assessing
patches and features.


## Using the issue tracker

The [issue tracker](https://github.com/Addepar/ember-widgets/issues) is
the preferred channel for [bug reports](#bug-reports),
[feature requests](#feature-requests) and
[submitting pull requests](#pull-requests), but please respect the following
restrictions:

* Please **do not** use the issue tracker for personal support requests. Stack
Overflow
([`ember-widgets`](http://stackoverflow.com/questions/tagged/ember-widgets) tag)
is a better place to get help.

* Please **do not** derail or troll issues. Keep the discussion on topic and
respect the opinions of others.


## Bug reports

A bug is a _demonstrable problem_ that is caused by the code in the repository.
Good bug reports are extremely helpful, so thanks!

Guidelines for bug reports:

1. **Use the GitHub issue search** — check if the issue has already been
reported.

2. **Check if the issue has been fixed** — try to reproduce it using the
latest `master` or development branch in the repository.

3. **Isolate the problem** — ideally create a reduced test
case and a live example. The starter kit JS Bin on the README page is a
helpful template.


## Feature requests

Feature requests are welcome. But take a moment to find out whether your idea
fits with the scope and aims of the project. It's up to *you* to make a strong
case to convince the project's developers of the merits of this feature. Please
provide as much detail and context as possible.


## Pull requests

Good pull requests—patches, improvements, new features—are a fantastic
help. They should remain focused in scope and avoid containing unrelated
commits.

**Please ask first** before embarking on any significant pull request (e.g.
implementing features, refactoring code, porting to a different language),
otherwise you risk spending a lot of time working on something that the
project's developers might not want to merge into the project.

For now, pull requests aren't required to have tests. Once we've established
a testing infrastructure, pull requests that introduce new functionality should
come with tests for that functionality.

Adhering to the following process is the best way to get your work
included in the project:

1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
and configure the remotes:

```bash
# Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/ember-widgets.git
# Navigate to the newly cloned directory
cd ember-widgets
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/Addepar/ember-widgets.git
```

2. If you cloned a while ago, get the latest changes from upstream:

```bash
git checkout master
git pull upstream master
```

3. Create a new topic branch (off the main project development branch) to
contain your feature, change, or fix:

```bash
git checkout -b <topic-branch-name>
```

4. Commit your changes in logical chunks. Please adhere to these [git commit
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
or your code is unlikely be merged into the main project. Use Git's
[interactive rebase](https://help.github.com/articles/interactive-rebase)
feature to tidy up your commits before making them public.

5. Locally merge (or rebase) the upstream development branch into your topic branch:

```bash
git pull [--rebase] upstream master
```

6. Push your topic branch up to your fork:

```bash
git push origin <topic-branch-name>
```

7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
with a clear title and description against the `master` branch.

**IMPORTANT**: By submitting a patch, you agree to allow the project owners to
license your work under the terms of the [BSD License](LICENSE).


## Running tests

```bash
grunt karma:default
```


## Syntax:

* Two spaces, no tabs.
* No trailing whitespace. Blank lines should not have any space.
* a = b and not a=b.
* Follow the conventions you see used in the source already.


## License

By contributing your code, you agree to license your contribution under the
[BSD license](LICENSE).


#### NOTE: Largely copied from https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md
99 changes: 78 additions & 21 deletions Gruntfile.coffee
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,40 @@ module.exports = (grunt) ->
clean:
target: ['build', 'dist' , 'gh_pages']

karma:
continuous: # continuous integration mode
configFile: 'karma.conf.js'
singleRun: true
unit:
configFile: 'karma.conf.js'
singleRun: true
exclude: ['build/src/ember_widgets.js', 'tests/functional/*.js', 'tests/integration/*.js'],
functional:
configFile: 'karma.conf.js'
singleRun: true
exclude: ['build/src/ember_widgets.js', 'tests/unit/*.js', 'tests/integration/*.js'],
integration:
configFile: 'karma.conf.js'
singleRun: true
exclude: ['build/src/ember_widgets.js', 'tests/unit/*.js', 'tests/functional/*.js'],
default:
configFile: 'karma.conf.js'
singleRun: false

uglify:
"dist/ember-widgets.min.js": "dist/ember-widgets.js"
"dist/js/ember-widgets.min.js": "dist/js/ember-widgets.js"

# https://github.com/yatskevich/grunt-bower-task
bower:
install:
options:
targetDir: 'vendor'
layout: 'byComponent'
install: true
verbose: true
cleanTargetDir: false
cleanBowerDir: true
bowerOptions: {}

coffee:
srcs:
Expand All @@ -29,6 +61,15 @@ module.exports = (grunt) ->
src: [ "**/*.coffee" ]
dest: "build/app/"
ext: ".js"
tests:
options:
bare: true
sourceMap: false
expand: true
cwd: "tests/"
src: ["**/*.coffee" ]
dest: "tests/"
ext: ".js"

emberTemplates:
options:
Expand All @@ -40,35 +81,37 @@ module.exports = (grunt) ->

neuter:
options:
includeSourceURL: no
"dist/ember-widgets.js": "build/src/ember_widgets.js"
includeSourceURL: env is "dev"
"dist/js/ember-widgets.js": "build/src/ember_widgets.js"
"gh_pages/app.js": "build/app/app.js"

less:
development:
options:
yuicompress: env isnt "dev"
files:
"dist/ember-widgets.css": "src/css/ember-widgets.less"
"dist/css/ember-widgets.css": "src/css/ember-widgets.less"
app:
options:
yuicompress: env isnt "dev"
files:
"gh_pages/css/app.css": "app/assets/css/app.less"

###
Copy build/app/assets/css into gh_pages/asset and other assets from app
###
# Copy build/app/assets/css into gh_pages/asset and other assets from app
copy:
gh_pages:
files: [
{src: ['dist/ember-widgets.css'], dest: 'gh_pages/css/ember-widgets.css'},
{src: ['dist/css/ember-widgets.css'], dest: 'gh_pages/css/ember-widgets.css'},
{src: ['app/index.html'], dest: 'gh_pages/index.html'},
{expand: true, flatten: true, cwd: 'dependencies/', src: ['**/*.js'], dest: 'gh_pages/lib'},
{expand: true, flatten: true, cwd: 'dependencies/', src: ['**/*.css'], dest: 'gh_pages/css'},
{expand: true, cwd: 'dependencies/font-awesome/fonts/', src: ['**'], dest: 'gh_pages/font'},
{expand: true, cwd: 'app/assets/font/', src: ['**'], dest: 'gh_pages/font'},
{expand: true, cwd: 'app/assets/img/', src: ['**'], dest: 'gh_pages/img'}
{expand: true, flatten: true, cwd: 'vendor/', src: ['**/*.js'], dest: 'gh_pages/lib'},
{expand: true, flatten: true, cwd: 'vendor/', src: ['**/*.css'], dest: 'gh_pages/css'},
{expand: true, cwd: 'vendor/font-awesome/fonts/', src: ['**'], dest: 'gh_pages/fonts'},
{expand: true, cwd: 'app/assets/font/', src: ['**'], dest: 'gh_pages/fonts'},
{expand: true, cwd: 'app/assets/img/', src: ['**'], dest: 'gh_pages/img'},
{expand: true, cwd: 'src/img/', src: ['**'], dest: 'gh_pages/img'}
{expand: true, cwd: 'src/img/', src: ['**'], dest: 'dist/img'}
]

###
Expand All @@ -88,38 +131,48 @@ module.exports = (grunt) ->
src:
files: [ "src/**/*.coffee"]
tasks: [ "coffee:srcs", "neuter" ]
test:
files: [ "tests/**/*.coffee"]
tasks: [ "coffee:tests", "neuter" ]
src_handlebars:
files: [ "src/**/*.hbs" ]
tasks: [ "emberTemplates", "neuter" ]
app:
files: [ "app/**/*.coffee", "dependencies/**/*.js" ]
files: [ "app/**/*.coffee", "dependencies/**/*.js", "vendor/**/*.js" ]
tasks: [ "coffee:app", "neuter" ]
app_handlebars:
files: [ "app/**/*.hbs"]
tasks: [ "emberTemplates", "neuter" ]
less:
files: [ "src/**/*.less", "src/**/*.css",
"dependencies/**/*.less", "dependencies/**/*.css",
"vendor/**/*.less", "vendor/**/*.css",
"app/assets/**/*.less", "app/assets/**/*.css" ]
tasks: ["less", "copy"]
copy:
files: [ "app/index.html" ]
tasks: [ "copy" ]
bower:
files: [ 'bower.json']
tasks: [ 'bower']
uglify:
files: [ 'dist/js/ember-widgets.js' ]
tasks: [ 'uglify' ]

###
Runs all .html files found in the test/ directory through PhantomJS.
Prints the report in your terminal.
###
qunit:
all: [ "test/**/*.html" ]
all: [ "tests/**/*.html" ]

###
Reads the projects .jshintrc file and applies coding
standards. Doesn't lint the dependencies or test
support files.
###
jshint:
all: ['Gruntfile.js', 'src/**/*.js', 'test/**/*.js', '!dependencies/*.*', '!test/support/*.*']
all: ['Gruntfile.js', 'src/**/*.js', 'test/**/*.js', '!dependencies/*.*', '!vendor/*.*', '!test/support/*.*']
options:
jshintrc: ".jshintrc"

Expand All @@ -130,8 +183,9 @@ module.exports = (grunt) ->
below.
###
build_test_runner_file:
all: [ "test/**/*_test.js" ]
all: [ "tests/**/*_test.js" ]

grunt.loadNpmTasks "grunt-bower-task"
grunt.loadNpmTasks "grunt-contrib-uglify"
grunt.loadNpmTasks "grunt-contrib-jshint"
grunt.loadNpmTasks "grunt-contrib-qunit"
Expand All @@ -142,22 +196,25 @@ module.exports = (grunt) ->
grunt.loadNpmTasks "grunt-contrib-less"
grunt.loadNpmTasks "grunt-contrib-copy"
grunt.loadNpmTasks "grunt-contrib-clean"

grunt.loadNpmTasks "grunt-karma"
###
A task to build the test runner html file that get place in
/test so it will be picked up by the qunit task. Will
place a single <script> tag into the body for every file passed to
its coniguration above in the grunt.initConfig above.
###
grunt.registerMultiTask "build_test_runner_file", "Creates a test runner file.", ->
tmpl = grunt.file.read("test/support/runner.html.tmpl")
tmpl = grunt.file.read("tests/support/runner.html.tmpl")
renderingContext = data:
files: @filesSrc.map (fileSrc) -> fileSrc.replace "test/", ""
grunt.file.write "test/runner.html", grunt.template.process(tmpl, renderingContext)
files: @filesSrc.map (fileSrc) -> fileSrc.replace "tests/", ""
grunt.file.write "tests/runner.html", grunt.template.process(tmpl, renderingContext)

grunt.registerTask "build_srcs", [ "coffee:srcs", "emberTemplates", "neuter" ]
grunt.registerTask "build_app", [ "coffee:app", "emberTemplates", "neuter" ]
grunt.registerTask "build_tests", [ "coffee:tests", "emberTemplates", "neuter" ]
if env is "dev"
grunt.registerTask "default", [ "build_srcs", "build_app", "less", "copy", "uglify", "watch" ]
grunt.registerTask "default", [ "clean", "bower", "build_srcs", "build_app", "build_tests", "less", "copy", "uglify", "watch" ]
# build: same as default but no bower
grunt.registerTask "build", [ "clean", "build_srcs", "build_app", "build_tests", "less", "copy", "uglify", "watch" ]
else
grunt.registerTask "default", [ "less", "build_srcs", "uglify"]
grunt.registerTask "default", [ "bower", "less", "build_srcs", "uglify"]
Loading

0 comments on commit c265d6c

Please sign in to comment.