ruby_smart-support 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ffa7fb2389de19763b239f720ab830e97178f07ab582168d3bff000f08061fe
-  data.tar.gz: 0d9e1695e4558759194c2b22d8f6a88e4e5cf91f0b527de9ab96c1e5a1799a95
+  metadata.gz: '04538f8760bf132b3624905d73d7d814be6db112127400c8813f788fbbcccbd9'
+  data.tar.gz: a25eef7736cfe55d98316f55fc44fac46b1866cdfa27fdac19194942c55cd685
 SHA512:
-  metadata.gz: 3868c6da69ac5a9a11357812cd2d5eb4ecdaba21ca3b805d90389068d52c6518f330da21873332f6e67207fa34d6eb536c307957ed2ed0249e7309fc9604c3a4
-  data.tar.gz: b72bbf4e9b768fa99af1245943a3ba1bd8e5302e790a316c4a5fcc9c17de9dafda83e5ef4b98a369cc28bc52b8b2cf7251abe935b3256f5cc7b8dc31999aa1e7
+  metadata.gz: cdca8016dc310dee6967f9f35ee9ba24bbb67e968ed6836306e2df22f68433d5d8cc86260b8c7b00ea86ea173e44d02a5efe89cbf3403f3a0091eab609a40aef
+  data.tar.gz: c8d56578f4bc8dd2fb8adcd081176b1ffd5c8fa52db1cc82380f6baac7358e7163e4b54810fd8d21ca15f2e0c9aa8dd4024516dfbbb58eb6e14767555fd2fe28

data/.gitignore

@@ -1,19 +1,25 @@
+# defaults
 /.bundle/
+/tmp/
+Gemfile.lock
+
+# testing
+.rspec_status
+/spec/reports/
+
+# documentation & coverage
 /.yardoc
 /_yardoc/
 /coverage/
 /doc/
-/pkg/
-/spec/reports/
-/tmp/
+/docs/yard
+/.coveralls.yml
 
-# rspec failure tracking
-.rspec_status
+# builds
+/pkg/
+/*.gem
 
 # IDE related files
 /.idea
 /.ruby-version
-/.bundle-version
-
-# Github testing
-Gemfile.lock
+/.bundle-version

data/.yardopts

@@ -0,0 +1,4 @@
+--embed-mixins
+--markup=markdown
+--files docs/*.*
+--plugin relative_markdown_links

data/README.md

@@ -1,8 +1,13 @@
 # RubySmart::Support
 
-[![Gem Version](https://badge.fury.io/rb/ruby_smart-support.svg)](https://badge.fury.io/rb/ruby_smart-support)
-[![Test](https://github.com/ruby-smart/support/actions/workflows/ruby.yml/badge.svg)](https://github.com/ruby-smart/support/actions/workflows/ruby.yml)
-[![RubySmart::Support Build Status](https://shields.io/github/workflow/status/ruby-smart/support/Test)](https://github.com/ruby-smart/support/actions)
+[![GitHub](https://img.shields.io/badge/github-ruby--smart/support-blue.svg)](http://github.com/ruby-smart/support)
+[![Documentation](https://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://rubydoc.info/gems/ruby_smart-support)
+
+[![Gem Version](https://badge.fury.io/rb/ruby_smart-support.svg?kill_cache=1)](https://badge.fury.io/rb/ruby_smart-support)
+[![License](https://img.shields.io/github/license/ruby-smart/support)](docs/LICENSE.txt)
+
+[![Coverage Status](https://coveralls.io/repos/github/ruby-smart/support/badge.svg?branch=main&kill_cache=1)](https://coveralls.io/github/ruby-smart/support?branch=main)
+[![Tests](https://github.com/ruby-smart/support/actions/workflows/ruby.yml/badge.svg)](https://github.com/ruby-smart/support/actions/workflows/ruby.yml)
 
 A toolkit of support libraries including GemInfo, ThreadInfo, Ruby core extensions & optionally activesupport extensions.
 
@@ -43,6 +48,9 @@ Or install it yourself as:
   * to `append` & `prepend` additional blocks
   * to check task-state with `#invoked?`, `#performed?` & `#running?`
 
+
+
+
 -----
 
 ## ThreadInfo module
@@ -191,19 +199,19 @@ rake db:migrate
 
 ## Docs
 
-[CHANGELOG](./docs/CHANGELOG.md)
+[CHANGELOG](docs/CHANGELOG.md)
 
 ## Contributing
 
 Bug reports and pull requests are welcome on [GitHub](https://github.com/ruby-smart/support).
-This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](./docs/CODE_OF_CONDUCT.md).
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](docs/CODE_OF_CONDUCT.md).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-A copy of the [LICENSE](./docs/LICENSE.txt) can be found @ the docs.
+A copy of the [LICENSE](docs/LICENSE.txt) can be found @ the docs.
 
 ## Code of Conduct
 
-Everyone interacting in the project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [CODE OF CONDUCT](./docs/CODE_OF_CONDUCT.md).
+Everyone interacting in the project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [CODE OF CONDUCT](docs/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -5,4 +5,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task default: :spec

data/bin/console

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require "bundler/setup"
-require "ruby_smart/support"
+require "ruby_smart-support"
 
 # 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.

data/docs/CHANGELOG.md

@@ -1,5 +1,15 @@
 # RubySmart::Support - CHANGELOG
 
+## [1.2.0] - 2023-01-24
+* **[ref]** `GemInfo` methods (active -> required & active? -> required?)
+* **[ref]** simplify `GemInfo.match?`method
+* **[fix]** `Hash#to_md5` method to use `#inspect` instead of `#to_s`
+
+## [1.1.1] - 2022-11-15
+* **[fix]** `GemInfo` & `ThreadInfo` not being included on require 'ruby_smart-support'
+* **[fix]** yard comments
+* **[add]** `yard` gem for documentation
+
 ## [1.1.0] - 2022-11-12
 * **[ref]** `GemInfo.match?` method to provide method parameters more intuitive like `.match?('3.4.0', '>', '3.1.0')`
 * **[fix]** README

data/lib/ruby_smart/support/core_ext/activesupport/hash.rb

@@ -8,12 +8,13 @@ unless Hash.method_defined? "only!"
     # Replaces the hash with only the given keys (if exists),
     # but returns the same hash (not the removed keys - this differs to *Hash#slice!*)
     #
+    # @example
     #   hsh = {a: 1, b: 2, c: 3}
     #   hsh.only!(:a, :d)
     #   > {a: 1}
     #   > hsh == {a: 1}
     #
-    # @param [Object] *keys
+    # @param [Array] keys
     # @return [Hash] self
     def only!(*keys)
       slice!(*keys)
@@ -27,15 +28,16 @@ unless Hash.method_defined? "without!"
     # removes the given keys from hash and returns those key => value pairs
     # (this differs to *Hash#except!*)
     #
+    # @example
     #   hsh = {a: 1, b: 2, c: 3}
     #   hsh.without!(:a, :d)
     #   > {a: 1}
     #   > hsh == {b: 2, c: 3}
     #
-    # @param [Object] *keys
+    # @param [Array] keys
     # @return [Hash] self
     def without!(*keys)
-      Hash[self.to_a - self.except!(*keys).to_a]
+      Hash[to_a - except!(*keys).to_a]
     end
   end
 end
@@ -44,12 +46,13 @@ unless Hash.method_defined? "deep_reject"
   class Hash
     # returns a new Hash with items that the block evaluates to true removed, also to deep Hashes.
     def deep_reject(&blk)
-      self.deep_dup.deep_reject!(&blk)
+      deep_dup.deep_reject!(&blk)
     end
 
     # deep reject by provided block
     # deep remove keys that the block evaluates to true
     #
+    # @example
     #   hsh = {a: 1, b: 2, c: 3, d: {a: 1, b: 2, c: 3}}
     #   hsh.deep_reject! {|_k,v| v.is_a?(Numeric) && v > 2}
     #   > hsh == {a: 1, b: 2, d: {a: 1, b: 2}}
@@ -58,13 +61,13 @@ unless Hash.method_defined? "deep_reject"
     #   hsh.deep_reject! {|k,v| k == :d || v == 2}
     #   > hsh == {a: 1, c: 3}
     def deep_reject!(&blk)
-      self.each do |k, v|
+      each do |k, v|
         if blk.(k, v)
-          self.delete(k)
+          delete(k)
         elsif v.is_a?(Hash)
           v.deep_reject!(&blk)
         end
       end
     end
   end
-end
+end

data/lib/ruby_smart/support/core_ext/ruby/array.rb

@@ -9,10 +9,10 @@ unless Array.method_defined? :only!
     #   ary.only!(:bar, :moon)
     #   > ary == [:bar]
     #
-    # @param [Object] *values
+    # @param [Array] values
     # @return [Array] self
     def only!(*values)
-      reject! {|value| !values.include?(value)}
+      reject! { |value| !values.include?(value) }
       self
     end
   end
@@ -27,7 +27,7 @@ unless Array.method_defined? :only
     #   ary.only(:bar, :bat, :moon)
     #   > [:bar, :bat]
     #
-    # @param [Object] *values
+    # @param [Array] values
     # @return [Array] ary
     def only(*values)
       dup.only!(*values)

data/lib/ruby_smart/support/core_ext/ruby/hash.rb

@@ -2,10 +2,10 @@
 
 unless Hash.method_defined? "to_md5"
   class Hash
-    # returns the md5 of any hash by using the to_s method
+    # returns the md5 of any hash by using the +#inspect+ method
     # @return [String] md5
     def to_md5
-      Digest::MD5.hexdigest(Hash[self.sort].to_s)
+      Digest::MD5.hexdigest(Hash[self.sort].inspect)
     end
   end
 end

data/lib/ruby_smart/support/gem_info.rb

@@ -15,8 +15,10 @@ module RubySmart
 
       # returns a hash of all installed gems with it's versions
       #
+      # @example
+      #
       #   GemInfo.installed
-      #   > {'bundler' => ['2.2.30', '1.2.3']}
+      #   # > {'bundler' => ['2.2.30', '1.2.3']}
       #
       # @return [Hash{<name> => Array[<version>]}] gem name-versions hash
       def self.installed
@@ -27,10 +29,10 @@ module RubySmart
       # the optional version requirement matches against any available version
       #
       #   GemInfo.installed?('bundler')
-      #   > true
+      #   # > true
       #
       #   GemInfo.installed?('bundler', '~> 3.0')
-      #   > false
+      #   # > false
       #
       # @param [String] name - the gem name
       # @param [nil, String] version - optional version requirement
@@ -41,22 +43,24 @@ module RubySmart
 
       # returns a hash of all loaded gems with its current version
       #
+      # @example
+      #
       #   GemInfo.loaded
-      #   > {'bundler' => '2.2.30'}
+      #   # > {'bundler' => '2.2.30'}
       #
       # @return [Hash{<name> => <version>}] gem name-version hash
       def self.loaded
         Hash[::Gem.loaded_specs.values.map { |g| [g.name, g.version.to_s] }.sort]
       end
 
-      # returns true if the provided gem name is loaded.
+      # returns true if the provided gem name is loaded (defined within any Gemfile), but must not be required yet.
       # the optional version requirement matches against the loaded version
       #
       #   GemInfo.loaded?('bundler')
-      #   > true
+      #   # > true
       #
       #   GemInfo.loaded?('bundler', '~> 3.0')
-      #   > false
+      #   # > false
       #
       # @param [String] name - the gem name
       # @param [nil, String] version - optional version requirement
@@ -65,13 +69,13 @@ module RubySmart
         loaded.key?(name) && (version.nil? || match?( loaded[name], version))
       end
 
-      # returns an array of all active gems
+      # returns an array of all required gems
       #
-      #   GemInfo.active
+      #   GemInfo.required
       #   > ['bundler']
       #
       # @return [Array<name>}] gem names
-      def self.active
+      def self.required
         $LOADED_FEATURES.
           select { |feature| feature.match(GEM_PATH_REGEXP) }.
           map { |feature|
@@ -82,20 +86,20 @@ module RubySmart
           sort
       end
 
-      # returns true if the provided gem name is active.
-      # the optional version requirement matches against the *loaded* version
+      # returns true if the provided gem name is required.
+      # the optional version matches against the *required* version
       #
-      #   GemInfo.active?('bundler')
+      #   GemInfo.required?('bundler')
       #   > true
       #
-      #   GemInfo.active?('bundler', '~> 3.0')
+      #   GemInfo.required?('bundler', '~> 3.0')
       #   > false
       #
       # @param [String] name - the gem name
       # @param [nil, String] version - optional version requirement
       # @return [Boolean] activated?
-      def self.active?(name, version = nil)
-        active.include?(name) && (version.nil? || match?(self.version(name), version))
+      def self.required?(name, version = nil)
+        required.include?(name) && (version.nil? || match?(self.version(name), version))
       end
 
       # returns an array of all loaded features
@@ -154,7 +158,7 @@ module RubySmart
       # @return [Boolean]
       def self.safe_require(path, gem = nil, version = nil)
         # check for missing gem (nicely check if the feature name differs to the gem name)
-        return false if !gem.nil? && path != gem && !active?(gem, version)
+        return false if !gem.nil? && path != gem && !required?(gem, version)
 
         # try to require the feature
         begin
@@ -185,28 +189,23 @@ module RubySmart
       #   > false
       def self.match?(*args)
         version_current = args.shift
-        version_requirement = args.join ' '
+        version_requirement = args.join(' ')
 
         return true if version_requirement.nil? || version_requirement.strip == ''
 
-        # split version compare operators
-        version_requirement_str = version_requirement.gsub(/([=~>< ]+)/, '')
-        version_requirement_op  = $1
-
-        # create plain versions without compare operators
         gem_version_current     = Gem::Version.new(version_current)
-        gem_version_requirement = Gem::Version.new(version_requirement_str)
+        gem_version_requirement = Gem::Requirement.new(version_requirement)
 
         # check if required version is PRE & current is NOT
         if gem_version_requirement.prerelease? && !gem_version_current.prerelease?
-          version_requirement = "#{version_requirement_op}#{gem_version_requirement.release}"
+          gem_version_requirement = Gem::Requirement.new("#{gem_version_requirement.requirements[0][0]} #{gem_version_requirement.requirements[0][1].release.version}")
         elsif gem_version_requirement.prerelease? != gem_version_current.prerelease?
           # check if required version PRE doesn't equal current version PRE
-          version_current = gem_version_current.release.to_s
+          gem_version_current = gem_version_current.release
         end
         # else is not required here: either its PRE && PRE || !PRE && !PRE
 
-        Gem::Dependency.new('', version_requirement).match?('', version_current)
+        gem_version_requirement.satisfied_by?(gem_version_current)
       end
     end
   end

data/lib/ruby_smart/support/gem_version.rb

@@ -9,7 +9,7 @@ module RubySmart
 
     module VERSION
       MAJOR = 1
-      MINOR = 1
+      MINOR = 2
       TINY  = 0
       PRE   = nil
 

data/lib/ruby_smart-support.rb

@@ -1,3 +1,5 @@
 # frozen_string_literal: true
 
-require 'ruby_smart/support'
+require 'ruby_smart/support'
+require 'gem_info'
+require 'thread_info'

data/ruby_smart-support.gemspec

@@ -1,27 +1,27 @@
 # frozen_string_literal: true
 
-require_relative "lib/ruby_smart/support/version"
+require_relative 'lib/ruby_smart/support/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ruby_smart-support"
-  spec.version       = RubySmart::Support.version
-  spec.authors       = ["Tobias Gonsior"]
-  spec.email         = ["info@ruby-smart.org"]
-
-  spec.summary     = "A toolkit of support libraries including GemInfo, ThreadInfo, Ruby core extensions & optionally activesupport extensions"
-  spec.description = <<DESC
-RubySmart::Support is a toolkit of support libraries for Ruby - major features includes GemInfo & ThreadInfo, as well core extensions for Ruby & activesupport (if installed).
-DESC
-
-  spec.homepage              = "https://github.com/ruby-smart/support"
-  spec.license               = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["homepage_uri"]      = spec.homepage
-  spec.metadata["source_code_uri"]   = "https://github.com/ruby-smart/support"
-  spec.metadata["changelog_uri"]     = "#{spec.metadata["source_code_uri"]}/blob/main/docs/CHANGELOG.md"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.name        = 'ruby_smart-support'
+  spec.version     = RubySmart::Support.version
+  spec.authors     = ['Tobias Gonsior']
+  spec.email       = ['info@ruby-smart.org']
+  spec.summary     = 'A toolkit of support libraries including GemInfo, ThreadInfo, Ruby core extensions & optionally activesupport extensions'
+  spec.description = <<~DESC
+    RubySmart::Support is a toolkit of support libraries for Ruby - major features includes GemInfo & ThreadInfo, as well core extensions for Ruby & activesupport (if installed).
+  DESC
+
+  spec.homepage              = 'https://github.com/ruby-smart/support'
+  spec.license               = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['homepage_uri']      = spec.homepage
+  spec.metadata['source_code_uri']   = 'https://github.com/ruby-smart/support'
+  spec.metadata['documentation_uri'] = 'https://rubydoc.info/gems/ruby_smart-support'
+  spec.metadata['changelog_uri']     = "#{spec.metadata["source_code_uri"]}/blob/main/docs/CHANGELOG.md"
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -29,10 +29,11 @@ DESC
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
 
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'activesupport', ">= 4.0"
-  spec.add_development_dependency 'rspec',  "~> 3.0"
-  spec.add_development_dependency 'rake', "~> 13.0"
-  spec.add_development_dependency 'simplecov',  '~> 0.21'
+  spec.add_development_dependency 'activesupport', '>= 4.0'
+  spec.add_development_dependency 'coveralls_reborn', '~> 0.25'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'yard', '~> 0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_smart-support
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Tobias Gonsior
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-12 00:00:00.000000000 Z
+date: 2023-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: coveralls_reborn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.25'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -53,24 +53,38 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.21'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.9'
 description: 'RubySmart::Support is a toolkit of support libraries for Ruby - major
   features includes GemInfo & ThreadInfo, as well core extensions for Ruby & activesupport
   (if installed).
 
-'
+  '
 email:
 - info@ruby-smart.org
 executables: []
@@ -80,6 +94,7 @@ files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- ".yardopts"
 - Gemfile
 - README.md
 - Rakefile
@@ -112,9 +127,10 @@ licenses:
 metadata:
   homepage_uri: https://github.com/ruby-smart/support
   source_code_uri: https://github.com/ruby-smart/support
+  documentation_uri: https://rubydoc.info/gems/ruby_smart-support
   changelog_uri: https://github.com/ruby-smart/support/blob/main/docs/CHANGELOG.md
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -129,8 +145,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.22
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A toolkit of support libraries including GemInfo, ThreadInfo, Ruby core extensions
   & optionally activesupport extensions