phc_string_format 0.3.3 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33dff8312aa061f66c90fdabb7d4630ffdb322c2d770e1714fd7f8115335a72e
-  data.tar.gz: 87d4da1c7bd827cad52cf8f748184d11d661f7d1757627b87be932aaeaf16728
+  metadata.gz: 679957901160f40d7a114d76d447b4c347627108c99f3d7a77039f98ae8775f1
+  data.tar.gz: 2fc8ebd4e7043b97769999e92b433e06faab04e3a4aef4d5ff20f9631be2b995
 SHA512:
-  metadata.gz: bb3038a561c2b36c94d064fa101dec7aa6dd7c49fd4df7b3da269e3d3595ccd8a54b79c1eebd905a42ea1abec0bcfb2fabe4f6cb54cc728d7a172485ced83105
-  data.tar.gz: a4c5bc3223bf5a614b485fe3a55afaf04f039d0123a734bef209d7db42ba85e076b7dfaed2685076433a87189762f43d314b5607c304706b3b41283d1ae5b527
+  metadata.gz: b8eecd0da8bbbd17de007880bc13f6101e07ba59095a4946ca1e41cbfe1f8fb7c77257a69334329b8d941f17d11d99564b6ad8829c0f7a5444d84cd94246fe84
+  data.tar.gz: bdde19da37640bf9ab41bdcc8f1af6f463148d838eb101cfbfc9c0eaa466cf3b12f791df86ec3c0536fb7fc6fb179a242c8ba056df7f6cd6232f6ca9875ff57d

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: false # runs 'bundle install' and caches installed gems automatically
+    - run: bundle install --jobs 4
+    - name: Run tests
+      run: bundle exec rake

data/.reek.yml

@@ -1,21 +1,14 @@
 ---
 detectors:
 
-  FeatureEnvy:
-    exclude:
-      - 'PhcStringFormat::PhcString#parse_params'
-
   LongParameterList:
     max_params: 6
-    overrides:
-      initialize:
-        max_params: 6
 
   TooManyStatements:
     max_statements: 10
 
   TooManyInstanceVariables:
-    max_instance_variables: 6
+    max_instance_variables: 5
 
   UncommunicativeModuleName:
     accept:

data/.rubocop.yml

@@ -9,17 +9,12 @@ AllCops:
   - '*.gemspec'
   - Rakefile
 
-Metrics/AbcSize:
-  Max: 20
-
 Metrics/BlockLength:
   Exclude:
   - 'spec/**/*'
-Metrics/ClassLength:
-  Max: 120
 
 Metrics/CyclomaticComplexity:
-  Max: 10
+  Max: 7
 
 Metrics/LineLength:
   Max: 110
@@ -29,6 +24,3 @@ Metrics/MethodLength:
 
 Metrics/ParameterLists:
   Max: 6
-
-Metrics/PerceivedComplexity:
-  Max: 10

data/.simplecov

@@ -0,0 +1,4 @@
+SimpleCov.start do
+  add_filter '/tmp/'
+  add_filter '/spec/'
+end

data/.travis.yml

@@ -1,5 +1,9 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.16.2
+  - 2.4
+  - 2.5
+  - 2.6
+before_install:
+  - gem update --system
+  - gem install bundler

data/Gemfile

@@ -7,3 +7,5 @@ gemspec
 
 gem "rubocop", "~> 0.58.2", require: false, :groups => [:development, :test]
 gem "reek", "~> 5.0", require: false, :groups => [:development, :test]
+gem 'simplecov', '>= 0.16.1', require: false, group: :test
+gem 'codacy-coverage', '>= 1.1.8', require: false, group: :test

data/Gemfile.lock

@@ -1,60 +1,65 @@
 PATH
   remote: .
   specs:
-    phc_string_format (0.3.3)
+    phc_string_format (0.3.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
+    ast (2.4.2)
     axiom-types (0.1.1)
       descendants_tracker (~> 0.0.4)
       ice_nine (~> 0.11.0)
       thread_safe (~> 0.3, >= 0.3.1)
-    byebug (10.0.2)
+    byebug (11.1.3)
+    codacy-coverage (2.2.1)
+      simplecov
     codeclimate-engine-rb (0.4.1)
       virtus (~> 1.0)
-    coderay (1.1.2)
+    coderay (1.1.3)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
     equalizer (0.0.11)
     ice_nine (0.11.2)
-    jaro_winkler (1.5.1)
+    jaro_winkler (1.5.4)
     kwalify (0.7.2)
-    method_source (0.9.0)
-    parallel (1.12.1)
-    parser (2.5.1.2)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-byebug (3.6.0)
-      byebug (~> 10.0)
-      pry (~> 0.10)
+    method_source (1.0.0)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    powerpack (0.1.3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    psych (3.1.0)
     rainbow (3.0.0)
-    rake (10.5.0)
-    reek (5.0.2)
+    rake (13.0.3)
+    reek (5.6.0)
       codeclimate-engine-rb (~> 0.4.0)
       kwalify (~> 0.7.0)
-      parser (>= 2.5.0.0, < 2.6, != 2.5.1.1)
+      parser (>= 2.5.0.0, < 2.8, != 2.5.1.1)
+      psych (~> 3.1.0)
       rainbow (>= 2.0, < 4.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
     rubocop (0.58.2)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -63,9 +68,15 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
     thread_safe (0.3.6)
-    unicode-display_width (1.4.0)
+    unicode-display_width (1.7.0)
     virtus (1.0.5)
       axiom-types (~> 0.1)
       coercible (~> 1.0)
@@ -76,13 +87,15 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2)
+  codacy-coverage (>= 1.1.8)
   phc_string_format!
   pry-byebug (~> 3.6)
-  rake (~> 10.0)
+  rake (~> 13.0)
   reek (~> 5.0)
   rspec (~> 3.0)
   rubocop (~> 0.58.2)
+  simplecov (>= 0.16.1)
 
 BUNDLED WITH
-   1.16.2
+   2.0.1

data/README.md

@@ -4,6 +4,7 @@
 [![Build Status](https://travis-ci.org/naokikimura/phc_string_format.svg?branch=master)](https://travis-ci.org/naokikimura/phc_string_format)
 [![Known Vulnerabilities](https://snyk.io/test/github/naokikimura/phc_string_format/badge.svg?targetFile=Gemfile.lock)](https://snyk.io/test/github/naokikimura/phc_string_format?targetFile=Gemfile.lock)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/cbcb6fa3556447a4af16980f3cc6f1eb)](https://app.codacy.com/app/naokikimura/phc_string_format?utm_source=github.com&utm_medium=referral&utm_content=naokikimura/phc_string_format&utm_campaign=badger)
+[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/26df342921414ee69b69f028cefe4f3b)](https://www.codacy.com/app/naokikimura/phc_string_format?utm_source=github.com&utm_medium=referral&utm_content=naokikimura/phc_string_format&utm_campaign=Badge_Coverage)
 
 PHC string format implemented by Ruby
 
@@ -31,13 +32,13 @@ require 'phc_string_format'
 encrypted_password = '$argon2i$v=19$m=4096,t=3,p=1$IfH5R3O3r3501DfGnGr2rw$DfQ8Hv9R2eF2uBs1dR99IGjVjDl/rpkJIkaNyZ1g3pk'
 
 # parse
-phc_string_params = PhcStringFormat::Formatter.parse(encrypted_password)
+phc_string_args = PhcStringFormat::Formatter.parse(encrypted_password)
 # => {:id=>"argon2i", :version=>19, :params=>{"m"=>4096, "t"=>3, "p"=>1}, :salt=>"!\xF1\xF9Gs\xB7\xAF~t\xD47\xC6\x9Cj\xF6\xAF", :hash=>"\r\xF4<\x1E\xFFQ\xD9\xE1v\xB8\e5u\x1F} h\xD5\x8C9\x7F\xAE\x99\t\"F\x8D\xC9\x9D`\xDE\x99"}
 
 # format
-password_hash = PhcStringFormat::Formatter.format(phc_string_params)
+password_hash = PhcStringFormat::Formatter.format(phc_string_args)
 
-password_hash == phc_string_format
+password_hash == encrypted_password
 ```
 
 ## Development

data/lib/phc_string_format.rb

@@ -1,7 +1,8 @@
 require 'phc_string_format/b64'
-require 'phc_string_format/formatter'
-require 'phc_string_format/phc_string'
 require 'phc_string_format/version'
+require 'phc_string_format/validations'
+require 'phc_string_format/phc_string'
+require 'phc_string_format/formatter'
 
 #
 # PHC string format implemented by Ruby

data/lib/phc_string_format/formatter.rb

@@ -4,7 +4,7 @@ module PhcStringFormat
   #
   module Formatter
     def self.format(**kwargs)
-      PhcString.create(kwargs).to_s
+      PhcString.create(**kwargs).to_s
     end
 
     def self.parse(string, hint: {}, pick: nil)

data/lib/phc_string_format/phc_string.rb

@@ -3,55 +3,39 @@ module PhcStringFormat
   # Parser for parsing PHC-string-format.
   #
   class PhcString
-    def self.validates(name, **options)
-      @validators ||= []
-      @validators << lambda { |object|
-        value = object.instance_variable_get(name)
-        return if options[:allow_nil] && !value
-        regex = options.dig(:format, :with)
-        raise ArgumentError, options[:message] unless !regex || value =~ regex
-      }
-    end
-
-    def self.validate(name, **options)
-      @validators ||= []
-      @validators << ->(object) { raise ArgumentError, options[:message] unless object.send(name) }
-    end
+    include Validations
 
-    def self.do_validate(that)
-      @validators.each { |validator| validator.call(that) }
-      that
+    def self.parse(string)
+      string ||= ''
+      PhcString.new(*split(string))
+    rescue StandardError => exception
+      raise ParseError, exception.message
     end
 
-    private_class_method :validates, :validate
-
     # :reek:DuplicateMethodCall { allow_calls: ['elements.shift', 'elements.first'] }
-    def self.parse(string)
-      string ||= ''
+    def self.split(string)
       elements = string.split(/\$/, 6)
       elements.shift
-      id = elements.shift
-      version = elements.shift if (elements.first || '').start_with?('v=')
-      params = elements.shift if (elements.first || '').include?('=')
-      salt = elements.shift
-      hash = elements.shift
-      begin
-        PhcString.new(id, version, params, salt, hash)
-      rescue ArgumentError
-        raise ParseError
-      end
+      [
+        elements.shift,
+        (elements.shift if (elements.first || '').start_with?('v=')),
+        (elements.shift if (elements.first || '').include?('=')),
+        elements.shift,
+        elements.shift
+      ]
     end
 
     def self.create(id:, version: nil, params: nil, salt: nil, hash: nil, hint: {})
-      PhcString.new(
+      PhcString.new \
         id,
-        ("v=#{version}" if version),
-        (params.map { |entry| entry.join '=' }.join(',') if params),
+        (Parameters.to_s(v: version) if version),
+        (Parameters.to_s(params) if params),
         hint.dig(:salt, :encoding) == '7bit' ? salt : B64.encode(salt),
         B64.encode(hash)
-      )
     end
 
+    private_class_method :split
+
     validates :@id, message: 'id is non-compliant', format: { with: /\A[a-z0-9-]{1,32}\z/ }
     validates \
       :@version_string,
@@ -63,12 +47,12 @@ module PhcStringFormat
       :@encoded_salt,
       message: 'encoded salt is non-compliant',
       allow_nil: true,
-      format: { with: %r{\A[a-zA-Z0-9/+.-]+\z} }
+      format: { with: %r{\A[a-zA-Z0-9/+.-]*\z} }
     validates \
       :@encoded_hash,
       message: 'encoded hash is non-compliant',
       allow_nil: true,
-      format: { with: %r{\A[a-zA-Z0-9/+]+\z} }
+      format: { with: %r{\A[a-zA-Z0-9/+]*\z} }
     validate :validate_salt_and_hash, message: 'hash needs salt'
 
     def initialize(id, version_string, params_string, encoded_salt, encoded_hash)
@@ -88,15 +72,15 @@ module PhcStringFormat
         @params_string,
         @encoded_salt,
         @encoded_hash
-      ].reject { |element| !element || element.empty? }.join('$')
+      ].compact.join('$')
     end
 
     def to_h(pick: nil, hint: {})
       pick ||= %i[id version params salt hash]
       {
         id: (@id if pick.include?(:id)),
-        version: (parse_version(@version_string) if pick.include?(:version)),
-        params: (parse_params(@params_string) if pick.include?(:params)),
+        version: (Parameters.to_h(@version_string)['v'] if pick.include?(:version)),
+        params: (Parameters.to_h(@params_string) if pick.include?(:params)),
         salt:
           if pick.include?(:salt)
             hint.dig(:salt, :encoding) == '7bit' ? @encoded_salt : B64.decode(@encoded_salt)
@@ -118,21 +102,26 @@ module PhcStringFormat
     end
 
     def validate_salt_and_hash
-      !((!@encoded_salt || @encoded_salt.empty?) && !(!@encoded_hash || @encoded_hash.empty?))
+      @encoded_salt || !@encoded_hash
     end
 
-    def parse_version(version_string)
-      parse_params(version_string)['v']
-    end
+    #
+    # PHC string parameters
+    #
+    module Parameters
+      def self.to_s(params)
+        params ||= {}
+        params.map { |param| param.join '=' }.join(',')
+      end
 
-    def parse_params(params_string)
-      mapper = ->(param) { param.split '=' }
-      reducer = lambda do |param, params|
-        name, value = param
-        params[name] = value =~ /\A-?\d+(.\d+)?\Z/ ? value.to_i : value
+      def self.to_h(params_string)
+        params_string ||= ''
+        params_string
+          .split(/,/)
+          .map { |param| param.split '=' }
+          .map { |name, value| [name, value =~ /\A-?\d+(.\d+)?\Z/ ? value.to_i : value] }
+          .to_h
       end
-      params_string ||= ''
-      params_string.split(/,/).map(&mapper).each_with_object({}, &reducer)
     end
   end
 

data/lib/phc_string_format/validations.rb

@@ -0,0 +1,34 @@
+module PhcStringFormat
+  #
+  # Provides a validation framework to your objects.
+  #
+  module Validations
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+    #
+    # class methods
+    #
+    module ClassMethods
+      def validates(name, **options)
+        @validators ||= []
+        @validators << lambda { |object|
+          value = object.instance_variable_get(name)
+          return if options[:allow_nil] && !value
+          regex = options.dig(:format, :with)
+          raise ArgumentError, options[:message] unless !regex || value =~ regex
+        }
+      end
+
+      def validate(name, **options)
+        @validators ||= []
+        @validators << ->(object) { raise ArgumentError, options[:message] unless object.send(name) }
+      end
+
+      def do_validate(that)
+        @validators.each { |validator| validator.call(that) }
+        that
+      end
+    end
+  end
+end

data/lib/phc_string_format/version.rb

@@ -1,3 +1,3 @@
 module PhcStringFormat
-  VERSION = "0.3.3"
+  VERSION = "0.3.8"
 end

data/phc_string_format.gemspec

@@ -27,8 +27,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry-byebug", "~> 3.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phc_string_format
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.8
 platform: ruby
 authors:
 - naokikimura
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-08-02 00:00:00.000000000 Z
+date: 2021-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,17 +66,19 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
-description: 
+description:
 email:
 - n.kimura.cap@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".reek.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".simplecov"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -90,6 +92,7 @@ files:
 - lib/phc_string_format/b64.rb
 - lib/phc_string_format/formatter.rb
 - lib/phc_string_format/phc_string.rb
+- lib/phc_string_format/validations.rb
 - lib/phc_string_format/version.rb
 - phc_string_format.gemspec
 homepage: https://github.com/naokikimura/phc_string_format
@@ -98,7 +101,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/naokikimura/phc_string_format/issues
   source_code_uri: https://github.com/naokikimura/phc_string_format.git
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,9 +116,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.0.3
+signing_key:
 specification_version: 4
 summary: PHC string format implemented by Ruby.
 test_files: []