ragnarson-stylecheck 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 840638094b92e21b7c6c0c9ebf0b50601008995f
+  data.tar.gz: bebada66cc6f199c465b0b55098272844ae9e2ea
+SHA512:
+  metadata.gz: 4b3dd2b35b3432fe19cd5b774fc9456256930a0bcb578ffbc754d127395b0f3add08fa36c143eda41bf7dc88a4318f6e1d4915e535bbd3bcfe23e62870a3705a
+  data.tar.gz: 452c04917246a42151ddd4fb247c7b8ee6b231c6c66d969a6b41c46b95aabdc04df6abb120a220f9f3d402f5ac3e39577562b2c565f9253a130d2054da99c71d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Ragnarson sp. z o. o.
+
+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,12 @@
+# ragnarson-stylecheck
+
+This gem should streamline using of rubocop and potentially other automated stylecheck tools.
+
+# install
+
+Just add to gemfile and new rake task should be available
+(if not add `require "ragnarson/rake_task"` to your Rakefile)
+
+* `bundle exec rake style`
+
+This for now just prepares a rubocop config and runs the rubocop check

data/config/rubocop.yml

@@ -0,0 +1,82 @@
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+# Multi-line method chaining should be done with leading dots.
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+# Use empty lines between defs.
+Style/EmptyLineBetweenDefs:
+  # If true, this parameter means that single line method definitions don't
+  # need an empty line between them.
+  AllowAdjacentOneLineDefs: true
+
+Style/EmptyLines:
+  Exclude:
+    - Gemfile
+
+# Checks whether the source file has a utf-8 encoding comment or not
+Style/Encoding:
+  Enabled: false
+
+Style/InlineComment:
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+# Enforce the method used for string formatting.
+Style/FormatString:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  MaxLineLength: 120
+
+Style/Semicolon:
+  # Allow ; to separate several expressions on the same line.
+  AllowAsExpressionSeparator: true
+
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Exclude:
+    - Gemfile
+    - Rakefile
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/TrailingComma:
+  # If EnforcedStyleForMultiline is comma, the cop allows a comma after the
+  # last item of a list, but only for lists where each item is on its own line.
+  EnforcedStyleForMultiline: no_comma
+
+Style/RaiseArgs:
+  Enabled: false
+
+# Allow logical `or`/`and` in conditionals
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+##################### Metrics ##################################
+
+Metrics/AbcSize:
+  Severity: warning
+  Max: 25
+
+Metrics/LineLength:
+  Max: 120
+  # To make it possible to copy or click on URIs in the code, we allow lines
+  # contaning a URI to be longer than Max.
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+
+##################### Rails ##################################

data/lib/ragnarson/rake_task.rb

@@ -0,0 +1,2 @@
+require 'rake'
+load 'ragnarson/tasks/rubocop.rake'

data/lib/ragnarson/stylecheck.rb

@@ -0,0 +1,13 @@
+module Ragnarson
+  # style checking for booking sync projects
+  module Stylecheck
+    class << self
+      def root
+        Gem::Specification.find_by_name('ragnarson-stylecheck').gem_dir
+      end
+    end
+  end
+end
+
+require 'ragnarson/stylecheck/rubocop_helpers'
+require 'ragnarson/stylecheck/railtie' if defined?(Rails)

data/lib/ragnarson/stylecheck/railtie.rb

@@ -0,0 +1,11 @@
+module Ragnarson
+  module Stylecheck
+    # auto loading rake tasks
+    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/ragnarson/stylecheck/rubocop_helpers.rb

@@ -0,0 +1,14 @@
+require 'fileutils'
+
+module Ragnarson
+  module Stylecheck
+    # helper to nicely update rubocop config
+    module RubocopHelpers
+      class << self
+        def config
+          File.join(Ragnarson::Stylecheck.root, 'config', 'rubocop.yml')
+        end
+      end
+    end
+  end
+end

data/lib/ragnarson/tasks/rubocop.rake

@@ -0,0 +1,32 @@
+require 'ragnarson/stylecheck'
+require "fileutils"
+
+namespace :style do
+  namespace :rubocop do
+    desc "Run RuboCop with auto_correct"
+    task :with_auto_correct do
+      options = ["--rails", "--auto-correct"]
+      options += ["--fail-level", "refactor"]
+      options += ["-c", Ragnarson::Stylecheck::RubocopHelpers.config]
+      sh "bundle exec rubocop #{options.join(' ')}" do |ok, _res|
+        abort "Fix code style errors" unless ok
+      end
+    end
+
+    desc 'Run RuboCop without auto_correct'
+    task :without_auto_correct do
+      options = ["--rails"]
+      options += ["--fail-level", "refactor"]
+      options += ["--display-cop-names"]
+      options += ["-c", Ragnarson::Stylecheck::RubocopHelpers.config]
+      sh "bundle exec rubocop #{options.join(' ')}" do |ok, _res|
+        abort "Fix code style errors" unless ok
+      end
+    end
+  end
+end
+
+desc "Check codestyle and fix common errors"
+task :style do
+  Rake::Task["style:rubocop:with_auto_correct"].invoke
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: ragnarson-stylecheck
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Piotr Marciniak
+- Grzesiek Kołodziejczyk
+- Oskar Szrajer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.29.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.29.1
+description: Wraps rubocop for simple and consisten experience
+email: oskarszrajer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- config/rubocop.yml
+- lib/ragnarson/rake_task.rb
+- lib/ragnarson/stylecheck.rb
+- lib/ragnarson/stylecheck/railtie.rb
+- lib/ragnarson/stylecheck/rubocop_helpers.rb
+- lib/ragnarson/tasks/rubocop.rake
+homepage: https://github.com/ragnarson/ragnarson-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.4.5
+signing_key: 
+specification_version: 4
+summary: Automatic style check for ragnarson projects
+test_files: []