rubocop-decko 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91fe3230eb2beec60d685171f8ed8c74038e4cad
-  data.tar.gz: 304dc90817b0786fcb33874afc6eec54a459983d
+  metadata.gz: 2317e1d406d4d99fed71a1ccf1d846ce5fa6713d
+  data.tar.gz: 4d75085a5ce222c614b5bb9027f0fe94bb3cd0dc
 SHA512:
-  metadata.gz: 735556d6247f244f691a68e57e8b08acd8a2dea0fde5697d5805464b01cbb80048b324cdaf58bea6b2164c2d4e8318ab9b855d126b76f0245b7e5b7c84247497
-  data.tar.gz: 989342f968dad91e3351f7626adc30128d5e8909baf978b68e64c9d58a6a83b021f05a77436e73d0e8b56b0b7e2ebfc9b75067de10e1b95161b566cc019fb0d2
+  metadata.gz: f2b1133694ebea9df07acef4af6e8eae668a6851cf3e5501538d5b00a9c9eb2038b63fceeab69efc1a12c0b3c824c9fa1f54f877178d31c4bcc76e0c1831f466
+  data.tar.gz: 72c09f7badbbe7f50b8fbd665946507e3f4875fb45f93141a01976e7e9bd6e1bf3b1ad54c3ad21cd246b818187f11aac59a9887d0e3e7da4d7e431f8498c8060

data/README.md

@@ -1,2 +1,80 @@
-# rubocop-decko
-Code style checking for Wagn/Decko files
+# RuboCop Decko
+
+[![Gem Version](https://badge.fury.io/rb/rubocop-decko.svg)](http://badge.fury.io/rb/rubocop-decko)
+
+Wagn-specific analysis for your Wagn deck, as an extension to
+[RuboCop](https://github.com/bbatsov/rubocop). Heavily inspired by [`rubocop-rspec`](https://github.com/nevir/rubocop-rspec) and [`rubocop-cask`](https://github.com/nevir/rubocop-rspec).
+
+
+## Installation
+
+Just install the `rubocop-decko` gem
+
+```bash
+gem install rubocop-decko
+```
+
+or if you use bundler put this in your `Gemfile`
+
+```
+gem 'rubocop-decko'
+```
+
+
+## Usage
+
+You need to tell RuboCop to load the Decko extension. There are three ways to do this:
+
+### RuboCop configuration file
+
+Put this into your `.rubocop.yml`:
+
+```
+require: rubocop-decko
+```
+
+Now you can run `rubocop` and it will automatically load the RuboCop Decko cops together with the standard cops.
+
+### Command line
+
+```bash
+rubocop --require rubocop-decko
+```
+
+### Rake task
+
+```ruby
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-decko'
+end
+```
+
+
+## The Cops
+
+All cops are located under [`lib/rubocop/cop/decko`](lib/rubocop/cop/decko), and contain examples/documentation.
+
+In your `.rubocop.yml`, you may treat the Decko cops just like any other cop. For example:
+
+```yaml
+Decko/ViewLength:
+  Description: Avoid views longer than 15 lines of code.
+  Enabled: true
+  CountComments: false
+  Max: 15
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+`rubocop-cask` is MIT licensed. [See the accompanying file](MIT-LICENSE.md) for
+the full text.
+

data/lib/rubocop-decko.rb

@@ -1,14 +1,19 @@
 # encoding: utf-8
 
+require 'pathname'
+require 'yaml'
+
 require 'rubocop'
 
+require 'rubocop/decko'
 require 'rubocop/decko/version'
 require 'rubocop/decko/inject'
 
 RuboCop::Decko::Inject.defaults!
 
-require 'rubocop/cop/mixin/block_length'
+require 'rubocop/cop/mixin/block_lines'
 
 # cops
 require 'rubocop/cop/decko/view_length'
 require 'rubocop/cop/decko/event_length'
+require 'rubocop/cop/decko/block_length'

data/lib/rubocop/cop/decko/block_length.rb

@@ -0,0 +1,18 @@
+
+module RuboCop
+  module Cop
+    module Metrics
+      # monkeypatch rubocop's block length cop so that it ignores format
+      # blocks.
+      # It doesn't work if I use the same path ("cop/metrics/block_length")
+      # for this.
+      class BlockLength < Cop
+        include BlockLines
+
+        def on_block(node)
+          check_block_length node, except: [:format, :view, :event]
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/decko/event_length.rb

@@ -5,20 +5,18 @@ module RuboCop
     module Decko
       # Checks that the lines of a view block don't exceed the allowed maximum
       # @example
-      #   view :editor do |args|
+      #   event :some_event, :store do
       #      ...
       #   end
       class EventLength < Cop
-        include BlockLength
+        include BlockLines
 
         def on_block(node)
-          method, args, body = *node
-          _receiver, method_name, _args = *method
-          return unless method_name == :event
-          check_code_length(node, body)
+          check_block_length node, only: :event
         end
 
         private
+
         def message(length, max_length)
           format('Event has too many lines. [%d/%d]', length, max_length)
         end

data/lib/rubocop/cop/decko/view_length.rb

@@ -9,13 +9,10 @@ module RuboCop
       #      ...
       #   end
       class ViewLength < Cop
-        include BlockLength
+        include BlockLines
 
         def on_block(node)
-          method, args, body = *node
-          _receiver, method_name, _args = *method
-          return unless method_name == :view
-          check_code_length(node, body)
+          check_block_length node, only: :view
         end
 
         private

data/lib/rubocop/cop/mixin/block_lines.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module RuboCop
+  module Cop
+    module BlockLines
+      # Common functionality for checking length of a block.
+
+      include TooManyLines
+
+      def check_block_length(node, opts={})
+        method, args, body = *node
+        require 'pry'
+        _receiver, method_name, _args = *method
+        return if opts[:only] && !Array(opts[:only]).include?(method_name)
+        return if opts[:except] && Array(opts[:except]).include?(method_name)
+        check_code_length node
+      end
+    end
+  end
+end

data/lib/rubocop/decko.rb

@@ -0,0 +1,10 @@
+module RuboCop
+  # RuboCop Decko project namespace
+  module Decko
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
+    CONFIG         = YAML.load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+  end
+end

data/lib/rubocop/decko/inject.rb

@@ -7,17 +7,29 @@ module RuboCop
     # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
     # bit of our configuration.
     module Inject
-      DEFAULT_FILE = File.expand_path(
-          '../../../../config/default.yml', __FILE__
-      )
-
       def self.defaults!
-        hash = YAML.load_file(DEFAULT_FILE)
-        puts "configuration from #{DEFAULT_FILE}" if ConfigLoader.debug?
-        config = ConfigLoader.merge_with_default(hash, DEFAULT_FILE)
-
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
         ConfigLoader.instance_variable_set(:@default_configuration, config)
       end
     end
+
+    # module Inject
+    #
+    #   DEFAULT_FILE = File.expand_path(
+    #       '../../../../config/default.yml', __FILE__
+    #   )
+    #
+    #   def self.defaults!
+    #     hash = YAML.load_file(DEFAULT_FILE)
+    #     puts "configuration from #{DEFAULT_FILE}" if ConfigLoader.debug?
+    #     config = ConfigLoader.merge_with_default(hash, DEFAULT_FILE)
+    #
+    #     ConfigLoader.instance_variable_set(:@default_configuration, config)
+    #   end
+    # end
   end
 end

data/lib/rubocop/decko/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Decko
     # Version information for the Decko RuboCop plugin.
     module Version
-      STRING = '0.1'
+      STRING = '0.2'
     end
   end
 end

data/rubocop-decko.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.test_files = spec.files.grep(%r{^spec/})
   spec.extra_rdoc_files = ['README.md']
 
-  spec.add_development_dependency('rubocop', '~> 0.31')
+  spec.add_development_dependency('rubocop', '~> 0.45')
   # spec.add_development_dependency('rake', '~> 10.1')
   # spec.add_development_dependency('rspec', '~> 3.0')
   # spec.add_development_dependency('simplecov', '~> 0.8')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-decko
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Philipp Kuehl
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.31'
+        version: '0.45'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.31'
+        version: '0.45'
 description: |2
       Code style checking for Wagn/Decko files.
       A plugin for the RuboCop code style enforcing & linting tool.
@@ -38,9 +38,11 @@ files:
 - Rakefile
 - config/default.yml
 - lib/rubocop-decko.rb
+- lib/rubocop/cop/decko/block_length.rb
 - lib/rubocop/cop/decko/event_length.rb
 - lib/rubocop/cop/decko/view_length.rb
-- lib/rubocop/cop/mixin/block_length.rb
+- lib/rubocop/cop/mixin/block_lines.rb
+- lib/rubocop/decko.rb
 - lib/rubocop/decko/inject.rb
 - lib/rubocop/decko/version.rb
 - rubocop-decko.gemspec

data/lib/rubocop/cop/mixin/block_length.rb

@@ -1,27 +0,0 @@
-# encoding: utf-8
-
-module RuboCop
-  module Cop
-    module BlockLength
-      # Common functionality for checking length of a block.
-      include CodeLength
-
-      def check_code_length(node, body)
-        length = code_length(body.loc.expression)
-        return unless length > max_length
-
-        add_offense(node, :expression, message(length, max_length)) do
-          self.max = length
-        end
-      end
-
-      private
-
-      def code_length(node)
-        lines = node.source.lines.to_a[1..-2] || []
-
-        lines.count { |line| !irrelevant_line(line) }
-      end
-    end
-  end
-end