cppjieba_rb 0.4.2 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0307422c11b4c5b703e3017990e706e242e56f062eca887a0445e3b5b3c20bcc
-  data.tar.gz: 2b0fb44719d6a0614ceadb99bfd7a49b7a814dc81acd2900897230f6167e7ec1
+  metadata.gz: c764f86e12cb63776f9dd2b2ce8b0704de2a766dbb43a361808aec12425c20a9
+  data.tar.gz: f0d87212f847cba89b41dfbaa44f82acc61b34cae18b65ef2e44b8baa2c4462b
 SHA512:
-  metadata.gz: b642ca8a5afc99e45fb18bcafd06bf4d24a6ea6c5b7e5b5dffa2a76e61418e0f170cf7a8a61c911c8ab035ca71f810100eafbdf7390347d0466f9f7b39f62d99
-  data.tar.gz: dcbf422afc0d0c85e5db5ed25c90dedff46767d9a6f3c52250f256584ef082437718da0c921c1291e2c1623944529ebd11c80b8e6247c84ee27b2febffaea8ef
+  metadata.gz: f2ce849f65fd618b3cb62833de4c43f0771985f2282df99dc10ae61261c92ba13391b7725ce452a1e5a5519cc4477e349e38e5f443d52bd17bc17a278acbcf21
+  data.tar.gz: 56660f21c9981bdd7180337674435b9c56d0238187c445ffd2b8146c750da6d319b94d8834ab47c5230d9b8726aac907409ceaeaf870302921cd5ada78331b50

data/.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

data/.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

data/.github/workflows/release.yml

@@ -0,0 +1,42 @@
+name: Release
+
+on:
+  workflow_dispatch: # allow repo collaborators to publish gem
+
+permissions:
+  contents: write # required for `rake release` to push the release tag
+  id-token: write # required for workflow to publish gem
+
+jobs:
+  release:
+    if: github.ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive # cppjieba requires a vendor library in a submodule
+
+      # required to run `rake release`.
+      - name: Setup Ruby and install dependencies
+        uses: ruby/setup-ruby@v1
+        with:
+          # setup-ruby implicitly uses .ruby-version
+          bundler-cache: true
+
+      # Run `rake release` to create git tag and push to repository based on `lib/cppjieba_rb/version.rb`.
+      # Then publish the new gem via trusted publishing
+      # Read more on https://guides.rubygems.org/trusted-publishing/releasing-gems/
+      - name: Publish gem
+        uses: rubygems/release-gem@v1
+
+      - name: Create GitHub Release
+        run: |
+          VERSION="v$(bundle exec rake version)"
+
+          gh release create \
+            $VERSION \
+            --verify-tag \
+            --generate-notes \
+            --latest

data/.github/workflows/tests.yml

@@ -0,0 +1,47 @@
+name: Tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    strategy:
+      matrix:
+        # Tests a range of Ruby to ensure the gem works.
+        # Keeps 2.7 for a while but support EOL Ruby for a year in general
+        # Read more about Ruby EOL date on https://endoflife.date/ruby
+        ruby-version:
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
+          - head
+        # test distributions up to 4 years
+        runner:
+          - ubuntu-latest
+          - ubuntu-20.04
+      fail-fast: false # allow contributors understand failure builds
+
+    runs-on: ${{ matrix.runner }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive # cppjieba requires a vendor library in a submodule
+
+      - 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 test

data/.gitignore

@@ -9,6 +9,7 @@ _yardoc
 coverage
 doc/
 lib/bundler/man
+*.so
 *.bundle
 pkg
 rdoc

data/.rubocop.yml

@@ -0,0 +1,45 @@
+# merge the default 'Exclude' key with ours
+inherit_mode:
+  merge:
+    - Exclude
+
+require:
+  - rubocop-minitest
+  - rubocop-performance
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+  StyleGuideBaseURL: https://rubystyle.guide
+  TargetRubyVersion: 2.7
+  SuggestExtensions: false
+
+  Exclude:
+    - bin/**/*
+    - tmp/**/*
+
+Bundler/OrderedGems:
+  Include:
+    - '*.gemspec'
+
+
+# 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
+
+# Project maximum code line length
+Layout/LineLength:
+  Max: 120
+
+# Exclude test files from BlockComments check
+Style/BlockComments:
+  Exclude:
+    - 'test/**/*'
+
+Metrics/MethodLength:
+  Max: 100

data/.ruby-version

@@ -0,0 +1 @@
+3.3

data/.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

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+## [0.4.3](https://github.com/erickguan/cppjieba_rb/compare/v0.4.2...v0.4.4) ##
+
+### Added
+
+- Linting with rubocop.
+
+### Changed
+
+- Requires Ruby 2.7.
+- Update `cppjieba` to `v5.3.2`. `cppejieba` supports more compliers. But no functions changes.
+- Testing with GitHub Action.
+- Releases and publishes the gem with Trust Publishing on GitHub Action.
+
+### Fixed
+
+
+### Removed

data/Gemfile

@@ -1,3 +1,14 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'rubocop', '~> 1.66.1', require: false
+gem 'rubocop-minitest', '~> 0.36.0', require: false
+gem 'rubocop-performance', '~> 1.22.1', require: false
+gem 'rubocop-rake', '~> 0.6.0', require: false
+
+gem 'minitest', '~> 5.14'
+gem 'rake', '~> 13'
+gem 'rake-compiler', '~> 1.1'

data/README.md

@@ -2,10 +2,6 @@
 
 [![Gem Version](https://badge.fury.io/rb/cppjieba_rb.svg)](http://badge.fury.io/rb/cppjieba_rb)
 
-[![Build Status](https://travis-ci.com/erickguan/cppjieba_rb.svg?branch=master)](https://travis-ci.com/erickguan/cppjieba_rb)
-
-[![Patreon](https://img.shields.io/badge/back_on-patreon-red.svg)](https://www.patreon.com/fantasticfears)
-
 Ruby bindings for [Cppjieba](https://github.com/yanyiwu/cppjieba). C++11 required. (gcc 4.8+)
 
 The TRIE tree has high memory usage. For default dict, it uses ~120 MB memory.
@@ -14,7 +10,11 @@ The TRIE tree has high memory usage. For default dict, it uses ~120 MB memory.
 
 Add this line to your application's Gemfile:
 
-    gem 'cppjieba_rb'
+    gem 'cppjieba_rb', require: false
+
+Or pin a version:
+
+    gem 'cppjieba_rb', '~> 0.4.2', require: false
 
 Or install it as:
 

data/Rakefile

@@ -1,9 +1,11 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'rake/extensiontask'
 
-gem = Gem::Specification.load(File.dirname(__FILE__) + '/cppjieba_rb.gemspec')
-Rake::ExtensionTask.new("cppjieba_rb", gem) do |ext|
+gem = Gem::Specification.load("#{File.dirname(__FILE__)}/cppjieba_rb.gemspec")
+Rake::ExtensionTask.new('cppjieba_rb', gem) do |ext|
   ext.lib_dir = File.join('lib', 'cppjieba_rb')
 end
 
@@ -12,9 +14,16 @@ Rake::Task[:test].prerequisites << :compile
 Rake::TestTask.new do |t|
   t.libs << 'test'
 end
-desc "clean compile files"
+
+desc 'clean compile files'
 task :clean_compile do
-  system "rm -r tmp"
-  system "rm lib/*.bundle"
+  system 'rm -r tmp'
+  system 'rm lib/*.bundle'
+end
+
+task default: :test
+
+desc 'report gem version'
+task :version do
+  print CppjiebaRb::VERSION
 end
-task :default => :test

data/cppjieba_rb.gemspec

@@ -1,50 +1,63 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cppjieba_rb/version'
 
+# Recursive function to handle submodules and their submodules
+def collect_submodule_files(spec, relative_path, submodule_dir)
+  Dir.chdir(submodule_dir) do
+    submodule_relative_path = submodule_dir.gsub(relative_path, '')
+
+    # Get all files in the current submodule
+    submodule_files = `git ls-files -z`.split("\x0")
+    submodule_files.each do |file|
+      # Add the relative submodule path to each file
+      spec.files << File.join(submodule_relative_path, file)
+    end
+
+    # Recurse into any submodules of the current submodule
+    nested_submodules = `git submodule foreach --quiet pwd`.split("\n")
+    nested_submodules.each do |nested_submodule_path|
+      if (ENV['OS'] == 'Windows_NT') && nested_submodule_path.start_with?('/')
+        # Handle cygwin-style paths on Windows
+        nested_submodule_path = nested_submodule_path[1..] # Remove leading slash
+        nested_submodule_path.insert(1, ':') # Add drive letter (e.g., C:)
+      end
+      collect_submodule_files(spec, relative_path, nested_submodule_path)
+    end
+  end
+end
+
 Gem::Specification.new do |spec|
   spec.name          = 'cppjieba_rb'
   spec.version       = CppjiebaRb::VERSION
   spec.authors       = ['Erick Guan']
-  spec.email         = ['fantasticfears@gmail.com']
+  spec.email         = ['erickguanst@gmail.com']
   spec.summary       = 'cppjieba binding for ruby'
   spec.description   = 'cppjieba binding for ruby. Mainly used by Discourse.'
-  spec.homepage = 'https://github.com/fantasticfears/cppjieba_rb'
-  spec.required_ruby_version = '>=2.3.0'
-  spec.license       = 'MIT'
+  spec.homepage = 'https://github.com/erickguan/cppjieba_rb'
+  spec.required_ruby_version = '>=2.7.0'
+  spec.license = 'MIT'
   spec.extensions = ['ext/cppjieba_rb/extconf.rb']
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  relative_path = File.expand_path('../', __FILE__) + '/'
-  `git submodule --quiet foreach pwd`.split($\).each do |submodule_path|
-    if (ENV['OS'] == 'Windows_NT') && submodule_path[0] == '/'
-      # Detect if cygwin path is being used by git
-      submodule_path = submodule_path[1..-1]
-      submodule_path.insert(1, ':')
-    end
-    # for each submodule, change working directory to that submodule
-    Dir.chdir(submodule_path) do
-      # Make the submodule path relative
-      submodule_path = submodule_path.gsub(/#{relative_path}/i, '')
-      # issue git ls-files in submodule's directory
-      submodule_files = `git ls-files -z`.split("\x0")
-
-      # prepend the submodule path to create relative file paths
-      submodule_files_paths = submodule_files.map do |filename|
-        File.join(submodule_path, filename)
-      end
-      # add relative paths to gem.files
-      spec.files += submodule_files_paths
+  spec.files = `git ls-files -z`.split("\x0")
+  relative_path = "#{File.expand_path(__dir__)}/"
+
+  # Collect files from all submodules recursively
+  submodules = `git submodule foreach --quiet pwd`.split("\n")
+  submodules.each do |submodule_path|
+    if (ENV['OS'] == 'Windows_NT') && submodule_path.start_with?('/')
+      # Handle cygwin-style paths on Windows
+      submodule_path = submodule_path[1..] # Remove leading slash
+      submodule_path.insert(1, ':') # Add drive letter (e.g., C:)
     end
+
+    collect_submodule_files(spec, relative_path, submodule_path)
   end
 
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
+  spec.require_paths = ['lib'] # to pick up the compiled shared library.
 
-  spec.add_development_dependency 'bundler', '~> 2.2', '>= 2.2.10'
-  spec.add_development_dependency 'rake', '~> 13'
-  spec.add_development_dependency 'rake-compiler', '~> 1.1'
-  spec.add_development_dependency 'minitest', '~> 5.14'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/ext/cppjieba/.github/workflows/cmake.yml

@@ -0,0 +1,52 @@
+name: CMake
+
+on:
+  push:
+  pull_request:
+
+env:
+  # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
+  BUILD_TYPE: Release
+
+jobs:
+  build:
+    # The CMake configure and build commands are platform agnostic and should work equally well on Windows or Mac.
+    # You can convert this to a matrix build if you need cross-platform coverage.
+    # See: https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [
+          ubuntu-20.04, 
+          ubuntu-22.04, 
+          macos-12,
+          macos-13,
+          macos-14,
+          windows-2019,
+          windows-2022,
+        ]  
+        cpp_version: [11, 14, 17, 20]
+
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v2
+        with:
+            submodules: recursive
+
+      - name: Configure CMake
+        # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.
+        # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
+        # run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
+        run: cmake -B ${{github.workspace}}/build -DBUILD_TESTING=ON -DCMAKE_CXX_STANDARD=${{matrix.cpp_version}} -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
+
+      - name: Build
+        # Build your program with the given configuration
+        # run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
+        run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
+
+      - name: Test
+        working-directory: ${{github.workspace}}/build
+        # Execute tests defined by the CMake configuration.  
+        # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
+        run: ctest -C ${{env.BUILD_TYPE}}
+      

data/ext/cppjieba/.github/workflows/stale-issues.yml

@@ -0,0 +1,24 @@
+name: Close Stale Issues
+
+on:
+  schedule:
+    - cron: '0 0 * * 0'  # Run weekly on Sunday at midnight
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+
+    steps:
+    - uses: actions/stale@v5
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        stale-issue-message: 'This issue has not been updated for over 1 year and will be marked as stale. If the issue still exists, please comment or update the issue, otherwise it will be closed after 7 days.'
+        close-issue-message: 'This issue has been automatically closed due to inactivity. If the issue still exists, please reopen it.'
+        days-before-issue-stale: 365
+        days-before-issue-close: 7
+        stale-issue-label: 'Stale'
+        exempt-issue-labels: 'pinned,security'
+        operations-per-run: 100

data/ext/cppjieba/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "deps/limonp"]
+	path = deps/limonp
+	url = https://github.com/yanyiwu/limonp.git

data/ext/cppjieba/{ChangeLog.md → CHANGELOG.md}

@@ -1,4 +1,53 @@
-# CppJieba ChangeLog
+# CHANGELOG
+
+## v5.3.2
+
++ removed test/demo.cpp and linked https://github.com/yanyiwu/cppjieba-demo
++ Update Demo Link in README.md
++ [github/actions] stale 1 year ago issues
++ limonp v0.9.0 -> v1.0.0
+
+## v5.3.1
+
++ [cmake] fetch googletest
++ [submodules] rm test/googletest
+
+## v5.3.0
+
++ [c++17,c++20] compatibility
++ limonp version 0.6.7 -> 0.9.0
+
+## v5.2.0
+
++ [CI] windows-[2019,2022]
++ [googletest] v1.6.0->v1.10.0
++ [CI] ubuntu version from 20 to 22, macos version from 12 to 14
++ [CMake] mini_required 2.6->3.5 and fix CXX_VERSION variable passed from cmd
++ [CI] matrix and multi cpp version [11, 14]
+
+## v5.1.3
+
++ [googletest] git submodule add googletest-1.6.0
+
+## v5.1.2
+
++ [submodule:deps/limonp] upgrade to v0.6.7
+
+## v5.1.1
+
++ Merged [pr-186](https://github.com/yanyiwu/cppjieba/pull/186)
+
+## v5.1.0
+
++ Merged [feature: add RemoveWord api from gojieba/pull/99 #172](https://github.com/yanyiwu/cppjieba/pull/172)
+
+## v5.0.5
+
++ Merged [pr-171 submodule update limonp to v0.6.6 #171](https://github.com/yanyiwu/cppjieba/pull/171)
+
+## v5.0.4
+
++ Merged [pr-168 limonp as submodule #168](https://github.com/yanyiwu/cppjieba/pull/168)
 
 ## v5.0.3
 

data/ext/cppjieba/CMakeLists.txt

@@ -1,28 +1,25 @@
+CMAKE_MINIMUM_REQUIRED (VERSION 3.5)
 PROJECT(CPPJIEBA)
 
-CMAKE_MINIMUM_REQUIRED (VERSION 2.6)
-
-INCLUDE_DIRECTORIES(${PROJECT_SOURCE_DIR}/deps
+INCLUDE_DIRECTORIES(${PROJECT_SOURCE_DIR}/deps/limonp/include
   ${PROJECT_SOURCE_DIR}/include)
 
 if (CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
     set (CMAKE_INSTALL_PREFIX "/usr/local/cppjieba" CACHE PATH "default install path" FORCE )
 endif()
 
-ADD_DEFINITIONS(-O3 -Wall -g)
-IF(APPLE) # mac os
-    ADD_DEFINITIONS(-std=c++0x)
+if(NOT DEFINED CMAKE_CXX_STANDARD)
+    set(CMAKE_CXX_STANDARD 11)
 endif()
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS OFF)
 
-# cmake .. -DENC=GBK
-# IF (DEFINED ENC)
-#     ADD_DEFINITIONS(-DCPPJIEBA_${ENC})
-# ENDIF()
+ADD_DEFINITIONS(-O3 -Wall -g)
 
-ADD_SUBDIRECTORY(deps)
 ADD_SUBDIRECTORY(test)
 
 ENABLE_TESTING()
-ADD_TEST(NAME ./test/test.run COMMAND ./test/test.run)
-ADD_TEST(NAME ./load_test COMMAND ./load_test)
-ADD_TEST(NAME ./demo COMMAND ./demo)
+if(NOT MSVC)
+	ADD_TEST(NAME ./test/test.run COMMAND ./test/test.run)
+	ADD_TEST(NAME ./load_test COMMAND ./load_test)
+endif()

data/ext/cppjieba/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.