devtools 0.1.0

data/lib/devtools/platform.rb

@@ -0,0 +1,118 @@
+# encoding: utf-8
+
+module Devtools
+
+  # Provides methods to determine the ruby platform
+  module Platform
+
+    DEFAULT_RVM_NAME = 'mri'.freeze
+
+    # Return Ruby engine string
+    #
+    # @return [String]
+    #
+    # @api private
+    def ruby_engine
+      @ruby_engine ||= (defined?(RUBY_ENGINE) && RUBY_ENGINE || 'ruby').freeze
+    end
+
+    # Return RVM name
+    #
+    # @return [String]
+    #
+    # @api private
+    def rvm_name
+      @rvm_name ||= begin
+        engine = ruby_engine
+        engine == 'ruby' ? DEFAULT_RVM_NAME : engine
+      end
+    end
+
+    # Return RVM string
+    #
+    # @return [String]
+    #
+    # @api private
+    def rvm
+      @rvm ||= "#{rvm_name}-#{RUBY_VERSION}".freeze
+    end
+
+    # Test for being executed under JRuby
+    #
+    # @return [true]
+    #   if running under JRuby
+    #
+    # @return [false]
+    #   otherwise
+    #
+    # @api private
+    def jruby?
+      ruby_engine == 'jruby'
+    end
+
+    # Test for being executed under rbx
+    #
+    # @return [true]
+    #   if running under rbx
+    #
+    # @return [false]
+    #   otherwise
+    #
+    # @api private
+    def rbx?
+      ruby_engine == 'rbx'
+    end
+
+    # Test for being executed under rubies with a JIT
+    #
+    # @return [true]
+    #   if running under JRuby or rbx
+    #
+    # @return [false]
+    #   otherwise
+    #
+    # @api private
+    def jit?
+      jruby? || rbx?
+    end
+
+    # Test for 1.8 mode
+    #
+    # @return [true]
+    #   if running under 1.8.x
+    #
+    # @return [false]
+    #   otherwise
+    #
+    # @api private
+    def ruby18?
+      RUBY_VERSION.start_with?('1.8.')
+    end
+
+    # Test for 1.9 mode
+    #
+    # @return [true]
+    #   if running under 1.9.x
+    #
+    # @return [false]
+    #   otherwise
+    #
+    # @api private
+    def ruby19?
+      RUBY_VERSION.start_with?('1.9.')
+    end
+
+    # Test for 2.0 mode
+    #
+    # @return [true]
+    #   if running under 2.0.x
+    #
+    # @return [false]
+    #   otherwise
+    #
+    # @api private
+    def ruby20?
+      RUBY_VERSION.start_with?('2.0.')
+    end
+  end # module Platform
+end # module Devtools

data/lib/devtools/project.rb

@@ -0,0 +1,157 @@
+# encoding: utf-8
+
+module Devtools
+
+  # The project devtools supports
+  class Project
+
+    # The reek configuration
+    #
+    # @return [Config::Reek]
+    #
+    # @api private
+    attr_reader :reek
+
+    # The rubocop configuration
+    #
+    # @return [Config::Rubocop]
+    #
+    # @api private
+    attr_reader :rubocop
+
+    # The flog configuration
+    #
+    # @return [Config::Flog]
+    #
+    # @api private
+    attr_reader :flog
+
+    # The yardstick configuration
+    #
+    # @return [Config::Yardstick]
+    #
+    # @api private
+    attr_reader :yardstick
+
+    # The flay configuration
+    #
+    # @return [Config::Flay]
+    #
+    # @api private
+    attr_reader :flay
+
+    # The mutant configuration
+    #
+    # @return [Config::Mutant]
+    #
+    # @api private
+    attr_reader :mutant
+
+    # The devtools configuration
+    #
+    # @return [Config::Devtools]
+    #
+    # @api private
+    attr_reader :devtools
+
+    # Return project root
+    #
+    # @return [Pathname]
+    #
+    # @api private
+    #
+    attr_reader :root
+
+    # The default config path
+    #
+    # @return [Pathname]
+    #
+    # @api private
+    attr_reader :default_config_path
+
+    # The lib directory
+    #
+    # @return [Pathname]
+    #
+    # @api private
+    attr_reader :lib_dir
+
+    # The Ruby file pattern
+    #
+    # @return [Pathname]
+    #
+    # @api private
+    attr_reader :file_pattern
+
+    # The spec root
+    #
+    # @return [Pathname]
+    #
+    # @api private
+    attr_reader :spec_root
+
+    # Return config directory
+    #
+    # @return [Pathname]
+    #
+    # @api private
+    attr_reader :config_dir
+
+    # The unit test timeout
+    #
+    # @return [Numeric]
+    #
+    # @api private
+    attr_reader :unit_test_timeout
+
+    # Initialize object
+    #
+    # @param [Pathname] root
+    #
+    # @return [undefined]
+    #
+    # @api private
+    #
+    def initialize(root)
+      @root = root
+
+      initialize_environment
+      initialize_configs
+
+      @unit_test_timeout = @devtools.unit_test_timeout
+    end
+
+  private
+
+    # Initialize environment
+    #
+    # @return [undefined]
+    #
+    # @api private
+    #
+    def initialize_environment
+      @default_config_path = @root.join(DEFAULT_CONFIG_DIR_NAME).freeze
+      @lib_dir             = @root.join(LIB_DIRECTORY_NAME).freeze
+      @spec_root           = @root.join(SPEC_DIRECTORY_NAME).freeze
+      @file_pattern        = @lib_dir.join(RB_FILE_PATTERN).freeze
+      @config_dir          = @default_config_path
+    end
+
+    # Initialize configs
+    #
+    # @return [undefined]
+    #
+    # @api private
+    #
+    def initialize_configs
+      @reek      = Config::Reek.new(self)
+      @rubocop   = Config::Rubocop.new(self)
+      @flog      = Config::Flog.new(self)
+      @yardstick = Config::Yardstick.new(self)
+      @flay      = Config::Flay.new(self)
+      @mutant    = Config::Mutant.new(self)
+      @devtools  = Config::Devtools.new(self)
+    end
+
+  end # class Project
+end # module Devtools

data/lib/devtools/project/initializer.rb

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

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

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+module Devtools
+  class Project
+    class Initializer
+
+      # Imports all devtools rake tasks into a project
+      class Rake
+
+        extend ::Rake::DSL
+
+        def self.call
+          FileList[RAKE_FILES_GLOB].each(&method(:import))
+        end
+
+      end # class Rake
+    end # class Initializer
+  end # class Project
+end # module Devtools

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

@@ -0,0 +1,105 @@
+# encoding: utf-8
+
+module Devtools
+  class Project
+    class Initializer
+
+      # Requires all shared specs in a project's spec_helper
+      # Also installs a configurable unit test timeout
+      class Rspec < self
+
+        def self.require_files(directory)
+          Devtools.require_files(directory, SHARED_SPEC_PATTERN)
+        end
+
+        # Initialize RSpec for +project+
+        #
+        # @param [Project] project
+        #   the project to initialize
+        #
+        # @return [Rspec]
+        #
+        # @api private
+        def self.call(project)
+          new(project).call
+        end
+
+        # The spec root
+        #
+        # @return [Pathname]
+        #
+        # @api private
+        attr_reader :spec_root
+        private :spec_root
+
+        # 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}
+        #
+        # @return [self]
+        #
+        # @api private
+        def call
+          require 'rspec'
+          require 'rspec/its'
+          require_shared_spec_files
+          enable_unit_test_timeout unless Devtools.jit?
+          self
+        end
+
+        private
+
+        # Timeout unit tests that take longer than 1/10th of a second
+        #
+        # @param [Numeric] timeout
+        #
+        # @return [undefined]
+        #
+        # @raise [Timeout::Error]
+        #   raised when the times are outside the timeout
+        #
+        # @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.timeout(timeout, &example)
+          end
+        end
+
+        def require_shared_spec_files
+          require_files(SHARED_SPEC_PATH)
+          require_files(spec_root)
+        end
+
+        def require_files(directory)
+          self.class.require_files(directory)
+        end
+
+      end # class Rspec
+    end # class Initializer
+  end # class Project
+end # module Devtools

data/lib/devtools/site.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+module Devtools
+
+  # Encapsulates a specific {Project} devtools is used for
+  class Site
+
+    attr_reader :root
+
+    attr_reader :project
+
+    def initialize(project)
+      @project = project
+      @root    = project.root
+    end
+
+    # Initialize project and load shared specs
+    #
+    # Expects to be called from $application_root/spec/spec_helper.rb
+    #
+    # @return [self]
+    #
+    # @api private
+    def init_spec_helper
+      Project::Initializer::Rspec.call(project)
+      self
+    end
+
+    # Initialize devtools using default config
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def init
+      Initializer.call(self)
+      puts 'Run bundle install to complete the devtools installation'
+      self
+    end
+
+  end # class Site
+end # module Devtools