phc_string_format 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 74aad184bd05ef181197a6511faf147117419a36
-  data.tar.gz: 67d273fc6645159868754577049e5c6161454831
+SHA256:
+  metadata.gz: bb2f0d0c00976c78f68dfc2ebdaa2fa87bbe930aecd1a97a29d41352f6f03bb2
+  data.tar.gz: 98d1aa8ababe727401fe90b8235f645598037c864d23fc67b9992c6adc3aeeb5
 SHA512:
-  metadata.gz: 727d3a0d2e0d0803f0331b897175cd79e36f17feccee6e0b91a02b0ebef6e9e75b083472b527b5ff04939c135696a620fae06b22159222b775d386c69c27771b
-  data.tar.gz: f1a8cf1788ace3f1ed3c4ad777492d53daf16782f88f4c539b8c3752895c0172dd8673d247cd046d6b74fd2e2052f6f8a5954f891f3ac3745c5a54457b8594c9
+  metadata.gz: d237ce6fc74598654b30c18b16688e15407d89e3df3d051282a77d4a8ab9be1d6f06da53927083dbf89cbdb238896004f2cbc20e83bbbd1b4206713dcfafb80b
+  data.tar.gz: 3c81d00427397be5fe6357e9478eda86864bb35388430a97d86e83839d92409bc29b72c0f1a2bd3524249e2b7591a014f4cdd995abb4c0bba3162009da115f26

data/.rubocop.yml

@@ -9,26 +9,18 @@ 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
+   Max: 110
 
 Metrics/MethodLength:
   Max: 15
 
 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/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', require: false, group: :test
+gem 'codacy-coverage', require: false, group: :test

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    phc_string_format (0.3.4)
+    phc_string_format (0.3.5)
 
 GEM
   remote: https://rubygems.org/
@@ -12,6 +12,8 @@ GEM
       ice_nine (~> 0.11.0)
       thread_safe (~> 0.3, >= 0.3.1)
     byebug (10.0.2)
+    codacy-coverage (1.1.8)
+      simplecov
     codeclimate-engine-rb (0.4.1)
       virtus (~> 1.0)
     coderay (1.1.2)
@@ -20,9 +22,11 @@ GEM
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.3)
+    docile (1.3.1)
     equalizer (0.0.11)
     ice_nine (0.11.2)
     jaro_winkler (1.5.1)
+    json (2.1.0)
     kwalify (0.7.2)
     method_source (0.9.0)
     parallel (1.12.1)
@@ -64,6 +68,11 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.9.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     thread_safe (0.3.6)
     unicode-display_width (1.4.0)
     virtus (1.0.5)
@@ -77,12 +86,14 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
+  codacy-coverage
   phc_string_format!
   pry-byebug (~> 3.6)
   rake (~> 10.0)
   reek (~> 5.0)
   rspec (~> 3.0)
   rubocop (~> 0.58.2)
+  simplecov
 
 BUNDLED WITH
    1.16.2

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/phc_string.rb

@@ -3,25 +3,7 @@ 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
-
-    def self.do_validate(that)
-      @validators.each { |validator| validator.call(that) }
-      that
-    end
+    include Validations
 
     def self.parse(string)
       string ||= ''
@@ -53,7 +35,7 @@ module PhcStringFormat
       )
     end
 
-    private_class_method :validates, :validate, :split
+    private_class_method :split
 
     validates :@id, message: 'id is non-compliant', format: { with: /\A[a-z0-9-]{1,32}\z/ }
     validates \

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.4"
+  VERSION = "0.3.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phc_string_format
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - naokikimura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-03 00:00:00.000000000 Z
+date: 2018-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,6 +77,7 @@ files:
 - ".reek.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".simplecov"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -90,6 +91,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
@@ -114,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: PHC string format implemented by Ruby.