faker-bot 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a409150c431509d7ccda5b95da8d39505da24b64f7d4d13a30674765750e266
-  data.tar.gz: 17ec8d367dff5cf0c089ec785ace9b909e7c6b4f3aaaaaacb24f3a9ef0f558cd
+  metadata.gz: e7fdf014f0c352744056c5ae4c197f99e204e8924e33a0f3ceb9e9b9d9d85b40
+  data.tar.gz: 3b7b462bdfa2ff3668340a70ac4ec7647dcc15d3b4f853d5381f2083f5b48841
 SHA512:
-  metadata.gz: 02cccefaf2d42f27255be1b5d1212fdf95c7cd02ea043affe8d39e3e3f3aab6ab5b75c26a21a82e6a5dadf3af2c3b8c8b79e2132380257be3443e3c26bcef498
-  data.tar.gz: 252b837519d144f6cb8260c1dcec298cd847c3fce9af9338b99705fb4e7ad854b887d08b00b7ec94f053ea0c134f43a8e0a9f0d04af41b32119f74182b34b385
+  metadata.gz: 99fbcbf1c3e43bfe6f0dc2edd10e65e2978f1bee35ee938e9d1b1ad24dcb83a7139a6a03700b6ae357083fc49749c2855c3001ac5437025854871a5e3c3384f7
+  data.tar.gz: 5f6b448c79c65eaad1cfab9c9b1e6c2b4a863136bca3ae54bed317e9445e729798329df3c8e7edb5ae82f6afdf2fde189fcea0e1ebdbbf504ed37ed6cf68d724

data/.codeclimate.yml

@@ -0,0 +1,21 @@
+
+version: "2"
+plugins:
+  bundler-audit:
+    enabled: true
+  fixme:
+    enabled: true
+  flog:
+    enabled: true
+  reek:
+    enabled: true
+  rubocop:
+    enabled: true
+exclude_patterns:
+  - "spec/"
+  - "vendor/"
+  - "Guardfile"
+  - "Rakefile"
+  - "bin/**/*"
+  - "config/**/*.rb"
+  - "script/**/*"

data/.travis.yml

@@ -1,6 +1,6 @@
 env:
   global:
-    - CC_TEST_REPORTER_ID=30c01e786e457860ad57c4d3ecc629c67b08510b170d86764eb360ffd5f7d8db
+    - CC_TEST_REPORTER_ID=97ada6a78eeebe77dc11dacfb31238d8c5c3ba39ccae8dec76279e8176221da5
 language: ruby
 rvm:
   - 2.4

data/CHANGELOG.md

@@ -2,7 +2,25 @@
 
 ## [Unreleased](https://github.com/faker-ruby/faker-bot/tree/HEAD)
 
-[Full Changelog](https://github.com/faker-ruby/faker-bot/compare/v0.4.5...HEAD)
+[Full Changelog](https://github.com/faker-ruby/faker-bot/compare/v0.5.0...HEAD)
+
+**Implemented enhancements:**
+
+- Add Asciinema Demo [\#43](https://github.com/faker-ruby/faker-bot/pull/43) ([akabiru](https://github.com/akabiru))
+
+**Closed issues:**
+
+- Migrate FakerBot CI & QA integrations  [\#30](https://github.com/faker-ruby/faker-bot/issues/30)
+
+**Merged pull requests:**
+
+- Fix gemspec summary [\#45](https://github.com/faker-ruby/faker-bot/pull/45) ([vbrazo](https://github.com/vbrazo))
+- fix: Remove brakeman plugin; it's Rails specific [\#44](https://github.com/faker-ruby/faker-bot/pull/44) ([akabiru](https://github.com/akabiru))
+- Add CodeClimate Configuration [\#42](https://github.com/faker-ruby/faker-bot/pull/42) ([akabiru](https://github.com/akabiru))
+- chore\(docs\): Add Code Level YARD Documentation 📖 [\#35](https://github.com/faker-ruby/faker-bot/pull/35) ([akabiru](https://github.com/akabiru))
+
+## [v0.5.0](https://github.com/faker-ruby/faker-bot/tree/v0.5.0) (2019-07-31)
+[Full Changelog](https://github.com/faker-ruby/faker-bot/compare/v0.4.5...v0.5.0)
 
 **Implemented enhancements:**
 
@@ -20,8 +38,10 @@
 
 **Merged pull requests:**
 
+- Release v0.5.0 [\#41](https://github.com/faker-ruby/faker-bot/pull/41) ([akabiru](https://github.com/akabiru))
 - Add CI & QA Badges [\#34](https://github.com/faker-ruby/faker-bot/pull/34) ([akabiru](https://github.com/akabiru))
 - Chore: CleanUp [\#32](https://github.com/faker-ruby/faker-bot/pull/32) ([akabiru](https://github.com/akabiru))
+- Update README to republish faker-cli [\#29](https://github.com/faker-ruby/faker-bot/pull/29) ([vbrazo](https://github.com/vbrazo))
 
 ## [v0.4.5](https://github.com/faker-ruby/faker-bot/tree/v0.4.5) (2019-07-11)
 [Full Changelog](https://github.com/faker-ruby/faker-bot/compare/v0.4.4...v0.4.5)
@@ -39,7 +59,6 @@
 
 **Merged pull requests:**
 
-- Update README to republish faker-cli [\#29](https://github.com/faker-ruby/faker-bot/pull/29) ([vbrazo](https://github.com/vbrazo))
 - chore: Rename from FakerBot to Faker::CLI [\#28](https://github.com/faker-ruby/faker-bot/pull/28) ([akabiru](https://github.com/akabiru))
 - Add deprecation notes; thank you contributors! 🎉 [\#25](https://github.com/faker-ruby/faker-bot/pull/25) ([akabiru](https://github.com/akabiru))
 
@@ -50,10 +69,13 @@
 
 - Add Unit tests for `FakerBot::Renderer` [\#11](https://github.com/faker-ruby/faker-bot/issues/11)
 
+**Fixed bugs:**
+
+- Skip Gem::Deprecate Warnings; The CLI handles that [\#19](https://github.com/faker-ruby/faker-bot/pull/19) ([akabiru](https://github.com/akabiru))
+
 **Merged pull requests:**
 
 - release v0.4.4 [\#21](https://github.com/faker-ruby/faker-bot/pull/21) ([akabiru](https://github.com/akabiru))
-- Skip Gem::Deprecate Warnings; The CLI handles that [\#19](https://github.com/faker-ruby/faker-bot/pull/19) ([akabiru](https://github.com/akabiru))
 - Touch Up Tests [\#18](https://github.com/faker-ruby/faker-bot/pull/18) ([akabiru](https://github.com/akabiru))
 - chore\(workflow\): Add test runner for dev [\#17](https://github.com/faker-ruby/faker-bot/pull/17) ([akabiru](https://github.com/akabiru))
 - Add CodeClimate [\#16](https://github.com/faker-ruby/faker-bot/pull/16) ([akabiru](https://github.com/akabiru))
@@ -65,9 +87,6 @@
 **Implemented enhancements:**
 
 - Improve Search [\#13](https://github.com/faker-ruby/faker-bot/issues/13)
-
-**Merged pull requests:**
-
 - Improve search functionality [\#14](https://github.com/faker-ruby/faker-bot/pull/14) ([codealchemy](https://github.com/codealchemy))
 
 ## [v0.4.2](https://github.com/faker-ruby/faker-bot/tree/v0.4.2) (2018-10-04)
@@ -81,15 +100,12 @@
 **Fixed bugs:**
 
 - Handle Deprecation Warnings [\#7](https://github.com/faker-ruby/faker-bot/issues/7)
-
-**Merged pull requests:**
-
 - Support `search` for ruby less than 2.4.0 [\#12](https://github.com/faker-ruby/faker-bot/pull/12) ([kfpo](https://github.com/kfpo))
 
 ## [v0.4.1](https://github.com/faker-ruby/faker-bot/tree/v0.4.1) (2018-09-18)
 [Full Changelog](https://github.com/faker-ruby/faker-bot/compare/v0.4.0...v0.4.1)
 
-**Merged pull requests:**
+**Fixed bugs:**
 
 - Handle Deprecation Warnings [\#10](https://github.com/faker-ruby/faker-bot/pull/10) ([shtakai](https://github.com/shtakai))
 
@@ -99,15 +115,12 @@
 **Implemented enhancements:**
 
 - Add flag to show sample faker output [\#5](https://github.com/faker-ruby/faker-bot/issues/5)
+- Include Faker sample output [\#6](https://github.com/faker-ruby/faker-bot/pull/6) ([akabiru](https://github.com/akabiru))
 
 **Fixed bugs:**
 
 - Only show public class methods [\#3](https://github.com/faker-ruby/faker-bot/issues/3)
 
-**Merged pull requests:**
-
-- Include Faker sample output [\#6](https://github.com/faker-ruby/faker-bot/pull/6) ([akabiru](https://github.com/akabiru))
-
 ## [v0.3.0](https://github.com/faker-ruby/faker-bot/tree/v0.3.0) (2018-08-10)
 [Full Changelog](https://github.com/faker-ruby/faker-bot/compare/v0.2.4...v0.3.0)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    faker-bot (0.5.0)
+    faker-bot (0.5.1)
       faker
       pastel (~> 0.7.2)
       thor (~> 0.20.0)
@@ -25,7 +25,7 @@ GEM
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
     equatable (0.6.1)
-    faker (2.0)
+    faker (2.1.0)
       i18n (>= 0.7)
     ffi (1.11.1)
     formatador (0.2.5)

data/README.md

@@ -3,8 +3,14 @@
 [![Build Status](https://travis-ci.org/faker-ruby/faker-bot.svg?branch=master)](https://travis-ci.org/faker-ruby/faker-bot)
 [![Gem Version](https://badge.fury.io/rb/faker-bot.svg)](https://badge.fury.io/rb/faker-bot)
 [![Open Source Helpers](https://www.codetriage.com/faker-ruby/faker-bot/badges/users.svg)](https://www.codetriage.com/faker-ruby/faker-bot)
+[![Maintainability](https://api.codeclimate.com/v1/badges/f40541168a0fafbe1808/maintainability)](https://codeclimate.com/github/faker-ruby/faker-bot/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/f40541168a0fafbe1808/test_coverage)](https://codeclimate.com/github/faker-ruby/faker-bot/test_coverage)
 
-> Quickly look up [Faker](https://github.com/stympy/faker) methods without leaving your terminal!
+> Quickly look up [Faker](https://github.com/faker-ruby/faker) methods without leaving your terminal!
+
+![faker-bot-demo](https://user-images.githubusercontent.com/17295175/62558993-c57be080-b882-11e9-972e-7588408d45c3.gif)
+
+:book: [Code Documentation](https://www.rubydoc.info/github/faker-ruby/faker-bot)
 
 ## Installation
 
@@ -58,14 +64,6 @@ $ faker search name -v
 # ....
 ```
 
-## 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.

data/faker-bot.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Austin Kabiru"]
   spec.email         = ["makabby@gmail.com"]
 
-  spec.summary       = %q{A stympy/faker lookup command line tool.}
+  spec.summary       = %q{A faker-ruby/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"

data/lib/faker/bot/command.rb

@@ -6,16 +6,43 @@ require_relative 'renderer'
 
 module Faker
   module Bot
+    # @abstract interface for [Command] objects
+    #
+    # @api private
+    #
     class Command
       extend Forwardable
 
       def_delegators :command, :run
+
+      # [Command] options
+      #
+      # @return [Hash<Symbol, String => String, Boolean>]
+      #
+      # @api private
+      #
       attr_reader :options
 
+      # Initialize the command
+      #
+      # @param options [Hash<Symbol, String => String, Boolean>]
+      #   The command options
+      #
+      # @api public
+      #
       def initialize(options)
         @options = options
       end
 
+      # Render the command result into [IO]
+      #
+      # @param result {Hash} the render tree
+      # @param output [IO]
+      #
+      # @return [IO]
+      #
+      # @api private
+      #
       def render(result, output)
         Renderer.call(result, options, output)
       end

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

@@ -6,7 +6,17 @@ require_relative '../reflectors/list'
 module Faker
   module Bot
     module Commands
+      # Lists all [Faker<Base>] constants
+      #
+      # @api private
+      #
       class List < Command
+        # Execute the `list` command
+        #
+        # @return [IO]
+        #
+        # @api private
+        #
         def execute(output: $stdout)
           result = Reflectors::List.call(options)
           render(result, output)
@@ -14,12 +24,30 @@ module Faker
 
         private
 
+        # Render the search results
+        #  * Return #not_found when there're no matching results
+        #
+        # @param result [Hash] the render tree
+        # @param output [IO]
+        #
+        # @return [IO]
+        #
+        # @api private
+        #
         def render(result, output)
           return not_found(output) if result.empty?
 
           super(result, output)
         end
 
+        # Render a bespoke "not found" message
+        #
+        # @param output [IO]
+        #
+        # @return [IO]
+        #
+        # @api private
+        #
         def not_found(output)
           output.puts "\nSorry, that class doesn't exist 😢", "\n",
                       'Try something like `Faker::Beer` or `Beer`.', "\n"

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

@@ -6,7 +6,17 @@ require_relative '../reflectors/search'
 module Faker
   module Bot
     module Commands
+      # Runs a search against [Faker<Base>] methods and returns matching results
+      #
+      # @api private
+      #
       class Search < Command
+        # Execute the `search` command
+        #
+        # @return [IO]
+        #
+        # @api private
+        #
         def execute(input, output: $stdout)
           result = Reflectors::Search.call(input)
           render(result, output)
@@ -14,12 +24,30 @@ module Faker
 
         private
 
+        # Render the search results
+        #  * Return #not_found when there're no matching results
+        #
+        # @param result [Hash] the render tree
+        # @param output [IO]
+        #
+        # @return [IO]
+        #
+        # @api private
+        #
         def render(result, output)
           return not_found(output) if result.empty?
 
           super(result, output)
         end
 
+        # Render a bespoke "not found" message
+        #
+        # @param output [IO]
+        #
+        # @return [IO]
+        #
+        # @api private
+        #
         def not_found(output)
           output.puts "\nSorry, we couldn't find a match 😢", "\n"
         end

data/lib/faker/bot/reflector.rb

@@ -4,18 +4,22 @@ require 'faker'
 
 module Faker
   module Bot
-    # Abstract `Faker` Reflector - introspects the `Faker` module
+    # @abstract `Faker::Base` Reflection object
+    # * Introspects the `Faker::Base` class and it's descendants
     #
     # @api private
-    # @abstract
     #
     class Reflector
       Faker::Base.class_eval do
         # Skip default deprecation warning output; the CLI will display that.
         Gem::Deprecate.skip = true
 
-        # Select `Faker` subclasses
-        # @return [Array] `Faker::Base` sub classes
+        # Select [Faker<Base>] subclasses
+        #
+        # @return [Array<Class>] `Faker::Base` subclasses
+        #
+        # @api private
+        #
         def self.descendants
           @descendants ||= ObjectSpace.each_object(Class).select do |klass|
             klass < self
@@ -23,26 +27,67 @@ module Faker
         end
 
         # Select public class methods
-        # @return [Array] public methods
+        #
+        # @return [Array] singleton public methods
+        #
+        # @api private
+        #
         def self.my_singleton_methods
           singleton_methods(false).select { |m| respond_to?(m) }
         end
       end
 
+      # @example Faker::Base subclasses with their methods
+      #   { Faker::Marketing => [:buzzwords], Faker::Artist => [:name] }
+      #
+      # @return [Hash[Class => [Array<Symbol>]]
+      #
+      # @api private
+      #
       attr_reader :descendants_with_methods
 
+      # Alternate constructor
+      #
+      # @see #initialize
+      # @see #call
+      #
+      # @api public
+      #
+      def self.call(*args)
+        new(*args).call
+      end
+
+      # Initialize the reflector
+      #
+      # @api public
+      #
       def initialize(*)
         @descendants_with_methods = Hash.new { |h, k| h[k] = [] }
       end
 
       protected
 
+      # Adds a `Faker::Base` descendant methods to the method list
+      #
+      # @param descendant [Class] The `Faker::Base` subclass
+      # @param methods [Array<Symbol>] The `Faker::Base` subclass methods
+      #
+      # @return [Array<Symbol>]
+      #
+      # @api private
+      #
       def store(descendant, methods)
         return if methods.empty?
 
         descendants_with_methods[descendant].concat(methods)
       end
 
+      # Get all `Faker::Base` subclasses
+      #
+      # @return [Array<Class>]
+      #
+      # @api public
+      #
       def faker_descendants
         @faker_descendants ||= Faker::Base.descendants
       end

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

@@ -5,17 +5,34 @@ require_relative '../reflector'
 module Faker
   module Bot
     module Reflectors
-      # List command reflector
+      # Reflection object that lists all `Faker::Base` subclasses
+      #
       # @api private
       #
       class List < Reflector
+        # Output filter
+        #
+        # @return [String, nil]
+        #
+        # @api private
+        #
         attr_reader :filter
+        # Boolean flag on whether to list methods or not
+        #
+        # @return [Boolean, nil]
+        #
+        # @api private
+        #
         attr_reader :show_methods
 
-        def self.call(options)
-          new(options).call
-        end
-
+        # Initialize list reflector
+        #
+        # @param options [Hash{Symbol => Boolean, nil}] Reflector options
+        # @option options [Boolean, nil] :show_method
+        #   Show methods in listing boolean flag
+        #
+        # @api public
+        #
         def initialize(options = {})
           @filter = options[:filter]
           @show_methods = options[:show_methods]
@@ -23,17 +40,39 @@ module Faker
           super
         end
 
+        # List `Faker::Base` subclasses
+        #
+        # @return [Hash<Class => <Array<Symbol>>] when #show_methods is truthy
+        #
+        # @api private
+        #
         def call
-          show_methods ? list_descendants_with_methods : list_descendants
+          if show_methods
+            list_descendants_with_methods
+          else
+            list_descendants
+          end
         end
 
         private
 
+        # List `Faker::Base` subclasses with methods
+        #
+        # @return [Hash{Class => <Array<Symbol>}]
+        #
+        # @api private
+        #
         def list_descendants_with_methods
           list_descendants
           descendants_with_methods
         end
 
+        # List `Faker::Base` subclasses
+        #
+        # @return [Array<Class>]
+        #
+        # @api private
+        #
         def list_descendants
           faker_descendants.each do |descendant|
             if filter_matches_class_name?(descendant.to_s)
@@ -43,9 +82,16 @@ module Faker
           descendants_with_methods.keys
         end
 
+        # Match against class name when filter is defined
+        #
+        # @return [Boolean]
+        #
+        # @api private
+        #
         def filter_matches_class_name?(class_name)
           return true unless filter
-          class_name.match(/#{filter}/)
+
+          class_name.match(/#{filter}/i)
         end
       end
     end

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

@@ -5,22 +5,38 @@ require_relative '../reflector'
 module Faker
   module Bot
     module Reflectors
-      # Find command reflector
+      # Reflection object that searches all `Faker::Base` subclass methods
+      #  * Currently operates at O(n); improvements welcome. :)
+      #
       # @api private
       #
       class Search < Reflector
+        # Reflector query
+        #
+        # @return [String, nil]
+        #
+        # @api private
+        #
         attr_reader :query
 
-        def self.call(query)
-          new(query).call
-        end
-
+        # Initialize search reflector
+        #
+        # @param query [String] The search query
+        #
+        # @api public
+        #
         def initialize(query)
           @query = query.downcase
 
           super
         end
 
+        # Search through `Faker::Base` subclasses and return matching results
+        #
+        # @return [Hash<Class => <Array<Symbol>>] when #show_methods is truthy
+        #
+        # @api private
+        #
         def call
           search_descendants_matching_query
           descendants_with_methods
@@ -28,23 +44,33 @@ module Faker
 
         private
 
+        # Search through `Faker::Base` subclasses and store matching results
+        #
+        # @api private
+        #
         def search_descendants_matching_query
           faker_descendants.each do |descendant|
             methods = descendant.my_singleton_methods
-            if query_matches_class_name?(descendant.to_s)
+
+            if query_matches?(descendant)
               store(descendant, methods)
             else
-              store(descendant, methods.select { |method| query_matches_method?(method.to_s) })
+              store(
+                descendant,
+                methods.select { |method| query_matches?(method) }
+              )
             end
           end
         end
 
-        def query_matches_method?(method_name)
-          method_name.match(/#{query}/)
-        end
-
-        def query_matches_class_name?(class_name)
-          class_name.downcase.match(/#{query}/)
+        # Match a subject against the query string
+        #
+        # @return [Boolean]
+        #
+        # @api private
+        #
+        def query_matches?(subject)
+          subject.to_s.match(/#{query}/i)
         end
       end
     end

data/lib/faker/bot/renderer.rb

@@ -7,21 +7,45 @@ require 'tty/tree'
 
 module Faker
   module Bot
+    # A class responsible for printing output to an [IO] interface
+    #
+    # @api private
+    #
     class Renderer
+      DEPRECATION_WARNING = ' ( WILL BE DEPRECATED )'
+      EMPTY = ''
+      NOT_AVAILABLE = 'N/A'
+
       attr_reader :crayon, :hash, :options, :output, :pager
 
       def self.call(*args)
         new(*args).call
       end
 
+      # Initialize a Render
+      #
+      # @param hash [Hash<Class => <Array<Symbol>>]
+      # @param options [Hash]
+      # @param output [IO]
+      #
+      # @api public
+      #
       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
 
+      # Print paginated output if the terminal interface supports pagination.
+      # Otherwise, just print the full output
+      #
+      # @return [IO]
+      #
+      # @api private
+      #
       def call
         if paginable?
           pager.page(render)
@@ -30,24 +54,54 @@ module Faker
         end
       end
 
+      # Render the structured data tree
+      #
+      # @return [String]
+      #
+      # @api private
+      #
       def render
         tree.render
       end
 
+      # Warm up the structured data tree render object
+      #
+      # @return [TTY<Tree>]
+      #
+      # @api private
+      #
       def tree
         @tree ||= TTY::Tree.new(build_tree)
       end
 
+      # Check whether the terminal interface supports pagination
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      #
       def paginable?
         gt_screen_height? && output.tty?
       end
 
+      # Check whether the tree size is greater than current screen height
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      #
       def gt_screen_height?
         tree.nodes.size > TTY::Screen.height
       end
 
       private
 
+      # Build the structured data tree sorted alphabetically
+      #
+      # @return [Hash{Class => <Array<Symbol>}]
+      #
+      # @api private
+      #
       def build_tree
         results = hash.reduce({}) do |h, (const, methods)|
           h.merge! node(const, methods&.sort)
@@ -56,37 +110,84 @@ module Faker
         results.sort_by(&:to_s).to_h
       end
 
+      # Tree node builder with color
+      #
+      # @return [Hash{Class => <Array<Symbol>}]
+      #
+      # @api private
+      #
       def node(const, methods)
         {
           crayon.green(const.to_s) => leaf(const, methods)
         }
       end
 
+      # Tree leaf builder with color
+      #
+      # @return [Array<Symbol>]
+      #
+      # @api private
+      #
       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? }
+        [method.to_s].tap do |arr|
+          verbose_output(method, const, arr) if verbose?
+        end
       end
 
+      # Boolean verbose option flag
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      #
       def verbose?
         options[:verbose]
       end
 
+      # Generate verbose output via sample fake data
+      #
+      # @return [Array<String>]
+      #
+      # @api private
+      #
       def verbose_output(method, const, arr)
         fake, message = faker_method(method, const)
-        arr << crayon.dim.white("=> #{fake}") << crayon.dim.magenta.bold(message.to_s)
+
+        arr.push(crayon.dim.white("=> #{fake}"))
+           .push(crayon.dim.magenta.bold(message.to_s))
       end
 
+      # Send message to Faker object; receive sample fake data
+      #
+      # @return [Array<String>]
+      #
+      # @api private
+      #
       def faker_method(method, const)
-        [const.public_send(method), ensure_method_is_supported(method, const)]
+        [
+          const.public_send(method),
+          ensure_method_is_supported(method, const)
+        ]
       rescue ArgumentError => _e
-        ['N/A', '']
+        [NOT_AVAILABLE, EMPTY]
       end
 
+      # Mark deprecated methods
+      #
+      # @return [String]
+      #
+      # @api private
+      #
       def ensure_method_is_supported(method, const)
-        const.respond_to?(:"_deprecated_#{method}") ? ' ( WILL BE DEPRECATED )' : ''
+        if const.respond_to?(:"_deprecated_#{method}")
+          DEPRECATION_WARNING
+        else
+          EMPTY
+        end
       end
     end
   end

data/lib/faker/bot/version.rb

@@ -2,6 +2,6 @@
 
 module Faker
   module Bot
-    VERSION = '0.5.0'
+    VERSION = '0.5.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faker-bot
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Austin Kabiru
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-31 00:00:00.000000000 Z
+date: 2019-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faker
@@ -200,6 +200,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".github/main.workflow"
 - ".gitignore"
 - ".rspec"
@@ -251,5 +252,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: A stympy/faker lookup command line tool.
+summary: A faker-ruby/faker lookup command line tool.
 test_files: []