ko 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c91c7af67e4e084ab9aad470c3966eddc060673429347dc198109ffb8588ef7
-  data.tar.gz: ff19bb13dd6ed12ba5078a27bcc368196d268a690932b739ff40416314f0a071
+  metadata.gz: 3e23069fa6e3d507cacf8baae87633f6537cb5254a9cd465b8e372519c0e0704
+  data.tar.gz: e33170f4510c249229a33d33c9fdca7a2d54375240976618d9e0aa026c28a318
 SHA512:
-  metadata.gz: f0e0c5d3fc829b3ae10933ec3277cacb76ec816281133520617670fb8212625e12fd2fea8f6c977130b4495e14c18db129a74d119a7c60c1504e09a8d590ebbd
-  data.tar.gz: bfe311b18cfdebe924d1024558e3b1e157382f6a2a04a5f70761f920816a841cfd6c05627227d6216d9cf57b13c4b226af564063bd932983ee1ffe1249ba2778
+  metadata.gz: 8b6c6b37d7ec073ff85c9b444e3e764b547dea1b1959db64b05a2603d70b9b50a44742879bc5e5a6b938a76520cfa6879faf0b291e1c985245abdc632c1e62ec
+  data.tar.gz: be5a5b7165da862a6f9482961185ee83845a335a69d0e648b367050c69ffe1abb7492e1124a6b99eaa5548f38fcf8463aab8f1bae7a23045fc0f5c38c4c9ad99

data/.overcommit.yml

@@ -0,0 +1,4 @@
+PreCommit:
+  RuboCop:
+    enabled: true
+    on_warn: fail # Treat all warnings as failures

data/.rspec

@@ -1,3 +1,3 @@
---format documentation
+--format progress
 --color
 --require spec_helper

data/.rubocop.yml

@@ -1,5 +1,27 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.2
+  NewCops: enable
+  SuggestExtensions: false
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - spec/**/*_spec.rb
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+    - "*.gemspec"
+
+Metrics/MethodLength:
+  Max: 10
+
+RSpec/NamedSubject:
+  Enabled: false
 
 Style/StringLiterals:
   Enabled: true
@@ -9,5 +31,20 @@ Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
 
-Layout/LineLength:
-  Max: 120
+Style/Documentation:
+  Enabled: false
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
+Style/NumberedParametersLimit:
+  Max: 2
+
+RSpec/EmptyExampleGroup:
+  AutoCorrect: false
+
+RSpec/NestedGroups:
+  Max: 5

data/.tool-versions

@@ -0,0 +1,2 @@
+ruby 3.2.1
+

data/Gemfile

@@ -5,8 +5,15 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in ko.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+group :development, :test do
+  gem "overcommit", require: false
+  gem "rake", require: false
+  gem "rspec", require: false
+  gem "rubocop", require: false
+  gem "rubocop-performance", require: false
+  gem "rubocop-rspec", require: false
+  gem "simplecov", require: false
+  gem "solargraph", require: false
 
-gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.21"
+  gem "async-rspec"
+end

data/Gemfile.lock

@@ -0,0 +1,141 @@
+PATH
+  remote: .
+  specs:
+    ko (0.1.2)
+      async (~> 2.5.0)
+      binding_of_caller (~> 1.0.0)
+      zeitwerk (~> 2.6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    async (2.5.0)
+      console (~> 1.10)
+      io-event (~> 1.1)
+      timers (~> 4.1)
+    async-rspec (1.16.1)
+      rspec (~> 3.0)
+      rspec-files (~> 1.0)
+      rspec-memory (~> 1.0)
+    backport (1.2.0)
+    benchmark (0.2.1)
+    binding_of_caller (1.0.0)
+      debug_inspector (>= 0.0.1)
+    childprocess (4.1.0)
+    console (1.16.2)
+      fiber-local
+    debug_inspector (1.1.0)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    e2mmap (0.1.0)
+    fiber-local (1.0.0)
+    iniparse (1.5.0)
+    io-event (1.1.7)
+    jaro_winkler (1.5.4)
+    json (2.6.3)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    nokogiri (1.14.2-x86_64-linux)
+      racc (~> 1.4)
+    overcommit (0.60.0)
+      childprocess (>= 0.6.3, < 5)
+      iniparse (~> 1.4)
+      rexml (~> 3.2)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    racc (1.6.2)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    reverse_markdown (2.1.1)
+      nokogiri
+    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.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-files (1.1.3)
+      rspec (~> 3.0)
+    rspec-memory (1.0.3)
+      rspec (~> 3.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.46.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.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.26.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.17.1)
+      rubocop (~> 1.41)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.19.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.11.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    solargraph (0.48.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.2.1)
+    tilt (2.1.0)
+    timers (4.3.5)
+    unicode-display_width (2.4.2)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+    zeitwerk (2.6.7)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  async-rspec
+  ko!
+  overcommit
+  rake
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+  simplecov
+  solargraph
+
+BUNDLED WITH
+   2.4.6

data/README.md

@@ -1,4 +1,4 @@
-# Ko
+# KO
 
 TODO: Delete this and the text below, and describe your gem
 
@@ -36,4 +36,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Ko project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ko/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the KO project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ko/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -9,4 +9,4 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+task default: [:spec, :rubocop]

data/exe/ko

@@ -1,3 +1,31 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "ko"
+
+class MyApplication < KO::Application
+end
+
+class MyObject < KO::Object
+  signal :something
+
+  # def on_ready do
+  #   pp("Ready #{id}")
+  # end
+end
+
+MyApplication[] do
+  x = MyObject["first"] do
+    signal :blah
+
+    MyObject["second"]
+
+    on_ready do
+      pp("Ready #{id}")
+    end
+  end
+  t = MyObject["third"]
+  t.parent = x
+end
+
+pp MyApplication.instance

data/lib/ko/application.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module KO
+  class Application < Object
+    # rubocop:disable Style/GlobalVars
+    class << self
+      def instance = $_KO_APP
+    end
+
+    def initialize(id: nil)
+      begin
+        super(id: id || "app")
+      rescue InvalidParent
+        @parent = nil
+      end
+      raise AlreadyIitialized if $_KO_APP
+
+      $_KO_APP = self
+    end
+    # rubocop:enable Style/GlobalVars
+
+    def parent=(_obj)
+      raise KO::InvalidParent, "KO::Application cannot have a parent"
+    end
+  end
+end

data/lib/ko/children.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module KO
+  class Children
+    include Enumerable
+
+    def initialize
+      @store = Set.new
+    end
+
+    # TODO: use index
+    def [](id) = @store.find { _1.id == id }
+
+    def add(obj) = @store << obj
+
+    def remove(obj)
+      raise UnknownChildError unless @store.include?(obj)
+
+      @store.delete(obj)
+    end
+
+    def inspect = to_a.inspect
+    def pretty_inspect = to_a.pretty_inspect
+
+    def each(...) = @store.each(...)
+    def count(...) = @store.count(...)
+  end
+end

data/lib/ko/object.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module KO
+  class Object
+    extend Signals
+
+    class << self
+      def [](id = nil, &)
+        new(id:).tap do |obj|
+          obj.instance_exec(&) if block_given?
+          obj.ready.emit
+        end
+      end
+    end
+
+    attr_reader :id, :parent
+
+    signal :ready
+
+    def initialize(id: nil)
+      @id = id
+      self.parent = find_parent
+    end
+
+    def children = @children ||= Children.new
+
+    def parent=(obj)
+      raise KO::InvalidParent unless can_be_parent?(obj)
+
+      parent&.remove_child(self)
+      @parent = obj
+      parent.add_child(self)
+    end
+
+    def add_child(obj)
+      obj.parent = self if obj.parent != self
+
+      children.add(obj)
+    end
+
+    def remove_child(obj) = children.remove(obj)
+
+    def [](id) = children[id]
+
+    def app
+      @app ||= begin
+        obj = self
+        obj = obj.parent until obj.parent.nil?
+        obj
+      end
+    end
+
+    def inspect
+      id_str = id.nil? ? "" : "[#{id.inspect}]"
+      "#<#{self.class}#{id_str} signals=#{signals.count} properties=0 children=#{children.count}>"
+    end
+
+    private
+
+    def find_parent
+      binding.callers[2..].each do |caller|
+        obj = caller.receiver
+        return obj if can_be_parent?(obj)
+      end
+      raise KO::InvalidParent
+    end
+
+    def can_be_parent?(obj)
+      obj.is_a?(KO::Object) && obj != self
+    end
+  end
+end

data/lib/ko/signals/connection.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module KO
+  module Signals
+    class Connection
+      attr_reader :callable, :mode, :signal
+
+      def initialize(callable, signal, mode:, one_shot:)
+        Validator.new(signal).validate_callable_type!(callable)
+
+        @callable = callable
+        @signal = signal
+        @mode = mode
+        @one_shot = one_shot
+      end
+
+      def one_shot? = @one_shot
+
+      def call(*args, force_direct: false) # rubocop:disable Lint/UnusedMethodArgument
+        return @callable.call(*args) if @callable.is_a?(Method) || @callable.is_a?(Signal)
+
+        @callable.send(signal.receiver_name, *args)
+      rescue StandardError => e
+        warn(e)
+      end
+
+      def disconnect
+        @signal.disconnect(@callable)
+      end
+    end
+  end
+end

data/lib/ko/signals/signal.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module KO
+  module Signals
+    class Signal
+      attr_reader :name, :arg_types, :connections
+
+      def initialize(name, arg_types)
+        @name = name
+        @arg_types = arg_types
+
+        @validator = Validator.new(self)
+        @connections = {}
+      end
+
+      def dup = super().tap { _1.connections.clear }
+
+      def receiver_name = "on_#{name}".to_sym
+
+      # Only 3 ways to connect:
+      # some_object.some_signal.connect(receiver) -> receiver#on_some_signal
+      # some_object.some_signal.connect(receiver.method(:do_something)) -> receiver#do_something
+      # some_object.some_signal.connect(receiver.another_signal) ->  emits receiver#another_signal
+      # Blocks, Procs and Lambda are not supported on purpose
+      def connect(callable = nil, mode: :direct, one_shot: false)
+        @validator.validate_callable!(callable)
+
+        Connection.new(callable, self, mode:, one_shot:).tap { @connections[callable] = _1 }
+      end
+
+      def disconnect(callable)
+        raise ArgumentError, "given callable is not connected to this signal" if @connections.delete(callable).nil?
+      end
+
+      def emit(*args)
+        @validator.validate_args!(args)
+        notify_subscribers(args)
+      end
+
+      def inspect = "#<#{self.class}[#{name.inspect}] connections=#{@connections.count}>"
+
+      def call(...) = emit(...)
+
+      def notify_subscribers(args)
+        @connections.values.shuffle.each do |connection|
+          connection.call(*args)
+        ensure
+          connection.disconnect if connection.one_shot?
+        end
+      end
+    end
+  end
+end

data/lib/ko/signals/validator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module KO
+  module Signals
+    class Validator
+      def initialize(signal)
+        @signal = signal
+      end
+
+      def validate_args!(args)
+        types = args.map(&:class)
+
+        return if types.count == @signal.arg_types.count && types_match?(types)
+
+        raise KO::EmitError, "expected args: #{@signal.arg_types}. given: #{types}"
+      end
+
+      def validate_callable!(callable)
+        callable = validate_callable_type!(callable)
+        validate_signal_arity!(callable) if callable.is_a?(Signal)
+      end
+
+      def validate_callable_type!(callable)
+        return callable if callable.is_a?(Signal) || callable.is_a?(Method)
+
+        return callable.method(@signal.receiver_name) if callable.respond_to?(@signal.receiver_name)
+
+        raise ArgumentError, "callable must be a Signal, a Method, or must respond to #{@signal.receiver_name}"
+      end
+
+      private
+
+      def types_match?(types) = types.each.with_index.all? { _1.ancestors.include?(@signal.arg_types[_2]) }
+
+      def validate_signal_arity!(signal)
+        return if signal.arg_types == @signal.arg_types
+
+        raise ArgumentError,
+              "target signal must have same type signature. Expected: #{@signal.arg_types}. given: #{signal.arg_types}"
+      end
+    end
+  end
+end

data/lib/ko/signals.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module KO
+  module Signals
+    module InstanceMethods
+      # TODO: write me!
+      def respond_to_missing?(name, include_private = false); end
+
+      def method_missing(name, *args, **params, &)
+        sigs = signals.each.with_object({}) { |(_k, v), acc| acc[v.receiver_name] = v }
+        super unless sigs.include?(name)
+
+        define_singleton_method(name, &)
+
+        sigs[name].connect(self)
+      end
+
+      private
+
+      def signals = @signals ||= self.class.signals.transform_values(&:dup)
+
+      def emit(name, *args) = send(name).call(*args)
+    end
+
+    module AddSignal
+      def signal(name, *arg_types)
+        signals[name.to_sym] = Signal.new(name, arg_types)
+
+        d = respond_to?(:define_method) ? :define_method : :define_singleton_method
+        send(d, name) { signals[name.to_sym] }
+      end
+    end
+
+    class << self
+      def extended(base)
+        base.include(InstanceMethods)
+        base.extend(AddSignal)
+        base.include(AddSignal)
+      end
+    end
+
+    # def method_added(name)
+    #   pp([self, name])
+    # end
+
+    def inherited(child)
+      super(child)
+      child.signals.merge!(signals)
+    end
+
+    def signals = @signals ||= {}
+  end
+end

data/lib/ko/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module Ko
-  VERSION = "0.1.0"
+module KO
+  VERSION = "0.1.2"
 end

data/lib/ko.rb

@@ -2,7 +2,31 @@
 
 require_relative "ko/version"
 
-module Ko
+require "zeitwerk"
+
+require "binding_of_caller"
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect(
+  "ko" => "KO"
+)
+loader.setup
+
+module KO
   class Error < StandardError; end
-  # Your code goes here...
+
+  class InvalidParent < Error
+    def initialize(msg = "only KO::Object can be a parent for KO::Object")
+      super(msg)
+    end
+  end
+
+  class AlreadyIitialized < Error
+    def initialize
+      super("KO is already initialized: only one instance of KO::Application must exist")
+    end
+  end
+
+  class UnknownChildError < Error; end
+  class EmitError < Error; end
 end

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: ko
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Gleb Sinyavskiy
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-08 00:00:00.000000000 Z
-dependencies: []
+date: 2023-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
 description: KO
 email:
 - zhulik.gleb@gmail.com
@@ -18,23 +60,33 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".overcommit.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".tool-versions"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - exe/ko
 - lib/ko.rb
+- lib/ko/application.rb
+- lib/ko/children.rb
+- lib/ko/object.rb
+- lib/ko/signals.rb
+- lib/ko/signals/connection.rb
+- lib/ko/signals/signal.rb
+- lib/ko/signals/validator.rb
 - lib/ko/version.rb
-- sig/ko.rbs
 homepage: https://github.com/zhulik/ko
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/zhulik/ko
-post_install_message:
+  rubygems_mfa_required: 'true'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -42,15 +94,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
-signing_key:
+rubygems_version: 3.4.10
+signing_key: 
 specification_version: 4
 summary: KO
 test_files: []

data/sig/ko.rbs

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