orthoses 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b99546cf07198d891673d96f57a8cd22602db3442fc8526377e113dc82716351
-  data.tar.gz: 45d4d49fd66765eac0429d90718ae7b4bc3f66181f67efd97c9f4a5b4e970955
+  metadata.gz: 0520f0eccc23c9e57186592193f7c30175b59aa1364bcf5de49f1bcbff0a68d5
+  data.tar.gz: deaeb9dd3baed337b22a0b6990bbddd98df1c282c1dc6269edeb3a78060abae1
 SHA512:
-  metadata.gz: e4d4ebe91a584ab50850ccdf60a489e37fe1c4da99fd8bc9ed2f8aa255b2e35f5b60b0b3ab5f2662833d34f8514f87be84018b17a97dcda76db4e57e1f52a834
-  data.tar.gz: 78696a4162f7e469c52e059cf4fdc09160926f354ab5b3343db681d7ba78360c1406889da81830c585dda30a95921d9753fced392ad92f72324f27a8d0ad3747
+  metadata.gz: 94037bb0ff51e74b055e8282048d818ca051a102fdcdb16f64dc00c1a83194bcd4a721d68c9dbf43e47a691b66ef7b992b319a69fff4b0afc9374cdf8001d0a2
+  data.tar.gz: 27611b811fead68b26ccd941d5111039ad7fddb0fdaad6d0509bf9b5d6bdfc29783daab517a959389a95890eba75ce57b5933a9c26158f17b3a2d8d0ab2948ff

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    orthoses (1.0.0)
+    orthoses (1.2.0)
       rbs (~> 2.0)
 
 GEM

data/README.md

@@ -3,6 +3,10 @@
 Orthoses is a framework for RBS generation.
 The Rack architecture keeps your code organized and extensible.
 
+- You can choose which middleware to use.
+- You can write your own middleware to use.
+- You can publish your middleware and share it with the world.
+
 ## PoC
 
 https://gist.github.com/ksss/00592da24f28774bf8fc5db08331666e
@@ -19,27 +23,38 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
+For example, You can write script in Rakefile.
+
 ```rb
-Orthoses::Builder.new do
-  use Orthoses::CreateFileByName
-    base_dir: Rails.root.join("sig/out"),
-    header: "# !!! GENERATED CODE !!!"
-  use Orthoses::Filter do |name, _content|
-    path, _lineno = Object.const_source_location(name)
-    return false unless path
-    %r{app/models}.match?(path)
+require 'orthoses'
+
+namespace :rbs do
+  desc "build RBS to sig/out"
+  task :build do
+    Orthoses::Builder.new do
+      use Orthoses::CreateFileByName,
+        base_dir: Rails.root.join("sig/out"),
+        header: "# !!! GENERATED CODE !!!"
+      use Orthoses::Filter do |name, _content|
+        path, _lineno = Object.const_source_location(name)
+        return false unless path
+        %r{app/models}.match?(path)
+      end
+      use YourCustom::Middleware
+      use Orthoses::Mixin
+      use Orthoses::Constant
+      use Orthoses::Walk,
+        root: "Foo"
+      run -> {
+        # load library or application
+      }
+    end.call
   end
-  use YourCustom::Middleware
-  use Orthoses::Mixin
-  use Orthoses::Constant
-  use Orthoses::Walk,
-    root: "Foo"
-  run -> () {
-    # load library or application
-  }
-end.call
+end
 ```
 
+Then, you can see the result files under `sig/out`.
+
 ## Utils
 
 `Orthoses::Utils` is a collection of useful methods.
@@ -150,11 +165,6 @@ Run `rbs prototype rb` command process to `paths` option files.
 
 Run `rbs prototype runtime` command process with `patterns` option string.
 
-### Orthoses::AvoidRecursiveAncestorError
-
-Mixin a module into an Object class raises `RBS::RecursiveAncestorError` when validation.
-Please add this middleware then.
-
 ### Orthoses::Autoload
 
 Force load const defined by `autoload`.
@@ -176,3 +186,9 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the Orthoses project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ksss/orthoses/blob/main/CODE_OF_CONDUCT.md).
+
+# TODO
+
+- Share middleware sets for commonly used use cases.
+  - For library.
+  - For application.

data/lib/orthoses/content/duplication_checker.rb

@@ -4,18 +4,23 @@ module Orthoses
     class DuplicationChecker
       def initialize(decl, env: nil)
         @decl = decl
-        @env = env || Utils.rbs_environment(collection: true)
+        @env = env || Utils.rbs_environment
       end
 
       def update_decl
         return unless @decl.respond_to?(:members)
         uniq_map = {}
         @decl.members.each do |member|
-          key = member_key(member)
-          drop_member = uniq_map[key]
-          uniq_map[key] = member
-          if drop_member
-            Orthoses.logger.info("#{@decl.name} \"#{member.location.source}\" was droped since duplication")
+          if member.instance_of?(RBS::AST::Members::MethodDefinition) && member.overload
+            # avoid to duplicate and keep order
+            uniq_map[Object.new] = member
+          else
+            key = member_key(member)
+            drop_member = uniq_map[key]
+            uniq_map[key] = member
+            if drop_member
+              Orthoses.logger.info("#{@decl.name} \"#{member.location.source}\" was droped since duplication")
+            end
           end
         end
         drop_known_method_definition(uniq_map)

data/lib/orthoses/content/environment.rb

@@ -17,7 +17,7 @@ module Orthoses
 
       def initialize(constant_filter: nil, mixin_filter: nil, attribute_filter: nil)
         @load_env = RBS::Environment.new
-        @known_env = Utils.rbs_environment(collection: true, cache: false)
+        @known_env = Utils.rbs_environment(cache: false)
         @constant_filter = constant_filter
         @mixin_filter = mixin_filter
         @attribute_filter = attribute_filter

data/lib/orthoses/content.rb

@@ -19,12 +19,14 @@ module Orthoses
     attr_reader :name
     attr_reader :body
     attr_accessor :header
+    attr_accessor :comment
 
     def initialize(name:)
       Orthoses.logger.debug("Create Orthoses::Content for #{name}")
       @name = name
       @body = []
       @header = nil
+      @comment = nil
     end
 
     def <<(line)
@@ -63,7 +65,9 @@ module Orthoses
     end
 
     def original_rbs
-      a = [@header]
+      a = []
+      a << @comment if @comment
+      a << @header
       a << "  #{@body.join("\n  ")}" if @body.length > 0
       a << "end"
       a.join("\n")
@@ -111,7 +115,7 @@ module Orthoses
     end
 
     def auto_header
-      env = Utils.rbs_environment(collection: true)
+      env = Utils.rbs_environment
       if entry = env.class_decls[TypeName(name).absolute!]
         @header = Content::HeaderBuilder.new(env: env).build(entry: entry)
         return

data/lib/orthoses/create_file_by_name.rb

@@ -13,33 +13,12 @@ module Orthoses
       @if = binding.local_variable_get(:if)
     end
 
-    using(Module.new {
-      refine String do
-        # avoid load active_support
-        def underscore
-          return self unless /[A-Z-]|::/.match?(self)
-          word = self.to_s.gsub("::", "/")
-          word.gsub!(/(?:(?<=([A-Za-z\d]))|\b)((?-mix:(?=a)b))(?=\b|[^a-z])/) { "#{$1 && '_' }#{$2.downcase}" }
-          word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
-          word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
-          word.tr!("-", "_")
-          word.downcase!
-          word
-        end
-      end
-    })
+    using Utils::Underscore
 
     def call
       store = @loader.call
 
       store.each do |name, content|
-        begin
-          content.uniq!
-        rescue NameError, LoadError => err
-          Orthoses.logger.error(err.inspect)
-          next
-        end
-
         next unless @if.nil? || @if.call(name, content)
 
         file_path = Pathname("#{@base_dir}/#{name.to_s.split('::').map(&:underscore).join('/')}.rbs")

data/lib/orthoses/outputable/avoid_recursive_ancestor_error.rb

@@ -11,6 +11,9 @@ module Orthoses
 
       def call
         @loader.call.tap do |store|
+          next if !store.key?("Object")
+          next if store["Object"].body.empty?
+
           object_mixins = {}
           collect_mixin_recursive(store, "Object", object_mixins)
 

data/lib/orthoses/outputable/uniq_content_body.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Orthoses
+  module Outputable
+    # UniqContentBody is an internal middleware
+    # It's using on orthoses/outputable.rb
+    class UniqContentBody
+      def initialize(loader)
+        @loader = loader
+      end
+
+      def call
+        @loader.call.tap do |store|
+          store.each do |name, content|
+            begin
+              content.uniq!
+            rescue NameError, LoadError => err
+              Orthoses.logger.error(err.inspect)
+              next
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/orthoses/outputable.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'orthoses/outputable/avoid_recursive_ancestor_error'
+require 'orthoses/outputable/uniq_content_body'
 
 module Orthoses
   # Module for output middleware.
@@ -15,6 +16,7 @@ module Orthoses
   module Outputable
     def call
       @loader = AvoidRecursiveAncestorError.new(@loader)
+      @loader = UniqContentBody.new(@loader)
       super
     end
   end

data/lib/orthoses/utils/underscore.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Orthoses
+  module Utils
+    module Underscore
+      refine String do
+        # avoid load active_support
+        def underscore
+          return self unless /[A-Z-]|::/.match?(self)
+          word = self.to_s.gsub("::", "/")
+          word.gsub!(/(?:(?<=([A-Za-z\d]))|\b)((?-mix:(?=a)b))(?=\b|[^a-z])/) { "#{$1 && '_' }#{$2.downcase}" }
+          word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+          word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+          word.tr!("-", "_")
+          word.downcase!
+          word
+        end
+      end
+    end
+  end
+end

data/lib/orthoses/utils.rb

@@ -2,6 +2,8 @@
 
 module Orthoses
   module Utils
+    autoload :Underscore, "orthoses/utils/underscore"
+
     def self.unautoload!
       warn "`Orthoses::Utils.unautoload!` is deprecated. please use `Orthoses::Autoload` middleware instead."
       ObjectSpace.each_object(Module) do |mod|
@@ -27,7 +29,7 @@ module Orthoses
       end
     end
 
-    def self.rbs_defined_const?(name, library: nil, collection: false)
+    def self.rbs_defined_const?(name, library: nil, collection: true)
       return false if name.start_with?("#<")
       env = rbs_environment(library: library, collection: collection)
       name = name.sub(/Object::/, '')
@@ -35,7 +37,7 @@ module Orthoses
       env.constant_decls.has_key?(target)
     end
 
-    def self.rbs_defined_class?(name, library: nil, collection: false)
+    def self.rbs_defined_class?(name, library: nil, collection: true)
       return false if name.start_with?("#<")
       env = rbs_environment(library: library, collection: collection)
       target = rbs_type_name(name)
@@ -69,7 +71,7 @@ module Orthoses
       end
     }.call
 
-    def self.rbs_environment(library: nil, collection: false, cache: true)
+    def self.rbs_environment(library: nil, collection: true, cache: true)
       @env_cache ||= {}
       if cache && hit = @env_cache[[library, collection]]
         return hit
@@ -188,7 +190,7 @@ module Orthoses
         else
           raise TypeError
         end
-      rbs_environment(collection: true).class_decls[type_name]&.then do |entry|
+      rbs_environment.class_decls[type_name]&.then do |entry|
         entry.decls.first.decl.type_params
       end
     end

data/lib/orthoses/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orthoses
-  VERSION = "1.0.0"
+  VERSION = "1.2.0"
 end

data/lib/orthoses.rb

@@ -3,33 +3,31 @@
 require 'rbs'
 require 'pathname'
 
-require_relative 'orthoses/attribute'
-require_relative 'orthoses/builder'
-require_relative 'orthoses/call_tracer'
-require_relative 'orthoses/constant'
-require_relative 'orthoses/content'
-require_relative 'orthoses/create_file_by_name'
-require_relative 'orthoses/delegate_class'
-require_relative 'orthoses/filter'
-require_relative 'orthoses/mixin'
-require_relative 'orthoses/load_rbs'
-require_relative 'orthoses/object_space_all'
-require_relative 'orthoses/outputable'
-require_relative 'orthoses/path_helper'
-require_relative 'orthoses/pp'
-require_relative 'orthoses/rbs_prototype_rb'
-require_relative 'orthoses/rbs_prototype_runtime'
-require_relative 'orthoses/store'
-require_relative 'orthoses/tap'
-require_relative 'orthoses/autoload'
-require_relative 'orthoses/utils'
-require_relative 'orthoses/version'
-require_relative 'orthoses/walk'
-require_relative 'orthoses/writer'
-
 module Orthoses
-  # Use autoload just in case there are side effects.
+  autoload :Attribute, 'orthoses/attribute'
+  autoload :Builder, 'orthoses/builder'
+  autoload :CallTracer, 'orthoses/call_tracer'
+  autoload :Constant, 'orthoses/constant'
+  autoload :Content, 'orthoses/content'
+  autoload :CreateFileByName, 'orthoses/create_file_by_name'
+  autoload :DelegateClass, 'orthoses/delegate_class'
+  autoload :Filter, 'orthoses/filter'
+  autoload :Mixin, 'orthoses/mixin'
   autoload :LazyTracePoint, 'orthoses/lazy_trace_point'
+  autoload :LoadRBS, 'orthoses/load_rbs'
+  autoload :ObjectSpaceAll, 'orthoses/object_space_all'
+  autoload :Outputable, 'orthoses/outputable'
+  autoload :PathHelper, 'orthoses/path_helper'
+  autoload :PP, 'orthoses/pp'
+  autoload :RBSPrototypeRB, 'orthoses/rbs_prototype_rb'
+  autoload :RBSPrototypeRuntime, 'orthoses/rbs_prototype_runtime'
+  autoload :Store, 'orthoses/store'
+  autoload :Tap, 'orthoses/tap'
+  autoload :Autoload, 'orthoses/autoload'
+  autoload :Utils, 'orthoses/utils'
+  autoload :VERSION, 'orthoses/version'
+  autoload :Walk, 'orthoses/walk'
+  autoload :Writer, 'orthoses/writer'
 
   METHOD_METHOD = ::Kernel.instance_method(:method)
   INSTANCE_METHOD_METHOD = ::Module.instance_method(:instance_method)

data/sig/orthoses/outputable/uniq_content_body.rbs

@@ -0,0 +1,6 @@
+# THIS IS GENERATED CODE from `$ rake generate_self_sig`
+
+class Orthoses::Outputable::UniqContentBody
+  def initialize: (untyped loader) -> void
+  def call: () -> untyped
+end

data/sig/orthoses/utils/underscore.rbs

@@ -0,0 +1,4 @@
+# THIS IS GENERATED CODE from `$ rake generate_self_sig`
+
+module Orthoses::Utils::Underscore
+end

data/sig/orthoses.rbs

@@ -1,7 +1,7 @@
 # THIS IS GENERATED CODE from `$ rake generate_self_sig`
 
 module Orthoses
-  VERSION: "1.0.0"
+  VERSION: "1.2.0"
   attr_accessor self.logger: ::Logger
   type store = Hash[String, Orthoses::Content]
   INSTANCE_METHOD_METHOD: UnboundMethod

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orthoses
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-09 00:00:00.000000000 Z
+date: 2022-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbs
@@ -60,6 +60,7 @@ files:
 - lib/orthoses/object_space_all.rb
 - lib/orthoses/outputable.rb
 - lib/orthoses/outputable/avoid_recursive_ancestor_error.rb
+- lib/orthoses/outputable/uniq_content_body.rb
 - lib/orthoses/path_helper.rb
 - lib/orthoses/pp.rb
 - lib/orthoses/rbs_prototype_rb.rb
@@ -67,6 +68,7 @@ files:
 - lib/orthoses/store.rb
 - lib/orthoses/tap.rb
 - lib/orthoses/utils.rb
+- lib/orthoses/utils/underscore.rb
 - lib/orthoses/version.rb
 - lib/orthoses/walk.rb
 - lib/orthoses/writer.rb
@@ -103,6 +105,7 @@ files:
 - sig/orthoses/object_space_all.rbs
 - sig/orthoses/outputable.rbs
 - sig/orthoses/outputable/avoid_recursive_ancestor_error.rbs
+- sig/orthoses/outputable/uniq_content_body.rbs
 - sig/orthoses/path_helper.rbs
 - sig/orthoses/pp.rbs
 - sig/orthoses/rbs_prototype_rb.rbs
@@ -110,6 +113,7 @@ files:
 - sig/orthoses/store.rbs
 - sig/orthoses/tap.rbs
 - sig/orthoses/utils.rbs
+- sig/orthoses/utils/underscore.rbs
 - sig/orthoses/walk.rbs
 - sig/orthoses/writer.rbs
 homepage: https://github.com/ksss/orthoses
@@ -133,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.0.dev
+rubygems_version: 3.3.16
 signing_key:
 specification_version: 4
 summary: Framework for Generate RBS