rbs_config 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61793181f02c7345ef7f22fe57204825aad1575141e9de7b6723c13928a6f25d
-  data.tar.gz: bc22569815b41ee6b65d8e19816376e0312a074baa3b4997ccdc7dcf9d82368d
+  metadata.gz: 8f7dc816262f1365ddfbf97de2aa149271b18080d4de58dd96341a71e025ce02
+  data.tar.gz: 6197190426cf582d43b13b315174cefea17c22b0d4c2c7da44b00a1d1d18217f
 SHA512:
-  metadata.gz: 4299e76aeb9d945dda9fece882aa8c153813d0f9f916b7f6a18faaf644b58dde066411587b7ad68d9fda64a8fe7682976d8273a5e820a6a1dba340f57cc19811
-  data.tar.gz: d1d0d938d45bef011eefba72b2a35bfcf452f78e02cfb31669bce0d8a4bbb5ade031c587978960404440aac7ca4de18f1cdcdb88f0cc558e122ee42e8e71e1b4
+  metadata.gz: 3d712b3aa4dc185dd994bc8d00f9d8c693dd94cc0c68e0620a8398ff3417b14a741561220bc9665460ba0678118fd1ad779e68ae4d1f3d36eb7f597c7f6727ea
+  data.tar.gz: c4366d824d02533718b947b00d8f28f8536efe74fc97c14846731df7a836202eac0913840d4a737a644910cf8536e807386485e69fbc3d3d1e2da551bb9acd16

data/.rubocop.yml

@@ -15,6 +15,9 @@ Style/StringLiteralsInInterpolation:
 Layout/LineLength:
   Max: 120
 
+Metrics/AbcSize:
+  Max: 20
+
 Metrics/BlockLength:
   Exclude:
     - "spec/**/*_spec.rb"

data/README.md

@@ -1,24 +1,34 @@
 # rbs_config
 
-rbs_config is a RBS generator for [config gem](https://github.com/rubyconfig/config).
+rbs_config is a RBS generator for Rails configuration.
+
+Now supports the following configuration:
+
+* Rails configuration (`Rails.configuration`)
+* [config gem](https://github.com/rubyconfig/config)
 
 ## Installation
 
 Add a new entry to your Gemfile and run `bundle install`:
 
     group :development do
-      gem 'rbs_config'
+      gem 'rbs_config', require: false
     end
 
 After the installation, please run rake task generator:
 
     bundle exec rails g rbs_config:install
 
-Additionally, it would be better to add the following entry to your `rbs_collection.yml`:
+And then, please modify `lib/tasks/rbs_config.rake` to fit your application.
+For example, set it up like this if you're using Rails configuration:
+
+    RbsConfig::RakeTask.new do |task|
+      task.type = :rails
+      task.mapping = { conf_name: Rails.application.config_for(:conf_name) }
+    end
 
-    gems:
-        - name: rbs_config
-          ignore: true
+Then, rbs_config will generate RBS file for `Rails.application.conf_name` from your
+configuration file.
 
 ## Usage
 

data/lib/generators/rbs_config/install_generator.rb

@@ -9,11 +9,17 @@ module RbsConfig
         begin
           require 'rbs_config/rake_task'
           RbsConfig::RakeTask.new do |task|
-            # The class name of configuration object.
+            # The type of configuration (default: :config)
+            # task.type = :config | :rails
+
+            # The class name of configuration object (for :config type)
             # task.class_name = "Settings"
 
-            # The files to be loaded.
+            # The files to be loaded (for :config type)
             # task.files = [Pathname(Rails.root / "config/settings.yml")]
+
+            # The mapping of configuration (for :rails type)
+            # task.mapping = { foo: Rails.application.config_for(:foo) }
           end
         rescue LoadError
           # failed to load rbs_config. Skip to load rbs_config tasks.

data/lib/rbs_config/rails_config.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require "rbs"
+require "active_support/ordered_options"
+require "active_support/core_ext/string/inflections"
+
+module RbsConfig
+  module RailsConfig
+    def self.generate(mapping:)
+      Generator.new(mapping: mapping).generate
+    end
+
+    class Generator
+      attr_reader :mapping
+
+      def initialize(mapping:)
+        @mapping = mapping
+      end
+
+      def generate
+        classes = generate_classes(mapping)
+        methods = mapping.map do |key, value|
+          "def #{key}: () -> #{stringify_type(key, value)}"
+        end
+
+        format <<~RBS
+          module Rails
+            class Application
+              class Configuration
+                #{classes.join("\n")}
+                #{methods.join("\n")}
+              end
+            end
+
+            def self.configuration: () -> Application::Configuration | ...
+          end
+        RBS
+      end
+
+      private
+
+      def format(rbs)
+        parsed = RBS::Parser.parse_signature(rbs)
+        StringIO.new.tap do |out|
+          RBS::Writer.new(out: out).write(parsed[1] + parsed[2])
+        end.string
+      end
+
+      def generate_classes(config)
+        config.filter_map do |key, value|
+          next unless value.is_a?(ActiveSupport::OrderedOptions)
+
+          classes = generate_classes(value)
+          methods = generate_methods(value)
+
+          <<~RBS
+            class #{key.to_s.camelize}
+              #{classes.join("\n")}
+              #{methods.join("\n")}
+            end
+          RBS
+        end
+      end
+
+      def generate_methods(config)
+        case config
+        when ActiveSupport::OrderedOptions
+          generate_ordered_options_methods(config)
+        when Hash
+          generate_hash_methods(config)
+        end
+      end
+
+      def generate_ordered_options_methods(config)
+        methods = config.map do |key, value|
+          type = stringify_type(key, value)
+          <<~RBS
+            def #{key}: () -> #{type}
+            def #{key}!: () -> #{type}
+          RBS
+        end
+
+        brace_method_type = config.map do |key, value|
+          "(:#{key}) -> #{stringify_type(key, value)}"
+        end.join(" | ")
+
+        methods + ["def []: #{brace_method_type}"]
+      end
+
+      def generate_hash_methods(config)
+        method_type = config.map do |key, value|
+          "(:#{key} | \"#{key}\") -> #{stringify_type(key, value)}"
+        end.join(" | ")
+        ["def []: #{method_type}"]
+      end
+
+      def stringify_type(name, value) # rubocop:disable Metrics/CyclomaticComplexity
+        case value
+        when ActiveSupport::OrderedOptions
+          name.to_s.camelize
+        when Hash
+          pairs = value.map do |k, v|
+            "#{k}: #{stringify_type(k, v)}"
+          end
+          "{ #{pairs.join(", ")} }"
+        when Array
+          types = value.map { |v| stringify_type(name, v) }.uniq
+          "Array[#{types.join(" | ")}]"
+        when NilClass
+          "nil"
+        when TrueClass, FalseClass
+          "bool"
+        else
+          value.class.to_s
+        end
+      end
+    end
+  end
+end

data/lib/rbs_config/rake_task.rb

@@ -5,16 +5,18 @@ require "rake/tasklib"
 
 module RbsConfig
   class RakeTask < Rake::TaskLib
-    attr_accessor :class_name, :files, :name, :signature_root_dir
+    attr_accessor :type, :class_name, :files, :mapping, :name, :signature_root_dir
 
     def initialize(name = :'rbs:config', &block)
       super()
 
       @name = name
+      @type = :config
       @class_name = "Settings"
       @files = [Pathname(Rails.root / "config/settings.yml"),
                 Pathname(Rails.root / "config/settings.local.yml"),
                 Pathname(Rails.root / "config/settings/production.yml")]
+      @mapping = {}
       @signature_root_dir = Pathname(Rails.root / "sig/config")
 
       block&.call(self)
@@ -34,11 +36,17 @@ module RbsConfig
     def define_generate_task
       desc "Generate RBS files for config gem"
       task "#{name}:generate" do
+        require "rbs_config"  # load RbsConfig lazily
+
         signature_root_dir.mkpath
 
-        signature_root_dir.join("#{class_name.underscore}.rbs").write(
-          RbsConfig::Config.generate(files: files, class_name: class_name)
-        )
+        rbs = if type == :config
+                RbsConfig::Config.generate(files: files, class_name: class_name)
+              else
+                RbsConfig::RailsConfig.generate(mapping: mapping)
+              end
+
+        signature_root_dir.join("#{class_name.underscore}.rbs").write(rbs)
       end
     end
 

data/lib/rbs_config/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RbsConfig
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/rbs_config.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "rbs_config/config"
+require_relative "rbs_config/rails_config"
 require_relative "rbs_config/version"
 
 module RbsConfig

data/sig/rbs_config/rails_config.rbs

@@ -0,0 +1,21 @@
+module RbsConfig
+  module RailsConfig
+    def self.generate: (mapping: Hash[untyped, Hash[untyped, untyped] | ActiveSupport::OrderedOptions[untyped, untyped]]) -> String
+
+    class Generator
+      attr_reader mapping: Hash[untyped, Hash[untyped, untyped] | ActiveSupport::OrderedOptions[untyped, untyped]]
+
+      def initialize: (mapping: Hash[untyped, Hash[untyped, untyped] | ActiveSupport::OrderedOptions[untyped, untyped]]) -> void
+      def generate: () -> String
+
+      private
+
+      def format: (String rbs) -> String
+      def generate_classes: (Hash[untyped, untyped] | ActiveSupport::OrderedOptions[untyped, untyped] config) -> Array[String]
+      def generate_methods: (Hash[untyped, untyped] | ActiveSupport::OrderedOptions[untyped, untyped] config) -> Array[string]
+      def generate_ordered_options_methods: (ActiveSupport::OrderedOptions[untyped, untyped] config) -> Array[string]
+      def generate_hash_methods: (Hash[untyped, untyped]) -> Array[string]
+      def stringify_type: (untyped name, untyped value) -> String
+    end
+  end
+end

data/sig/rbs_config/rake_task.rbs

@@ -1,5 +1,6 @@
 module RbsConfig
   class RakeTask < Rake::TaskLib
+    attr_accessor type: :config | :rails
     attr_accessor class_name: String
     attr_accessor files: Array[Pathname]
     attr_accessor name: Symbol

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs_config
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Takeshi KOMIYA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-23 00:00:00.000000000 Z
+date: 2023-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -56,6 +56,7 @@ files:
 - lib/generators/rbs_config/install_generator.rb
 - lib/rbs_config.rb
 - lib/rbs_config/config.rb
+- lib/rbs_config/rails_config.rb
 - lib/rbs_config/rake_task.rb
 - lib/rbs_config/version.rb
 - rbs_collection.lock.yaml
@@ -63,6 +64,7 @@ files:
 - rbs_config.gemspec
 - sig/rbs_config.rbs
 - sig/rbs_config/config.rbs
+- sig/rbs_config/rails_config.rbs
 - sig/rbs_config/rake_task.rbs
 - sig/shims/rake.rbs
 homepage: https://github.com/tk0miya/rbs_config