Various improvements

Removed
-------

* `rack` as dependency
* Unused `config.ru`

Changed
-------

* `voight_kampff/rack_request` isn't required by default
* Default path for cache is now in `./tmp` directory instead of `./config`

Development
-----------

* [EditorConfig](https://editorconfig.org/) added
* [RuboCop](https://github.com/rubocop-hq/rubocop) added and offenses fixed
* RuboCop task added for Travis CI
* Drop support for Ruby <= 2.2 (they even will not get security patches)
* Ignore built gems for git

Author: AlexWayfer

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.gitignore

@@ -5,3 +5,4 @@ Gemfile.lock
 *.rbc
 coverage
 doc
+*.gem

.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Layout/MultilineMethodCallIndentation:
+   EnforcedStyle: indented
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/LineLength:
+  Exclude:
+    - spec/support/*

.ruby-version

@@ -1,9 +1,17 @@
 language: ruby
+
 rvm:
-  - 2.4.6
-  - 2.5.5
-  - 2.6.2
-script: bundle exec rspec
+  - 2.4
+  - 2.5
+  - 2.6
+
 before_install:
+  - gem update --system
   # fixes Travis CI error: NoMethodError: undefined method `spec' for nil:NilClass
   - gem install bundler
+
+cache: bundler
+
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

.travis.yml

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

Gemfile

@@ -15,29 +15,34 @@ Configuration
 
 A JSON file is used to match [user agent strings](http://simplyfast.info/browser) to a list of known bots.
 
-If you'd like to use an [updated list](https://github.com/monperrus/crawler-user-agents) or make your own customizations, run `rake voight_kampff:import_user_agents`. This will download a `crawler-user-agents.json` file into the `./config` directory.
+If you'd like to use an [updated list](https://github.com/monperrus/crawler-user-agents) or make your own customizations, run `rake voight_kampff:import_user_agents`. This will download a `crawler-user-agents.json` file into the `./tmp` directory.
 
 __Note:__ The pattern entries in the JSON file are evaluated as [regular expressions](http://en.wikipedia.org/wiki/Regular_expression).
 
 Usage
 -----
 There are three ways to use Voight-Kampff
 
-1. Through Rack::Request such as in your [Ruby on Rails](http://rubyonrails.org) controllers:  
-   `request.bot?`
+1. Through `Rack::Request` in your app such as [Ruby on Rails](http://rubyonrails.org):
+   ```ruby
+   require 'voight_kampff/rack_request'
 
-2. Through the `VoightKampff` module:  
+   request.bot?
+   ```
+
+2. Through the `VoightKampff` module:
    `VoightKampff.bot? 'your user agent string'`
 
-3. Through a `VoightKampff::Test` instance:  
+3. Through a `VoightKampff::Test` instance:
    `VoightKampff::Test.new('your user agent string').bot?`
 
-All of the above examples accept `human?` and `bot?` methods. All of these methods will return `true` or `false`.
+All of the above examples accept `human?` and `bot?` methods.
+All of these methods will return `true` or `false`.
 
 Upgrading to version 1.0
 ------------------------
 
-Version 1.0 uses a new source for a list of bot user agent strings since the old source was no longer maintained. This new source, unfortuately, does not include as much detail. Therefore the following methods have been deprecated:
+Version 1.0 uses a new source for a list of bot user agent strings since the old source was no longer maintained. This new source, unfortunately, does not include as much detail. Therefore the following methods have been deprecated:
 - `#browser?`
 - `#checker?`
 - `#downloader?`
@@ -51,12 +56,12 @@ Also, the gem no longer extends `ActionDispatch::Request` instead it extends `Ra
 
 FAQ
 ---
-__Q:__ __What's with the name?__  
+__Q:__ __What's with the name?__
 __A:__ It's the [machine in Blade Runner](https://en.wikipedia.org/wiki/Blade_Runner#Voight-Kampff_machine) that is used to test whether someone is a human or a replicant.
 
-__Q:__ __I've found a bot that isn't being matched__  
+__Q:__ __I've found a bot that isn't being matched__
 __A:__ The list is being pulled from [github.com/monperrus/crawler-user-agents](https://github.com/monperrus/crawler-user-agents).
-If you'd  like to have entries added to the list, please create a pull request with that project. Once that pull request is merged, feel free to create an issue here and I'll release a new gem version with the updated list. In the meantime you can always run `rake voight_kampff:import_user_agents` on your project to get that updated list.
+If you'd  like to have entries added to the list, please create a pull request with that project. Once that pull request is merged, you'll be get the new version at the next cache update. In the meantime you can always manually flush the cache in your project to get that updated list.
 
 __Q:__ __Why don't you use the user agent list from ______________
 If you know of a better source for a list of bot user agent strings, please create an issue and let me know. I'm open to switching to a better source or supporting multiple sources. There are others out there but I like the openness of monperrus' list.
@@ -67,7 +72,7 @@ Thanks to [github.com/monperrus/crawler-user-agents](https://github.com/monperru
 
 Contributing
 ------------
-PR without tests will not get merged, Make sure you write tests for api and rails app.
+PR without tests will not get merged, Make sure you write tests for API and Rails app.
 Feel free to ask for help, if you do not know how to write a determined test.
 
 Running Tests?

README.md

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 namespace :voight_kampff do
   desc 'Import a new crawler-user-agents.json file'
-  task :import_user_agents, :url do |t, args|
+  task :import_user_agents, :url do |_t, args|
     args.with_defaults url: 'https://raw.githubusercontent.com/monperrus/crawler-user-agents/master/crawler-user-agents.json'
 
     require 'net/http'
@@ -9,8 +11,10 @@ namespace :voight_kampff do
     contents = Net::HTTP.get(uri)
 
     if contents.present?
-      file = File.open('./config/crawler-user-agents.json', 'w')
-      file.write(contents.force_encoding(Encoding::UTF_8))
+      File.write(
+        './tmp/crawler-user-agents.json',
+        contents.force_encoding(Encoding::UTF_8)
+      )
     else
       puts "voight_kampff:import_user_agents - empty file received from #{uri}"
     end

config.ru

@@ -1,25 +1,22 @@
-require 'json'
+# frozen_string_literal: true
 
 require 'voight_kampff/test'
 require 'voight_kampff/methods'
-require 'voight_kampff/rack_request' if defined?(Rack::Request)
 require 'voight_kampff/engine' if defined?(Rails)
 
+# Class helper methods
 module VoightKampff
-  class << self
-    def root
-      require 'pathname'
-      Pathname.new File.expand_path '..', File.dirname(__FILE__)
-    end
+  ROOT = File.expand_path '..', __dir__
 
+  class << self
     def human?(user_agent_string)
       test(user_agent_string).human?
     end
 
     def bot?(user_agent_string)
       test(user_agent_string).bot?
     end
-    alias :replicant? :bot?
+    alias replicant? bot?
 
     private