red_amber 0.2.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f70451aad21c0750fb2a0bfe165baf5862ac3837541135cf9d58df4ecd732ac
-  data.tar.gz: c31f143278bf3792bc03e0e727e12df72fca5a001b3d6c098c3f028df456e2f0
+  metadata.gz: aa6f3c47b47df7271d7d150a800013c7c9d8bd75ca6066f54506c922f12eea09
+  data.tar.gz: 763f19f54a6508648fe9f1bdd0a11f678a86f554b58b71d7bed66aa5df7df2a7
 SHA512:
-  metadata.gz: c5026422e8f0c0b1b1b25f6baa97b540287937a3c0d224a16ce13c17c16a11ccd54682682f17fdf5e176190f7db40bfda7bbe5659e89a212eed8f1bf9b3567e9
-  data.tar.gz: 82b500a1570b8fc8925a7c988bd7d3f3db677588537ee9f8d75f965ca98f5d730a0a55be5fa6637e3beeb4aed11b55a9afd3e4dfd52aee687e123f390f0d8d2b
+  metadata.gz: 433ca52f7a62f055f327e0426426cfd86f563009e4ec4811d7cf8297152309081271b7b7625d39ffa31ecf455d352ee305d76b6d09e4d1dab0d90aa6c2bffb3e
+  data.tar.gz: 717d8618dd428d165c80420e7c35f1b7f870a059227a91bd5224f67b9cd3b8bdafcaed523fee170524738036cc9b43e914712fa01e88f7eb9ca1f0cc18c98dbf

data/.rubocop.yml

@@ -8,12 +8,13 @@ require:
   - rubocop-rake
 
 AllCops:
-  # drop support for < 2.7
-  TargetRubyVersion: 2.7
+  # drop support for 2.7 (since 0.3.0)
+  TargetRubyVersion: 3.0
   # accept new cops if any
   NewCops: enable
 
 # ===
+# Globally I change these 3 cops from default
 
 # alias is hard to see separately 
 Style/Alias:
@@ -29,123 +30,204 @@ Style/TrailingCommaInHashLiteral:
 # ===
 
 # To let you know the possibility of refactoring ===
-#
-# avoid unused variable asignment
-Rubycw/Rubycw:
+
+# Max: 120
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 90
   Exclude:
     - 'test/**/*'
-Lint/UselessAssignment:
+
+# EnforcedStyle: aligned
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+
+# avoid unused variable asignment
+Rubycw/Rubycw:
   Exclude:
     - 'test/**/*'
 
 # Disabled to define Vector operators
+# Offense count: 38
 Lint/BinaryOperatorWithIdenticalOperands:
   Exclude:
-    - 'test/test_vector_function.rb'
+    - 'test/test_vector_binary_element_wise.rb'
 
 # Need for test with empty block
+# Offense count: 1
+# Configuration parameters: AllowComments, AllowEmptyLambdas.
 Lint/EmptyBlock:
   Exclude:
     - 'test/test_group.rb'
 
-# Max: 120
-Layout/LineLength:
-  Max: 118
+# avoid unused variable asignment
+# Offense count: 6
+Lint/UselessAssignment:
   Exclude:
     - 'test/**/*'
 
 # <= 17 satisfactory
 # 18..30 unsatisfactory
 # > 30 dangerous
+# Offense count: 28
+# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 30
-  Exclude:
-    - 'lib/red_amber/data_frame_combinable.rb' # Max: 43
-    - 'lib/red_amber/data_frame_displayable.rb' # Max: 55
-    - 'lib/red_amber/data_frame_reshaping.rb' # Max 40.91
-    - 'lib/red_amber/data_frame_selectable.rb' # Max: 51
-    - 'lib/red_amber/data_frame_variable_operation.rb' # Max: 30.15
-    - 'lib/red_amber/vector_updatable.rb' # Max: 36
-    - 'lib/red_amber/vector_selectable.rb' # Max: 33
+  CountRepeatedAttributes: false
+  AllowedMethods: [
+    'join', # 51.87
+    'dataframe_info', # 46.5
+    'format_table', # 84.62
+    'to_long', # 33.66
+    'to_wide', #38.22
+    'slice_by', # 38.29
+    'remove', # 44.42
+    'drop', # 31.42
+    '[]', # 33.76
+    'split', # 37.35
+  ]
 
 # Max: 25
+# Offense count: 57
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
+# AllowedMethods: refine
 Metrics/BlockLength:
   Max: 25
   Exclude:
     - 'test/**/*'
+    - 'lib/red_amber/helper.rb' # 32
 
+# It's ok if class is big
 # Max: 100
+# Offense count: 15
+# Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 100
   Exclude:
     - 'test/**/*'
-    - 'lib/red_amber/data_frame.rb' #Max: 131
-    - 'lib/red_amber/vector.rb' #Max: 102
-    - 'lib/red_amber/group.rb' #Max: 103
+    - 'lib/red_amber/data_frame.rb' # 162
+    - 'lib/red_amber/group.rb' # 105
+    - 'lib/red_amber/subframes.rb' # 110
+    - 'lib/red_amber/vector.rb' # 152
 
+# Only for monitoring. I will measure by PerceivedComplexity.
 # Max: 7
+# Offense count: 16
+# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
 Metrics/CyclomaticComplexity:
   Max: 12
-  Exclude:
-    - 'lib/red_amber/data_frame_combinable.rb' # Max: 15
-    - 'lib/red_amber/data_frame_displayable.rb' # Max: 18
-    - 'lib/red_amber/data_frame_selectable.rb' # Max: 14
-    - 'lib/red_amber/helper.rb' # Max: 15
-    - 'lib/red_amber/vector_selectable.rb' # Max: 13
-    - 'lib/red_amber/vector_updatable.rb' # Max: 14
+  AllowedMethods: [
+    'split', # 33
+    'format_table', # 21
+    'normalize_element', # 17
+    'slice_by', # 16
+    'assign_update', # 14
+    'join', # 14
+    'parse_range', # 14
+    'remove', # 14
+    '[]', # 13
+  ]
 
 # Max: 10
+# Offense count: 34
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
 Metrics/MethodLength:
   Max: 30
-  Exclude:
-    - 'lib/red_amber/data_frame_combinable.rb' # Max: 38
-    - 'lib/red_amber/data_frame_displayable.rb' # Max: 33
-    - 'lib/red_amber/data_frame_selectable.rb' # Max: 38
-    - 'lib/red_amber/data_frame_variable_operation.rb' # Max: 35
+  AllowedMethods: [
+    'join', # 47
+    'dataframe_info', # 33
+    'format_table', # 53
+    'slice_by', # 38
+    'assign_update', # 35
+    'aggregate', # 31
+  ]
 
 # Max: 100
+# Offense count: 5
+# Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
   Max: 100
   Exclude:
-    - 'lib/red_amber/data_frame_combinable.rb' # Max: 108
-    - 'lib/red_amber/data_frame_displayable.rb' # Max: 132
-    - 'lib/red_amber/data_frame_selectable.rb' # Max: 141
-    - 'lib/red_amber/data_frame_variable_operation.rb' # Max: 110
-    - 'lib/red_amber/vector_functions.rb' # Max: 114
+    - 'lib/red_amber/data_frame_combinable.rb' # Max: 149
+    - 'lib/red_amber/data_frame_displayable.rb' # Max: 226
+    - 'lib/red_amber/data_frame_selectable.rb' # Max: 175
+    - 'lib/red_amber/data_frame_variable_operation.rb' # Max: 171
+    - 'lib/red_amber/vector_functions.rb' # Max: 165
+    - 'lib/red_amber/vector_selectable.rb' # Max: 104
+    - 'lib/red_amber/vector_updatable.rb' # Max: 103
 
 # Max: 5
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
-  Max: 6
-  # Exclude:
-  #   - 'lib/red_amber/data_frame_combinable.rb' # Max: 6
+  Exclude:
+    - 'lib/red_amber/data_frame_combinable.rb' # Max: 6, at 'join'
 
 # Max: 8
+# Offense count: 15
+# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 13
-  Exclude:
-    - 'lib/red_amber/data_frame_combinable.rb' # Max: 14
-    - 'lib/red_amber/data_frame_selectable.rb' # Max: 14
-    - 'lib/red_amber/helper.rb' # Max: 15
-    - 'lib/red_amber/vector_updatable.rb' # Max: 15
-    - 'lib/red_amber/data_frame_displayable.rb' # Max: 19
-
+  Max: 10
+  AllowedMethods: [
+    'format_table', # 22
+    'slice_by', # 20
+    'normalize_element', # 17
+    'assign_update', # 15
+    'parse_range', # 15
+    'join', # 14
+    'remove', # 14
+    'split', # 14
+    'dataframe_info', # 13
+    'replace', # 13
+    'drop', # 12
+    'initialize', # 12
+    'aggregate', # 12
+    '[]', # 11
+    'filters', # 11
+    'html_table', # 11
+    'slice', # 11
+  ]
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# CheckDefinitionPathHierarchyRoots: lib, spec, test, src
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
 Naming/FileName:
   Exclude:
     - 'lib/red-amber.rb'
 
 # Necessary to define is_na, is_in, etc.
+# Offense count: 3
+# Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros.
+# NamePrefix: is_, has_, have_
+# ForbiddenPrefixes: is_, has_, have_
+# AllowedMethods: is_a?
+# MethodDefinitionMacros: define_method, define_singleton_method
 Naming/PredicateName:
   Exclude:
-    - 'lib/red_amber/vector_functions.rb'
     - 'lib/red_amber/vector.rb'
+    - 'lib/red_amber/vector_functions.rb'
     - 'lib/red_amber/vector_selectable.rb'
 
+# Offense count: 16
+# This cop supports safe autocorrection (--autocorrect).
+Style/OperatorMethodCall:
+  Exclude:
+    - 'test/test_vector_binary_element_wise.rb'
+
 # Necessary to test when range.end == -1
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
 Style/SlicingWithRange:
   Exclude:
     - 'test/test_data_frame_selectable.rb'
 
 # Necessary to Vector < 0 element-wise comparison
+# Offense count: 5
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle, AllowedMethods, AllowedPatterns, IgnoredMethods.
+# SupportedStyles: predicate, comparison
 Style/NumericPredicate:
   Exclude:
     - 'lib/red_amber/data_frame_selectable.rb'

data/.yardopts

@@ -1 +1,3 @@
 --output-dir doc/yard
+--template-path doc/yard-templates
+--use-cache

data/CHANGELOG.md

@@ -1,4 +1,206 @@
-## [0.2.4] - 2022-12-25 (unleleased)
+## [0.4.0] - 2023-02-25
+
+:memo: Update documents for consistency
+
+- Breaking change
+  - Upgrade dependency to Arrow 11.0.0 (#188)
+
+- Bug fixes
+  - Add :force_order option for DataFrame#join (#174)
+  - Return error for empty DataFrame in DataFrame#filter (#172)
+  - Accept ChunkedArray in DataFrame#filter (#172)
+  - Fix Vector#replace to accept Arrow::Array as a replacer (#179)
+  - Fix Vector#round_to_multiple to accept Float or Integer (#180)
+  - Change Vector atan2 to a class method (#180)
+  - Fix Vector#shift when boolean Vector (#184)
+  - Fix processing empty SubFrames (#183)
+  - Do not check object id in DataFrame#rename, #drop for self (#188)
+
+- New features and improvements
+  - Accept a block in DataFrame#filter (#172)
+  - Add Vector.aggregate? method (#175)
+  - Introduce Vector#propagate method (#175)
+  - Add Vector#rank methods (#176)
+  - Add Vector#sample method (#176)
+  - Add Vector#sort method (#176)
+  - Promote DataFrame#shape_str to public (#184)
+  - Introduce Vector#concatenate (#184)
+  - Add #numeric? in refinements of Array (#184)
+  - Add Vector#cumulative_sum_checked and #cumsum (#184)
+  - Add Vector#resolve method (#184)
+  - Add DataFrame#tdra method (#184)
+  - Add #expand as an alias for Vector#propagate (#184)
+  - Add #glimpse as an alias for DataFrame#tdr (#184)
+  - New class SubFrames (#183)
+    - Introduce class SubFrames
+    - Memorize dataframes in SubFrames
+    - Add @frames to memorize sub DataFrames
+    - Accept filters in SubFrames.new
+    - Accept block in SubFrames.new
+    - Add SubFrames.by_filter
+    - Introduce methods creating SubFrames from DataFrame
+    - Introduce SubFrames#each method
+    - Add SubFrames#to_s method
+    - Add SubFrames#concatenate method
+    - Add SubFrames#offset_indices method
+    - SubFrames#aggregate method
+    - Redefine SubFrames#map to return SubFrames
+    - Define SubFrame#map dynamically
+    - Add SubFrames#assign method
+    - Redefine SubFrames#select to return SubFrames
+    - Add SubFrames#reject method
+    - Add SubFrames#filter_map method
+    - Refine DataFrame#indices memorizing @indices
+    - Rename SubFrames#universal_frame as #baseframe
+    - Set Group iteration feature to @api private
+
+- Refactoring
+  - Generate Vector functions in class method (#177)
+  - Set Constant visibility to private (#179)
+  - Separate test_vector_function (#179)
+  - Relocate methods in DataFrameIndexable (#179)
+  - Rename Array refinements to the same name as Vector (#184)
+
+- Improve in tests/CI
+  - Tests
+    - Update benchmarks to set 0.3.0 as a reference (#167)
+    - Move test of Vector#logb to proper location (#180)
+
+  - Cops
+    - Update .rubocop.yml to align with latest cops (#174)
+    - Unify style of MethodCallIndentation as relative to reciever (#184)
+
+  - CI
+    - Fix setting up Arrow by homebrew in CI (#167)
+    - Fix CI error on homebrew deleting python link (#167)
+    - Set cache-version to get new C extensions in CI (#173) Thanks to @kou for suggestion.
+
+- Documentation
+  - Update DataFrame.md about loading csv without headers (#165)
+    - Thanks to kojix2
+  - Update YARD in DataFrame combinable (#168)
+  - Update comment for Ruby 2.7 support in README.md
+  - Update license year
+  - Update README (#172)
+  - Update Vector.md and yardoc in #propagate (#175)
+  - Use customized style sheet for YARD (#179)
+  - Add examples for the doc of #pick and #drop (#179)
+  - Add examples to YARD in DataFrame reshaping methods (#179)
+  - Update documents in DataFrameDisplayable (#179)
+  - Update documents in DataFrameVariableOperation (#179)
+  - Update document for dynamically generated methods (#179)
+  - Unify style in document (#179)
+  - Update documents in DataFrameSelectable (#179)
+  - Update documents of basic Vector methods (#179)
+  - Update document in VectorUpdatable (#179)
+  - Update document of Group (#179)
+  - Update document of DataFrameLoadSave (#180)
+  - Add examples for document of ArrowFunction (#180)
+  - Update document of Vector_unary_aggregation (#180)
+  - Update document of Vector_unary_element_wise (#180)
+  - Update document of Vector_biary_element_wise (#180)
+  - Add documentation to give comparison of dataframes(#169)
+    - Thanks to Benson Muite
+  - Update documents for consistency of method indentation (#189)
+  - Update CHANGELOG (#189)
+  - Update README for 0.4.0 (#189)
+
+- GitHub site
+
+- Thanks
+  - kojix2
+  - Benson Muite
+
+## [0.3.0] - 2022-12-18
+
+- Breaking change
+  - Supported Ruby version has changed from 2.7 to 3.0
+    - Upgrade minimum supported/required version of Ruby from 2.7 to 3.0 (#159, #160)
+
+- Bug fixes
+  - Add check with #key? in DataFrame#method_missing (#140)
+  - Delete unnecessary backslash to supress warning in unary functions (#140)
+  - Fix syntax in code_climate.yml (144)
+  - Temporary disable simplecov test report (#149)
+  - Change Vector#[] to return Array or scalar (#148)
+  - Add missing simplecov HTML formatter (#148)
+  - Change return value of DataFrame#save to self (#160)
+    - Originally reported by kojix2.
+
+- New features and improvements
+  - Update Vector#take to accept block (#148)
+  - Add properties of list Vectors (#148)
+  - Add Vector#split, #split_to_column, #split_to_row (#148)
+  - Add Vector#merge (#148)
+
+- Refactoring
+  - Refactor code (#140)
+    - Add DataFrame.create as a faster constructor
+    - Refactor DataFrame.new using refinements and duck typing
+    - Refactor Vector.new using refinements and duck typing
+    - Add Vector.create as a faster constructor
+    - Refactor Group
+    - Refactor DataFrame#pick/#drop by refininig Array
+    - Refactor DataFrame#pick/#drop
+    - Refactor nil treatment in pick/drop
+    - Refactor DataFrame#pick/#drop using new parser
+    - Refactor DataFrame#[]
+    - Refactor Vector#[], #take, #filter by updating parser
+    - Add for_keys option to parse_args
+    - Refactor Vector properties by refinements for Arrow::Array
+    - Refactor DataFrame selectable using Arrow::Array refinements instead of Vector methods
+    - Refactor DataFrame#assign
+  - Refine error message in DataFrame#to_long/to_wide #143)
+  - Refactor Vector#take/filter returns arrow array (#148)
+  - Change LineLength in cop from 120 to 90 (#152)
+  - Refine DataFrame combinable (join) operations (#159)
+    - Refine DataFrame#join effectively using outputs options
+    - Simplify DataFrame set operations
+
+- Improve in tests/CI
+  - Tests
+    - Update benchmark using 0.2.3 (#138)
+    - Update benchmark basic#02/pick by [] (#140)
+    - Update benchmark contexts and loop_count (#140)
+    - Add benchmark for vector (#140)
+    - Add tests for refinements (#140)
+    - Add benchmark for the series of DataFrame operations (#140)
+    - Add missing test for tdr and dictionary (#140)
+    - Add missing test for group#method with foreign key (#152)
+    - Add missing test for set operations and natural join (#152)
+    - Add missing test for DataFrame#[] with selecting by Array of illegal type' (#152)
+    - Add missing test for DataFrame#assign when assigner size is mismatch (#152)
+    - Accept Hash as join keys in DataFrame join methods (#159)
+
+  - Cops
+    - Refactor/clean rubocop.yml (#138)
+
+  - CI
+    - Support Ruby 3.2 in CI test (#141)
+    - Send test coverage report to Code Climate (#144)
+    - Add test on Fedora (#151)
+      - Thanks to Benson Muite.
+
+    - Add workflow to generate document (#153)
+      - Thanks to kojix2.
+
+    - Support Code Climate test coverage report in CI (#155)
+
+- Documentation
+  - Add YARD in data_frame.rb (#140)
+  - Fix YARD document in the code (#140)
+  - Add Code Climate badges of maintainability and coverage (#144)
+  - Add installation for Fedora in README (#147)
+    - Thanks to Benson Muite.
+
+  - Add Vector#split/merge in Vector.md (#148)
+  - Fix codeclimate badges in README (#155)
+  - Update YARD in DataFrame join methods (#159)
+  - Update jupyter notebook '89 examples of Redamber' (#160)
+
+- Thanks
+  - Benson Muite
+  - kojix2
 
 ## [0.2.3] - 2022-11-16
 

data/Gemfile

@@ -7,7 +7,7 @@ gemspec
 group :test do
   gem 'rake'
 
-  gem 'red-parquet', '~> 10.0.0'
+  gem 'red-parquet', '~> 11.0.0'
   gem 'rover-df', '~> 0.3.0'
 
   gem 'rubocop'
@@ -24,4 +24,5 @@ group :test do
   gem 'red-arrow-numo-narray'
   gem 'red-datasets-arrow'
   gem 'simplecov'
+  gem 'simplecov-json'
 end

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Hirokazu SUZUKI (heronshoes)
+Copyright (c) 2022-2023 Hirokazu SUZUKI (heronshoes)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal