coupon_code 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 66c35baf6d4c13f6943b85c3558e9a22c830b400
-  data.tar.gz: b983fe59c933ede4c5351fd9875b66365ed2f471
+SHA256:
+  metadata.gz: 4a5fe9e0fccbe7e2a8897b9fc37d04d7eda798eba03ba7275a890ccc269aabcb
+  data.tar.gz: f4d0bb81a8b83a11ae053109a833b9b6c77aa7e5eb7edcc720ff3159dd912102
 SHA512:
-  metadata.gz: b85ea82fc307464cd877a2fc7cc1c856576765a81bb090b8c0bcf94bd8e97685978b3779f46c393b6b199881af4b9b75b9857b95c65019d3bc5c70cc0fb61d3b
-  data.tar.gz: 55fa61617a7b1d012ab6a86704c79d82d2f9a3b143ba0f7b4d7e5787e52ef8fd88e428d1bc203353628a89e03f673077ca666d968a7377724ec9f53a1e87f405
+  metadata.gz: 6129aa503dd392ef1ddb77ecc8cda803265cc60b7b8bb4074d5925b9963687b3458b8920dcf0529fa1924d36da32be98d450db446e57bfab6b9aed3fe784fa1f
+  data.tar.gz: 1d26342a6f24ba0eb2c257deaf66fbd7015080c30bfb8e0199e35c50bed7545036b0cf3a78673f042419bc12c48d789e0c4a38070013a16b7e3de1ab81bf0380

data/CHANGELOG.md

@@ -5,3 +5,13 @@
 
 ### 0.0.2
  - Bug fix `.validate` can't handle invalid characters and produces an error. (mrclmrvn)
+
+### 0.0.3
+ - add ability to specify length #15 (fourcolors)
+
+### 0.1.0
+ - **Behaviour change:** `.validate` now returns `nil` for codes with a wrong check digit. 0.0.3 accepted them by mistake. (#17)
+ - Generate codes with `SecureRandom` instead of `rand`. (#17)
+ - Ruby 4 support: frozen string literals, no warnings. (#17)
+ - Tested on Ruby 2.6 to 4.0; the gem ships only the files it needs and requires MFA to publish. (#18)
+ - Fix `.generate` hanging when only `part_length:` is given, and stop it emptying the options hash passed in. (#19)

data/README-ko.md

@@ -15,8 +15,6 @@
 하지만 현 시점에는 펄 버전이 가진 세심하고 다양한 기능이 모두 구현되어 있지 않다는 점을 기억해 주십시오.
 평문을 입력해 코드를 생성하는 기능이나 자동교정, 금칙어 설정, 그리고 클라이언트 상에서의 코드 검증을 위한 jQuery 플러그인은 포함되어있지 않습니다.
 
-이 루비 젬은 [https://stripes.co.kr](https://stripes.co.kr)를 위해 개발됐습니다.
-
 ## 설치
 
 애플리케이션의 Gemfile에 아래의 코드 한 줄을 추가하십시오:
@@ -46,14 +44,14 @@
 쿠폰 코드를 만들 때 아래와 같이 옵션값을 넣어, 기본 설정인 3부분이 아닌 쿠폰 코드를 얻을 수 있습니다. 
 
     >> CouponCode.generate(parts: 4)
-    => "1K7Q-CTFM-LMTC-DLGP"
-    >> CouponCode.validate("1K7Q-CTFM-LMTC-DLGP", 4)
-    => "1K7Q-CTFM-LMTC-DLGP"
+    => "7YQH-1FU7-E1HX-0BG9"
+    >> CouponCode.validate("7YQH-1FU7-E1HX-0BG9", 4)
+    => "7YQH-1FU7-E1HX-0BG9"
 
 ## 테스팅
 
 ```ruby
-$ bundle exec rake test
+$ bundle exec rake spec
 ```
 ## Thanks to
 

data/README.md

@@ -1,6 +1,4 @@
-[![Build Status](https://travis-ci.org/baxang/coupon-code.svg)](https://travis-ci.org/baxang/coupon-code)
-[![Code Climate](https://codeclimate.com/github/baxang/coupon-code/badges/gpa.svg)](https://codeclimate.com/github/baxang/coupon-code)
-[![Test Coverage](https://codeclimate.com/github/baxang/coupon-code/badges/coverage.svg)](https://codeclimate.com/github/baxang/coupon-code/coverage)
+[![Ruby](https://github.com/baxang/coupon-code/actions/workflows/ruby.yml/badge.svg)](https://github.com/baxang/coupon-code/actions/workflows/ruby.yml)
 [![Gem Version](https://badge.fury.io/rb/coupon_code.svg)](http://badge.fury.io/rb/coupon_code)
 
 # CouponCode
@@ -13,8 +11,6 @@ It is a Ruby implementation of [Grant][grant]'s [Algorithm::CouponCode][couponco
 
 Please be aware that some of the original CPAN module's features are not implemented yet. For example, generating codes by plaintext, auto correction, and jQuery plugin are missing in this gem.
 
-This gem is developed for https://stripes.co.kr
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -44,14 +40,21 @@ Or install it yourself as:
 You can change the number of parts of the generated code by passing an option hash value like:
 
     >> CouponCode.generate(parts: 4)
-    => "1K7Q-CTFM-LMTC-DLGP"
-    >> CouponCode.validate("1K7Q-CTFM-LMTC-DLGP", 4)
-    => "1K7Q-CTFM-LMTC-DLGP"
+    => "7YQH-1FU7-E1HX-0BG9"
+    >> CouponCode.validate("7YQH-1FU7-E1HX-0BG9", 4)
+    => "7YQH-1FU7-E1HX-0BG9"
+
+You can also change the length of each part like:
+
+    >> CouponCode.generate(parts: 3, part_length: 5)
+    => "GRG65-X0PF4-KP7TJ"
+    >> CouponCode.validate("GRG65-X0PF4-KP7TJ", 3, 5)
+    => "GRG65-X0PF4-KP7TJ"
 
 ## Testing
 
 ```ruby
-$ bundle exec rake test
+$ bundle exec rake spec
 ```
 
 ## Thanks to

data/bin/coupon-code

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require 'coupon_code'
+require "coupon_code"
 
 code = CouponCode.generate
 puts code

data/lib/coupon_code/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CouponCode
-  VERSION = '0.0.2'.freeze
+  VERSION = "0.1.0"
 end

data/lib/coupon_code.rb

@@ -1,39 +1,36 @@
-require 'coupon_code/version'
-require 'securerandom'
-require 'digest/sha1'
+# frozen_string_literal: true
+
+require "coupon_code/version"
+require "securerandom"
 
 module CouponCode
-  SYMBOL = '0123456789ABCDEFGHJKLMNPQRTUVWXY'
-  PARTS  = 3
+  SYMBOL = "0123456789ABCDEFGHJKLMNPQRTUVWXY"
+  PARTS = 3
   LENGTH = 4
 
-  def self.generate(options = { parts: PARTS })
-    num_parts = options.delete(:parts)
+  def self.generate(options = {})
+    num_parts = options[:parts] || PARTS
+    length_of_parts = options[:part_length] || LENGTH
+
     parts = []
     (1..num_parts).each do |i|
-      part = ''
-      (1...LENGTH).each { part << random_symbol }
-      part << checkdigit_alg_1(part, i)
-      parts << part
+      data = (1...length_of_parts).map { random_symbol }.join
+      parts << data + checkdigit_alg_1(data, i)
     end
-    parts.join('-')
+    parts.join("-")
   end
 
-  def self.validate(orig, num_parts = PARTS)
+  def self.validate(orig, num_parts = PARTS, part_length = LENGTH)
     code = orig.upcase
-    code.gsub!(/[^#{SYMBOL}]+/, '')
-    parts = code.scan(/[#{SYMBOL}]{#{LENGTH}}/)
+    code.gsub!(/[^#{SYMBOL}]+/o, "")
+    parts = code.scan(/[#{SYMBOL}]{#{part_length}}/)
     return if parts.length != num_parts
-    parts.each_with_index do |part, i|
-      data  = part[0...(LENGTH - 1)]
-      check = part[-1]
-      return if check != checkdigit_alg_1(data, i + 1)
-    end
-    parts.join('-')
+    return unless parts.each_with_index.all? { |part, i| part[-1] == checkdigit_alg_1(part[0...-1], i + 1) }
+    parts.join("-")
   end
 
   def self.checkdigit_alg_1(orig, check)
-    orig.split('').each_with_index do |c, _|
+    orig.chars.each_with_index do |c, _|
       k = SYMBOL.index(c)
       check = check * 19 + k
     end
@@ -41,6 +38,6 @@ module CouponCode
   end
 
   def self.random_symbol
-    SYMBOL[rand(SYMBOL.length)]
+    SYMBOL[SecureRandom.random_number(SYMBOL.length)]
   end
 end

metadata

@@ -1,57 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: coupon_code
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Sanghyun Park
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-04-08 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
+date: 2026-10-22 00:00:00.000000000 Z
+dependencies: []
 description: A Ruby implementation of Perl's Algorithm::CouponCode CPAN module.
 email:
 - sh@baxang.com
@@ -60,27 +18,22 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".hound.yml"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README-ko.md
 - README.md
-- Rakefile
 - bin/coupon-code
-- coupon_code.gemspec
 - lib/coupon_code.rb
 - lib/coupon_code/version.rb
-- spec/coupon_code_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/baxang/coupon-code
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/baxang/coupon-code
+  source_code_uri: https://github.com/baxang/coupon-code/tree/master
+  changelog_uri: https://github.com/baxang/coupon-code/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -88,18 +41,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: Generate and validate coupon codes.
-test_files:
-- spec/coupon_code_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.gitignore

@@ -1,14 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log

data/.hound.yml

@@ -1,3 +0,0 @@
-ruby:
-  enabled: true
-  config_file: .rubocop.yml

data/.rubocop.yml

@@ -1,5 +0,0 @@
-Documentation:
-  Enabled: false
-
-Style/FileName:
-  Exclude: ['bin/coupon-code']

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
-script: 'bundle exec rake'
-before_install:
-  - gem update bundler
-addons:
-  code_climate:
-    repo_token: 8a7079440da500bd46bff928386a4a512cf5a3c314b4882a2ce7e6fe160b4f45

data/Gemfile

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in coupon_code.gemspec
-gemspec
-
-gem 'codeclimate-test-reporter', group: :test, require: nil

data/Rakefile

@@ -1,10 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec
-
-task :console do
-  exec 'irb -r coupon_code -I ./lib'
-end

data/coupon_code.gemspec

@@ -1,27 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'coupon_code/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'coupon_code'
-  spec.version       = CouponCode::VERSION
-  spec.authors       = ['Sanghyun Park']
-  spec.email         = ['sh@baxang.com']
-  spec.summary       = 'Generate and validate coupon codes.'
-  spec.description   = 'A Ruby implementation of Perl\'s' \
-                       ' Algorithm::CouponCode CPAN module.'
-  spec.homepage      = 'https://github.com/baxang/coupon-code'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  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.required_ruby_version = '>= 1.9.3'
-
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.4'
-end

data/spec/coupon_code_spec.rb

@@ -1,56 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe CouponCode do
-
-  describe '.generate' do
-    subject { described_class.generate }
-    it { is_expected.not_to be_nil }
-    it { is_expected.to match(/^[0-9A-Z-]+$/) }
-    it { is_expected.to match(/^\w{4}-\w{4}-\w{4}$/) }
-    it 'generates a different code' do
-      code2 = described_class.generate
-      is_expected.not_to eq(code2)
-    end
-
-    context '2 parts' do
-      subject { described_class.generate(parts: 2) }
-      it { is_expected.to match(/^\w{4}-\w{4}$/) }
-    end
-  end
-
-  describe '.validate' do
-
-    it 'validates a good code' do
-      expect(described_class.validate('1K7Q-CTFM-LMTC')).to eq('1K7Q-CTFM-LMTC')
-    end
-
-    it 'validates and returns the code in uppercase letters' do
-      expect(described_class.validate('1K7Q-ctfm-LMTC')).to eq('1K7Q-CTFM-LMTC')
-    end
-
-    it 'returns nil for an invalid code' do
-      expect(described_class.validate('1K7Q-CTFM')).to be_nil
-    end
-
-    it 'handles invalid characters' do
-      expect(described_class.validate('OK7Q-CTFM-LMTC')).to be_nil
-    end
-
-    context 'valid cases: lowercase, different separator and parts' do
-      [
-        ['1k7q-ctfm-lmtc'],
-        ['1K7Q/CTFM/LMTC'],
-        ['1K7Q CTFM LMTC'],
-        ['1k7qctfmlmtc'],
-        ['1K7Q-CTFM', 2],
-        ['7YQH-1FU7-E1HX-0BG9', 4],
-        ['YENH-UPJK-PTE0-20U6-QYME', 5],
-        ['YENH-UPJK-PTE0-20U6-QYME-RBK1', 6]
-      ].each do |args|
-        it { expect(described_class.validate(*args)).not_to be_nil }
-      end
-    end
-
-  end
-
-end

data/spec/spec_helper.rb

@@ -1,97 +0,0 @@
-require 'coupon_code'
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# The generated `.rspec` file contains `--require spec_helper` which will cause
-# this file to always be loaded, without a need to explicitly require it in any
-# files.
-#
-# Given that it is always loaded, you are encouraged to keep this file as
-# light-weight as possible. Requiring heavyweight dependencies from this file
-# will add to the boot time of your test suite on EVERY test run, even for an
-# individual file that may not need all of that loaded. Instead, consider making
-# a separate helper file that requires the additional dependencies and performs
-# the additional setup, and require it from the spec files that actually need
-# it.
-#
-# The `.rspec` file also contains a few flags that are not defaults but that
-# users commonly want.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-RSpec.configure do |config|
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
-  config.expect_with :rspec do |expectations|
-    # This option will default to `true` in RSpec 4. It makes the `description`
-    # and `failure_message` of custom matchers include text for helper methods
-    # defined using `chain`, e.g.:
-    #     be_bigger_than(2).and_smaller_than(4).description
-    #     # => "be bigger than 2 and smaller than 4"
-    # ...rather than:
-    #     # => "be bigger than 2"
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
-  config.mock_with :rspec do |mocks|
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended, and will default to
-    # `true` in RSpec 4.
-    mocks.verify_partial_doubles = true
-  end
-
-# The settings below are suggested to provide a good initial experience
-# with RSpec, but feel free to customize to your heart's content.
-=begin
-  # These two settings work together to allow you to limit a spec run
-  # to individual examples or groups you care about by tagging them with
-  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
-  # get run.
-  config.filter_run :focus
-  config.run_all_when_everything_filtered = true
-
-  # Allows RSpec to persist some state between runs in order to support
-  # the `--only-failures` and `--next-failure` CLI options. We recommend
-  # you configure your source control system to ignore this file.
-  config.example_status_persistence_file_path = "spec/examples.txt"
-
-  # Limits the available syntax to the non-monkey patched syntax that is
-  # recommended. For more details, see:
-  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
-  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
-  config.disable_monkey_patching!
-
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
-  config.warnings = true
-
-  # Many RSpec users commonly either run the entire suite or an individual
-  # file, and it's useful to allow more verbose output when running an
-  # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
-  end
-
-  # Print the 10 slowest examples and example groups at the
-  # end of the spec run, to help surface which specs are running
-  # particularly slow.
-  config.profile_examples = 10
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = :random
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  Kernel.srand config.seed
-=end
-end