rubocop-faker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d656a993af8fbade3cb0a33710650fefc7d1589aabd0bf311277b53420d35902
+  data.tar.gz: ca08d83c826333f7dadccca91e37ef7897c50f2b33fd0821977918ca982ccb21
+SHA512:
+  metadata.gz: 703a11af3986d36b98d035830aadc56ed3cfff3ed72c1529ff23a5f4c9c403f8b624cb32de252adfabeb15c40c0660be4da5c25acefdd11c3f33e09e2a60921c
+  data.tar.gz: cd2b9c97746bdbfb01a53c17078b2e279279466db796b5c5f547ec272122a85a6ea3ddc29170e59725ab2724d4f1e9883b8e00f8e0da7297711cd02bdc92f983

data/.circleci/config.yml

@@ -0,0 +1,43 @@
+version: 2.1
+
+jobs:
+  rake_default:
+    parameters:
+      image:
+        description: "Name of the Docker image."
+        type: string
+        default: "circleci/ruby"
+    docker:
+      - image: << parameters.image >>
+    environment:
+      # CircleCI container has two cores, but Ruby can see 32 cores. So we
+      # configure test-queue.
+      # See https://github.com/tmm1/test-queue#environment-variables
+      TEST_QUEUE_WORKERS: 2
+      JRUBY_OPTS: "--dev -J-Xmx1000M"
+    steps:
+      - checkout
+      - run: bundle install
+      - run: bundle exec rake
+
+workflows:
+  build:
+    jobs:
+      - rake_default:
+          name: Ruby 2.3
+          image: circleci/ruby:2.3
+      - rake_default:
+          name: Ruby 2.4
+          image: circleci/ruby:2.4
+      - rake_default:
+          name: Ruby 2.5
+          image: circleci/ruby:2.5
+      - rake_default:
+          name: Ruby 2.6
+          image: circleci/ruby:2.6
+      - rake_default:
+          name: Ruby HEAD
+          image: rubocophq/circleci-ruby-snapshot:latest # Nightly snapshot build
+      - rake_default:
+          name: JRuby 9.2
+          image: circleci/jruby:9.2

data/.gitignore

@@ -0,0 +1,61 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+Gemfile.lock
+Gemfile.local
+
+# rbenv
+.ruby-version
+
+# rspec
+/spec/examples.txt
+/.test_queue_stats
+
+# jeweler generated
+pkg
+
+# etags
+TAGS
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.rspec

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

data/.rspec_status

@@ -0,0 +1,4 @@
+example_id                        | status | run_time        |
+--------------------------------- | ------ | --------------- |
+./spec/rubocop/faker_spec.rb[1:1] | passed | 0.00103 seconds |
+./spec/rubocop/faker_spec.rb[1:2] | failed | 0.0248 seconds  |

data/.rubocop.yml

@@ -0,0 +1,81 @@
+inherit_from: .rubocop_todo.yml
+
+# This is the configuration used to check the rubocop source code.
+
+require:
+  - rubocop/cop/internal_affairs
+  - rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Naming/PredicateName:
+  # Method define macros for dynamically generated method.
+  MethodDefinitionMacros:
+    - define_method
+    - define_singleton_method
+    - def_node_matcher
+    - def_node_search
+
+Style/FormatStringToken:
+  # Because we parse a lot of source codes from strings. Percent arrays
+  # look like unannotated format string tokens to this cop.
+  Exclude:
+    - test/**/*
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Layout/ClassStructure:
+  Enabled: true
+  Categories:
+    module_inclusion:
+      - include
+      - prepend
+      - extend
+  ExpectedOrder:
+      - module_inclusion
+      - constants
+      - public_class_methods
+      - initializer
+      - instance_methods
+      - protected_methods
+      - private_methods
+
+# Trailing white space is meaningful in code examples
+Layout/TrailingWhitespace:
+  AllowInHeredoc: true
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'test/**/*.rb'
+
+Lint/InterpolationCheck:
+  Exclude:
+    - 'test/**/*.rb'
+
+Lint/UselessAccessModifier:
+  MethodCreatingMethods:
+    - 'def_matcher'
+    - 'def_node_matcher'
+
+Lint/BooleanSymbol:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - '**/*.gemspec'
+
+Naming/FileName:
+  Exclude:
+    - lib/rubocop-faker.rb
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'test/**/*.rb'
+
+Performance/ChainArrayAllocation:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,23 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-08-07 15:41:02 +0900 using RuboCop version 0.74.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+Metrics/AbcSize:
+  Max: 17
+
+# Offense count: 5
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 14
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 87

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.0.pre.1

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## master (unreleased)
+
+## 0.1.0 (2019-09-02)
+
+### New features
+
+* Create RuboCop Faker gem. ([@koic][])
+
+[@koic]: https://github.com/koic

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gemspec
+
+gem 'rake'
+gem 'rspec'
+gem 'rubocop', github: 'rubocop-hq/rubocop'
+gem 'rubocop-performance', '~> 1.4.0'
+gem 'yard', '~> 0.9'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Koichi ITO
+
+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,63 @@
+# RuboCop Faker
+
+A [RuboCop](https://github.com/rubocop-hq/rubocop) extension for [Faker](https://github.com/faker-ruby/faker).
+
+RuboCop Faker is a tool for converting your Faker's methods to the latest Faker argument style with static code analysis.
+
+With RuboCop Faker you can upgrade your Faker 1 codes to Faker 2 in no time. It supports [conversions](https://github.com/koic/rubocop-faker/blob/master/config/default.yml) for almost all of the Faker 2 changes.
+
+## Installation
+
+Just install the `rubocop-faker` gem
+
+```sh
+gem install rubocop-faker
+```
+
+or if you use bundler put this in your `Gemfile`
+
+```ruby
+gem 'rubocop-faker'
+```
+
+## Examples
+
+Here's an example.
+
+```ruby
+Faker::Avatar.image(slug, size, format, set, bgset)
+```
+
+RuboCop Faker would convert it to the following Faker 2 form:
+
+```
+Faker::Avatar.image(slug: slug, size: size, format: format, set: set, bgset: bgset)
+```
+
+## Usage
+
+You need to tell RuboCop to load the Faker extension.
+
+This gem offers the only `Faker/DeprecatedArguments` cop. It is intended to convert a Faker 2 compatible interface.
+
+### Command line
+
+Check positional argument style before Faker 2.
+
+```console
+% rubocop --require rubocop-faker --only Faker/DeprecatedArguments
+```
+
+Auto-correction to keyword argument style on Faker 2.
+
+```console
+% rubocop --require rubocop-faker --only Faker/DeprecatedArguments --auto-correct
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/koic/rubocop-faker.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'bundler'
+require 'bundler/gem_tasks'
+
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Run RSpec with code coverage'
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['spec'].execute
+end
+
+desc 'Run RuboCop over itself'
+RuboCop::RakeTask.new(:internal_investigation).tap do |task|
+  if RUBY_ENGINE == 'ruby' &&
+     RbConfig::CONFIG['host_os'] !~ /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+    task.options = %w[--parallel]
+  end
+end
+
+task default: %i[
+  documentation_syntax_check
+  generate_cops_documentation
+  spec
+  internal_investigation
+]
+
+desc 'Generate a new cop template'
+task :new_cop, [:cop] do |_task, args|
+  require 'rubocop'
+
+  cop_name = args.fetch(:cop) do
+    warn 'usage: bundle exec rake new_cop[Department/Name]'
+    exit!
+  end
+
+  github_user = `git config github.user`.chop
+  github_user = 'your_id' if github_user.empty?
+
+  generator = RuboCop::Cop::Generator.new(cop_name, github_user)
+
+  generator.write_source
+  generator.write_spec
+  generator.inject_require(
+    root_file_path: 'lib/rubocop/cop/faker_cops.rb'
+  )
+  generator.inject_config(config_file_path: 'config/default.yml')
+
+  puts generator.todo
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rubocop/faker'
+
+# 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
+
+require 'irb'
+IRB.start(__FILE__)

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/config/default.yml

@@ -0,0 +1,450 @@
+# This is the default configuration file.
+
+Faker/DeprecatedArguments:
+  Description: 'Checks that Faker arguments style is based on Faker 2.'
+  Enabled: true
+  VersionAdded: '0.1'
+  Reference: 'https://github.com/faker-ruby/faker/blob/master/CHANGELOG.md#v20-2019-31-07'
+  ArgumentKeywords:
+    #
+    # FakerClassName:
+    #   method_name:
+    #     - keyword_name_for_first_argument
+    #     - keyword_name_for_second_argument
+    #     - keyword_name_for_third_argument
+    #
+    Faker::Dune:
+      quote:
+        - character
+      saying:
+        - source
+    Faker::Books::Lovecraft:
+      fhtagn:
+        - number
+      sentence:
+        - word_count
+        - random_words_to_add
+      words:
+        - number
+        - spaces_allowed
+      sentences:
+        - number
+      paragraph:
+        - sentence_count
+        - random_sentences_to_add
+      paragraphs:
+        - number
+      paragraph_by_chars:
+        - characters
+    Faker::Address:
+      city:
+        - options
+      street_address:
+        - include_secondary
+      zip_code:
+        - state_abbreviation
+      country_by_code:
+        - code
+      country_name_to_code:
+        - name
+    Faker::Alphanumeric:
+      alpha:
+        - number
+      alphanumeric:
+        - number
+    Faker::App:
+      semantic_version:
+        - major
+        - minor
+        - patch
+    Faker::Avatar:
+      image:
+        - slug
+        - size
+        - format
+        - set
+        - bgset
+    Faker::Bank:
+      account_number:
+        - digits
+      iban:
+        - country_code
+    Faker::Boolean:
+      boolean:
+        - true_ratio
+    Faker::ChileRut:
+      rut:
+        - min_rut
+        - fixed
+      full_rut:
+        - min_rut
+        - fixed
+    Faker::Code:
+      isbn:
+        - base
+      ean:
+        - base
+      nric:
+        - min_age
+        - max_age
+    Faker::Commerce:
+      promotion_code:
+        - digits
+      department:
+        - max
+        - fixed_amount
+      price:
+        - range
+        - as_string
+    Faker::Company:
+      polish_register_of_national_economy:
+        - length
+      brazilian_company_number:
+        - formatted
+    Faker::CryptoCoin:
+      coin_name:
+        - coin
+      acronym:
+        - coin
+      url_logo:
+        - coin
+    Faker::Date:
+      between:
+        - from
+        - to
+      between_except:
+        - from
+        - to
+        - excepted
+      forward:
+        - days
+      backward:
+        - days
+      birthday:
+        - min_age
+        - max_age
+    Faker::Demographic:
+      height:
+        - unit
+    Faker::DrivingLicence:
+      british_driving_licence:
+        - last_name
+        - initials
+        - gender
+        - date_of_birth
+    Faker::File:
+      dir:
+        - segment_count
+        - root
+        - directory_separator
+      file_name:
+        - dir
+        - name
+        - ext
+        - directory_separator
+    Faker::Fillmurray:
+      image:
+        - grayscale
+        - width
+        - height
+    Faker::Finance:
+      vat_number:
+        - country
+    Faker::Hipster:
+      words:
+        - number
+        - supplemental
+        - spaces_allowed
+      sentence:
+        - word_count
+        - supplemental
+        - random_words_to_add
+      sentences:
+        - number
+        - supplemental
+      paragraph:
+        - sentence_count
+        - supplemental
+        - random_sentences_to_add
+      paragraphs:
+        - number
+        - supplemental
+      paragraph_by_chars:
+        - characters
+        - supplemental
+    Faker::IDNumber:
+      brazilian_citizen_number:
+        - formatted
+      brazilian_id:
+        - formatted
+    Faker::Internet:
+      email:
+        - name
+        - separators
+      free_email:
+        - name
+      safe_email:
+        - name
+      username:
+        - specifier
+        - separators
+      password:
+        - min_length
+        - max_length
+        - mix_case
+        - special_characters
+      domain_name:
+        - subdomain
+      fix_umlauts:
+        - string
+      mac_address:
+        - prefix
+      url:
+        - host
+        - path
+        - scheme
+      slug:
+        - words
+        - glue
+      user_agent:
+        - vendor
+    Faker::Invoice:
+      amount_between:
+        - from
+        - to
+      creditor_reference:
+        - ref
+      reference:
+        - ref
+    Faker::Json:
+      shallow_json:
+        - width
+        - options
+      add_depth_to_json:
+        - json
+        - width
+        - options
+    Faker::Lorem:
+      words:
+        - number
+        - supplemental
+      characters:
+        - number
+      sentence:
+        - word_count
+        - supplemental
+        - random_words_to_add
+      sentences:
+        - number
+        - supplemental
+      paragraph:
+        - sentence_count
+        - supplemental
+        - random_sentences_to_add
+      paragraphs:
+        - number
+        - supplemental
+      paragraph_by_chars:
+        - number
+        - supplemental
+      question:
+        - word_count
+        - supplemental
+        - random_words_to_add
+      questions:
+        - number
+        - supplemental
+    Faker::LoremFlickr:
+      image:
+        - size
+        - search_terms
+        - match_all
+      grayscale_image:
+        - size
+        - search_terms
+        - match_all
+      pixelated_image:
+        - size
+        - search_terms
+        - match_all
+      colorized_image:
+        - size
+        - color
+        - search_terms
+        - match_all
+    Faker::LoremPixel:
+      image:
+        - size
+        - is_gray
+        - category
+        - number
+        - text
+        - secure
+    Faker::Markdown:
+      sandwich:
+        - sentences
+        - repeat
+    Faker::Measurement:
+      height:
+        - amount
+      length:
+        - amount
+      volume:
+        - amount
+      weight:
+        - amount
+      metric_height:
+        - amount
+      metric_length:
+        - amount
+      metric_volume:
+        - amount
+      metric_weight:
+        - amount
+    Faker::Name:
+      initials:
+        - number
+    Faker::NationalHealthService:
+      check_digit:
+        - number
+    Faker::Number:
+      number:
+        - digits
+      leading_zero_number:
+        - digits
+      decimal_part:
+        - digits
+      decimal:
+        - l_digits
+        - r_digits
+      hexadecimal:
+        - digits
+      normal:
+        - mean
+        - standard_deviation
+      between:
+        - from
+        - to
+      within:
+        - range
+      positive:
+        - from
+        - to
+      negative:
+        - from
+        - to
+    Faker::Omniauth:
+      google:
+        - name
+        - email
+        - uid
+      facebook:
+        - name
+        - email
+        - username
+        - uid
+      twitter:
+        - name
+        - nickname
+        - uid
+      linkedin:
+        - name
+        - email
+        - uid
+      github:
+        - name
+        - email
+        - uid
+    Faker::PhoneNumber:
+      subscriber_number:
+        - length
+    Faker::Placeholdit:
+      image:
+        - size
+        - format
+        - background_color
+        - text_color
+        - text
+    Faker::Relationship:
+      familial:
+        - connection
+    Faker::Source:
+      hello_world:
+        - lang
+      print:
+        - str
+        - lang
+      print_1_to_10:
+        - lang
+    Faker::String:
+      random:
+        - length
+    Faker::Stripe:
+      valid_card:
+        - card_type
+      valid_token:
+        - card_type
+      invalid_card:
+        - card_error
+      ccv:
+        - card_type
+    Faker::Time:
+      between:
+        - from
+        - to
+        - format
+      between_dates:
+        - from
+        - to
+        - period
+        - format
+      forward:
+        - days
+        - period
+        - format
+      backward:
+        - days
+        - period
+        - format
+    Faker::Twitter:
+      user:
+        - include_status
+        - include_email
+      status:
+        - include_user
+        - include_photo
+      status_entities:
+        - include_photo
+    Faker::Types:
+      rb_string:
+        - words
+      rb_integer:
+        - from
+        - to
+      rb_hash:
+        - number
+        - type
+      complex_rb_hash:
+        - number
+      rb_array:
+        - len
+    Faker::Vehicle:
+      model:
+        - make_of_model
+      mileage:
+        - min
+        - max
+      license_plate:
+        - state_abreviation
+    Faker::WorldCup:
+      group:
+        - group
+      roster:
+        - country
+        - type
+    Faker::Dota:
+      quote:
+        - hero
+    Faker::Movies::StarWars:
+      quote:
+        - character