foobara 0.3.0 → 0.4.2

data/projects/entities/spec/spec_helper.rb

@@ -0,0 +1,54 @@
+ENV["FOOBARA_ENV"] = "test"
+
+require "bundler/setup"
+
+if ENV["RUBY_DEBUG"] == "true"
+  require "debug"
+elsif ENV["SKIP_PRY"] != "true" && ENV["CI"] != "true"
+  require "pry"
+  require "pry-byebug" unless ENV["SKIP_BYEBUG"] == "true"
+end
+
+require "rspec/its"
+require "simplecov"
+
+SimpleCov.root "#{__dir__}/../../../"
+SimpleCov.command_name "entities"
+SimpleCov.coverage_dir "coverage/entities"
+
+SimpleCov.start do
+  add_filter "spec/support/"
+  # This avoids printing out info about coverage generated by HTTPFormatter
+  formatter Class.new { def format(_result) = nil }
+end
+
+require "foobara/project"
+require "foobara/delegate"
+require "foobara/builtin_types"
+require "foobara/entity"
+require "foobara/in_memory_crud_driver"
+require "foobara/model_attribute_helpers"
+require "foobara/nested_transactionable"
+
+Foobara.install!
+
+RSpec.configure do |config|
+  config.filter_run_when_matching :focus
+
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.order = :defined
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  # config.raise_errors_for_deprecations!
+end
+
+require "foobara/spec_helpers/all"
+Dir["#{__dir__}/support/**/*.rb"].each { |f| require f }

data/projects/entities/spec/support/rubyprof.rb

@@ -0,0 +1,32 @@
+RSpec.configure do |config|
+  # TODO: move this to foobara-spec-helpers project
+  config.around(:each, :profile) do |example|
+    require "ruby-prof"
+    RubyProf.start
+
+    example.run
+
+    result = RubyProf.stop
+    printer = RubyProf::GraphHtmlPrinter.new(result)
+    File.open("tmp/profile-out.html", "w+") do |file|
+      printer.print(file)
+    end
+  end
+
+  if ENV["RUBY_PROF"] == "true"
+    config.before(:suite) do
+      require "ruby-prof"
+      require "ruby-prof/profile"
+      RubyProf.start
+    end
+
+    config.after(:suite) do
+      result = RubyProf.stop
+
+      printer = RubyProf::GraphHtmlPrinter.new(result)
+      File.open("tmp/profile-out.html", "w+") do |file|
+        printer.print(file)
+      end
+    end
+  end
+end

data/projects/entities/spec/support/term_trap.rb

@@ -0,0 +1,6 @@
+# Convenient whenever running into an infinite loop
+Signal.trap("TERM") do
+  puts "SIGTERM received, printing backtrace:"
+  puts caller.join("\n")
+  exit
+end

data/projects/entities/spec/type_declarations/sensitive_type_removers_spec.rb

@@ -0,0 +1,90 @@
+RSpec.describe Foobara::TypeDeclarations do
+  after { Foobara.reset_alls }
+
+  describe ".remove_sensitive_types" do
+    let(:strict_type_declaration) do
+      type.declaration_data
+    end
+
+    let(:type_declaration_without_sensitive_types) do
+      described_class.remove_sensitive_types(strict_type_declaration)
+    end
+
+    context "when model/entity/detached entity" do
+      let(:type) do
+        stub_class "SomeModel", Foobara::Model do
+          attributes do
+            foo :string
+            foo2 :string, :sensitive
+          end
+        end
+
+        stub_class("InnerEntity", Foobara::Entity) do
+          attributes do
+            id :integer
+            bar :string
+            bar2 :string, :sensitive
+          end
+          primary_key :id
+        end
+
+        stub_class "InnerDetachedEntity", Foobara::DetachedEntity do
+          attributes do
+            id :integer
+            baz :string
+            baz2 :string, :sensitive
+          end
+          primary_key :id
+        end
+
+        stub_class "OuterEntity", Foobara::Entity do
+          attributes do
+            id :integer
+            foo :string
+            foo2 :string, :sensitive
+            some_inner_entity InnerEntity
+            some_detached_entity InnerDetachedEntity
+            some_model SomeModel
+          end
+          primary_key :id
+        end
+
+        OuterEntity.entity_type
+      end
+
+      it "returns a declaration without sensitive attributes all the way down" do
+        expect(
+          type_declaration_without_sensitive_types[:attributes_declaration][:element_type_declarations]
+        ).to eq(
+          id: :integer,
+          foo: :string,
+          some_inner_entity: :InnerEntity,
+          some_detached_entity: :InnerDetachedEntity,
+          some_model: :SomeModel
+        )
+      end
+
+      context "when subclass of an entity" do
+        let(:type) do
+          stub_class "SubEntity", super().target_class
+
+          SubEntity.entity_type
+        end
+
+        it "returns a declaration without sensitive attributes all the way down" do
+          expect(type.target_class).to eq(SubEntity)
+          expect(SubEntity.superclass).to eq(OuterEntity)
+          expect(
+            type_declaration_without_sensitive_types[:attributes_declaration][:element_type_declarations]
+          ).to eq(
+            id: :integer,
+            foo: :string,
+            some_inner_entity: :InnerEntity,
+            some_detached_entity: :InnerDetachedEntity,
+            some_model: :SomeModel
+          )
+        end
+      end
+    end
+  end
+end

data/projects/entities_plumbing/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec, all_after_pass: false, all_on_start: true, cmd: "bundle exec rspec", failed_mode: :focus do
+  watch(%r{^spec/(.+)_spec\.rb$})
+  watch(%r{^src/(.+)\.rb$}) { "spec/" }
+  watch(%r{^lib/(.+)\.rb$}) { "spec/" }
+  watch(%r{^spec/spec_helper.rb$}) { "spec/" }
+end

data/projects/entities_plumbing/lib/foobara/entities_plumbing.rb

@@ -0,0 +1,12 @@
+require "foobara/command_connectors"
+
+module Foobara
+  module EntitiesPlumbing
+  end
+end
+
+Foobara.project("entities_plumbing", project_path: "#{__dir__}/../..")
+
+Foobara::CommandConnector.singleton_class.prepend(
+  Foobara::EntitiesPlumbing::CommandConnectorsExtension::ClassMethods
+)

data/projects/entities_plumbing/spec/auth_mappers_spec.rb

@@ -0,0 +1,159 @@
+RSpec.describe Foobara::CommandConnector do
+  before do
+    Foobara::Persistence.default_crud_driver = Foobara::Persistence::CrudDrivers::InMemory.new
+  end
+
+  after do
+    Foobara.reset_alls
+  end
+
+  let(:command_class) do
+    stub_class(:ComputeExponent, Foobara::Command) do
+      inputs exponent: :integer, base: :integer
+      result :integer
+
+      def execute = base ** exponent
+    end
+  end
+
+  let(:command_connector) do
+    described_class.new(authenticator:, current_user: domain_user_class)
+  end
+
+  let(:auth_user_class) do
+    stub_class "AuthUser", Foobara::Entity do
+      attributes id: :integer, name: :string
+      primary_key :id
+    end
+  end
+  let(:domain_user_class) do
+    auth_user_class
+    stub_class "User", Foobara::Entity do
+      attributes id: :integer, auth_user: AuthUser
+      primary_key :id
+    end
+  end
+
+  let(:auth_user) do
+    auth_user_class.transaction { AuthUser.create(name: "Fumiko") }
+  end
+  let(:domain_user) do
+    au = auth_user
+    domain_user_class.transaction do
+      User.create(auth_user: au)
+    end
+  end
+
+  let(:authenticator) do
+    user = auth_user
+    Foobara::CommandConnector::Authenticator.subclass(to: AuthUser) { user }
+  end
+
+  let(:base) { 2 }
+  let(:exponent) { 3 }
+
+  let(:response) { command_connector.run(full_command_name:, action:, inputs:) }
+  let(:errors_hash) { response.body.errors_hash }
+
+  let(:action) { "run" }
+  let(:full_command_name) { "ComputeExponent" }
+  let(:inputs) do
+    { base:, exponent: }
+  end
+
+  describe "#run_command" do
+    class << self
+      def with_current_user_allowed_rule
+        let(:allowed_rule) do
+          user = domain_user
+          -> { current_user == user }
+        end
+      end
+
+      def with_current_user_not_allowed_rule
+        let(:allowed_rule) do
+          -> { current_user == "asfdasdf" }
+        end
+      end
+
+      def with_authenticated_user_allowed_rule
+        let(:allowed_rule) do
+          user = auth_user
+          -> { authenticated_user == user }
+        end
+      end
+
+      def with_authenticated_user_not_allowed_rule
+        let(:allowed_rule) do
+          -> { authenticated_user == "asfdasdf" }
+        end
+      end
+    end
+
+    shared_examples "a connector with auth mappers" do
+      before do
+        command_connector.connect(command_class, allowed_rule:)
+      end
+
+      context "when using current_user in the allowed rule" do
+        context "when allowed" do
+          with_current_user_allowed_rule
+
+          it "runs the command" do
+            expect(response.status).to be(0)
+            expect(response.body).to eq(8)
+          end
+        end
+
+        context "when not allowed" do
+          with_current_user_not_allowed_rule
+
+          it "fails with a relevant error" do
+            expect(response.status).to be(1)
+            expect(errors_hash.key?("runtime.not_allowed")).to be true
+          end
+        end
+
+        context "when calling current_user multiple times" do
+          let(:allowed_rule) do
+            user = domain_user
+            -> { current_user && current_user == user }
+          end
+
+          it "runs the command" do
+            expect(response.status).to be(0)
+            expect(response.body).to eq(8)
+          end
+        end
+      end
+
+      context "when using authenticated_user in the allowed rule" do
+        context "when allowed" do
+          with_authenticated_user_allowed_rule
+
+          it "runs the command" do
+            expect(response.status).to be(0)
+            expect(response.body).to eq(8)
+          end
+        end
+
+        context "when not allowed" do
+          with_authenticated_user_not_allowed_rule
+
+          it "fails with a relevant error" do
+            expect(response.status).to be(1)
+            expect(errors_hash.key?("runtime.not_allowed")).to be true
+          end
+        end
+      end
+    end
+
+    context "when auth user mapper is an entity class" do
+      before do
+        domain_user
+      end
+
+      it_behaves_like "a connector with auth mappers"
+    end
+  end
+end

data/projects/entities_plumbing/spec/spec_helper.rb

@@ -0,0 +1,54 @@
+ENV["FOOBARA_ENV"] = "test"
+
+require "bundler/setup"
+
+if ENV["RUBY_DEBUG"] == "true"
+  require "debug"
+elsif ENV["SKIP_PRY"] != "true" && ENV["CI"] != "true"
+  require "pry"
+  require "pry-byebug" unless ENV["SKIP_BYEBUG"] == "true"
+end
+
+require "rspec/its"
+require "simplecov"
+
+SimpleCov.root "#{__dir__}/../../../"
+SimpleCov.command_name "entities_plumbing"
+SimpleCov.coverage_dir "coverage/entities_plumbing"
+
+SimpleCov.start do
+  add_filter "spec/support/"
+  # This avoids printing out info about coverage generated by HTTPFormatter
+  formatter Class.new { def format(_result) = nil }
+end
+
+require "foobara/all"
+require "foobara/entities_plumbing"
+
+RSpec.configure do |config|
+  # Need to do :all instead of :each because for specs that use .around,
+  # .after(:each) do |example| here is called after example.run but before any threads created in
+  # .around might have been cleaned up.
+  config.after(:suite) do
+    threads = Thread.list.reject { |t| t.name == "DEBUGGER__::SESSION@server" }
+    expect(threads.size).to eq(1)
+  end
+  config.filter_run_when_matching :focus
+
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.order = :defined
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  # config.raise_errors_for_deprecations!
+end
+
+require "foobara/spec_helpers/all"
+Dir["#{__dir__}/support/**/*.rb"].each { |f| require f }

data/projects/entities_plumbing/spec/support/rubyprof.rb

@@ -0,0 +1,32 @@
+RSpec.configure do |config|
+  # TODO: move this to foobara-spec-helpers project
+  config.around(:each, :profile) do |example|
+    require "ruby-prof"
+    RubyProf.start
+
+    example.run
+
+    result = RubyProf.stop
+    printer = RubyProf::GraphHtmlPrinter.new(result)
+    File.open("tmp/profile-out.html", "w+") do |file|
+      printer.print(file)
+    end
+  end
+
+  if ENV["RUBY_PROF"] == "true"
+    config.before(:suite) do
+      require "ruby-prof"
+      require "ruby-prof/profile"
+      RubyProf.start
+    end
+
+    config.after(:suite) do
+      result = RubyProf.stop
+
+      printer = RubyProf::GraphHtmlPrinter.new(result)
+      File.open("tmp/profile-out.html", "w+") do |file|
+        printer.print(file)
+      end
+    end
+  end
+end

data/projects/entities_plumbing/spec/support/term_trap.rb

@@ -0,0 +1,6 @@
+# Convenient whenever running into an infinite loop
+Signal.trap("TERM") do
+  puts "SIGTERM received, printing backtrace:"
+  puts caller.join("\n")
+  exit
+end

data/projects/entities_plumbing/src/command_connectors_extension.rb

@@ -0,0 +1,17 @@
+module Foobara
+  module EntitiesPlumbing
+    module CommandConnectorsExtension
+      module ClassMethods
+        def to_auth_user_mapper(object)
+          if object.is_a?(::Class) && object < Foobara::Entity
+            TypeDeclarations::TypedTransformer.subclass(to: object) do |authenticated_user|
+              object.that_owns(authenticated_user)
+            end.instance
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/projects/entities_plumbing/src/extensions/authenticator.rb

@@ -0,0 +1,13 @@
+module Foobara
+  class CommandConnector
+    class Authenticator
+      def relevant_entity_classes(_request)
+        if to_type&.extends?(BuiltinTypes[:entity])
+          NestedTransactionable.relevant_entity_classes_for_type(to_type)
+        else
+          EMPTY_ARRAY
+        end
+      end
+    end
+  end
+end

data/projects/manifest/lib/foobara/manifest.rb

@@ -2,3 +2,5 @@ module Foobara
   module Manifest
   end
 end
+
+Foobara.project("manifest", project_path: "#{__dir__}/../..")