tal_style 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 45e8a1b325028d841153a9fc6544719266a044fc073bbfeea6e24a319e2352ae
+  data.tar.gz: 2f216c846114115fc48957898e530a26beea6989c9de3e809a7cb3a33aee283a
+SHA512:
+  metadata.gz: 8dbfe06153dda26296b650e65b56a04378887d32b295c38b28266bdd89e7470a915d534975839fb00aa7c8d45ea6c53ffa7048a8f30757a471a96ca1004caeaf
+  data.tar.gz: 0d6218a09caaefeb85ad9403a90291852fc5749be349b916304362a7ea670de788f610f0f14413c7dc26b6a0dbd1587b909ae8553e1cde33c9bc7626d40eaf55

data/.gitignore

@@ -0,0 +1,2 @@
+.idea
+*.gem

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# gem "rails"

data/Gemfile.lock

@@ -0,0 +1,11 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+
+BUNDLED WITH
+   1.16.3

data/lib/generators/tal_style/install_generator.rb

@@ -0,0 +1,19 @@
+require 'rails/generators'
+require 'rails/generators/base'
+
+module TalStyle
+  class InstallGenerator < Rails::Generators::Base
+    def self.source_root
+      @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+    end
+
+    def create_root_reek_yml
+      template "reek", ".reek", orce: true
+    end
+
+    def create_root_rubocop
+      template "rubocop.yml", ".rubocop.yml", force: true
+    end
+  end
+end
+

data/lib/generators/tal_style/templates/reek

@@ -0,0 +1,133 @@
+---
+Attribute:
+  enabled: true
+  exclude: []
+BooleanParameter:
+  enabled: true
+  exclude: []
+ClassVariable:
+  enabled: true
+  exclude: []
+ControlParameter:
+  enabled: true
+  exclude: []
+DataClump:
+  enabled: true
+  exclude: []
+  max_copies: 2
+  min_clump_size: 2
+DuplicateMethodCall:
+  enabled: true
+  exclude: []
+  max_calls: 1
+  allow_calls: []
+FeatureEnvy:
+  enabled: true
+  exclude: []
+Attribute:
+  exclude: []
+InstanceVariableAssumption:
+  enabled: false
+  exclude: []
+IrresponsibleModule:
+  enabled: false
+  exclude: []
+LongParameterList:
+  enabled: true
+  exclude: []
+  max_params: 3
+  overrides:
+    initialize:
+      max_params: 5
+LongYieldList:
+  enabled: true
+  exclude: []
+  max_params: 3
+ManualDispatch:
+  enabled: true
+  exclude: []
+ModuleInitialize:
+  enabled: true
+  exclude: []
+NestedIterators:
+  enabled: true
+  exclude: []
+  max_allowed_nesting: 1
+  ignore_iterators:
+  - tap
+NilCheck:
+  enabled: true
+  exclude: []
+PrimaDonnaMethod:
+  enabled: true
+  exclude: []
+RepeatedConditional:
+  enabled: true
+  exclude: []
+  max_ifs: 2
+SubclassedFromCoreClass:
+  enabled: true
+  exclude: []
+Syntax:
+  enabled: true
+  exclude: []
+TooManyConstants:
+  enabled: true
+  exclude: []
+  max_constants: 5
+TooManyInstanceVariables:
+  enabled: true
+  exclude: []
+  max_instance_variables: 4
+TooManyMethods:
+  enabled: true
+  exclude: []
+  max_methods: 15
+TooManyStatements:
+  enabled: true
+  exclude: []
+  max_statements: 5
+UncommunicativeMethodName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeModuleName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  accept: []
+UncommunicativeParameterName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  - !ruby/regexp /^_/
+  accept: []
+UncommunicativeVariableName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept:
+  - !ruby/regexp /^_$/
+UnusedParameters:
+  enabled: true
+  exclude: []
+UnusedPrivateMethod:
+  enabled: false
+  exclude: []
+UtilityFunction:
+  enabled: true
+  exclude: []
+  public_methods_only: false
+

data/lib/generators/tal_style/templates/rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  tal_style: rails/rubocop.yml

data/rails/rubocop.yml

@@ -0,0 +1,28 @@
+Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/ParallelAssignment:
+  Enabled: false
+Style/NumericPredicate:
+  Enabled: false
+Metrics/LineLength:
+  Description: 'Limit lines to 120 characters.'
+  Max: 120
+Metrics/BlockLength:
+  CountComments: false
+  Max: 25
+Metrics/MethodLength:
+  Description: 'Avoid methods longer than `Max` lines of code.'
+  CountComments: false
+  Max: 15
+  Enabled: true
+Metrics/ClassLength:
+  Enabled: false
+AllCops:
+  Exclude:
+    - bin/**/*
+    - vendor/**/*
+    - db/schema.rb
+Rails:
+  Enabled: true

data/readme.md

@@ -0,0 +1,28 @@
+Rails TAL Style
+==================
+
+A gem to unify the development styles across the rails projects [The Appraisal Lane](theappraisallane.com).
+This project is inspired by [house_style](https://github.com/altmetric/house_style)
+
+# Dependencies
+
+This project includes dependencies and configuration files for [reek](https://github.com/troessner/reek), [rubocop](https://github.com/rubocop-hq/rubocop) and [rails best practices](https://github.com/flyerhzm/rails_best_practices).
+
+## Installation and configuration
+
+Add the following line to your project's `Gemfile`
+
+```(ruby)
+group :test, :development do
+    gem 'tal_style'
+end    
+```
+
+After that, run the generator in order to copy the config files to the application's root directory. **This will override your current `.reek` and `.rubocop.yml` files**
+```
+rails generate tal_style:install
+```
+
+That's all!
+Every time you run reek and rubocop in your project the shared config will be loaded.
+

data/tal_style.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = %q{tal_style}
+  spec.version       = '1.0.0'
+  spec.authors       = ['The Appraisal Lane', 'Esteban Bordon']
+  spec.email         = ['developers@theappraisallane.com', 'ebordon@gmail.com']
+
+  spec.summary       = %q{Style guides to develop TAL applications in rails}
+  spec.description   = 'Configuration files and other snippets to help you apply standards across multiple projects'
+  spec.homepage      = 'https://github.com/theappraisallane/rails-tal-style'
+  spec.license       = 'MIT'
+
+  spec.post_install_message = <<-ENDOFMESSAGE
+TAL styles were installed!
+  ENDOFMESSAGE
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rubocop', '~> 0.51', '< 0.65'
+  spec.add_dependency 'rails_best_practices', '<= 1.19.4'
+  spec.add_dependency 'reek', '<= 5.3.1'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: tal_style
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- The Appraisal Lane
+- Esteban Bordon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.65'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.65'
+- !ruby/object:Gem::Dependency
+  name: rails_best_practices
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.19.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.19.4
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 5.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 5.3.1
+description: Configuration files and other snippets to help you apply standards across
+  multiple projects
+email:
+- developers@theappraisallane.com
+- ebordon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- lib/generators/tal_style/install_generator.rb
+- lib/generators/tal_style/templates/reek
+- lib/generators/tal_style/templates/rubocop.yml
+- rails/rubocop.yml
+- readme.md
+- tal_style.gemspec
+homepage: https://github.com/theappraisallane/rails-tal-style
+licenses:
+- MIT
+metadata: {}
+post_install_message: 'TAL styles were installed!
+
+'
+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: Style guides to develop TAL applications in rails
+test_files: []