phc_string_format 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2c0d23fc35b585de7e270b87439a5ae61c53213f10442f8b5e576484e985d2d
-  data.tar.gz: 5ccf72ce6afe6ac8e16a8fb6904341007e7698daf2ddd85b25296d5179c7cca2
+  metadata.gz: 95e7a26c44ec35184f4fb1ca0be50e7a6c29d99b738016ed7cd03e82f9b67694
+  data.tar.gz: 76c006ce54750252df08eeba8dba21c4ff5ee89ea8236eb5393e5cb4c474ba4a
 SHA512:
-  metadata.gz: 59d704eeda40482c8b55c1ee0e398c3da3b09c70fcff60e05106411c8bf2e43246c57d9b6bbaebf2af5f1ae855105ce915847bee79a09bb67f2b3436d5b21bb6
-  data.tar.gz: 5518af92641a14e47ba3bc552bf9e3da25ece970b479ac2e5708fe868eebbb6571b4725b22e8b0374eeb0f0215d550e11054ccb4e7a1883bc8d286fa9df51677
+  metadata.gz: 8932e026c805b7e9cc1a04d9b28ab9cab7c6410ae3ca12c776765c143c33a0db4cc350def716dc4fc4d5af5aff06c1dc2d286098a0058676877385314b074dd5
+  data.tar.gz: 39c415ecd8487e4c99182dd8f3bb008d6b952b0b5a39479fe99233895b2e4422f5efc3e0362cf272ebe1f101e9ce7f18c278b53749445414aa79cea6fe0fb976

data/.reek.yml

@@ -1,9 +1,6 @@
 ---
 detectors:
 
-  DuplicateMethodCall:
-    exclude:
-    - 'PhcStringFormat::PhcString#self.parse'
   FeatureEnvy:
     exclude:
       - 'PhcStringFormat::PhcString#parse_params'

data/.rubocop.yml

@@ -15,6 +15,8 @@ Metrics/AbcSize:
 Metrics/BlockLength:
   Exclude:
   - 'spec/**/*'
+Metrics/ClassLength:
+  Max: 120
 
 Metrics/CyclomaticComplexity:
   Max: 10

data/Gemfile

@@ -6,5 +6,4 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 gemspec
 
 gem "rubocop", "~> 0.58.2", require: false, :groups => [:development, :test]
-
 gem "reek", "~> 5.0", require: false, :groups => [:development, :test]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    phc_string_format (0.3.1)
+    phc_string_format (0.3.2)
 
 GEM
   remote: https://rubygems.org/

data/bin/console

@@ -6,9 +6,5 @@ require "phc_string_format"
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+require "pry"
+Pry.start

data/lib/phc_string_format/phc_string.rb

@@ -3,6 +3,19 @@ module PhcStringFormat
   # Parser for parsing PHC-string-format.
   #
   class PhcString
+    def self.validates(name, **validator)
+      @validators ||= {}
+      @validators[name] = validator
+    end
+
+    def self.validate(object)
+      @validators.each do |name, validator|
+        raise ArgumentError, validator[:message] \
+          unless validator[:unless].call(object.instance_variable_get(name))
+      end
+    end
+
+    # :reek:DuplicateMethodCall { allow_calls: ['elements.shift', 'elements.first'] }
     def self.parse(string, hint: {})
       string ||= ''
       elements = string.split(/\$/, 6)
@@ -12,10 +25,14 @@ module PhcStringFormat
       params = elements.shift if (elements.first || '').include?('=')
       salt = elements.shift
       hash = elements.shift
-      PhcString.new(id, version, params, salt, hash, hint)
+      begin
+        PhcString.new(id, version, params, salt, hash, hint)
+      rescue ArgumentError
+        raise ParseError
+      end
     end
 
-    def self.create(id:, version: nil, params: {}, salt: '', hash: '', hint: {})
+    def self.create(id:, version: nil, params: nil, salt: nil, hash: nil, hint: {})
       PhcString.new(
         id,
         ("v=#{version}" if version),
@@ -26,18 +43,39 @@ module PhcStringFormat
       )
     end
 
-    def initialize(id, version_string, params_string, encoded_salt, encoded_hash, hint)
-      raise ArgumentError.new, 'id is required' unless id
-      if (!encoded_salt || encoded_salt.empty?) && !(!encoded_hash || encoded_hash.empty?)
-        raise ArgumentError.new, 'hash needs salt'
-      end
+    validates :@id, message: 'id is non-compliant', unless: ->(id) { id && id =~ /\A[a-z0-9-]{1,32}\z/ }
+    validates \
+      :@version_string,
+      message: 'version is non-compliant',
+      unless: ->(version_string) { !version_string || version_string =~ /\Av=\d+\z/ }
+    validates \
+      :@params_string,
+      message: 'parameters is non-compliant',
+      unless: proc { |params_string|
+        !params_string || !params_string.empty? && params_string.split(',').all? \
+          { |param| param =~ %r{\A[a-z0-9-]{1,32}=[a-zA-Z0-9/+.-]+\z} }
+      }
+    validates \
+      :@encoded_salt,
+      message: 'encoded salt is non-compliant',
+      unless: ->(encoded_salt) { !encoded_salt || encoded_salt =~ %r{\A[a-zA-Z0-9/+.-]+\z} }
+    validates \
+      :@encoded_hash,
+      message: 'encoded hash is non-compliant',
+      unless: ->(encoded_hash) { !encoded_hash || encoded_hash =~ %r{\A[a-zA-Z0-9/+]+\z} }
 
+    # :reek:DuplicateMethodCall { allow_calls: ['!encoded_salt', '!encoded_hash'] }
+    def initialize(id, version_string, params_string, encoded_salt, encoded_hash, hint)
       @id = id
       @version_string = version_string
       @params_string = params_string
       @encoded_salt = encoded_salt
       @encoded_hash = encoded_hash
       @hint = hint
+
+      self.class.validate self
+      raise ArgumentError, 'hash needs salt' \
+        if (!encoded_salt || encoded_salt.empty?) && !(!encoded_hash || encoded_hash.empty?)
     end
 
     def to_s
@@ -64,6 +102,11 @@ module PhcStringFormat
       }.select { |_, value| value }
     end
 
+    def ==(other)
+      instance_variable_values = other.instance_variables.map { |name| other.instance_variable_get(name) }
+      instance_variable_values == instance_variables.map { |name| instance_variable_get(name) }
+    end
+
     private
 
     def parse_version(version_string)
@@ -80,4 +123,9 @@ module PhcStringFormat
       params_string.split(/,/).map(&mapper).each_with_object({}, &reducer)
     end
   end
+
+  #
+  # This exception is raised if a parser error occurs.
+  #
+  class ParseError < StandardError; end
 end

data/lib/phc_string_format/version.rb

@@ -1,3 +1,3 @@
 module PhcStringFormat
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phc_string_format
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - naokikimura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-29 00:00:00.000000000 Z
+date: 2018-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler