Enhance TA-Lib library and update configuration

[Youngv]

User description

• Added support for Metrics/ModuleLength in .rubocop.yml to improve code quality checks.
• Updated README.md to include a badge for GitHub Actions tests and refined the gem description.
• Refactored lib/ta_lib.rb to improve code organization and readability, including the introduction of a constant for parameter types.
• Removed redundant tests in spec/ta_lib_spec.rb to streamline validation and improve clarity.
• Enhanced input validation in various methods to ensure robustness against invalid data.

These changes aim to improve the overall functionality and maintainability of the TA-Lib library.

---

PR Type

Enhancement, Documentation

---

Description

• Refactored lib/ta_lib.rb for better organization and readability

• Added Rubocop configuration to disable Metrics/ModuleLength

• Updated README.md with GitHub Actions badge and gem description

• Removed redundant tests in spec/ta_lib_spec.rb

---

Changes walkthrough 📝

	Relevant files
Enhancement	ta_lib.rb Refactor TA-Lib core functionality and organization            lib/ta_lib.rb Added frozen string literal comment Refactored parameter types into a constant hash TA_PARAM_TYPE Improved input validation and error handling Added Rubocop disable comments for long methods +73/-91
Tests	ta_lib_spec.rb Streamline and improve test coverage                                          spec/ta_lib_spec.rb Removed redundant tests for array length validation Updated test descriptions and expectations Improved test data handling and edge cases +86/-200
Configuration changes	.rubocop.yml Update Rubocop configuration                                                          .rubocop.yml Added configuration to disable Metrics/ModuleLength check +3/-0
Documentation	README.md Update README with badge and description                                  README.md Added GitHub Actions test badge Updated gem description +2/-2
Formatting	talib_spec.rb Clean up file formatting                                                                  spec/talib_spec.rb Removed empty line at end of file +0/-1

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪

🧪 PR contains tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Input Validation The input validation for array lengths in methods like validate_inputs! has been modified. Ensure that the new validation logic correctly handles edge cases and maintains data integrity. def validate_inputs!(arrays) raise TALibError, "Input arrays cannot be empty" if arrays.empty? arrays.each do |arr| raise TALibError, "Input must be arrays" unless arr.is_a?(Array) end sizes = arrays.map(&:length) raise TALibError, "Input arrays cannot be empty" if sizes.any?(&:zero?) arrays.each do |arr| raise TALibError, "Input arrays must contain only numbers" unless arr.flatten.all? { |x| x.is_a?(Numeric) } end end # rubocop:enable Metrics/CyclomaticComplexity # rubocop:enable Metrics/PerceivedComplexity Rubocop Disables Multiple Rubocop disables have been added for metrics like MethodLength and AbcSize. Review if these disables are necessary or if the code can be refactored to avoid them. # rubocop:disable Metrics/MethodLength # rubocop:disable Metrics/AbcSize def print_function_info(func_info) Test Coverage Some tests have been removed or modified. Ensure that the remaining tests provide adequate coverage for the functionality, especially for edge cases and error handling. describe "#div" do it "performs vector arithmetic division of two arrays" do result = described_class.div(first_price_set, second_price_set) expect(result).to eq([0.5, 1.0, 1.0, 0.8, 1.0]) end it "returns array of same length as inputs" do result = described_class.div(first_price_set, second_price_set) expect(result.length).to eq(first_price_set.length) end it "handles division by zero" do array1 = [1.0, 2.0, 3.0]

[github-actions]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
General	Explicitly define price flag order The setup_price_inputs method now uses TA_FLAGS[:TA_InputFlags].keys[0..5] to iterate over price flags. This is fragile as it assumes the order of keys in the hash. Consider explicitly defining the order of price flags to ensure consistent behavior. lib/ta_lib.rb [641] -TA_FLAGS[:TA_InputFlags].keys[0..5].each_with_index do |flag, i| +[TA_IN_PRICE_OPEN, TA_IN_PRICE_HIGH, TA_IN_PRICE_LOW, TA_IN_PRICE_CLOSE, TA_IN_PRICE_VOLUME, TA_IN_PRICE_OPENINTEREST].each_with_index do |flag, i| Suggestion importance[1-10]: 8 Why: The suggestion improves code robustness by avoiding reliance on hash key order, which is a good practice.	8
	Remove redundant empty array check The validation for empty input arrays is duplicated in validate_inputs!. The check raise TALibError, "Input arrays cannot be empty" if arrays.empty? is redundant since it's already covered by raise TALibError, "Input arrays cannot be empty" if sizes.any?(&:zero?). Remove the redundant check to avoid confusion and maintain clean code. lib/ta_lib.rb [349-356] -raise TALibError, "Input arrays cannot be empty" if arrays.empty? ... raise TALibError, "Input arrays cannot be empty" if sizes.any?(&:zero?) Suggestion importance[1-10]: 6 Why: The suggestion correctly identifies a redundant check, improving code clarity and maintainability.	6
	Remove debug logging statement The puts "actual_size: #{actual_size}" statement in calculate_results appears to be debug logging. If this is not intended for production, consider removing it or wrapping it in a debug condition to avoid unnecessary output in production environments. lib/ta_lib.rb [446] -puts "actual_size: #{actual_size}" +# Remove or wrap in debug condition Suggestion importance[1-10]: 5 Why: The suggestion addresses a potential debug statement that should not be in production code, improving code quality.	5
Possible issue	Add division by zero behavior verification The test for handling division by zero should include assertions to verify the actual behavior when dividing by zero, rather than just checking array lengths. spec/ta_lib_spec.rb [71-73] it "handles division by zero" do array1 = [1.0, 2.0, 3.0] array2 = [1.0, 0.0, 2.0] + result = described_class.div(array1, array2) + expect(result[1]).to be_infinite Suggestion importance[1-10]: 8 Why: The suggestion adds important verification of division by zero behavior, which is a critical edge case that should be tested.	8
	Add error handling for invalid types The set_input_parameter method's case statement has overlapping conditions due to missing else branches. This could lead to unexpected behavior if an invalid type is passed. Add an else branch to handle unexpected types. lib/ta_lib.rb [390-397] case input_info["type"] when TA_PARAM_TYPE[:TA_Input_Real] input_ptr = prepare_double_array(array) TA_SetInputParamRealPtr(params_ptr, index, input_ptr) when TA_PARAM_TYPE[:TA_Input_Integer] input_ptr = prepare_integer_array(array) TA_SetInputParamIntegerPtr(params_ptr, index, input_ptr) when TA_PARAM_TYPE[:TA_Input_Price] setup_price_inputs(params_ptr, index, array, input_info["flags"]) +else + raise TALibError, "Invalid input parameter type: #{input_info["type"]}" end Suggestion importance[1-10]: 7 Why: The suggestion adds necessary error handling for unexpected input types, improving code reliability.	7
	Add Bollinger Bands value verification The test for Bollinger Bands should verify the actual calculated values rather than just checking the structure of the result. spec/ta_lib_spec.rb [852-857] it "calculates Bollinger Bands" do result = described_class.bbands(close_prices, time_period: 5) expect(result).to be_a(Hash) expect(result.keys).to contain_exactly(:upper_band, :middle_band, :lower_band) - expect(result).to match(upper_band: an_instance_of(Array), middle_band: an_instance_of(Array), lower_band: an_instance_of(Array)) + expect(result[:upper_band].first).to be_within(0.01).of(11.0) + expect(result[:middle_band].first).to be_within(0.01).of(10.0) + expect(result[:lower_band].first).to be_within(0.01).of(9.0) Suggestion importance[1-10]: 7 Why: While the suggestion improves test coverage, the specific expected values (11.0, 10.0, 9.0) may not be accurate for all cases.	7
	Add MidPrice value verification The test for MidPrice should verify the actual calculated mid prices rather than just checking the array structure. spec/ta_lib_spec.rb [1095-1098] it "calculates MidPrice over period" do result = described_class.midprice([high_prices, low_prices], time_period: 2) expect(result).to be_an(Array) - expect(result.length).to eq(1) + expect(result.first).to be_within(0.01).of(10.5) Suggestion importance[1-10]: 7 Why: The suggestion adds value verification which improves test quality, though the specific expected value (10.5) may need validation.	7
	Tighten HT Trendline constant test The test for handling constant price series in HT Trendline should verify the actual calculated trendline values. spec/ta_lib_spec.rb [950-953] it "handles constant price series" do constant_prices = Array.new(200) { rand(9.0..11.0) } result = described_class.ht_trendline(constant_prices) - expect(result).to all(be_within(1).of(10.0)) + expect(result).to all(be_within(0.01).of(10.0)) Suggestion importance[1-10]: 6 Why: The suggestion improves test precision but the impact is moderate as it only tightens the tolerance range.	6