faker-bot 0.4.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0d9f5879fc71514770f70096568eddd9e69e61922ce46a3e63cbfd3310d7e85
-  data.tar.gz: 91339a22891160fe23425c73d022e1545204608e0556179cb38c6677f8c9d197
+  metadata.gz: 4a409150c431509d7ccda5b95da8d39505da24b64f7d4d13a30674765750e266
+  data.tar.gz: 17ec8d367dff5cf0c089ec785ace9b909e7c6b4f3aaaaaacb24f3a9ef0f558cd
 SHA512:
-  metadata.gz: 7ad7bdbc091932be9d3dd3d4767830e43c8abc9a49192787e7acecd673383dcd2c77c6db4824edcbc02595ab4b64174a054918b6bad7b60da06e4e18a48168b0
-  data.tar.gz: 777a6b40d91aed4f13376e8aeb64197950fe963fcee7f7237e1c97c8076e1134d8feaef59441fe9b75f245a3b586234cb7141e5681d89c618a6aab8d3cf43518
+  metadata.gz: 02cccefaf2d42f27255be1b5d1212fdf95c7cd02ea043affe8d39e3e3f3aab6ab5b75c26a21a82e6a5dadf3af2c3b8c8b79e2132380257be3443e3c26bcef498
+  data.tar.gz: 252b837519d144f6cb8260c1dcec298cd847c3fce9af9338b99705fb4e7ad854b887d08b00b7ec94f053ea0c134f43a8e0a9f0d04af41b32119f74182b34b385

data/.ruby-version

@@ -1 +1 @@
-2.4.0
+2.5.3

data/CHANGELOG.md

@@ -0,0 +1,143 @@
+# Change Log
+
+## [Unreleased](https://github.com/faker-ruby/faker-bot/tree/HEAD)
+
+[Full Changelog](https://github.com/faker-ruby/faker-bot/compare/v0.4.5...HEAD)
+
+**Implemented enhancements:**
+
+- Let `faker list` accept arguments [\#20](https://github.com/faker-ruby/faker-bot/issues/20)
+- Allow list to accept filter and match on class name [\#39](https://github.com/faker-ruby/faker-bot/pull/39) ([bpleslie](https://github.com/bpleslie))
+- Allow search to accept namespaces and partial matches [\#38](https://github.com/faker-ruby/faker-bot/pull/38) ([bpleslie](https://github.com/bpleslie))
+
+**Fixed bugs:**
+
+- Skip Faker Deprecation Warnings; The CLI handles that - II [\#33](https://github.com/faker-ruby/faker-bot/pull/33) ([akabiru](https://github.com/akabiru))
+
+**Closed issues:**
+
+- Fakerbot not searching namespace [\#36](https://github.com/faker-ruby/faker-bot/issues/36)
+
+**Merged pull requests:**
+
+- 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))
+
+## [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)
+
+**Implemented enhancements:**
+
+- faker-bot should be a separate gem [\#26](https://github.com/faker-ruby/faker-bot/issues/26)
+- Gem name should be faker-bot [\#31](https://github.com/faker-ruby/faker-bot/pull/31) ([vbrazo](https://github.com/vbrazo))
+- Distribute Faker::Reflector Responsibilities [\#22](https://github.com/faker-ruby/faker-bot/pull/22) ([akabiru](https://github.com/akabiru))
+
+**Closed issues:**
+
+- Integrate faker-bot in faker-ruby organization [\#27](https://github.com/faker-ruby/faker-bot/issues/27)
+- Fix "NestedIterators" issue in lib/fakerbot/reflectors/search.rb [\#24](https://github.com/faker-ruby/faker-bot/issues/24)
+
+**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))
+
+## [v0.4.4](https://github.com/faker-ruby/faker-bot/tree/v0.4.4) (2019-01-18)
+[Full Changelog](https://github.com/faker-ruby/faker-bot/compare/v0.4.3...v0.4.4)
+
+**Implemented enhancements:**
+
+- Add Unit tests for `FakerBot::Renderer` [\#11](https://github.com/faker-ruby/faker-bot/issues/11)
+
+**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))
+- Update main.workflow [\#15](https://github.com/faker-ruby/faker-bot/pull/15) ([akabiru](https://github.com/akabiru))
+
+## [v0.4.3](https://github.com/faker-ruby/faker-bot/tree/v0.4.3) (2018-10-07)
+[Full Changelog](https://github.com/faker-ruby/faker-bot/compare/v0.4.2...v0.4.3)
+
+**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)
+[Full Changelog](https://github.com/faker-ruby/faker-bot/compare/v0.4.1...v0.4.2)
+
+**Implemented enhancements:**
+
+- Handle Deprecation Warnings [\#7](https://github.com/faker-ruby/faker-bot/issues/7)
+- Sort `fakerbot list` alphabetically [\#4](https://github.com/faker-ruby/faker-bot/issues/4)
+
+**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:**
+
+- Handle Deprecation Warnings [\#10](https://github.com/faker-ruby/faker-bot/pull/10) ([shtakai](https://github.com/shtakai))
+
+## [v0.4.0](https://github.com/faker-ruby/faker-bot/tree/v0.4.0) (2018-08-13)
+[Full Changelog](https://github.com/faker-ruby/faker-bot/compare/v0.3.0...v0.4.0)
+
+**Implemented enhancements:**
+
+- Add flag to show sample faker output [\#5](https://github.com/faker-ruby/faker-bot/issues/5)
+
+**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)
+
+**Merged pull requests:**
+
+- Add `fakerbot list` Command [\#2](https://github.com/faker-ruby/faker-bot/pull/2) ([akabiru](https://github.com/akabiru))
+
+## [v0.2.4](https://github.com/faker-ruby/faker-bot/tree/v0.2.4) (2018-08-10)
+[Full Changelog](https://github.com/faker-ruby/faker-bot/compare/v0.2.3...v0.2.4)
+
+## [v0.2.3](https://github.com/faker-ruby/faker-bot/tree/v0.2.3) (2018-08-09)
+[Full Changelog](https://github.com/faker-ruby/faker-bot/compare/v0.2.1...v0.2.3)
+
+## [v0.2.1](https://github.com/faker-ruby/faker-bot/tree/v0.2.1) (2018-08-09)
+[Full Changelog](https://github.com/faker-ruby/faker-bot/compare/v0.2.0...v0.2.1)
+
+## [v0.2.0](https://github.com/faker-ruby/faker-bot/tree/v0.2.0) (2018-08-09)
+[Full Changelog](https://github.com/faker-ruby/faker-bot/compare/v0.1.2...v0.2.0)
+
+## [v0.1.2](https://github.com/faker-ruby/faker-bot/tree/v0.1.2) (2018-07-24)
+[Full Changelog](https://github.com/faker-ruby/faker-bot/compare/v0.1.1...v0.1.2)
+
+## [v0.1.1](https://github.com/faker-ruby/faker-bot/tree/v0.1.1) (2018-07-03)
+[Full Changelog](https://github.com/faker-ruby/faker-bot/compare/v0.1.0...v0.1.1)
+
+## [v0.1.0](https://github.com/faker-ruby/faker-bot/tree/v0.1.0) (2018-07-03)
+**Merged pull requests:**
+
+- Add Reflectors [\#1](https://github.com/faker-ruby/faker-bot/pull/1) ([akabiru](https://github.com/akabiru))
+
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    faker-bot (0.4.5)
+    faker-bot (0.5.0)
       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 (1.9.6)
+    faker (2.0)
       i18n (>= 0.7)
     ffi (1.11.1)
     formatador (0.2.5)

data/Guardfile

@@ -1,31 +1,7 @@
 # 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)
@@ -41,32 +17,4 @@ guard :rspec, cmd: 'bundle exec rspec' do
   # 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/README.md

@@ -1,5 +1,9 @@
 # faker-bot
 
+[![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)
+
 > Quickly look up [Faker](https://github.com/stympy/faker) methods without leaving your terminal!
 
 ## Installation

data/lib/faker/bot.rb

@@ -10,42 +10,41 @@ 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
+      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(filter = nil)
+        if options[:help]
+          invoke :help, ['list']
+        else
+          filter_options = options.merge(filter: filter)
+          Faker::Bot::Commands::List.new(filter_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
+      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

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

@@ -11,6 +11,19 @@ module Faker
           result = Reflectors::List.call(options)
           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, that class doesn't exist 😢", "\n",
+                      'Try something like `Faker::Beer` or `Beer`.', "\n"
+        end
       end
     end
   end

data/lib/faker/bot/reflector.rb

@@ -11,6 +11,9 @@ module Faker
     #
     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
         def self.descendants

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

@@ -9,6 +9,7 @@ module Faker
       # @api private
       #
       class List < Reflector
+        attr_reader :filter
         attr_reader :show_methods
 
         def self.call(options)
@@ -16,22 +17,35 @@ module Faker
         end
 
         def initialize(options = {})
+          @filter = options[:filter]
           @show_methods = options[:show_methods]
 
           super
         end
 
         def call
-          show_methods ? all_descendants_with_methods : faker_descendants
+          show_methods ? list_descendants_with_methods : list_descendants
         end
 
         private
 
-        def all_descendants_with_methods
+        def list_descendants_with_methods
+          list_descendants
+          descendants_with_methods
+        end
+
+        def list_descendants
           faker_descendants.each do |descendant|
-            store(descendant, descendant.my_singleton_methods)
+            if filter_matches_class_name?(descendant.to_s)
+              store(descendant, descendant.my_singleton_methods)
+            end
           end
-          descendants_with_methods
+          descendants_with_methods.keys
+        end
+
+        def filter_matches_class_name?(class_name)
+          return true unless filter
+          class_name.match(/#{filter}/)
         end
       end
     end

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

@@ -16,7 +16,7 @@ module Faker
         end
 
         def initialize(query)
-          @query = query
+          @query = query.downcase
 
           super
         end
@@ -31,14 +31,20 @@ module Faker
         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)
+            if query_matches_class_name?(descendant.to_s)
+              store(descendant, methods)
+            else
+              store(descendant, methods.select { |method| query_matches_method?(method.to_s) })
+            end
           end
         end
 
-        def query_matches?(method_name)
-          method_name_parts = method_name.split(/_/).reject(&:empty?)
-          query.match(/#{method_name_parts.join('|')}/)
+        def query_matches_method?(method_name)
+          method_name.match(/#{query}/)
+        end
+
+        def query_matches_class_name?(class_name)
+          class_name.downcase.match(/#{query}/)
         end
       end
     end

data/lib/faker/bot/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faker-bot
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.0
 platform: ruby
 authors:
 - Austin Kabiru
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-09 00:00:00.000000000 Z
+date: 2019-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faker
@@ -206,6 +206,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -217,7 +218,6 @@ files:
 - 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
@@ -228,7 +228,6 @@ files:
 - 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
@@ -249,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.9
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A stympy/faker lookup command line tool.

data/lib/faker/renderer.rb

@@ -1,91 +0,0 @@
-# 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