rmfbarker / camel-snake-kebab

A Clojure library for word case conversions.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Camel_SNAKE-kebab

A Clojure library for word case conversions.

News

2014-07-28: 0.2.0

  • Supports ClojureScript!
  • Requires Clojure 1.5.1 or later.
  • Has new regex-free internals.
  • Handles non-ASCII chars better.
  • Breaking change: The namespace camel-snake-kebab has been renamed to camel-snake-kebab.core.

Examples

(use 'camel-snake-kebab)

(->CamelCase 'flux-capacitor)
; => 'FluxCapacitor

(->SNAKE_CASE "I am constant")
; => "I_AM_CONSTANT"

(->kebab-case :object_id)
; => :object-id

(->HTTP-Header-Case "x-ssl-cipher")
; => "X-SSL-Cipher"

There are also functions that convert the value type for you:

(->kebab-case-keyword "object_id")
; => :object-id

Installation

  1. Add the following to your project.clj :dependencies:
[camel-snake-kebab "0.2.1"]
  1. Add the following to your namespace declaration:
:require [camel-snake-kebab :refer :all]

Available Conversion Functions

  • ->CamelCase
  • ->camelCase
  • ->SNAKE_CASE
  • ->Snake_case
  • ->snake_case
  • ->kebab-case
  • ->Camel_Snake_Case
  • ->HTTP-Header-Case

You should be able to figure out all what all of them do.

Yeah, and then there are the type-converting functions:

  • ->CamelCase{Keyword, String, Symbol}
  • ->camelCase{Keyword, String, Symbol}
  • ->SNAKE_CASE_{KEYWORD, STRING, SYMBOL}
  • ->Snake_case_{keyword, string, symbol}
  • ->snake_case_{keyword, string, symbol}
  • ->kebab-case-{keyword, string, symbol}
  • ->Camel_Snake_Case_{Keyword, String, Symbol}
  • ->HTTP-Header-Case-{Keyword, String, Symbol}

Notes

Namespaced keywords and symbols will be rejected with an exception.

Serving Suggestions

(defn map-keys [f m]
  (letfn [(mapper [[k v]] [(f k) (if (map? v) (map-keys f v) v)])]
    (into {} (map mapper m))))

With JSON

(require '[clojure.data.json :as json])

(json/read-str "{\"firstName\":\"John\",\"lastName\":\"Smith\"}" :key-fn ->kebab-case-keyword)
; => {:first-name "John", :last-name "Smith"}

; And back:

(json/write-str {:first-name "John", :last-name "Smith"} :key-fn ->camelCaseString)
; => "{\"firstName\":\"John\",\"lastName\":\"Smith\"}"

With Plain Maps

(map-keys ->kebab-case-keyword {"firstName" "John", "lastName" "Smith"})
; => {:first-name "John", :last-name "Smith"}

; And back:

(map-keys ->camelCaseString {:first-name "John", :last-name "Smith"})
; => {"firstName" "John", "lastName" "Smith"}

With JavaBeans

(->> (java.util.Date.)
     (bean)
     (map-keys ->kebab-case)
     :timezone-offset)
; => -120

With Memoization

If you're going to do case conversion in a hot spot, use core.memoize to avoid doing the same conversions over and over again.

(use 'clojure.core.memoize)
(use 'criterium.core)

(def memoized->kebab-case
  (memo-fifo ->kebab-case 512))

(quick-bench (->kebab-case "firstName"))
; ... Execution time mean : 6,384971 µs ...

(quick-bench (memoized->kebab-case "firstName"))
; ... Execution time mean : 700,146806 ns ...

Further Reading

Alternatives

License

Copyright (C) 2012-2014 Christoffer Sawicki, ToBeReplaced & Brendan Bates

Distributed under the Eclipse Public License, the same as Clojure.

About

A Clojure library for word case conversions.