rubocop-cask 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28972420dc9ce7f5af5f9acd84d29315618b81b6
+  data.tar.gz: 7805e7dc619fd148d982a7397a7cf49c0eb7aa17
+SHA512:
+  metadata.gz: 898b80daadf2ab178beae041529bb41e580d6fb59c031b46c03411132d9ec0a829099204024efa22e5940f02e46d412ed723a30797ee4c4c9f0a58d1c4250a6a
+  data.tar.gz: 950eaf10f6c9cf303b10d0d38b89355ddb6ac3652b19788e63f71cef51a01d7c0ae043a5c855b2479e20d60473b2c21f22cc940d193dc09ec5ae6521f68e7c7e

data/MIT-LICENSE.md

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+=====================
+
+Copyright (c) Joshua Hagins <hagins.josh@gmail.com>
+
+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,87 @@
+# RuboCop Cask
+
+[![Gem Version](https://badge.fury.io/rb/rubocop-cask.svg)](http://badge.fury.io/rb/rubocop-cask)
+[![Dependency Status](https://gemnasium.com/jawshooah/rubocop-cask.svg)](https://gemnasium.com/jawshooah/rubocop-cask)
+[![Build Status](https://travis-ci.org/jawshooah/rubocop-cask.svg?branch=master)](https://travis-ci.org/jawshooah/rubocop-cask)
+[![Coverage Status](https://img.shields.io/codeclimate/coverage/github/jawshooah/rubocop-cask.svg)](https://codeclimate.com/github/jawshooah/rubocop-cask)
+[![Code Climate](https://codeclimate.com/github/jawshooah/rubocop-cask/badges/gpa.svg)](https://codeclimate.com/github/jawshooah/rubocop-cask)
+[![Inline docs](http://inch-ci.org/github/jawshooah/rubocop-cask.svg)](http://inch-ci.org/github/jawshooah/rubocop-cask)
+
+Cask-specific analysis for your Homebrew-Cask taps, as an extension to
+[RuboCop](https://github.com/bbatsov/rubocop). Heavily inspired by [`rubocop-rspec`](https://github.com/nevir/rubocop-rspec).
+
+
+## Installation
+
+Just install the `rubocop-cask` gem
+
+```bash
+gem install rubocop-cask
+```
+
+or if you use bundler put this in your `Gemfile`
+
+```
+gem 'rubocop-cask'
+```
+
+
+## Usage
+
+You need to tell RuboCop to load the Cask extension. There are three ways to do this:
+
+### RuboCop configuration file
+
+Put this into your `.rubocop.yml`:
+
+```
+require: rubocop-cask
+```
+
+Now you can run `rubocop` and it will automatically load the RuboCop Cask cops together with the standard cops.
+
+### Command line
+
+```bash
+rubocop --require rubocop-cask
+```
+
+### Rake task
+
+```ruby
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-cask'
+end
+```
+
+
+## The Cops
+
+All cops are located under [`lib/rubocop/cop/cask`](lib/rubocop/cop/cask), and contain examples/documentation.
+
+In your `.rubocop.yml`, you may treat the Cask cops just like any other cop. For example:
+
+```yaml
+Cask/NoDslVersion:
+  Enabled: false
+```
+
+
+## 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
+
+For running the spec files, this project depends on RuboCop's spec helpers. This means that in order to run the specs locally, you need a (shallow) clone of the RuboCop repository:
+
+```bash
+git clone --depth 1 git://github.com/bbatsov/rubocop.git vendor/rubocop
+```
+
+## License
+
+`rubocop-cask` is MIT licensed. [See the accompanying file](MIT-LICENSE.md) for
+the full text.

data/config/default.yml

@@ -0,0 +1,3 @@
+Cask/NoDslVersion:
+  Description: 'Do not use the deprecated DSL version syntax in your cask header.'
+  Enabled: true

data/lib/rubocop/cask/inject.rb

@@ -0,0 +1,21 @@
+require 'yaml'
+
+module RuboCop
+  module Cask
+    # 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)
+
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/cask/version.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+
+module RuboCop
+  module Cask
+    # Version information for the Cask RuboCop plugin.
+    module Version
+      STRING = '0.0.0'
+
+      def self.gem_version
+        Gem::Version.new(STRING)
+      end
+    end
+  end
+end

data/lib/rubocop/cop/cask/no_dsl_version.rb

@@ -0,0 +1,42 @@
+module RuboCop
+  module Cop
+    module Cask
+      # Do not use the deprecated DSL version syntax in your cask header.
+      #
+      # @example
+      #   # bad
+      #   cask :v1 => 'foo' do
+      #     ...
+      #   end
+      #
+      #   # good
+      #   cask 'foo' do
+      #     ...
+      #   end
+      class NoDslVersion < Cop
+        MESSAGE = "Use `%s '%s'` instead of `%s %s => '%s'`"
+
+        CASK_METHOD_NAMES = [:cask, :test_cask]
+
+        def on_block(node)
+          method, _args, _body = node.children
+          _receiver, method_name, object = method.children
+          return unless CASK_METHOD_NAMES.include?(method_name)
+          return unless object.type == :hash
+          check(method_name, object)
+        end
+
+        private
+
+        def check(method_name, object)
+          left, right = *object.children.first
+          dsl_version_sym = left.children.first
+          cask_token = right.children.first
+          message = format(MESSAGE, method_name, cask_token, method_name,
+                           dsl_version_sym.inspect, cask_token)
+          add_offense(object, :expression, message)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop-cask.rb

@@ -0,0 +1,8 @@
+require 'rubocop'
+
+require 'rubocop/cask/version'
+require 'rubocop/cask/inject'
+
+RuboCop::Cask::Inject.defaults!
+
+require 'rubocop/cop/cask/no_dsl_version'

data/spec/project_spec.rb

@@ -0,0 +1,30 @@
+describe 'RuboCop Project' do
+  describe 'default configuration file' do
+    let(:cop_names) do
+      cop_files = Dir.glob(File.join(File.dirname(__FILE__), '..', 'lib',
+                                     'rubocop', 'cop', 'cask', '*.rb'))
+      cop_files.map do |file|
+        cop_name = File.basename(file, '.rb')
+          .gsub(/(^|_)(.)/) { Regexp.last_match(2).upcase }
+
+        "Cask/#{cop_name}"
+      end
+    end
+
+    subject(:default_config) do
+      RuboCop::ConfigLoader.load_file('config/default.yml')
+    end
+
+    it 'has configuration for all cops' do
+      expect(default_config.keys.sort).to eq((cop_names).sort)
+    end
+
+    it 'has a nicely formatted description for all cops' do
+      cop_names.each do |name|
+        description = default_config[name]['Description']
+        expect(description).not_to be_nil
+        expect(description).not_to include("\n")
+      end
+    end
+  end
+end

data/spec/rubocop/cop/cask/no_dsl_version_spec.rb

@@ -0,0 +1,45 @@
+describe RuboCop::Cop::Cask::NoDslVersion do
+  subject(:cop) { described_class.new }
+
+  it 'checks for dsl version in cask header' do
+    inspect_source(cop, [
+      "cask :v1 => 'foo' do",
+      'end'
+    ])
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.first.line).to eq(1)
+    expect(cop.messages)
+      .to eq(["Use `cask 'foo'` instead of `cask :v1 => 'foo'`"])
+    expect(cop.highlights)
+      .to eq([":v1 => 'foo'"])
+  end
+
+  it 'ignores cask header with no dsl version' do
+    inspect_source(cop, [
+      "cask 'foo' do",
+      'end'
+    ])
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'checks for dsl version in test_cask header' do
+    inspect_source(cop, [
+      "test_cask :v1 => 'foo' do",
+      'end'
+    ])
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.first.line).to eq(1)
+    expect(cop.messages)
+      .to eq(["Use `test_cask 'foo'` instead of `test_cask :v1 => 'foo'`"])
+    expect(cop.highlights)
+      .to eq([":v1 => 'foo'"])
+  end
+
+  it 'ignores test_cask header with no dsl version' do
+    inspect_source(cop, [
+      "test_cask 'foo' do",
+      'end'
+    ])
+    expect(cop.offenses).to be_empty
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'rubocop'
+
+rubocop_path = File.join(File.dirname(__FILE__), '../vendor/rubocop')
+unless File.directory?(rubocop_path)
+  fail "Can't run specs without a local RuboCop checkout. Look in the README."
+end
+Dir["#{rubocop_path}/spec/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.order = :random
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect # Disable `should`
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect # Disable `should_receive` and `stub`
+  end
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rubocop-cask'

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-cask
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Joshua Hagins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: |2
+      Code style checking for Homebrew-Cask files.
+      A plugin for the RuboCop code style enforcing & linting tool.
+email:
+- hagins.josh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- MIT-LICENSE.md
+- README.md
+files:
+- MIT-LICENSE.md
+- README.md
+- config/default.yml
+- lib/rubocop-cask.rb
+- lib/rubocop/cask/inject.rb
+- lib/rubocop/cask/version.rb
+- lib/rubocop/cop/cask/no_dsl_version.rb
+- spec/project_spec.rb
+- spec/rubocop/cop/cask/no_dsl_version_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jawshooah/rubocop-cask
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Code style checking for Homebrew-Cask files
+test_files:
+- spec/project_spec.rb
+- spec/rubocop/cop/cask/no_dsl_version_spec.rb
+- spec/spec_helper.rb