ruby_smart-support 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9ddd076dedba91f00229b1a827c9d07f4d97670cfbac540ad050cb0b20817079
+  data.tar.gz: 22d199ba3c75ab029323ff44589234e839b84a72de6cd45374300c85bba49d2a
+SHA512:
+  metadata.gz: e53d6679db01e5bcd40503cc6ced2657bcf431e465c7c45d877ca01fce9e4d3a3fbd142cdfb193582a843d9fe9e45019a31033bab34af762a530aadea2b57c45
+  data.tar.gz: b0176b30822758271ea3028e0f15ca9020f529760bd7738b38dcba58a0594c5e3536cf078ad313bc65942dc1a53f952e84b39c02839fac46007dd8f66f434c1e

data/.github/workflows/ruby.yml

@@ -0,0 +1,38 @@
+# 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: Test
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.1', '3.0', '2.7', '2.6']
+
+    steps:
+    - uses: actions/checkout@v3
+    - 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@0a29871fe2b0200a17a4497bae54fe5df0d973aa # v1.115.3
+      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/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# IDE related files
+/.idea
+/.ruby-version
+/.bundle-version
+
+# Github testing
+Gemfile.lock

data/.rspec

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

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ruby_smart-support.gemspec
+gemspec
+

data/README.md

@@ -0,0 +1,200 @@
+# 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)
+
+A toolkit of support libraries including GemInfo, ThreadInfo, Ruby core extensions & optionally activesupport extensions.
+
+_RubySmart::Support is a toolkit of support libraries for Ruby - major features includes GemInfo & ThreadInfo, as well core extensions for Ruby & activesupport (if installed)._
+
+-----
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_smart-support'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ruby_smart-support
+
+## Features
+* validate & check gems through GemInfo
+* resolve information about the current ruby's thread through ThreadInfo
+* extensions for Ruby
+  * *Array* `#only!`, `#only`
+  * *Float* `#round_down`, `#round_up`
+  * *Hash* `#to_md5`, `#product`
+  * *Object* `#numeric?`, `#boolean?`, `#missing_method?`, `#alias_missing_method`
+  * *String* `#to_boolean`, `#to_md5`
+
+* extensions for activesupport
+  * *Hash* `#only!`, `#without!`, `#deep_reject`
+
+* extensions for Rake-Tasks
+  * to `append` & `prepend` additional blocks
+  * to check task-state with `#invoked?`, `#performed?` & `#running?`
+
+-----
+
+## ThreadInfo module
+
+The `ThreadInfo` module provides information about the current thread.
+
+### Usage Examples
+
+```ruby
+require 'thread_info'
+
+# returns true, if this is a console
+ThreadInfo.console?
+# > true
+
+# returns the current thread name (rake / rails)
+ThreadInfo.name
+# > true
+
+# returns true if thread has a 'window'
+ThreadInfo.window?
+# > true
+
+# returns the thread type string
+ThreadInfo.info
+# > "$534435 [#235] @ console :: RakeTaskName"
+```
+
+### Available methods
+* .rake?
+* .rails?
+* .console?
+* .irb?
+* .pry?
+* .server?
+* .rails_console?
+* .io_console?
+* .thread?
+* .thread
+* .thread_id
+* .process_object_id
+* .id
+* .name
+* .type
+* .info
+* .windowed?
+* .winsize
+* .stdout?
+
+## GemInfo module
+
+The `GemInfo` module provides information about the installed and loaded gems & features.
+
+### Usage Examples
+
+```ruby
+require 'gem_info'
+
+# returns a hash of all installed gems with it's versions
+# (gems within the currently installed ruby version)
+GemInfo.installed
+# > {'bundler' => ['2.2.30', '1.2.3'], ...}
+
+# returns a hash of all loaded gems with its current version
+# (gems from the Gemfile)
+GemInfo.loaded
+# > {'bundler' => '2.2.30', ...}
+
+# returns an array of all active gems
+GemInfo.active
+# > ['bundler', ...]
+
+# returns an array of all loaded features
+GemInfo.features
+# > ['active_support','bundler']
+
+# safe requires a feature by provided name & optional gem
+GemInfo.safe_require('activesupport')
+# > false
+GemInfo.safe_require('active_support')
+# > true
+GemInfo.safe_require('action_view/helpers/date_helper','actionview', '> 0.1.0')
+# > true
+
+# compares two versions against each other
+GemInfo.match?('4.3.0', '4.3.0')
+# > true
+#
+GemInfo.match?('>= 3.0', '4.3.0')
+# > true
+#
+GemInfo.match?( '~> 3.1', '3.3.0')
+# > true
+#
+GemInfo.match?( '~> 1.1.0', '0.1.0')
+# > false
+```
+
+### Available methods
+* .installed
+* .installed?
+* .loaded
+* .loaded?
+* .active
+* .active?
+* .features
+* .feature?
+* .version
+* .safe_require
+* .match?
+
+## Rake::Task extensions
+
+With the new methods `append` & `prepend` you can now patch existing rake tasks.
+
+```ruby
+# lib/tasks/patch_db_migrate.rake
+
+namespace :db do
+  task(:migrate).prepend do |t|
+    if t.invoked?
+      puts "This task is invoked by another task!"
+    end
+    
+    if t.performed?
+      raise "This task already performed - no need to execute again!"
+    end
+  end
+
+  task(:migrate).append do |t|
+    puts "execution done!"
+  end
+end
+```
+
+-----
+
+## Docs
+
+[CHANGELOG](./docs/CHANGELOG.md)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [elasticsearch_record](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).
+
+## 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.
+
+## 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).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docs/CHANGELOG.md

@@ -0,0 +1,15 @@
+# RubySmart::Support - CHANGELOG
+
+## [1.0.0] - 2022-11-08
+* **[add]** `GemInfo` module
+* **[add]** `ThreadInfo` module
+* **[add]** core extensions for ruby
+* **[add]** extensions for rails & rake
+* **[add]** extensions for optional gem 'activesupport' / hash methods
+* **[add]** additional properties to `Rails::Info` - load them after ActiveSupport hooks
+* **[add]** rspec & simplecov
+* **[add]** Github workflow Test
+
+## [0.1.0] - 2022-11-08
+* Initial commit
+* docs, version, structure

data/docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at tg@reimbursement.institute. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/docs/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Ruby Smart
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/gem_info.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'ruby_smart/support/gem_info'
+
+# Alias to <tt>ruby_smart/support/gem_info</tt>
+GemInfo = RubySmart::Support::GemInfo

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/hash'
+require 'active_support/core_ext/object/deep_dup'
+
+unless Hash.method_defined? "only!"
+  class Hash
+    # Replaces the hash with only the given keys (if exists),
+    # but returns the same hash (not the removed keys - this differs to *Hash#slice!*)
+    #
+    #   hsh = {a: 1, b: 2, c: 3}
+    #   hsh.only!(:a, :d)
+    #   > {a: 1}
+    #   > hsh == {a: 1}
+    #
+    # @param [Object] *keys
+    # @return [Hash] self
+    def only!(*keys)
+      slice!(*keys)
+      self
+    end
+  end
+end
+
+unless Hash.method_defined? "without!"
+  class Hash
+    # removes the given keys from hash and returns those key => value pairs
+    # (this differs to *Hash#except!*)
+    #
+    #   hsh = {a: 1, b: 2, c: 3}
+    #   hsh.without!(:a, :d)
+    #   > {a: 1}
+    #   > hsh == {b: 2, c: 3}
+    #
+    # @param [Object] *keys
+    # @return [Hash] self
+    def without!(*keys)
+      Hash[self.to_a - self.except!(*keys).to_a]
+    end
+  end
+end
+
+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)
+    end
+
+    # deep reject by provided block
+    # deep remove keys that the block evaluates to true
+    #
+    #   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}}
+    #
+    #   hsh = {a: 1, b: 2, c: 3, d: {a: 1, b: 2, c: 3}}
+    #   hsh.deep_reject! {|k,v| k == :d || v == 2}
+    #   > hsh == {a: 1, c: 3}
+    def deep_reject!(&blk)
+      self.each do |k, v|
+        if blk.(k, v)
+          self.delete(k)
+        elsif v.is_a?(Hash)
+          v.deep_reject!(&blk)
+        end
+      end
+    end
+  end
+end

data/lib/ruby_smart/support/core_ext/rails/info.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'rails/info'
+
+# add additional property for info
+# The current thread information
+Rails::Info.property 'Thread' do
+  ::RubySmart::Support::ThreadInfo.info
+end
+
+# The current Bundler version
+Rails::Info.property 'Bundler' do
+  ::Bundler::VERSION if defined?(::Bundler::VERSION)
+end

data/lib/ruby_smart/support/core_ext/rake/task.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'rake/task'
+
+module Rake
+  class Task
+    module StatePatch
+      # overwriting the execute method to track the current state
+      def execute(*args)
+        @state = :running
+        super
+        @state = :done
+      end
+    end
+
+    prepend StatePatch
+
+    attr_reader :state
+
+    # returns true, if this task was invoked
+    # @return [Boolean]
+    def invoked?
+      !!@already_invoked
+    end
+
+    # returns true, if this task performed (executed)
+    # @return [Boolean]
+    def performed?
+      @state == :done
+    end
+
+    # returns true, if this task is currently running
+    # @return [Boolean]
+    def running?
+      @state == :running
+    end
+
+    # append the given block to the 'actions'-array
+    # this method is chainable and returns self
+    #
+    # @param [Proc] block
+    # @return [Rake::Task] self
+    def append(&block)
+      @actions << block
+      self
+    end
+
+    # prepends the given block to the 'actions'-array
+    # this method is chainable and returns self
+    #
+    # @param [Proc] block
+    # @return [Rake::Task] self
+    def prepend(&block)
+      @actions.unshift(block)
+      self
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+unless Array.method_defined? :only!
+  class Array
+    # refactors the same array with only given values (if exists)
+    #
+    # @example
+    #   ary = [:foo, :bar, :bat]
+    #   ary.only!(:bar, :moon)
+    #   > ary == [:bar]
+    #
+    # @param [Object] *values
+    # @return [Array] self
+    def only!(*values)
+      reject! {|value| !values.include?(value)}
+      self
+    end
+  end
+end
+
+unless Array.method_defined? :only
+  class Array
+    # returns a new array with only given values (if exists)
+    #
+    # @example
+    #   ary = [:foo, :bar, :bat]
+    #   ary.only(:bar, :bat, :moon)
+    #   > [:bar, :bat]
+    #
+    # @param [Object] *values
+    # @return [Array] ary
+    def only(*values)
+      dup.only!(*values)
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+unless Float.method_defined? :round_down
+  class Float
+    # returns a new float and rounds down
+    #
+    # @example
+    #   nb = 45.5678
+    #   nb.round_down(2)
+    #   > 45.56
+    #
+    # @param [Integer] exp - amount of decimals
+    # @return [Float] rounded number
+    def round_down(exp = 0)
+      multiplier = 10 ** exp
+      ((self * multiplier).floor).to_f/multiplier.to_f
+    end
+  end
+end
+
+unless Float.method_defined? :round_up
+  class Float
+    # returns a new float and rounds up
+    #
+    # @example
+    #   nb = 45.5678
+    #   nb.round_up(2)
+    #   > 45.57
+    #
+    # @param [Integer] exp - amount of decimals
+    # @return [Float] rounded number
+    def round_up(exp = 0)
+      multiplier = 10 ** exp
+      ((self * multiplier).ceil).to_f/multiplier.to_f
+    end
+  end
+end