surveymonkey-style 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4bc053ec165afeb7a7f2fbee0f31349466dc7b7f66de9bb1bf5062109718a568
+  data.tar.gz: e4ee65542286b7d9c5c7d4ea6de5e3786930669ed85a79098d93f9279c905fc0
+SHA512:
+  metadata.gz: 9ae384eccca234898dfc3a41400fe711818459dbb877a01c7f417c38778908269851b4fd26afd4e46e718a1e791d2ded91806a6329f0267d8b43476d23e7ec96
+  data.tar.gz: edcbb052a0383a2f4a3852d277d000409f7c2462fa6ce8806b72da6fac0c775296b69f962279d22063b5f151610ad51fc0252d65b1ef4d60bc1cae6255eeae5a

data/.dependabot/config.yml

@@ -0,0 +1,16 @@
+version: 1
+update_configs:
+  # Update your Gemfile (& lockfiles) as soon as
+  # new versions are published to the RubyGems registry
+  - package_manager: 'ruby:bundler'
+    directory: '/'
+    update_schedule: 'live'
+
+    default_reviewers:
+      # TODO: We need to create a getfeedback/ruby-libraries team
+      - 'mdeering'
+    default_labels:
+      - 'Dependencies'
+      - 'Dependabot'
+
+# To learn more about this config file, visit: https://dependabot.com/docs/config-file/

data/.github/workflows/rake.yml

@@ -0,0 +1,38 @@
+name: Default rake tasks
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, 'ci-skip')"
+
+    strategy:
+      matrix:
+        ruby: ['2.5', '2.6', '2.7']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby }}
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install required packages
+      run: |
+        sudo apt-get update
+    - name: Cache gems
+      uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os}}-gem-
+    - name: Install gems
+      run: |
+        gem install bundler
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+    - name: Build, test, and lint with default Rake task
+      run: |
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_gem:
+  surveymonkey-style:
+    - rubocop/performance.yml
+    - rubocop/rspec.yml
+    - rubocop/ruby.yml
+
+RSpec/FilePath:
+  Exclude:
+    # Wants file names for SurveyMonkey to be survey_monkey
+    - spec/surveymonkey/**/*

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.1.2

data/Gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+group :development do
+  gem 'guard-bundler',   require: false
+  gem 'guard-rspec',     require: false
+  gem 'guard-rubocop',   require: false
+  gem 'guard-yardstick', require: false
+end
+
+group :test do
+  gem 'rspec',               require: false
+  gem 'rubocop',             require: false
+  gem 'rubocop-performance', require: false
+  gem 'rubocop-rspec',       require: false
+  gem 'yardstick',           require: false
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,109 @@
+PATH
+  remote: .
+  specs:
+    surveymonkey-style (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ffi (1.12.2)
+    formatador (0.2.5)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-bundler (2.2.1)
+      bundler (>= 1.3.0, < 3)
+      guard (~> 2.2)
+      guard-compat (~> 1.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.3.0)
+      guard (~> 2.0)
+      rubocop (~> 0.20)
+    guard-yardstick (1.0.0)
+      guard (>= 2.0)
+      guard-compat (>= 1.2)
+      yardstick (>= 0.9)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.4)
+    method_source (1.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.83.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.39.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    shellany (0.0.1)
+    thor (1.0.1)
+    unicode-display_width (1.7.0)
+    yard (0.9.25)
+    yardstick (0.9.9)
+      yard (~> 0.8, >= 0.8.7.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard-bundler
+  guard-rspec
+  guard-rubocop
+  guard-yardstick
+  rake
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+  surveymonkey-style!
+  yardstick
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Michael Deering
+
+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,34 @@
+# SurveyMonkey::Style
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development, :test do
+  gem 'surveymonkey-style', require: false
+end
+```
+## Usage
+
+### RuboCop
+
+Add the following to your .rubocop.yml
+
+```yaml
+inherit_gem:
+  surveymonkey-style:
+    - rubocop/all.yml # Includes Rails, Ruby && RSpec Cops
+    # - rubocop/ruby.yml # Includes Ruby && RSpec Cops
+```
+
+### Yardstick
+
+Pull in the yardstick configuration options like so.
+
+```ruby
+require 'yardstick/rake/verify'
+require 'surveymonkey/style'
+yardstick_options = YAML.load_file(SurveyMonkey::Style.yardstick)
+Yardstick::Rake::Verify.new(:yardstick, yardstick_options)
+```

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop)
+
+require 'yardstick/rake/verify'
+
+require 'surveymonkey/style'
+
+yardstick_options = YAML.load_file(SurveyMonkey::Style.yardstick)
+Yardstick::Rake::Verify.new(:yardstick, yardstick_options)
+
+task default: [:spec, :rubocop, :yardstick]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'surveymonkey/style'
+
+# 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__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/surveymonkey/style.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'surveymonkey/style/version'
+
+module SurveyMonkey
+  # SurveyMonkey common code and linting settings and configurations
+  module Style
+    class Error < StandardError; end
+
+    # Path to yarstick.yml configuration
+    #
+    # @api public
+    #
+    # @example
+    #  require 'yardstick/rake/verify'
+    #  require 'surveymonkey/style'
+    #  yardstick_options = YAML.load_file(SurveyMonkey::Style.yardstick)
+    #  Yardstick::Rake::Verify.new(:yardstick, yardstick_options)
+    #
+    # @return [String]
+    def self.yardstick
+      File.expand_path('../../yardstick/.yardstick.yml', __dir__)
+    end
+  end
+end

data/lib/surveymonkey/style/version.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module SurveyMonkey
+  module Style
+    # Semantic versioning
+    module Version
+
+      MAJOR       = 0
+      MINOR       = 1
+      PATCH       = 0
+      PRE_RELEASE = nil
+
+      # Current semantic version of the gem
+      #
+      # @api public
+      #
+      # @example
+      #   "surveymonkey-style #{SurveyMonkey::Style::Version} has been loaded!"
+      #
+      # @return [string] Current semantic version of the gem
+      def self.to_s
+        [MAJOR, MINOR, PATCH, PRE_RELEASE].compact.join('.')
+      end
+
+    end
+  end
+end

data/rubocop/all.yml

@@ -0,0 +1,5 @@
+inherit_from:
+  - ./performance.yml
+  - ./rails.yml
+  - ./rspec.yml
+  - ./ruby.yml

data/rubocop/performance.yml

@@ -0,0 +1 @@
+require: rubocop-performance

data/rubocop/rails.yml

@@ -0,0 +1,9 @@
+require: rubocop-rails
+
+Metrics/MethodLength:
+  Exclude:
+    - db/migrate/*.rb
+
+Style/Documentation:
+  Exclude:
+    - db/migrate/*.rb

data/rubocop/rspec.yml

@@ -0,0 +1,10 @@
+require: rubocop-rspec
+
+Style/BlockComments:
+  Exclude:
+    - spec/spec_helper.rb
+
+# RSpec files are basicly huge blocks of blocks
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb

data/rubocop/ruby.yml

@@ -0,0 +1,41 @@
+AllCops:
+  DisplayCopNames: true
+  NewCops: enable
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+# Whitespace is never a bad thing
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+# Whitespace is never a bad thing
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+# Whitespace is never a bad thing
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: false
+
+# Whitespace is never a bad thing
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Layout/HashAlignment:
+  EnforcedColonStyle:      table
+  EnforcedHashRocketStyle: table
+
+Layout/LineLength:
+  # Chosen the value of 125 as that is the width GitHub/GitLab provide
+  # before you need to do any horizontal scrolling
+  Max: 125
+
+# SymbolArrays are jarring to anyone coming from any other language. What are you gaining
+# anyway with %i[foo bar baz] VS [:foo, :bar, :baz]? Street cred../
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+# WordArray are jarring to anyone coming from any other language. What are you gaining
+# anyway with %w[foo bar baz] VS ['foo', 'bar', 'baz']? Street cred../
+Style/WordArray:
+  EnforcedStyle: brackets

data/surveymonkey-style.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'lib/surveymonkey/style/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'surveymonkey-style'
+  spec.version       = SurveyMonkey::Style::Version
+  spec.authors       = ['Michael Deering']
+  spec.email         = ['mdeering@mdeering.com']
+
+  spec.summary       = 'SurveyMonkey coding standards'
+  spec.description   = 'Set of common SurveyMonkey coding and linting settings and configurations'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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 'rake'
+end

data/yardstick/.yardstick.yml

@@ -0,0 +1,10 @@
+---
+rules:
+  APITag::Presence:
+    enabled: false
+  ApiTag::Inclusion:
+    enabled: false
+  ApiTag::ProtectedMethod:
+    enabled: false
+  ApiTag::PrivateMethod:
+    enabled: false

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: surveymonkey-style
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Deering
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Set of common SurveyMonkey coding and linting settings and configurations
+email:
+- mdeering@mdeering.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".dependabot/config.yml"
+- ".github/workflows/rake.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/surveymonkey/style.rb
+- lib/surveymonkey/style/version.rb
+- rubocop/all.yml
+- rubocop/performance.yml
+- rubocop/rails.yml
+- rubocop/rspec.yml
+- rubocop/ruby.yml
+- surveymonkey-style.gemspec
+- yardstick/.yardstick.yml
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.10
+signing_key: 
+specification_version: 4
+summary: SurveyMonkey coding standards
+test_files: []