chore(ruby): fix publish step dependency on the build step and add new rubocop workflow. (#593)

* chore(ruby): fix publish step dependency on the build step and add new rubocop workflow.

Author: aakashanandg

.github/workflows/release-ruby-wrapper.yml

@@ -80,7 +80,7 @@ jobs:
   publish:
     name: Package and Publish Gem
     # This job runs only after all 'build' jobs have succeeded
-    needs: build
+    needs: build-shared-library-binaries
     runs-on: ubuntu-latest
 
     # This gives the job permission to publish to RubyGems

.github/workflows/ruby-wrapper-lint.yml

@@ -0,0 +1,31 @@
+# .github/workflows/lint.yml
+
+name: RuboCop Linter
+
+on:
+  push:
+    branches:
+      - main  
+  pull_request:
+    
+jobs:
+  ruby-wrapper-lint:
+    runs-on: ubuntu-latest 
+
+    defaults:
+      run:
+        working-directory: spannerlib/wrappers/spannerlib-ruby
+    
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'       
+          bundler-cache: true 
+          working-directory: spannerlib/wrappers/spannerlib-ruby 
+
+      - name: Run RuboCop
+        run: bundle exec rubocop

spannerlib/wrappers/spannerlib-ruby/Rakefile

@@ -36,14 +36,15 @@ LIB_DIR = File.expand_path("lib/spannerlib", __dir__)
 # The 'ext' is the file extension for the shared library.
 PLATFORMS = {
   "aarch64-darwin" => { goos: "darwin", goarch: "arm64", ext: "dylib" },
-  "x86_64-darwin"  => { goos: "darwin", goarch: "amd64", ext: "dylib" },
-  "aarch64-linux"  => { goos: "linux",  goarch: "arm64", ext: "so" },
-  "x86_64-linux"   => { goos: "linux",  goarch: "amd64", ext: "so" },
-  "x64-mingw32"    => { goos: "windows", goarch: "amd64", ext: "dll" } # For Windows
+  "x86_64-darwin" => { goos: "darwin", goarch: "amd64", ext: "dylib" },
+  "aarch64-linux" => { goos: "linux",  goarch: "arm64", ext: "so" },
+  "x86_64-linux" => { goos: "linux",  goarch: "amd64", ext: "so" },
+  "x64-mingw32" => { goos: "windows", goarch: "amd64", ext: "dll" } # For Windows
 }.freeze
 
 # --- Rake Tasks for Compilation ---
 
+# rubocop:disable Metrics/BlockLength
 # Create a 'compile' namespace for all build tasks
 namespace :compile do
   desc "Remove all compiled native libraries"
@@ -54,8 +55,10 @@ namespace :compile do
       rm_rf target_dir
     end
   end
+  # rubocop:enable Metrics/BlockLength
 
   # Dynamically create a build task for each platform
+  # rubocop:disable Metrics/BlockLength
   PLATFORMS.each do |arch, config|
     desc "Compile native library for #{arch}"
     task arch do
@@ -93,7 +96,7 @@ namespace :compile do
           env["RANLIB"] = ENV.fetch("RANLIB", "x86_64-w64-mingw32-ranlib")
         end
       when "darwin"
-        # Note: cross-compiling darwin/arm64 on an x86 mac runner is NOT reliably supported
+        # NOTE: cross-compiling darwin/arm64 on an x86 mac runner is NOT reliably supported
         # unless you use osxcross or an ARM mac runner. We try nothing here; rely on runner's clang.
         env["CC"] ||= ENV.fetch("CC", "clang")
       end
@@ -114,6 +117,7 @@ namespace :compile do
       puts "Successfully built #{output_file}"
     end
   end
+  # rubocop:enable Metrics/BlockLength
 
   desc "Compile native libraries for all platforms"
   task all: PLATFORMS.keys

spannerlib/wrappers/spannerlib-ruby/lib/spannerlib/ffi.rb

@@ -28,7 +28,7 @@
 module SpannerLib
   extend FFI::Library
 
-  ENV_OVERRIDE = ENV["SPANNERLIB_PATH"]
+  ENV_OVERRIDE = ENV.fetch("SPANNERLIB_PATH", nil)
 
   def self.platform_dir_from_host
     host_os  = RbConfig::CONFIG["host_os"]
@@ -41,15 +41,15 @@ def self.platform_dir_from_host
       host_cpu =~ /arm|aarch64/ ? "aarch64-linux" : "x86_64-linux"
     when /mswin|mingw|cygwin/
       "x64-mingw32"
-    else
-      nil
     end
   end
 
   # Build list of candidate paths (ordered): env override, platform-specific, any packaged lib, system library
+  # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
   def self.library_path
     if ENV_OVERRIDE && !ENV_OVERRIDE.empty?
       return ENV_OVERRIDE if File.file?(ENV_OVERRIDE)
+
       warn "SPANNERLIB_PATH set to #{ENV_OVERRIDE} but file not found"
     end
 
@@ -71,7 +71,9 @@ def self.library_path
       # Attempt to open system lib name; if succeeds, return bare name so ffi_lib can resolve it
       FFI::DynamicLibrary.open("spannerlib", FFI::DynamicLibrary::RTLD_LAZY | FFI::DynamicLibrary::RTLD_GLOBAL)
       return "spannerlib"
-    rescue StandardError
+    rescue LoadError
+      # This is intentional. If the system library fails to load,
+      # we'll proceed to the final LoadError with all search paths.
     end
 
     searched = []
@@ -86,6 +88,7 @@ def self.library_path
       You can set SPANNERLIB_PATH to the absolute path of the library file, or install a platform-specific native gem.
     ERR
   end
+  # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
 
   ffi_lib library_path
 

spannerlib/wrappers/spannerlib-ruby/spannerlib-ruby.gemspec

@@ -29,15 +29,13 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     files = []
     # prefer git-tracked files when available (local dev), but also pick up built files present on disk (CI)
-    if system('git rev-parse --is-inside-work-tree > /dev/null 2>&1')
-      files += `git ls-files -z`.split("\x0")
-    end
+    files += `git ls-files -z`.split("\x0") if system("git rev-parse --is-inside-work-tree > /dev/null 2>&1")
 
     # include any built native libs (CI places them under lib/spannerlib/)
-    files += Dir.glob('lib/spannerlib/**/*').select { |f| File.file?(f) }
+    files += Dir.glob("lib/spannerlib/**/*").select { |f| File.file?(f) }
 
     # dedupe and reject unwanted entries
-    files.map! { |f| f.sub(%r{\A\./}, '') }.uniq!
+    files.map! { |f| f.sub(%r{\A\./}, "") }.uniq!
     files.reject do |f|
       f.match(%r{^(pkg|Gemfile\.lock|.*\.gem|Rakefile|spec/|.*\.o|.*\.h)$})
     end