RubySmart::Support

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:

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
  • Enumerator #from_hash

• 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

require 'thread_info'

# returns true, if this is a console
ThreadInfo.console?
# > true

# returns the current thread name (rake / rails)
ThreadInfo.name
# > "RakeTaskName"

# returns true if thread has a 'window'
ThreadInfo.windowed?
# > true

# returns the thread type string
ThreadInfo.info
# > "$534435 [#235] @ console :: RakeTaskName"

Available methods

• .rake?
• .rails?
• .console?
• .irb?
• .pry?
• .sidekiq?
• .server?
• .debugger?
• .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

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 a hash of all loaded gems with its current license
# (gems from the Gemfile)
GemInfo.licenses
# > {'bundler' => 'MIT', ...}

# 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?('4.3.0', '>= 3.0')
# > true

# also works with split operator
GemInfo.match?( '3.3.0', '~>', ' 3.1')
# > true

GemInfo.match?( '0.1.0', '~> 1.1.0',)
# > false

Available methods

• .installed
• .installed?
• .loaded
• .loaded?
• .licenses
• .active
• .active?
• .features
• .feature?
• .version
• .safe_require
• .match?

Rake::Task extensions

With the new methods append & prepend you can now patch existing rake tasks.

# 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

So the execution of this rake task will now execute prepend, default & append blocks:

rake db:migrate
# > executes prepend
# > executes previously defined block
# > executes append block

Enumerator extensions

With the new method from_hash you can now easily map values from an array of hashes.

ary = [{a: 34, b: 12}, {a: 19, c: 4}, {b: 3, c: 11}]
ary.map.from_hash(:a)
# > [34, 19, nil]

---

Docs

CHANGELOG

Contributing

Bug reports and pull requests are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

A copy of the LICENSE 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.