Skip to content

Small fixes for ordered map equiv and equals methods #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Small fixes for ordered map equiv and equals methods #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion src/flatland/ordered/map.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
IPersistentMap
(equiv [this other]
(and (instance? Map other)
(or (not (map? other)) (instance? MapEquivalence other))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you explain this line a bit more? What is the purpose of checking for (not (map? other))?

Should this be (or (map? other) (instance? MapEquivalence other)), i.e. checking if other is an IPersistentMap or if it is MapEquivalent? Either way, it could be good to add a comment here explaining the purpose of this line?

(= (.count this) (.size ^Map other))
(every? (fn [^MapEntry e]
(let [k (.key e)]
Expand Down Expand Up @@ -85,7 +86,13 @@
(toString [this]
(str "{" (s/join ", " (for [[k v] this] (str k " " v))) "}"))
(equals [this other]
(.equiv this other))
(and (instance? Map other)
(= (.count this) (.size ^Map other))
(every? (fn [^MapEntry e]
(let [k (.key e)]
(and (.containsKey ^Map other k)
(.equals (.val e) (.get ^Map other k)))))
(.seq this))))
(hashCode [this]
(APersistentMap/mapHash this))
IHashEq
Expand Down
34 changes: 34 additions & 0 deletions test/flatland/ordered/map_test.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,3 +211,37 @@
[[nil :a]]
[[:a nil]]
[[nil nil]]))

(defrecord EmptyRec1 [])

(defn is-same-collection [omap b]
(let [msg (format "(class omap)=%s (class b)=%s omap=%s b=%s"
(.getName (class omap)) (.getName (class b)) omap b)
b-persistent? (map? b)
should-be-=? (not (record? b))]
(is (= (count omap) (count b) (.size omap) (.size b)) msg)
(is (= (= omap b) should-be-=?) msg)
(is (= (= b omap) should-be-=?) msg)
(is (.equals ^Object omap b) msg)
(is (.equals ^Object b omap) msg)
(is (= (.hashCode ^Object omap) (.hashCode ^Object b)) msg)
;; At least while CLJ-1372 is unresolved, Clojure persistent
;; collections intentionally have different result for
;; clojure.core/hash than otherwise = non-persistent collections.
(if (and b-persistent? (not (record? b)))
(is (= (hash omap) (hash b)) msg))))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried transforming this into a macro, but I think I actually preferred the error messages in Cursive showing up on the is assertions that failed, rather than on is-same-collection. What do you think?

(defmacro is-same-collection [omap b]
  `(let [msg# (format "(class omap)=%s (class b)=%s omap=%s b=%s"
                      (.getName (class ~omap)) (.getName (class ~b)) ~omap ~b)
         b-persistent?# (map? ~b)
         should-be-=?# (not (record? ~b))]
     (is (= (count ~omap) (count ~b) (.size ~omap) (.size ~b)) msg#)
     (is (= (= ~omap ~b) should-be-=?#) msg#)
     (is (= (= ~b ~omap) should-be-=?#) msg#)
     (is (.equals ^Object ~omap ~b) msg#)
     (is (.equals ^Object ~b ~omap) msg#)
     (is (= (.hashCode ^Object ~omap) (.hashCode ^Object ~b)) msg#)
     ;; At least while CLJ-1372 is unresolved, Clojure persistent
     ;; collections intentionally have different result for
     ;; clojure.core/hash than otherwise = non-persistent collections.
     (if (and b-persistent?# (not (record? ~b)))
       (is (= (hash ~omap) (hash ~b)) msg#))))

(deftest map-collection-tests
  (is-same-collection (ordered-map) {})
  (is-same-collection (ordered-map) (hash-map))
  (is-same-collection (ordered-map) (array-map))
  (is-same-collection (ordered-map) (sorted-map))
  (is-same-collection (ordered-map) (sorted-map-by <))
  (is-same-collection (ordered-map) (ordered-map))
  (is-same-collection (ordered-map) (->EmptyRec1))
  (is-same-collection (ordered-map) (java.util.HashMap.))

  (is (= false (.equals {1 17N} (java.util.HashMap. {1 17}))))
  (is (= false (.equals (ordered-map 1 17N) (java.util.HashMap. {1 17})))))


(deftest map-collection-tests
(let [maps [ {}
(hash-map)
(array-map)
(sorted-map)
(sorted-map-by <)
(ordered-map)
(->EmptyRec1)
(java.util.HashMap.) ]]
(doseq [m maps]
(is-same-collection (ordered-map) m)))

(is (= false (.equals {1 17N} (java.util.HashMap. {1 17}))))
(is (= false (.equals (ordered-map 1 17N) (java.util.HashMap. {1 17})))))