ProtectedConstructor 2.1.6 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7990f247685c9fa18b298bbeb2d09204dbedfb504297c79ae7c448a8483e9a4
-  data.tar.gz: 0bc68b9a58cf0dbd39a9f441fa9413ecb8039d79a5276ce83d4bd2fefd988c0c
+  metadata.gz: 33a8ab169a6775003036bf9cc5cd913ca751af29e9f8d97a39c8780e5876cd4a
+  data.tar.gz: 8b12876d3fde7c172ca0a9aab2d11829258918dbae6b7b0c49d658a405f21c6f
 SHA512:
-  metadata.gz: 7d0219b9f6320c1c41a77614c0d0c48115b301e647d680989afbf0eaca58469cfaee45db508aa9ccd7cf7f4273e58a6e5613ae128aca322bb0ba6c3d4ddae6ad
-  data.tar.gz: c66ddcdb47c8f6750d6fb05e324ac6db02a29fd721aa22ee2c26c9bf761299c3768b5b245886604a801c7922a31c5c903f3b1851068394569dde5b28fc9772f9
+  metadata.gz: ed6cb57adc6dd845b535db0edd1b67b83e98308781000548be06b1584b75af7e56e610af404bb5c223624f10b3c17c1707bcd0e34049ca6a1fc1f2efd1db6d10
+  data.tar.gz: a2309ec622d2a38f7b06eea015326eb028fd6ad6e673e4a988ce0f3407ba206dc751b94a9ec1892d35b9f952775c3def542f3b57754e30cecac2fcb504a8be04

data/.github/workflows/ruby.yml

@@ -0,0 +1,43 @@
+# 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: ["main"]
+  pull_request:
+    branches: ["main"]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        # Use `rbenv install -l` and only use the latest stable
+        # version of ruby.
+        ruby-version: ["3.0.1", "3.0.6", "3.1.4", "3.2.2"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set timezone
+        run: sudo timedatectl set-timezone 'America/New_York'
+      - name: Run a command
+        run: date
+      - 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@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rake

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 3.0.0 2023-12-28
+* Breaking changes
+  * The require file for this gem is now 'protected_constructor' instead of 'ProtectedConstructor' (i.e. `require 'protected_constructor'`). Remove all references to `require 'ProtectedConstructor'` and replace with `require 'protected_constructor'`.
+
+* changes
+  * Relax ruby dependency to '~> 3.0'.
+  * Update ruby gems.
+
 ### 2.1.6 2023-12-02
 * changes
   * Update ruby gems.

data/Gemfile

@@ -4,3 +4,14 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ProtectedConstructor.gemspec
 gemspec
+
+gem 'bundler', '~> 2.5', '>= 2.5.3'
+gem 'pry-byebug', '>= 3.9', '< 4.0'
+gem 'rake', '>= 13.0', '< 14.0'
+gem 'redcarpet', '>= 3.5', '< 4.0'
+gem 'reek', '>= 6.1', '< 7.0'
+gem 'rspec', '>= 3.10', '< 4.0'
+gem 'rubocop', '>= 1.35', '< 2.0'
+gem 'rubocop-performance', '>= 1.14', '< 2.0'
+gem 'rubocop-rspec', '>= 2.12', '< 3.0'
+gem 'yard', '>= 0.9.28', '< 1.0'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ProtectedConstructor (2.1.6)
+    ProtectedConstructor (3.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -10,11 +10,11 @@ GEM
     byebug (11.1.3)
     coderay (1.1.3)
     diff-lcs (1.5.0)
-    json (2.7.0)
+    json (2.7.1)
     kwalify (0.7.2)
     language_server-protocol (3.17.0.3)
     method_source (1.0.0)
-    parallel (1.23.0)
+    parallel (1.24.0)
     parser (3.2.2.4)
       ast (~> 2.4.1)
       racc
@@ -32,7 +32,7 @@ GEM
       kwalify (~> 0.7.0)
       parser (~> 3.2.0)
       rainbow (>= 2.0, < 4.0)
-    regexp_parser (2.8.2)
+    regexp_parser (2.8.3)
     rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -47,7 +47,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
-    rubocop (1.58.0)
+    rubocop (1.59.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -64,9 +64,9 @@ GEM
       rubocop (~> 1.41)
     rubocop-factory_bot (2.24.0)
       rubocop (~> 1.33)
-    rubocop-performance (1.19.1)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
+    rubocop-performance (1.20.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
     rubocop-rspec (2.25.0)
       rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
@@ -82,7 +82,7 @@ PLATFORMS
 
 DEPENDENCIES
   ProtectedConstructor!
-  bundler (>= 2.4, < 3.0)
+  bundler (~> 2.5, >= 2.5.3)
   pry-byebug (>= 3.9, < 4.0)
   rake (>= 13.0, < 14.0)
   redcarpet (>= 3.5, < 4.0)
@@ -94,4 +94,4 @@ DEPENDENCIES
   yard (>= 0.9.28, < 1.0)
 
 BUNDLED WITH
-   2.4.21
+   2.5.3

data/ProtectedConstructor.gemspec

@@ -18,20 +18,10 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/gangelo/ProtectedConstructor'
   spec.license       = 'MIT'
 
+  spec.required_ruby_version = Gem::Requirement.new('~> 3.0')
+
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   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.required_ruby_version = '~> 3.0.1'
-  spec.add_development_dependency 'bundler', '>= 2.4', '< 3.0'
-  spec.add_development_dependency 'pry-byebug', '>= 3.9', '< 4.0'
-  spec.add_development_dependency 'rake', '>= 13.0', '< 14.0'
-  spec.add_development_dependency 'redcarpet', '>= 3.5', '< 4.0'
-  spec.add_development_dependency 'reek', '>= 6.1', '< 7.0'
-  spec.add_development_dependency 'rspec', '>= 3.10', '< 4.0'
-  spec.add_development_dependency 'rubocop', '>= 1.35', '< 2.0'
-  spec.add_development_dependency 'rubocop-performance', '>= 1.14', '< 2.0'
-  spec.add_development_dependency 'rubocop-rspec', '>= 2.12', '< 3.0'
-  spec.add_development_dependency 'yard', '>= 0.9.28', '< 1.0'
 end

data/README.md

@@ -1,12 +1,10 @@
-[![GitHub version](http://badge.fury.io/gh/gangelo%2FProtectedConstructor.svg?v=2.0.0)](http://badge.fury.io/gh/gangelo%2FProtectedConstructor.svg?v=2.0.0)
-[![Gem Version](https://badge.fury.io/rb/ProtectedConstructor.svg)](https://badge.fury.io/rb/ProtectedConstructor.svg)
-
-![](http://ruby-gem-downloads-badge.herokuapp.com/ProtectedConstructor?type=total)
+[![Ruby](https://github.com/gangelo/ProtectedConstructor/actions/workflows/ruby.yml/badge.svg)](https://github.com/gangelo/ProtectedConstructor/actions/workflows/ruby.yml)
+[![GitHub version](http://badge.fury.io/gh/gangelo%2FProtectedConstructor.svg?refresh=1)](http://badge.fury.io/gh/gangelo%2FProtectedConstructor.svg)
+[![Gem Version](https://badge.fury.io/rb/ProtectedConstructor.svg?refresh=3)](https://badge.fury.io/rb/ProtectedConstructor.svg)
 [![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/ProtectedConstructor/)
-
 [![Report Issues](https://img.shields.io/badge/report-issues-red.svg)](https://github.com/gangelo/ProtectedConstructor/issues)
-
 [![License](http://img.shields.io/badge/license-MIT-yellowgreen.svg)](#license)
+
 # ProtectedConstructor
 Provides a module that may be included in a Ruby class, that protects the constructor; good for enforcing
 instantiation of classes using, for instance, a class factory. The code itself is not mine, I just wrapped it
@@ -28,15 +26,15 @@ Or install it yourself as:
 
 ## Usage
 
-    require 'ProtectedConstructor'
- 
+    require 'protected_constructor'
+
     class Klass
       include ProtectedConstructor
- 
+
       def initialize
       end
     end
- 
+
     module KlassFactory
       class << self
         public
@@ -45,20 +43,20 @@ Or install it yourself as:
         end
       end
     end
- 
+
     # Constructor is protected.
     klass = Klass.new # NoMethodError
- 
+
     # Example using factory...
     klass = KlassFactory::create # works
     klass.nil?  # false
     klass.is_a?(Klass) # true
- 
+
     # Example just using  #send...
     klass = Klass.send(:new)  # works
     klass.nil?  # false
     klass.is_a?(Klass)  # true
- 
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,15 +1,12 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-begin
-  require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new(:spec)
-rescue LoadError => _e
-  task 'spec' do
-    puts "RSpec not loaded - make sure it's installed and you're using bundle exec"
-    exit 1
-  end
-end
-
-task default: :spec
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/ProtectedConstructor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ProtectedConstructor
-  VERSION = '2.1.6'
+  VERSION = '3.0.0'
 end

data/lib/{ProtectedConstructor.rb → protected_constructor.rb}

@@ -3,7 +3,7 @@
 require 'ProtectedConstructor/version'
 
 # @example
-#   require 'ProtectedConstructor'
+#   require 'protected_constructor'
 #
 #   class Klass
 #     include ProtectedConstructor

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'pry-byebug'
-require_relative '../lib/ProtectedConstructor'
+require_relative '../lib/protected_constructor'
 
 Dir[File.join(Dir.pwd, 'spec/support/**/*.rb')].sort.each { |f| require f }
 

metadata

@@ -1,215 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ProtectedConstructor
 version: !ruby/object:Gem::Version
-  version: 2.1.6
+  version: 3.0.0
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-02 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.9'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.9'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '13.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '14.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '13.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '14.0'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.5'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.5'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.10'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.10'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.35'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.35'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.14'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.14'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.12'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.12'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.28
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.28
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+date: 2023-12-28 00:00:00.000000000 Z
+dependencies: []
 description: ProtectedConstructor Gem
 email:
 - public.gma@gmail.com
@@ -218,6 +18,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
@@ -228,8 +29,8 @@ files:
 - ProtectedConstructor.gemspec
 - README.md
 - Rakefile
-- lib/ProtectedConstructor.rb
 - lib/ProtectedConstructor/version.rb
+- lib/protected_constructor.rb
 - spec/ProtectedConstructor/protected_constructor_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_klasses/klass_factory.rb
@@ -246,7 +47,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: 3.0.1
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="