guard-standardrb 0.1.0.beta4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a93e41eccda79ac0f698385bb182a7de5fb7117e1c94fea4fe93f9e5b0826e6
-  data.tar.gz: 2b6087c303908e445d53db12975ac4ad961cee4b3b1842993b4b08a53e48423e
+  metadata.gz: dd45cab7d4cf2d0a20c696fd809ea26ddb2992aa42eed30c86369e95c035107c
+  data.tar.gz: 6664d9d33ef7647387d6ad377954e3a0b336034ca6a260ace6e5dd67b609c111
 SHA512:
-  metadata.gz: 808d88c143566457a5701ef58386f7e30bbbc7c177656d5e61101c05d397b09e6a490c4a0a1df7e90b33b841a2ddbf6f86c8e6c865d6917d8517c18049b9c528
-  data.tar.gz: a0a94d35f846f83620cc1a81e797bae3846633a5554f1f803d9f47348ab4318500b9d8567139ea30ef8bda18b55890d73a5984ce7c218dc5ce4739e2c4b651aa
+  metadata.gz: 94bd9ee1cc22faf5f31b0566185a3751c3d8a969cae55e5bfc72c50a25afd64d8c90b76aee4a59cb7214bd5b7054ff70f3ba12fc5f1973be4936b2e33e036eca
+  data.tar.gz: 0b56828f42d8ba6e0b6ac40eb5bb2fbe25cfce4a7aa21de4115674a1a5650477fc0bb50973b1a97a05412773eaa717628083a668e8e2003371a2b86ddc845189

data/Gemfile

@@ -2,8 +2,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in guard-standardrb.gemspec
 gemspec
-
-group :development, :test do
-  gem 'rake'
-  gem 'rspec', '~> 3.1'
-end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    guard-standardrb (0.1.0)
+    guard-standardrb (0.2.0)
       guard (>= 2.0.0)
       guard-compat (~> 1.0)
       standardrb
@@ -9,10 +9,11 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    coderay (1.1.2)
+    ast (2.4.1)
+    byebug (11.1.3)
+    coderay (1.1.3)
     diff-lcs (1.3)
-    ffi (1.12.2)
+    ffi (1.13.1)
     formatador (0.2.5)
     guard (2.16.2)
       formatador (>= 0.2.4)
@@ -24,27 +25,30 @@ GEM
       shellany (~> 0.0)
       thor (>= 0.18.1)
     guard-compat (1.2.1)
-    jaro_winkler (1.5.4)
     listen (3.2.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    lumberjack (1.2.4)
+    lumberjack (1.2.8)
     method_source (1.0.0)
     nenv (0.3.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.19.1)
-    parser (2.7.1.0)
-      ast (~> 2.4.0)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
     rainbow (3.0.0)
     rake (13.0.1)
-    rb-fsevent (0.10.3)
+    rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
+    regexp_parser (1.8.1)
     rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -59,33 +63,38 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
-    rubocop (0.80.1)
-      jaro_winkler (~> 1.5.1)
+    rubocop (0.92.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
       rexml
+      rubocop-ast (>= 0.5.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.2)
-      rubocop (>= 0.71.0)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.7.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.8.1)
+      rubocop (>= 0.87.0)
+      rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.10.1)
     shellany (0.0.1)
-    standard (0.2.3)
-      rubocop (~> 0.80.1)
-      rubocop-performance (~> 1.5.2)
+    standard (0.7)
+      rubocop (= 0.92)
+      rubocop-performance (= 1.8.1)
     standardrb (1.0.0)
       standard
     thor (1.0.1)
-    unicode-display_width (1.6.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   guard-standardrb!
+  pry-byebug
   rake
   rspec (~> 3.1)
 
 BUNDLED WITH
-   2.1.0
+   2.1.4

data/README.md

@@ -1,8 +1,20 @@
 # Guard::Standardrb
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/guard/standardrb`. To experiment with that code, run `bin/console` for an interactive prompt.
+Welcome to the new guard plugin `guard-standardrb`!
+This guard is bases on the gem `standardrb`, you can find more information about it https://github.com/testdouble/standard
 
-TODO: Delete this and the text above, and describe your gem
+StandardRB is essentially a wrapper on top of RuboCop, but enforce code convention without much configuration possible.
+This plugin will run with your guard while you modify your code and output any code conventions errors in the terminal.
+
+More Information about StandardRb:
+The beauty of Ruby Standard Style is that it's simple. No one wants to maintain multiple hundred-line style configuration files for every module/project they work on. Enough of this madness!
+
+This gem saves you (and others!) time in three ways:
+
+No configuration. The easiest way to enforce consistent style in your project. Just drop it in.
+Automatically format code. Just run standardrb --fix and say goodbye to messy or inconsistent code.
+Catch style issues & programmer errors early. Save precious code review time by eliminating back-and-forth between reviewer & contributor.
+Adopting Standard style means ranking the importance of code clarity and community conventions higher than personal style. This might not make sense for 100% of projects and development cultures, however open source can be a hostile place for newbies. Setting up clear, automated contributor expectations makes a project healthier.
 
 ## Installation
 
@@ -26,7 +38,24 @@ To add this guard plugin to your repo, run:
 
 ## Usage
 
-TODO: Write usage instructions here
+Once you installed the gem on your repo and initialized it to be added to your GuardFile,
+just run `bundle exec guard` and you should see a line `Standardrb initialized`.
+This means that the guard will run on all files that will be modified by that point in time and output the erros.
+
+Please read [Guard usage doc](https://github.com/guard/guard#readme).
+
+## Add the argument fix
+
+with the release of the version `0.2.0` the gem gets the possibility to auto fix standardrb errors that could be easily fixed.
+you can choose to activate or disable it.
+
+After the initilisation of the guard, jump into the GuardFile and you can modify the argument fix to be `true` or `false`
+
+```
+guard :standardrb fix: false do
+ ...
+end
+```
 
 ## Development
 
@@ -46,3 +75,11 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the Guard::Standardrb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/guard-standardrb/blob/master/CODE_OF_CONDUCT.md).
+
+### Author
+
+[Jody Vandenschrick](https://github.com/JodyVanden) ([@jodyvanden](https://twitter.com/jodyvanden))
+
+### Contributors
+
+[https://github.com/JodyVanden/guard-standardrb/graphs/contributors](https://github.com/JodyVanden/guard-standardrb/graphs/contributors)

data/guard-standardrb.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Jody Vandenschrick"]
   spec.email         = ["jody.vanden@gmail.com"]
 
-  spec.summary       = %q{add a plugin to gard to work with standardrb.}
+  spec.summary       = %q{add a plugin to guard to work with standardrb.}
   spec.homepage      = "https://github.com/JodyVanden/guard-standardrb"
   spec.license       = "MIT"
   # spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
@@ -22,6 +22,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'guard-compat', '~> 1.0'
   spec.add_dependency 'standardrb'
 
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'pry-byebug'
+
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do

data/lib/guard/standardrb.rb

@@ -1,29 +1,34 @@
-# coding: utf-8
-
-require 'guard'
-require 'guard/plugin'
+require "guard"
+require "guard/plugin"
+require "guard/standardrb/version"
 
 module Guard
   class Standardrb < Plugin
+    attr_reader :fix
 
-    def start
-      UI.info 'Inspecting Ruby code style of all files with standardrb'
+    def initialize(opts = {})
+      super
+      @fix = opts[:fix]
     end
 
-    def stop
+    def start
+      Guard::Compat::UI.info "Inspecting Ruby code style of all files with standardrb"
+      Guard::Compat::UI.info "Standardrb --fix = #{fix}"
     end
 
     def run_on_modifications(res)
-      UI.info 'StandardRb a file was modified'
+      Guard::Compat::UI.info "StandardRb a file was modified"
       inspect_with_standardrb(res)
 
       $stdout.puts res if res
     end
 
     def inspect_with_standardrb(paths = [])
-      paths.each do |path|
-        system("bundle exec standardrb #{path}")
-      end
+      args = ["bundle", "exec", "standardrb"]
+      args << "--fix" if fix
+
+      args += paths
+      system(*args)
     end
   end
 end

data/lib/guard/standardrb/templates/GuardFile

@@ -1,7 +1,12 @@
-# Add files and commands to this file, like the example:
-#   watch(%r{file/path}) { `command(s)` }
-#
-guard :standardrb do
+# You can choose to pass an option to the guard-standardrb plugin
+# to fix easy issues
+
+# guard :standardrb, fix: true do
+#   UI.info 'StandardRb is initialized'
+#   watch(/.+\.rb$/)
+# end
+
+guard :standardrb, fix: false do
   UI.info 'StandardRb is initialized'
   watch(/.+\.rb$/)
 end

data/lib/guard/standardrb/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module StandardrbVersion
-    VERSION = "0.1.0.beta4".freeze
+    VERSION = "0.2.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard-standardrb
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta4
+  version: 0.2.0
 platform: ruby
 authors:
 - Jody Vandenschrick
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-21 00:00:00.000000000 Z
+date: 2020-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -52,6 +52,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - jody.vanden@gmail.com
@@ -93,12 +135,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: add a plugin to gard to work with standardrb.
+summary: add a plugin to guard to work with standardrb.
 test_files: []