coactive 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: caf295bc360ec4f4551be981b1233660a33406714b2627d1d7c3118cfde42ba1
+  data.tar.gz: 55a5254e390a82bf22188fb8d84253d2382e52360abc2a36a007ef129b74572f
+SHA512:
+  metadata.gz: 477b7ff382d1697943a0898ac2d8703aaa98fde5088e1f88c6e6a05f7cdee08d4071914d5a8308103ec0dd7a553df777a5d0382bf088db44bdf0d2e5f80c9b7c
+  data.tar.gz: 6c038fdee9aed452ac716abd2d6f29149164c57e0db32777fde17bad46652f25ba1ad34c86cad1139e90c8e41911cdae46428df9572e9b80efb783afafe815a1

data/.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-18.04
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, 3.0]
+        gemfile: ['rails50', 'rails51', 'rails52', 'rails60', 'rails61']
+        exclude:
+          - ruby: 2.3
+            gemfile: rails60
+          - ruby: 2.3
+            gemfile: rails61
+          - ruby: 2.4
+            gemfile: rails60
+          - ruby: 2.4
+            gemfile: rails61
+          - ruby: 3.0
+            gemfile: rails50
+          - ruby: 3.0
+            gemfile: rails51
+          - ruby: 3.0
+            gemfile: rails52
+
+    name: ruby ${{ matrix.ruby }}, ${{ matrix.gemfile }}
+
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run test
+      run: |
+        DEBUG=1 bundle exec rspec

data/.gitignore

@@ -0,0 +1,8 @@
+.bundle/
+Gemfile.lock
+coverage/
+pkg/
+tmp/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/schema_*.rb
+spec/dummy/log/*.log

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 1.0.0
+
+* First release.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Yoshikazu Kaneta
+
+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,244 @@
+# Coactive
+
+Make classes coactive.
+
+## Dependencies
+
+* ruby 2.3+
+* activesupport 5.0+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'coactive'
+```
+
+Then execute:
+
+    $ bundle
+
+## Usage
+
+Include `Coactive::Base` to your base class:
+
+```ruby
+class Base
+  include Coactive::Base
+end
+```
+
+Define coactive classes that inherit your base class:
+
+```ruby
+class A < Base
+end
+
+class B < Base
+end
+
+class C < Base
+  coact A
+  coact B
+end
+```
+
+You can lookup coactors as follows:
+
+```ruby
+C.new.coactors
+# => [A, B]
+```
+
+### Named coactors
+
+You can also define coactive classes by using specific name:
+
+```ruby
+class A < Base
+  coaction :coactive_name
+end
+
+class B < Base
+  coaction :coactive_name
+end
+
+class C < Base
+  coact :coactive_name
+end
+
+C.new.coactors
+# => [A, B]
+```
+
+Coactors are looked up from descendants of your base class.
+Note that the coactors are unordered.
+
+In development mode of rails, it is necessary to load source files for looking up classes having specific coaction.
+You can configure source file locations by `load_paths` as the following example:
+
+```ruby
+class Base
+  include Coactive::Base
+
+  configure_coactive do |config|
+    config.load_paths = ['app/coactors']
+  end
+end
+```
+
+### Object-based coactors
+
+You can also define coactive classes by using object:
+
+```ruby
+class ModelA
+end
+
+class ModelB
+end
+
+class Base::ModelA < Base
+end
+
+class Base::ModelB < Base
+end
+
+class Base::C < Base
+  coact ModelA
+  coact ModelB
+end
+
+Base::C.new.coactors
+#=> [Base::ModelA, Base::ModelB]
+```
+
+Coactors are looked up from the namespace corresponding with caller classes.
+
+You can also looked up coactors corresponding with superclass of object.
+You can configure this feature by `lookup_superclass_for_object` and `lookup_superclass_until`:
+
+```ruby
+class Base
+  include Coactive::Base
+
+  configure_coactive do |config|
+    config.lookup_superclass_for_object = true
+    config.lookup_superclass_until = ['ActiveRecord::Base', 'ActiveModel::Base']
+  end
+end
+```
+
+### Dynamic coactors
+
+You can also dynamically lookup coactors by using block or instance method:
+
+```ruby
+class A < Base
+end
+
+class B < Base
+end
+
+class C < Base
+  # use block
+  coact do
+    if @condition == 'A'
+      A
+    else
+      B
+    end
+  end
+
+  def initialize(condition)
+    @condition = condition
+  end
+end
+
+C.new('A').coactors
+#=> [A]
+C.new('B').coactors
+#=> [B]
+
+class D < Base
+  # use method
+  coact :coactivate_with_condition
+
+  def initialize(condition)
+    @condition = condition
+  end
+
+  def coactivate_with_condition
+    if @condition == 'A'
+      A
+    else
+      B
+    end
+  end
+end
+
+D.new('A').coactors
+#=> [A]
+D.new('B').coactors
+#=> [B]
+```
+
+### Nested coactors
+
+You can define nested coactors. For example:
+
+```ruby
+class NestedA < Base
+end
+
+class NestedB < Base
+end
+
+class A < Base
+  coact NestedA
+end
+
+class B < Base
+  coact NestedB
+end
+
+class C < Base
+  coact A
+  coact B
+end
+
+C.new.coactors.map { |klass| [klass] + klass.new.coactors }.flatten
+#=> [A, NestedA, B, NestedB]
+```
+
+### Configuration
+
+You can set configurations in your base class as follows:
+
+```ruby
+class Base
+  include Coactive::Base
+
+  configure_coactive do |config|
+    # path to source files for coactors
+    config.load_paths = ['app/coactors']
+    # suffix of class that inherits base class
+    config.class_suffix = 'Coactor'
+    # cache coactors in memory
+    config.use_cache = true
+    # lookup coactors corresponding with superclass of object
+    config.lookup_superclass_for_object = true
+    # lookup coactors until superclass is not in the list
+    config.lookup_superclass_until = ['ActiveRecord::Base', 'ActiveModel::Base']
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome at https://github.com/kanety/coactive.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "coactive"
+
+# 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

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/coactive.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'coactive/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "coactive"
+  spec.version       = Coactive::VERSION
+  spec.authors       = ["Yoshikazu Kaneta"]
+  spec.email         = ["kaneta@sitebridge.co.jp"]
+  spec.summary       = %q{Make classes coactive}
+  spec.description   = %q{Make classes coactive}
+  spec.homepage      = "https://github.com/kanety/coactive"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 5.0"
+
+  spec.add_development_dependency "rails", ">= 5.0"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "simplecov"
+end

data/gemfiles/rails50.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 5.0.0"
+gem "sqlite3", "~> 1.3.6"
+
+gemspec path: "../"

data/gemfiles/rails51.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 5.1.0"
+gem "sqlite3", "~> 1.3.6"
+
+gemspec path: "../"

data/gemfiles/rails52.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 5.2.0"
+gem "sqlite3", "~> 1.3.6"
+
+gemspec path: "../"

data/gemfiles/rails60.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 6.0.0"
+
+gemspec path: "../"

data/gemfiles/rails61.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 6.1.0"
+
+gemspec path: "../"

data/lib/coactive/base.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'configure'
+require_relative 'coact'
+require_relative 'coaction'
+require_relative 'coactors'
+require_relative 'loader'
+
+module Coactive
+  module Base
+    extend ActiveSupport::Concern
+
+    included do
+      include Configure
+      include Coact
+      include Coaction
+      include Coactors
+    end
+  end
+end

data/lib/coactive/coact.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Coactive
+  module Coact
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_coactants
+      self._coactants = []
+    end
+
+    class_methods do
+      def coact(*coactants, **options, &block)
+        if block
+          self._coactants = _coactants + [block]
+        elsif options[:before]
+          index = self._coactants.index { |coactant| coactant == options[:before] }
+          self._coactants = self._coactants.insert(index, *coactants)
+        else
+          self._coactants = _coactants + coactants
+        end
+      end
+
+      def coactants
+        self._coactants
+      end
+
+      def clear_coactants
+        self._coactants = []
+      end
+    end
+  end
+end

data/lib/coactive/coaction.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Coactive
+  module Coaction
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_coactions
+      self._coactions = []
+    end
+
+    class_methods do
+      def coaction(*coactions)
+        self._coactions = _coactions + coactions
+      end
+
+      def coactions
+        self._coactions
+      end
+
+      def clear_coactions
+        self._coactions = []
+      end
+    end
+  end
+end

data/lib/coactive/coactors.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lookup'
+
+module Coactive
+  module Coactors
+    extend ActiveSupport::Concern
+
+    def coactors
+      self.class._coactants.map do |coactant|
+        if coactant.is_a?(Symbol) && respond_to?(coactant, true)
+          send(coactant)
+        elsif coactant.is_a?(Proc)
+          instance_exec(&coactant)
+        else
+          coactant
+        end
+      end.flatten.compact.map do |coactant|
+        if coactant.is_a?(Class) && coactant < self.class.coactive_config.base_class
+          coactant
+        else
+          self.class.coactors(coactant)
+        end
+      end.flatten.compact
+    end
+
+    class_methods do
+      def coactors(*coactants)
+        coactants = _coactants unless coactants
+        coactants.map { |coactant| Lookup.call(self, coactant) }.flatten
+      end
+    end
+  end
+end

data/lib/coactive/config.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Coactive
+  class Config
+    DEFAULTS = {
+      base_class: nil,
+      load_paths: ['app/coactors'],
+      class_suffix: 'Coactor',
+      use_cache: true,
+      lookup_superclass_for_object: true,
+      lookup_superclass_until: ['ActiveRecord::Base', 'ActiveModel::Base'],
+    }
+
+    def initialize
+      @data = DEFAULTS.deep_dup
+    end
+
+    DEFAULTS.keys.each do |key|
+      define_method "#{key}" do
+        @data[key]
+      end
+
+      define_method "#{key}=" do |val|
+        @data[key] = val
+      end
+    end
+  end
+end

data/lib/coactive/configure.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'config'
+
+module Coactive
+  module Configure
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :coactive_config
+      self.coactive_config = Config.new
+      self.coactive_config.base_class = self
+    end
+
+    class_methods do
+      def configure_coactive
+        yield coactive_config
+      end
+    end
+  end
+end

data/lib/coactive/loader.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Coactive
+  module Loader
+    class << self
+      def call(paths)
+        return unless defined?(Rails)
+        return if Rails.application.config.eager_load
+        return if paths.blank?
+
+        engines = [Rails] + Rails::Engine.subclasses.map(&:instance)
+        engines.each do |engine|
+          Dir["#{engine.root}/{#{Array(paths).join(',')}}/**/*.rb"].each do |file|
+            require file
+          end
+        end
+      end
+    end
+  end
+end

data/lib/coactive/lookup.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lookups/base'
+require_relative 'lookups/name'
+require_relative 'lookups/object'
+
+module Coactive
+  class Lookup
+    class << self
+      class_attribute :lookups
+      self.lookups = [Lookups::Name, Lookups::Object]
+
+      class_attribute :cache
+      self.cache = {}
+
+      def call(klass, coactivation)
+        with_cache(klass, coactivation) do
+          lookup = lookups.detect { |lookup| lookup.callable?(coactivation) }
+          lookup.new(klass, coactivation).call if lookup
+        end
+      end
+
+      private
+
+      def with_cache(klass, coactivation)
+        if klass.coactive_config.use_cache
+          self.cache[klass] ||= {}
+          self.cache[klass][coactivation] ||= yield
+        else
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/coactive/lookups/base.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Coactive
+  module Lookups
+    class Base
+      def initialize(klass, coactant)
+        @klass = klass
+        @coactant = coactant
+      end
+
+      def call
+      end
+
+      class << self
+        def callable?(coactant)
+        end
+      end
+    end
+  end
+end

data/lib/coactive/lookups/name.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Coactive
+  module Lookups
+    class Name < Base
+      def call
+        load_files
+        lookup
+      end
+
+      private
+
+      def load_files
+        Coactive::Loader.call(@klass.coactive_config.load_paths)
+      end
+
+      def lookup
+        @klass.coactive_config.base_class.descendants.select do |coactor|
+          coactor._coactions.any? { |coaction| coaction == @coactant }
+        end
+      end
+
+      class << self
+        def callable?(coactant)
+          coactant.is_a?(Symbol)
+        end
+      end
+    end
+  end
+end

data/lib/coactive/lookups/object.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Coactive
+  module Lookups
+    class Object < Base
+      def call
+        lookup(@coactant)
+      end
+
+      private
+
+      def lookup(coactant)
+        return if terminate?(coactant)
+
+        if coactant.name.present? && (coactor = resolve(coactant))
+          coactor
+        elsif @klass.coactive_config.lookup_superclass_for_object && coactant.superclass
+          lookup(coactant.superclass)
+        end
+      end
+
+      def terminate?(coactant)
+        coactant.name.to_s.in?(@klass.coactive_config.lookup_superclass_until)
+      end
+
+      def resolve(coactant)
+        name = resolve_name(coactant)
+        coactor = name.safe_constantize
+        return coactor if coactor && name == coactor.name
+      end
+
+      def resolve_name(coactant)
+        suffix = @klass.coactive_config.class_suffix
+        namespace = @klass.name.to_s.sub(/#{suffix}$/, '').to_s
+        [namespace, "#{coactant.name}#{suffix}"].join('::')
+      end
+
+      class << self
+        def callable?(coactant)
+          coactant.is_a?(Module)
+        end
+      end
+    end
+  end
+end

data/lib/coactive/version.rb

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

data/lib/coactive.rb

@@ -0,0 +1,4 @@
+require 'active_support'
+
+require 'coactive/version'
+require 'coactive/base'

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: coactive
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yoshikazu Kaneta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Make classes coactive
+email:
+- kaneta@sitebridge.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- coactive.gemspec
+- gemfiles/rails50.gemfile
+- gemfiles/rails51.gemfile
+- gemfiles/rails52.gemfile
+- gemfiles/rails60.gemfile
+- gemfiles/rails61.gemfile
+- lib/coactive.rb
+- lib/coactive/base.rb
+- lib/coactive/coact.rb
+- lib/coactive/coaction.rb
+- lib/coactive/coactors.rb
+- lib/coactive/config.rb
+- lib/coactive/configure.rb
+- lib/coactive/loader.rb
+- lib/coactive/lookup.rb
+- lib/coactive/lookups/base.rb
+- lib/coactive/lookups/name.rb
+- lib/coactive/lookups/object.rb
+- lib/coactive/version.rb
+homepage: https://github.com/kanety/coactive
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Make classes coactive
+test_files: []