add rubocop, github action

Author: patodevilla

.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: Test
+
+on: [pull_request]
+
+# permissions:
+#   contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    # env:
+    #   BUNDLE_ONLY: rubocop
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Ruby 3.2.2
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.2.2
+        bundler-cache: true
+
+    - name: Run Tests
+      run: bundle exec rubocop --parallel
+      # run: bundle exec rake

.rspec

@@ -0,0 +1,12 @@
+###########################################################
+#################### Rubocop Minitest #####################
+###########################################################
+
+Minitest/AssertTruthy:
+  Enabled: false
+
+Minitest/RefuteFalse:
+  Enabled: false
+
+Minitest/MultipleAssertions:
+  Max: 4

.rubocop-minitest.yml

@@ -0,0 +1,58 @@
+# see example at https://gist.github.com/jhass/a5ae80d87f18e53e7b56
+
+# <% unless ENV['BYPASS_RUBOCOP_TODO'] %>
+# inherit_from:
+# <% else %>
+# inherit_from:
+#   - '.rubocop-todo.yml'
+# <% end %>
+
+inherit_from:
+  - .rubocop_todo.yml
+  - .rubocop-minitest.yml
+
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+  # TargetRubyVersion: 2.7.8
+  # TargetRailsVersion: 6.1.4
+  # Exclude:
+  #   - 'Gemfile.lock'
+
+Naming/VariableNumber:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines_special
+  Enabled: false
+
+Layout/TrailingEmptyLines:
+  Enabled: false
+  EnforcedStyle: final_blank_line
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/VariableName:
+  Enabled: false
+
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+Metrics/ParameterLists:
+  Enabled: false 

.rubocop.yml

@@ -0,0 +1,94 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-03-15 19:54:30 UTC using RuboCop version 1.62.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Layout/ElseAlignment:
+  Exclude:
+    - 'lib/kibana/api/namespace/saved_object.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyleAlignWith, Severity.
+# SupportedStylesAlignWith: keyword, variable, start_of_line
+Layout/EndAlignment:
+  Exclude:
+    - 'lib/kibana/api/namespace/saved_object.rb'
+    - 'lib/kibana/dashboard.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AutoCorrect, AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/kibana/dashboard.rb'
+
+# Offense count: 7
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 57
+
+# Offense count: 3
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 220
+
+# Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 25
+
+# Offense count: 14
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 50
+
+# Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 23
+
+# Offense count: 1
+Naming/AccessorMethodName:
+  Exclude:
+    - 'lib/kibana/api/namespace/space.rb'
+
+# Offense count: 17
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/kibana.rb'
+    - 'lib/kibana/api.rb'
+    - 'lib/kibana/api/base_client.rb'
+    - 'lib/kibana/api/namespace/canvas.rb'
+    - 'lib/kibana/api/namespace/features.rb'
+    - 'lib/kibana/api/namespace/role.rb'
+    - 'lib/kibana/api/namespace/saved_object.rb'
+    - 'lib/kibana/api/namespace/space.rb'
+    - 'lib/kibana/api/spaceable.rb'
+    - 'lib/kibana/transport.rb'
+    - 'lib/kibana/transport/client.rb'
+    - 'lib/kibana/utils.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: InverseMethods, InverseBlocks.
+Style/InverseMethods:
+  Exclude:
+    - 'lib/kibana/dashboard.rb'
+
+# Offense count: 3
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle, AllowedMethods, AllowedPatterns.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/kibana/dashboard.rb'

.rubocop_todo.yml

@@ -1,6 +1,21 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in kibana.gemspec
 gemspec
+
+# gem 'bundler', '2.4.22'
+gem 'debug', '>= 1.0.0'
+gem 'minitest', '~> 5.14'
+gem 'minitest-reporters', '~> 1.6'
+gem 'rake', '~> 13.1'
+gem 'super_hash', '0.3.2', git: 'https://github.com/prysmex/super_hash.git'
+
+# rubocop
+gem 'rubocop', '~> 1.62'
+gem 'rubocop-minitest', '~> 0.35'
+gem 'rubocop-performance', '~> 1.20'
+gem 'rubocop-rake', '~> 0.6'

.travis.yml

@@ -1,11 +1,18 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
 
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList["test/**/*_spec.rb"]
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
   t.verbose = true
   t.warning = true
+  t.libs << 'test'
+  # t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

Gemfile

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "kibana"
+require 'bundler/setup'
+require 'kibana'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "kibana"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

Rakefile

@@ -1,47 +1,37 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "kibana/version"
+require_relative 'lib/kibana/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "kibana"
+  spec.name          = 'kibana'
   spec.version       = Kibana::VERSION
-  spec.authors       = ["victor-aguilars"]
-  spec.email         = ["victor.aguilarsnz@gmail.com"]
+  spec.authors       = ['victor-aguilars']
+  spec.email         = ['victor.aguilarsnz@gmail.com']
 
   spec.summary       = 'Ruby API for Kibana.'
   spec.description   = 'Ruby API for Kibana.'
   # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
-  # spec.license       = "MIT"
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.1.0'
 
-  # # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # # to allow pushing to a single host or delete this section to allow pushing to any host.
-  # if spec.respond_to?(:metadata)
-  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
-
-  #   spec.metadata["homepage_uri"] = spec.homepage
-  #   spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-  #   spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
-  # else
-  #   raise "RubyGems 2.0 or newer is required to protect against " \
-  #     "public gem pushes."
-  # end
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "2.4.22"
-  spec.add_development_dependency "rake", "~> 13.1"
-  spec.add_development_dependency "debug", ">= 1.0.0"
-  spec.add_development_dependency "minitest", "~> 5.14"
-  spec.add_development_dependency "minitest-reporters", "~> 1.6"
-  spec.add_dependency "activesupport", '~> 6'
+  spec.add_dependency 'activesupport', '~> 6'
   spec.add_dependency 'faraday', '~> 2'
   spec.add_dependency 'faraday-multipart'
   spec.add_dependency 'oj', '~> 3'

bin/console

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support'
 require 'active_support/all'
 require 'faraday'

kibana_api.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'api/base_client'
 require_relative 'api/spaceable'
 require_relative 'api/namespace/canvas'

lib/kibana.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Kibana
   module API
     class BaseClient
@@ -9,16 +11,16 @@ def initialize(client)
       end
 
       private
-      
+
       # delegate
-      def request(**args, &block)
-        client.request(**args, &block)
+      def request(**args, &)
+        client.request(**args, &)
       end
 
       def symbolize_keys(object)
-        object.transform_keys{|k| k.to_sym}
+        object.transform_keys(&:to_sym)
       end
-      
+
     end
   end
 end