fakerbot 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5088f42e2b2ebe474794900ef68c9c82082577f
-  data.tar.gz: e2c0b519a845ad6060aded36dccae8550fd4675f
+  metadata.gz: 837cc2d92e1c31ad78fd7adc057fb11178d89bea
+  data.tar.gz: 02e139d11db43948282be5cf4694cdc1cdda9db2
 SHA512:
-  metadata.gz: ddcbc76eb1255fbcc9eab56f68da1e16df9f988c6a03061e524aba571dc41da5ea235adcad6de839eb60c59fe987843eb49307ccd3ac02713b6ae1363febf9d5
-  data.tar.gz: a1595e16fba24d51b280fc5a14d044c7288a26633d38143f6f97afe86184bc62ec05791c5c27c6e39c660477d74ff7c514390a60294b2673c58147f3bda8b2ff
+  metadata.gz: 82e8003271e1e494021551910a83b8c252a41f0aae71fb77b01c067ac2efafda4b456a8d56714544dde8d7f888d0161ee2966ce14efb75534f043ce8faf8d465
+  data.tar.gz: bca6bd5310bf359267b52ad0ea2ac454dfc0432e59bd023d13e54e2857e645e939eb8d52e900a4758b93e04b623ac9b6b55605083415beff49c82c0770426f9d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fakerbot (0.2.4)
+    fakerbot (0.3.0)
       faker
       pastel (~> 0.7.2)
       thor (~> 0.20.0)

data/lib/fakerbot/bot.rb

@@ -20,10 +20,10 @@ module FakerBot
       end
     end
 
-    attr_reader :matching_descendants, :query
+    attr_reader :descendants_with_methods, :query
 
-    def initialize(query)
-      @matching_descendants = Hash.new { |h, k| h[k] = [] }
+    def initialize(query = nil)
+      @descendants_with_methods = Hash.new { |h, k| h[k] = [] }
       @query = query
     end
 
@@ -31,26 +31,41 @@ module FakerBot
       def find(query)
         new(query).find
       end
+
+      def list(verbose: false)
+        new.list(verbose)
+      end
     end
 
     def find
       search_descendants_matching_query
-      matching_descendants
+      descendants_with_methods
+    end
+
+    def list(verbose)
+      verbose ? all_descendants_with_methods : faker_descendants
     end
 
     private
 
+    def all_descendants_with_methods
+      faker_descendants.each do |faker|
+        store(faker, faker.my_singleton_methods)
+      end
+      descendants_with_methods
+    end
+
     def search_descendants_matching_query
       faker_descendants.each do |faker|
         methods = faker.my_singleton_methods
         matching = methods.select { |m| m.match?(/#{query}/i) }
-        save_matching(faker, matching)
+        store(faker, matching)
       end
     end
 
-    def save_matching(descendant, matching)
-      return if matching.empty?
-      matching_descendants[descendant].concat(matching)
+    def store(descendant, methods)
+      return if methods.empty?
+      descendants_with_methods[descendant].concat(methods)
     end
 
     def faker_descendants

data/lib/fakerbot/cli.rb

@@ -3,6 +3,7 @@
 require 'thor'
 require 'fakerbot/cli'
 require 'fakerbot/version'
+require 'fakerbot/commands/list'
 require 'fakerbot/commands/search'
 
 module FakerBot
@@ -16,11 +17,24 @@ module FakerBot
     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 :verbose, aliases: '-v', type: :boolean,
+                            desc: 'Display Faker constants with methods'
+    def list(*)
+      if options[:help]
+        invoke :help, ['list']
+      else
+        FakerBot::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 :verbose, aliases: '-v', type: :boolean,
-                            desc: 'Display Faker classes with methods'
+                            desc: 'Display Faker constants methods with examples'
     def search(query)
       if options[:help]
         invoke :help, ['search']

data/lib/fakerbot/command.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'pastel'
+require 'tty/pager'
+require 'tty/tree'
+
+module FakerBot
+  class Command
+    extend Forwardable
+
+    def_delegators :command, :run
+
+    def pager
+      TTY::Pager.new(command: 'less -R')
+    end
+
+    def screen
+      TTY::Screen
+    end
+
+    def tree(input)
+      TTY::Tree.new do
+        input.each do |faker, methods|
+          node Pastel.new.green(faker.to_s) do
+            methods&.each { |m| leaf Pastel.new.cyan(m.to_s) }
+          end
+        end
+      end
+    end
+
+    def render(result, output = $stdout)
+      result_tree = tree(result)
+      view = result_tree.render
+      if screen.height < result_tree.nodes.size
+        # paginate when attached to terminal
+        output.tty? ? pager.page(view) : output.puts(view)
+      else
+        output.puts view
+      end
+    end
+  end
+end

data/lib/fakerbot/commands/list.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+
+module FakerBot
+  module Commands
+    class List < FakerBot::Command
+      def initialize(options)
+        @options = options
+      end
+
+      def execute(output: $stdout)
+        render FakerBot::Bot.list(verbose: @options[:verbose]), output
+      end
+    end
+  end
+end

data/lib/fakerbot/commands/search.rb

@@ -1,45 +1,24 @@
 # frozen_string_literal: true
 
-require 'pastel'
-require 'tty/pager'
-require 'tty/tree'
 require 'fakerbot/bot'
+require_relative '../command'
 
 module FakerBot
   module Commands
-    class Search
+    class Search < FakerBot::Command
       def initialize(options)
         @options = options
-        @pager = TTY::Pager.new(command: 'less -R')
-        @screen = TTY::Screen
       end
 
-      def execute(input)
-        render FakerBot::Bot.find(input)
+      def execute(input, output: $stdout)
+        render FakerBot::Bot.find(input), output
       end
 
       private
 
-      attr_reader :screen, :pager
-
-      def render(result)
+      def render(result, output)
         return not_found if result.empty?
-        output = tree(result)
-        if screen.height < output.nodes.size
-          pager.page output.render
-        else
-          puts output.render
-        end
-      end
-
-      def tree(input)
-        TTY::Tree.new do
-          input.each do |faker, methods|
-            node Pastel.new.green(faker.to_s) do
-              methods.each { |m| leaf Pastel.new.cyan(m.to_s) }
-            end
-          end
-        end
+        super(result, output)
       end
 
       def not_found

data/lib/fakerbot/templates/list/.gitkeep

@@ -0,0 +1 @@
+#

data/lib/fakerbot/version.rb

@@ -1,3 +1,3 @@
 module FakerBot
-  VERSION = '0.2.4'.freeze
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fakerbot
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Austin Kabiru
@@ -204,7 +204,10 @@ files:
 - lib/fakerbot.rb
 - lib/fakerbot/bot.rb
 - lib/fakerbot/cli.rb
+- lib/fakerbot/command.rb
+- lib/fakerbot/commands/list.rb
 - lib/fakerbot/commands/search.rb
+- lib/fakerbot/templates/list/.gitkeep
 - lib/fakerbot/version.rb
 homepage: https://github.com/akabiru/fakerbot
 licenses: