Skip to content
This repository has been archived by the owner on Nov 2, 2020. It is now read-only.

Commit

Permalink
fork of angular-naturalsort from OverZealous
Browse files Browse the repository at this point in the history 
Originally sourced from: https://bitbucket.org/OverZealous/angularjs-naturalsort/src
  • Loading branch information
Isabella Dell committed Nov 18, 2016
1 parent 9e705d6 commit 9fa1539
Show file tree
Hide file tree
Showing 14 changed files with 1,033 additions and 201 deletions.
30 changes: 30 additions & 0 deletions Gruntfile.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
module.exports = function(grunt) {

// load all grunt tasks
require('matchdep').filterDev('grunt-*').forEach(grunt.loadNpmTasks);

grunt.initConfig({
watch: {
/* watch and see if our javascript files change, or new packages are installed */
js: {
files: ['src/*.js'],
tasks: ['uglify']
}
},

uglify: {
options: {
preserveComments: 'some'
},
js: {
files: grunt.file.expandMapping("*.js", "dist", {
cwd: 'src/',
ext: '.min.js'
})
}
}
});

grunt.registerTask('default', 'watch');

}
402 changes: 201 additions & 201 deletions LICENSE
View file

Large diffs are not rendered by default.

202 changes: 202 additions & 0 deletions LICENSE.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2013 Phil DeJarnet - http://www.overzealous.com

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
10 changes: 10 additions & 0 deletions Natural Sort.iml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<module type="WEB_MODULE" version="4">
<component name="NewModuleRootManager" inherit-compiler-output="true">
<exclude-output />
<content url="file://$MODULE_DIR$" />
<orderEntry type="sourceFolder" forTests="false" />
<orderEntry type="library" name="Node.js Dependencies for Natural Sort" level="project" />
</component>
</module>

139 changes: 139 additions & 0 deletions Readme.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
# Natural Sort for Angular.js

This repo contains several variations on a library for handling natural sorting when using the `orderBy` filter. It can also optionally be used as a standalone function by injecting the `naturalSort` service into your controller or other object.

Normally, numerical values in strings are sorted using their ascii codes in a non-inutitive manner. Natural sorting adjusts the sorting for these items to ensure that they are sorted in the order that the user would expect.

Example:

Before After
----------- -----------
foo-1 foo-1
foo-11 foo-2
foo-2 foo-5
foo-25 foo-11
foo-5 foo-25

The algorithm here can also handle sorting dates in common formats (if included), and version strings.

This library was highly inspired by [Ben Nadel's blog post, *User-Friendly Sort Of Alpha-Numeric Data In JavaScript*](http://www.bennadel.com/blog/2495-User-Friendly-Sort-Of-Alpha-Numeric-Data-In-JavaScript.htm).

A demo of this library in action [can be found on jsFiddle](http://jsfiddle.net/wE7H2/3/).

## General Usage

You must include one of the scripts in the `src` directory in your application. They all have the same API, but have slightly different feature sets, so you can swap them out at any time:

* **naturalSortVersionDatesCaching.js**
This version includes all features:
* *Number Sorting* - Finds and standardizes integers and decimals in the string
* *Version Sorting* - Finds and standardizes version strings (e.g. `1.0.2`) within the string
* *Date Sorting* - Finds and standardizes locale-specific dates (e.g. `4/23/2012` or `23.4.2012`)
* *Caching* - Caches the values based on the input
* **naturalSortVersionDates.js** - ***Recommended Version for Most Applications***
Includes everything except for the caching feature.
* **naturalSortVersionCaching.js**
Includes everything except for the date functionality.
* **naturalSortVersion.js**
Includes only number and version sorting.

After including the file you want, make sure to add it to your application module:

var app = angular.module('myApp', ['naturalSort']);

### Using with orderBy

The usage with orderBy is very simple. The `naturalSort` module adds a function onto the `$rootScope` of your application called `natural`, which can be used to sort an array based on a property of the objects that are being sorted.

<ul>
<li ng-repeat="item in items | orderBy:natural('title')">{{ title }}</li>
</ul>

You can also use it in an array of sort values:

<ul>
<li ng-repeat="item in items | orderBy:['user.name',natural('title')]">
{{ user.name }} - {{ title }}
</li>
</ul>

#### A Warning
Because the `natural` function is on `$rootScope`, it is only available from within controllers, or from directives that *do not* isolate their scope. If a directive is using an isolate scope, it wil need to reference the $rootScope function directly, like so:

<li ng-repeat="item in items | orderBy:$rootScope.natural('title')">{{ title }}</li>

### Using the Service

The service can be injected, and provides two public functions:

app.controller("MyController", ["naturalSort", function(naturalSort) {
var myArray = ...;
// The naturalSort function can be used to compare two values based
// on their natural sort value.
myArray.sort(naturalSort.naturalSort);
// The naturalValue function parses a string into a standardized
// string that can be used for comparison.
var natValue = naturalSort.naturalValue("Foo 12");
}]);

## Features

### Number Sorting

Numbers are located in the string and padded out to a consistent length. Integers are converted into decimals, then the integral part is padded with leading zeros, while the fractional part is padded with trailing zeros. This converts numbers to look like:

Original Sorting Value
3.64 00000000000000000003.64000000000000000000
5 00000000000000000005.00000000000000000000
11 00000000000000000011.00000000000000000000

### Version Strings

Version strings are numbers with more than one decimal point, such as `1.1.6`. This library identifies these and pads each component of the version string to ensure logical sorting. If a version string includes something like `-RC1`, it will be handled using the normal Number algorithm.

### Dates

Date sorting may or may not be a feature you need. It attempts to locate date strings of the format `dd?-dd?-dddd`, where `-` can be `-`, `/`, or `.`. Using Angular's `$locale` service, it will determine if the expected format for dates is `dd/mm/yyyy` or `mm/dd/yyyy`, and adjust the order of the dates appropriately. Additionally, it will attempt to determine if the month field is over `13`, and swap the values accordingly, in case the user typed the string in an unknown order.

After a date is located, it is normalized to `yyyy-mm-dd`, so normal sorting can occur.

The date portion adds about 300 bytes (1.2Kb uncompressed) to the file, and it might be confusing if you never expect embedded dates, so variations that don't have that functionality are included.

### Caching

The cost for converting these strings isn't *too* high, but the library comes in a caching format if your needs meet these requirements:

* You are sorting a *long* list
* The values in the list don't change frequently, but you might add or remove items regularly
* Your application isn't expected to be running for an extended length of time.
* You don't mind wasting the memory for the cache

The cache is very simple: it's a permanent record of every item ever converted. There's no way to clear the cache, and it doesn't have a max value. I don't know if it would ever be useful, so I recommend against it.

## License

The code is provided under the Apache License. Technically, you need to include the license in if you use the code, but I don't actually care. Take it and run with it!

> ### Why Include A License At All?
>
> Confusingly, this license is here to protect *other* users of this software. Basically, using the Apache license means I'm giving away this code. I don't really care what you do with it — feel free to copy it, reuse it, share it, whatever. But if I didn't include some sort of license, you would not be legally protected if you decided to use it.
### The Apache License Preamble

> Copyright 2013 Phil DeJarnett - http://www.overzealous.com
>
> Licensed under the Apache License, Version 2.0 (the "License");
> you may not use this file except in compliance with the License.
> You may obtain a copy of the License at
>
> http://www.apache.org/licenses/LICENSE-2.0
>
> Unless required by applicable law or agreed to in writing, software
> distributed under the License is distributed on an "AS IS" BASIS,
> WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
> See the License for the specific language governing permissions and
> limitations under the License.
Loading

0 comments on commit 9fa1539

Please sign in to comment.