semantic/test/Analysis/Ruby/Spec.hs

module Analysis.Ruby.Spec (spec) where

import Data.Abstract.Environment as Env
import Data.Abstract.Evaluatable
import qualified Data.Abstract.ModuleTable as ModuleTable
import Data.Abstract.Number as Number
import Data.Abstract.Value.Concrete as Value
import Data.AST
import Control.Effect.Resumable (SomeError(..))
import Data.List.NonEmpty (NonEmpty(..))
import Data.Sum
import qualified Language.Ruby.Assignment as Ruby
import qualified Data.Language as Language

import SpecHelpers


spec :: TaskConfig -> Spec
spec config = parallel $ do
  describe "Ruby" $ do
    it "evaluates require_relative" $ do
      (_, (heap, res)) <- evaluate ["main.rb", "foo.rb"]
      case ModuleTable.lookup "main.rb" <$> res of
        Right (Just (Module _ (_, (env, addr)) :| [])) -> do
          heapLookupAll addr heap `shouldBe` Just [Value.Integer (Number.Integer 1)]
          Env.names env `shouldContain` [ "foo" ]
        other -> expectationFailure (show other)

    it "evaluates load" $ do
      (_, (heap, res)) <- evaluate ["load.rb", "foo.rb"]
      case ModuleTable.lookup "load.rb" <$> res of
        Right (Just (Module _ (_, (env, addr)) :| [])) -> do
          heapLookupAll addr heap `shouldBe` Just [Value.Integer (Number.Integer 1)]
          Env.names env `shouldContain` [ "foo" ]
        other -> expectationFailure (show other)

    it "evaluates load with wrapper" $ do
      (_, (_, res)) <- evaluate ["load-wrap.rb", "foo.rb"]
      res `shouldBe` Left (SomeError (inject @(BaseError (EnvironmentError Precise)) (BaseError (ModuleInfo "load-wrap.rb") emptySpan (FreeVariable "foo"))))

    it "evaluates subclass" $ do
      (_, (heap, res)) <- evaluate ["subclass.rb"]
      case ModuleTable.lookup "subclass.rb" <$> res of
        Right (Just (Module _ (_, (env, addr)) :| [])) -> do
          heapLookupAll addr heap `shouldBe` Just [String "\"<bar>\""]
          Env.names env `shouldContain` [ "Bar", "Foo" ]

          (derefQName heap ("Bar" :| []) env >>= deNamespace heap) `shouldBe` Just ("Bar",  ["baz", "inspect", "foo"])
        other -> expectationFailure (show other)

    it "evaluates modules" $ do
      (_, (heap, res)) <- evaluate ["modules.rb"]
      case ModuleTable.lookup "modules.rb" <$> res of
        Right (Just (Module _ (_, (env, addr)) :| [])) -> do
          heapLookupAll addr heap `shouldBe` Just [String "\"<hello>\""]
          Env.names env `shouldContain` [ "Bar" ]
        other -> expectationFailure (show other)

    it "handles break correctly" $ do
      (_, (heap, res)) <- evaluate ["break.rb"]
      case ModuleTable.lookup "break.rb" <$> res of
        Right (Just (Module _ (_, (env, addr)) :| [])) -> heapLookupAll addr heap `shouldBe` Just [Value.Integer (Number.Integer 3)]
        other -> expectationFailure (show other)

    it "handles next correctly" $ do
      (_, (heap, res)) <- evaluate ["next.rb"]
      case ModuleTable.lookup "next.rb" <$> res of
        Right (Just (Module _ (_, (env, addr)) :| [])) -> heapLookupAll addr heap `shouldBe` Just [Value.Integer (Number.Integer 8)]
        other -> expectationFailure (show other)

    it "calls functions with arguments" $ do
      (_, (heap, res)) <- evaluate ["call.rb"]
      case ModuleTable.lookup "call.rb" <$> res of
        Right (Just (Module _ (_, (env, addr)) :| [])) -> heapLookupAll addr heap `shouldBe` Just [Value.Integer (Number.Integer 579)]
        other -> expectationFailure (show other)

    it "evaluates early return statements" $ do
      (_, (heap, res)) <- evaluate ["early-return.rb"]
      case ModuleTable.lookup "early-return.rb" <$> res of
        Right (Just (Module _ (_, (env, addr)) :| [])) -> heapLookupAll addr heap `shouldBe` Just [Value.Integer (Number.Integer 123)]
        other -> expectationFailure (show other)

    it "has prelude" $ do
      (_, (heap, res)) <- evaluate ["preluded.rb"]
      case ModuleTable.lookup "preluded.rb" <$> res of
        Right (Just (Module _ (_, (env, addr)) :| [])) -> heapLookupAll addr heap `shouldBe` Just [String "\"<foo>\""]
        other -> expectationFailure (show other)

    it "evaluates __LINE__" $ do
      (_, (heap, res)) <- evaluate ["line.rb"]
      case ModuleTable.lookup "line.rb" <$> res of
        Right (Just (Module _ (_, (env, addr)) :| [])) -> heapLookupAll addr heap `shouldBe` Just [Value.Integer (Number.Integer 4)]
        other -> expectationFailure (show other)

    it "resolves builtins used in the prelude" $ do
      (traces, (heap, res)) <- evaluate ["puts.rb"]
      case ModuleTable.lookup "puts.rb" <$> res of
        Right (Just (Module _ (_, (env, addr)) :| [])) -> do
          heapLookupAll addr heap `shouldBe` Just [Unit]
          traces `shouldContain` ["String \"\\\"hello\\\"\""]
        other -> expectationFailure (show other)

  where
    fixtures = "test/fixtures/ruby/analysis/"
    evaluate = evalRubyProject . map (fixtures <>)
    evalRubyProject = testEvaluating <=< evaluateProject' config (Proxy :: Proxy 'Language.Ruby) rubyParser