Seperates Create & Update Request Schema and Updates Documentations

.gitignore

@@ -10,4 +10,6 @@
 # rspec failure tracking
 .rspec_status
 
-*.gem
+*.gem
+
+.idea

.rubocop.yml

@@ -108,10 +108,28 @@ 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
+Rails/Output: # Disables rails output warning
+  Enabled: false
+Metrics/ClassLength: # Disables class length warning
+  Max: 150

CHANGELOG.md

@@ -1,5 +1,18 @@
-## [Unreleased]
+# Changelog
+This file is used to list changes made in each version of the Schemable gem.
 
-## [0.1.0] - 2023-05-10
+## Schemable 1.0.3 (2024-01-30)
 
-- Initial release
+* Added configuration for preventing expansion for nested relationships. This can be done by setting the `expand_nested` to `true` when  invoking `ResponseSchemaGenerator`'s `generate` instance method (e.g. `ResponseSchemaGenerator.new(instance).generate(expand: true, expand_nested: true)`. Additionally, you could globally set the value of `expand_nested` to the same value as `expand` by setting the configuration `infer_expand_nested_from_expand` to `true` in the `/config/initializers/schemable.rb`.
+
+## Schemable 1.0.2 (2024-01-30)
+
+* Added configuration for making certain associations nullable in the response's relationship. This can be done by adding the name of the relation in the `nullable_relationships` method's array of strings.
+
+## Schemable 1.0.1 (2024-01-29)
+
+* Added configuration for changing the default value of enums. By default first key is used, or alternatively default can be set manually by the method `default_value_for_enum_attributes` from the definition.
+
+## Schemable 1.0.0 (2023-11-17)
+
+* Initial release

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.1.0'
+gem 'rspec', '~> 3.12.0'
+gem 'rubocop', '~> 1.60.2'
+gem 'rubocop-rails', '~> 2.23.1'
 
 group :development, :test do
+  gem 'factory_bot_rails', '~> 6.4.3'
   gem 'jsonapi-rails', '~> 0.4.1'
-  gem 'factory_bot_rails', '~> 6.2'
-end
+end

Gemfile.lock

@@ -1,128 +0,0 @@
-PATH
-  remote: .
-  specs:
-    schemable (0.1.2)
-      factory_bot_rails (~> 6.2.0)
-      jsonapi-rails (~> 0.4.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionpack (7.0.4.3)
-      actionview (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
-      rack (~> 2.0, >= 2.2.0)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (7.0.4.3)
-      activesupport (= 7.0.4.3)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (7.0.4.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    ast (2.4.2)
-    builder (3.2.4)
-    concurrent-ruby (1.2.2)
-    crass (1.0.6)
-    diff-lcs (1.5.0)
-    erubi (1.12.0)
-    factory_bot (6.2.1)
-      activesupport (>= 5.0.0)
-    factory_bot_rails (6.2.0)
-      factory_bot (~> 6.2.0)
-      railties (>= 5.0.0)
-    i18n (1.13.0)
-      concurrent-ruby (~> 1.0)
-    json (2.6.3)
-    jsonapi-deserializable (0.2.0)
-    jsonapi-parser (0.1.1)
-    jsonapi-rails (0.4.1)
-      jsonapi-parser (~> 0.1.0)
-      jsonapi-rb (~> 0.5.0)
-    jsonapi-rb (0.5.0)
-      jsonapi-deserializable (~> 0.2.0)
-      jsonapi-serializable (~> 0.3.0)
-    jsonapi-renderer (0.2.2)
-    jsonapi-serializable (0.3.1)
-      jsonapi-renderer (~> 0.2.0)
-    loofah (2.21.2)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.12.0)
-    method_source (1.0.0)
-    minitest (5.18.0)
-    nokogiri (1.14.4-x86_64-linux)
-      racc (~> 1.4)
-    parallel (1.23.0)
-    parser (3.2.2.1)
-      ast (~> 2.4.1)
-    racc (1.6.2)
-    rack (2.2.7)
-    rack-test (2.1.0)
-      rack (>= 1.3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.5.0)
-      loofah (~> 2.19, >= 2.19.1)
-    railties (7.0.4.3)
-      actionpack (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
-      method_source
-      rake (>= 12.2)
-      thor (~> 1.0)
-      zeitwerk (~> 2.5)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.8.0)
-    rexml (3.2.5)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.51.0)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.2.0.0)
-      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)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.1)
-      parser (>= 3.2.1.0)
-    ruby-progressbar (1.13.0)
-    thor (1.2.2)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.4.2)
-    zeitwerk (2.6.8)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  factory_bot_rails (~> 6.2)
-  jsonapi-rails (~> 0.4.1)
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.21)
-  schemable!
-
-BUNDLED WITH
-   2.4.12