devtools 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1071f9d15d4b5aa58b37b2ce7673f52a1a93134
-  data.tar.gz: 9df7747e313808a6e834a2a13578a238e07df7c0
+  metadata.gz: 525d730bf63b2733ddbde070eaf7a58615ff40cf
+  data.tar.gz: 4706f0847e170be9bf2d7477cab78f4afa36f6f9
 SHA512:
-  metadata.gz: f9a7d6f2255c8f52c9cda553e550ee1c27f4fa2cf736cb824889b52585c97324782673b07f1bcffeef2c9481da788072dda1e575532a20a7adc88d3d682a0bbe
-  data.tar.gz: eb0519a453e0d758a6dd1ab12b6f831cff8fb17a22e7eeb9748836c5885c874a1975d0fb9f6b33b0b05b686c7c0fe0808dc7a6bd618c9e4129e6ffa68c20df99
+  metadata.gz: cb7b59eaee5985348cbbc3902eafb956148d8fefdb2b43e102880a610766060521bfb655e58ce057becf08b3d0cf778cc0862f6077f125fe44820b36e0bbd530
+  data.tar.gz: 2492e98c9a00afc8b57916ad42fc4b2645836a46d9e3863025f4f0cbe4009082bbb653e482414c74134a9858c070fe43ff7a2a5211c42ffded0ac0a6f271917f

data/.rspec

@@ -3,3 +3,4 @@
 --profile
 --warnings
 --order random
+--require spec_helper

data/Gemfile

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -1,6 +1,6 @@
 # devtools
 
-[![Build Status](https://secure.travis-ci.org/mbj/devtools.png?branch=master)](http://travis-ci.org/mbj/devtools)
+[![Build Status](https://img.shields.io/circleci/project/mbj/devtools.svg)](https://circleci.com/gh/mbj/devtools/tree/master)
 [![Dependency Status](https://gemnasium.com/mbj/devtools.png)](https://gemnasium.com/mbj/devtools)
 [![Code Climate](https://codeclimate.com/github/datamapper/devtools.png)](https://codeclimate.com/github/datamapper/devtools)
 <!-- [![Code Climate](https://codeclimate.com/github/mbj/devtools.png)](https://codeclimate.com/github/mbj/devtools) -->
@@ -14,7 +14,7 @@ Add the gem to your Gemfile's development section.
 
 ```ruby
 group :development, :test do
-  gem 'devtools', '~> 0.1.1'
+  gem 'devtools', '~> 0.1.x'
 end
 ```
 

data/circle.yml

@@ -1,7 +1,7 @@
 ---
 machine:
   ruby:
-    version: '2.2'
+    version: '2.2.3'
 test:
   override:
     - bundle exec rake ci

data/config/devtools.yml

@@ -0,0 +1,2 @@
+---
+unit_test_timeout: 0.2

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
-threshold: 16
-total_score: 97
+threshold: 8
+total_score: 112

data/config/flog.yml

@@ -1,2 +1,2 @@
 ---
-threshold: 11.1
+threshold: 19.7

data/config/mutant.yml

@@ -1,2 +1,4 @@
 name: devtools
 namespace: Devtools
+ignore_subjects:
+- "Devtools::Flay::Scale#flay"

data/config/reek.yml

@@ -23,15 +23,14 @@ DuplicateMethodCall:
   allow_calls: []
 FeatureEnvy:
   enabled: true
-  exclude:
-  - Devtools::Site::Initializer#init_gemfile
-  - Devtools::Site::Initializer#init_rakefile
+  exclude: []
 IrresponsibleModule:
   enabled: true
   exclude: []
 LongParameterList:
   enabled: true
-  exclude: []
+  exclude:
+  - Devtools::Config#self.attribute
   max_params: 2
   overrides: {}
 LongYieldList:
@@ -52,17 +51,15 @@ RepeatedConditional:
   max_ifs: 1
 TooManyInstanceVariables:
   enabled: true
-  exclude:
-  - Devtools::Project
-  max_instance_variables: 14 # no adamantium ;)
+  exclude: []
+  max_instance_variables: 2
 TooManyMethods:
   enabled: true
   exclude: []
   max_methods: 15
 TooManyStatements:
   enabled: true
-  exclude:
-  - Devtools::Project#initialize  # needs refactoring, it is way too large
+  exclude: []
   max_statements: 5
 UncommunicativeMethodName:
   enabled: true
@@ -101,7 +98,5 @@ UnusedParameters:
 UtilityFunction:
   enabled: true
   exclude:
-  - Devtools::Platform#ruby18?
-  - Devtools::Platform#ruby19?
-  - Devtools::Platform#ruby20?
+  - Devtools::Project::Initializer::Rspec#require_files # intentional for deduplication
   max_helper_calls: 0

data/devtools.gemspec

@@ -1,8 +1,6 @@
-# encoding: utf-8
-
 Gem::Specification.new do |gem|
   gem.name        = 'devtools'
-  gem.version     = '0.1.2'
+  gem.version     = '0.1.3'
   gem.authors     = [ 'Markus Schirp' ]
   gem.email       = [ 'mbj@schirp-dso.com' ]
   gem.description = 'A metagem for ROM-style development'
@@ -12,22 +10,26 @@ Gem::Specification.new do |gem|
 
   gem.require_paths         = %w[lib]
   gem.files                 = `git ls-files`.split($/)
-  gem.executables           = %w[devtools]
+  gem.executables           = %w[]
   gem.test_files            = `git ls-files -- spec`.split($/)
-  gem.extra_rdoc_files      = %w[README.md TODO]
+  gem.extra_rdoc_files      = %w[README.md]
   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.5.0'
-  gem.add_dependency 'rubocop',      '~> 0.34.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'
+  gem.add_runtime_dependency 'procto',       '~> 0.0.x'
+  gem.add_runtime_dependency 'anima',        '~> 0.3.x'
+  gem.add_runtime_dependency 'concord',      '~> 0.1.x'
+  gem.add_runtime_dependency 'adamantium',   '~> 0.2.x'
+  gem.add_runtime_dependency 'rspec',        '~> 3.4.0'
+  gem.add_runtime_dependency 'rspec-core',   '~> 3.4.0'
+  gem.add_runtime_dependency 'rspec-its',    '~> 1.2.0'
+  gem.add_runtime_dependency 'rake',         '~> 10.4.2'
+  gem.add_runtime_dependency 'yard',         '~> 0.8.7.6'
+  gem.add_runtime_dependency 'flay',         '~> 2.6.1'
+  gem.add_runtime_dependency 'flog',         '~> 4.3.2'
+  gem.add_runtime_dependency 'reek',         '~> 3.7.0'
+  gem.add_runtime_dependency 'rubocop',      '~> 0.35.1'
+  gem.add_runtime_dependency 'simplecov',    '~> 0.10.0'
+  gem.add_runtime_dependency 'yardstick',    '~> 0.9.9'
+  gem.add_runtime_dependency 'mutant',       '~> 0.8.9'
+  gem.add_runtime_dependency 'mutant-rspec', '~> 0.8.8'
 end

data/lib/devtools.rb

@@ -1,24 +1,24 @@
-# encoding: utf-8
-
+# Stdlib infrastructure
 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'
+# Non stdlib infrastructure
+require 'procto'
+require 'anima'
+require 'concord'
+require 'adamantium'
 
-# Provides access to metric tools
-module Devtools
+# Wrapped tools
+require 'flay'
+require 'rspec'
+require 'rspec/its'
+require 'simplecov'
 
-  extend Platform
+# Main devtools namespace population
+module Devtools
 
   ROOT                    = Pathname.new(__FILE__).parent.parent.freeze
   PROJECT_ROOT            = Pathname.pwd.freeze
@@ -28,17 +28,12 @@ module Devtools
   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))
+  private_constant(*constants(false))
 
   # React to metric violation
   #
@@ -63,26 +58,13 @@ module Devtools
     self
   end
 
-  # Initialize project and load shared specs
-  #
-  # Expects to be called from $application_root/spec/spec_helper.rb
+  # Return devtools root path
   #
-  # @return [self]
+  # @return [Pathname]
   #
-  # @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
+  # @api private
+  def self.root
+    ROOT
   end
 
   # Return project
@@ -91,53 +73,22 @@ module Devtools
   #
   # @api private
   def self.project
-    SITE.project
+    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
+end # module Devtools
 
-  # Detect travis ci
-  #
-  # @return [Boolean]
-  #
-  # @api private
-  #
-  def self.travis?
-    ENV.key?('TRAVIS')
-  end
+# Devtools implementation
+require 'devtools/config'
+require 'devtools/project'
+require 'devtools/project/initializer'
+require 'devtools/project/initializer/rake'
+require 'devtools/project/initializer/rspec'
+require 'devtools/flay'
+require 'devtools/rake/flay'
 
-end # module Devtools
+# Devtools self initialization
+module Devtools
+  # The project devtools is active for
+  PROJECT = Project.new(PROJECT_ROOT)
+end

data/lib/devtools/config.rb

@@ -1,48 +1,65 @@
-# encoding: utf-8
-
 module Devtools
 
   # Abstract base class of tool configuration
   class Config
+    include Adamantium::Flat, AbstractType, Concord.new(:config_dir)
+
     # Represent no configuration
     DEFAULT_CONFIG = {}.freeze
 
+    # Simple named type check representation
+    class TypeCheck
+      # Type check against expected class
+      include Concord.new(:name, :allowed_classes)
+
+      ERROR_FORMAT = '%<name>s: Got instance of %<got>s expected %<allowed>s'.freeze
+      CLASS_DELIM  = ','.freeze
+
+      # Check value for instance of expected class
+      #
+      # @param [Object] value
+      #
+      # @return [Object]
+      def call(value)
+        klass = value.class
+
+        unless allowed_classes.any?(&klass.method(:equal?))
+          fail TypeError, ERROR_FORMAT % {
+            name:    name,
+            got:     klass,
+            allowed: allowed_classes.join(CLASS_DELIM)
+          }
+        end
+
+        value
+      end
+    end # TypeCheck
+
+    private_constant(*constants(false))
+
+    # Error raised on type errors
+    TypeError = Class.new(RuntimeError)
+
     # Declare an attribute
     #
     # @param [Symbol] name
-    #
-    # @yieldreturn [Object]
-    #   the default value to use
+    # @param [Array<Class>] classes
     #
     # @api private
     #
     # @return [self]
     #
-    def self.attribute(name, *default)
+    def self.attribute(name, classes, **options)
+      default    = [options.fetch(:default)] if options.key?(:default)
+      type_check = TypeCheck.new(name, classes)
+      key        = name.to_s
+
       define_method(name) do
-        raw.fetch(name.to_s, *default)
+        type_check.call(raw.fetch(key, *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]
@@ -50,8 +67,9 @@ module Devtools
     # @api private
     #
     def config_file
-      @config_file ||= project.config_dir.join(self.class::FILE).freeze
+      config_dir.join(self.class::FILE)
     end
+    memoize :config_file
 
   private
 
@@ -62,8 +80,9 @@ module Devtools
     # @api private
     #
     def raw
-      @raw ||= yaml_config || DEFAULT_CONFIG
+      yaml_config || DEFAULT_CONFIG
     end
+    memoize :raw
 
     # Return the raw config data from a yaml file
     #
@@ -75,29 +94,30 @@ module Devtools
     # @api private
     #
     def yaml_config
-      config_file = self.config_file
-      YAML.load_file(config_file).freeze if config_file.file?
+      IceNine.deep_freeze(YAML.load_file(config_file)) if config_file.file?
     end
 
     # Rubocop configuration
     class Rubocop < self
       FILE = 'rubocop.yml'.freeze
-    end
+    end # Rubocop
 
     # Reek configuration
     class Reek < self
       FILE = 'reek.yml'.freeze
-    end
+    end # Reek
 
     # Flay configuration
     class Flay < self
       FILE             = 'flay.yml'.freeze
       DEFAULT_LIB_DIRS = %w[lib].freeze
+      DEFAULT_EXCLUDES = %w[].freeze
 
-      attribute :total_score
-      attribute :threshold
-      attribute :lib_dirs, DEFAULT_LIB_DIRS
-    end
+      attribute :total_score, [Fixnum]
+      attribute :threshold,   [Fixnum]
+      attribute :lib_dirs,    [Array], default: DEFAULT_LIB_DIRS
+      attribute :excludes,    [Array], default: DEFAULT_EXCLUDES
+    end # Flay
 
     # Yardstick configuration
     class Yardstick < self
@@ -120,39 +140,40 @@ module Devtools
           hash[name] = raw.fetch(name, nil)
         end
       end
-    end
+    end # Yardstick
 
     # Flog configuration
     class Flog < self
-      FILE                      = 'flog.yml'.freeze
-      DEFAULT_LIB_DIRS          = %w[lib].freeze
+      FILE             = 'flog.yml'.freeze
+      DEFAULT_LIB_DIRS = %w[lib].freeze
 
-      attribute :total_score
-      attribute :threshold
-      attribute :lib_dirs,          DEFAULT_LIB_DIRS
-    end
+      attribute :total_score, [Float]
+      attribute :threshold,   [Float]
+      attribute :lib_dirs,    [Array], default: DEFAULT_LIB_DIRS
+    end # Flog
 
     # Mutant configuration
     class Mutant < self
       FILE             = 'mutant.yml'.freeze
       DEFAULT_NAME     = ''.freeze
       DEFAULT_STRATEGY = 'rspec'.freeze
+      DEFAULT_COVERAGE = '1/1'.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
+      attribute :name,            [String],                default: DEFAULT_NAME
+      attribute :strategy,        [String],                default: DEFAULT_STRATEGY
+      attribute :zombify,         [TrueClass, FalseClass], default: false
+      attribute :since,           [String, NilClass],      default: nil
+      attribute :ignore_subjects, [Array],                 default: []
+      attribute :expect_coverage, [String],                default: DEFAULT_COVERAGE
+      attribute :namespace,       [String]
+    end # Mutant
 
     # Devtools configuration
     class Devtools < self
-      FILE = 'devtools.yml'.freeze
+      FILE                      = 'devtools.yml'.freeze
       DEFAULT_UNIT_TEST_TIMEOUT = 0.1  # 100ms
 
-      attribute :unit_test_timeout, DEFAULT_UNIT_TEST_TIMEOUT
-    end
-  end
-end
+      attribute :unit_test_timeout, [Float], default: DEFAULT_UNIT_TEST_TIMEOUT
+    end # Devtools
+  end # Config
+end # Devtools