documentation-zero 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b9268dac205c84212366821a80fbfc1b415c194acd5013bfd4263b95abb3b46d
+  data.tar.gz: b14a79c073247962b148fa46a61220fbb0669b49d12c8df24b38e5ca17975782
+SHA512:
+  metadata.gz: fc628c160b2404f99ffa77d0d491d55e43ed902ba45379355b672783578fd89c98290aaa71dc12d725169bcccd93927cc302e9167fadb4b574a1e4f07dfde73d
+  data.tar.gz: 0d555dc8941e2599c25fee949790aadfadea4bd1610c5d152e29ecd28bd3a6dbd1e65ea2f82fbecbe793aadf9100a2546574827cc71f2b11d3a7b73ce12f17d7

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.0.1] - 2022-03-17
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at lazaronixon@hotmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in documentation_zero.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Nixon
+
+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.

data/README.md

@@ -0,0 +1,39 @@
+# Documentation Zero
+
+The purpose of documentation zero is to generate a scaffold for rails api documentations using markdown.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "documentation-zero"
+```
+
+## Usage
+
+```
+rails generate documentation:readme
+```
+
+```
+rails generate documentation:scaffold posts title:string body:text published:boolean
+```
+
+Add ```- [Posts](.documentation-api/sections/posts.md)``` to API endpoints section.
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lazaronixon/documentation-zero. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/lazaronixon/documentation-zero/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DocumentationZero project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/lazaronixon/documentation-zero/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/documentation_zero.gemspec

@@ -0,0 +1,24 @@
+require_relative "lib/documentation_zero/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "documentation-zero"
+  spec.version = DocumentationZero::VERSION
+  spec.authors = ["Nixon"]
+  spec.email = ["lazaronixon@hotmail.com"]
+
+  spec.summary = "An documentation system generator for Rails applications"
+  spec.homepage = "https://github.com/lazaronixon/documentation-zero"
+  spec.license = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/lazaronixon/documentation-zero"
+  spec.metadata["changelog_uri"] = "https://github.com/lazaronixon/documentation-zero/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+end

data/lib/documentation-zero.rb

@@ -0,0 +1 @@
+require "documentation_zero"

data/lib/documentation_zero/version.rb

@@ -0,0 +1,3 @@
+module DocumentationZero
+  VERSION = "0.0.1"
+end

data/lib/documentation_zero.rb

@@ -0,0 +1,4 @@
+require_relative "documentation_zero/version"
+
+module DocumentationZero
+end

data/lib/generators/documentation/readme/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate documentation:readme

data/lib/generators/documentation/readme/readme_generator.rb

@@ -0,0 +1,20 @@
+module Documentation
+  module Generators
+    class ReadmeGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_files
+        template "README.md", ".documentation_api/README.md"
+      end
+
+      private
+        def application_name
+          if defined?(Rails) && Rails.application
+            Rails.application.class.name.split("::").first.underscore
+          else
+            "application"
+          end
+        end
+    end
+  end
+end

data/lib/generators/documentation/readme/templates/README.md.tt

@@ -0,0 +1,77 @@
+# The <%= application_name.humanize %> API
+
+Welcome to the <%= application_name.humanize %> API! If you're looking to integrate your application with <%= application_name.humanize %> or create your own application in concert with data inside of <%= application_name.humanize %>, you're in the right place. We're happy to have you!
+
+## Making a request
+
+All URLs start with **`https://example.com/api/`**. URLs are HTTPS only. The path is prefixed with the `/api` prefix.
+
+To make a request for all the resources on your account, append the `resources` index path to the base URL to form something like `https://example.com/api/resources.json`. In cURL, it looks like this:
+
+``` shell
+curl -H "Authorization: Bearer $ACCESS_TOKEN" -H 'User-Agent: MyApp (yourname@example.com)' https://example.com/api/resources.json
+```
+
+## Identifying your application
+
+You must include a `User-Agent` header with **both**:
+
+* The name of your application
+* A link to your application or your email address
+
+We use this information to get in touch if you're doing something wrong (so we can warn you before you're blacklisted) or something awesome (so we can congratulate you). Here are examples of acceptable `User-Agent` headers:
+
+* `User-Agent: Freshbooks (http://freshbooks.com/contact.php)`
+* `User-Agent: Fabian's Ingenious Integration (fabian@example.com)`
+
+If you don't include a `User-Agent` header, you'll get a `400 Bad Request` response.
+
+## JSON only
+
+We use JSON for all API data. The style is no root element and snake\_case for object keys. This means that you have to send the `Content-Type` header `Content-Type: application/json; charset=utf-8` when you're POSTing or PUTing data into <%= application_name.humanize %>. All API URLs end in `.json` to indicate that they return JSON. Alternatively you can send `Accept: application/json`.
+
+You'll receive a `415 Unsupported Media Type` response code if you don't include the `Content-Type` header.
+
+## Pagination
+
+Most collection APIs paginate their results. The number of requests that'll appear on each page is variable. In most cases, we use a [geared pagination ratio](https://github.com/basecamp/geared_pagination) with 15 results on page 1, 30 on page 2, 50 on 3, and then 100 on 4 and above. The <%= application_name.humanize %> API follows the [RFC5988 convention](https://tools.ietf.org/html/rfc5988) of using the `Link` header to provide URLs for the `next` page. Follow this convention to retrieve the next page of data—please don't build the pagination URLs yourself!
+
+Here's an example response header from requesting the third page of some resource:
+
+```
+Link: <https://example.com/api/resources.json?page=4>; rel="next"
+```
+
+If the `Link` header is blank, that's the last page. The <%= application_name.humanize %> API also provides the `X-Total-Count` header, which displays the total number of resources in the collection you are fetching.
+
+## Using HTTP caching
+
+You must use HTTP freshness headers to speed up your application and lighten the load on our servers. Most API responses will include an `ETag` or `Last-Modified` header. When you first request a resource, store these values. On subsequent requests, submit them back to us as `If-None-Match` and `If-Modified-Since`, respectively. If the resource hasn't changed since your last request, you'll get a `304 Not Modified` response with no body, saving you the time and bandwidth of sending something you already have.
+
+## Handling errors
+
+API clients must expect and gracefully handle transient errors, such as rate limiting or server errors. We recommend baking 5xx and 429 response handling into your low-level HTTP client so your integration can handle most errors automatically.
+
+### Rate limiting (429 Too Many Requests)
+
+You can perform up to 50 requests per 10-second period from the same IP address. If you exceed this limit, you'll get a [429 Too Many Requests](http://tools.ietf.org/html/draft-nottingham-http-new-status-02#section-4) response for subsequent requests. Check the `Retry-After` header to see how many seconds to wait before retrying the request.
+
+### [5xx server errors](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#5xx_Server_errors)
+
+If <%= application_name.humanize %> is having trouble, you will get a response with a 5xx status code indicating a server error. 500 (Internal Server Error), 502 (Bad Gateway), 503 (Service Unavailable), and 504 (Gateway Timeout) may be retried with [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff).
+
+### 404 Not Found
+
+API requests may 404 due to deleted content, an inactive account, missing user permissions, etc. Detect these conditions to give your users a clear explanation about why they can't connect to <%= application_name.humanize %>. Do not automatically retry these requests.
+
+## API endpoints
+
+<!-- START API ENDPOINTS -->
+
+<!-- END API ENDPOINTS -->
+
+---
+
+If you have a specific feature request or find a bug, please open a GitHub issue. We encourage you to fork these docs for local reference and happily accept pull requests with improvements.
+
+To talk with us and other developers about the API, [post a question on StackOverflow](http://stackoverflow.com/questions/ask) tagged `<%= application_name.dasherize %>`. If you need help from us directly, please open a support ticket.

data/lib/generators/documentation/scaffold/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate admin:scaffold model field:type field:type

data/lib/generators/documentation/scaffold/scaffold_generator.rb

@@ -0,0 +1,12 @@
+module Documentation
+  module Generators
+    class ScaffoldGenerator < Rails::Generators::NamedBase
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_files
+        template "resource.md", ".documentation_api/sections/#{plural_file_name}.md"
+      end
+    end
+  end
+end

data/lib/generators/documentation/scaffold/templates/resource.md.tt

@@ -0,0 +1,77 @@
+# <%= human_name.pluralize %>
+
+Endpoints:
+
+- [Get <%= human_name.pluralize.downcase %>](#get-<%= plural_name.dasherize %>)
+- [Get <%= human_name.downcase %>](#get-<%= singular_name.dasherize %>)
+- [Create <%= human_name.downcase %>](#create-<%= singular_name.dasherize %>)
+- [Update <%= human_name.downcase %>](#update-<%= singular_name.dasherize %>)
+- [Delete <%= human_name.downcase %>](#delete-<%= singular_name.dasherize %>)
+
+## Get <%= human_name.pluralize.downcase %>
+
+- `GET /<%= plural_name %>.json` will return a [paginated list](../readme.md#pagination) of <%= human_name.pluralize.downcase %>.
+
+<!--
+_Optional query parameters_:
+
+* `attribute1` - when set to true, will only return resources that are completed.
+* `attribute2` - when set to true, will only return resources that are completed.
+-->
+
+See the [<%= human_name.downcase %>](#model) model for more info on the response payload.
+
+## Get <%= human_name.downcase %>
+
+- `GET /<%= plural_name %>/1.json` will return the <%= human_name.downcase %> with an ID of `1`.
+
+See the [<%= human_name.downcase %>](#model) model for more info on the response payload.
+
+## Create <%= human_name.downcase %>
+
+- `POST /<%= plural_name %>.json` creates <%= human_name.downcase %>.
+
+<!--
+**Required parameters**: `attribute1` and `attribute2`.
+-->
+
+_Optional parameters_:
+
+<% attributes.each do |attribute| -%>
+* `<%= attribute.column_name %>` - attribute from <%= human_name.downcase %>.
+<% end -%>
+
+This endpoint will return `201 Created` with the current JSON representation of the <%= human_name.downcase %> if the creation was a success. See the [<%= human_name.downcase %>](#model) model for more info on the payload.
+
+## Update <%= human_name.downcase %>
+
+- `PUT /<%= plural_name %>/1.json` allows changing the <%= human_name.downcase %> with an ID of `1`.
+
+This endpoint will return `200 OK` with the current JSON representation of the <%= human_name.downcase %> if the update was a success. See the [<%= human_name.downcase %>](#model) model for more info on the payload.
+
+<!--
+**Required parameters**: `attribute1` and `attribute2`.
+-->
+
+_Optional parameters_:
+
+<% attributes.each do |attribute| -%>
+* `<%= attribute.column_name %>` - attribute from <%= human_name.downcase %>.
+<% end -%>
+
+## Delete <%= human_name.downcase %>
+
+- `DELETE /<%= plural_name %>/1.json` will delete the <%= human_name.downcase %> with an ID of `1`.
+
+This endpoint will return `204 No Content` if successful. No parameters are required.
+
+---
+
+## Model
+```javascript
+{
+<% attributes.each do |attribute| -%>
+  <%= attribute.column_name %>: "<%= attribute.type %>",
+<% end -%>
+}
+```

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: documentation-zero
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nixon
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-18 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- lazaronixon@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- documentation_zero.gemspec
+- lib/documentation-zero.rb
+- lib/documentation_zero.rb
+- lib/documentation_zero/version.rb
+- lib/generators/documentation/readme/USAGE
+- lib/generators/documentation/readme/readme_generator.rb
+- lib/generators/documentation/readme/templates/README.md.tt
+- lib/generators/documentation/scaffold/USAGE
+- lib/generators/documentation/scaffold/scaffold_generator.rb
+- lib/generators/documentation/scaffold/templates/resource.md.tt
+homepage: https://github.com/lazaronixon/documentation-zero
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lazaronixon/documentation-zero
+  source_code_uri: https://github.com/lazaronixon/documentation-zero
+  changelog_uri: https://github.com/lazaronixon/documentation-zero/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: An documentation system generator for Rails applications
+test_files: []