is_flow -> is_flow_class

Author: leafo

docs/flows.md

@@ -310,28 +310,28 @@ assert(flow_b._ == my_object)
 
 ## Utility Functions
 
-### `is_flow(cls)`
+### `is_flow_class(cls)`
 
-The `is_flow` function checks if a class is a Flow:
+The `is_flow_class` function checks if a class or instance is a Flow:
 
 $dual_code{
 lua = [[
 local Flow = require("lapis.flow").Flow
-local is_flow = require("lapis.flow").is_flow
+local is_flow_class = require("lapis.flow").is_flow_class
 
 MyFlow = Flow:extend({})
 some_object = {}
 
-is_flow(MyFlow) --> true
-is_flow(some_object) --> false
+is_flow_class(MyFlow) --> true
+is_flow_class(some_object) --> false
 ]],
 moon = [[
-import Flow, is_flow from require "lapis.flow"
+import Flow, is_flow_class from require "lapis.flow"
 
 class MyFlow extends Flow
 some_object = {}
 
-is_flow MyFlow --> true
-is_flow some_object --> false
+is_flow_class MyFlow --> true
+is_flow_class some_object --> false
 ]]
 }

lapis/flow.lua

@@ -5,15 +5,15 @@ do
 end
 local unpack = table.unpack or unpack
 local Flow
-local is_flow
-is_flow = function(cls)
+local is_flow_class
+is_flow_class = function(cls)
   if not (cls) then
     return false
   end
   if cls == Flow then
     return true
   end
-  return is_flow(cls.__parent)
+  return is_flow_class(cls.__parent)
 end
 local MEMO_KEY = setmetatable({ }, {
   __tostring = function()
@@ -50,7 +50,7 @@ do
       self._ = _
       assert(self._, "missing flow target")
       self._req = self._
-      if is_flow(self._.__class) then
+      if is_flow_class(self._.__class) then
         self._ = self._._
       end
       local old_mt = getmetatable(self)
@@ -126,7 +126,7 @@ do
 end
 return {
   Flow = Flow,
-  is_flow = is_flow,
+  is_flow_class = is_flow_class,
   MEMO_KEY = MEMO_KEY,
   memo = memo
 }

lapis/flow.moon

@@ -5,10 +5,10 @@ unpack = table.unpack or unpack
 
 local Flow
 
-is_flow = (cls) ->
+is_flow_class = (cls) ->
   return false unless cls
   return true if cls == Flow
-  is_flow cls.__parent
+  is_flow_class cls.__parent
 
 MEMO_KEY = setmetatable {}, __tostring: -> "::memo_key::"
 
@@ -48,7 +48,7 @@ class Flow
     @_req = @_ -- TODO: for legacy flows
 
     -- get the real request if the object passed is another flow
-    if is_flow @_.__class
+    if is_flow_class @_.__class
       @_ = @_._
 
     old_mt = getmetatable @
@@ -87,4 +87,4 @@ class Flow
     setmetatable @, mt
 
 
-{ :Flow, :is_flow, :MEMO_KEY, :memo }
+{ :Flow, :is_flow_class, :MEMO_KEY, :memo }

spec/flow_spec.moon

@@ -1,5 +1,5 @@
 
-import Flow, is_flow from require "lapis.flow"
+import Flow, is_flow_class from require "lapis.flow"
 
 describe "lapis.flow", ->
   local base_object
@@ -186,39 +186,39 @@ describe "lapis.flow", ->
       assert.same {}, obj
       assert.same {[multiple]: {1, 2}}, f[MEMO_KEY]
 
-  describe "is_flow", ->
+  describe "is_flow_class", ->
     it "returns false for nil", ->
-      assert.false is_flow nil
+      assert.false is_flow_class nil
 
     it "returns false for false", ->
-      assert.false is_flow false
+      assert.false is_flow_class false
 
     it "returns true for Flow class", ->
-      assert.true is_flow Flow
+      assert.true is_flow_class Flow
 
     it "returns true for class extending Flow", ->
       class MyFlow extends Flow
-      assert.true is_flow MyFlow
+      assert.true is_flow_class MyFlow
 
     it "returns true for deeply nested Flow subclass", ->
       class FirstFlow extends Flow
       class SecondFlow extends FirstFlow
       class ThirdFlow extends SecondFlow
 
-      assert.true is_flow SecondFlow
-      assert.true is_flow ThirdFlow
+      assert.true is_flow_class SecondFlow
+      assert.true is_flow_class ThirdFlow
 
     it "returns false for regular table", ->
-      assert.false is_flow {}
+      assert.false is_flow_class {}
 
     it "returns false for regular class", ->
       class BaseClass
       class ChildClass extends BaseClass
 
-      assert.false is_flow BaseClass
-      assert.false is_flow ChildClass
+      assert.false is_flow_class BaseClass
+      assert.false is_flow_class ChildClass
 
     it "returns false when passing a Flow instance directly", ->
       class MyFlow extends Flow
       f = MyFlow {}
-      assert.false is_flow f
+      assert.false is_flow_class f