schemable 0.1.0

data/lib/templates/common_definitions.rb

@@ -0,0 +1,13 @@
+module SwaggerDefinitions
+  module CommonDefinitions
+    def self.aggregate
+      [
+        # Import definitions like this:
+        # Swagger::Definitions::Model.definitions
+
+        # Make sure in swagger_helper.rb's components section you have:
+        # schemas: SwaggerDefinitions::CommonDefinitions.aggregate
+      ].flatten.reduce({}, :merge)
+    end
+  end
+end

data/lib/templates/serializers_helper.rb

@@ -0,0 +1,7 @@
+module SerializersHelper
+  def serializers_map
+    {
+      # TheModel: V1::TheModelSerializer
+    }.freeze
+  end
+end

data/schemable.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/schemable/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "schemable"
+  spec.version = Schemable::VERSION
+  spec.authors = ["Muhammad Nawzad"]
+  spec.email = ["hama127n@gmail.com"]
+
+  spec.summary = "An opiniated Gem for Rails applications to auto generate schema in JSONAPI format."
+  spec.description = "The schemable gem is an opiniated Gem for Rails applications to auto generate schema for models in JSONAPI format. It is designed to work with rswag's swagger documentation since it can generate the schemas for it."
+  spec.homepage = "https://github.com/muhammadnawzad/schemable"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.2"
+
+  spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = 'https://github.com/muhammadnawzad/schemable'
+  spec.metadata["changelog_uri"] = 'https://github.com/muhammadnawzad/schemable/blob/main/CHANGELOG.md'
+
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jsonapi-rails", "~> 0.4.1"
+  spec.add_dependency "factory_bot_rails", "~> 6.2.0"
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/sig/schemable.rbs

@@ -0,0 +1,4 @@
+module Schemable
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: schemable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Muhammad Nawzad
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jsonapi-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.0
+description: The schemable gem is an opiniated Gem for Rails applications to auto
+  generate schema for models in JSONAPI format. It is designed to work with rswag's
+  swagger documentation since it can generate the schemas for it.
+email:
+- hama127n@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/schemable/install_generator.rb
+- lib/generators/schemable/model_generator.rb
+- lib/schemable.rb
+- lib/schemable/version.rb
+- lib/templates/common_definitions.rb
+- lib/templates/serializers_helper.rb
+- schemable.gemspec
+- sig/schemable.rbs
+homepage: https://github.com/muhammadnawzad/schemable
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/muhammadnawzad/schemable
+  source_code_uri: https://github.com/muhammadnawzad/schemable
+  changelog_uri: https://github.com/muhammadnawzad/schemable/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: An opiniated Gem for Rails applications to auto generate schema in JSONAPI
+  format.
+test_files: []