rubocop-stylecheck 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c60afe33c5f252769bbea51bd2c8c9ecdb47e8be
+  data.tar.gz: 1c09ae96a90854d746a4a102cea99efc84c1f57e
+SHA512:
+  metadata.gz: 73cf744a8d92c1620a645ae453095c9c6fe905ff7c0edac328044c33dc890d26c97156999ea9c464df770c24d149fc27a978ff4bd2054e88a9ab179d1f2008a9
+  data.tar.gz: ab53f6e1d5994b6b32adcc369175ee050bbb76490e4adf81018abc2bed2ede01a86811c9c457b7f80f33725b367a4eccf2a2235f2abd862f37a1cf2a4eb456c1

data/.gitignore

@@ -0,0 +1,3 @@
+/.bundle/
+/Gemfile.lock
+/pkg/

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rubocop-stylecheck.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Krzysztof Wawer
+
+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,50 @@
+# Rubocop::Stylecheck
+
+This gem is inspired by `ragnarson-stylecheck` gem.
+
+This gem adds rake tasks which easily can invoke RuboCop with predefined options. You can use it in Ruby on Rails projects (with dedicated support from RuboCop side), but you can also use it in projects without Ruby on Rails - this gem supports both cases.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rubocop-stylecheck"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubocop-stylecheck
+
+After all in Rakefile you must add:
+
+```ruby
+require "rubocop/stylecheck/rake_task"
+```
+
+## Usage
+
+Available rake tasks:
+* style - shortcut for style:rubocop:with_auto_correct
+* style:rubocop:with_auto_correct - run RuboCop with auto correction
+* style:rubocop:without_auto_correct - run RuboCop without auto correction
+* style:rubocop:generate_local_config - generate rubocop config locally, if we want to override something
+
+For generating local config file you must set:
+```ruby
+Rubocop::Stylecheck.config_path = "..."
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alterans/rubocop-stylecheck.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler"
+require "bundler/gem_tasks"
+Bundler.require
+
+require "rubocop/stylecheck/rake_task"

data/lib/rubocop-stylecheck.rb

@@ -0,0 +1 @@
+require "rubocop/stylecheck"

data/lib/rubocop/stylecheck.rb

@@ -0,0 +1,16 @@
+require "rubocop/stylecheck/version"
+
+module Rubocop
+  module Stylecheck
+    class << self
+      attr_accessor :config_path
+
+      def project_config_path
+        File.join(Dir.pwd, ".rubocop.yml")
+      end
+    end
+  end
+end
+
+require "rubocop/stylecheck/cli"
+require "rubocop/stylecheck/railtie" if defined?(Rails)

data/lib/rubocop/stylecheck/cli.rb

@@ -0,0 +1,21 @@
+module Rubocop
+  module Stylecheck
+    module Cli
+      class << self
+        def options
+          options = ["--fail-level", "refactor"]
+          options += ["--rails"] if defined?(Rails)
+          options
+        end
+
+        def options_with_auto_correct
+          options + ["--auto-correct"]
+        end
+
+        def options_with_cop
+          options + ["--display-cop-names"]
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/stylecheck/railtie.rb

@@ -0,0 +1,10 @@
+module Rubocop
+  module Stylecheck
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        rake_path = File.join(File.dirname(__FILE__), "tasks/*.rake")
+        Dir[rake_path].each { |f| load f }
+      end
+    end
+  end
+end

data/lib/rubocop/stylecheck/rake_task.rb

@@ -0,0 +1,2 @@
+require "rake"
+load "rubocop/stylecheck/tasks/rubocop.rake"

data/lib/rubocop/stylecheck/tasks/rubocop.rake

@@ -0,0 +1,39 @@
+require "rubocop/stylecheck"
+require "fileutils"
+
+def run(options)
+  sh "bundle exec rubocop #{options.join(' ')}" do |ok, _res|
+    abort "Fix code style errors" unless ok
+  end
+end
+
+namespace :style do
+  namespace :rubocop do
+    desc "Run RuboCop with auto_correct"
+    task :with_auto_correct do
+      run(Rubocop::Stylecheck::Cli.options_with_auto_correct)
+    end
+
+    desc "Run RuboCop without auto_correct"
+    task :without_auto_correct do
+      run(Rubocop::Stylecheck::Cli.options_with_cop)
+    end
+
+    desc "Generate local RuboCop config"
+    task :generate_local_config do
+      template_config_path = Rubocop::Stylecheck.config_path
+      project_config_path = Rubocop::Stylecheck.project_config_path
+
+      if template_config_path && File.exist?(template_config_path)
+        FileUtils.cp(template_config_path, project_config_path)
+      else
+        abort "Config file doesn't exist, please use Robocop::Stylecheck.config_path = ..."
+      end
+    end
+  end
+end
+
+desc "Check codestyle and fix common errors"
+task :style do
+  Rake::Task["style:rubocop:with_auto_correct"].invoke
+end

data/lib/rubocop/stylecheck/version.rb

@@ -0,0 +1,5 @@
+module Rubocop
+  module Stylecheck
+    VERSION = "0.1.0".freeze
+  end
+end

data/rubocop-stylecheck.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rubocop/stylecheck/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop-stylecheck"
+  spec.version       = Rubocop::Stylecheck::VERSION
+  spec.authors       = ["Krzysztof Wawer"]
+  spec.email         = ["krzysztof.wawer@gmail.com"]
+
+  spec.summary       = "Automatic style check for ruby projects"
+  spec.description   = "Adds rake tasks for checking ruby style"
+  spec.homepage      = "https://github.com/alterans/rubocop-stylecheck"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_dependency "rake", "~> 10.0"
+  spec.add_dependency "rubocop", "~> 0.51"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-stylecheck
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Krzysztof Wawer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+description: Adds rake tasks for checking ruby style
+email:
+- krzysztof.wawer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rubocop-stylecheck.rb
+- lib/rubocop/stylecheck.rb
+- lib/rubocop/stylecheck/cli.rb
+- lib/rubocop/stylecheck/railtie.rb
+- lib/rubocop/stylecheck/rake_task.rb
+- lib/rubocop/stylecheck/tasks/rubocop.rake
+- lib/rubocop/stylecheck/version.rb
+- rubocop-stylecheck.gemspec
+homepage: https://github.com/alterans/rubocop-stylecheck
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Automatic style check for ruby projects
+test_files: []