faker-bot 0.4.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c0d9f5879fc71514770f70096568eddd9e69e61922ce46a3e63cbfd3310d7e85
+  data.tar.gz: 91339a22891160fe23425c73d022e1545204608e0556179cb38c6677f8c9d197
+SHA512:
+  metadata.gz: 7ad7bdbc091932be9d3dd3d4767830e43c8abc9a49192787e7acecd673383dcd2c77c6db4824edcbc02595ab4b64174a054918b6bad7b60da06e4e18a48168b0
+  data.tar.gz: 777a6b40d91aed4f13376e8aeb64197950fe963fcee7f7237e1c97c8076e1134d8feaef59441fe9b75f245a3b586234cb7141e5681d89c618a6aab8d3cf43518

data/.github/main.workflow

@@ -0,0 +1,9 @@
+workflow "on pull request merge, delete the branch" {
+  on = "pull_request"
+  resolves = ["branch cleanup"]
+}
+
+action "branch cleanup" {
+  uses = "jessfraz/branch-cleanup-action@master"
+  secrets = ["GITHUB_TOKEN"]
+}

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  Exclude:
+    - "Gemfile"
+    - "*.gemspec"
+    - "spec/spec_helper.rb"
+    - "config/**/*"
+  UseCache: false
+Style/Documentation:
+  Exclude:
+    - "lib/**/*"
+Metrics/ModuleLength:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/.travis.yml

@@ -0,0 +1,14 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=30c01e786e457860ad57c4d3ecc629c67b08510b170d86764eb360ffd5f7d8db
+language: ruby
+rvm:
+  - 2.4
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at austin.kabiru@andela.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in faker-cli.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,137 @@
+PATH
+  remote: .
+  specs:
+    faker-bot (0.4.5)
+      faker
+      pastel (~> 0.7.2)
+      thor (~> 0.20.0)
+      tty-pager
+      tty-screen
+      tty-tree
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    coveralls (0.7.1)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    diff-lcs (1.3)
+    docile (1.3.2)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    equatable (0.6.1)
+    faker (1.9.6)
+      i18n (>= 0.7)
+    ffi (1.11.1)
+    formatador (0.2.5)
+    guard (2.15.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    json (2.2.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.0331)
+    multi_json (1.13.1)
+    nenv (0.3.0)
+    netrc (0.11.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pastel (0.7.3)
+      equatable (~> 0.6)
+      tty-color (~> 0.5)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    simplecov (0.17.0)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    strings (0.1.5)
+      strings-ansi (~> 0.1)
+      unicode-display_width (~> 1.5)
+      unicode_utils (~> 1.4)
+    strings-ansi (0.1.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (0.20.3)
+    tins (1.21.0)
+    tty-color (0.5.0)
+    tty-pager (0.12.1)
+      strings (~> 0.1.4)
+      tty-screen (~> 0.6)
+      tty-which (~> 0.4)
+    tty-screen (0.7.0)
+    tty-tree (0.3.0)
+    tty-which (0.4.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+    unicode-display_width (1.6.0)
+    unicode_utils (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.16)
+  coveralls
+  faker-bot!
+  guard-rspec
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov (~> 0.12)
+
+BUNDLED WITH
+   2.0.2

data/Guardfile

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w[erb haml slim])
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance'
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Austin Kabiru
+
+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/README.md

@@ -0,0 +1,85 @@
+# faker-bot
+
+> Quickly look up [Faker](https://github.com/stympy/faker) methods without leaving your terminal!
+
+## Installation
+
+```bash
+$ gem install faker-bot
+```
+
+## Usage
+
+1.) Run a quick lookup
+
+```bash
+$ faker search name
+# Faker::SwordArtOnline
+# └── real_name
+# └── game_name
+# Faker::Superhero
+# └── name
+# ....
+```
+
+2.) List methods
+
+```sh
+$ faker list
+# Faker::BackToTheFuture
+# ├── quote
+# ├── date
+# └── character
+# Faker::Finance
+# └── credit_card
+# ....
+```
+
+`faker` also includes an option to display sample output via the `--verbose` or `-v` flag. :wink:
+
+3.)
+
+```sh
+$ faker list -v
+# Faker::Appliance
+# ├── brand=> Whirlpool
+# └── equipment=> Sump pump
+# Faker::UmphreysMcgee
+# └── song=> Headphones & Snowcones
+$ faker search name -v
+# Faker::App
+# └── name=> Subin
+# Faker::Address
+# └── street_name=> Percy Landing
+# ....
+```
+
+## New Features! :sunglasses: :dancers:
+
+- [x] List classes with methods E.g. Faker::FunnyName should list `.name`,`.first_name` e.t.c.
+- [x] Expand search to Faker::Base sub classes
+- [x] Paginate results :book:
+
+![screen shot 2018-08-13 at 23 33 51](https://user-images.githubusercontent.com/17295175/44056603-6343f9f2-9f51-11e8-933d-55367e25be35.jpg)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/faker-ruby/faker-bot. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Credits
+
+Terminal awesomeness made easy by the [TTY Toolkit](http://piotrmurach.github.io/tty/). :beer:
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the faker-bot project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/faker-ruby/faker-bot/blob/master/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,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'faker/bot'
+
+# 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

data/bin/faker

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib_path = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+require 'faker/bot'
+
+Signal.trap('INT') do
+  warn("\n#{caller.join("\n")}: interrupted")
+  exit(1)
+end
+
+begin
+  Faker::Bot::Base.start
+rescue Faker::Bot::Base::Error => e
+  puts "ERROR: #{e.message}"
+  exit 1
+end

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/faker-bot.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "faker/bot/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "faker-bot"
+  spec.version       = Faker::Bot::VERSION
+  spec.authors       = ["Austin Kabiru"]
+  spec.email         = ["makabby@gmail.com"]
+
+  spec.summary       = %q{A stympy/faker lookup command line tool.}
+  spec.description   = %q{Quickly look up Faker methods without leaving your terminal!}
+  spec.homepage      = "https://github.com/faker-ruby/faker-bot"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = ['faker']
+  spec.require_paths = ['lib']
+
+  spec.add_dependency "faker"
+  spec.add_dependency "pastel", "~> 0.7.2"
+  spec.add_dependency "thor", "~> 0.20.0"
+  spec.add_dependency "tty-pager"
+  spec.add_dependency "tty-screen"
+  spec.add_dependency "tty-tree"
+
+  spec.add_development_dependency "bundler", ">= 1.16"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.12"
+end

data/lib/faker-bot.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'faker/bot'

data/lib/faker/bot.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+require 'faker/bot/commands/list'
+require 'faker/bot/commands/search'
+require 'faker/bot/version'
+
+module Faker
+  module Bot
+    class Base < Thor
+      Error = Class.new(StandardError)
+      # Skip default deprecation warning output; the Bot will display that.
+      Gem::Deprecate.skip_during do
+        desc 'version', 'Faker version'
+        def version
+          puts "v#{Faker::Bot::VERSION}"
+        end
+        map %w[--version -v] => :version
+
+        desc 'list', 'List all Faker constants'
+        method_option :help, aliases: '-h', type: :boolean,
+                             desc: 'Display usage information'
+        method_option :show_methods, aliases: '-m', type: :boolean, default: true,
+                                     desc: 'Display Faker constants with methods'
+        method_option :verbose, aliases: '-v', type: :boolean,
+                                desc: 'Include sample Faker output'
+        def list(*)
+          if options[:help]
+            invoke :help, ['list']
+          else
+            Faker::Bot::Commands::List.new(options).execute
+          end
+        end
+
+        desc 'search [Faker]', 'Search Faker method(s)'
+        method_option :help, aliases: '-h', type: :boolean,
+                             desc: 'Display usage information'
+        method_option :show_methods, aliases: '-m', type: :boolean, default: true,
+                                     desc: 'Display Faker constants with methods'
+        method_option :verbose, aliases: '-v', type: :boolean,
+                                desc: 'Include sample Faker output'
+        def search(query)
+          if options[:help]
+            invoke :help, ['search']
+          else
+            Faker::Bot::Commands::Search.new(options).execute(query)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/faker/bot/command.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+require_relative 'renderer'
+
+module Faker
+  module Bot
+    class Command
+      extend Forwardable
+
+      def_delegators :command, :run
+      attr_reader :options
+
+      def initialize(options)
+        @options = options
+      end
+
+      def render(result, output)
+        Renderer.call(result, options, output)
+      end
+    end
+  end
+end

data/lib/faker/bot/commands/list.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+require_relative '../reflectors/list'
+
+module Faker
+  module Bot
+    module Commands
+      class List < Command
+        def execute(output: $stdout)
+          result = Reflectors::List.call(options)
+          render(result, output)
+        end
+      end
+    end
+  end
+end

data/lib/faker/bot/commands/search.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+require_relative '../reflectors/search'
+
+module Faker
+  module Bot
+    module Commands
+      class Search < Command
+        def execute(input, output: $stdout)
+          result = Reflectors::Search.call(input)
+          render(result, output)
+        end
+
+        private
+
+        def render(result, output)
+          return not_found(output) if result.empty?
+
+          super(result, output)
+        end
+
+        def not_found(output)
+          output.puts "\nSorry, we couldn't find a match 😢", "\n"
+        end
+      end
+    end
+  end
+end

data/lib/faker/bot/reflector.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'faker'
+
+module Faker
+  module Bot
+    # Abstract `Faker` Reflector - introspects the `Faker` module
+    #
+    # @api private
+    # @abstract
+    #
+    class Reflector
+      Faker::Base.class_eval do
+        # Select `Faker` subclasses
+        # @return [Array] `Faker::Base` sub classes
+        def self.descendants
+          @descendants ||= ObjectSpace.each_object(Class).select do |klass|
+            klass < self
+          end
+        end
+
+        # Select public class methods
+        # @return [Array] public methods
+        def self.my_singleton_methods
+          singleton_methods(false).select { |m| respond_to?(m) }
+        end
+      end
+
+      attr_reader :descendants_with_methods
+
+      def initialize(*)
+        @descendants_with_methods = Hash.new { |h, k| h[k] = [] }
+      end
+
+      protected
+
+      def store(descendant, methods)
+        return if methods.empty?
+
+        descendants_with_methods[descendant].concat(methods)
+      end
+
+      def faker_descendants
+        @faker_descendants ||= Faker::Base.descendants
+      end
+    end
+  end
+end

data/lib/faker/bot/reflectors/list.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../reflector'
+
+module Faker
+  module Bot
+    module Reflectors
+      # List command reflector
+      # @api private
+      #
+      class List < Reflector
+        attr_reader :show_methods
+
+        def self.call(options)
+          new(options).call
+        end
+
+        def initialize(options = {})
+          @show_methods = options[:show_methods]
+
+          super
+        end
+
+        def call
+          show_methods ? all_descendants_with_methods : faker_descendants
+        end
+
+        private
+
+        def all_descendants_with_methods
+          faker_descendants.each do |descendant|
+            store(descendant, descendant.my_singleton_methods)
+          end
+          descendants_with_methods
+        end
+      end
+    end
+  end
+end

data/lib/faker/bot/reflectors/search.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative '../reflector'
+
+module Faker
+  module Bot
+    module Reflectors
+      # Find command reflector
+      # @api private
+      #
+      class Search < Reflector
+        attr_reader :query
+
+        def self.call(query)
+          new(query).call
+        end
+
+        def initialize(query)
+          @query = query
+
+          super
+        end
+
+        def call
+          search_descendants_matching_query
+          descendants_with_methods
+        end
+
+        private
+
+        def search_descendants_matching_query
+          faker_descendants.each do |descendant|
+            methods = descendant.my_singleton_methods
+            matching = methods.select { |method| query_matches?(method.to_s) }
+            store(descendant, matching)
+          end
+        end
+
+        def query_matches?(method_name)
+          method_name_parts = method_name.split(/_/).reject(&:empty?)
+          query.match(/#{method_name_parts.join('|')}/)
+        end
+      end
+    end
+  end
+end

data/lib/faker/bot/renderer.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'pastel'
+require 'tty/pager'
+require 'tty/screen'
+require 'tty/tree'
+
+module Faker
+  module Bot
+    class Renderer
+      attr_reader :crayon, :hash, :options, :output, :pager
+
+      def self.call(*args)
+        new(*args).call
+      end
+
+      def initialize(hash, options, output)
+        @hash = hash
+        @options = options
+        @output = output
+        @crayon = Pastel.new(enabled: output.tty?)
+        @pager = TTY::Pager.new(command: 'less -R')
+      end
+
+      def call
+        if paginable?
+          pager.page(render)
+        else
+          output.puts(render)
+        end
+      end
+
+      def render
+        tree.render
+      end
+
+      def tree
+        @tree ||= TTY::Tree.new(build_tree)
+      end
+
+      def paginable?
+        gt_screen_height? && output.tty?
+      end
+
+      def gt_screen_height?
+        tree.nodes.size > TTY::Screen.height
+      end
+
+      private
+
+      def build_tree
+        results = hash.reduce({}) do |h, (const, methods)|
+          h.merge! node(const, methods&.sort)
+        end
+
+        results.sort_by(&:to_s).to_h
+      end
+
+      def node(const, methods)
+        {
+          crayon.green(const.to_s) => leaf(const, methods)
+        }
+      end
+
+      def leaf(const, methods)
+        (methods || []).map { |m| crayon.cyan(*leaf_args(m, const)) }
+      end
+
+      def leaf_args(method, const)
+        [method.to_s].tap { |arr| verbose_output(method, const, arr) if verbose? }
+      end
+
+      def verbose?
+        options[:verbose]
+      end
+
+      def verbose_output(method, const, arr)
+        fake, message = faker_method(method, const)
+        arr << crayon.dim.white("=> #{fake}") << crayon.dim.magenta.bold(message.to_s)
+      end
+
+      def faker_method(method, const)
+        [const.public_send(method), ensure_method_is_supported(method, const)]
+      rescue ArgumentError => _e
+        ['N/A', '']
+      end
+
+      def ensure_method_is_supported(method, const)
+        const.respond_to?(:"_deprecated_#{method}") ? ' ( WILL BE DEPRECATED )' : ''
+      end
+    end
+  end
+end

data/lib/faker/bot/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Faker
+  module Bot
+    VERSION = '0.4.5'
+  end
+end

data/lib/faker/renderer.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'pastel'
+require 'tty/pager'
+require 'tty/screen'
+require 'tty/tree'
+
+module Faker::Bot
+  class Renderer
+    attr_reader :crayon, :hash, :options, :output, :pager
+
+    def self.call(*args)
+      new(*args).call
+    end
+
+    def initialize(hash, options, output)
+      @hash = hash
+      @options = options
+      @output = output
+      @crayon = Pastel.new(enabled: output.tty?)
+      @pager = TTY::Pager.new(command: 'less -R')
+    end
+
+    def call
+      if paginable?
+        pager.page(render)
+      else
+        output.puts(render)
+      end
+    end
+
+    def render
+      tree.render
+    end
+
+    def tree
+      @tree ||= TTY::Tree.new(build_tree)
+    end
+
+    def paginable?
+      gt_screen_height? && output.tty?
+    end
+
+    def gt_screen_height?
+      tree.nodes.size > TTY::Screen.height
+    end
+
+    private
+
+    def build_tree
+      result = hash.reduce({}) do |h, (faker, methods)|
+        h.merge! node(faker, methods&.sort)
+      end
+
+      result.sort_by(&:to_s).to_h
+    end
+
+    def node(const, methods)
+      {
+        crayon.green(const.to_s) => leaf(const, methods)
+      }
+    end
+
+    def leaf(const, methods)
+      (methods || []).map { |m| crayon.cyan(*leaf_args(m, const)) }
+    end
+
+    def leaf_args(method, const)
+      [method.to_s].tap { |arr| verbose_output(method, const, arr) if verbose? }
+    end
+
+    def verbose?
+      options[:verbose]
+    end
+
+    def verbose_output(method, const, arr)
+      fake, message = faker_method(method, const)
+      arr << crayon.dim.white("=> #{fake}") << crayon.dim.magenta.bold(message.to_s)
+    end
+
+    def faker_method(method, const)
+      [const.public_send(method), ensure_method_is_supported(method, const)]
+    rescue ArgumentError => _e
+      ['N/A', '']
+    end
+
+    def ensure_method_is_supported(method, const)
+      const.respond_to?(:"_deprecated_#{method}") ? ' ( WILL BE DEPRECATED )' : ''
+    end
+  end
+end

metadata

@@ -0,0 +1,256 @@
+--- !ruby/object:Gem::Specification
+name: faker-bot
+version: !ruby/object:Gem::Version
+  version: 0.4.5
+platform: ruby
+authors:
+- Austin Kabiru
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: tty-pager
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-screen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-tree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+description: Quickly look up Faker methods without leaving your terminal!
+email:
+- makabby@gmail.com
+executables:
+- faker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/main.workflow"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/faker
+- bin/setup
+- faker-bot.gemspec
+- faker-cli-0.4.5.gem
+- lib/faker-bot.rb
+- lib/faker/bot.rb
+- lib/faker/bot/command.rb
+- lib/faker/bot/commands/list.rb
+- lib/faker/bot/commands/search.rb
+- lib/faker/bot/reflector.rb
+- lib/faker/bot/reflectors/list.rb
+- lib/faker/bot/reflectors/search.rb
+- lib/faker/bot/renderer.rb
+- lib/faker/bot/version.rb
+- lib/faker/renderer.rb
+homepage: https://github.com/faker-ruby/faker-bot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.9
+signing_key: 
+specification_version: 4
+summary: A stympy/faker lookup command line tool.
+test_files: []