front_matter_parser 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a44ac54ad879c510b24c28d9319b693205e8a23fe2c9da8243e3002d2d5cbf09
-  data.tar.gz: e6d5f1b27f027bc8ce55ed8a5cfeb55855ad556130b0c224c27b2d1ca86370a7
+  metadata.gz: a904dbf5bade2127e0bb2b9abb7106f179ce22876ca6e57aa9dc7c89730d2898
+  data.tar.gz: b43330122a6496888be51b937fc06749dd0b256394227425736b88a0e9e9f781
 SHA512:
-  metadata.gz: 9d73bd59751664532d32e4275f11cb5f4ec3c9c645adb0e561c9b8a3c079b1a87298d420c1e3b88f605577910513d2243d2420306bb0e986e2fc4b530654b6fa
-  data.tar.gz: 538b56e768dffac9e9a281233a3037383cd6f6297c6201769b713c757a3cbb1a3458d9be44d335bba3eb8e44cea400eab2439074ee527a38f0c0d1d145265b9b
+  metadata.gz: bf46ac330a47187dc37041b4c25ec6dd8500761ec18feaa2102659e19cda516f03be66b3ac32a9a530406b9d4fe598a86666916418ddf54f5380d9c164787095
+  data.tar.gz: 1d359953cd78bac9bf7186eb5b16e22f95a4d01ddaaf3d9e643580c7d407332f6730573733aa55423fd06c147e7816873b8deb62b1f1fa59ac7429e0f1490489

data/.rubocop.yml

@@ -1,8 +1,50 @@
 require: rubocop-rspec
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 3.0
+  Exclude:
+    - Gemfile
+    - front_matter_parser.gemspec
+    - vendor/**/*
 RSpec/NestedGroups:
   Max: 3
+RSpec/MessageExpectation:
+  EnforcedStyle: 'expect'
 Metrics/BlockLength:
   Exclude:
     - "spec/**/*.rb"
+Style/SafeNavigation:
+  Enabled: false
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/AccessorGrouping:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: false

data/.travis.yml

@@ -1,20 +1,20 @@
-sudo: false
 language: ruby
+cache: bundler
 rvm:
-  - 2.4
-  - 2.5
   - 2.6
+  - 2.7
+  - 3.0
+  - ruby-head
 before_install:
   - gem update --system --no-doc
-  - bundle install --gemfile=.overcommit_gems.rb
-before_script:
-  - git config --global user.email 'travis@travis.ci'
-  - git config --global user.name 'Travis CI'
+  - gem install bundler
 script:
   - bundle exec rspec
+  - bundle exec rubocop
   - bundle exec codeclimate-test-reporter
-  - overcommit --sign
-  - overcommit --run
+jobs:
+  allow_failures:
+    - rvm: ruby-head
 addons:
   code_climate:
     repo_token:

data/CHANGELOG.md

@@ -4,6 +4,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/) 
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.0.0] - 2020-08-31
+- Depreciate "whitelist" in favor of "allowlist" by renaming the `whitelist_classes` param to `allowlist_classes`.
+
+If your project uses the `whitelist_classes` param, you will need to upgrade your code as follows:
+
+```ruby
+## before
+loader = FrontMatterParser::Loader::Yaml.new(whitelist_classes: [Time])
+
+## after
+loader = FrontMatterParser::Loader::Yaml.new(allowlist_classes: [Time])
+```
+
 ## [0.2.1] - 2019-06-06
 ### Fixed
 - Do not add `bin` development executables to generated gem.

data/Dockerfile

@@ -1,8 +1,5 @@
-FROM ruby:2.4.0
-ENV APP_HOME /app/
-ENV LIB_DIR lib/front_matter_parser/
-RUN mkdir -p $APP_HOME/$LIB_DIR
-WORKDIR $APP_HOME
-COPY Gemfile *gemspec $APP_HOME
-COPY $LIB_DIR/version.rb $APP_HOME/$LIB_DIR
-RUN bundle install
+FROM ruby:3.0.0
+ENV APP_USER front_matter_parser_user
+RUN useradd -ms /bin/bash $APP_USER
+USER $APP_USER
+WORKDIR /home/$APP_USER/app

data/README.md

@@ -75,17 +75,17 @@ title = FrontMatterParser::Parser.parse_file('example.haml')['title'] #=> 'Hello
 
 Following there is a relation of known syntaxes and their known comment delimiters:
 
-| Syntax | Single line comment | Start multiline comment | End multiline comment  |
-| ------ | ------------------- | ----------------------- | ---------------------- |
-| haml   |                     | -#                      | (indentation)          |
-| slim   |                     | /                       | (indentation)          |
-| liquid |                     | {% comment %}           | {% endcomment %}       |
-| md     |                     |                         |                        |
-| html   |                     | <!--                 | -->                 |
-| erb    |                     | <%#                  | %>                  |
-| coffee | #                   |                         |                        |
-| sass   | //                  |                         |                        |
-| scss   | //                  |                         |                        |
+| Syntax | Single line comment | Start multiline comment | End multiline comment |
+| ------ | ------------------- | ----------------------- | --------------------- |
+| haml   |                     | -#                      | (indentation)         |
+| slim   |                     | /                       | (indentation)         |
+| liquid |                     | {% comment %}           | {% endcomment %}      |
+| md     |                     |                         |                       |
+| html   |                     | <!--                 | -->                |
+| erb    |                     | <%#                  | %>                 |
+| coffee | #                   |                         |                       |
+| sass   | //                  |                         |                       |
+| scss   | //                  |                         |                       |
 
 ### Parsing a string
 
@@ -134,10 +134,10 @@ FrontMatterParser::Parser.parse_file('example.md', loader: json_loader)
 FrontMatterParser::Parser.new(:md, loader: json_loader).call(string)
 ```
 
-If you need to whitelist some class for the built-in YAML loader, you can just create a custom loader based on it and provide needed classes in a `whitelist_classes:` param:
+If you need to allow one or more classes for the built-in YAML loader, you can just create a custom loader based on it and provide needed classes in a `allowlist_classes:` param:
 
 ```ruby
-loader = FrontMatterParser::Loader::Yaml.new(whitelist_classes: [Time])
+loader = FrontMatterParser::Loader::Yaml.new(allowlist_classes: [Time])
 parsed = FrontMatterParser::Parser.parse_file('example.md', loader: loader)
 puts parsed['timestamp']
 ```
@@ -152,14 +152,6 @@ An then, for example:
 
 `docker-compose exec app rspec`
 
-This gem uses [overcommit](https://github.com/brigade/overcommit) to execute some code review engines. If you submit a pull request, it will be executed in the CI process. In order to set it up, you need to do:
-
-```ruby
-bundle install --gemfile=.overcommit_gems.rb
-overcommit --sign
-overcommit --run # To test if it works
-```
-
 ## Contributing
 
 1. Fork it

data/docker-compose.yml

@@ -2,6 +2,11 @@ version: '2'
 services:
   app:
     build: .
-    command: tail -f Gemfile
+    image: front_matter_parser_user
+    command: bash -c "bundle && tail -f Gemfile"
     volumes:
-      - .:/app
+      - .:/home/front_matter_parser_user/app
+    tty: true
+    stdin_open: true
+    tmpfs:
+      - /tmp

data/front_matter_parser.gemspec

@@ -23,6 +23,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.8"
   spec.add_development_dependency "pry-byebug", "~> 3.7"
   # Test reporting
-  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'rubocop', '~> 1.9'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.2'
+  spec.add_development_dependency 'simplecov', '0.17'
   spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
 end

data/lib/front_matter_parser/loader/yaml.rb

@@ -6,12 +6,12 @@ module FrontMatterParser
   module Loader
     # {Loader} that uses YAML library
     class Yaml
-      # @!attribute [r] whitelist_classes
+      # @!attribute [r] allowlist_classes
       # Classes that may be parsed by #call.
-      attr_reader :whitelist_classes
+      attr_reader :allowlist_classes
 
-      def initialize(whitelist_classes: [])
-        @whitelist_classes = whitelist_classes
+      def initialize(allowlist_classes: [])
+        @allowlist_classes = allowlist_classes
       end
 
       # Loads a hash front matter from a string
@@ -19,7 +19,7 @@ module FrontMatterParser
       # @param string [String] front matter string representation
       # @return [Hash] front matter hash representation
       def call(string)
-        YAML.safe_load(string, whitelist_classes)
+        YAML.safe_load(string, allowlist_classes)
       end
     end
   end

data/lib/front_matter_parser/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FrontMatterParser
-  VERSION = '0.2.1'
+  VERSION = '1.0.0'
 end

data/spec/front_matter_parser/loader/yaml_spec.rb

@@ -12,11 +12,11 @@ describe FrontMatterParser::Loader::Yaml do
       )
     end
 
-    it 'loads with whitelisted classes' do
+    it 'loads with classes in allowlist' do
       string = 'timestamp: 2017-10-17 00:00:00Z'
-      params = { whitelist_classes: [Time] }
+      params = { allowlist_classes: [Time] }
 
-      expect(described_class.new(params).call(string)).to eq(
+      expect(described_class.new(**params).call(string)).to eq(
         'timestamp' => Time.parse('2017-10-17 00:00:00Z')
       )
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: front_matter_parser
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - marc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-06 00:00:00.000000000 Z
+date: 2021-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,19 +67,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.7'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -103,8 +131,6 @@ extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
 - ".gitignore"
-- ".overcommit.yml"
-- ".overcommit_gems.rb"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
@@ -163,8 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Library to parse a front matter from strings or files. It allows writing

data/.overcommit.yml

@@ -1,54 +0,0 @@
-#
-# Select version of overcommit and the other tools from Gemfile
-#
-gemfile: .overcommit_gems.rb
-
-#
-# Hooks that are run against every commit message after a user has written it.
-#
-CommitMsg:
-  ALL:
-    required: true
-    exclude: &default_excludes
-      - Gemfile
-      - CHANGELOG.md
-      - front_matter_parser.gemspec
-      - README.md
-
-  HardTabs:
-    enabled: true
-
-  SingleLineSubject:
-    enabled: true
-
-#
-# Hooks that are run after `git commit` is executed, before the commit message
-# editor is displayed.
-#
-PreCommit:
-  ALL:
-    required: true
-    exclude: *default_excludes
-
-  BundleAudit:
-    enabled: true
-
-  BundleCheck:
-    enabled: true
-
-  LocalPathsInGemfile:
-    enabled: true
-
-  ExecutePermissions:
-    enabled: true
-    exclude:
-      - bin/*
-
-  Reek:
-    enabled: true
-
-  RuboCop:
-    enabled: true
-
-  TrailingWhitespace:
-    enabled: true

data/.overcommit_gems.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gem 'overcommit', '~> 0.36'
-
-# Patch-level verification for Bundled apps
-gem 'bundler-audit', '~> 0.5'
-
-# Ruby code smell reporter
-gem 'reek', '~> 4.5'
-
-# Ruby code style checking
-gem 'rubocop', '~> 0.43'
-gem 'rubocop-rspec', '~> 1.7'