-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Summary: ------------------------------ This change centralizes version management at the class level, creating a consistent and reusable way to define and access API versions. Unit Tests: ------------------------------ 6155 tests, 80982 assertions, 0 failures, 0 errors, 0 pendings, 0 omissions, 0 notifications 100% passed RuboCop: ------------------------------ 808 files inspected, no offenses detected
- Loading branch information
Showing
10 changed files
with
165 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
module ActiveMerchant | ||
module Versionable | ||
def self.included(base) | ||
if base.respond_to?(:class_attribute) | ||
base.class_attribute :versions, default: {} | ||
base.extend(ClassMethods) | ||
end | ||
end | ||
|
||
module ClassMethods | ||
def inherited(subclass) | ||
super | ||
subclass.versions = {} | ||
end | ||
|
||
def version(version, feature = :default_api) | ||
versions[feature] = version | ||
end | ||
|
||
def fetch_version(feature = :default_api) | ||
versions[feature] | ||
end | ||
end | ||
|
||
def fetch_version(feature = :default_api) | ||
versions[feature] | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
require 'test_helper' | ||
|
||
class VersionableTest < Test::Unit::TestCase | ||
class ParentClass | ||
include ActiveMerchant::Versionable | ||
end | ||
|
||
class DummyClass < ParentClass | ||
end | ||
|
||
class FakeClass < ParentClass | ||
end | ||
|
||
class DummyChildClass < DummyClass | ||
end | ||
|
||
def setup | ||
@dummy_instance = DummyClass.new | ||
@fake_instance = FakeClass.new | ||
@dummy_child_instance = DummyChildClass.new | ||
end | ||
|
||
def test_class_can_set_and_fetch_default_version | ||
DummyClass.version('1.0') | ||
assert_equal '1.0', DummyClass.fetch_version, 'Class should return the correct version' | ||
end | ||
|
||
def test_class_can_set_and_fetch_custom_feature_version | ||
DummyClass.version('2.0', :custom_api) | ||
DummyClass.version('v2', :some_feature) | ||
assert_equal '2.0', DummyClass.fetch_version(:custom_api), 'Class should return the correct version' | ||
assert_equal 'v2', DummyClass.fetch_version(:some_feature), 'Class should return the correct version' | ||
end | ||
|
||
def test_instance_can_fetch_default_version | ||
DummyClass.version('v3') | ||
assert_equal 'v3', @dummy_instance.fetch_version, 'Instance should return the correct version' | ||
end | ||
|
||
def test_instance_can_fetch_custom_feature_version | ||
DummyClass.version('v4', :custom_api) | ||
DummyClass.version('4.0', :some_feature) | ||
assert_equal 'v4', @dummy_instance.fetch_version(:custom_api), 'Instance should return the correct version' | ||
assert_equal '4.0', @dummy_instance.fetch_version(:some_feature), 'Instance should return the correct version' | ||
end | ||
|
||
def test_fetch_version_returns_nil_for_unset_feature | ||
assert_nil DummyClass.fetch_version(:nonexistent_feature), 'Class should return nil for an unset feature' | ||
assert_nil @dummy_instance.fetch_version(:nonexistent_feature), 'Instance should return nil for an unset feature' | ||
end | ||
|
||
def test_classes_dont_share_versions | ||
# Default key | ||
DummyClass.version('1.0') | ||
FakeClass.version('2.0') | ||
DummyChildClass.version('3.0') | ||
|
||
# Custom key :some_feature | ||
DummyChildClass.version('v5', :some_feature) | ||
FakeClass.version('v3', :some_feature) | ||
DummyClass.version('v4', :some_feature) | ||
|
||
assert_equal '1.0', DummyClass.fetch_version, 'Class should return the correct version' | ||
assert_equal 'v4', DummyClass.fetch_version(:some_feature), 'Class should return the correct version' | ||
assert_equal '2.0', FakeClass.fetch_version, 'Class should return the correct version' | ||
assert_equal 'v3', FakeClass.fetch_version(:some_feature), 'Class should return the correct version' | ||
assert_equal '3.0', DummyChildClass.fetch_version, 'Class should return the correct version' | ||
assert_equal 'v5', DummyChildClass.fetch_version(:some_feature), 'Class should return the correct version' | ||
end | ||
|
||
def test_instances_dont_share_versions | ||
# Default key | ||
DummyClass.version('1.0') | ||
FakeClass.version('2.0') | ||
DummyChildClass.version('3.0') | ||
|
||
# Custom key :some_feature | ||
DummyChildClass.version('v5', :some_feature) | ||
FakeClass.version('v3', :some_feature) | ||
DummyClass.version('v4', :some_feature) | ||
|
||
assert_equal '1.0', @dummy_instance.fetch_version, 'Class should return the correct version' | ||
assert_equal 'v4', @dummy_instance.fetch_version(:some_feature), 'Class should return the correct version' | ||
assert_equal '2.0', @fake_instance.fetch_version, 'Class should return the correct version' | ||
assert_equal 'v3', @fake_instance.fetch_version(:some_feature), 'Class should return the correct version' | ||
assert_equal '3.0', @dummy_child_instance.fetch_version, 'Class should return the correct version' | ||
assert_equal 'v5', @dummy_child_instance.fetch_version(:some_feature), 'Class should return the correct version' | ||
end | ||
end |