ecoportal-api-graphql 0.3.13 → 0.3.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84a9f39a8061d4b353f10cfb5e9fd5b2dded406387e60226b6e5bf2bb0d8ed48
-  data.tar.gz: bb50d826e6337eff2003df61040028ebf4e894c6926f99b5a62c77b69250359a
+  metadata.gz: da17c7fff2d84fe5564911fe5a9be5af6200fdd085e681e4547ce900f44315bd
+  data.tar.gz: 622ced495fa4873f4ca3ea72596865c2db9bb78172f80253e0f90e5167b2e89a
 SHA512:
-  metadata.gz: c104b66bc6d0d131d0a7af1db10773517562423db29c79e755358618b135cefc308d603bbefaa3046a132ab99dcd19a077d2e84d5ea5e661099e31b4652a8057
-  data.tar.gz: aca1f93af54014e401bf854afbdcd1692682002ca01b5191c99776cffc2ef1525ce34def3d3da0d154d01b0555410cd15b369b8d37b7d0db3fecc243a85ac0a9
+  metadata.gz: 796f9be5a3c4edd8f400675e45c3138370fe98106d8045f30084b9e39b98264ff939b4152ee05908d987518a04d9989d2131b62655dfac2e2fab45940da560e6
+  data.tar.gz: 444a2be4a632b01ac2c949279fd42ad1a5420f0a14d32f72746ebcd726521ea09da8b6bd16ac30409cef2c8550d368187f6be554b67850426a369a4f57db7ab3

data/.rubocop.yml

@@ -1,12 +1,11 @@
 AllCops:
-  TargetRubyVersion: 2.5.1
+  TargetRubyVersion: 2.7.8
   Exclude:
     - 'config/routes.rb'
+  NewCops: enable
 
-Metrics/LineLength:
-  Enabled: false
 Metrics/BlockLength:
-  ExcludedMethods: [context, describe]
+  CountAsOne: ['array', 'heredoc', 'method_call']
   Max: 50
 Metrics/MethodLength:
   Max: 50
@@ -14,26 +13,51 @@ Metrics/ClassLength:
   Max: 200
 Metrics/AbcSize:
   Max: 30
-
-ParameterLists:
+Metrics/ParameterLists:
   Max: 5
   CountKeywordArgs: false
+Metrics/CyclomaticComplexity:
+  Max: 30
+Metrics/PerceivedComplexity:
+  Max: 30
 
-Style/StringLiterals:
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Style/BlockDelimiters:
+  BracesRequiredMethods: ['log']
+  AllowedMethods: ['proc', 'new']
+  Enabled: false
+Style/ClassAndModuleChildren:
   Enabled: false
 Style/FrozenStringLiteralComment:
   Enabled: false
+Style/StringLiterals:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
 Style/CommentedKeyword:
   Enabled: false
-Style/MultilineBlockChain:
+Layout/LeadingCommentSpace:
   Enabled: false
-Style/Documentation:
+  AllowGemfileRubyComment: true
+Style/MultilineBlockChain:
   Enabled: false
 Style/StringLiteralsInInterpolation:
   Enabled: false
 Style/AndOr:
   Enabled: false
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+Style/FetchEnvVar:
+  Enabled: false
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+  AllowInnerSlashes: true
 
+Layout/LineLength:
+  Enabled: false
 Layout/SpaceInsideHashLiteralBraces:
   Enabled: false
 Layout/SpaceInsideBlockBraces:
@@ -48,8 +72,17 @@ Layout/DotPosition:
   EnforcedStyle: trailing
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
-Layout/IndentHash:
+Layout/FirstHashElementIndentation:
+  Enabled: false
+Layout/EmptyLineAfterGuardClause:
   Enabled: false
 
 Naming/VariableNumber:
   EnforcedStyle: snake_case
+  CheckSymbols: false
+Naming/MethodParameterName:
+  AllowedNames: ['x', 'y', 'i', 'j']
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
+Naming/MethodName:
+  Enabled: false

data/CHANGELOG.md

@@ -12,8 +12,15 @@ All notable changes to this project will be documented in this file.
 ## [0.3.14] - 2024-02-xx
 
 ### Added
+  - some benchmarking on
+    1. core graphql base `query`
+  - `#parent_id` to location node model
+
 ### Changed
+  - upgraded `ecoportal-v2-api` gem
+
 ### Fixed
+  - Optimized `treeify` and locations structure class
 
 ## [0.3.13] - 2024-02-03
 

data/README.md

@@ -18,3 +18,7 @@ And then execute:
 Or install it yourself as:
 
     $ gem install ecoportal-api-graphql
+
+## Changelog
+
+See {file:CHANGELOG.md} for a list of changes.

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'rubocop/rake_task'
 require "yard"
 require "redcarpet"
 
@@ -10,11 +11,18 @@ desc "run rspec showing backtrace"
 RSpec::Core::RakeTask.new(:spec_trace) do |task|
   task.rspec_opts = ['--backtrace']
 end
+task :rspec_trace => :spec_trace
 
 desc "run rspec stopping on first fail, and show backtrace"
 RSpec::Core::RakeTask.new(:spec_fast) do |task|
   task.rspec_opts = ['--fail-fast', '--backtrace']
 end
+task :rspec_fast  => :spec_fast
+
+desc "run rubocop diaplying cop names"
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--display-cop-names']
+end
 
 # default task name is yard
 desc "Yard: generate all the documentation"
@@ -22,6 +30,9 @@ YARD::Rake::YardocTask.new(:doc) do |t|
   #t.files = ['lib/**/*.rb']
 end
 
-task :default     => [:spec]
-task :rspec_trace => :spec_trace
-task :rspec_fast  => :spec_fast
+desc "default task: runs rubocop and rspec"
+task :default do
+  Rake::Task[:rubocop].invoke
+ensure
+  Rake::Task[:spec].invoke
+end

data/ecoportal-api-graphql.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://www.ecoportal.com"
   spec.licenses      = %w[MIT]
 
-  spec.required_ruby_version = '>= 2.6.0'
+  spec.required_ruby_version = '>= 2.7.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -29,6 +29,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "redcarpet", ">= 3.6.0",  "< 4"
   spec.add_development_dependency "pry"      , ">= 0.14"
 
-  spec.add_dependency 'ecoportal-api-v2', '>= 1.1.5', '< 1.2'
+  spec.add_dependency 'ecoportal-api-v2', '>= 1.1.7', '< 1.2'
   spec.add_dependency 'graphlient',       '>= 0.8.0', '< 0.9'
 end

data/lib/ecoportal/api/graphql/base/location_structure.rb

@@ -3,6 +3,7 @@ module Ecoportal
     class GraphQL
       module Base
         class LocationStructure < Ecoportal::API::GraphQL::Base::Model
+          read_only!
           extend Ecoportal::API::GraphQL::Helpers::LocationsTree
 
           passkey :id

data/lib/ecoportal/api/graphql/fragment/action.rb

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       class Fragment
-        fragment :Action, <<~'GRAPHQL'
+        fragment :Action, <<~GRAPHQL
           fragment on Action {
             id
             altId

data/lib/ecoportal/api/graphql/fragment/contractor_entity.rb

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       class Fragment
-        fragment :ContractorEntity, <<~'GRAPHQL'
+        fragment :ContractorEntity, <<~GRAPHQL
           fragment on ContractorEntity {
             id
             name

data/lib/ecoportal/api/graphql/fragment/location_node.rb

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       class Fragment
-        fragment :LocationNode, <<~'GRAPHQL'
+        fragment :LocationNode, <<~GRAPHQL
           fragment on LocationNodeInterface {
             id
             name

data/lib/ecoportal/api/graphql/fragment/pagination.rb

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class GraphQL
       class Fragment
-        fragment :Pagination, <<~'GRAPHQL'
+        fragment :Pagination, <<~GRAPHQL
           fragment on ActionConnection {
             totalCount
             pageInfo {

data/lib/ecoportal/api/graphql/helpers/locations_tree.rb

@@ -3,11 +3,11 @@ module Ecoportal
     class GraphQL
       module Helpers
         module LocationsTree
+          RELEVANT_NODES_COUNT = 1000
+
           def treeify(nodes)
-            parents = nodes.each_with_object({}) do |node, parents|
-              parent   = node.parent
-              parentId = parent && parent.id.upcase
-              (parents[parentId] ||= []).push(node)
+            parents = nodes.each_with_object({}) do |node, out|
+              (out[node.parent_id_upcase] ||= []).push(node)
             end
             get_children(nil, parents)
           end
@@ -21,15 +21,15 @@ module Ecoportal
               class_names = class_types.map(&:name)
 
               results << {
-                "id"        => child.id,
-                "name"      => child.name,
-                "weight"    => child.weight,
-                "parent_id" => node_id,
-                "archived"  => child.archived,
+                "id"                   => child.id,
+                "name"                 => child.name,
+                "weight"               => child.weight,
+                "parent_id"            => node_id,
+                "archived"             => child.archived,
                 "archived_token"       => child.archivedToken,
                 "classifications"      => class_ids,
                 "classification_names" => class_names,
-                "nodes"    => get_children(child.id, parents).compact
+                "nodes"                => get_children(child.id, parents).compact
               }
             end
           end

data/lib/ecoportal/api/graphql/logic/base_query.rb

@@ -19,7 +19,7 @@ module Ecoportal
                 param_defaults[key] = default unless default == :unused
               end
 
-              @accepted_params.push(*keys).tap {|ks| ks.uniq!}
+              @accepted_params.push(*keys).tap(&:uniq!)
               @accepted_params
             end
 
@@ -41,6 +41,8 @@ module Ecoportal
             end
           end
 
+          include Ecoportal::API::Common::Concerns::Benchmarkable
+
           attr_reader :client
           attr_reader :base_path
 
@@ -53,7 +55,7 @@ module Ecoportal
           # Resolves the `path` by using `path` or `base_path` + `class.field_name`.
           def path(field_name = self.class.field_name)
             result   = @path
-            result ||= default_path if self.respond_to?(:default_path, true)
+            result ||= default_path if respond_to?(:default_path, true)
             result ||= (base_path + [field_name]) if base_path && field_name
             result
           end
@@ -61,7 +63,9 @@ module Ecoportal
           # Query rely that manages the different blocks.
           # @return [Class] an object of `response_class` with the results hanging from `path`.
           def query(path: self.path, **kargs, &block)
-            graphql_query(path: path, **kargs, &basic_block(&block))
+            benchmarking("#{self.class}##{__method__}", print: true) do
+              graphql_query(path: path, **kargs, &basic_block(&block))
+            end
           end
 
           def response_class
@@ -84,7 +88,7 @@ module Ecoportal
             request(*path) do
               raw_response[:data] = client.query(query_params, &block)
             end
-          rescue Faraday::ParsingError, Graphlient::Errors::GraphQLError => e
+          rescue Faraday::ParsingError, Graphlient::Errors::GraphQLError => _err
             puts "Internal Error with these params:"
             pp kargs
             pp block
@@ -97,7 +101,10 @@ module Ecoportal
           end
 
           def wrap_response(response, path = [])
-            raise "Complete failure on request. Path: #{path}\n#{response.to_h.pretty_inspect}" unless res = response.to_h.dig(*path.dup.unshift("data"))
+            unless (res = response.to_h.dig(*path.dup.unshift("data")))
+              msg = "Complete failure on request. Path: #{path}\n#{response.to_h.pretty_inspect}"
+              raise msg
+            end
             data = Ecoportal::API::Common::GraphQL::HashHelpers.deep_dup(res)
             response_class.new(data)
           end

data/lib/ecoportal/api/graphql/logic/connection.rb

@@ -4,7 +4,7 @@ module Ecoportal
       module Logic
         class Connection < Ecoportal::API::GraphQL::Base::Model
           class GenericNode
-            def initialize(*args, **kargs)
+            def initialize(*_args, **_kargs)
               raise "Missuse error. You should define a node_class for a class that inherits from GraphqlConnection class."
             end
           end

data/lib/ecoportal/api/graphql/logic/mutation.rb

@@ -4,12 +4,13 @@ module Ecoportal
       module Logic
         class Mutation < Ecoportal::API::GraphQL::Logic::BaseQuery
           class GenericPayload
-            def initialize(*args, **kargs)
+            def initialize(*_args, **_kargs)
               raise "Missuse error. You should define a payload_class for a class that inherits from Mutation class."
             end
           end
+
           class GenericInput
-            def initialize(*args, **kargs)
+            def initialize(*_args, **_kargs)
               raise "Missuse error. You should define a input_class for a class that inherits from Mutation class."
             end
           end
@@ -23,7 +24,7 @@ module Ecoportal
             request(*path) do
               client.query(input: as_input(input), &basic_block(&block))
             end
-          rescue Faraday::ParsingError, Graphlient::Errors::FaradayServerError => e
+          rescue Faraday::ParsingError, Graphlient::Errors::FaradayServerError => _err
             puts "Internal Error with these input ('#{input.class}'):"
             pp input
             raise
@@ -43,13 +44,13 @@ module Ecoportal
               value
             when Ecoportal::API::GraphQL::Base::Model
               value.as_input
-            when Hash
-              value = Helpers::Model::HashKeys.keys_to_sym_deep(value)
-              Ecoportal::API::Base::Model.as_input(value)
+            # when Hash
+            #   value = Helpers::Model::HashKeys.keys_to_sym_deep(value)
+            #   Ecoportal::API::Base::Model.as_input(value)
             when Enumerable
               value.map {|v| as_input(v)}
             else
-              raise ArgumentError.new("Expecting Hash, GraphQL::Base::Model or Enumerable. Unsupported type '#{value.class}'.")
+              raise ArgumentError, "Expecting Hash, GraphQL::Base::Model or Enumerable. Unsupported type '#{value.class}'."
             end
           end
         end

data/lib/ecoportal/api/graphql/logic/payload.rb

@@ -4,7 +4,7 @@ module Ecoportal
       module Logic
         class Payload < Ecoportal::API::GraphQL::Base::Model
           class GenericItem
-            def initialize(*args, **kargs)
+            def initialize(*_args, **_kargs)
               raise "Missuse error. You should define a item_class for a class that inherits from GraphqlPayload class."
             end
           end

data/lib/ecoportal/api/graphql/logic/query.rb

@@ -4,7 +4,7 @@ module Ecoportal
       module Logic
         class Query < Ecoportal::API::GraphQL::Logic::BaseQuery
           class GenericItem
-            def initialize(*args, **kargs)
+            def initialize(*_args, **_kargs)
               raise "Missuse error. You should define a item_class for a class that inherits from Query class."
             end
           end

data/lib/ecoportal/api/graphql/logic/query_array.rb

@@ -6,7 +6,7 @@ module Ecoportal
           include Enumerable
 
           def each(item_block: nil, **kargs, &block)
-            return to_enum(:each, **kargs, item_block: connection_block) unless block
+            return to_enum(:each, item_block: connection_block, **kargs) unless block
             query(**kargs, &item_block).each do |item|
               yield(item) if block_given?
             end

data/lib/ecoportal/api/graphql/logic/query_connection.rb

@@ -8,16 +8,14 @@ module Ecoportal
 
           def each(connection_block: nil, **kargs, &block)
             return to_enum(:each, **kargs, connection_block: connection_block) unless block
-            cursor = nil; results = 0
+            cursor = nil
             loop do
               kargs.update(after: cursor) if cursor
               connection = query(**kargs, &connection_block)
               #total    = connection.totalCount
-              pageInfo = connection.pageInfo
-              connection.nodes.each do |item|
-                yield item
-              end
-              break unless cursor = pageInfo.endCursor
+              page_info = connection.pageInfo
+              connection.nodes.each(&block)
+              break unless (cursor = page_info.endCursor)
             end
           end
 
@@ -25,7 +23,7 @@ module Ecoportal
             return connection_class if respond_to?(:connection_class)
             @response_class ||= self.class.new_class(
               item_class,
-              inherits: Ecoportal::API::GraphQL::Logic::Connection,
+              inherits:  Ecoportal::API::GraphQL::Logic::Connection,
               namespace: "Ecoportal::API::GraphQL::Connection"
             ) do |klass|
               klass.item_class = item_class

data/lib/ecoportal/api/graphql/model/location_node.rb

@@ -5,6 +5,15 @@ module Ecoportal
         class LocationNode < Ecoportal::API::GraphQL::Base::LocationNode
           embeds_one :parent, klass: Model::LocationNode, nullable: true
           embeds_many :ancestors, klass: Model::LocationNode
+
+          def parentId
+            parent&.id
+          end
+          alias_method :parent_id, :parentId
+
+          def parent_id_upcase
+            parent_id&.upcase
+          end
         end
       end
     end

data/lib/ecoportal/api/graphql/mutation/location_structure/apply_commands.rb

@@ -12,7 +12,7 @@ module Ecoportal
 
             def basic_block(&block)
               payload_block = block || default_payload_block
-              Proc.new {
+              proc {
                 mutation(input: :ApplyCommandsToLocationStructureInput!) {
                   applyCommandsToLocationStructure(input: :input, &payload_block)
                 }
@@ -20,32 +20,32 @@ module Ecoportal
             end
 
             def default_payload_block
-              Proc.new {
+              proc {
                 clientMutationId
                 error {
-            			message
-            			conflictingIds
-            			validationErrors {
-            				error
-            				message
-            			}
-            		}
-            		results {
-            			command {
-            				id
-            				state
+                  message
+                  conflictingIds
+                  validationErrors {
+                    error
+                    message
+                  }
+                }
+                results {
+                  command {
+                    id
+                    state
                     __typename
-            			}
-            			ok
-            			error {
-            				conflictingIds
-            				message
-            				validationErrors {
-            					error
-            					message
-            				}
-            			}
-            		}
+                  }
+                  ok
+                  error {
+                    conflictingIds
+                    message
+                    validationErrors {
+                      error
+                      message
+                    }
+                  }
+                }
                 structure {
                   nodes(includeArchived: true) {
                     ___Ecoportal__API__GraphQL__Fragment__LocationNode

data/lib/ecoportal/api/graphql/query/location_structure.rb

@@ -14,7 +14,7 @@ module Ecoportal
 
           def basic_block(&block)
             final_block = block || default_query_block
-            Proc.new {
+            proc {
               query(id: :id!, includeArchivedNodes: :boolean) {
                 currentOrganization {
                   locations {
@@ -29,7 +29,7 @@ module Ecoportal
           # @note this is on purpose, as via API
           #   there isn't much sense in not including archived nodes.
           def default_query_block
-            Proc.new {
+            proc {
               id
               name
               archived

data/lib/ecoportal/api/graphql/query/location_structures.rb

@@ -5,7 +5,7 @@ module Ecoportal
         class LocationStructures < Ecoportal::API::GraphQL::Logic::QueryArray
           accepted_params :includeArchived, :includeUnpublished, default: false
           accepted_params :includeArchivedNodes, default: true
-          
+
           field_name :structures
 
           class_resolver :item_class, Ecoportal::API::GraphQL::Model::LocationStructure
@@ -14,7 +14,7 @@ module Ecoportal
 
           def basic_block(&block)
             final_block = block || default_query_block
-            Proc.new {
+            proc {
               query(includeArchived: :boolean,
                     includeUnpublished: :boolean,
                     includeArchivedNodes: :boolean
@@ -36,7 +36,7 @@ module Ecoportal
           # @note this is on purpose, as via API
           #   there isn't much sense in not including archived nodes.
           def default_query_block
-            Proc.new {
+            proc {
               id
               name
               archived

data/lib/ecoportal/api/graphql_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GRAPQL_VERSION = "0.3.13"
+    GRAPQL_VERSION = "0.3.14"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-graphql
 version: !ruby/object:Gem::Version
-  version: 0.3.13
+  version: 0.3.14
 platform: ruby
 authors:
 - Oscar Segura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-02 00:00:00.000000000 Z
+date: 2024-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,7 +130,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: 1.1.7
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.2'
@@ -140,7 +140,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: 1.1.7
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.2'
@@ -174,7 +174,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
@@ -325,7 +324,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.16.1