ruby_smart-support 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ffa7fb2389de19763b239f720ab830e97178f07ab582168d3bff000f08061fe
-  data.tar.gz: 0d9e1695e4558759194c2b22d8f6a88e4e5cf91f0b527de9ab96c1e5a1799a95
+  metadata.gz: fd347393200ee92556b1d3ea0c6c364d5da5a13be34100fda90056005ac22adf
+  data.tar.gz: 92bf3aae8deda45cc40b2aa7eb77d5e8774e9ae46320246642e6ea1c8ba3102a
 SHA512:
-  metadata.gz: 3868c6da69ac5a9a11357812cd2d5eb4ecdaba21ca3b805d90389068d52c6518f330da21873332f6e67207fa34d6eb536c307957ed2ed0249e7309fc9604c3a4
-  data.tar.gz: b72bbf4e9b768fa99af1245943a3ba1bd8e5302e790a316c4a5fcc9c17de9dafda83e5ef4b98a369cc28bc52b8b2cf7251abe935b3256f5cc7b8dc31999aa1e7
+  metadata.gz: aec073cf8aece0a5930fe22f83365fe804bc589b40b84b7524f5b21edaf4053df678b59968f9c1f1222b7773ec228b3cda5343d9d8c99fb7f7eddc79ab7d869e
+  data.tar.gz: fdc642a6c32398c676e353599d61855390999eca7aea52a3c5a51a0a9c0fc7e3c28ea3c264fc75ac5112e3b30bd8dc97ebea664b819016b160567e854e6be90a

data/.gitignore

@@ -17,3 +17,6 @@
 
 # Github testing
 Gemfile.lock
+
+# builds
+/*.gem

data/Rakefile

@@ -6,3 +6,11 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+# ----- Documentation tasks ---------------------------------------------------
+
+require 'yard'
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.options = %w| --embed-mixins --markup=markdown|
+  t.files = ['lib/**/*.rb','-','docs/*.*']
+end

data/docs/CHANGELOG.md

@@ -1,5 +1,10 @@
 # RubySmart::Support - CHANGELOG
 
+## [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/gem_version.rb

@@ -10,7 +10,7 @@ module RubySmart
     module VERSION
       MAJOR = 1
       MINOR = 1
-      TINY  = 0
+      TINY  = 1
       PRE   = nil
 
       STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

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.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.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.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['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.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 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.21'
+  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.1.1
 platform: ruby
 authors:
 - Tobias Gonsior
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-12 00:00:00.000000000 Z
+date: 2022-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -66,11 +66,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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: []
@@ -114,7 +128,7 @@ metadata:
   source_code_uri: https://github.com/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
@@ -130,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.22
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A toolkit of support libraries including GemInfo, ThreadInfo, Ruby core extensions
   & optionally activesupport extensions