scalar_ruby 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 665e34004852e3c7508b7d672ce7222f1de09183a4549bff71f82144975e476c
-  data.tar.gz: 60d68fdb4072cc5dff56e25911270ce05828c7231b9f7cc49aa1b8cc66138100
+  metadata.gz: ebbb3b25b5e211a1aba05134d5f54aee9117073edf95f14c55dadd34c26a5141
+  data.tar.gz: d7918de252e40550258ad63b169c9fd6b8be93531390d54950c98f1dd0ca7bc7
 SHA512:
-  metadata.gz: bb139b0a28acb3e42418370b36611a7eb7ea8c885f02c11c3fda2662b5424a71bb1f5be5c117173662c5ba45ae0dcf8b0ae05475964199335eb242323910718e
-  data.tar.gz: 0e27fe32e65004da16237aaa7a4300f5a005f61367fe4d8d0fa3028ec9e0d88d7c1d3d9eb438f5b84de8884cfdea0dd5957e5ce773905f2f8356f4edc6126d83
+  metadata.gz: f6f20de57d3558a21630d3f8937ceb3d6863269189c77c75248b756868e2ab903dc6fdc30da9482c6a6e6db690e551b3e49b703ccbc5919bd1e6a3f7a2148472
+  data.tar.gz: 4f28e02faa358651f1aad4fc4f9908086f585d4bf2df05cf3081b13876a307173c91d795af7058755a54d0eb545a3a81c060c19889def3c158b04e3c76ae72b9

data/README.md

@@ -1,7 +1,18 @@
+[![Gem Version](https://badge.fury.io/rb/scalar_ruby.svg)](https://badge.fury.io/rb/scalar_ruby)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/dmytroshevchuk/scalar_ruby/check.yml)](https://github.com/dmytroshevchuk/scalar_ruby/actions/workflows/check.yml)
+
 # Scalar API Reference for Ruby
 
 This gem simplifies the integration of [Scalar](https://scalar.com), a modern open-source developer experience platform for your APIs into Ruby applications.
 
+## Requirements
+
+This gem is tested and supported on the following Ruby versions:
+
+- Ruby 3.0, 3.1, 3.2, 3.3
+
+Other Ruby versions might work but are not officially supported.
+
 ## Installation
 
 Add the gem to your application's Gemfile by executing in the terminal:
@@ -51,6 +62,14 @@ end
 
 And that's it! More detailed information on other configuration options is in the section below.
 
+## Integrations
+
+You can use in-build generator to setup gem into [Ruby in Rails](https://rubyonrails.org) framework by running:
+
+```ruby
+bin/rails generate scalar:install
+```
+
 ## Configuration
 
 Once mounted to your application, the library requires no further configuration. You can immediately start playing with the provided API reference example.

data/lib/generators/scalar/install/USAGE

@@ -0,0 +1,11 @@
+Description:
+  Installs Scalar, modern open-source developer experience platform for your APIs
+
+Example:
+  bin/rails generate scalar:install
+
+This will update:
+  config/routes.rb
+
+This will create:
+  config/initializers/scalar.rb

data/lib/generators/scalar/install/install_generator.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      desc 'Installs Scalar into a Rails app'
+
+      def introduction
+        say <<~INTRODUCTION
+
+          👋 Let's install Scalar into your Rails app!
+
+        INTRODUCTION
+      end
+
+      def update_routes
+        insert_into_file Rails.root.join('config/routes.rb'), after: 'Rails.application.routes.draw do' do
+          "\n  mount Scalar::UI, at: \"/docs\""
+        end
+      end
+
+      def create_initializer
+        template 'initializer.rb', 'config/initializers/scalar.rb'
+      end
+
+      def farewell
+        say <<~FAREWELL
+
+          We're done! Your can run "/docs" to observe a scalar API platform
+
+        FAREWELL
+      end
+    end
+  end
+end

data/lib/generators/scalar/install/templates/initializer.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+Scalar.setup do |config|
+  # Specify the specific version of the Scalar. By default it uses the latest one
+  #
+  # config.library_url = "https://cdn.jsdelivr.net/npm/@scalar/api-reference"
+
+  # Add custom page title displayed in the browser tab
+  #
+  # config.page_title = "API Reference"
+
+  # Pass your API specification. It may be URL or file content in OpenAPI format
+  #
+  # config.specification = File.read(Rails.root.join("docs/openapi.yml"))
+
+  # Additional Scalar configuration (e.g. theme) can be set here
+  #
+  # config.scalar_configuration = {
+  #   theme: "purple"
+  # }
+end

data/lib/scalar/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Scalar
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,17 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: scalar_ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Dmytro Shevchuk
 - Serhii Ponomarov
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-29 00:00:00.000000000 Z
+date: 2025-02-10 00:00:00.000000000 Z
 dependencies: []
-description:
 email:
 - dmytro@hey.com
 - sergii.ponomarov@gmail.com
@@ -21,6 +19,9 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
+- lib/generators/scalar/install/USAGE
+- lib/generators/scalar/install/install_generator.rb
+- lib/generators/scalar/install/templates/initializer.rb
 - lib/scalar/config.rb
 - lib/scalar/template.erb
 - lib/scalar/ui.rb
@@ -33,7 +34,6 @@ metadata:
   homepage_uri: https://github.com/dmytroshevchuk/scalar_ruby
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/dmytroshevchuk/scalar_ruby
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -41,15 +41,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.5
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: A gem to automate using Scalar with Ruby apps
 test_files: []