spellr 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f536be7fdf055e77cf278ccc2b4980da48bcbaae1d821bdf581df338c6ffa4e
-  data.tar.gz: 8c33f240c847e4b9557f2c02c4804b8e1e375f65135c0f5801165fd9ce3fe53c
+  metadata.gz: 4d7433ea064065687e2295575e41d3a991bad67e3ad57602ef37fbbc19dcd91d
+  data.tar.gz: a242b9f1c85d00933a367924440d5c22ecc3c53c2f339c18e91393808d25f86d
 SHA512:
-  metadata.gz: 9bed7f3fd56ca81cde5796ee61e96caeebe1e4bb0456d50ed9c3e7e34ab794f10130a13b668ee8c9eb175d5f5a8c63defc7c308fed3d6e2f79e431a396419839
-  data.tar.gz: 7ac9605ef35b4e66c98c919102098e3e59c901a3f019674254c00c2769cb1f852878e00bba9c60ce666ce891aaa848b63d94ec8efd3607498b91801acaa573d6
+  metadata.gz: 76ee40dd1f2c4ad6cba3a1db28966bc84e0e6910a994bcf58840135eef8d1043f14bfd0f0151ae9f770633ec8d878d2984dc3e235013766a877ca88f250d5c5d
+  data.tar.gz: fc2fb0f38d1513a24cd2e33d5175f35eb7bdbb72f37d2c97c6e2ef6ef0ae3efc6cdbee41938c5c836a9d5af6536c057c0c5ed0b17ab4179c363781255554473d

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.8.0
+- add the ability to use spellr as a rake task
+
 # v0.7.1
 - relax fast_ignore requirement
 
@@ -6,7 +9,6 @@
 - require fast_ignore 0.6.0
 - new interactive UI
 - misc performance improvements
-- drop ruby 2.4 support because simplecov does
 
 # v0.6.0
 - add CSS wordlist from MDN

data/README.md

@@ -229,11 +229,79 @@ languages:
              # this file will match even if it doesn't otherwise match the includes pattern.
 ```
 
+If you want a file to have a file-specific wordlist:
+e.g. for terms specific to logstash:
+```yml
+languages:
+  logstash: # this can be anything
+    includes:
+      - path/to/logstash/file
+```
+
+## Rake and Travis
+
+Create or open a file in the root of your project named `Rakefile`.
+adding the following lines
+```ruby
+# Rakefile
+require 'spellr/rake_task'
+Spellr::RakeTask.generate_task
+```
+
+This will add the `rake spellr` task. To provide arguments like the cli, use square brackets. (ensure you escape the `[]` if you're using zsh)
+`rake 'spellr[--interactive]'`
+
+To have this automatically run on travis, add `:spellr` to the default task.
+```ruby
+# Rakefile
+require 'spellr/rake_task'
+Spellr::RakeTask.generate_task
+
+task :default, :spellr
+```
+or if you already have :default task, add :spellr to the array.
+```ruby
+require 'spellr/rake_task'
+Spellr::RakeTask.generate_task
+
+task :default, [:spec, :spellr]
+```
+or etc.
+
+Also follow the travis documentation to have travis run rake:
+```yml
+# .travis.yml
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5
+before_install: gem install bundler
+```
+
+To provide default cli arguments, the first argument is the name, and subsequent arguments are the cli arguments.
+```ruby
+# Rakefile
+require 'spellr/rake_task'
+Spellr::RakeTask.generate_task(:spellr_quiet, '--quiet')
+
+task :default, :spellr_quiet
+```
+or `rake spellr` will be in interactive mode unless the CI env variable is set.
+```ruby
+# Rakefile
+require 'spellr/rake_task'
+spellr_arguments = ENV['CI'] ? [] : ['--interactive']
+Spellr::RakeTask.generate_task(:spellr, **spellr_arguments)
+
+task :default, :spellr
+```
+
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 

data/exe/spellr

@@ -3,10 +3,4 @@
 
 require_relative '../lib/spellr/cli'
 
-begin
-  Spellr::CLI.new(ARGV).check
-rescue Spellr::Error => e
-  require_relative '../lib/spellr/string_format'
-  warn Spellr::StringFormat.red(e.message)
-  exit 1
-end
+Spellr::CLI.new(ARGV)

data/lib/spellr/cli.rb

@@ -2,6 +2,7 @@
 
 require_relative '../spellr'
 require_relative 'cli_options'
+require_relative 'string_format'
 
 module Spellr
   class CLI
@@ -10,10 +11,18 @@ module Spellr
     def initialize(argv)
       @argv = argv
       CLI::Options.parse(@argv)
-      Spellr.config.valid?
+      check
+    rescue Spellr::Error => e
+      exit_with_error(e.message)
+    end
+
+    def exit_with_error(message)
+      warn Spellr::StringFormat.red(message)
+      exit 1
     end
 
     def check
+      Spellr.config.valid?
       checker = Spellr.config.checker.new(files: files)
       checker.check
 

data/lib/spellr/config_validator.rb

@@ -15,7 +15,7 @@ module Spellr
     validate :keys_are_single_characters
 
     def valid?
-      raise Spellr::Config::Invalid, errors.join("\n") unless super
+      raise ::Spellr::Config::Invalid, errors.join("\n") unless super
     end
 
     def interactive_is_interactive # rubocop:disable Metrics/MethodLength

data/lib/spellr/rake_task.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'spellr/cli'
+require 'shellwords'
+
+module Spellr
+  class RakeTask
+    include ::Rake::DSL
+
+    def self.generate_task(name = :spellr, *default_argv) # rubocop:disable
+      new(name, default_argv)
+
+      name
+    end
+
+    def initialize(name, default_argv)
+      @name = name
+      @default_argv = default_argv
+
+      describe_task
+      define_task
+    end
+
+    private
+
+    def escaped_argv(argv = @default_argv)
+      return if argv.empty?
+
+      Shellwords.shelljoin(argv)
+    end
+
+    def describe_task
+      return desc('Run spellr') if @default_argv.empty?
+
+      desc("Run spellr (default args: #{escaped_argv})")
+    end
+
+    def define_task
+      task(@name, :'*args') do |_, task_argv|
+        argv = argv_or_default(task_argv)
+        write_cli_cmd(argv)
+        run(argv)
+      end
+    end
+
+    def write_cli_cmd(argv)
+      $stdout.puts("\e[2mspellr #{escaped_argv(argv)}\e[0m")
+    end
+
+    def run(argv)
+      Spellr::CLI.new(argv)
+    rescue SystemExit => e
+      raise unless e.status == 0
+    end
+
+    def argv_or_default(task_argv)
+      task_argv = task_argv.to_a.compact
+      task_argv.empty? ? @default_argv : task_argv
+    end
+  end
+end

data/lib/spellr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spellr
-  VERSION = '0.7.1'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spellr
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Dana Sherson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-17 00:00:00.000000000 Z
+date: 2020-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -248,6 +248,7 @@ files:
 - lib/spellr/output.rb
 - lib/spellr/output_stubbed.rb
 - lib/spellr/quiet_reporter.rb
+- lib/spellr/rake_task.rb
 - lib/spellr/reporter.rb
 - lib/spellr/string_format.rb
 - lib/spellr/token.rb