Use GitHub Actions for linting and testing as well as update gemspec

.document

@@ -1,4 +1,5 @@
-README.rdoc
+# Documentation listing for RDoc
+README.md
 lib/**/*.rb
 bin/*
 features/**/*.feature

.editorconfig

@@ -0,0 +1,21 @@
+# Top-level setting to indicate this is the root .editorconfig file
+root = true
+
+# Default settings for all files
+[*]
+# Enforce LF (\n) as the line ending across all files for consistency
+end_of_line = lf
+# Ensure every file ends with a newline
+insert_final_newline = true
+charset = utf-8
+# Use spaces for indentation (as opposed to tabs)
+indent_style = space
+# Set the width of a single indentation level to 2 spaces
+indent_size = 2
+trim_trailing_whitespace = true
+
+# Specific settings for Markdown files
+[*.md]
+# Disable trimming of trailing whitespace in Markdown files,
+# important for Markdown syntax where trailing spaces can be meaningful
+trim_trailing_whitespace = false

.github/workflows/linting.yml

@@ -0,0 +1,30 @@
+name: Linting
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+permissions:
+  contents: read
+
+jobs:
+  linting:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Lint YAML
+        run: yamllint .
+
+      - name: Set up Ruby and install dependencies
+        uses: ruby/setup-ruby@v1
+        with:
+          # uses .ruby-version implicitly
+          bundler-cache: true
+
+      - name: Lint Ruby code
+        run: bundle exec rubocop

.github/workflows/tests.yml

@@ -0,0 +1,43 @@
+name: Tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    strategy:
+      matrix:
+        # test a range of Ruby to ensure gem works
+        # keep ruby until EOL. Read more on https://endoflife.date/ruby
+        ruby-version:
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
+          - head
+        # test distributions up to 4 years
+        runner:
+          - ubuntu-22.04
+          - ubuntu-20.04
+      fail-fast: false # allow contributors understand failure builds
+
+    runs-on: ${{ matrix.runner }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby and install dependencies
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rake spec

.gitignore

@@ -1,23 +1,10 @@
-## MAC OS
+## macOS
 .DS_Store
 
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
+## Project specific
 coverage
 rdoc
 pkg
-
-## PROJECT::SPECIFIC
 *.rbc
 Gemfile.lock
+vendor/

.rubocop.yml

@@ -0,0 +1,140 @@
+# merge the default 'Exclude' key with ours
+inherit_mode:
+  merge:
+    - Exclude
+
+require:
+  - rubocop-rspec
+  - rubocop-minitest
+  - rubocop-packaging
+
+AllCops:
+  NewCops: enable
+  StyleGuideBaseURL: https://rubystyle.guide
+  TargetRubyVersion: 3.0
+  SuggestExtensions: false # reduce noise. consider add rubocop-benchmark
+
+  Exclude:
+    - bin/**/*
+    - tmp/**/*
+
+Bundler/OrderedGems:
+  Include:
+    - '*.gemspec'
+
+# Allow no documentation.
+Style/Documentation:
+  Enabled: false
+
+# Enforce single quotes in the gem
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/HashSyntax:
+  EnforcedStyle: no_mixed_keys # consistent hash syntax
+  EnforcedShorthandSyntax: consistent # enforce explicit hash syntax
+
+# Enforce dots on the next line for multi-line method calls
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+# Project maximum code line length
+Layout/LineLength:
+  Max: 120
+
+Layout/FirstArrayElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Style/SymbolArray:
+  EnforcedStyle: brackets # Prefer brackets
+
+Style/WordArray:
+  EnforcedStyle: brackets # Prefer brackets
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Exclude test files from BlockComments check
+Style/BlockComments:
+  Exclude:
+    - 'test/**/*'
+
+Metrics/ClassLength:
+  Max: 500
+
+Metrics/BlockLength:
+  Max: 50
+  Exclude:
+    # allows longer block for RSpec
+    - spec/**/*.rb
+
+Metrics/AbcSize:
+  Max: 110
+
+Metrics/BlockNesting:
+  Max: 5
+
+Metrics/CyclomaticComplexity:
+  Max: 40
+
+Metrics/MethodLength:
+  Max: 100
+
+Metrics/ModuleLength:
+  Max: 250
+  Exclude:
+    # allows longer block for RSpec
+    - spec/**/*.rb
+    - lib/ffi-icu/lib.rb
+
+Metrics/PerceivedComplexity:
+  Max: 50
+
+RSpec/ExampleLength:
+  Max: 20
+
+RSpec/MultipleExpectations:
+  Max: 10
+
+RSpec/NestedGroups:
+  Max: 5
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/SpecFilePathFormat:
+  Enabled: false
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/NoExpectationExample:
+  Enabled: false
+
+RSpec/MultipleDescribes:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Enabled: false
+
+RSpec/PredicateMatcher:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - lib/ffi-icu.rb

.ruby-version

@@ -0,0 +1 @@
+3.2.3

.yamllint

@@ -0,0 +1,35 @@
+extends: default
+
+locale: en_US.UTF-8
+
+# ignored directories
+ignore: |
+  .git/
+
+rules:
+  octal-values: enable
+
+  document-start: disable
+  document-end: disable
+
+  # allow 120 characters in a line
+  line-length:
+    max: 120
+    level: error
+
+  indentation:
+    spaces: 2
+    indent-sequences: true
+
+  # allow one space indent
+  comments:
+    level: error
+    min-spaces-from-content: 1
+
+  # disallow boolean values to avoid surprise
+  truthy:
+    level: error
+
+    # github workflows uses `on` as trigger
+    ignore: |
+      .github/workflows/*.yml

CHANGELOG.md

@@ -0,0 +1,14 @@
+## [Unreleased](https://github.com/erickguan/ffi-icu/compare/v0.5.3...master) ##
+
+### Added
+
+
+### Changed
+
+- Required Ruby 3.0 and up.
+
+### Fixed
+
+
+### Removed
+

Gemfile

@@ -1,3 +1,12 @@
 source 'https://rubygems.org'
 
 gemspec
+
+group :development, :test do
+  gem 'rake', '>= 12.3.3'
+  gem 'rspec', '~> 3.9'
+  gem 'rubocop', '~> 1.60'
+  gem 'rubocop-minitest', '~> 0.34.5'
+  gem 'rubocop-packaging', '~> 0.5.2'
+  gem 'rubocop-rspec', '~> 2.27'
+end

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2015 Jari Bakken
+Copyright (c) 2010-2024 Jari Bakken
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the