kriangle 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 94a8b6cad02b4f2290c4db90ec9c521d6e4524f5eedb16d5080560c64d4b669d
+  data.tar.gz: 2427a89e91ea3ee96b5c9461e53028f3a94db4c88fcc4efd5a5518dcea4b95dd
+SHA512:
+  metadata.gz: 0c94d697623ca4c12f389244d9bb600b6b8dfd15ad59fbb407d1bcd824a3c35e472386f25a840eecdcf6c15eab9233d3a7d60ae5c21b9c26313921202e2eb99b
+  data.tar.gz: 8cafdce35a5c41f46ea45d1e743513654877de90ae1ce322bb4686bf17ec7805d33e76d4d23a74a01c300c4662d5fe09d74e7f9495e31b31f209b1372be410f5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+kriangle-*

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at lalit.logical@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in kriangle.gemspec
+gemspec
+
+gem 'byebug', platform: :mri
+
+gem 'sqlite3', '~> 1.4', '>= 1.4.2'
+
+gem 'bcrypt', '~> 3.1.7'
+gem 'dotenv-rails', '~> 2.7', '>= 2.7.6'
+gem 'devise', '~> 4.4', '>= 4.4.3'
+
+gem 'grape', '~> 1.2', '>= 1.2.4'
+gem 'grape-active_model_serializers', '~> 1.5', '>= 1.5.2'
+gem 'grape-rails-cache', '~> 0.1.2'
+gem 'grape-swagger', '~> 1.4'
+gem 'grape-swagger-rails', '~> 0.3.1'
+
+gem 'api-pagination', '~> 4.7'
+gem 'kaminari', '~> 1.0', '>= 1.0.1'
+
+gem 'rack-cors', '~> 1.1', '>= 1.1.1'
+gem 'ransack', '~> 2.3'
+
+gem 'carrierwave', '~> 2.0', '>= 2.0.2'

data/Gemfile.lock

@@ -0,0 +1,216 @@
+PATH
+  remote: .
+  specs:
+    kriangle (0.1.0)
+      api-pagination (~> 4.7)
+      bcrypt (~> 3.1.7)
+      carrierwave (~> 2.0, >= 2.0.2)
+      devise (~> 4.4, >= 4.4.3)
+      dotenv-rails (~> 2.7, >= 2.7.6)
+      grape (~> 1.2, >= 1.2.4)
+      grape-active_model_serializers (~> 1.5, >= 1.5.2)
+      grape-rails-cache (~> 0.1.2)
+      grape-swagger (~> 1.4)
+      grape-swagger-rails (~> 0.3.1)
+      kaminari (~> 1.0, >= 1.0.1)
+      rack-cors (~> 1.1, >= 1.1.1)
+      ransack (~> 2.3)
+      sqlite3 (~> 1.4, >= 1.4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.1.3.2)
+      actionview (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.1.3.2)
+      activesupport (= 6.1.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    active_model_serializers (0.10.12)
+      actionpack (>= 4.1, < 6.2)
+      activemodel (>= 4.1, < 6.2)
+      case_transform (>= 0.2)
+      jsonapi-renderer (>= 0.1.1.beta1, < 0.3)
+    activemodel (6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activerecord (6.1.3.2)
+      activemodel (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activesupport (6.1.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    api-pagination (4.8.2)
+    bcrypt (3.1.16)
+    builder (3.2.4)
+    byebug (11.1.3)
+    carrierwave (2.2.1)
+      activemodel (>= 5.0.0)
+      activesupport (>= 5.0.0)
+      addressable (~> 2.6)
+      image_processing (~> 1.1)
+      marcel (~> 1.0.0)
+      mini_mime (>= 0.1.3)
+      ssrf_filter (~> 1.0)
+    case_transform (0.2)
+      activesupport
+    concurrent-ruby (1.1.8)
+    crass (1.0.6)
+    devise (4.8.0)
+      bcrypt (~> 3.0)
+      orm_adapter (~> 0.1)
+      railties (>= 4.1.0)
+      responders
+      warden (~> 1.2.3)
+    dotenv (2.7.6)
+    dotenv-rails (2.7.6)
+      dotenv (= 2.7.6)
+      railties (>= 3.2)
+    dry-configurable (0.12.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5.0)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.5.0)
+      concurrent-ruby (~> 1.0)
+    dry-inflector (0.2.0)
+    dry-logic (1.2.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5)
+    dry-types (1.5.1)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    erubi (1.10.0)
+    ffi (1.15.1)
+    grape (1.5.3)
+      activesupport
+      builder
+      dry-types (>= 1.1)
+      mustermann-grape (~> 1.0.0)
+      rack (>= 1.3.0)
+      rack-accept
+    grape-active_model_serializers (1.5.2)
+      active_model_serializers (>= 0.10.0)
+      grape (>= 0.8.0)
+    grape-rails-cache (0.1.2)
+      activesupport
+      grape
+    grape-swagger (1.4.0)
+      grape (~> 1.3)
+    grape-swagger-rails (0.3.1)
+      railties (>= 3.2.12)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    image_processing (1.12.1)
+      mini_magick (>= 4.9.5, < 5)
+      ruby-vips (>= 2.0.17, < 3)
+    jsonapi-renderer (0.2.2)
+    kaminari (1.2.1)
+      activesupport (>= 4.1.0)
+      kaminari-actionview (= 1.2.1)
+      kaminari-activerecord (= 1.2.1)
+      kaminari-core (= 1.2.1)
+    kaminari-actionview (1.2.1)
+      actionview
+      kaminari-core (= 1.2.1)
+    kaminari-activerecord (1.2.1)
+      activerecord
+      kaminari-core (= 1.2.1)
+    kaminari-core (1.2.1)
+    loofah (2.9.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    marcel (1.0.1)
+    method_source (1.0.0)
+    mini_magick (4.11.0)
+    mini_mime (1.1.0)
+    mini_portile2 (2.5.1)
+    minitest (5.14.4)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    mustermann-grape (1.0.1)
+      mustermann (>= 1.0.0)
+    nokogiri (1.11.5)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    orm_adapter (0.5.0)
+    public_suffix (4.0.6)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rack-cors (1.1.1)
+      rack (>= 2.0.0)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (~> 1.0)
+    rake (13.0.3)
+    ransack (2.4.2)
+      activerecord (>= 5.2.4)
+      activesupport (>= 5.2.4)
+      i18n
+    responders (3.0.1)
+      actionpack (>= 5.0)
+      railties (>= 5.0)
+    ruby-vips (2.1.2)
+      ffi (~> 1.12)
+    ruby2_keywords (0.0.4)
+    sqlite3 (1.4.2)
+    ssrf_filter (1.0.7)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    warden (1.2.9)
+      rack (>= 2.0.9)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  api-pagination (~> 4.7)
+  bcrypt (~> 3.1.7)
+  bundler (~> 1.16)
+  byebug
+  carrierwave (~> 2.0, >= 2.0.2)
+  devise (~> 4.4, >= 4.4.3)
+  dotenv-rails (~> 2.7, >= 2.7.6)
+  grape (~> 1.2, >= 1.2.4)
+  grape-active_model_serializers (~> 1.5, >= 1.5.2)
+  grape-rails-cache (~> 0.1.2)
+  grape-swagger (~> 1.4)
+  grape-swagger-rails (~> 0.3.1)
+  kaminari (~> 1.0, >= 1.0.1)
+  kriangle!
+  rack-cors (~> 1.1, >= 1.1.1)
+  rake (~> 13.0)
+  ransack (~> 2.3)
+  sqlite3 (~> 1.4, >= 1.4.2)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Lalit Kumar Maurya
+
+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,307 @@
+# Kriangle
+
+Kriangle is a library (gem) built upon ruby to scaffold the Modules (Model, Controller, Serialiser, APIs and much more) in rails project.
+
+Any modules can be consists of below components.
+1. Model
+2. Controller (APIs)
+3. Serialiser
+5. Swagger Docs
+6. much more ...
+
+Kriangle can scaffold any module easily by using it’s [Generators](#generators). You can control the module generation with [skip options](#skip-options). Also you can choose the [options](#options) as per your requirements.
+
+## Contents
+
+- [Getting Started](#getting-started)
+  - [Generators](#generators)
+  - [Initial Setup](#initial-setup)
+  - [Module Generator](#module-generator)
+- [Options](#options)
+  - [Associations](#associations)
+  - [Columns](#columns)
+  - [Controller Actions](#controller-actions)
+  - [Skip Options](#skip-options)
+  - [Advanced Options](#advanced-options)
+    - [Database](#database)
+    - [Wrapper](#wrapper)
+    - [APIs Routes](#apis-routes)
+    - [Parent Reference](#parent-reference)
+    - [Self Reference](#self-reference)
+- [Example](#example)
+- [License](#license)
+- [Code of Conduct](#code-of-conduct)
+
+## Getting started
+
+Kriangle works with Rails 5.1 onwards (< 6). Add the following line to your Gemfile:
+
+```ruby
+gem 'kriangle'
+```
+
+Or you can use the master branch code as gem. Add the following line to your Gemfile:
+
+```ruby
+gem 'kriangle', git: 'git@github.com:lalitlogical/kriangle.git', branch: 'master'
+```
+
+Then run `bundle install`
+
+Kriangle dependent on [Devise](https://github.com/heartcombo/devise) gem for its authentication module. So we have to generate its intialiser file by installing it.
+
+```ruby
+bundle exec rails g devise:install
+```
+
+Next, you need to run the generators:
+
+### Generators
+
+Kriangle provides two generator for this purpose:
+1. [Initial Setup](#initial-setup) - Install the Kriangle and it's dependencies into the existing project.
+2. [Module Generator](#module-generator) - Scaffold new modules into the existing project.
+
+Always remember the **hierarchy** of modules. So if any module behave as child of any other module then parent module should be generated before the child module. So when you generate the modules, it should follow the hierarchy. i.e. if you enable the counter cache on `Post` model for it's owners, `User` module must created before `Post` module. So hierarchy should be like `User`, `Post`, `Comment`, `Like`, etc for a blog rails application.
+
+### Initial Setup
+
+In intial setup, it's create the intialiser files, authentication module (login, register, forgot password, etc), swagger setup, etc. Swagger help to create the APIs docs. This command can be run single time per project and always before module generator.
+
+In the following command you will replace `MODEL` with the class name used for the application’s users. This will create a model (if one does not exist) and configure it with the authentication module. The generator also configures your config/routes.rb file to point to the authentications controller.This command can be run single time per project and always before module generator.
+
+`rails g kriangle:install MODEL PATH [column_name:type]`
+
+i.e. if you want to generate the User model with Authentication model (for authentication purpose), so you can type below command.
+
+```ruby
+rails g kriangle:install User Auth first_name last_name gender age
+```
+Note: `email`, `password`, other columns and authetication related table will be added automatically.
+
+### Module Generator
+
+In above command we have setup the initial authetication module. We can generate the new modules with below command. You have to take care of sequence of options as below.
+
+`rails g kriangle:module MODULE [association type] [column_name:type] [controller actions] [skip options]`
+
+if you want to generate `Post` model with title, content columns, you can type below.
+
+```ruby
+rails g kriangle:module Post title:string content:text
+```
+
+By default, generated the model does not refered to current logged in user. You can enable it by passing reference=true and other arguments as below.
+
+```ruby
+rails g kriangle:module Post title:text:false:_cont_any content:text:false:_cont_any published:boolean:false::false index show create update destroy --reference=true --reference_name=current_user --association_type=has_many --skip_tips=true --creation_method=new
+```
+
+If you want to enable counter cache on user's record, you should use below command.
+
+```ruby
+rails g kriangle:module Post title:text:false:_cont_any content:text:false:_cont_any published:boolean:false::false index show create update destroy --reference=true --reference_name=current_user --association_type=has_many --counter_cache=true --skip_tips=true --creation_method=new
+```
+
+## Options
+
+Kriangle support different arguments to control the code generation.
+
+### Associations
+
+If you have rails knowledge, you are already aware about the associations (has_many, belongs_to, etc). You can control this with [Generate New module](#generate-new-module) command. This options support below items in same sequence.
+
+`ma:association_type:association_name:dependent_type:validate_presence:counter_cache:touch_record:accepts_nested_attributes:foreign_key:class_name`
+
+Let understand the every options and its supported values. By default false or nil depedents on arguments.
+
+| Option            |            Description                         |  Required   |
+|:---	              |:---	                                           |:---  |
+| `association_type` | `has_many` or `belongs_to` or `has_one`                 | True |
+| `association_name` | any previously created model name in lower case   | True |
+| `dependent_type`   | `delete_all` or `destroy_all` or `nullify`. Works only with `has_many` and `has_one` association | |
+| `validate_presence`   | `true` or `false`. Works only with `belongs_to` association | |
+| `counter_cache`   | `true` or `false` | |
+| `touch_record`   | `true` or `false` | |
+| `accepts_nested_attributes`   | `true` or `false`. Works only with `has_many` and `has_one` association | |
+| `foreign_key` | custom foreign key   | |
+| `class_name` | any previously created model name   | |
+
+i.e.
+
+`ma:has_many:comments::false:false:false:false:`
+
+### Columns
+
+By default rails support two options into migration. But we have enhance it into Kriangle. It supports as below.
+
+`column name:type:validate_presence:search_by:default value`
+
+Let understand the every arguments and its supported values. By default false or nil depedents on arguments.
+
+| Option            |            Description                         |  Required   |
+|:---	              |:---	                                           |:---  |
+| column name | any valid column name for your model             | True |
+| type | `string`, `text`, `boolean`, `integer`, `float`, `date`, `DateTime`, `array`, `attachment`, `Polymorphic`, `json`  | True |
+| `validate_presence`   | `true` or `false`. To validate the presence of column value | |
+| `search_by`   | `_eq`, `_not_eq`, `_matches`, `_does_not_match`, `_cont`, `_cont_any`, `_cont_all`, `_not_cont`, `_not_cont_any`, `_not_cont_all`, `_true`, `_false` | |
+| deafult value   | pass the default value for columns. i.e. `true` or `false` for boolean type of column | |
+
+i.e.
+
+ `title:string:false:_cont_any`
+
+### Controller Actions
+
+By default, all CRUD APIs generated. But if you want to control it, you have to mentioned the required action. It will generate only those APIs.
+
+Valid actions mentioned as below.
+1. index
+2. show
+3. create
+4. update
+5. destroy
+6. create_or_destroy - Will update the controller's action according to like dislike feature respective to authenticator model (i.e. User).
+
+### Skip Options
+
+There are a lot of skip options available. You can check below.
+
+| Skip Options            | Default   |                            Description                     |
+|:---	                    |:---	      |:---                                                        |
+| `skip_swagger`            | `false`   | Skip the swagger documentation. **Only** valid with `install` generator |
+| `skip_avatar`            | `true`   | Skip the user's avatar feature. **Only** valid with `install` generator |
+| `skip_model`            | `false`   | Skip the model creation if model aleady created and you do not want to override it. |
+| `skip_controller`            | `false`   | Skip the controller (APIs) generation. |
+| `skip_migration`            | `false`   | Skip the table migration if table aleady created and you do not want to override it. |
+| `skip_tips`            | `false`   | Skip the tips or comments into files. |
+| `skip_authentication`            | `false`   | Skip the authentication for whole APIs of given module. |
+| `skip_serializer`            | `false`   | Skip the serialiser. |
+| `skip_timestamps`            | `false`   | Skip the timestamps columns (created_at and updated_at) into migration |
+| `skip_pagination`            | `false`   | Skip the pagination from index API of controller. |
+
+### Advanced Options
+
+Kriangle support some additional arguments also for generate code as per requirement.
+
+#### Database
+
+By default, Kriangle generate code based on `sqlite3` database, mostly migration files depends on it. But you can provide the database to generate the code based on that.
+
+```ruby
+--database=postgresql
+```
+
+Supported databases: `postgresql`, `mysql`, `sqlite3`. You have to add **adapter/gem** based on your database in your **Gemfile**
+
+
+#### Wrapper
+
+Kriangle generate all APIs under `app/controllers/api/v1` folder. You can change the wrapper name (v1) as per you need with `wrapper` arguments as below.
+
+```ruby
+--wrapper=V2
+```
+
+#### APIs Routes
+
+Kriangle by default use the model name for routes. So if do not pass it will determined with model name. i.e. For `Post` model api routes will be `posts` and whole end points will be like `api/v1/posts`. You can change it by passing your desired path as below.
+
+```ruby 
+--controller_path=blogs
+```
+
+Now all APIs points to `/api/v1/blogs` but model will be `Post`.
+
+#### Parent Reference
+
+Kriangle provides mechanism to add parent reference with previously created model (i.e. `User`, `Post` ) or `current_user`.
+
+If you want that newly created records associate with current logged in user, you have to pass below arguments.
+
+```ruby
+--reference=true --reference_name=current_user --association_type=has_many
+```
+There are other options also available under this Parent Reference.
+
+| Option         | Default   |                            Description                     |
+|:---	           |:---   |:---                                                        |
+| `reference` | `false` | Current model's association sets up a one-to-one connection with selected model, such that each instance of the declaring model 'belongs to' one instance of the selected model. |
+| `reference_name` | | `current_user` or previously created model name i.e. `User`, `Post` |
+| `association_type` | `has_many` | `has_many` or `has_one` |
+| `counter_cache` | `false` | Default false. Instead of counting the associated records in the database every time the page loads, ActiveRecord’s counter caching feature allows storing the counter and updating it every time an associated object is created or removed. Parent model should be defined before this model. |
+| `touch_record` | `false` | In rails touch is used to update the parent's updated_at field for persisted objects. |
+| `accepts_nested_attributes` | `false` | Nested attributes allow you to save attributes on associated records through the parent. By default nested attribute updating is turned off and you can enable it using the accepts_nested_attributes_for class method. When you enable nested attributes an attribute writer is defined on the model. |
+
+#### Self Reference
+
+Kriangle provides mechanism to add self reference within the model.
+
+If you want that newly created records associate with existing record of same table, you have to pass below arguments.
+
+```ruby
+--self_reference=true --parent_association_name=parent --child_association_name=replies
+```
+
+You can chose your desired association name through `parent_association_name` and `child_association_name` arguments.
+
+## Example
+
+To understand the uses of Kriangle, we will provide a example of **Blogger** rails application.
+
+Let's create a rails project.
+
+```ruby
+rails _5.2.3_ new blogger
+```
+
+Now follow the [Getting Started](#getting-started) to setup the Kriangle gem into your newly created **blogger** rails project. After that we run its generators to scaffold new modules into the **blogger** rails project as below.
+
+Let generate the **authentication** module. Its a **mendatory** step.
+
+```ruby
+rails g kriangle:install User email:string:true name:string:true --skip_avatar=true --skip_tips=true --controller_path=Auth
+```
+
+Let now generate the two modules.
+1. [Blog](https://kriangle.s3.ap-south-1.amazonaws.com/blog-module-setting.png)
+2. [Comment](https://kriangle.s3.ap-south-1.amazonaws.com/comment-module-setting.png)
+
+Kriangle provide you different arguments to control the module generation. So we will use some of them mentioned below.
+
+A full fledge command which contains approx all arguments will be like something below.
+1. It will generate the `Blog` model with title, description, published columns and with enabling searching on title and description columns.
+2. It will also create all CRUD APIs.
+3. It will also associate the records with `current_user` during CRUD.
+4. It will also enable counter caching on users table to store the blogs_count.
+
+```ruby
+rails g kriangle:module Blog ma:has_many:comments:delete_all:false:false:false:false: title:string:false:_cont_any description:text:false:_cont_any published:boolean:false::false index show create update destroy --reference=true --reference_name=current_user --association_type=has_many --counter_cache=true --skip_tips=true --creation_method=new
+```
+
+Next command will generate the `Comment` model associated with `Blog` model with message column. Its also provide the self reference mechanism to itself table to store the replies on the comments.
+
+```ruby
+rails g kriangle:module Comment ma:belongs_to:user::true:false:false:false: message:text:false index show create update destroy --reference=true --reference_name=Blog --association_type=has_many --counter_cache=true --self_reference=true --parent_association_name=parent --child_association_name=replies --skip_tips=true --creation_method=new
+```
+When you are done with these commands, please run `rake db:migrate` to complete the migration.
+
+Now run the application and go to [http://localhost:3000/swagger](http://localhost:3000/swagger) routes to check the APIs documentation as below.
+
+![alt text][api-documentation-image]
+
+Also you can check the rails project which will magically contains the generated code.
+
+This is the example of Kriangle which can be use to scaffold a full working module with these generators. Play it!
+
+Hope you like it!. if you face any issue, please feel free to contact us :)
+
+## 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 Kriangle project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/lalitlogical/kriangle/blob/master/CODE_OF_CONDUCT.md).
+
+[api-documentation-image]: https://kriangle.s3.ap-south-1.amazonaws.com/kriangle-api-documentation.png "Swagger APIs documentation"