schemable 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff54bf6e14c37d3fdc76b31bd73073334d753539e3dea0e0deecf63268863633
-  data.tar.gz: debcf929b72f6ac7afdcc4906aeb80407a0b5aa9dfdde86f401dfb17099af0b7
+  metadata.gz: 61661d657d9eb811ae32e778d400c824664209bf63f0602e9425c0749af794d7
+  data.tar.gz: b19b40efeb1550826ec20d6dad94d3abdd8eca92ed211837198f91a8eb3be37f
 SHA512:
-  metadata.gz: d159f7c5489bf55387f20d8552d6f6c393396a9692798de7f74e34b73a1a9ae645fdffd82fc66f8264a1ab385da0136d4ab663e5952e6e3bc0f89a2b255addcb
-  data.tar.gz: c509ac7d2711b2ff22b15fed2430fe4f434ddd3b842fca01c6a42f263e0b9027f950a302b410b348ac369c4bf35549f3e178c2596d687562269fdc86df2dd7cd
+  metadata.gz: f8dff9116105d5e6bf59a22d08f76c631eabc0fd04964d59ac9d54d3f9e8d2fd538e50720e38f48172817b895798c037a148d8bcfa1536e1fa052035537b9c4f
+  data.tar.gz: bbe13dd62692efe72f6311f30fd4a00e4314b4aa557227d7b1bcb40e5f9643c35285d810292069bbf4a2317cff25f88158584e10141e604f3be8822fe6dcb75a

data/.rubocop.yml

@@ -108,10 +108,24 @@ Metrics/AbcSize:
 Metrics/MethodLength:
   Enabled: false
 Metrics/CyclomaticComplexity:
-  Max: 15
+  Enabled: false
 Metrics/PerceivedComplexity:
-  Max: 15
+  Enabled: false
 Lint/DuplicateMethods: # Disables duplicate methods warning
   Enabled: false
 Gemspec/RequiredRubyVersion: # Disables required ruby version warning
   Enabled: false
+Metrics/ParameterLists: # Disables parameter lists warning
+  Enabled: false
+Lint/NextWithoutAccumulator: # Disables next without accumulator warning
+  Enabled: false
+Lint/ShadowingOuterLocalVariable: # Disables shadowing outer local variable warning
+  Enabled: false
+Metrics/ModuleLength: # Disables module length warning
+  Enabled: false
+Layout/EmptyLinesAroundClassBody: # Disables empty lines around class body warning
+  Enabled: false
+Layout/HeredocIndentation: # Disables heredoc indentation warning
+  Enabled: false
+Layout/ClosingHeredocIndentation: # Disables closing heredoc indentation warning
+  Enabled: false

data/Gemfile

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
 
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.0"
-gem "rubocop", "~> 1.21"
+gem 'rake', '~> 13.0.6'
+gem 'rspec', '~> 3.12'
+gem 'rubocop', '~> 1.55'
+gem 'rubocop-rails', '~> 2.20.2'
 
 group :development, :test do
-  gem 'jsonapi-rails', '~> 0.4.1'
   gem 'factory_bot_rails', '~> 6.2'
-end
+  gem 'jsonapi-rails', '~> 0.4.1'
+end

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    schemable (0.1.0)
-      factory_bot_rails (>= 6.2.0)
-      jsonapi-rails (>= 0.4.1)
+    schemable (0.1.3)
+      factory_bot_rails (~> 6.2.0)
+      jsonapi-rails (~> 0.4.1)
 
 GEM
   remote: https://rubygems.org/
@@ -51,6 +51,7 @@ GEM
     jsonapi-renderer (0.2.2)
     jsonapi-serializable (0.3.1)
       jsonapi-renderer (~> 0.2.0)
+    language_server-protocol (3.17.0.3)
     loofah (2.21.2)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
@@ -59,8 +60,9 @@ GEM
     nokogiri (1.14.4-x86_64-linux)
       racc (~> 1.4)
     parallel (1.23.0)
-    parser (3.2.2.1)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
     racc (1.6.2)
     rack (2.2.7)
     rack-test (2.1.0)
@@ -79,8 +81,8 @@ GEM
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.8.0)
-    rexml (3.2.5)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -94,18 +96,23 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.51.0)
+    rubocop (1.55.0)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.1)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
+    rubocop-rails (2.20.2)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
     ruby-progressbar (1.13.0)
     thor (1.2.2)
     tzinfo (2.0.6)
@@ -119,9 +126,10 @@ PLATFORMS
 DEPENDENCIES
   factory_bot_rails (~> 6.2)
   jsonapi-rails (~> 0.4.1)
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.21)
+  rake (~> 13.0.6)
+  rspec (~> 3.12)
+  rubocop (~> 1.55)
+  rubocop-rails (~> 2.20.2)
   schemable!
 
 BUNDLED WITH

data/README.md

@@ -1,24 +1,180 @@
 # Schemable
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/schemable`. To experiment with that code, run `bin/console` for an interactive prompt.
+The Schemable gem provides a simple way to define a schema for a Rails model in [JSONAPI](https://jsonapi.org/) format. It can automatically generate a schema for a model based on the model's factory and the model's attributes. It is also highly customizable, allowing you to modify the schema to your liking by overriding the default methods.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'schemable'
+```
 
-Install the gem and add to the application's Gemfile by executing:
+And then execute:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle install
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or install it yourself as:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install schemable
 
 ## Usage
 
-TODO: Write usage instructions here
+The installation command above will install the Schemable gem and its dependencies. However, in order for Schemable to work, you must also add the following files to your Rails application:
+
+- `app/helpers/serializers_helper.rb` - This file contains the `serializers_map` helper method, which is used to map a model to its serializer.
+- `spec/swagger/common_definitions.rb` - This file contains the `aggregate` method, which is used to aggregate the schemas of all the models in your application into a single place. This file is recommeded, but not required. If you do not use this file, you will need to manually aggregate the schemas of all the models in your application into a single place.
+
+To generate these files, run the following command:
+
+```ruby
+rails g schemable:install
+```
+
+### Generating Definition Files
+
+The Schemable gem provides a generator that can be used to generate definition files for your models. To generate a definition file for a model, run the following command:
+
+```ruby
+rails g schemable:model --model_name <model_name>
+```
+
+This will generate a definition file for the specified model in the `lib/swagger/definitions` directory. The definition file will be named `<model_name>.rb`. This file will have the bare minimum code required to generate a schema for the model. You can then modify the definition file to your liking by overriding the default methods. For example, you can add or remove attributes from the schema, or you can add or remove relationships from the schema. You can also add custom attributes to the schema. For more information on how to customize the schema, see the [Customizing the Schema](#customizing-the-schema) section below.
+
+## Customizing the Schema
+
+The Schemable gem provides a number of methods that can be used to customize the schema. These methods are defined in the `Schemable` module of the gem. To customize the schema, simply override the default methods in the definition file for the model. The following is a list of the methods that can be overridden:
+
+| WARNING: please read the method inline documentation before overriding to avoid any unexpected behavior. |
+| -------------------------------------------------------------------------------------------------------- |
+
+The list of methods that can be overridden are as follows:
+
+| Method Name                      | Description                                                                                                |
+| -------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `serializer`                     | Returns the serializer class.                                                                              |
+| `attributes`                     | Returns the attributes that are auto generated from the model.                                             |
+| `relationships`                  | Returns the relationships in the format of { belongs_to: {}, has_many: {} }.                               |
+| `array_type`                     | Returns the type of arrays in the model that needs to be manually defined.                                 |
+| `optional_request_attributes`    | Returns the attributes that are optional in the request schema.                                            |
+| `nullable_attributes`            | Returns the attributes that are nullable in the request/response schema.                                   |
+| `additional_request_attributes`  | Returns the attributes that are additional in the request schema.                                          |
+| `additional_response_attributes` | Returns the attributes that are additional in the response schema.                                         |
+| `additional_response_relations`  | Returns the relationships that are additional in the response schema (Appended to relationships).          |
+| `additional_response_included`   | Returns the included that are additional in the response schema (Appended to included).                    |
+| `excluded_request_attributes`    | Returns the attributes that are excluded from the request schema.                                          |
+| `excluded_response_attributes`   | Returns the attributes that are excluded from the response schema.                                         |
+| `excluded_response_relations`    | Returns the relationships that are excluded from the response schema.                                      |
+| `excluded_response_included`     | (not implemented yet) Returns the included that are excluded from the response schema.                     |
+| `nested_relationships`           | Returns the relationships to be further expanded in the response schema.                                   |
+| `model`                          | Returns the model class (Constantized from the definition class name).                                     |
+| `model_name`                     | Returns the model name. Used for schema type naming.                                                       |
+| `definitions`                    | Returns the generated schemas in JSONAPI format (It is recommended to override this method to your liking) |
+
+The following is an example of a definition file for a model that has been customized:
+
+<Details>
+<Summary>Click to view the example</Summary>
+
+```ruby
+module Swagger
+  module Definitions
+    class UserApplication
+
+      include Schemable
+      include SerializersHelper
+
+      attr_accessor :instance
+
+      def initialize
+        @instance ||= JSONAPI::Serializable::Renderer.new.render(FactoryBot.create(:user, :with_user_application_applicants), class: serializers_map, include: [])
+      end
+
+      def serializer
+        V1::UserApplicationSerializer
+      end
+
+      def relationships
+        {
+          belongs_to: {
+            category: Swagger::Definitions::Category,
+          },
+          has_many: {
+            applicants: Swagger::Definitions::Applicant,
+          }
+        }
+      end
+
+      def array_types
+        {
+          applicant_ids:
+            {
+              type: :array,
+              items:
+                {
+                  type: :string
+                },
+              nullable: true
+            }
+        }
+      end
+
+      def excluded_request_attributes
+        %i[id updated_at created_at applicant_ids comment]
+      end
+
+      def additional_request_attributes
+        {
+          applicants_attributes:
+            {
+              type: :array,
+              items: {
+                anyOf: [
+                  {
+                    type: :object,
+                    properties: Swagger::Definitions::Applicant.new.request_schema.as_json['properties']['data']['properties']
+                  }
+                ]
+              }
+            }
+        }
+      end
+
+      def additional_response_attributes
+        {
+          comment: { type: :object, properties: {}, nullable: true }
+        }
+      end
+
+      def nested_relationships
+        {
+          applicants: {
+            belongs_to: {
+              district: Swagger::Definitions::District,
+              province: Swagger::Definitions::Province,
+            },
+            has_many: {
+              attachments: Swagger::Definitions::Upload,
+            }
+          }
+        }
+      end
+
+      def self.definitions
+        schema_instance = self.new
+        [
+          "#{schema_instance.model}Request": schema_instance.camelize_keys(schema_instance.request_schema),
+          "#{schema_instance.model}Response": schema_instance.camelize_keys(schema_instance.response_schema(expand: true, exclude_from_expansion: [:category], multi: true)),
+          "#{schema_instance.model}ResponseExpanded": schema_instance.camelize_keys(schema_instance.response_schema(expand: true, nested: true))
+        ]
+      end
+    end
+  end
+end
+
+```
+
+</Details>
 
 ## Development
 

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 

data/lib/generators/schemable/install_generator.rb

@@ -4,8 +4,8 @@ module Schemable
     source_root File.expand_path('../../templates', __dir__)
     class_option :model_name, type: :string, default: 'Model', desc: 'Name of the model'
 
-    def initialize(*)
-      super(*)
+    def initialize(*args)
+      super(*args)
     end
 
     def copy_initializer

data/lib/generators/schemable/model_generator.rb

@@ -4,8 +4,8 @@ module Schemable
     source_root File.expand_path('../../templates', __dir__)
     class_option :model_name, type: :string, default: 'Model', desc: 'Name of the model'
 
-    def initialize(*)
-      super(*)
+    def initialize(*args)
+      super(*args)
 
       @model_name = options[:model_name]
       @model_name != 'Model' || raise('Model name is required')
@@ -36,8 +36,12 @@ module Swagger
         V1::#{@model_name.classify}Serializer
       end
 
-      def excluded_request_attributes
-        %i[id updatedAt createdAt]
+      def excluded_create_request_attributes
+        %i[updated_at created_at]
+      end
+
+      def excluded_update_request_attributes
+        %i[updated_at created_at]
       end
     end
   end

data/lib/schemable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Schemable
-  VERSION = "0.1.2"
+  VERSION = '0.1.3'
 end