surrounded 1.1.0 → 1.1.1

data/test/surrounded_context_test.rb

@@ -1,113 +1,113 @@
-require 'test_helper'
+require "test_helper"
 
-describe Surrounded::Context, '#triggers' do
-  let(:user){ User.new("Jim") }
-  let(:other_user){ User.new("Guille") }
-  let(:context){ TestContext.new(user: user, other_user: other_user) }
+describe Surrounded::Context, "#triggers" do
+  let(:user) { User.new("Jim") }
+  let(:other_user) { User.new("Guille") }
+  let(:context) { TestContext.new(user: user, other_user: other_user) }
 
-  it 'lists the externally accessible trigger methods' do
+  it "lists the externally accessible trigger methods" do
     assert context.triggers.include?(:access_other_object)
   end
 
-  it 'prevents altering the list of triggers externally' do
+  it "prevents altering the list of triggers externally" do
     original_trigger_list = context.triggers
-    context.triggers << 'another_trigger'
+    context.triggers << "another_trigger"
     assert_equal original_trigger_list, context.triggers
   end
 end
 
-describe Surrounded::Context, '.triggers' do
-  it 'lists the externally accessible trigger methods' do
+describe Surrounded::Context, ".triggers" do
+  it "lists the externally accessible trigger methods" do
     assert TestContext.triggers.include?(:access_other_object)
   end
 
-  it 'prevents altering the list of triggers externally' do
+  it "prevents altering the list of triggers externally" do
     original_trigger_list = TestContext.triggers
-    TestContext.triggers << 'another_trigger'
+    TestContext.triggers << "another_trigger"
     assert_equal original_trigger_list, TestContext.triggers
   end
 end
 
-describe Surrounded::Context, '.trigger' do
-  let(:user){ User.new("Jim") }
-  let(:other_user){ User.new("Guille") }
-  let(:context){ TestContext.new(user: user, other_user: other_user) }
+describe Surrounded::Context, ".trigger" do
+  let(:user) { User.new("Jim") }
+  let(:other_user) { User.new("Guille") }
+  let(:context) { TestContext.new(user: user, other_user: other_user) }
 
-  it 'defines a public method on the context' do
+  it "defines a public method on the context" do
     assert context.respond_to?(:access_other_object)
   end
 
-  it 'gives objects access to each other inside the method' do
-    assert_raises(NoMethodError){
+  it "gives objects access to each other inside the method" do
+    assert_raises(NoMethodError) {
       user.other_user
     }
     assert_equal "Guille", context.access_other_object
   end
 
-  it 'preserves arguments and blocks' do
-    result = context.block_method('argument') do |*args, obj|
+  it "preserves arguments and blocks" do
+    result = context.block_method("argument") do |*args, obj|
       "Having an #{args.first} with #{obj.class}"
     end
     assert_equal "Having an argument with TestContext", result
   end
 
-  it 'allows usage of regular methods for triggers' do
+  it "allows usage of regular methods for triggers" do
     assert context.regular_method_trigger
   end
 
-  it 'ignores nil trigger names' do
+  it "ignores nil trigger names" do
     assert context.class.send(:trigger)
   end
 end
 
-describe Surrounded::Context, '#role?' do
-  let(:user){
+describe Surrounded::Context, "#role?" do
+  let(:user) {
     test_user = User.new("Jim")
 
     def test_user.get_role(name, context)
-      context.role?(name){}
+      context.role?(name) {}
     end
 
     test_user
   }
-  let(:other_user){ User.new("Guille") }
-  let(:external){
+  let(:other_user) { User.new("Guille") }
+  let(:external) {
     external_object = Object.new
     def external_object.get_role_from_context(name, context)
-      context.role?(name){}
+      context.role?(name) {}
     end
     external_object
   }
-  let(:context){ TestContext.new(user: user, other_user: other_user) }
+  let(:context) { TestContext.new(user: user, other_user: other_user) }
 
-  it 'returns the object assigned to the named role' do
+  it "returns the object assigned to the named role" do
     assert_equal user, user.get_role(:user, context)
   end
 
-  it 'returns false if the role does not exist' do
+  it "returns false if the role does not exist" do
     refute user.get_role(:non_existant_role, context)
   end
 
-  it 'returns false if the accessing object is not a role player in the context' do
+  it "returns false if the accessing object is not a role player in the context" do
     refute external.get_role_from_context(:user, context)
   end
 
-  it 'checks for the role based upon the calling object' do
-    refute context.role?(:user){} # this test is the caller
+  it "checks for the role based upon the calling object" do
+    refute context.role?(:user) {} # this test is the caller
   end
 end
 
-describe Surrounded::Context, '#role_player?' do
-  let(:player){ User.new("Jim") }
-  let(:other_player){ User.new("Amy") }
-  let(:non_player){ User.new("Guille") }
-  let(:context){ TestContext.new(user: player, other_user: other_player) }
+describe Surrounded::Context, "#role_player?" do
+  let(:player) { User.new("Jim") }
+  let(:other_player) { User.new("Amy") }
+  let(:non_player) { User.new("Guille") }
+  let(:context) { TestContext.new(user: player, other_user: other_player) }
 
-  it 'is true if the given object is a role player' do
+  it "is true if the given object is a role player" do
     expect(context.role_player?(player)).must_equal true
   end
 
-  it 'is false if the given oject is not a role player' do
+  it "is false if the given oject is not a role player" do
     expect(context.role_player?(non_player)).must_equal false
   end
 end
@@ -133,25 +133,30 @@ class RoleAssignmentContext
   trigger :check_other_user_response do
     user.respond_to?(:a_method!)
   end
-  
+
   trigger :user_ancestors, :other_user_ancestors
 
   module User
-    def a_method!; end
+    def a_method!
+    end
   end
+
   module OtherUser
-    def a_method!; end
+    def a_method!
+    end
   end
 end
 
 class Special; end
+
 class IgnoreExternalConstantsContext
   extend Surrounded::Context
 
   initialize :user, :special, :other
 
   role :other do
-    def something_or_other; end
+    def something_or_other
+    end
   end
 
   trigger :check_special do
@@ -170,44 +175,48 @@ class ClassRoleAssignmentContext
 
   class Thing
     include Surrounded
-    def initialize(obj); end
-    def method_from_class; end
-  end
 
+    def initialize(obj)
+      @obj = obj
+    end
+
+    def method_from_class
+    end
+  end
 end
 
-describe Surrounded::Context, 'assigning roles' do
+describe Surrounded::Context, "assigning roles" do
   include Surrounded # the test must be context-aware
 
-  let(:user){ User.new("Jim") }
-  let(:other_user){ CastingUser.new("Guille") }
-  let(:context){ RoleAssignmentContext.new(user: user, other_user: other_user) }
+  let(:user) { User.new("Jim") }
+  let(:other_user) { CastingUser.new("Guille") }
+  let(:context) { RoleAssignmentContext.new(user: user, other_user: other_user) }
 
-  it 'tries to use casting to add roles' do
+  it "tries to use casting to add roles" do
     refute_includes(context.other_user_ancestors, RoleAssignmentContext::OtherUser)
   end
 
-  it 'extends objects with role modules failing casting' do
+  it "extends objects with role modules failing casting" do
     assert_includes(context.user_ancestors, RoleAssignmentContext::User)
   end
 
-  it 'sets role players to respond to role methods' do
+  it "sets role players to respond to role methods" do
     assert context.check_user_response
     assert context.check_other_user_response
   end
 
-  it 'will use classes as roles' do
-    user = User.new('Jim')
+  it "will use classes as roles" do
+    user = User.new("Jim")
 
     context = ClassRoleAssignmentContext.new(thing: user, the_test: self)
 
     assert context.check_user_response
   end
 
-  it 'does not use constants defined outside the context class' do
-    special = User.new('Special')
-    other = User.new('Other')
+  it "does not use constants defined outside the context class" do
+    special = User.new("Special")
+    other = User.new("Other")
     context = IgnoreExternalConstantsContext.new(user: user, special: special, other: other)
     assert_equal User, context.check_special
   end
-end
+end

data/test/surrounded_test.rb

@@ -1,21 +1,19 @@
-require 'test_helper'
+require "test_helper"
 
-describe "Surrounded", 'without context' do
-
-  let(:jim){ User.new("Jim") }
+describe "Surrounded", "without context" do
+  let(:jim) { User.new("Jim") }
 
   it "never has context roles" do
-    assert_nil jim.send(:context).role?('anything')
+    assert_nil jim.send(:context).role?("anything")
   end
-
 end
 
 describe "Surrounded" do
-  let(:jim){ User.new("Jim") }
-  let(:guille){ User.new("Guille") }
-  let(:external_user){ User.new("External User") }
+  let(:jim) { User.new("Jim") }
+  let(:guille) { User.new("Guille") }
+  let(:external_user) { User.new("External User") }
 
-  let(:context){
+  let(:context) {
     TestContext.new(user: jim, other_user: guille)
   }
 
@@ -24,7 +22,7 @@ describe "Surrounded" do
   end
 
   it "prevents access to context objects for external objects" do
-    assert_raises(NoMethodError){
+    assert_raises(NoMethodError) {
       external_user.user
     }
   end
@@ -37,14 +35,14 @@ end
 describe "Surrounded", "added to an existing object" do
   it "allows the object to store its context" do
     thing = UnsurroundedObject.new
-    thing.name = 'Jim'
+    thing.name = "Jim"
 
-    assert_raises(NoMethodError){
+    assert_raises(NoMethodError) {
       thing.__send__(:store_context)
     }
     thing.extend(Surrounded)
 
-    other = User.new('Guille')
+    other = User.new("Guille")
 
     context = TestContext.new(user: thing, other_user: other)
     assert context.access_other_object
@@ -57,7 +55,7 @@ end
 
 describe "Surrounded", "added to an object through another module" do
   it "allows the object to store its context" do
-    object = Array.new
+    object = []
     object.extend(SpecialSurrounding)
     assert object.respond_to?(:context, true)
   end

data/test/test_helper.rb

@@ -1,14 +1,15 @@
-require 'simplecov'
-require 'minitest/autorun'
+require "simplecov"
+require "minitest/autorun"
 SimpleCov.enable_coverage :branch
 SimpleCov.add_filter %r{version.rb}
 SimpleCov.start unless defined?(Coverage)
 
-require 'surrounded'
-require 'surrounded/context'
+require "surrounded"
+require "surrounded/context"
 
 class User
   include Surrounded
+
   def initialize(name)
     @name = name
   end

data/test/threaded_context_test.rb

@@ -0,0 +1,70 @@
+require "test_helper"
+require "async"
+
+class AsyncThreadedContext
+  extend Surrounded::Context
+
+  def initialize(leader:, members:)
+    role_names = [:leader, :members]
+    role_players = [leader, members]
+
+    role_names.concat(members.map { |member| :"member_#{member.object_id}" })
+    role_players.concat(members)
+
+    map_roles(role_names.zip(role_players))
+  end
+  private_attr_reader :leader, :members
+
+  trigger :meet do
+    result = []
+    result << leader.greet
+    result << members.concurrent_map do |member|
+      result << member.greet
+    end
+    result.flatten.join(" ")
+  end
+
+  module Leader
+    def greet
+      "Hello everyone. I am #{name}"
+    end
+  end
+
+  module Member
+    def greet
+      "Hello #{leader.name}, I am #{name}"
+    end
+  end
+
+  module Members
+    include Surrounded
+
+    def concurrent_map
+      Async do
+        map do |member|
+          yield member
+        end
+      end
+    end
+  end
+end
+
+describe AsyncThreadedContext do
+  let(:jim) { User.new("Jim") }
+  let(:amy) { User.new("Amy") }
+  let(:guille) { User.new("Guille") }
+  let(:jason) { User.new("Jason") }
+  let(:dave) { User.new("Dave") }
+
+  let(:greeter) { jim }
+  let(:members) { [amy, guille, jason, dave] }
+
+  it "works in multi-threaded environments with async" do
+    meeting = AsyncThreadedContext.new(leader: jim, members: members)
+
+    result = meeting.meet
+
+    assert_includes result, "Hello everyone. I am Jim"
+    assert_includes result, "Hello Jim, I am Amy"
+  end
+end

metadata

@@ -1,27 +1,26 @@
 --- !ruby/object:Gem::Specification
 name: surrounded
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - "'Jim Gay'"
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: triad
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.0
 - !ruby/object:Gem::Dependency
@@ -45,19 +44,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
-- ".github/workflows/codeql-analysis.yml"
-- ".github/workflows/test.yml"
-- ".gitignore"
-- ".pullreview.yml"
-- ".simplecov"
 - Changelog.md
-- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- examples/bottles.rb
-- examples/rails.rb
 - lib/surrounded.rb
 - lib/surrounded/access_control.rb
 - lib/surrounded/context.rb
@@ -74,7 +64,7 @@ files:
 - lib/surrounded/shortcuts.rb
 - lib/surrounded/version.rb
 - surrounded.gemspec
-- test/casting_role_player_test.rb
+- test/casting_test_helper.rb
 - test/collection_role_players_test.rb
 - test/context_access_test.rb
 - test/context_forwarding_test.rb
@@ -93,11 +83,11 @@ files:
 - test/surrounded_context_test.rb
 - test/surrounded_test.rb
 - test/test_helper.rb
+- test/threaded_context_test.rb
 homepage: http://github.com/saturnflyer/surrounded
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -112,27 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.23
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Create encapsulated environments for your objects.
-test_files:
-- test/casting_role_player_test.rb
-- test/collection_role_players_test.rb
-- test/context_access_test.rb
-- test/context_forwarding_test.rb
-- test/context_reuse_test.rb
-- test/context_shortcuts_test.rb
-- test/east_oriented_triggers_test.rb
-- test/example_delegate_class_test.rb
-- test/example_proxy_test.rb
-- test/example_threaded_test.rb
-- test/example_wrapper_test.rb
-- test/initialization_test.rb
-- test/name_collisions_test.rb
-- test/non_surrounded_role_player_test.rb
-- test/override_methods_test.rb
-- test/role_context_method_test.rb
-- test/surrounded_context_test.rb
-- test/surrounded_test.rb
-- test/test_helper.rb
+test_files: []

data/.codeclimate.yml

@@ -1,4 +0,0 @@
-languages:
-  Ruby: true
-exclude_paths:
-- "examples"

data/.github/workflows/codeql-analysis.yml

@@ -1,70 +0,0 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
-name: "CodeQL"
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ master ]
-  schedule:
-    - cron: '41 18 * * 4'
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'ruby' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
-        # Learn more about CodeQL language support at https://git.io/codeql-language-support
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
-
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
-
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
-
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
-
-    #- run: |
-    #   make bootstrap
-    #   make release
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2

data/.github/workflows/test.yml

@@ -1,18 +0,0 @@
-name: spec
-
-on: push
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby: [ '2.7', '3.0', '3.1' ]
-    name: Ruby ${{ matrix.ruby }} sample
-    steps:
-      - uses: actions/checkout@v2
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-      - run: bundle exec rake

data/.gitignore

@@ -1,19 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-.rvmrc
-.DS_Store
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.pullreview.yml

@@ -1,4 +0,0 @@
----
-notifications:
-  pullrequest:
-    comment: verbose

data/.simplecov

@@ -1,3 +0,0 @@
-SimpleCov.start do
-  add_filter 'test'
-end

data/Gemfile

@@ -1,9 +0,0 @@
-source 'https://rubygems.org'
-
-group :test do
-  gem 'minitest'
-  gem "simplecov"
-  gem 'casting'
-end
-
-gemspec