devtools 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 764c83969a5e3165490c1032274ebae18ebe2b9d
-  data.tar.gz: 8f7d916f56ce1d5e2e265331583bde25dc276d6f
+  metadata.gz: df0052621c82ba8a5452d4c9352c76690a59c159
+  data.tar.gz: b83f7ff1af43a8344a6d88921b6230fd2ce0653a
 SHA512:
-  metadata.gz: ad8bba29c9c98632ea5502b1d22e89bc0c4d4a555e7f6f5a856021a33e0484f090b04306f3033e456cda7b133d057393e81905ea63b24a0149fef57efe4c1539
-  data.tar.gz: 0fff91e6b6ed417aaf43c3328119f00b861d361b2d503e4bd306b6bb9b192e938a82f921900f92fe79769ee61b743c90980d6860900c7667f92f9695f1095530
+  metadata.gz: 8a4eb1dd77b9aabf6db22f150c4efc9adc5a840d5efb1dee144a6c3359ea006fe7b67b6d3a912f894a49df05081656aa45b2c78b081cc0a00eca85d378ba0e9f
+  data.tar.gz: 72b3ce1b479c109364841d3798454ea2380fa6e14154c533498375338089f04ab9307fa39cbc94818e1d5fe498cdf19c09c7eeeb1ae2fc5e71b04bd51de5df57

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) -->
@@ -10,11 +10,11 @@ Used to centralize metric setup and development gem dependencies.
 
 ## Installation
 
-Add the git source to your Gemfile's development section, there is currently no gem release.
+Add the gem to your Gemfile's development section.
 
 ```ruby
 group :development, :test do
-  gem 'devtools', git: 'https://github.com/mbj/devtools.git'
+  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/config/rubocop.yml

@@ -115,3 +115,11 @@ LambdaCall:
 # Allow additional spaces
 ExtraSpacing:
   Enabled: false
+
+# All objects can still be mutated if their eigenclass is patched
+RedundantFreeze:
+  Enabled: false
+
+# Prefer using `fail` when raising and `raise` when reraising
+SignalException:
+  EnforcedStyle: semantic

data/devtools.gemspec

@@ -1,33 +1,35 @@
-# encoding: utf-8
-
 Gem::Specification.new do |gem|
   gem.name        = 'devtools'
-  gem.version     = '0.1.0'
+  gem.version     = '0.1.5'
   gem.authors     = [ 'Markus Schirp' ]
   gem.email       = [ 'mbj@schirp-dso.com' ]
-  gem.description = 'A metagem for ROM-style development'
+  gem.description = 'A metagem wrapping development tools'
   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.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.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'
+  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.7.0'
+  gem.add_runtime_dependency 'flog',         '~> 4.3.2'
+  gem.add_runtime_dependency 'reek',         '~> 3.10.2'
+  gem.add_runtime_dependency 'rubocop',      '~> 0.37.2'
+  gem.add_runtime_dependency 'simplecov',    '~> 0.10.0'
+  gem.add_runtime_dependency 'yardstick',    '~> 0.9.9'
+  gem.add_runtime_dependency 'mutant',       '~> 0.8.10'
+  gem.add_runtime_dependency 'mutant-rspec', '~> 0.8.8'
 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

data/lib/devtools/flay.rb

@@ -0,0 +1,94 @@
+module Devtools
+  module Flay
+    # Measure flay mass relative to size of duplicated sexps
+    class Scale
+      include Adamantium
+      include Anima.new(:minimum_mass, :files)
+      include Procto.call(:measure)
+
+      # Measure duplication mass
+      #
+      # @return [Array<Rational>]
+      #
+      # @api private
+      def measure
+        flay.masses.map do |hash, mass|
+          Rational(mass, flay.hashes.fetch(hash).size)
+        end
+      end
+
+      # Report flay output
+      #
+      # @return [undefined]
+      #
+      # @api private
+      def flay_report
+        flay.report
+      end
+
+    private
+
+      # Memoized flay instance
+      #
+      # @return [Flay]
+      #
+      # @api private
+      def flay
+        ::Flay.new(mass: minimum_mass).tap do |flay|
+          flay.process(*files)
+          flay.analyze
+        end
+      end
+      memoize :flay, freezer: :noop
+    end
+
+    # Expand include and exclude file settings for flay
+    class FileList
+      include Procto.call, Concord.new(:includes, :excludes)
+
+      # Expand includes and filter by excludes
+      #
+      # @return [Set<Pathname>]
+      #
+      # @api private
+      def call
+        include_set - exclude_set
+      end
+
+    private
+
+      # Set of excluded files
+      #
+      # @return [Set<Pathname>]
+      #
+      # @api private
+      def exclude_set
+        excludes.flat_map(&Pathname.method(:glob))
+      end
+
+      # Set of included files
+      #
+      # Expanded using flay's file expander which takes into
+      # account flay's plugin support
+      #
+      # @return [Set<Pathname>]
+      #
+      # @api private
+      def include_set
+        Set.new(flay_includes.map(&method(:Pathname)))
+      end
+
+      # Expand includes using flay
+      #
+      # Expanded using flay's file expander which takes into
+      # account flay's plugin support
+      #
+      # @return [Array<String>]
+      #
+      # @api private
+      def flay_includes
+        ::Flay.expand_dirs_to_files(includes)
+      end
+    end
+  end
+end

data/lib/devtools/project/initializer/rake.rb

@@ -1,16 +1,18 @@
-# encoding: utf-8
-
 module Devtools
   class Project
     class Initializer
-
       # Imports all devtools rake tasks into a project
-      class Rake
-
-        extend ::Rake::DSL
+      class Rake < self
+        include AbstractType
 
+        # Initialize rake tasks
+        #
+        # @return [undefined]
+        #
+        # @api rpivate
         def self.call
-          FileList[RAKE_FILES_GLOB].each(&method(:import))
+          FileList.glob(RAKE_FILES_GLOB).each(&::Rake.application.method(:add_import))
+          self
         end
 
       end # class Rake

data/lib/devtools/project/initializer/rspec.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Devtools
   class Project
     class Initializer
@@ -7,72 +5,33 @@ module Devtools
       # Requires all shared specs in a project's spec_helper
       # Also installs a configurable unit test timeout
       class Rspec < self
+        include Concord.new(:project)
 
-        def self.require_files(directory)
-          Devtools.require_files(directory, SHARED_SPEC_PATTERN)
-        end
-
-        # Initialize RSpec for +project+
+        # Call initializer for project
         #
         # @param [Project] project
-        #   the project to initialize
         #
-        # @return [Rspec]
+        # @return [self]
         #
         # @api private
         def self.call(project)
-          new(project).call
+          new(project).__send__(:call)
+          self
         end
 
-        # The spec root
-        #
-        # @return [Pathname]
-        #
-        # @api private
-        attr_reader :spec_root
-        private :spec_root
+      private
 
-        # The unit test timeout
-        #
-        # @return [Numeric]
-        #
-        # @api private
-        attr_reader :unit_test_timeout
-        private :unit_test_timeout
-
-        # Initialize a new instance
-        #
-        # @param [Project] project
-        #   the project to initialize
-        #
-        # @param [Numeric] unit_test_timeout
-        #   the maximum time a single unit test can take
-        #
-        # @return [undefined]
-        #
-        # @api private
-        def initialize(project)
-          super
-          @spec_root         = project.spec_root
-          @unit_test_timeout = project.unit_test_timeout
-        end
-
-        # Setup RSpec for {#project}
+        # Setup RSpec for project
         #
         # @return [self]
         #
         # @api private
         def call
-          require 'rspec'
-          require 'rspec/its'
           require_shared_spec_files
-          enable_unit_test_timeout unless Devtools.jit?
-          self
+          enable_unit_test_timeout
         end
 
-        private
-
-        # Timeout unit tests that take longer than 1/10th of a second
+        # Timeout unit tests that take longer than configured amount of time
         #
         # @param [Numeric] timeout
         #
@@ -84,19 +43,33 @@ module Devtools
         # @api private
         #
         def enable_unit_test_timeout
-          timeout = unit_test_timeout # support the closure
-          RSpec.configuration.around file_path: UNIT_TEST_PATH_REGEXP do |example|
+          timeout = project.devtools.unit_test_timeout
+          RSpec.configuration.around(file_path: UNIT_TEST_PATH_REGEXP) do |example|
             Timeout.timeout(timeout, &example)
           end
         end
 
+        # Trigger the require of shared spec files
+        #
+        # @return [undefined]
+        #
+        # @api private
+        #
         def require_shared_spec_files
           require_files(SHARED_SPEC_PATH)
-          require_files(spec_root)
+          require_files(project.spec_root)
         end
 
-        def require_files(directory)
-          self.class.require_files(directory)
+        # Require files with pattern
+        #
+        # @param [Pathname] dir
+        #   the directory containing the files to require
+        #
+        # @return [self]
+        #
+        # @api private
+        def require_files(dir)
+          Dir.glob(dir.join(SHARED_SPEC_PATTERN)).each(&Kernel.method(:require))
         end
 
       end # class Rspec

data/lib/devtools/project/initializer.rb

@@ -1,21 +1,11 @@
-# encoding: utf-8
-
 module Devtools
   class Project
 
     # Base class for project initializers
     class Initializer
+      include AbstractType
 
-      attr_reader :project
-      protected :project
-
-      def initialize(project)
-        @project = project
-      end
-
-      def call
-        fail NotImplementedError, "#{self.class}##{__method__} must be implemented"
-      end
+      abstract_singleton_method :call
     end # class Initializer
   end # class Project
 end # module Devtools