cuke_linter 0.13.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7669fb1b66c4e9c103aedb209961dbeca8b308f74bcc1159401fa21e1ffd5b05
-  data.tar.gz: 36ef3927bc68e7d52bde3c91f26ab0428d07b81c7163c0c31aaabf2847fa78db
+  metadata.gz: ae22f6f11409b8b44b14680f1b4134e2deda49a8deca6a92ac78798f33588cd1
+  data.tar.gz: 443760f17fa6d22ba14c5264e0a26b3f71661afbb703505e9ca257cb3d677cfe
 SHA512:
-  metadata.gz: 449a18606c23f574ffba7b5a2d80f9cc7170839daf9187e52404d31ca93e3fb20396860476d827125b6a85968d98985ba83e2ad92d127066a69322edee40459b
-  data.tar.gz: 407d387c3ce3c6eb3648179837757caa688b5b6bdab42b7cc684d3480054fadc0d7aa4c4ef555d241c77919ecb6e8ae7438736ba6b449e56c6ee76cfbdac07e4
+  metadata.gz: 72af3e32ba1ee0a0c4b7b6dd939293b708f4e726e1858d43651d14aa3da8ba0266a4d8d0e6b1b6edd213c24a291c5adc601c736134cf6d1537811276ac29a67d
+  data.tar.gz: 583835b3d2f300f9d960711135aef2c5039062328bb5ba218cad1d37fae71c5dcdce5cc1394f6771281e09fbe740683822b98a5aecdd46c3ce843f12bc9d48dc

data/CHANGELOG.md

@@ -8,6 +8,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Nothing yet...
 
+
+## [1.0.0] - 2020-03-09
+
+### Changed
+ - No longer including every file in the Git repository as part of the gem. Only the files needed for using the linter (and the informative ones like the README) will be packaged into the released gem.
+
+
 ## [0.13.0] - 2020-03-01
 
 ### Added
@@ -147,7 +154,8 @@ Nothing yet...
 - Custom linters, formatters, and command line usability
 
 
-[Unreleased]: https://github.com/enkessler/cuke_linter/compare/v0.13.0...HEAD
+[Unreleased]: https://github.com/enkessler/cuke_linter/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/enkessler/cuke_linter/compare/v0.13.0...v1.0.0
 [0.13.0]: https://github.com/enkessler/cuke_linter/compare/v0.12.1...v0.13.0
 [0.12.1]: https://github.com/enkessler/cuke_linter/compare/v0.12.0...v0.12.1
 [0.12.0]: https://github.com/enkessler/cuke_linter/compare/v0.11.1...v0.12.0

data/README.md

@@ -8,11 +8,11 @@ User stuff:
 [![Yard Docs](http://img.shields.io/badge/Documentation-API-blue.svg)](https://www.rubydoc.info/gems/cuke_linter)
 
 Developer stuff:
-[![Build Status](https://travis-ci.org/enkessler/cuke_linter.svg?branch=dev)](https://travis-ci.org/enkessler/cuke_linter)
-[![Build Status](https://ci.appveyor.com/api/projects/status/g5o70u747x073evy/branch/dev?svg=true)](https://ci.appveyor.com/project/enkessler/cuke-linter/branch/dev)
-[![Coverage Status](https://coveralls.io/repos/github/enkessler/cuke_linter/badge.svg?branch=dev)](https://coveralls.io/github/enkessler/cuke_linter?branch=dev)
+[![Build Status](https://travis-ci.org/enkessler/cuke_linter.svg?branch=master)](https://travis-ci.org/enkessler/cuke_linter)
+[![Build Status](https://ci.appveyor.com/api/projects/status/g5o70u747x073evy/branch/master?svg=true)](https://ci.appveyor.com/project/enkessler/cuke-linter/branch/master)
+[![Coverage Status](https://coveralls.io/repos/github/enkessler/cuke_linter/badge.svg?branch=master)](https://coveralls.io/github/enkessler/cuke_linter?branch=master)
 [![Maintainability](https://api.codeclimate.com/v1/badges/d1b86760e59a457c8e73/maintainability)](https://codeclimate.com/github/enkessler/cuke_linter/maintainability)
-[![Inline docs](http://inch-ci.org/github/enkessler/cuke_linter.svg?branch=dev)](https://inch-ci.org/github/enkessler/cuke_linter?branch=dev)
+[![Inline docs](http://inch-ci.org/github/enkessler/cuke_linter.svg?branch=master)](https://inch-ci.org/github/enkessler/cuke_linter?branch=master)
 
 ---
 

data/cuke_linter.gemspec

@@ -14,11 +14,11 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
 
-  # TODO: don't just include everything in the gem
   # 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
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    source_controlled_files = `git ls-files -z`.split("\x0")
+    source_controlled_files.keep_if { |file| file =~ %r{^(lib|exe|testing/cucumber/features)} } + ['README.md', 'LICENSE.txt', 'CHANGELOG.md', 'cuke_linter.gemspec']
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/lib/cuke_linter.rb

@@ -35,8 +35,11 @@ require 'cuke_linter/linters/test_with_too_many_steps_linter'
 
 module CukeLinter
 
+  # The default keyword that is considered a 'Given' keyword
   DEFAULT_GIVEN_KEYWORD = 'Given'.freeze
+  # The default keyword that is considered a 'When' keyword
   DEFAULT_WHEN_KEYWORD = 'When'.freeze
+  # The default keyword that is considered a 'Then' keyword
   DEFAULT_THEN_KEYWORD = 'Then'.freeze
 
   @original_linters = { 'BackgroundDoesMoreThanSetupLinter'            => BackgroundDoesMoreThanSetupLinter.new,
@@ -132,7 +135,7 @@ module CukeLinter
 
     model_trees                  = [CukeModeler::Directory.new(Dir.pwd)] if model_trees.empty? && file_paths.empty?
     file_path_models             = file_paths.collect do |file_path|
-      # TODO: raise exception unless path exists
+      # TODO: raise exception unless path exists?
       case
         when File.directory?(file_path)
           CukeModeler::Directory.new(file_path)
@@ -150,7 +153,7 @@ module CukeLinter
       model_tree.each_model do |model|
         applicable_linters = relevant_linters_for_model(linters, model)
         applicable_linters.each do |linter|
-          # TODO: have linters lint only certain types of models
+          # TODO: have linters lint only certain types of models?
           #         linting_data.concat(linter.lint(model)) if relevant_model?(linter, model)
 
           result = linter.lint(model)
@@ -176,7 +179,6 @@ module CukeLinter
       end
     end
 
-    # TODO: keep this or always format data?
     linting_data
   end
 

data/lib/cuke_linter/version.rb

@@ -1,4 +1,4 @@
 module CukeLinter
   # The release version of this gem
-  VERSION = '0.13.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuke_linter
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Eric Kessler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-02 00:00:00.000000000 Z
+date: 2020-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cuke_modeler
@@ -164,22 +164,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".simplecov"
-- ".travis.yml"
 - CHANGELOG.md
-- CONTRIBUTING.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- appveyor.yml
-- bin/console
-- bin/setup
 - cuke_linter.gemspec
-- environments/common_env.rb
-- environments/cucumber_env.rb
-- environments/rspec_env.rb
 - exe/cuke_linter
 - lib/cuke_linter.rb
 - lib/cuke_linter/formatters/pretty_formatter.rb
@@ -242,78 +230,6 @@ files:
 - testing/cucumber/features/linters/test_with_setup_step_after_verification_step.feature
 - testing/cucumber/features/linters/test_with_setup_step_as_final_step.feature
 - testing/cucumber/features/linters/test_with_too_many_steps.feature
-- testing/cucumber/step_definitions/action_steps.rb
-- testing/cucumber/step_definitions/setup_steps.rb
-- testing/cucumber/step_definitions/verification_steps.rb
-- testing/file_helper.rb
-- testing/formatter_factory.rb
-- testing/gemfiles/cuke_modeler1.gemfile
-- testing/gemfiles/cuke_modeler2.gemfile
-- testing/linter_factory.rb
-- testing/model_factory.rb
-- testing/rspec/spec/integration/cli_integration_spec.rb
-- testing/rspec/spec/integration/configuration_spec.rb
-- testing/rspec/spec/integration/cuke_linter_integration_spec.rb
-- testing/rspec/spec/integration/formatters/formatter_integration_specs.rb
-- testing/rspec/spec/integration/formatters/pretty_formatter_integration_spec.rb
-- testing/rspec/spec/integration/linters/background_does_more_than_setup_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/element_with_common_tags_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/element_with_duplicate_tags_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/element_with_too_many_tags_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/example_without_name_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/feature_file_with_invalid_name_integration_spec.rb
-- testing/rspec/spec/integration/linters/feature_file_with_mismatched_name_integration_spec.rb
-- testing/rspec/spec/integration/linters/feature_with_too_many_different_tags_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/feature_without_description_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/feature_without_name_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/feature_without_scenarios_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/linter_integration_specs.rb
-- testing/rspec/spec/integration/linters/outline_with_single_example_row_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/single_test_background_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/step_with_end_period_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/step_with_too_many_characters_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/test_should_use_background_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/test_with_action_step_as_final_step_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/test_with_bad_name_integration_spec.rb
-- testing/rspec/spec/integration/linters/test_with_no_action_step_integration_spec.rb
-- testing/rspec/spec/integration/linters/test_with_no_name_integration_spec.rb
-- testing/rspec/spec/integration/linters/test_with_no_verification_step_integration_spec.rb
-- testing/rspec/spec/integration/linters/test_with_setup_step_after_action_step_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/test_with_setup_step_after_verification_step_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/test_with_setup_step_as_final_step_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/test_with_too_many_steps_linter_integration_spec.rb
-- testing/rspec/spec/unit/cuke_linter_unit_spec.rb
-- testing/rspec/spec/unit/formatters/formatter_unit_specs.rb
-- testing/rspec/spec/unit/formatters/pretty_formatter_unit_spec.rb
-- testing/rspec/spec/unit/linters/background_does_more_than_setup_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/configurable_linter_unit_specs.rb
-- testing/rspec/spec/unit/linters/element_with_common_tags_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/element_with_duplicate_tags_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/element_with_too_many_tags_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/example_without_name_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/feature_file_with_invalid_name_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/feature_file_with_mismatched_name_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/feature_with_too_many_different_tags_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/feature_without_description_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/feature_without_name_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/feature_without_scenarios_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/linter_unit_specs.rb
-- testing/rspec/spec/unit/linters/outline_with_single_example_row_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/single_test_background_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/step_with_end_period_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/step_with_too_many_characters_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/test_should_use_background_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/test_with_action_step_as_final_step_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/test_with_bad_name_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/test_with_no_action_step_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/test_with_no_name_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/test_with_no_verification_step_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/test_with_setup_step_after_action_step_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/test_with_setup_step_after_verification_step_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/test_with_setup_step_as_final_step_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/test_with_too_many_steps_linter_unit_spec.rb
 homepage: https://github.com/enkessler/cuke_linter
 licenses:
 - MIT

data/.gitignore

@@ -1,19 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-# JetBrains IDE metadata folders
-/.idea
-
-# Mac metadata directories
-.DS_Store
-
-Gemfile.lock

data/.simplecov

@@ -1,8 +0,0 @@
-SimpleCov.start do
-  root __dir__
-
-  add_filter '/testing/'
-  add_filter '/environments/'
-
-  merge_timeout 300
-end

data/.travis.yml

@@ -1,33 +0,0 @@
-os:
-  - linux
-  - osx
-sudo: false
-
-# JRuby isn't working on the new default distribution
-dist: trusty
-
-language: ruby
-rvm:
-  - 2.3.3
-  - 2.4.0
-  - 2.5.1
-  - 2.6.0
-  - jruby-9.1.7.0
-
-matrix:
-  exclude:
-    # Ruby 2.3.x is currently broken on TravisCI and is no longer a supported Ruby version, anyway.
-    - rvm: 2.3.3
-      os: osx
-
-gemfile:
-  - testing/gemfiles/cuke_modeler1.gemfile
-  - testing/gemfiles/cuke_modeler2.gemfile
-
-gemfile:
-  - testing/gemfiles/cuke_modeler1.gemfile
-  - testing/gemfiles/cuke_modeler2.gemfile
-
-before_install: gem install bundler -v 1.16.2
-
-script: bundle exec rake cuke_linter:ci_build

data/CONTRIBUTING.md

@@ -1,26 +0,0 @@
-# Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake cuke_linter:test_everything` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/enkessler/cuke_linter.
-
-1. Fork it
-2. Create your feature branch **(off of the development branch)**
-   `git checkout -b my-new-feature dev`
-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
-
-
-### Adding a new linter
-
-Some guidelines when adding a new linter
-  * Inherit from the base linter class. It will handle almost all of the functional requirements of a linter.
-  * Existing linters should provide decent examples of how to create new linters and how to test them. A copy/paste/tweak approach is perfectly valid.
-  * Keep linters simple. Rather than have one linter that has different behaviors depending on context, create a different linter class for each context.
-  * Keep things alphabetical. There are going to be lots of linters and things will be easier to find if lists of them in the code base (e.g. `require` statments, documentation, etc.) are in an intuitive order.

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in cuke_linter.gemspec
-gemspec

data/Rakefile

@@ -1,63 +0,0 @@
-require 'rake'
-require 'racatt'
-require 'coveralls/rake/task'
-require 'rainbow'
-
-Rainbow.enabled = true
-
-namespace 'racatt' do
-  Racatt.create_tasks
-end
-
-namespace 'cuke_linter' do
-
-  desc 'Removes the current code coverage data'
-  task :clear_coverage do
-    code_coverage_directory = "#{__dir__}/coverage"
-
-    FileUtils.remove_dir(code_coverage_directory, true)
-  end
-
-  desc 'Check documentation with RDoc'
-  task :check_documentation do
-    output = `rdoc lib -C`
-    puts output
-
-    if output =~ /100.00% documented/
-      puts Rainbow('All code documented').green
-    else
-      raise Rainbow('Parts of the gem are undocumented').red
-    end
-  end
-
-  desc 'Run all of the tests'
-  task :test_everything => [:clear_coverage] do
-    rspec_args    = '--pattern "testing/rspec/spec/**/*_spec.rb" --force-color'
-    cucumber_args = "testing/cucumber/features -r environments/cucumber_env.rb -f progress -t 'not @wip' --color"
-
-    Rake::Task['racatt:test_everything'].invoke(rspec_args, cucumber_args)
-  end
-
-  # creates coveralls:push task
-  Coveralls::RakeTask.new
-
-  desc 'The task that CI will run. Do not run locally.'
-  task :ci_build => ['cuke_linter:test_everything', 'coveralls:push']
-
-  desc 'Check that things look good before trying to release'
-  task :prerelease_check do
-    begin
-      Rake::Task['cuke_linter:test_everything'].invoke
-      Rake::Task['cuke_linter:check_documentation'].invoke
-    rescue => e
-      puts Rainbow("-----------------------\nSomething isn't right!").red
-      raise e
-    end
-
-    puts Rainbow("-----------------------\nAll is well. :)").green
-  end
-
-end
-
-
-task :default => 'cuke_linter:test_everything'

data/appveyor.yml

@@ -1,43 +0,0 @@
-version: '1.0.{build}'
-
-environment:
-  matrix:
-    - RUBY_VERSION: 23
-      BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler1.gemfile
-    - RUBY_VERSION: 23-x64
-      BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler1.gemfile
-    - RUBY_VERSION: 24
-      BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler1.gemfile
-    - RUBY_VERSION: 24-x64
-      BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler1.gemfile
-    - RUBY_VERSION: 25
-      BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler1.gemfile
-    - RUBY_VERSION: 25-x64
-      BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler1.gemfile
-
-    - RUBY_VERSION: 23
-      BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler2.gemfile
-    - RUBY_VERSION: 23-x64
-      BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler2.gemfile
-    - RUBY_VERSION: 24
-      BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler2.gemfile
-    - RUBY_VERSION: 24-x64
-      BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler2.gemfile
-    - RUBY_VERSION: 25
-      BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler2.gemfile
-    - RUBY_VERSION: 25-x64
-      BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler2.gemfile
-
-install:
-  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
-  - bundle install
-
-build: off
-
-before_test:
-  - ruby -v
-  - gem -v
-  - bundle -v
-
-test_script:
-  - bundle exec rake cuke_linter:ci_build

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "cuke_linter"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)