mdeering-style 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0567a9728d2796ba948633d8b5a367a61a4d4a239259bc4ad1a989b8af9d1f6c
+  data.tar.gz: 585953b1a022ab6850a52f17cd41e5913fcf857d131a51e85b7c920ddaa22b08
+SHA512:
+  metadata.gz: 1d9a6b1ac98ca3093bfa63ee199bb15e816d8e2e25135bad91ceafe7e0e907769ac1f0293565a7fb9a29fffd8c52327876e7221902a58b8e9912e58f21fe9085
+  data.tar.gz: c993709752a5ba2d25a103cfeab049370d616514bd9f8e94621e6c329593e45479e8da7ee4bcc3de17da0a4356392d01d7422af37764f0bec949bb7fcaf8c38f

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_gem:
+  mdeering-style:
+    - rubocop/rspec.yml
+    - rubocop/ruby.yml

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5

data/Gemfile

@@ -0,0 +1,18 @@
+# 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 'yardstick', require: false
+end
+
+# Specify your gem's dependencies in mdeering-style.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'mdeering/style'
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, all_on_start: true, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+end
+
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end
+
+guard :bundler do
+  require 'guard/bundler'
+  require 'guard/bundler/verify'
+  helper = Guard::Bundler::Verify.new
+
+  files = ['Gemfile']
+  files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
+
+  # Assume files are symlinked from somewhere
+  files.each { |file| watch(helper.real_path(file)) }
+end
+
+guard :yardstick, config: Mdeering::Style.yardstick do
+  watch(%r{^lib\/(.+)\.rb$})
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 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,38 @@
+# Mdeering::Style
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development, :test do
+  gem 'mdeering-style', require: false
+end
+```
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    $ gem install mdeering-style
+
+## Usage
+
+Add the following to your .rubocop.yml
+
+```yaml
+inherit_gem:
+  mdeering-style:
+    - rubocop/all.yml # Includes Rails, Ruby && RSpec Cops
+    # - rubocop/ruby.yml # Includes Ruby && RSpec Cops
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mdeering/mdeering-style.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,22 @@
+# 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) do |t|
+  t.options = ['--display-cop-names']
+end
+
+require 'yardstick/rake/verify'
+require 'mdeering/style'
+
+yardstick_options = YAML.load_file(Mdeering::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 'mdeering/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/mdeering/style.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'mdeering/style/version'
+
+module Mdeering
+  # The purpose of mdeering-style is to have centralized and evolving source
+  # of Ruby and Rails configurations for tools common to most of my development
+  # and build environments.
+  module Style
+
+    # Path to yarstick.yml configuration
+    #
+    # @example
+    #  require 'yardstick/rake/verify'
+    #  require 'mdeering/style'
+    #  yardstick_options = YAML.load_file(Mdeering::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/mdeering/style/version.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Mdeering
+  module Style
+    # Semantic versioning
+    module Version
+
+      MAJOR = 0
+      MINOR = 0
+      PATCH = 1
+
+      # Current semantic version of the gem
+      #
+      # @example
+      #   "mdeering-style #{Mdeering::Style::Version} is loaded"
+      #
+      # @return [String]
+      def self.to_s
+        [MAJOR, MINOR, PATCH].join('.')
+      end
+
+    end
+  end
+end

data/mdeering-style.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mdeering/style/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mdeering-style'
+  spec.version       = Mdeering::Style::Version
+  spec.authors       = ['Michael Deering']
+  spec.email         = ['mdeering@mdeering.com']
+
+  spec.summary       = 'My perfered style and linter configurations'
+  spec.description   = 'My opinionated and even sometimes misinformed style and code linting configurations'
+  spec.homepage      = 'https://github.com/mdeering/mdeering-style'
+  spec.license       = 'MIT'
+
+  spec.metadata['yard.run'] = 'yri' # use "yard" to build full HTML docs.
+
+  # 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_dependency 'rubocop'
+  spec.add_dependency 'rubocop-rspec'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/rubocop/all.yml

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

data/rubocop/rails.yml

@@ -0,0 +1,12 @@
+AllCops:
+  Exclude:
+    - bin/*
+    - db/schema.rb
+
+Documentation:
+  Exclude:
+    - app/mailers/application_mailer.rb
+    - app/models/application_record.rb
+    - app/helpers/application_helper.rb
+    - config/application.rb
+    - db/migrate/*.rb

data/rubocop/rspec.yml

@@ -0,0 +1,5 @@
+require: rubocop-rspec
+
+BlockComments:
+  Exclude:
+    - spec/spec_helper.rb

data/rubocop/ruby.yml

@@ -0,0 +1,13 @@
+EmptyLinesAroundBlockBody:
+  Enabled: false
+
+EmptyLinesAroundModuleBody:
+  Enabled: false
+
+LineLength:
+  # I have choosen the value of 125 as that is the width GitHub/GitLab provide
+  # before you need to do any horizontal scrolling
+  Max: 125
+
+SymbolArray:
+  Enabled: false

data/yardstick/.yardstick.yml

@@ -0,0 +1,6 @@
+---
+rules:
+  ApiTag::Presence:
+    enabled: false
+  ApiTag::Inclusion:
+    enabled: false

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: mdeering-style
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Deering
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: My opinionated and even sometimes misinformed style and code linting
+  configurations
+email:
+- mdeering@mdeering.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mdeering/style.rb
+- lib/mdeering/style/version.rb
+- mdeering-style.gemspec
+- rubocop/all.yml
+- rubocop/rails.yml
+- rubocop/rspec.yml
+- rubocop/ruby.yml
+- yardstick/.yardstick.yml
+homepage: https://github.com/mdeering/mdeering-style
+licenses:
+- MIT
+metadata:
+  yard.run: yri
+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.7.6
+signing_key: 
+specification_version: 4
+summary: My perfered style and linter configurations
+test_files: []