ProtectedConstructor 1.0.5 → 2.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 53f567997f4b0dbb923f554f7dd6973dee4f4999230a47aea69d9f0a09c499b3
+  data.tar.gz: 891ec0d8e75293a47681ccb773b22ba183dbde1559474045cab0c68995d29583
+SHA512:
+  metadata.gz: ff08b1c8a2b89ba5ffca832c58ccb48bf285184b8335389a268686a43386c8cf240dbda7d9c50f97236cc501b75d330296c0504a57a0b9eda38578e61fb68519
+  data.tar.gz: a46b096ec35339cc68ce643ebdb7d56e9baf649941fbbda9d51552d805307b0d35d8e3c47027abb679932a65197c6a13f63edfd490f53fcced24ea9eb08d343b

data/.gitignore

@@ -1,17 +1,20 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/rdoc/
 *.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+
+# rspec failure tracking
+.rspec_status
+
+/.vscode/
+*.code-workspace
+
+scratch.rb
+readme.txt

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.0.1

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+### 2.1.3
+* changes
+  * Required Ruby version is now 3.0.1.
+### 2.0.3
+* changes
+  * Clean up ProtectedConstructor call to module_eval of unnecessary code.
+  * Update gems and especially rake gem version to patch redcarpet CVE-2020-26298, yard CVE-2017-17042 and CVE-2019-1020001.
+  * Fix rubocop violations.

data/Gemfile

@@ -1,9 +1,6 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ProtectedConstructor.gemspec
 gemspec
-
-ruby '1.9.3'
-gem "rspec", "~> 2.13.0"
-gem "yard", "0.8.6.1"
-gem "redcarpet", "~> 2.3.0"

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: .
+  specs:
+    ProtectedConstructor (2.1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    json (2.6.2)
+    kwalify (0.7.2)
+    method_source (1.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    redcarpet (3.5.1)
+    reek (6.1.1)
+      kwalify (~> 0.7.0)
+      parser (~> 3.1.0)
+      rainbow (>= 2.0, < 4.0)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.35.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.12.1)
+      rubocop (~> 1.31)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.2.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  ProtectedConstructor!
+  bundler (~> 2.2, >= 2.2.17)
+  pry-byebug (~> 3.9)
+  rake (~> 13.0, >= 13.0.6)
+  redcarpet (~> 3.5, >= 3.5.1)
+  reek (~> 6.1, >= 6.1.1)
+  rspec (>= 3.10)
+  rubocop (~> 1.35)
+  rubocop-performance (~> 1.14, >= 1.14.3)
+  rubocop-rspec (~> 2.12, >= 2.12.1)
+  yard (~> 0.9.28)
+
+BUNDLED WITH
+   2.3.20

data/ProtectedConstructor.gemspec

@@ -1,23 +1,37 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+require 'English'
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ProtectedConstructor/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ProtectedConstructor"
+  spec.name          = 'ProtectedConstructor'
   spec.version       = ProtectedConstructor::VERSION
-  spec.authors       = ["Gene M. Angelo, Jr."]
-  spec.email         = ["public.gma@gmail.com"]
-  spec.description   = %q{ProtectedConstructor Gem}
-  spec.summary       = %q{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.}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['Gene M. Angelo, Jr.']
+  spec.email         = ['public.gma@gmail.com']
+  spec.description   = 'ProtectedConstructor Gem'
+  spec.summary       = '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.'
+  spec.homepage      = 'http://www.geneangelo.com'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  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.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.required_ruby_version = '~> 3.0.1'
+  spec.add_development_dependency 'bundler', '~> 2.2', '>= 2.2.17'
+  spec.add_development_dependency 'pry-byebug', '~> 3.9'
+  spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
+  spec.add_development_dependency 'redcarpet', '~> 3.5', '>= 3.5.1'
+  spec.add_development_dependency 'reek', '~> 6.1', '>= 6.1.1'
+  spec.add_development_dependency 'rspec', '>= 3.10'
+  spec.add_development_dependency 'rubocop', '~> 1.35'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.14', '>= 1.14.3'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.12', '>= 2.12.1'
+  spec.add_development_dependency 'yard', '~> 0.9.28'
 end

data/README.md

@@ -1,5 +1,13 @@
-# ProtectedConstructor
+[![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)
+[![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
 in a gem and provided the examples; sorry, I don't remember the origin of the code to give credit.
@@ -39,7 +47,7 @@ Or install it yourself as:
     end
  
     # Constructor is protected.
-    klass = Klass.new   NoMethodError
+    klass = Klass.new # NoMethodError
  
     # Example using factory...
     klass = KlassFactory::create # works

data/Rakefile

@@ -1,13 +1,15 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 
 begin
   require 'rspec/core/rake_task'
   RSpec::Core::RakeTask.new(:spec)
-rescue LoadError => e
-  task "spec" do
+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
+task default: :spec

data/lib/ProtectedConstructor/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProtectedConstructor
-  VERSION = "1.0.5"
+  VERSION = '2.1.3'
 end

data/lib/ProtectedConstructor.rb

@@ -1,4 +1,6 @@
-require "ProtectedConstructor/version"
+# frozen_string_literal: true
+
+require 'ProtectedConstructor/version'
 
 # @example
 #   require 'ProtectedConstructor'
@@ -37,12 +39,6 @@ module ProtectedConstructor
     klass.module_eval do
       class << self
         protected :new
-
-        def inherited(klass)
-          klass.module_eval do
-            def self.new(*args); super; end
-          end
-        end
       end
     end
   end

data/spec/ProtectedConstructor/protected_constructor_spec.rb

@@ -1,22 +1,64 @@
-require_relative '../spec_helper'
+# frozen_string_literal: true
 
-describe 'ProtectedConstructor' do
+# rubocop:disable Metrics/BlockLength
+describe 'ProtectedConstructor', type: :module do
+  let(:id) { 1 }
 
-  it 'should throw a NoMethodError exception if attempting to instantiate Klass without using the KlassFactory' do
-   lambda { klass = Klass.new(1) }.should raise_error NoMethodError
-  end
+  describe 'when the module is included in a class' do
+    subject do
+      KlassFactory
+    end
 
-  it 'should create a Klass object when using the factory' do
-    klass = KlassFactory::create(0)
-    klass.nil?.should == false
-    klass.is_a?(Klass).should == true
-  end
+    describe '.new' do
+      context 'when calling .new' do
+        it 'raises an error' do
+          expect { subject.new(id) }.to raise_error NoMethodError
+        end
+      end
+    end
+
+    describe '.<class factory method>' do
+      let(:factory_class_object) { subject.create(id) }
 
-  it 'should create a Klass object when using the factory and pass constructor parameters' do
-    klass = KlassFactory::create(99)
-    klass.nil?.should == false
-    klass.is_a?(Klass).should == true
-    klass.id.should == 99
+      context 'when wrapped in a factory' do
+        it 'creates an object' do
+          expect(factory_class_object).to be_kind_of subject
+          expect(factory_class_object.id).to eq id
+        end
+      end
+    end
   end
 
-end
+  describe 'multiple inheritance' do
+    subject do
+      KlassFactoryTwo
+    end
+
+    let(:name) { 'john' }
+
+    describe '.new' do
+      context 'when calling .new' do
+        it 'raises an error' do
+          expect { subject.new(name, id) }.to raise_error NoMethodError
+        end
+      end
+    end
+
+    describe '.<class factory method>' do
+      context 'when calling .<class factory method>' do
+        let(:factory_class_object) { subject.create(name, id) }
+
+        it 'does not raise an error' do
+          expect { factory_class_object }.to_not raise_error
+        end
+
+        it 'returns a factory class object' do
+          expect(factory_class_object).to be_kind_of subject
+          expect(factory_class_object.name).to eq name
+          expect(factory_class_object.id).to eq id
+        end
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/BlockLength

data/spec/spec_helper.rb

@@ -1,3 +1,22 @@
-require 'klass'
-require 'klass_factory'
-require_relative '../lib/ProtectedConstructor'
+# frozen_string_literal: true
+
+require 'pry-byebug'
+require_relative '../lib/ProtectedConstructor'
+
+Dir[File.join(Dir.pwd, 'spec/support/**/*.rb')].sort.each { |f| require f }
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  # config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.mock_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/support/shared_klasses/klass_factory.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Defines a class factory that includes ProtectedConstructor.
+class KlassFactory
+  include ProtectedConstructor
+
+  class << self
+    def create(id)
+      send(:new, id)
+    end
+  end
+
+  attr_reader :id
+
+  def initialize(id)
+    @id = id
+  end
+end

data/spec/support/shared_klasses/klass_factory_two.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'klass_factory'
+
+# Defines a class factory that inherits from a class
+# that includes ProtectedConstructor.
+class KlassFactoryTwo < KlassFactory
+  class << self
+    def create(name, id)
+      send(:new, name, id)
+    end
+  end
+
+  attr_reader :name
+
+  def initialize(name, id)
+    super id
+    @name = name
+  end
+end