rbs_draper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2e6df474118e1aa1523fc02aa5fd55e15d4c329ce9503147e2f252b69dc3656e
+  data.tar.gz: 78da07e88141b84609208766a4b270548da02964b313d2d462529c5afae9441a
+SHA512:
+  metadata.gz: e1774f4eebbc89a4092d0c3b1e38e53886a1740d5bb6ac275f31ed48db0c28e1847746ce22080844d18c96b6173d2355dc87a60267abef9020d25d29c1346d0f
+  data.tar.gz: 68837472313ad5112d16741a02048dd8484d38b7a10c0aaabcdf437289f521a9834bbe4b207d67021b6a7884b9d9fd1e841d449565e51a7390c4912a49c391b4

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb

data/.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+    "recommendations": [
+        "shopify.ruby-lsp",
+        "soutaro.steep-vscode",
+        "tk0miya.rspec-daemon"
+    ]
+}

data/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "[ruby]": {
+        "editor.defaultFormatter": "Shopify.ruby-lsp"
+    }
+}

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at i.tkomiya@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rbs_draper.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 1.21"
+
+group :development do
+  gem "rspec", require: false
+  gem "rspec-daemon", require: false
+
+  gem "steep"
+end
+
+# dependencies only for signature
+group :signature do
+  gem "activerecord"
+  gem "railties"
+end

data/Gemfile.lock

@@ -0,0 +1,179 @@
+PATH
+  remote: .
+  specs:
+    rbs_draper (0.1.0)
+      draper
+      rbs_rails
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.5)
+      actionview (= 7.0.5)
+      activesupport (= 7.0.5)
+      rack (~> 2.0, >= 2.2.4)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.5)
+      activesupport (= 7.0.5)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (7.0.5)
+      activesupport (= 7.0.5)
+    activemodel-serializers-xml (1.0.2)
+      activemodel (> 5.x)
+      activesupport (> 5.x)
+      builder (~> 3.1)
+    activerecord (7.0.5)
+      activemodel (= 7.0.5)
+      activesupport (= 7.0.5)
+    activesupport (7.0.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    crass (1.0.6)
+    csv (3.2.6)
+    diff-lcs (1.5.0)
+    draper (4.0.2)
+      actionpack (>= 5.0)
+      activemodel (>= 5.0)
+      activemodel-serializers-xml (>= 1.0)
+      activesupport (>= 5.0)
+      request_store (>= 1.0)
+      ruby2_keywords
+    erubi (1.12.0)
+    ffi (1.15.5)
+    fileutils (1.7.1)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.5.3)
+    loofah (2.21.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    method_source (1.0.0)
+    minitest (5.18.0)
+    nokogiri (1.15.2-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.2-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.7.0)
+    rack (2.2.7)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.0.5)
+      actionpack (= 7.0.5)
+      activesupport (= 7.0.5)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (3.1.0)
+    rbs_rails (0.12.0)
+      parser
+      rbs (>= 1)
+    regexp_parser (2.8.1)
+    request_store (1.5.1)
+      rack (>= 1.4)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-daemon (0.1.5)
+      pry
+      rspec
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.52.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    securerandom (0.2.2)
+    steep (1.4.0)
+      activesupport (>= 5.1)
+      concurrent-ruby (>= 1.2.2)
+      csv (>= 3.0.9)
+      fileutils (>= 1.1.0)
+      json (>= 2.1.0)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      logger (>= 1.3.0)
+      parser (>= 3.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 2.8.0)
+      securerandom (>= 0.1)
+      strscan (>= 1.0.0)
+      terminal-table (>= 2, < 4)
+    strscan (3.0.6)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.2.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    zeitwerk (2.6.8)
+
+PLATFORMS
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  activerecord
+  railties
+  rake (~> 13.0)
+  rbs_draper!
+  rspec
+  rspec-daemon
+  rubocop (~> 1.21)
+  steep
+
+BUNDLED WITH
+   2.4.13

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Takeshi KOMIYA
+
+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,61 @@
+# rbs_draper
+
+rbs_draper is a generator for decorators using [Draper](https://github.com/drapergem/draper).
+
+## Installation
+
+Add a new entry to your Gemfile and run `bundle install`:
+
+    group :development do
+      gem 'rbs_draper'
+    end
+
+After the installation, please run rake task generator:
+
+    bundle exec rails g rbs_draper:install
+
+Additionally, it would be better to add the following entry to your `rbs_collection.yml`:
+
+    gems:
+      - name: rbs_draper
+        ignore: true
+
+## Usage
+
+1. Run `rbs:draper:clean` at first
+2. Run other RBS generators (ex. `rbs prototype`, `rbs_rails` and so on)
+3. Run `rbs:draper:setup` task finally.
+
+       bundle exec rake rbs:draper:setup
+
+Then rbs_draper will scan your source code and type signatures, and will generate
+RBS files into `sig/draper` directory.
+
+Note: rbs_draper uses other type signatures to generate decorators' signature.
+      So it should be run after other tasks.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also
+run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, update the version number in `version.rb`, and then put
+a git tag (ex. `git tag v1.0.0`) and push it to the GitHub.  Then GitHub Actions
+will release a new package to [rubygems.org](https://rubygems.org) automatically.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tk0miya/rbs_draper.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are
+expected to adhere to the [code of conduct](https://github.com/tk0miya/rbs_draper/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RbsDraper project's codebases, issue trackers is expected to
+follow the [code of conduct](https://github.com/tk0miya/rbs_draper/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/Steepfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+
+  check "lib"                       # Directory name
+  check "Gemfile"                   # File name
+
+  configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+end

data/lib/generators/rbs_draper/install_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "rails"
+
+module RbsDraper
+  class InstallGenerator < Rails::Generators::Base
+    def create_raketask
+      create_file "lib/tasks/rbs_draper.rake", <<~RUBY
+        begin
+          require 'rbs_draper/rake_task'
+          RbsDraper::RakeTask.new
+        rescue LoadError
+          # failed to load rbs_draper. Skip to load rbs_draper tasks.
+        end
+      RUBY
+    end
+  end
+end

data/lib/rbs_draper/decoratable.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "draper"
+require "rbs_rails"
+
+module RbsDraper
+  module Decoratable
+    def self.all
+      ObjectSpace.each_object.select do |obj|
+        obj.is_a?(Class) && obj.ancestors.include?(::Draper::Decoratable) && obj.decorator_class
+      rescue StandardError
+        nil
+      end
+    end
+
+    def self.class_to_rbs(klass)
+      Generator.new(klass).generate
+    end
+
+    class Generator
+      attr_reader :klass
+
+      def initialize(klass)
+        @klass = klass
+      end
+
+      def generate
+        RbsRails::Util.format_rbs klass_decl
+      end
+
+      private
+
+      def klass_decl
+        <<~RBS
+          #{header}
+          #{method_decls}
+          #{footer}
+        RBS
+      end
+
+      def header
+        module_defs = module_names.map { |module_name| "module #{module_name}" }
+
+        class_name = klass.name.split("::").last
+        class_def = if klass.superclass
+                      "class #{class_name} < #{klass.superclass}"
+                    else
+                      "class #{class_name}"
+                    end
+
+        (module_defs + [class_def]).join("\n")
+      end
+
+      def method_decls
+        "def decorate: () -> #{klass.decorator_class.name}"
+      end
+
+      def footer
+        "end\n" * klass.module_parents.size
+      end
+
+      def module_names
+        klass.module_parents.reverse[1..].map do |mod|
+          mod.name.split("::").last
+        end
+      end
+    end
+  end
+end

data/lib/rbs_draper/decorator.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "draper"
+require "rbs"
+require "rbs_rails"
+
+module RbsDraper
+  module Decorator
+    def self.class_to_rbs(klass, rbs_builder)
+      Generator.new(klass, rbs_builder).generate
+    end
+
+    class Generator
+      attr_reader :klass, :rbs_builder
+
+      def initialize(klass, rbs_builder)
+        @klass = klass
+        @rbs_builder = rbs_builder
+      end
+
+      def generate
+        return if decorated_class.blank?
+
+        RbsRails::Util.format_rbs klass_decl
+      end
+
+      private
+
+      def klass_decl
+        <<~RBS
+          #{header}
+          def object: () -> #{klass.name.sub(/Decorator$/, "")}
+
+          #{method_decls}
+          #{footer}
+        RBS
+      end
+
+      def header
+        module_defs = module_names.map { |module_name| "module #{module_name}" }
+
+        class_name = klass.name.split("::").last
+        class_def = if klass.superclass
+                      "class #{class_name} < #{klass.superclass.name}"
+                    else
+                      "class #{class_name}"
+                    end
+
+        (module_defs + [class_def]).join("\n")
+      end
+
+      def method_decls
+        delegated_methods.filter_map do |name, method|
+          next if user_defined_class&.methods&.fetch(name, nil)
+
+          "def #{name}: #{method.method_types.map(&:to_s).join(" | ")}"
+        end.join("\n")
+      end
+
+      def footer
+        "end\n" * klass.module_parents.size
+      end
+
+      def module_names
+        klass.module_parents.reverse[1..].map do |mod|
+          mod.name.split("::").last
+        end
+      end
+
+      def decorated_class
+        type_name = RBS::TypeName(klass.name.sub(/Decorator$/, "")).absolute!
+        @decorated_class ||= rbs_builder.build_instance(type_name)
+      rescue StandardError
+        nil
+      end
+
+      def delegated_methods
+        return [] unless klass.ancestors.include? ::Draper::AutomaticDelegation
+
+        decorated_class.methods.keys.sort.filter_map do |name|
+          method = decorated_class.methods[name]
+          next if %w[::Object ::BasicObject ::Kernel].include? method.defined_in.to_s
+
+          [name, method] if method.accessibility == :public
+        end
+      end
+
+      def user_defined_class
+        type_name = RBS::TypeName(klass.name.to_s).absolute!
+        @user_defined_class ||= rbs_builder.build_instance(type_name)
+      rescue StandardError
+        nil
+      end
+    end
+  end
+end

data/lib/rbs_draper/rake_task.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "rbs/cli"
+require "pathname"
+require "rake"
+require "rake/tasklib"
+
+module RbsDraper
+  class RakeTask < Rake::TaskLib
+    attr_accessor :name, :signature_root_dir
+
+    def initialize(name = :'rbs:draper', &block)
+      super()
+
+      @name = name
+      @signature_root_dir = Pathname(Rails.root / "sig/draper")
+
+      block&.call(self)
+
+      define_clean_task
+      define_base_class_generate_task
+      define_decoratables_generate_task
+      define_decorators_generate_task
+      define_setup_task
+    end
+
+    def define_setup_task
+      desc "Run all tasks of rbs_draper"
+
+      deps = [:"#{name}:clean", :"#{name}:base_class:generate", :"#{name}:decoratables:generate",
+              :"#{name}:decorators:generate"]
+      task("#{name}:setup": deps)
+    end
+
+    def define_clean_task
+      desc "Clean up generated RBS files"
+      task("#{name}:clean": :environment) do
+        sh "rm", "-rf", signature_root_dir.to_s
+      end
+    end
+
+    def define_base_class_generate_task
+      desc "Generate RBS files for base classes"
+      task("#{name}:base_class:generate": :environment) do
+        signature_root_dir.mkpath
+
+        basedir = Pathname(__FILE__).dirname
+        FileUtils.cp basedir / "sig/decoratable.rbs", signature_root_dir
+        FileUtils.cp basedir / "sig/decorator.rbs", signature_root_dir
+      end
+    end
+
+    def define_decoratables_generate_task
+      desc "Generate RBS files for decoratable models"
+      task("#{name}:decoratables:generate": :environment) do
+        Rails.application.eager_load!
+
+        RbsDraper::Decoratable.all.each do |klass|
+          path = signature_root_dir / "app/models/#{klass.name.underscore}.rbs"
+          path.dirname.mkpath
+          rbs = RbsDraper::Decoratable.class_to_rbs(klass)
+          path.write rbs if rbs
+        end
+      end
+    end
+
+    def define_decorators_generate_task
+      desc "Generate RBS files for decorators"
+      task("#{name}:decorators:generate": :environment) do
+        Rails.application.eager_load!
+
+        Draper::Decorator.descendants.each do |klass|
+          path = signature_root_dir / "app/decorators/#{klass.name.underscore}.rbs"
+          path.dirname.mkpath
+          rbs = RbsDraper::Decorator.class_to_rbs(klass, rbs_builder)
+          path.write rbs if rbs
+        end
+      end
+    end
+
+    private
+
+    def rbs_builder
+      return @rbs_builder if @rbs_builder
+
+      loader = RBS::CLI::LibraryOptions.new.loader
+      loader.add path: Pathname("sig")
+      @rbs_builder = RBS::DefinitionBuilder.new env: RBS::Environment.from_loader(loader).resolve_type_names
+    end
+  end
+end

data/lib/rbs_draper/sig/decoratable.rbs

@@ -0,0 +1,6 @@
+module Draper
+  module Decoratable
+    def decorated?: () -> bool
+    def decorated_with?: (untyped decorator_class) -> bool
+  end
+end

data/lib/rbs_draper/sig/decorator.rbs

@@ -0,0 +1,6 @@
+module Draper
+  class Decorator
+    def decorated?: () -> bool
+    def decorated_with?: (untyped decorator_class) -> bool
+  end
+end

data/lib/rbs_draper/version.rb

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

data/lib/rbs_draper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "rbs_draper/decoratable"
+require_relative "rbs_draper/decorator"
+require_relative "rbs_draper/rake_task"
+require_relative "rbs_draper/version"
+
+module RbsDraper
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/rbs_collection.lock.yaml

@@ -0,0 +1,202 @@
+---
+sources:
+- type: git
+  name: ruby/gem_rbs_collection
+  revision: 280d44d7671abfa909f2966fbef94bca5be082de
+  remote: https://github.com/ruby/gem_rbs_collection.git
+  repo_dir: gems
+path: ".gem_rbs_collection"
+gems:
+- name: abbrev
+  version: '0'
+  source:
+    type: stdlib
+- name: actionpack
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 280d44d7671abfa909f2966fbef94bca5be082de
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: actionview
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 280d44d7671abfa909f2966fbef94bca5be082de
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activemodel
+  version: '7.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 280d44d7671abfa909f2966fbef94bca5be082de
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activerecord
+  version: '7.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 280d44d7671abfa909f2966fbef94bca5be082de
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activesupport
+  version: '7.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 280d44d7671abfa909f2966fbef94bca5be082de
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: ast
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 280d44d7671abfa909f2966fbef94bca5be082de
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: cgi
+  version: '0'
+  source:
+    type: stdlib
+- name: concurrent-ruby
+  version: '1.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 280d44d7671abfa909f2966fbef94bca5be082de
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: date
+  version: '0'
+  source:
+    type: stdlib
+- name: i18n
+  version: '1.10'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 280d44d7671abfa909f2966fbef94bca5be082de
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: json
+  version: '0'
+  source:
+    type: stdlib
+- name: logger
+  version: '0'
+  source:
+    type: stdlib
+- name: minitest
+  version: '0'
+  source:
+    type: stdlib
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: mutex_m
+  version: '0'
+  source:
+    type: stdlib
+- name: nokogiri
+  version: '1.11'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 280d44d7671abfa909f2966fbef94bca5be082de
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: optparse
+  version: '0'
+  source:
+    type: stdlib
+- name: parallel
+  version: '1.20'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 280d44d7671abfa909f2966fbef94bca5be082de
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: pathname
+  version: '0'
+  source:
+    type: stdlib
+- name: rack
+  version: '2.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 280d44d7671abfa909f2966fbef94bca5be082de
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rails-dom-testing
+  version: '2.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 280d44d7671abfa909f2966fbef94bca5be082de
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: railties
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 280d44d7671abfa909f2966fbef94bca5be082de
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rainbow
+  version: '3.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 280d44d7671abfa909f2966fbef94bca5be082de
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rbs
+  version: 3.1.0
+  source:
+    type: rubygems
+- name: rbs_rails
+  version: 0.12.0
+  source:
+    type: rubygems
+- name: rdoc
+  version: '0'
+  source:
+    type: stdlib
+- name: request_store
+  version: '1.5'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 280d44d7671abfa909f2966fbef94bca5be082de
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: singleton
+  version: '0'
+  source:
+    type: stdlib
+- name: tempfile
+  version: '0'
+  source:
+    type: stdlib
+- name: time
+  version: '0'
+  source:
+    type: stdlib
+- name: tsort
+  version: '0'
+  source:
+    type: stdlib
+- name: uri
+  version: '0'
+  source:
+    type: stdlib
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,20 @@
+# Download sources
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# You can specify local directories as sources also.
+# - type: local
+#   path: path/to/your/local/repository
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+gems:
+  # Skip loading rbs gem's RBS.
+  # It's unnecessary if you don't use rbs as a library.
+  - name: steep
+    ignore: true

data/rbs_draper.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/rbs_draper/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rbs_draper"
+  spec.version = RbsDraper::VERSION
+  spec.authors = ["Takeshi KOMIYA"]
+  spec.email = ["i.tkomiya@gmail.com"]
+
+  spec.summary = "A RBS files generator for Draper decorators"
+  spec.description = "A RBS files generator for Draper decorators"
+  spec.homepage = "https://github.com/tk0miya/rbs_draper"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  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 "draper"
+  spec.add_dependency "rbs_rails"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/rbs_draper/decoratable.rbs

@@ -0,0 +1,21 @@
+module RbsDraper
+  module Decoratable
+    def self.all: () -> Array[Class]
+    def self.class_to_rbs: (Class klass) -> String
+
+    class Generator
+      attr_reader klass: Class
+
+      def initialize: (Class klass) -> void
+      def generate: () -> String
+
+      private
+
+      def klass_decl: () -> String
+      def header: () -> String
+      def method_decls: () -> String
+      def footer: () -> String
+      def module_names: () -> Array[String]
+    end
+  end
+end

data/sig/rbs_draper/decorator.rbs

@@ -0,0 +1,27 @@
+module RbsDraper
+  module Decorator
+    def self.class_to_rbs: (Class klass, RBS::DefinitionBuilder rbs_builder) -> String?
+
+    class Generator
+      attr_reader klass: Class
+      attr_reader rbs_builder: RBS::DefinitionBuilder
+
+      @decorated_class: RBS::Definition
+      @user_defined_class: RBS::Definition
+
+      def initialize: (Class klass, RBS::DefinitionBuilder rbs_builder) -> void
+      def generate: () -> String?
+
+      private
+
+      def klass_decl: () -> String
+      def header: () -> String
+      def method_decls: () -> String?
+      def footer: () -> String
+      def module_names: () -> Array[String]
+      def decorated_class: () -> RBS::Definition?
+      def delegated_methods: () -> Array[[Symbol, RBS::Definition]]
+      def user_defined_class: () -> RBS::Definition?
+    end
+  end
+end

data/sig/rbs_draper/rake_task.rbs

@@ -0,0 +1,21 @@
+module RbsDraper
+  class RakeTask < Rake::TaskLib
+    attr_accessor name: Symbol
+    attr_accessor signature_root_dir: Pathname
+
+    @name: Symbol
+    @rbs_builder: RBS::DefinitionBuilder
+    @signature_root_dir: Pathname
+
+    def initialize: (?Symbol name) ?{ (RakeTask) -> void } -> void
+    def define_setup_task: () -> void
+    def define_clean_task: () -> void
+    def define_base_class_generate_task: () -> void
+    def define_decoratables_generate_task: () -> void
+    def define_decorators_generate_task: () -> void
+
+    private
+
+    def rbs_builder: () -> RBS::DefinitionBuilder
+  end
+end

data/sig/rbs_draper.rbs

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

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: rbs_draper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takeshi KOMIYA
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: draper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rbs_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A RBS files generator for Draper decorators
+email:
+- i.tkomiya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".vscode/extensions.json"
+- ".vscode/settings.json"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- lib/generators/rbs_draper/install_generator.rb
+- lib/rbs_draper.rb
+- lib/rbs_draper/decoratable.rb
+- lib/rbs_draper/decorator.rb
+- lib/rbs_draper/rake_task.rb
+- lib/rbs_draper/sig/decoratable.rbs
+- lib/rbs_draper/sig/decorator.rbs
+- lib/rbs_draper/version.rb
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
+- rbs_draper.gemspec
+- sig/rbs_draper.rbs
+- sig/rbs_draper/decoratable.rbs
+- sig/rbs_draper/decorator.rbs
+- sig/rbs_draper/rake_task.rbs
+homepage: https://github.com/tk0miya/rbs_draper
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tk0miya/rbs_draper
+  source_code_uri: https://github.com/tk0miya/rbs_draper
+  changelog_uri: https://github.com/tk0miya/rbs_draper
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: A RBS files generator for Draper decorators
+test_files: []