devtools 0.1.0

data/default/config/mutant.yml

@@ -0,0 +1,3 @@
+---
+name: your_lib
+namespace: YourLib

data/default/config/reek.yml

@@ -0,0 +1,103 @@
+---
+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: []
+IrresponsibleModule:
+  enabled: true
+  exclude: []
+LongParameterList:
+  enabled: true
+  exclude: []
+  max_params: 2
+  overrides:
+    initialize:
+      max_params: 3
+LongYieldList:
+  enabled: true
+  exclude: []
+  max_params: 2
+NestedIterators:
+  enabled: true
+  exclude: []
+  max_allowed_nesting: 1
+  ignore_iterators: []
+NilCheck:
+  enabled: true
+  exclude: []
+RepeatedConditional:
+  enabled: true
+  exclude: []
+  max_ifs: 1
+TooManyInstanceVariables:
+  enabled: true
+  exclude: []
+  max_instance_variables: 3
+TooManyMethods:
+  enabled: true
+  exclude: []
+  max_methods: 10
+TooManyStatements:
+  enabled: true
+  exclude:
+  - each
+  max_statements: 2
+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]/
+  accept: []
+UncommunicativeVariableName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UnusedParameters:
+  enabled: true
+  exclude: []
+UtilityFunction:
+  enabled: true
+  exclude: []
+  max_helper_calls: 0

data/default/config/rubocop.yml

@@ -0,0 +1,91 @@
+AllCops:
+  Includes:
+    - '**/*.rake'
+    - 'Gemfile'
+  Excludes:
+    - '**/vendor/**'
+    - '**/benchmarks/**'
+
+# Avoid parameter lists longer than five parameters.
+ParameterLists:
+  Max: 3
+  CountKeywordArgs: true
+
+# Limit method length
+MethodLength:
+  CountComments: false
+  Max: 10
+
+# Avoid more than `Max` levels of nesting.
+BlockNesting:
+  Max: 3
+
+# Align with the style guide.
+CollectionMethods:
+  PreferredMethods:
+    collect:  'map'
+    inject:   'reduce'
+    find:     'detect'
+    find_all: 'select'
+
+# Do not force public/protected/private keyword to be indented at the same
+# level as the def keyword. My personal preference is to outdent these keywords
+# because I think when scanning code it makes it easier to identify the
+# sections of code and visually separate them. When the keyword is at the same
+# level I think it sort of blends in with the def keywords and makes it harder
+# to scan the code and see where the sections are.
+AccessModifierIndentation:
+  Enabled: false
+
+# Limit line length
+LineLength:
+  Max: 79
+
+# Disable documentation checking until a class needs to be documented once
+Documentation:
+  Enabled: false
+
+# Do not always use &&/|| instead of and/or.
+AndOr:
+  Enabled: false
+
+# Do not favor modifier if/unless usage when you have a single-line body
+IfUnlessModifier:
+  Enabled: false
+
+# Allow case equality operator (in limited use within the specs)
+CaseEquality:
+  Enabled: false
+
+# Constants do not always have to use SCREAMING_SNAKE_CASE
+ConstantName:
+  Enabled: false
+
+# Not all trivial readers/writers can be defined with attr_* methods
+TrivialAccessors:
+  Enabled: false
+
+# Do not prefer do/end over {} for multiline blocks
+Blocks:
+  Enabled: false
+
+# Allow empty lines around body
+EmptyLinesAroundBody:
+  Enabled: false
+
+# Prefer String#% over Kernel#sprintf
+FormatString:
+  Enabled: false
+
+# Use square brackets for literal Array objects
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  ()
+    '%i': '[]'
+    '%q': ()
+    '%Q': ()
+    '%r': '{}'
+    '%s': ()
+    '%w': '[]'
+    '%W': '[]'
+    '%x': ()

data/default/config/yardstick.yml

@@ -0,0 +1,2 @@
+---
+threshold: 100

data/devtools.gemspec

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+  gem.name        = 'devtools'
+  gem.version     = '0.1.0'
+  gem.authors     = [ 'Markus Schirp' ]
+  gem.email       = [ 'mbj@schirp-dso.com' ]
+  gem.description = 'A metagem for ROM-style development'
+  gem.summary     = gem.description
+  gem.homepage    = 'https://github.com/rom-rb/devtools'
+  gem.license     = 'MIT'
+
+  gem.require_paths         = %w[lib]
+  gem.files                 = `git ls-files`.split($/)
+  gem.executables           = %w[devtools]
+  gem.test_files            = `git ls-files -- spec`.split($/)
+  gem.extra_rdoc_files      = %w[README.md TODO]
+  gem.required_ruby_version = '>= 2.1'
+
+  gem.add_dependency 'rspec',        '~> 3.3.0'
+  gem.add_dependency 'rspec-core',   '~> 3.3.0'
+  gem.add_dependency 'rspec-its',    '~> 1.2.0'
+  gem.add_dependency 'rake',         '~> 10.4.2'
+  gem.add_dependency 'yard',         '~> 0.8.7.6'
+  gem.add_dependency 'flay',         '~> 2.6.1'
+  gem.add_dependency 'flog',         '~> 4.3.2'
+  gem.add_dependency 'reek',         '~> 3.3.1'
+  gem.add_dependency 'rubocop',      '~> 0.33.0'
+  gem.add_dependency 'simplecov',    '~> 0.10.0'
+  gem.add_dependency 'yardstick',    '~> 0.9.9'
+  gem.add_dependency 'mutant',       '~> 0.8.3'
+  gem.add_dependency 'mutant-rspec', '~> 0.8.2'
+end

data/lib/devtools.rb

@@ -0,0 +1,143 @@
+# encoding: utf-8
+
+require 'pathname'
+require 'rake'
+require 'timeout'
+require 'yaml'
+require 'fileutils'
+
+require 'devtools/platform'
+require 'devtools/site'
+require 'devtools/site/initializer'
+require 'devtools/project'
+require 'devtools/config'
+require 'devtools/project/initializer'
+require 'devtools/project/initializer/rake'
+require 'devtools/project/initializer/rspec'
+
+# Provides access to metric tools
+module Devtools
+
+  extend Platform
+
+  ROOT                    = Pathname.new(__FILE__).parent.parent.freeze
+  PROJECT_ROOT            = Pathname.pwd.freeze
+  SHARED_PATH             = ROOT.join('shared').freeze
+  SHARED_SPEC_PATH        = SHARED_PATH.join('spec').freeze
+  DEFAULT_CONFIG_PATH     = ROOT.join('default/config').freeze
+  RAKE_FILES_GLOB         = ROOT.join('tasks/**/*.rake').to_s.freeze
+  LIB_DIRECTORY_NAME      = 'lib'.freeze
+  SPEC_DIRECTORY_NAME     = 'spec'.freeze
+  RB_FILE_PATTERN         = '**/*.rb'.freeze
+  RAKE_FILE_NAME          = 'Rakefile'.freeze
+  REQUIRE                 = "require 'devtools'".freeze
+  INIT_RAKE_TASKS         = 'Devtools.init_rake_tasks'.freeze
+  SHARED_SPEC_PATTERN     = '{shared,support}/**/*.rb'.freeze
+  UNIT_TEST_PATH_REGEXP   = %r{\bspec/unit/}.freeze
+  DEFAULT_CONFIG_DIR_NAME = 'config'.freeze
+  ANNOTATION_WRAPPER      = "\n# Added by devtools\n%s\n".freeze
+
+  # Provides devtools for a project
+  SITE = Site.new(Project.new(PROJECT_ROOT))
+
+  # React to metric violation
+  #
+  # @param [String] msg
+  #
+  # @return [undefined]
+  #
+  # @api private
+  def self.notify_metric_violation(msg)
+    abort(msg)
+  end
+
+  # Initialize project and load tasks
+  #
+  # Should *only* be called from your $application_root/Rakefile
+  #
+  # @return [self]
+  #
+  # @api public
+  def self.init_rake_tasks
+    Project::Initializer::Rake.call
+    self
+  end
+
+  # Initialize project and load shared specs
+  #
+  # Expects to be called from $application_root/spec/spec_helper.rb
+  #
+  # @return [self]
+  #
+  # @api public
+  def self.init_spec_helper
+    SITE.init_spec_helper
+    self
+  end
+
+  # Initialize devtools using default config
+  #
+  # @return [undefined]
+  #
+  # @api public
+  def self.init
+    SITE.init
+    self
+  end
+
+  # Return project
+  #
+  # @return [Project]
+  #
+  # @api private
+  def self.project
+    SITE.project
+  end
+
+  # Require shared examples
+  #
+  # @param [Pathname] dir
+  #   the directory containing the files to require
+  #
+  # @param [String] pattern
+  #   the file pattern to match inside directory
+  #
+  # @return [self]
+  #
+  # @api private
+  def self.require_files(dir, pattern)
+    Dir[dir.join(pattern)].each { |file| require file }
+    self
+  end
+
+  # Detect ci
+  #
+  # @return [Boolean]
+  #
+  # @api private
+  #
+  def self.ci?
+    ENV.key?('CI')
+  end
+
+  # Detect circle ci
+  #
+  # @return [Boolean]
+  #
+  # @api private
+  #
+  def self.circle_ci?
+    ENV.key?('CIRCLECI')
+  end
+
+  # Detect travis ci
+  #
+  # @return [Boolean]
+  #
+  # @api private
+  #
+  def self.travis?
+    ENV.key?('TRAVIS')
+  end
+
+end # module Devtools

data/lib/devtools/config.rb

@@ -0,0 +1,158 @@
+# encoding: utf-8
+
+module Devtools
+
+  # Abstract base class of tool configuration
+  class Config
+    # Represent no configuration
+    DEFAULT_CONFIG = {}.freeze
+
+    # Declare an attribute
+    #
+    # @param [Symbol] name
+    #
+    # @yieldreturn [Object]
+    #   the default value to use
+    #
+    # @api private
+    #
+    # @return [self]
+    #
+    def self.attribute(name, *default)
+      define_method(name) do
+        raw.fetch(name.to_s, *default)
+      end
+    end
+    private_class_method :attribute
+
+    # Return project
+    #
+    # @return [Project]
+    #
+    # @api private
+    #
+    attr_reader :project
+
+    # Initialize object
+    #
+    # @return [Project]
+    #
+    # @api private
+    #
+    def initialize(project)
+      @project = project
+    end
+
+    # Return config path
+    #
+    # @return [String]
+    #
+    # @api private
+    #
+    def config_file
+      @config_file ||= project.config_dir.join(self.class::FILE).freeze
+    end
+
+  private
+
+    # Return raw data
+    #
+    # @return [Hash]
+    #
+    # @api private
+    #
+    def raw
+      @raw ||= yaml_config || DEFAULT_CONFIG
+    end
+
+    # Return the raw config data from a yaml file
+    #
+    # @return [Hash]
+    #   returned if the yaml file is found
+    # @return [nil]
+    #   returned if the yaml file is not found
+    #
+    # @api private
+    #
+    def yaml_config
+      config_file = self.config_file
+      YAML.load_file(config_file).freeze if config_file.file?
+    end
+
+    # Rubocop configuration
+    class Rubocop < self
+      FILE = 'rubocop.yml'.freeze
+    end
+
+    # Reek configuration
+    class Reek < self
+      FILE = 'reek.yml'.freeze
+    end
+
+    # Flay configuration
+    class Flay < self
+      FILE             = 'flay.yml'.freeze
+      DEFAULT_LIB_DIRS = %w[lib].freeze
+
+      attribute :total_score
+      attribute :threshold
+      attribute :lib_dirs, DEFAULT_LIB_DIRS
+    end
+
+    # Yardstick configuration
+    class Yardstick < self
+      FILE    = 'yardstick.yml'.freeze
+      OPTIONS = %w[
+        threshold
+        rules
+        verbose
+        path
+        require_exact_threshold
+      ].freeze
+
+      # Options hash that Yardstick understands
+      #
+      # @return [Hash]
+      #
+      # @api private
+      def options
+        OPTIONS.each_with_object({}) do |name, hash|
+          hash[name] = raw.fetch(name, nil)
+        end
+      end
+    end
+
+    # Flog configuration
+    class Flog < self
+      FILE                      = 'flog.yml'.freeze
+      DEFAULT_LIB_DIRS          = %w[lib].freeze
+
+      attribute :total_score
+      attribute :threshold
+      attribute :lib_dirs,          DEFAULT_LIB_DIRS
+    end
+
+    # Mutant configuration
+    class Mutant < self
+      FILE             = 'mutant.yml'.freeze
+      DEFAULT_NAME     = ''.freeze
+      DEFAULT_STRATEGY = 'rspec'.freeze
+
+      attribute :name,            DEFAULT_NAME
+      attribute :strategy,        DEFAULT_STRATEGY
+      attribute :zombify,         false
+      attribute :since,           nil
+      attribute :ignore_subjects, []
+      attribute :expect_coverage, 1
+      attribute :namespace
+    end
+
+    # Devtools configuration
+    class Devtools < self
+      FILE = 'devtools.yml'.freeze
+      DEFAULT_UNIT_TEST_TIMEOUT = 0.1  # 100ms
+
+      attribute :unit_test_timeout, DEFAULT_UNIT_TEST_TIMEOUT
+    end
+  end
+end