datarockets-style 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 324883d55397473999caa61fc8ede9378a4fad7e
+  data.tar.gz: 7baac97267430faabd884999ade8340189e0e32f
+SHA512:
+  metadata.gz: e3e7980949ee6b086ff587485378546b935b69b105874e1a043eb648fa5db66f212ef12d5ba5b6a9d0f3c7d13a7677d0abf77d0c983c0bcda261e25a1372a010
+  data.tar.gz: df7210852291e82002373257e0dce1c5baf1c87b4051003835bac2e0a7903193101625ee7d4b1a9f83cbef9c2189c7b4c96b6487346d626da47a03f7a055e621

data/.gitignore

@@ -0,0 +1,7 @@
+/.bundle/
+/bundler/
+/.yardoc
+/_yardoc/
+/doc/
+/pkg/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Change Log
+
+The format is described in [Contributing notes](CONTRIBUTING.md#changelog-entry-format)
+
+## master (unreleased)
+
+## 0.1.0 (2019-06-27)
+
+### Added
+
+* Base config with community rules and some basic override rules. ([@r.dubrovsky][], [@aleks][])
+* Config is based on rubocop version 0.72.0 ([@r.dubrovsky][])
+* Enable `rubocop-spec` cops by default ([@r.dubrovsky][])
+* Enable `Bundler/DuplicatedGem` cop by default ([@r.dubrovsky][])
+* Enable `Bundler/OrderedGems` cop with allowing ordering by groups ([@r.dubrovsky][])
+
+
+### Changed
+
+* Change the limit for size of line to 120 symbols ([@r.dubrovsky][])
+* Disable `Metrics/BlockLength` cop for rspec files ([@r.dubrovsky][])
+* Exclude rubocop checking for some config directories ([@r.dubrovsky][])
+* Enable prafering double quotes for string literals ([@r.dubrovsky][])
+* Do not add spaces beetwen hash literal braces (cop `Layout/SpaceInsideHashLiteralBraces`) ([@r.dubrovsky][])
+* Prefer normal style for `Layout/IndentationConsistency` cop for Rails apps too ([@r.dubrovsky][])
+* Change style to `variable` for `Layout/EndAlignment` cop ([@r.dubrovsky][])
+* Change style to `with_fixed_indentation` with indentation width 2 for `Layout/AlignParameter` cop ([@r.dubrovsky][])
+* Always ingone hash aligning for key word arguments (cop: `Layout/AlignHash`) ([@r.dubrovsky][])
+
+[@r.dubrovsky]: https://github.com/roman-dubrovsky
+[@aleks]: https://github.com/AleksSenkou

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hello@datarockets.com All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,60 @@
+# Contributing
+
+If you discover issues, want to add or change some code-style rules,
+have ideas for improvements or new features,
+please report them to the [issue tracker][1] of the repository or
+submit a pull request. Please, try to follow these guidelines when you
+do so.
+
+## Issue reporting
+
+* Check that the issue has not already been reported.
+* Check that the issue has not already been fixed in the latest code
+  (a.k.a. `master`).
+* Be clear, concise and precise in your description of the problem.
+* Open an issue with a descriptive title and a summary in grammatically correct,
+  complete sentences.
+* Include any relevant code to the issue summary
+
+## Pull requests
+
+* Read [how to properly contribute to open source projects on GitHub][2].
+* Fork the project.
+* Use a topic/feature branch to easily amend a pull request later, if necessary.
+* Write [good commit messages][3].
+* Use the same coding conventions as the rest of the project.
+* Commit and push until you are happy with your contribution.
+* If your change has a corresponding open GitHub issue, prefix the commit message with `[Fix #github-issue-number]`.
+* Make sure to add tests for it. This is important so we don't break it
+  in a future version unintentionally.
+* If you add new code-style rule or cop, add some words about it in the [Code Style Notes](STYLE_GUIDE.md).
+* Add an entry to the [Changelog](CHANGELOG.md) accordingly. See [changelog entry format](#changelog-entry-format).
+* If you deliver new cop, try to suggest and deliver it to the community [rubocop][7] gem.
+* [Squash related commits together][5].
+* Open a [pull request][4] that relates to *only* one subject with a clear title
+  and description in grammatically correct, complete sentences.
+
+### Changelog entry format
+
+Here are a few examples:
+
+```
+* [#716](https://github.com/rubocop-hq/rubocop/issues/716): Fixed a regression in the auto-correction logic of `MethodDefParentheses`. ([@bbatsov][])
+* New cop `ElseLayout` checks for odd arrangement of code in the `else` branch of a conditional expression. ([@bbatsov][])
+```
+
+* There are four categories for each release: added, changed, bug fixed and removed
+* Mark it up in [Markdown syntax][6].
+* The entry line should start with `* ` (an asterisk and a space).
+* If the change has a related GitHub issue (e.g. a bug fix for a reported issue), put a link to the issue as `[#123](https://github.com/rubocop-hq/rubocop/issues/123): `.
+* Describe the brief of the change. The sentence should end with a punctuation.
+* At the end of the entry, add an implicit link to your GitHub user page as `([@username][])`.
+* If this is your first contribution to RuboCop project, add a link definition for the implicit link to the bottom of the changelog as `[@username]: https://github.com/username`.
+
+[1]: https://github.com/datarockets/datarockets-style/issues
+[2]: https://www.gun.io/blog/how-to-github-fork-branch-and-pull-request
+[3]: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[4]: https://help.github.com/articles/about-pull-requests
+[5]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html
+[6]: https://daringfireball.net/projects/markdown/syntax
+[7]: https://github.com/rubocop-hq/rubocop

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    datarockets-style (0.1.0)
+      rubocop (~> 0.72.0)
+      rubocop-rspec
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    jaro_winkler (1.5.3)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.72.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-rspec (1.33.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  datarockets-style!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 datarockets
+
+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,60 @@
+# Datarockets::Style
+
+Datarockets shared style configs and notes of code-style convensions. Based on the [Rubocop](https://github.com/rubocop-hq/rubocop) util.
+
+This config enforces many of the guidelines outlined in the datarockets [Ruby Style Guide](STYLE_GUIDE.md).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :test, :development do
+  gem 'datarockets-style'
+end
+```
+
+Or, for a Ruby library, add this to your gemspec:
+
+```ruby
+spec.add_development_dependency 'datarockets-style'
+```
+
+And then execute:
+
+$ bundle install
+
+## Usage
+
+Create a `.rubocop.yml` with the following directives:
+
+```yaml
+inherit_gem:
+  datarockets-style:
+    - default.yml
+```
+
+Now, run:
+
+```bash
+$ bundle exec rubocop
+```
+
+You do not need to include rubocop directly in your application's dependencies. Datarockets-style will include a specific version of `rubocop` and `rubocop-rspec` that is shared across all projects.
+
+## Changelog
+
+Datarockets Style's changelog is available [here](CHANGELOG.md).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/datarockets/datarockets-style. If you'd like to contribute to our RuboCop config and code-style rules, please take the time to go through our short [contribution guidelines](CONTRIBUTING.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Datarockets::Style project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).

data/RELEASING.md

@@ -0,0 +1,17 @@
+# Releasing
+
+* Update `version.rb` file accordingly.
+* Update `CHANGELOG.md` file
+* Tag the release: `git tag vVERSION`
+* Push changes: `git push --tags`
+* Update the release notes on GitHub.com
+* Build and publish:
+
+```bash
+bundle exec rake build
+gem push *todo*
+```
+
+* Announce the new release,
+   making sure to say "thank you" to the contributors
+   who helped shape this version!

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+# require "rspec/core/rake_task"
+
+# RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/STYLE_GUIDE.md

@@ -0,0 +1,202 @@
+# Style Guide
+
+In datarockets we enforce a community [Ruby Style Guide](https://github.com/rubocop-hq/ruby-style-guide).
+
+This is a small list of differences which we have when compared with community style guide:
+
+## Bundler
+
+* A Gem's requirements should be listed only once in a Gemfile
+
+* Gems should be alphabetically sorted within groups. Also you can use a line comment as a group separator.
+
+## Style
+
+* Limit lines to 80 characters.
+
+* Prefer double-quotes unless your string literal contains " or escape characters you want to suppress.
+
+* If elements of a hash literal span more than one line we're aligning them by keys
+
+
+```ruby
+# bad
+{
+  foo: bar,
+   ba: baz
+}
+{
+  foo: bar,
+  ba:  baz
+}
+
+# good
+{
+  foo: bar,
+  ba: baz
+}
+```
+
+* There is one exception in the rule above when the hash literal is passed as method argument.
+In this case we just use an indentation level.
+
+```ruby
+# bad
+do_something(foo: 1,
+             bar: 2)
+
+# good
+do_something(foo: 1,
+  bar: 2)
+```
+
+* The parameters on a multi-line method call or definition are aligning by an indentation level.
+
+```ruby
+# good
+
+def foo(bar,
+  baz)
+  123
+end
+
+def foo(
+  bar,
+  baz
+)
+  123
+end
+
+# bad
+
+def foo(bar,
+        baz)
+  123
+end
+
+# bad
+
+def foo(
+  bar,
+     baz)
+  123
+end
+```
+
+* The `end` shall be aligned with the left-hand-side of the variable assignment. But we prefer not to use code blocks with `end` for variable assignment and prefer move it into the separate methods.
+
+```ruby
+# bad
+
+variable = if true
+           end
+
+variable = array.map do |value|
+                    value
+                  end
+
+# good
+
+variable = if true
+end
+
+variable =
+  if true
+  end
+
+variable = array.map do |value|
+  value
+end
+
+# better
+
+variable = condition_value
+
+def condition_value(*args)
+  if true
+  end
+end
+
+variable = values_from_array(array)
+
+def values_from_array(array)
+  array.map do |value|
+    value
+  end
+end
+
+```
+
+* We're prefering a ruby style for methods indentations, not rails. You can check it [here](https://github.com/rubocop-hq/ruby-style-guide#indent-public-private-protected)
+
+```ruby
+# bad
+class A
+  def test
+    puts 'hello'
+     puts 'world'
+  end
+end
+
+# bad
+class A
+  def test
+    puts 'hello'
+    puts 'world'
+  end
+
+  protected
+
+    def foo
+    end
+
+  private
+
+    def bar
+    end
+end
+
+# good
+class A
+  def test
+    puts 'hello'
+    puts 'world'
+  end
+end
+
+# good
+class A
+  def test
+    puts 'hello'
+    puts 'world'
+  end
+
+  protected
+
+  def foo
+  end
+
+  private
+
+  def bar
+  end
+end
+```
+
+* For hash literals not to add scapes after `{` or before `}`. We want to have the advantage of adding visual difference between block and hash literals.
+
+```ruby
+# bad
+h = { a: 1, b: 2 }
+Array.new(3) {|i| i + 1}
+
+# good
+h = {a: 1, b: 2}
+Array.new(3) { |i| i + 1 }
+```
+
+## Rspec
+
+* We're happy to use [better spec rules](http://www.betterspecs.org/) for improving our tests.
+
+* We're not limiting a length of rspec files

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "datarockets/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 --path=bundler
+
+# Do any other automated setup that you need to do here

data/datarockets-style.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "datarockets/style/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "datarockets-style"
+  spec.version       = Datarockets::Style::VERSION
+  spec.authors       = ["Roman Dubrovsky"]
+  spec.email         = ["r.dubrovsky@datarockets.com"]
+
+  spec.summary       = "Datarockets style guides and shared style configs"
+  spec.homepage      = "https://github.com/datarockets/datarockets-style"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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", "~> 0.72.0"
+  spec.add_dependency "rubocop-rspec"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/default.yml

@@ -0,0 +1,45 @@
+AllCops:
+  Exclude:
+    - "db/**/*"
+    - "bin/*"
+    - "lib/tasks/**/*"
+    - "config/**/*"
+    - "vendor/**/*"
+    - "app/views/**/*"
+    - "config.ru"
+    - "Rakefile"
+
+require: rubocop-rspec
+
+Bundler/DuplicatedGem:
+  Enabled: true
+
+Bundler/OrderedGems:
+  TreatCommentsAsGroupSeparators: true
+
+Layout/AlignHash:
+  EnforcedLastArgumentHashStyle: always_ignore
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+  IndentationWidth: 2
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Layout/IndentationConsistency:
+  EnforcedStyle: normal
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBraces: no_space
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+Metrics/LineLength:
+  Max: 120
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/lib/datarockets/style.rb

@@ -0,0 +1,7 @@
+require "datarockets/style/version"
+
+module Datarockets
+  module Style
+    # Your code goes here...
+  end
+end

data/lib/datarockets/style/version.rb

@@ -0,0 +1,5 @@
+module Datarockets
+  module Style
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: datarockets-style
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roman Dubrovsky
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.72.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.72.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'
+description: 
+email:
+- r.dubrovsky@datarockets.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- RELEASING.md
+- Rakefile
+- STYLE_GUIDE.md
+- bin/console
+- bin/setup
+- datarockets-style.gemspec
+- default.yml
+- lib/datarockets/style.rb
+- lib/datarockets/style/version.rb
+homepage: https://github.com/datarockets/datarockets-style
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Datarockets style guides and shared style configs
+test_files: []