diff options
| -rw-r--r-- | cpp/include/libaddressinput/address_ui.h | 39 | ||||
| -rw-r--r-- | cpp/libaddressinput.gyp | 2 | ||||
| -rw-r--r-- | cpp/src/address_ui.cc | 131 | ||||
| -rw-r--r-- | cpp/test/address_ui_test.cc | 92 |
4 files changed, 264 insertions, 0 deletions
diff --git a/cpp/include/libaddressinput/address_ui.h b/cpp/include/libaddressinput/address_ui.h new file mode 100644 index 0000000..35d2ede --- /dev/null +++ b/cpp/include/libaddressinput/address_ui.h @@ -0,0 +1,39 @@ +// Copyright (C) 2013 Google Inc. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +#ifndef I18N_ADDRESSINPUT_ADDRESS_UI_H_ +#define I18N_ADDRESSINPUT_ADDRESS_UI_H_ + +#include <string> +#include <vector> + +namespace i18n { +namespace addressinput { + +class Localization; +struct AddressUiComponent; + +// Returns the list of supported CLDR region codes. +const std::vector<std::string>& GetRegionCodes(); + +// Returns the UI components for the CLDR |region_code|. Uses the strings from +// |localization|. Returns an empty vector on error. +std::vector<AddressUiComponent> BuildComponents( + const std::string& region_code, + const Localization& localization); + +} // namespace addressinput +} // namespace i18n + +#endif // I18N_ADDRESSINPUT_ADDRESS_UI_H_ diff --git a/cpp/libaddressinput.gyp b/cpp/libaddressinput.gyp index 0ae5ab1..9130574 100644 --- a/cpp/libaddressinput.gyp +++ b/cpp/libaddressinput.gyp @@ -33,6 +33,7 @@ 'sources': [ 'src/address_field.cc', 'src/address_field_util.cc', + 'src/address_ui.cc', 'src/localization.cc', 'src/region_data_constants.cc', 'src/rule.cc', @@ -48,6 +49,7 @@ 'type': 'executable', 'sources': [ 'test/address_field_util_test.cc', + 'test/address_ui_test.cc', 'test/localization_test.cc', 'test/region_data_constants_test.cc', 'test/rule_test.cc', diff --git a/cpp/src/address_ui.cc b/cpp/src/address_ui.cc new file mode 100644 index 0000000..2867dae --- /dev/null +++ b/cpp/src/address_ui.cc @@ -0,0 +1,131 @@ +// Copyright (C) 2013 Google Inc. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +#include <libaddressinput/address_ui.h> + +#include <libaddressinput/address_field.h> +#include <libaddressinput/address_ui_component.h> +#include <libaddressinput/localization.h> + +#include <string> +#include <vector> + +#include "address_field_util.h" +#include "grit.h" +#include "messages.h" +#include "region_data_constants.h" +#include "rule.h" + +namespace i18n { +namespace addressinput { + +namespace { + +// Parses the default region data into the static Rule object and returns a +// constant reference to this object. Cannot return a copy of the object, +// because Rule objects are not copyable. +const Rule& InitDefaultRule() { + static Rule rule; + rule.ParseSerializedRule(RegionDataConstants::GetDefaultRegionData()); + return rule; +} + +// Returns the constant reference to the Rule object from InitDefaultRule(). The +// static object is in InitDefaultRule(), but this function maintains a constant +// static reference to it. The constant static reference avoids re-parsing the +// default region data. +const Rule& GetDefaultRule() { + static const Rule& kDefaultRule(InitDefaultRule()); + return kDefaultRule; +} + +int GetMessageIdForField(AddressField field, + int admin_area_name_message_id, + int postal_code_name_message_id) { + switch (field) { + case COUNTRY: + return IDS_LIBADDRESSINPUT_I18N_COUNTRY_LABEL; + case ADMIN_AREA: + return admin_area_name_message_id; + case LOCALITY: + return IDS_LIBADDRESSINPUT_I18N_LOCALITY_LABEL; + case DEPENDENT_LOCALITY: + return IDS_LIBADDRESSINPUT_I18N_DEPENDENT_LOCALITY_LABEL; + case SORTING_CODE: + return IDS_LIBADDRESSINPUT_I18N_CEDEX_LABEL; + case POSTAL_CODE: + return postal_code_name_message_id; + case STREET_ADDRESS: + return IDS_LIBADDRESSINPUT_I18N_ADDRESS_LINE1_LABEL; + case ORGANIZATION: + return IDS_LIBADDRESSINPUT_I18N_ORGANIZATION_LABEL; + case RECIPIENT: + return IDS_LIBADDRESSINPUT_I18N_RECIPIENT_LABEL; + default: + return INVALID_MESSAGE_ID; + } +} + +bool IsNewline(AddressField field) { + // NEWLINE is an extension for AddressField enum that's used only internally. + return field == static_cast<AddressField>(NEWLINE); +} + +} // namespace + +const std::vector<std::string>& GetRegionCodes() { + return RegionDataConstants::GetRegionCodes(); +} + +std::vector<AddressUiComponent> BuildComponents( + const std::string& region_code, + const Localization& localization) { + std::vector<AddressUiComponent> result; + + Rule rule; + rule.CopyFrom(GetDefaultRule()); + if (!rule.ParseSerializedRule( + RegionDataConstants::GetRegionData(region_code))) { + return result; + } + + bool previous_field_is_newline = true; + bool next_field_is_newline = true; + for (std::vector<AddressField>::const_iterator field_it = + rule.GetFormat().begin(); + field_it != rule.GetFormat().end(); ++field_it) { + if (IsNewline(*field_it)) { + previous_field_is_newline = true; + continue; + } + AddressUiComponent component; + std::vector<AddressField>::const_iterator next_field_it = field_it + 1; + next_field_is_newline = + next_field_it == rule.GetFormat().end() || IsNewline(*next_field_it); + component.length_hint = previous_field_is_newline && next_field_is_newline + ? AddressUiComponent::HINT_LONG + : AddressUiComponent::HINT_SHORT; + previous_field_is_newline = false; + component.field = *field_it; + component.name = localization.GetString( + GetMessageIdForField(*field_it, rule.GetAdminAreaNameMessageId(), + rule.GetPostalCodeNameMessageId())); + result.push_back(component); + } + + return result; +} + +} // namespace addressinput +} // namespace i18n diff --git a/cpp/test/address_ui_test.cc b/cpp/test/address_ui_test.cc new file mode 100644 index 0000000..8eb4130 --- /dev/null +++ b/cpp/test/address_ui_test.cc @@ -0,0 +1,92 @@ +// Copyright (C) 2013 Google Inc. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +#include <libaddressinput/address_ui.h> + +#include <libaddressinput/address_field.h> +#include <libaddressinput/address_ui_component.h> +#include <libaddressinput/localization.h> + +#include <string> +#include <vector> + +#include <gtest/gtest.h> + +namespace { + +using i18n::addressinput::AddressField; +using i18n::addressinput::AddressUiComponent; +using i18n::addressinput::BuildComponents; +using i18n::addressinput::COUNTRY; +using i18n::addressinput::GetRegionCodes; +using i18n::addressinput::Localization; +using i18n::addressinput::RECIPIENT; + +// Returns testing::AssertionSuccess if the |components| are valid. Uses +// |region_code| in test failure messages. +testing::AssertionResult ComponentsAreValid( + const std::vector<AddressUiComponent>& components) { + if (components.empty()) { + return testing::AssertionFailure() << "no components"; + } + + for (std::vector<AddressUiComponent>::const_iterator + component_it = components.begin(); + component_it != components.end(); ++component_it) { + static const AddressField kMinAddressField = COUNTRY; + static const AddressField kMaxAddressField = RECIPIENT; + if (component_it->field < kMinAddressField || + component_it->field > kMaxAddressField) { + return testing::AssertionFailure() << "unexpected field " + << component_it->field; + } + + if (component_it->name.empty()) { + return testing::AssertionFailure() << "empty field name for field " + << component_it->field; + } + } + + return testing::AssertionSuccess(); +} + +// Tests for address UI functions. +class AddressUiTest : public testing::TestWithParam<std::string> { + protected: + Localization localization_; +}; + +// Verifies that a region code consists of two characters, for example "TW". +TEST_P(AddressUiTest, RegionCodeHasTwoCharacters) { + EXPECT_EQ(2, GetParam().size()); +} + +// Verifies that BuildComponents() returns valid UI components for a region +// code. +TEST_P(AddressUiTest, ComponentsAreValid) { + EXPECT_TRUE(ComponentsAreValid(BuildComponents(GetParam(), localization_))); +} + +// Test all regions codes. +INSTANTIATE_TEST_CASE_P( + AllRegions, AddressUiTest, + testing::ValuesIn(GetRegionCodes())); + +// Verifies that BuildComponents() returns an empty vector for an invalid region +// code. +TEST_F(AddressUiTest, InvalidRegionCodeReturnsEmptyVector) { + EXPECT_TRUE(BuildComponents("INVALID-REGION-CODE", localization_).empty()); +} + +} // namespace |