Merge pull request #6 from vthiery/feature/improve-organization

Feature/improve organization

Author: vthiery

.clang-format

@@ -0,0 +1,105 @@
+AccessModifierOffset: -4
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortFunctionsOnASingleLine: Empty
+BinPackArguments: false
+BinPackParameters: false
+ColumnLimit:     120
+IndentCaseLabels: false
+IndentWidth:     4
+
+---
+Language:        Cpp
+# BasedOnStyle:  Google
+#AccessModifierOffset: -1
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlinesLeft: true
+AlignOperands:   true
+AlignTrailingComments: true
+#AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+#AllowShortFunctionsOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: true
+AllowShortLoopsOnASingleLine: true
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: true
+AlwaysBreakTemplateDeclarations: true
+#BinPackArguments: true
+#BinPackParameters: true
+BraceWrapping:
+  AfterClass:      false
+  AfterControlStatement: false
+  AfterEnum:       false
+  AfterFunction:   false
+  AfterNamespace:  false
+  AfterObjCDeclaration: false
+  AfterStruct:     false
+  AfterUnion:      false
+  BeforeCatch:     false
+  BeforeElse:      false
+  IndentBraces:    false
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Attach
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+#ColumnLimit:     80
+CommentPragmas:  '^ IWYU pragma:'
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DerivePointerAlignment: true
+DisableFormat:   false
+ExperimentalAutoDetectBinPacking: false
+ForEachMacros:   [ foreach, Q_FOREACH, BOOST_FOREACH ]
+IncludeCategories:
+  - Regex:           '^<.*\.h>'
+    Priority:        1
+  - Regex:           '^<.*'
+    Priority:        2
+  - Regex:           '.*'
+    Priority:        3
+IncludeIsMainRegex: '([-_](test|unittest))?$'
+#IndentCaseLabels: true
+#IndentWidth:     2
+IndentWrappedFunctionNames: false
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: false
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBlockIndentWidth: 2
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: false
+PenaltyBreakBeforeFirstCallParameter: 1
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 200
+PointerAlignment: Left
+ReflowComments:  true
+SortIncludes:    true
+SpaceAfterCStyleCast: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeParens: ControlStatements
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 2
+SpacesInAngles:  false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+Standard:        Auto
+TabWidth:        8
+UseTab:          Never
+...
+

CMakeLists.txt

@@ -2,9 +2,9 @@ cmake_minimum_required(VERSION 3.2)
 
 project(StatsdClient)
 
-include_directories(${CMAKE_CURRENT_SOURCE_DIR}/src)
+include_directories(${CMAKE_CURRENT_SOURCE_DIR}/include/cpp-statsd-client)
 
-install(FILES src/UDPSender.hpp src/StatsdClient.hpp DESTINATION include)
+install(FILES UDPSender.hpp StatsdClient.hpp DESTINATION include)
 
 find_package(Threads)
 add_executable(testStatsdClient ${CMAKE_CURRENT_SOURCE_DIR}/tests/testStatsdClient.cpp)

src/StatsdClient.hpp …clude/cpp-statsd-client/StatsdClient.hppsrc/StatsdClient.hpp renamed to include/cpp-statsd-client/StatsdClient.hpp src/StatsdClient.hpp renamed to include/cpp-statsd-client/StatsdClient.hpp

@@ -6,8 +6,7 @@
 #include <string>
 #include "UDPSender.hpp"
 
-namespace Statsd
-{
+namespace Statsd {
 /*!
  *
  * Statsd client
@@ -20,159 +19,124 @@ namespace Statsd
  * set if batching is not desired.
  *
  */
-class StatsdClient
-{
+class StatsdClient {
 public:
-
     //!@name Constructor and destructor
     //!@{
 
     //! Constructor
-    StatsdClient(
-        const std::string& host,
-        const uint16_t port,
-        const std::string& prefix,
-        const std::experimental::optional<uint64_t> batchsize = std::experimental::nullopt) noexcept;
+    StatsdClient(const std::string &host,
+                 const uint16_t port,
+                 const std::string &prefix,
+                 const std::experimental::optional<uint64_t> batchsize = std::experimental::nullopt) noexcept;
 
     //!@}
 
     //!@name Methods
     //!@{
 
     //! Sets a configuration { host, port, prefix }
-    inline void setConfig(const std::string& host, const uint16_t port, const std::string& prefix) noexcept;
+    inline void setConfig(const std::string &host, const uint16_t port, const std::string &prefix) noexcept;
 
     //! Returns the error message as an optional std::string
     inline std::experimental::optional<std::string> errorMessage() const noexcept;
 
     //! Increments the key, at a given frequency rate
-    inline void increment(const std::string& key, const float frequency = 1.0f) const noexcept;
+    inline void increment(const std::string &key, const float frequency = 1.0f) const noexcept;
 
     //! Increments the key, at a given frequency rate
-    inline void decrement(const std::string& key, const float frequency = 1.0f) const noexcept;
+    inline void decrement(const std::string &key, const float frequency = 1.0f) const noexcept;
 
     //! Adjusts the specified key by a given delta, at a given frequency rate
-    inline void count(const std::string& key, const int delta, const float frequency = 1.0f) const noexcept;
+    inline void count(const std::string &key, const int delta, const float frequency = 1.0f) const noexcept;
 
     //! Records a gauge for the key, with a given value, at a given frequency rate
-    inline void gauge(const std::string& key, const unsigned int value, const float frequency = 1.0f) const noexcept;
+    inline void gauge(const std::string &key, const unsigned int value, const float frequency = 1.0f) const noexcept;
 
     //! Records a timing for a key, at a given frequency
-    inline void timing(const std::string& key, const unsigned int ms, const float frequency = 1.0f) const noexcept;
+    inline void timing(const std::string &key, const unsigned int ms, const float frequency = 1.0f) const noexcept;
 
     //! Send a value for a key, according to its type, at a given frequency
-    void send(const std::string& key, const int value, const std::string& type, const float frequency = 1.0f) const noexcept;
+    void send(const std::string &key, const int value, const std::string &type, const float frequency = 1.0f) const
+        noexcept;
 
     //!@}
 
 private:
-
     //! The prefix to be used for metrics
     std::string m_prefix;
 
     //! The UDP sender to be used for actual sending
     mutable UDPSender m_sender;
 };
 
-StatsdClient::
-StatsdClient(
-    const std::string& host,
-    const uint16_t port,
-    const std::string& prefix,
-    const std::experimental::optional<uint64_t> batchsize) noexcept
-: m_prefix(prefix)
-, m_sender(host, port, batchsize)
-{
+StatsdClient::StatsdClient(const std::string &host,
+                           const uint16_t port,
+                           const std::string &prefix,
+                           const std::experimental::optional<uint64_t> batchsize) noexcept
+    : m_prefix(prefix), m_sender(host, port, batchsize) {
     // Initialize the randorm generator to be used for sampling
     std::srand(time(nullptr));
 }
 
-void
-StatsdClient::
-setConfig(const std::string& host, const uint16_t port, const std::string& prefix) noexcept
-{
+void StatsdClient::setConfig(const std::string &host, const uint16_t port, const std::string &prefix) noexcept {
     m_prefix = prefix;
     m_sender.setConfig(host, port);
 }
 
-std::experimental::optional<std::string>
-StatsdClient::
-errorMessage() const noexcept
-{
+std::experimental::optional<std::string> StatsdClient::errorMessage() const noexcept {
     return m_sender.errorMessage();
 }
 
-void
-StatsdClient::
-decrement(const std::string& key, const float frequency) const noexcept
-{
+void StatsdClient::decrement(const std::string &key, const float frequency) const noexcept {
     return count(key, -1, frequency);
 }
 
-void
-StatsdClient::
-increment(const std::string& key, const float frequency) const noexcept
-{
+void StatsdClient::increment(const std::string &key, const float frequency) const noexcept {
     return count(key, 1, frequency);
 }
 
-void
-StatsdClient::
-count(const std::string& key, const int delta, const float frequency) const noexcept
-{
+void StatsdClient::count(const std::string &key, const int delta, const float frequency) const noexcept {
     return send(key, delta, "c", frequency);
 }
 
-void
-StatsdClient::
-gauge(const std::string& key, const unsigned int value, const float frequency) const noexcept
-{
+void StatsdClient::gauge(const std::string &key, const unsigned int value, const float frequency) const noexcept {
     return send(key, value, "g", frequency);
 }
 
-void
-StatsdClient::
-timing(const std::string& key, const unsigned int ms, const float frequency) const noexcept
-{
+void StatsdClient::timing(const std::string &key, const unsigned int ms, const float frequency) const noexcept {
     return send(key, ms, "ms", frequency);
 }
 
-void
-StatsdClient::
-send(const std::string& key, const int value, const std::string& type, const float frequency) const noexcept
-{
-    const auto isFrequencyOne = [](const float frequency) noexcept
-    {
-        constexpr float epsilon{ 0.0001f };
+void StatsdClient::send(const std::string &key, const int value, const std::string &type, const float frequency) const
+    noexcept {
+    const auto isFrequencyOne = [](const float frequency) noexcept {
+        constexpr float epsilon{0.0001f};
         return std::fabs(frequency - 1.0f) < epsilon;
     };
 
     // Test if one should send or not, according to the frequency rate
-    if (!isFrequencyOne(frequency))
-    {
-        if (frequency < static_cast<float>(std::rand()) / RAND_MAX)
-        {
+    if (!isFrequencyOne(frequency)) {
+        if (frequency < static_cast<float>(std::rand()) / RAND_MAX) {
             return;
         }
     }
 
     // Prepare the buffer, with a sampling rate if specified different from 1.0f
     char buffer[256];
-    if (isFrequencyOne(frequency))
-    {
+    if (isFrequencyOne(frequency)) {
         // Sampling rate is 1.0f, no need to specify it
         std::snprintf(buffer, sizeof(buffer), "%s%s:%d|%s", m_prefix.c_str(), key.c_str(), value, type.c_str());
-    }
-    else
-    {
+    } else {
         // Sampling rate is different from 1.0f, hence specify it
-        std::snprintf(buffer, sizeof(buffer), "%s%s:%d|%s|@%.2f", m_prefix.c_str(), key.c_str(), value, type.c_str(), frequency);
+        std::snprintf(
+            buffer, sizeof(buffer), "%s%s:%d|%s|@%.2f", m_prefix.c_str(), key.c_str(), value, type.c_str(), frequency);
     }
 
     // Send the message via the UDP sender
     m_sender.send(buffer);
 }
 
-}
+}  // namespace Statsd
 
 #endif