config_rbs_generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b6deabab848b4d6d5d8a557cdb51fdea4c8cf6162a7450cea3a8435153d591af
+  data.tar.gz: ca955203b2d4cfd196d7a0da8f2125a8e6265daf5eb3511f8b0334c98d4327e4
+SHA512:
+  metadata.gz: 66c56ee05c827aaefc32fa749c5f3f484efff5134d1c0b0425973aed2eaca7f221e73beb0f186ab82c3f9ee31a932aeed3126de0fcd5910be052eca20f78fc10
+  data.tar.gz: 5471f09b794746be9ecb8db0c2802bdf297fc02575203f0ed2ec25a9e5e930c5be9cd21be103849ebad42feeb8f8ba4dfa4bdcf7190e053c2a0d7c2a7de75a1a

data/.rubocop.yml

@@ -0,0 +1,25 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0
+  SuggestExtensions: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-08-10
+
+- Initial release

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in config_rbs_generator.gemspec
+gemspec
+
+gem 'config'
+gem 'minitest'
+gem 'rake', '~> 13.0'
+gem 'rubocop', '~> 1.21'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 fugakkbn
+
+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,36 @@
+[![test - Ruby 3.1](https://github.com/fugakkbn/config_rbs_generator/actions/workflows/test_ruby_3.1.yml/badge.svg)](https://github.com/fugakkbn/config_rbs_generator/actions/workflows/test_ruby_3.1.yml)
+[![RuboCop - Ruby 3.1](https://github.com/fugakkbn/config_rbs_generator/actions/workflows/rubocop_ruby_3.1.yml/badge.svg)](https://github.com/fugakkbn/config_rbs_generator/actions/workflows/rubocop_ruby_3.1.yml)
+[![test - Ruby 3.0](https://github.com/fugakkbn/config_rbs_generator/actions/workflows/test_ruby_3.0.yml/badge.svg)](https://github.com/fugakkbn/config_rbs_generator/actions/workflows/test_ruby_3.0.yml)
+[![RuboCop - Ruby 3.0](https://github.com/fugakkbn/config_rbs_generator/actions/workflows/rubocop_ruby_3.0.yml/badge.svg)](https://github.com/fugakkbn/config_rbs_generator/actions/workflows/rubocop_ruby_3.0.yml)
+
+# config_rbs_generator
+
+The `config_rbs_generator` generates an RBS for the `Settings` object that can be handled by the `config` gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'config_rbs_generator', require: false
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install config_rbs_generator
+
+## Usage
+
+Simply run the following command in the root directory of your Rails project.
+
+    $ bundle exec config_rbs_generate
+
+The RBS will then appear in the console. Place rbs file in the location of your choice and copy & paste.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'config_rbs_generator'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/initializers/config.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'config'
+
+Config.setup do |config|
+  config.const_name = 'Settings'
+  config.load_and_set_settings('config/settings.yml')
+end

data/config/settings.yml

@@ -0,0 +1,25 @@
+size: 2
+text: How are you?
+array:
+  - 10
+  - Nice to meet you!
+  - Goodbye.
+section:
+  size: 3
+  text: Hello World!
+  yeah:
+    mettya:
+      holiday: Sunday
+  paragraph:
+    - paragraph1
+    - paragraph2
+uho:
+  - name: name1
+    title: title1
+    body: body1
+  - name: name2
+    title: title2
+    body: body2
+  - name: name3
+    title: title3
+    body: body3

data/config_rbs_generator.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/config_rbs_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'config_rbs_generator'
+  spec.version = ConfigRbsGenerator::VERSION
+  spec.authors = ['fugakkbn']
+  spec.email = ['aax.chiri@gmail.com']
+
+  spec.summary = 'This gem generates RBS files for `Settings` objects created by the config gem.'
+  spec.homepage = 'https://github.com/fugakkbn/config_rbs_generator'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/fugakkbn/config_rbs_generator/blob/main/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/exe/config_rbs_generate

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/config_rbs_generator'
+
+puts '== generate started... =='
+puts ConfigRbsGenerator.run
+puts 'Settings RBS generated!'

data/lib/config_rbs_generator/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ConfigRbsGenerator
+  VERSION = '0.1.0'
+end

data/lib/config_rbs_generator.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative 'config_rbs_generator/version'
+require_relative '../config/initializers/config'
+
+module ConfigRbsGenerator
+  def self.run
+    outputs = Outputs.new
+
+    Settings.each do |setting|
+      outputs.add_method_definition(setting)
+    end
+
+    outputs.finalize
+    outputs.text
+  end
+
+  class Outputs
+    attr_reader :text
+
+    def initialize
+      @text = "module #{Config.const_name}\n"
+    end
+
+    def add_method_definition(setting)
+      @text += "  def self.#{setting[0]}: () -> "
+
+      if setting[1].instance_of?(Config::Options)
+        @text += "self\n"
+        setting[1].each { |s| add_method_definition(s) }
+        @text
+      elsif setting[1].instance_of?(Array)
+        convert_array_types(setting[1])
+      else
+        @text += "#{setting[1].class}\n"
+      end
+    end
+
+    def finalize
+      @text += "end\n"
+    end
+
+    private
+
+    def convert_array_types(array)
+      if array.map { |s| s.instance_of?(Config::Options) }.include?(true)
+        @text += "Array[untyped]\n"
+      else
+        klasses = array.map(&:class).uniq
+        @text += "Array[#{klasses.join(' | ')}]\n"
+      end
+    end
+  end
+
+  class Error < StandardError; end
+end

data/sig/config_rbs_generator.rbs

@@ -0,0 +1,18 @@
+module ConfigRbsGenerator
+  VERSION: String
+
+  def self.run: () -> String
+
+  class Outputs
+    @text: String
+
+    attr_reader text: ::String
+
+    def initialize: () -> void
+    def add_method_definition: ([::Symbol, ::String]
+                              | [::Symbol, ::Integer]
+                              | [::Symbol, ::Array[::String | ::Integer]]
+                              | [::Symbol, Config::Options] setting) -> ::String
+    def finalize: -> ::String
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: config_rbs_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- fugakkbn
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-08-13 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- aax.chiri@gmail.com
+executables:
+- config_rbs_generate
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/initializers/config.rb
+- config/settings.yml
+- config_rbs_generator.gemspec
+- exe/config_rbs_generate
+- lib/config_rbs_generator.rb
+- lib/config_rbs_generator/version.rb
+- sig/config_rbs_generator.rbs
+homepage: https://github.com/fugakkbn/config_rbs_generator
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/fugakkbn/config_rbs_generator
+  source_code_uri: https://github.com/fugakkbn/config_rbs_generator
+  changelog_uri: https://github.com/fugakkbn/config_rbs_generator/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.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: This gem generates RBS files for `Settings` objects created by the config
+  gem.
+test_files: []