ng_word 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0a2b392753e735250209d1c7f72beb7a76bb8ec0c66dfaa3225e7e1e2bae0bc
-  data.tar.gz: 0402e29327e647d1f676cec0aa41499304c99f9872e023933d712feca484837e
+  metadata.gz: 76a4a48f1db69953deb1234d5fa2a2a3f8808e04eb1e556527502fcbd4e57ba3
+  data.tar.gz: 6507a13384276aa2bfe178b82cbdc57c45446e25ddaf3c0a5ecf8d7473506787
 SHA512:
-  metadata.gz: e517d878be9d7ac30093263ea32207fa1715835be111908e1a071f4509b138bef95b4d3e239720e3bcd6b797f86f564578f08e9f279cab8a3cceb6b6a9fa1e29
-  data.tar.gz: 7ebb7744daf9e861f4cee1c05cd4d0fe34ee96cc9711ba5a4576441be7940472c48b8fb5ddb89d4506cb31ebe9de8bb5c587cfb3db2b245fab5ea605c27366a3
+  metadata.gz: de03cfd062eda421483e7501fcf1fa39cfad60a2cf969db0d5ac26842c7d0af77543a751328ad0d0db26afab1fe0e90a626b55ace30236237317dd54fb964b8a
+  data.tar.gz: 6fcc439a877ce8cf99bee925de7e013391c4bd235f1f89d21d2359eb1d7413ad084b5042c1bbfe11cc60cda57f66ea6c9c5eb7cba60923df5a88167852404740

data/.github/workflows/release.yml

@@ -0,0 +1,21 @@
+name: Release gem
+
+on:
+  workflow_dispatch:
+    inputs:
+      rubygems-otp-code:
+        description: RubyGems OTP code
+        required: true
+
+permissions:
+  contents: write
+
+jobs:
+  release-gem:
+    uses: taka0125/rubygems_release_workflow/.github/workflows/release.yml@v1
+    with:
+      rubygems-otp-code: ${{ github.event.inputs.rubygems-otp-code }}
+      user-email: taka0125@gmail.com
+      user-name: Takahiro Ooishi
+    secrets:
+      RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}

data/.github/workflows/ruby.yml

@@ -0,0 +1,31 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - master
+
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby:
+          - '3.1'
+          - '3.2'
+          - '3.3'
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - run: bundle exec rspec

data/Makefile

@@ -0,0 +1,28 @@
+DOCKER_COMPOSE = docker compose
+
+help:
+	@grep "^[a-zA-Z][a-zA-Z0-9\-\/\_]*:" -o Makefile | grep -v "grep" | sed -e 's/^/make /' | sed -e 's/://'
+build:
+	$(DOCKER_COMPOSE) build
+up:
+	$(DOCKER_COMPOSE) up -d
+down:
+	$(DOCKER_COMPOSE) stop
+restart:
+	$(MAKE) down
+	$(MAKE) up
+ps:
+	$(DOCKER_COMPOSE) ps
+convert:
+	$(DOCKER_COMPOSE) convert
+bundle/install: up
+	$(DOCKER_COMPOSE) exec ruby bash -c 'bundle install'
+ruby/bash: up
+	$(DOCKER_COMPOSE) exec ruby bash
+ruby/rspec: up
+	$(DOCKER_COMPOSE) exec ruby bash -c 'bundle exec rspec'
+gem/release:
+	@read -p "Enter OTP code: " otp_code; \
+	gh workflow run release.yml -f rubygems-otp-code="$$otp_code"
+console: up
+	$(DOCKER_COMPOSE) exec ruby bash -c './bin/console'

data/README.md

@@ -1,5 +1,8 @@
 # NgWord
 
+[![Latest Version](https://img.shields.io/gem/v/ng_word.svg)](https://rubygems.org/gems/ng_word)
+[![Build Status](https://github.com/taka0125/ng_word/workflows/Ruby/badge.svg)](https://github.com/taka0125/ng_word/actions)
+
 Verify NG words.
 
 ## Installation
@@ -38,10 +41,6 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Code Status
-
-[![CircleCI](https://circleci.com/gh/taka0125/ng_word/tree/master.svg?style=svg)](https://circleci.com/gh/taka0125/ng_word/tree/master)
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/taka0125/ng_word.

data/compose.yaml

@@ -0,0 +1,15 @@
+services:
+  ruby:
+    image: ruby:3.3
+    command: sleep infinity
+    working_dir: /app
+    volumes:
+      - .:/app:cached
+      - bundle:/bundle
+    environment:
+      - HISTFILE=/app/.bash_history
+      - BUNDLE_PATH=/bundle
+      - BUNDLE_JOBS=4
+
+volumes:
+  bundle:

data/lib/ng_word/exclude_word_rule.rb

@@ -3,24 +3,20 @@ module NgWord
     def initialize(downcased_ng_word, exclude_word)
       @downcased_ng_word = downcased_ng_word
       @exclude_word = exclude_word
+      @downcased_exclude_word = exclude_word.downcase
+
+      @index = @downcased_exclude_word.index(@downcased_ng_word)
+      @length = @downcased_exclude_word.length
+
+      freeze
     end
 
     def match?(downcased_text, matched_index)
-      downcased_text.slice(matched_index - index, length) == @downcased_exclude_word
+      downcased_text.slice(matched_index - index, length) == downcased_exclude_word
     end
 
     private
 
-    def downcased_exclude_word
-      @downcased_exclude_word ||= @exclude_word.downcase
-    end
-
-    def index
-      @index ||= downcased_exclude_word.index(@downcased_ng_word)
-    end
-
-    def length
-      @length ||= downcased_exclude_word.length
-    end
+    attr_reader :downcased_ng_word, :exclude_word, :downcased_exclude_word, :index, :length
   end
 end

data/lib/ng_word/rule.rb

@@ -5,6 +5,11 @@ module NgWord
     def initialize(ng_word, exclude_words: [])
       @ng_word = ng_word
       @exclude_words = exclude_words
+
+      @downcased_ng_word = @ng_word.downcase
+      @exclude_word_rules = Array(@exclude_words).map { |w| ExcludeWordRule.new(@downcased_ng_word, w) }
+
+      freeze
     end
 
     def verify(downcased_text, offset: 0)
@@ -15,7 +20,7 @@ module NgWord
         return verify(downcased_text, offset: index + 1) if rule.match?(downcased_text, index)
       end
 
-      VerificationResult.new(false, ng_word: @ng_word)
+      VerificationResult.new(false, ng_word: ng_word)
     end
 
     def masked_text(text, replace_text: '***', for_monitoring: false)
@@ -33,7 +38,7 @@ module NgWord
       end
       words << text.slice(current_index, text.length - current_index)
 
-      replaced_text = for_monitoring ? "#{replace_text}(#{@ng_word})" : replace_text
+      replaced_text = for_monitoring ? "#{replace_text}(#{ng_word})" : replace_text
       words.join(replaced_text)
     end
 
@@ -44,13 +49,7 @@ module NgWord
 
     private
 
-    def downcased_ng_word
-      @downcased_ng_word ||= @ng_word.downcase
-    end
-
-    def exclude_word_rules
-      @exclude_word_rules ||= Array(@exclude_words).map { |w| ExcludeWordRule.new(downcased_ng_word, w) }
-    end
+    attr_reader :downcased_ng_word
 
     def split(downcased_text, offset: 0, index_list: [])
       index = downcased_text.index(downcased_ng_word, offset)

data/lib/ng_word/rule_list.rb

@@ -6,19 +6,20 @@ module NgWord
         @rules[rule.ng_word.downcase] = rule
       end
 
-      @ng_words = @rules.keys
       @regexp = Regexp.union(@rules.keys.map { |s| /#{s}/i })
+
+      freeze
     end
 
     def verify(text)
       return VerificationResult.new(true) if text.blank?
 
-      candidate_ng_words = text.scan(@regexp)
+      candidate_ng_words = text.scan(regexp)
       return VerificationResult.new(true) if candidate_ng_words.blank?
 
       downcased_text = text.downcase
       candidate_ng_words.each do |ng_word|
-        rule = @rules[ng_word.downcase]
+        rule = rules[ng_word.downcase]
         next if rule.blank?
 
         return VerificationResult.new(false, ng_word: rule.ng_word) if rule.match?(downcased_text)
@@ -30,11 +31,11 @@ module NgWord
     def masked_text(text, replace_text: '***', for_monitoring: false)
       return text if text.blank?
 
-      candidate_ng_words = text.scan(@regexp)
+      candidate_ng_words = text.scan(regexp)
       return text if candidate_ng_words.blank?
 
       candidate_ng_words.each do |ng_word|
-        rule = @rules[ng_word.downcase]
+        rule = rules[ng_word.downcase]
         next if rule.blank?
 
         text = rule.masked_text(text, replace_text: replace_text, for_monitoring: for_monitoring)
@@ -47,5 +48,9 @@ module NgWord
       result = verify(text)
       !result.valid?
     end
+
+    private
+
+    attr_reader :rules, :regexp
   end
 end

data/lib/ng_word/verification_result.rb

@@ -5,10 +5,16 @@ module NgWord
     def initialize(is_valid, ng_word: nil)
       @is_valid = is_valid
       @ng_word = ng_word
+
+      freeze
     end
 
     def valid?
-      @is_valid
+      is_valid
     end
+
+    private
+
+    attr_reader :is_valid
   end
 end

data/lib/ng_word/version.rb

@@ -1,3 +1,3 @@
 module NgWord
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/ng_word.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport"
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ng_word
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Takahiro Ooishi
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-10-27 00:00:00.000000000 Z
+date: 2025-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -28,44 +28,44 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: Verify NG words.
 email:
 - taka0125@gmail.com
@@ -73,17 +73,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE
+- Makefile
 - README.md
 - Rakefile
-- aaa
 - bin/console
 - bin/setup
+- compose.yaml
 - lib/ng_word.rb
 - lib/ng_word/exclude_word_rule.rb
 - lib/ng_word/rule.rb
@@ -94,7 +95,7 @@ files:
 homepage: https://github.com/taka0125/ng_word
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -109,9 +110,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Verify NG words.
 test_files: []

data/.circleci/config.yml

@@ -1,30 +0,0 @@
-version: 2
-
-jobs:
-  build: &build
-    docker:
-      - image: circleci/ruby:latest
-    steps:
-      - checkout
-      - run:
-          name: Install gems
-          command: bundle install
-      - run:
-          name: RSpec
-          command: rspec
-  ruby-2.4:
-    <<: *build
-    docker:
-      - image: circleci/ruby:2.4
-
-  ruby-2.5:
-    <<: *build
-    docker:
-      - image: circleci/ruby:2.5
-
-workflows:
-  version: 2
-  build-multiple-rubies:
-    jobs:
-      - ruby-2.4
-      - ruby-2.5

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.16.4