coupon_code 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 66c35baf6d4c13f6943b85c3558e9a22c830b400
-  data.tar.gz: b983fe59c933ede4c5351fd9875b66365ed2f471
+SHA256:
+  metadata.gz: 76d25c8d75ec9f94df915aed8a41ff6141cea7e20d2342c09412763916d81869
+  data.tar.gz: f1ffd10712e8e966276d4b54b466aea30ffc377c76e8044d8d437a7f1efff275
 SHA512:
-  metadata.gz: b85ea82fc307464cd877a2fc7cc1c856576765a81bb090b8c0bcf94bd8e97685978b3779f46c393b6b199881af4b9b75b9857b95c65019d3bc5c70cc0fb61d3b
-  data.tar.gz: 55fa61617a7b1d012ab6a86704c79d82d2f9a3b143ba0f7b4d7e5787e52ef8fd88e428d1bc203353628a89e03f673077ca666d968a7377724ec9f53a1e87f405
+  metadata.gz: 62f908f274676f03fb33adf0c8f3243171619df9a636bd00016cd2ab8641468436fdb638ca690cac63059d9ec2880fddde832efe2a6c3afa885c5e83af012128
+  data.tar.gz: 8abdcecb97a48f026eafda0b794149594a29425458da24e1308827506aaa63cb2e30ae36254b8e190f8cb665eddae71842bdd8193b84075d9a3ab079ddb5a107

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "19:00"
+  open-pull-requests-limit: 10

data/.github/workflows/ruby.yml

@@ -0,0 +1,36 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: [ '2.6', '2.7', '3.0', '3.1', '3.2', '3.3', '3.4' ]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run standardrb
+        run: bundle exec standardrb
+
+      - name: Run tests
+        run: bundle exec rspec

data/.ruby-version

@@ -0,0 +1 @@
+3.3.4

data/.standard.yml

@@ -0,0 +1,2 @@
+format: progress        # default: Standard::Formatter
+ruby_version: 2.6       # default: RUBY_VERSION

data/CHANGELOG.md

@@ -5,3 +5,6 @@
 
 ### 0.0.2
  - Bug fix `.validate` can't handle invalid characters and produces an error. (mrclmrvn)
+
+### 0.0.2
+ - add ability to specify length #15 (fourcolors)

data/Gemfile

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

data/README-ko.md

@@ -53,7 +53,7 @@
 ## 테스팅
 
 ```ruby
-$ bundle exec rake test
+$ bundle exec rake spec
 ```
 ## Thanks to
 

data/README.md

@@ -48,10 +48,17 @@ You can change the number of parts of the generated code by passing an option ha
     >> CouponCode.validate("1K7Q-CTFM-LMTC-DLGP", 4)
     => "1K7Q-CTFM-LMTC-DLGP"
 
+You can also change the length of each part like:
+
+    >> CouponCode.generate(parts: 3, part_length: 5)
+    => "GRG65-X0PF4-KP7TJ"
+    >> CouponCode.validate("1K7Q-CTFM-LMTC-DLGP", 3, 5)
+    => "1K7Q-CTFM-LMTC-DLGP"
+
 ## Testing
 
 ```ruby
-$ bundle exec rake test
+$ bundle exec rake spec
 ```
 
 ## Thanks to

data/Rakefile

@@ -1,10 +1,10 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+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'
+  exec "irb -r coupon_code -I ./lib"
 end

data/coupon_code.gemspec

@@ -1,27 +1,26 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'coupon_code/version'
+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.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.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = ">= 2.6.0"
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "standardrb"
 end

data/lib/coupon_code/version.rb

@@ -1,3 +1,3 @@
 module CouponCode
-  VERSION = '0.0.2'.freeze
+  VERSION = "0.0.3".freeze
 end

data/lib/coupon_code.rb

@@ -1,39 +1,41 @@
-require 'coupon_code/version'
-require 'securerandom'
-require 'digest/sha1'
+require "coupon_code/version"
+require "securerandom"
+require "digest/sha1"
 
 module CouponCode
-  SYMBOL = '0123456789ABCDEFGHJKLMNPQRTUVWXY'
-  PARTS  = 3
+  SYMBOL = "0123456789ABCDEFGHJKLMNPQRTUVWXY"
+  PARTS = 3
   LENGTH = 4
 
-  def self.generate(options = { parts: PARTS })
+  def self.generate(options = {parts: PARTS, part_length: LENGTH})
     num_parts = options.delete(:parts)
+    length_of_parts = options.delete(:part_length) || LENGTH
+
     parts = []
     (1..num_parts).each do |i|
-      part = ''
-      (1...LENGTH).each { part << random_symbol }
+      part = ""
+      (1...length_of_parts).each { part << random_symbol }
       part << checkdigit_alg_1(part, i)
       parts << part
     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)]
+      data = part[0...(part_length - 1)]
       check = part[-1]
-      return if check != checkdigit_alg_1(data, i + 1)
+      break if check != checkdigit_alg_1(data, i + 1)
     end
-    parts.join('-')
+    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

data/spec/coupon_code_spec.rb

@@ -1,56 +1,63 @@
-require 'spec_helper'
+require "spec_helper"
 
 RSpec.describe CouponCode do
-
-  describe '.generate' 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
+    it "generates a different code" do
       code2 = described_class.generate
       is_expected.not_to eq(code2)
     end
 
-    context '2 parts' do
+    context "2 parts" do
       subject { described_class.generate(parts: 2) }
       it { is_expected.to match(/^\w{4}-\w{4}$/) }
     end
+
+    context "when passed part_length" do
+      subject { described_class.generate(part_length: 4, parts: 1) }
+      it "allows part length to be set" do
+        expect(subject.length).to equal(4)
+      end
+    end
   end
 
-  describe '.validate' do
+  describe ".validate" do
+    it "validates a good code" do
+      expect(described_class.validate("1K7Q-CTFM-LMTC")).to eq("1K7Q-CTFM-LMTC")
+    end
 
-    it 'validates a good code' do
-      expect(described_class.validate('1K7Q-CTFM-LMTC')).to eq('1K7Q-CTFM-LMTC')
+    it "validates with a custom length" do
+      expect(described_class.validate("GRG65-X0PF4-KP7TJ", 3, 5)).to eq("GRG65-X0PF4-KP7TJ")
     end
 
-    it 'validates and returns the code in uppercase letters' do
-      expect(described_class.validate('1K7Q-ctfm-LMTC')).to eq('1K7Q-CTFM-LMTC')
+    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
+    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
+    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
+    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]
+        ["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,4 +1,4 @@
-require 'coupon_code'
+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
@@ -41,57 +41,55 @@ RSpec.configure do |config|
     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
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coupon_code
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Sanghyun Park
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-04-08 00:00:00.000000000 Z
+date: 2024-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  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'
 description: A Ruby implementation of Perl's Algorithm::CouponCode CPAN module.
 email:
 - sh@baxang.com
@@ -60,10 +74,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".hound.yml"
-- ".rubocop.yml"
-- ".travis.yml"
+- ".ruby-version"
+- ".standard.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -80,7 +95,7 @@ homepage: https://github.com/baxang/coupon-code
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -88,18 +103,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/.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