Giter VIP home page Giter VIP logo

zally's Introduction

Zally: A minimalistic, simple-to-use OpenAPI 2 and 3 linter

Build Status Codacy Badge Join the chat at https://gitter.im/zalando/zally

Zally is a quality assurance tool. It's a linter for OpenAPI specifications, it performs the following tasks :

  • Increases the quality of APIs
  • Checks compliance
  • Delivers early feedback for API designers
  • Ensures the same look-and-feel of APIs
  • Supports API-First approach
  • Provides best practices and advices

Its standard configuration will check your APIs against the rules defined in Zalando's RESTful Guidelines, but anyone can use it out-of-the-box.

Zally has an easy-to-use CLI which uses the server in the background so that you can check your API on the spot. It also features an intuitive Web UI that shows implemented rules and lints external files and (with its online editor) API definitions.

Features

  • Support for OpenAPI 3 and (Swagger) OpenAPI 2 specifications
  • RESTful API, CLI and Web interface
  • Rich Check configuration
  • Ignore functionality (x-zally-ignore extension)
  • Java/Kotlin API for new Checks + helper functions

Quick start guide

Trying out Zally is easy. You can build and run the whole Zally stack (web-ui, server and database) by executing:

docker compose up -d

Web UI is accessible on http://localhost:8080; Zally server on http://localhost:8000

Documentation and Manuals

Please consult the following documents for further information:

Integrations

Contributing to Zally

Zally welcomes contributions from the open source community. To get started, take a look at our contributing guidelines. Then check our Project Board and Issues Tracker for ideas.

Contact

Feel free to join our Gitter room or contact one of the maintainers directly.

Alternatives

Zally is not the only linter for OpenAPI v2 and v3. There is an article comparing different OpenAPI linters.

So why should you choose Zally?

  • It supports Zalando's RESTful Guidelines
  • It can be used in multiple ways: RESTful API, CLI and Web interface
  • Highly customizable (with Kotlin)

License

MIT license with an exception. See license file.

Publish

Prerequisites

Steps

  1. Create a separate branch with a name release-<release-version>.

  2. Update current version in server/gradle.properties from -SNAPSHOT to a final version.

  3. Update mime types configuration:

       ./gradlew -q generate-media-types-config --info
  4. Commit the updated file to the repository.

  5. Release Zally server and API using the command

    cd server
    ./gradlew clean build publishAllPublicationsToMavenRepository
    
  6. Commit server/gradle.properties with the release version

  7. Create a tag

    git tag v<release-version> -m "Version <release-version>"
  8. Bump version in server/gradle.properties to the next -SNAPSHOT

  9. Push release branch and tag

     git push origin
     git push origin <tag-name>
  10. Create a Pull Request with the version update

  11. Create and publish a release with a new version in GitHub

zally's People

Contributors

7databits avatar akryvko avatar bhaskarmelkani avatar caliginouspierson avatar cjhowald avatar defaude avatar dependabot[bot] avatar epaul avatar fmueller avatar ioggstream avatar ishishov avatar jaquelinep avatar kingslef avatar ktsypkina avatar maschleg avatar maxim-tschumak avatar mfellner avatar mkulak avatar nagogus avatar nehalium avatar netme avatar rbarilani avatar roxspring avatar ruiaraujo avatar superbenji avatar tfrauenstein avatar thomasabraham avatar tkrop avatar vadeg avatar zeitlinger avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

zally's Issues

Give information about not-automated rules

As user of Zalando's API Linter I'd like to know which rules are not yet automated. This would improve API design process because as an API provider I would know which rules I should read. Furthermore it would help API reviewers to know on which aspects to concentrate because they are not covered by Zally.

Server should deliver in api-violations response a simple description text about not yet automated rules. This text should be configurable. CLI should display this text as part of summary.

Fix `gradle bin` for zally-cli

We have spotted that on some environments gradle bin command doesn't create a proper zally.jar file inside the bin/ folder. That makes a zally command failing. Investigate and fix it.

Introduce new rule type "Hints"

Let's discuss the following use case:

  • User wants to implement feature A of API (e.g. HTTP headers support)
  • Zalando has already a lot of experience in implementing feature A and uses a library B for that
  • Zally spots that user implements a feature A
  • Zally gives a user recommendation to use library B during implementation and points to some usage manual.

Define GH Integration Architecture

Since we have an already working GH integration prototype, it's time to convert it to a service. Before we create tasks for that, we need to define an architecture.

Adjust colors for CLI tool on light background

In #103 we have implemented colors for CLI. They can look a bi better on white background.

Steps:

  1. Find a way to detect if background is light or dark
  2. Generate more readable colors on light background
  3. Test few popular terminal color schemes and also adjust colors for dark and light backgrounds

Light background screenshot:

screen shot 2017-01-17 at 15 08 14

Add synonym dictionary as configurable rule

In our microservice architecture at Zalando (and I guess this holds true for other environments as well) we have a common set of property names like customer id, order id and so on. Such terms should be the same across all APIs. I think it would be a great value add if one could configure a synonym dictionary where alternative names for such general property names are listed and once an API uses such a synonym and not the general name a violation is created.

This dictionary should be configurable, for instance by a simple text file.

e.g.:
customer Id -> synonyms: cId, c-id, custId, cust_identifier...

Current Zally's API spec is incomplete

Description of endpoint /api-violations doesn't contain any info on how to actually send swagger spec for linting.

paths:
  '/api-violations':
    post:
      summary:
        Retrieves list of API violations based on the uploaded swagger file
      description:
        Retrieves list of API violations based on the uploaded swagger file
      parameters:
        - $ref: '#/parameters/Authorization'
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        200:
          description: API swagger is OK
          schema:
            $ref: '#/definitions/LintingResponse'
        400:
          description: Input file not parsable
          schema:
            $ref: 'https://zalando.github.io/problem/schema.yaml#/Problem'
        default:
          description: An array of error objects
          schema:
            $ref: 'https://zalando.github.io/problem/schema.yaml#/Problem'
      security:
        - oauth2:
          - uid

Also description "Retrieves list of API violations based on the uploaded swagger file" sounds very confusing to me - do I really need to upload my swagger file prior to calling this endpoint?

I propose to add actual spec for request body and change description.

_links field is not whitelisted

_links field should be whitelisted in each rule, it violates our syntax rules in the guidelines but is also defined as default field for links in our guidelines. Currently Zally creates violations for it.

Fetch URLs from CLI tool

In order to make CLI tool usable, we need to support both inputs: files and URLs.

To avoid end-user confusion, --url parameter should be renamed to --zally-url

Introduce Code Quality Tools to the Project

In order to keep the codebase clean, we should introduce some code quality checking tools like PMD or CheckStyle for Java.

Since we also supporting Kotlin for the rule definitions, we also need to check tooling around this language.

Improve output of CLI tool

In order to make CLI tool more usable by developers, we need to improve the output:

  1. We should use colors 🔴 💚 🔷 🔸
  2. We should be provide more information from API (e.g. links to issues)
  3. We should find the best format for messages

Introduce Test Coverage Tool

Steps:

  1. Find a good tool for measuring test coverage (preferable with GH integration)
  2. Introduce it to the zally builds
  3. Add a badge to README.md

Find a way to provide line numbers in violation report

As we have discussed on API guild meeting, it would be nice to have line numbers in violations report. It will improve the usability of the tool.

Possible ways of solving this issue

  • Check the currently used library if it can be more verbose
  • Find another library
  • UGLY: try to match statements with lines

Response enhancement or more detailed report page

Include count of must, should and could violations in the response in order to quickly get an overview in which condition the API spec is.
Or let the frontend (Zally report) calculate this numbers and display them.

Show Hints in CLI

After hints implementation will be done on API level (#89) we need to show hints in CLI.

Render the Badge "Checked with Zally"

In order to promote Zally tool, we need to be able to render a special badge "Checked with Zally"

Some ideas around this topic:

  • We can use SVG to simplify the things.
  • We can show the "API Compatibility" grade based on the amount of errors.

More ideas are welcome

Define the list of rules for Hints section

In order to make Zally more friendly to end users, we need to implement an additional section called "Hints".

Example:

If Zally recognizes that the API uses pagination, we can give recommendation to consider cursor-based pagination and provide a link.

Goal:

  • Create the list of such rules
  • Prioritise them
  • Create tickets to implement them

Add metrics to server

For later analysis it would be interesting to know:

  • How often was an API review requested by Zally?
  • How many violations were found by API definition? (grouped by Violation Type)
  • How often was and API review requested per API definition? And how much did the API improve per request over time?

Anymore interesting metric ideas?

Instructions "how to build and run cli tool" are incomplete

In [cli/README.md] I see following instructions:

  1. cd cli
  2. ./gradlew bin
  3. ./bin/zally

After doing it on a clean project I get:
Error: Unable to access jarfile /Users/mkulak/src/zally/cli/bin/zally.jar

As far as I understand shell script expects jar-file to be located in his dir but gradle by default places it in build/libs.
So we need either add to readme additional step like copy build/libs/zally.jar to bin or add copying to gradle task.

Add an Integration Test to Run on Travis.CI

In order to make sure that CLI tool is not broken, we can add a small integration test which:

  1. Compiles and starts Zally Server
  2. Compiles Zally CLI
  3. Runs few scenarios with local and remote files

In order to keep it simple, we can use bats framework for that.

Replace Bats Framework for Integration Testing

Bats framework is doing its job now, but sometimes it's nightmare to debug it when something is changing on CLI.

Steps:

  1. Find a better tool to test CLI and discuss it with Zally team
  2. Reimplement existing integration tests
  3. Adjust .travis.yml

Group Validation Issues

Sometimes, developers are using the same wrong pattern in multiple places of swagger file. This leads to the long list of similar violations when running Zally.

Proposal: We need to group violations by rule type.

Question 1: Where it should be implemented?

  • On Zally API level
  • In the client libraries

Question 2: How it will affect the output format?

Consider using JDK-Standard 'ServiceLoader' instead of Spring

... for loading rules into validator.

Hi Zally-Team, I would like you to consider using the 'ServiceLoader'-Feature to load existing rules into the validator. Sure, I don't know what you plan for the future with Zally and how the Rules-interface will evolve in the future. From what I have seen so far, the ServiceLoader provided by the JDK can replace the existing mechanism to load the rules and the validator itself does not depend anymore on spring.

Removing the dependency to spring could make the validator more interesting for other projects. As an example swagger-codegen-tooling comes into my mind. It would be a nice feature to validate the swagger.yaml before generating code.
Also for other integrations (Gradle-plugin) it would make sense to provide a validator with minimal dependencies.

Please have a look into the 'serviceloader'-branch to see how the 'ServiceLoader' can be used.

Regards
Jörg

Make `zally` command path-agnostic

Steps to reproduce

  • cd bin/
  • ./zally path/to/swagger.yaml

Actual result

Command reports that bin/zally.jar is not found.

Expected result

Command should still work

Improve Error Reporting from CLI tool

In order to give the end user reasonable error messages, we need to add a wrapper for API-returned errors and check the HTTP status codes as well.

Incorrect 'Response As JSON Object:' violation

Given the following swagger spec:

swagger: '2.0'

info:
  version: "0.0.1"
  title: API Example

schemes:
    - "https"
basePath: /
produces:
  - application/json
consumes:
  - application/json

securityDefinitions:
  oauth2:
    type: oauth2
    flow: password
    tokenUrl: https://tokeninfo.example.com
    scopes:
      uid: Unique identifier of the user accessing the service.

security:
  - oauth2: [uid]

paths:
  '/resources':
    get:
      summary: List all resources
      responses:
        200:
          description: List of all resources.
          schema:
            type: object
            properties:
              items:
                type: array
                items:
                    '$ref': '#/definitions/Resource'
        500:
          description: Unexpected error

definitions:
  Resource:
    type: object
    properties:
      name:
        type: string

I get this violation when running the CLI:

$ cli/bin/zally swagger.yaml
Found the following MUST violations
===================================
Response As JSON Object:
	Always Return JSON Objects As Top-Level Data Structures To Support Extensibility
	/resources/GET/200

Summary:
=======
COULD violations: 0
SHOULD violations: 0
MUST violations: 1

Since the response type of /resources/GET/200 is:

{
  "items": [Resource,]
}

I would not expect it to be a violation.

Add Hints rules orchestration

In order to be able to show Hints to end user, we need to add orchestration for Hints rules and present them in the API output.

Blocked by #88

Update license

Provide the following license text via the GUI of your binary:

Zally is in general licensed under the following MIT license with the exception of the inflector.java file which is licensed under LGPLv2+ (see notice file below).

MIT License

Copyright (c) 2016 The Zalando Incubator

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Notice file for zally/src/main/java/de/zalando/zally/utils/Inflector.java

JBoss DNA (http://www.jboss.org/dna)
See the COPYRIGHT.txt file distributed with this work for information
regarding copyright ownership. Some portions may be licensed
to Red Hat, Inc. under one or more contributor license agreements.
See the AUTHORS.txt file in the distribution for a full listing of
individual contributors.

JBoss DNA is free software. Unless otherwise indicated, all code in JBoss DNA
is licensed to you under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation; either version 2.1 of
the License, or (at your option) any later version.

JBoss DNA is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this software; if not, write to the Free
Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
02110-1301 USA, or see the FSF site: http://www.fsf.org.

MODIFICATIONS Inflector.java:
21.12.2016 16:00 - No change

              GNU LESSER GENERAL PUBLIC LICENSE
                   Version 2.1, February 1999

Copyright (C) 1991, 1999 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.

[This is the first released version of the Lesser GPL. It also counts
as the successor of the GNU Library Public License, version 2, hence
the version number 2.1.]

                        Preamble

The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
Licenses are intended to guarantee your freedom to share and change
free software--to make sure the software is free for all its users.

This license, the Lesser General Public License, applies to some
specially designated software packages--typically libraries--of the
Free Software Foundation and other authors who decide to use it. You
can use it too, but we suggest you first think carefully about whether
this license or the ordinary General Public License is the better
strategy to use in any particular case, based on the explanations below.

When we speak of free software, we are referring to freedom of use,
not price. Our General Public Licenses are designed to make sure that
you have the freedom to distribute copies of free software (and charge
for this service if you wish); that you receive source code or can get
it if you want it; that you can change the software and use pieces of
it in new free programs; and that you are informed that you can do
these things.

To protect your rights, we need to make restrictions that forbid
distributors to deny you these rights or to ask you to surrender these
rights. These restrictions translate to certain responsibilities for
you if you distribute copies of the library or if you modify it.

For example, if you distribute copies of the library, whether gratis
or for a fee, you must give the recipients all the rights that we gave
you. You must make sure that they, too, receive or can get the source
code. If you link other code with the library, you must provide
complete object files to the recipients, so that they can relink them
with the library after making changes to the library and recompiling
it. And you must show them these terms so they know their rights.

We protect your rights with a two-step method: (1) we copyright the
library, and (2) we offer you this license, which gives you legal
permission to copy, distribute and/or modify the library.

To protect each distributor, we want to make it very clear that
there is no warranty for the free library. Also, if the library is
modified by someone else and passed on, the recipients should know
that what they have is not the original version, so that the original
author's reputation will not be affected by problems that might be
introduced by others.

Finally, software patents pose a constant threat to the existence of
any free program. We wish to make sure that a company cannot
effectively restrict the users of a free program by obtaining a
restrictive license from a patent holder. Therefore, we insist that
any patent license obtained for a version of the library must be
consistent with the full freedom of use specified in this license.

Most GNU software, including some libraries, is covered by the
ordinary GNU General Public License. This license, the GNU Lesser
General Public License, applies to certain designated libraries, and
is quite different from the ordinary General Public License. We use
this license for certain libraries in order to permit linking those
libraries into non-free programs.

When a program is linked with a library, whether statically or using
a shared library, the combination of the two is legally speaking a
combined work, a derivative of the original library. The ordinary
General Public License therefore permits such linking only if the
entire combination fits its criteria of freedom. The Lesser General
Public License permits more lax criteria for linking other code with
the library.

We call this license the "Lesser" General Public License because it
does Less to protect the user's freedom than the ordinary General
Public License. It also provides other free software developers Less
of an advantage over competing non-free programs. These disadvantages
are the reason we use the ordinary General Public License for many
libraries. However, the Lesser license provides advantages in certain
special circumstances.

For example, on rare occasions, there may be a special need to
encourage the widest possible use of a certain library, so that it becomes
a de-facto standard. To achieve this, non-free programs must be
allowed to use the library. A more frequent case is that a free
library does the same job as widely used non-free libraries. In this
case, there is little to gain by limiting the free library to free
software only, so we use the Lesser General Public License.

In other cases, permission to use a particular library in non-free
programs enables a greater number of people to use a large body of
free software. For example, permission to use the GNU C Library in
non-free programs enables many more people to use the whole GNU
operating system, as well as its variant, the GNU/Linux operating
system.

Although the Lesser General Public License is Less protective of the
users' freedom, it does ensure that the user of a program that is
linked with the Library has the freedom and the wherewithal to run
that program using a modified version of the Library.

The precise terms and conditions for copying, distribution and
modification follow. Pay close attention to the difference between a
"work based on the library" and a "work that uses the library". The
former contains code derived from the library, whereas the latter must
be combined with the library in order to run.

GNU LESSER GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

  1. This License Agreement applies to any software library or other
    program which contains a notice placed by the copyright holder or
    other authorized party saying it may be distributed under the terms of
    this Lesser General Public License (also called "this License").
    Each licensee is addressed as "you".

A "library" means a collection of software functions and/or data
prepared so as to be conveniently linked with application programs
(which use some of those functions and data) to form executables.

The "Library", below, refers to any such software library or work
which has been distributed under these terms. A "work based on the
Library" means either the Library or any derivative work under
copyright law: that is to say, a work containing the Library or a
portion of it, either verbatim or with modifications and/or translated
straightforwardly into another language. (Hereinafter, translation is
included without limitation in the term "modification".)

"Source code" for a work means the preferred form of the work for
making modifications to it. For a library, complete source code means
all the source code for all modules it contains, plus any associated
interface definition files, plus the scripts used to control compilation
and installation of the library.

Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running a program using the Library is not restricted, and output from
such a program is covered only if its contents constitute a work based
on the Library (independent of the use of the Library in a tool for
writing it). Whether that is true depends on what the Library does
and what the program that uses the Library does.

  1. You may copy and distribute verbatim copies of the Library's
    complete source code as you receive it, in any medium, provided that
    you conspicuously and appropriately publish on each copy an
    appropriate copyright notice and disclaimer of warranty; keep intact
    all the notices that refer to this License and to the absence of any
    warranty; and distribute a copy of this License along with the
    Library.

You may charge a fee for the physical act of transferring a copy,
and you may at your option offer warranty protection in exchange for a
fee.

2. You may modify your copy or copies of the Library or any portion
of it, thus forming a work based on the Library, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:

a) The modified work must itself be a software library.

b) You must cause the files modified to carry prominent notices
stating that you changed the files and the date of any change.

c) You must cause the whole of the work to be licensed at no
charge to all third parties under the terms of this License.

d) If a facility in the modified Library refers to a function or a
table of data to be supplied by an application program that uses
the facility, other than as an argument passed when the facility
is invoked, then you must make a good faith effort to ensure that,
in the event an application does not supply such function or
table, the facility still operates, and performs whatever part of
its purpose remains meaningful.

(For example, a function in a library to compute square roots has
a purpose that is entirely well-defined independent of the
application.  Therefore, Subsection 2d requires that any
application-supplied function or table used by this function must
be optional: if the application does not supply it, the square
root function must still compute square roots.)

These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Library,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Library, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote
it.

Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Library.

In addition, mere aggregation of another work not based on the Library
with the Library (or with a work based on the Library) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.

  1. You may opt to apply the terms of the ordinary GNU General Public
    License instead of this License to a given copy of the Library. To do
    this, you must alter all the notices that refer to this License, so
    that they refer to the ordinary GNU General Public License, version 2,
    instead of to this License. (If a newer version than version 2 of the
    ordinary GNU General Public License has appeared, then you can specify
    that version instead if you wish.) Do not make any other change in
    these notices.

    Once this change is made in a given copy, it is irreversible for
    that copy, so the ordinary GNU General Public License applies to all
    subsequent copies and derivative works made from that copy.

This option is useful when you wish to copy part of the code of
the Library into a program that is not a library.

  1. You may copy and distribute the Library (or a portion or
    derivative of it, under Section 2) in object code or executable form
    under the terms of Sections 1 and 2 above provided that you accompany
    it with the complete corresponding machine-readable source code, which
    must be distributed under the terms of Sections 1 and 2 above on a
    medium customarily used for software interchange.

If distribution of object code is made by offering access to copy
from a designated place, then offering equivalent access to copy the
source code from the same place satisfies the requirement to
distribute the source code, even though third parties are not
compelled to copy the source along with the object code.

  1. A program that contains no derivative of any portion of the
    Library, but is designed to work with the Library by being compiled or
    linked with it, is called a "work that uses the Library". Such a
    work, in isolation, is not a derivative work of the Library, and
    therefore falls outside the scope of this License.

However, linking a "work that uses the Library" with the Library
creates an executable that is a derivative of the Library (because it
contains portions of the Library), rather than a "work that uses the
library". The executable is therefore covered by this License.
Section 6 states terms for distribution of such executables.

When a "work that uses the Library" uses material from a header file
that is part of the Library, the object code for the work may be a
derivative work of the Library even though the source code is not.
Whether this is true is especially significant if the work can be
linked without the Library, or if the work is itself a library. The
threshold for this to be true is not precisely defined by law.

If such an object file uses only numerical parameters, data
structure layouts and accessors, and small macros and small inline
functions (ten lines or less in length), then the use of the object
file is unrestricted, regardless of whether it is legally a derivative
work. (Executables containing this object code plus portions of the
Library will still fall under Section 6.)

Otherwise, if the work is a derivative of the Library, you may
distribute the object code for the work under the terms of Section 6.
Any executables containing that work also fall under Section 6,
whether or not they are linked directly with the Library itself.

6. As an exception to the Sections above, you may also combine or
link a "work that uses the Library" with the Library to produce a
work containing portions of the Library, and distribute that work
under terms of your choice, provided that the terms permit
modification of the work for the customer's own use and reverse
engineering for debugging such modifications.

You must give prominent notice with each copy of the work that the
Library is used in it and that the Library and its use are covered by
this License. You must supply a copy of this License. If the work
during execution displays copyright notices, you must include the
copyright notice for the Library among them, as well as a reference
directing the user to the copy of this License. Also, you must do one
of these things:

a) Accompany the work with the complete corresponding
machine-readable source code for the Library including whatever
changes were used in the work (which must be distributed under
Sections 1 and 2 above); and, if the work is an executable linked
with the Library, with the complete machine-readable "work that
uses the Library", as object code and/or source code, so that the
user can modify the Library and then relink to produce a modified
executable containing the modified Library.  (It is understood
that the user who changes the contents of definitions files in the
Library will not necessarily be able to recompile the application
to use the modified definitions.)

b) Use a suitable shared library mechanism for linking with the
Library.  A suitable mechanism is one that (1) uses at run time a
copy of the library already present on the user's computer system,
rather than copying library functions into the executable, and (2)
will operate properly with a modified version of the library, if
the user installs one, as long as the modified version is
interface-compatible with the version that the work was made with.

c) Accompany the work with a written offer, valid for at
least three years, to give the same user the materials
specified in Subsection 6a, above, for a charge no more
than the cost of performing this distribution.

d) If distribution of the work is made by offering access to copy
from a designated place, offer equivalent access to copy the above
specified materials from the same place.

e) Verify that the user has already received a copy of these
materials or that you have already sent this user a copy.

For an executable, the required form of the "work that uses the
Library" must include any data and utility programs needed for
reproducing the executable from it. However, as a special exception,
the materials to be distributed need not include anything that is
normally distributed (in either source or binary form) with the major
components (compiler, kernel, and so on) of the operating system on
which the executable runs, unless that component itself accompanies
the executable.

It may happen that this requirement contradicts the license
restrictions of other proprietary libraries that do not normally
accompany the operating system. Such a contradiction means you cannot
use both them and the Library together in an executable that you
distribute.

7. You may place library facilities that are a work based on the
Library side-by-side in a single library together with other library
facilities not covered by this License, and distribute such a combined
library, provided that the separate distribution of the work based on
the Library and of the other library facilities is otherwise
permitted, and provided that you do these two things:

a) Accompany the combined library with a copy of the same work
based on the Library, uncombined with any other library
facilities.  This must be distributed under the terms of the
Sections above.

b) Give prominent notice with the combined library of the fact
that part of it is a work based on the Library, and explaining
where to find the accompanying uncombined form of the same work.
  1. You may not copy, modify, sublicense, link with, or distribute
    the Library except as expressly provided under this License. Any
    attempt otherwise to copy, modify, sublicense, link with, or
    distribute the Library is void, and will automatically terminate your
    rights under this License. However, parties who have received copies,
    or rights, from you under this License will not have their licenses
    terminated so long as such parties remain in full compliance.

  2. You are not required to accept this License, since you have not
    signed it. However, nothing else grants you permission to modify or
    distribute the Library or its derivative works. These actions are
    prohibited by law if you do not accept this License. Therefore, by
    modifying or distributing the Library (or any work based on the
    Library), you indicate your acceptance of this License to do so, and
    all its terms and conditions for copying, distributing or modifying
    the Library or works based on it.

  3. Each time you redistribute the Library (or any work based on the
    Library), the recipient automatically receives a license from the
    original licensor to copy, distribute, link with or modify the Library
    subject to these terms and conditions. You may not impose any further
    restrictions on the recipients' exercise of the rights granted herein.
    You are not responsible for enforcing compliance by third parties with
    this License.

  4. If, as a consequence of a court judgment or allegation of patent
    infringement or for any other reason (not limited to patent issues),
    conditions are imposed on you (whether by court order, agreement or
    otherwise) that contradict the conditions of this License, they do not
    excuse you from the conditions of this License. If you cannot
    distribute so as to satisfy simultaneously your obligations under this
    License and any other pertinent obligations, then as a consequence you
    may not distribute the Library at all. For example, if a patent
    license would not permit royalty-free redistribution of the Library by
    all those who receive copies directly or indirectly through you, then
    the only way you could satisfy both it and this License would be to
    refrain entirely from distribution of the Library.

If any portion of this section is held invalid or unenforceable under any
particular circumstance, the balance of the section is intended to apply,
and the section as a whole is intended to apply in other circumstances.

It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.

This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.

  1. If the distribution and/or use of the Library is restricted in
    certain countries either by patents or by copyrighted interfaces, the
    original copyright holder who places the Library under this License may add
    an explicit geographical distribution limitation excluding those countries,
    so that distribution is permitted only in or among countries not thus
    excluded. In such case, this License incorporates the limitation as if
    written in the body of this License.

  2. The Free Software Foundation may publish revised and/or new
    versions of the Lesser General Public License from time to time.
    Such new versions will be similar in spirit to the present version,
    but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the Library
specifies a version number of this License which applies to it and
"any later version", you have the option of following the terms and
conditions either of that version or of any later version published by
the Free Software Foundation. If the Library does not specify a
license version number, you may choose any version ever published by
the Free Software Foundation.

14. If you wish to incorporate parts of the Library into other free
programs whose distribution conditions are incompatible with these,
write to the author to ask for permission. For software which is
copyrighted by the Free Software Foundation, write to the Free
Software Foundation; we sometimes make exceptions for this. Our
decision will be guided by the two goals of preserving the free status
of all derivatives of our free software and of promoting the sharing
and reuse of software generally.

                        NO WARRANTY
  1. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
    WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
    EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
    OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
    KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
    PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
    LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
    THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

  2. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
    WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
    AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
    FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
    CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
    LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
    RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
    FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
    SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
    DAMAGES.

Source code of inflector.java is available under http://docs.jboss.org/jbossdna/0.5/apidocs/src-html/org/jboss/dna/common/text/Inflector.html on 21.12.2016.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.