inch 0.3.1 → 0.3.2.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65ac531a061df93776377170f9aabc79c4773c50
-  data.tar.gz: eddc74ab9d1125cdb78d6880c1211650d906c7c1
+  metadata.gz: f173292eed0fa894560c5a2d899349d3e62bb55c
+  data.tar.gz: 2d52a21c83eccb32e43803d5b16f849700108037
 SHA512:
-  metadata.gz: ebfaa638825acfc574fe1fab5e981ce72d0a19a179d5f5d80e3eeadf7abc4fb8a0b81b7521e8247d140c41bf344b5347a53ba2e1a7a76a69bb123b7a5669f00e
-  data.tar.gz: b6a6112f4657649d9a03c78d93fe26d785b3962ed50f732bc006640abfe138aa2818ba6517a7e806d94bea0ea060b016c6909f3ff564fde9a7c1f3b87fe1f58e
+  metadata.gz: 3c98ae65f4e3e3cd4c2daea064da62c6580e5c4fa8b4b6fab4b5dff86dc2049a1f488e6a3d03fdb2ca5118041b5c2c76970ce7b366d44316b57d5fc5bb8872b2
+  data.tar.gz: b56177359ca54a305518c5cf367465a3c771afffad6ffb5f1e12c5e2ceb1c1b8972dc50097ad02bc41f2a92128b12525716d1b17e8192a211aff30d5cbd10a10

data/Rakefile

@@ -6,4 +6,12 @@ Rake::TestTask.new do |t|
   t.pattern = "test/**/*_test.rb"
 end
 
+Rake::TestTask.new(:"test:unit") do |t|
+  t.pattern = "test/unit/**/*_test.rb"
+end
+
+Rake::TestTask.new(:"test:integration") do |t|
+  t.pattern = "test/integration/**/*_test.rb"
+end
+
 task :default => :test

data/config/defaults.rb

@@ -1,6 +1,11 @@
 Inch::Config.run do
   # development!
 
+  codebase do
+    include_files ["lib/**/*.rb", "app/**/*.rb"]
+    exclude_files []
+  end
+
   evaluation do
     grade(:A) do
       scores    80..100

data/config/example.yml

@@ -0,0 +1,6 @@
+files:
+  included:
+    - lib/**/*.rb
+    - app/**/*.rb
+  excluded:
+    - lib/vendor/**/*.rb

data/lib/inch/cli/command/base_list.rb

@@ -21,7 +21,8 @@ module Inch
           @options.parse(args)
           @options.verify
 
-          @codebase = ::Inch::Codebase.parse(Dir.pwd, @options.paths, @options.excluded)
+          config = Config::Codebase.new(@options.paths, @options.excluded)
+          @codebase = ::Inch::Codebase.parse(Dir.pwd, config)
         end
       end
     end

data/lib/inch/code_object/provider.rb

@@ -21,8 +21,8 @@ module Inch
     #
     #
     module Provider
-      def self.parse(dir, paths, excluded, type = :YARD)
-        provider_for(type).parse(dir, paths, excluded)
+      def self.parse(dir, config = Inch::Config.codebase, type = :YARD)
+        provider_for(type).parse(dir, config)
       end
 
       # @return [Module]

data/lib/inch/code_object/provider/yard.rb

@@ -4,8 +4,8 @@ module Inch
       # Parses the source tree (using YARD)
       module YARD
 
-        def self.parse(dir, paths, excluded)
-          Parser.parse(dir, paths, excluded)
+        def self.parse(dir, config = Inch::Config.codebase)
+          Parser.parse(dir, config)
         end
 
       end
@@ -21,4 +21,4 @@ log.level = ::Logger::UNKNOWN # basically disable YARD's logging
 require_relative 'yard/parser'
 require_relative 'yard/docstring'
 require_relative 'yard/nodoc_helper'
-require_relative 'yard/object'
+require_relative 'yard/object'

data/lib/inch/code_object/provider/yard/parser.rb

@@ -4,9 +4,6 @@ module Inch
       module YARD
         # Parses the source tree (using YARD)
         class Parser
-          DEFAULT_PATHS     = ["app/**/*.rb", "lib/**/*.rb"]
-          DEFAULT_EXCLUDED  = []
-
           IGNORE_TYPES      = [:macro]
 
           # Helper method to parse an instance with the given +args+
@@ -19,14 +16,18 @@ module Inch
             parser
           end
 
-          def parse(dir, paths, excluded)
+          # @param dir [String] directory
+          # @param config [Inch::Config::Codebase] configuration for codebase
+          # @return [void]
+          def parse(dir, config)
             old_dir = Dir.pwd
             Dir.chdir dir
-            parse_yard_objects(paths, excluded)
+            parse_yard_objects(config.included_files, config.excluded_files)
             inject_base_dir(dir)
             Dir.chdir old_dir
           end
 
+          # @return [Array<YARD::Object::Base>]
           def objects
             @objects ||= parsed_objects.map do |o|
               YARD::Object.for(o) unless IGNORE_TYPES.include?(o.type)
@@ -37,7 +38,7 @@ module Inch
 
           def parse_yard_objects(paths, excluded)
             ::YARD::Registry.clear
-            ::YARD.parse(paths || DEFAULT_PATHS, excluded || DEFAULT_EXCLUDED)
+            ::YARD.parse(paths, excluded)
           end
 
           def inject_base_dir(dir)

data/lib/inch/codebase.rb

@@ -5,11 +5,12 @@ module Inch
     # Parses a codebase
     #
     # @param dir [String]
-    # @param paths [Array<String>]
-    # @param excluded [Array<String>]
+    # @param config [Inch::Config::Codebase,nil]
     # @return [Codebase::Proxy]
-    def self.parse(dir, paths = nil, excluded = nil)
-      Proxy.new(dir, paths, excluded)
+    def self.parse(dir, config = nil)
+      config ||= Config.codebase.clone
+      config.update_via_yaml(dir)
+      Proxy.parse(dir, config)
     end
   end
 end

data/lib/inch/codebase/proxy.rb

@@ -3,9 +3,7 @@ module Inch
     class Proxy
       attr_reader :objects
 
-      def initialize(dir = Dir.pwd, paths = nil, excluded = nil)
-        @base_dir = dir
-        provider = CodeObject::Provider.parse(dir, paths, excluded)
+      def initialize(provider)
         @objects = Codebase::Objects.new(provider.objects)
       end
 
@@ -17,6 +15,11 @@ module Inch
         end
         lists
       end
+
+      def self.parse(dir = Dir.pwd, config = Inch::Config.codebase)
+        provider = CodeObject::Provider.parse(dir, config)
+        new(provider)
+      end
     end
   end
-end
+end

data/lib/inch/config.rb

@@ -6,48 +6,19 @@ module Inch
     class << self
       attr_accessor :instance
 
+      def codebase
+        self.instance ||= Config::Base.new
+        instance.codebase
+      end
+
       def run(&block)
-        self.instance ||= new
+        self.instance ||= Config::Base.new
         instance.update(&block)
         instance
       end
     end
-
-    def update(&block)
-      instance_eval(&block)
-    end
-
-    def development?
-      @development
-    end
-
-    def development!
-      @development = true
-    end
-
-    def evaluation(&block)
-      @evaluation ||= Evaluation.new
-      @evaluation.update(&block) if block
-      @evaluation
-    end
-
-    class Evaluation
-      def update(&block)
-        instance_eval(&block)
-      end
-
-      def grade(symbol, &block)
-        ::Inch::Evaluation::Grade.grade(symbol, &block)
-      end
-
-      def priority(symbol, &block)
-        ::Inch::Evaluation::PriorityRange.priority_range(symbol, &block)
-      end
-
-      def schema(constant_name, &block)
-        constant = ::Inch::Evaluation::Proxy.const_get(constant_name)
-        constant.criteria(&block)
-      end
-    end
   end
 end
+
+require_relative 'config/base'
+require_relative 'config/codebase'

data/lib/inch/config/base.rb

@@ -0,0 +1,52 @@
+module Inch
+  # Stores the configuration for Inch
+  #
+  # @see config/defaults.rb
+  class Config
+    class Base
+
+      def update(&block)
+        instance_eval(&block)
+      end
+
+      def development?
+        @development
+      end
+
+      def development!
+        @development = true
+      end
+
+      def codebase(&block)
+        @codebase ||= Config::Codebase.new
+        @codebase.update(&block) if block
+        @codebase
+      end
+
+      def evaluation(&block)
+        @evaluation ||= Evaluation.new
+        @evaluation.update(&block) if block
+        @evaluation
+      end
+
+      class Evaluation
+        def update(&block)
+          instance_eval(&block)
+        end
+
+        def grade(symbol, &block)
+          ::Inch::Evaluation::Grade.grade(symbol, &block)
+        end
+
+        def priority(symbol, &block)
+          ::Inch::Evaluation::PriorityRange.priority_range(symbol, &block)
+        end
+
+        def schema(constant_name, &block)
+          constant = ::Inch::Evaluation::Proxy.const_get(constant_name)
+          constant.criteria(&block)
+        end
+      end
+    end
+  end
+end

data/lib/inch/config/codebase.rb

@@ -0,0 +1,66 @@
+module Inch
+  class Config
+    # Stores the configuration for an individual single codebase
+    class Codebase
+      attr_reader :included_files
+      attr_reader :excluded_files
+
+      YAML_FILE = ".inch.yml"
+
+      def initialize(included = nil, excluded = nil)
+        @included_files = included || []
+        @excluded_files = excluded || []
+      end
+
+      # Returns the contents of +dir+/.inch.yml, if present.
+      # Returns nil otherwise.
+      #
+      # @param dir [String]
+      # @return [Hash,nil]
+      def self.yaml(dir)
+        yaml_file = File.join(dir, YAML_FILE)
+        YAML.load(File.read(yaml_file)) if File.exist?(yaml_file)
+      end
+
+      def update(&block)
+        instance_eval(&block)
+      end
+
+      def update_via_yaml(dir)
+        if yaml = self.class.yaml(dir)
+          old_dir = Dir.pwd
+          Dir.chdir dir
+          update_files yaml["files"]
+          Dir.chdir old_dir
+        end
+      end
+
+      def include_files(*files)
+        @included_files.concat(files).flatten!
+      end
+
+      def exclude_files(*files)
+        @excluded_files.concat(files).flatten!
+      end
+
+      private
+
+      def expand_files(files)
+        files.map do |f|
+          case f
+          when String
+            f =~ /[\*\{]/ ? Dir[f] : f
+          else
+            f
+          end
+        end.flatten
+      end
+
+      def update_files(files)
+        return if files.nil?
+        include_files expand_files(files["included"])
+        exclude_files expand_files(files["excluded"])
+      end
+    end
+  end
+end

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = "0.3.1"
+  VERSION = "0.3.2.rc1"
 end

data/test/fixtures/inch-yml/.inch.yml

@@ -0,0 +1,7 @@
+files:
+  included:
+    - foo/**/*.rb
+  excluded:
+    - foo/vendor/**/*.rb
+    # or
+    - !ruby/regexp /vendor/

data/test/fixtures/inch-yml/foo/bar.rb

@@ -0,0 +1,6 @@
+class Foo
+  class Bar
+    def initialize
+    end
+  end
+end

data/test/fixtures/inch-yml/foo/vendor/base.rb

@@ -0,0 +1,6 @@
+module Vendor
+  class Base
+    def initialize
+    end
+  end
+end

data/test/test_helper.rb

@@ -10,3 +10,25 @@ require 'inch'
 def fixture_path(name)
   File.join(File.dirname(__FILE__), "fixtures", name.to_s)
 end
+
+module Inch
+  module Test
+    class << self
+      attr_accessor :object_providers
+
+      def codebase(name)
+        Inch::Codebase::Proxy.new object_provider(name)
+      end
+
+      def object_provider(name)
+        self.object_providers ||= {}
+        self.object_providers[name] ||= ::Inch::CodeObject::Provider.parse(fixture_path(name))
+      end
+    end
+  end
+end
+
+def test_codebase(name)
+  codebase = Inch::Test.codebase(name)
+  codebase
+end

data/test/{inch → unit}/api/filter_test.rb

@@ -2,8 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
 describe ::Inch::API::Filter do
   before do
-    @dir = fixture_path(:simple)
-    @codebase = ::Inch::Codebase.parse(@dir)
+    @codebase = test_codebase(:simple)
   end
 
   it "should work" do

data/test/{inch → unit}/api/get_test.rb

@@ -2,8 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
 describe ::Inch::API::Get do
   before do
-    @dir = fixture_path(:simple)
-    @codebase = ::Inch::Codebase.parse(@dir)
+    @codebase = test_codebase(:simple)
   end
 
   it "should work" do

data/test/{inch → unit}/api/list_test.rb

@@ -2,8 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
 describe ::Inch::API::List do
   before do
-    @dir = fixture_path(:simple)
-    @codebase = ::Inch::Codebase.parse(@dir)
+    @codebase = test_codebase(:simple)
   end
 
   it "should work" do

data/test/{inch → unit}/api/stats_test.rb

@@ -2,8 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
 describe ::Inch::API::Stats do
   before do
-    @dir = fixture_path(:simple)
-    @codebase = ::Inch::Codebase.parse(@dir)
+    @codebase = test_codebase(:simple)
   end
 
   it "should work" do

data/test/{inch → unit}/api/suggest_test.rb

@@ -2,8 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
 describe ::Inch::API::Suggest do
   before do
-    @dir = fixture_path(:simple)
-    @codebase = ::Inch::Codebase.parse(@dir)
+    @codebase = test_codebase(:simple)
   end
 
   it "should work" do

data/test/{inch → unit}/code_object/provider/yard/nodoc_helper_test.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../../../test_helper')
 
 describe ::Inch::CodeObject::Provider::YARD::NodocHelper do
   before do
-    @provider = ::Inch::CodeObject::Provider::YARD.parse(fixture_path(:simple), ["lib/**/*.rb"], [])
+    @provider = ::Inch::CodeObject::Provider::YARD.parse(fixture_path(:simple))
     @objects = @provider.objects
   end
 

data/test/{inch → unit}/code_object/provider/yard_test.rb

@@ -4,7 +4,7 @@ describe ::Inch::CodeObject::Provider::YARD do
   let(:described_class) { ::Inch::CodeObject::Provider::YARD }
 
   it "should parse" do
-    provider = described_class.parse(fixture_path(:simple), ["lib/**/*.rb"], [])
+    provider = described_class.parse(fixture_path(:simple))
     assert !provider.objects.empty?
   end
 

data/test/{inch → unit}/code_object/provider_test.rb

@@ -3,7 +3,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 describe ::Inch::CodeObject::Provider do
   it "should parse all objects" do
     Dir.chdir File.dirname(__FILE__)
-    @provider = ::Inch::CodeObject::Provider.parse(fixture_path(:simple), ["lib/**/*.rb"], [])
+    @provider = ::Inch::CodeObject::Provider.parse(fixture_path(:simple))
     refute @provider.objects.empty?
   end
 end

data/test/{inch → unit}/code_object/proxy/method_object_test.rb

@@ -2,24 +2,24 @@ require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
 
 describe ::Inch::CodeObject::Proxy::MethodObject do
   before do
-    Dir.chdir fixture_path(:simple)
-    @codebase = Inch::Codebase.parse(fixture_path(:simple), ["lib/**/*.rb"])
+    @codebase = test_codebase(:simple)
+    @objects = @codebase.objects
   end
 
   def test_transitive_tags_dont_matter
-    m = @codebase.objects.find("InchTest::Deprecated::ClassMethods")
+    m = @objects.find("InchTest::Deprecated::ClassMethods")
     assert_equal 0, m.score
     assert m.undocumented?
   end
 
   def test_raising_method_with_comment
-    m = @codebase.objects.find("InchTest#raising_method_with_comment")
+    m = @objects.find("InchTest#raising_method_with_comment")
     assert m.score > 0
     refute m.undocumented?
   end
 
   def test_raising_method
-    m = @codebase.objects.find("InchTest#raising_method")
+    m = @objects.find("InchTest#raising_method")
     assert_equal 0, m.score
     assert m.undocumented?
   end
@@ -27,7 +27,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   def test_tagged_as_private
     %w( InchTest#method_with_private_tag
         InchTest#private_method_with_tomdoc).each do |fullname|
-      m = @codebase.objects.find(fullname)
+      m = @objects.find(fullname)
       assert m.tagged_as_private?
     end
   end
@@ -35,13 +35,13 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   def test_tagged_as_internal_api
     %w( InchTest#private_api_with_yard
         InchTest#internal_api_with_tomdoc).each do |fullname|
-      m = @codebase.objects.find(fullname)
+      m = @objects.find(fullname)
       assert m.tagged_as_internal_api?
     end
   end
 
   def test_method_without_doc
-    m = @codebase.objects.find("Foo::Bar#method_without_doc")
+    m = @objects.find("Foo::Bar#method_without_doc")
     refute m.has_doc?
     refute m.has_parameters?
     refute m.return_mentioned?
@@ -51,7 +51,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_method_with_missing_param_doc
-    m = @codebase.objects.find("Foo::Bar#method_with_missing_param_doc")
+    m = @objects.find("Foo::Bar#method_with_missing_param_doc")
     assert m.has_doc?
     assert m.has_parameters?
     assert m.return_mentioned?
@@ -68,7 +68,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_method_with_wrong_doc
-    m = @codebase.objects.find("Foo::Bar#method_with_wrong_doc")
+    m = @objects.find("Foo::Bar#method_with_wrong_doc")
     assert m.has_doc?
     assert m.has_parameters?
     assert m.return_mentioned?
@@ -91,7 +91,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_method_with_full_doc
-    m = @codebase.objects.find("Foo::Bar#method_with_full_doc")
+    m = @objects.find("Foo::Bar#method_with_full_doc")
     assert m.has_doc?
     assert m.has_parameters?
     assert m.return_mentioned?
@@ -108,7 +108,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_method_without_params_or_return_type
-    m = @codebase.objects.find("Foo::Bar#method_without_params_or_return_type")
+    m = @objects.find("Foo::Bar#method_without_params_or_return_type")
     assert m.has_doc?
     refute m.has_parameters?
     refute m.return_mentioned?
@@ -117,7 +117,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_method_without_docstring
-    m = @codebase.objects.find("Foo::Bar#method_without_docstring")
+    m = @objects.find("Foo::Bar#method_without_docstring")
     refute m.has_doc?
     assert m.has_parameters?
     assert m.return_mentioned?
@@ -126,7 +126,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_method_without_params_or_docstring
-    m = @codebase.objects.find("Foo::Bar#method_without_params_or_docstring")
+    m = @objects.find("Foo::Bar#method_without_params_or_docstring")
     refute m.has_doc?
     refute m.has_parameters?
     assert m.return_mentioned?
@@ -135,7 +135,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_method_with_rdoc_doc
-    m = @codebase.objects.find("Foo::Bar#method_with_rdoc_doc")
+    m = @objects.find("Foo::Bar#method_with_rdoc_doc")
     assert m.has_doc?
     assert m.has_parameters?
     p = m.parameter(:param1)
@@ -146,7 +146,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_method_with_other_rdoc_doc
-    m = @codebase.objects.find("Foo::Bar#method_with_other_rdoc_doc")
+    m = @objects.find("Foo::Bar#method_with_other_rdoc_doc")
     assert m.has_doc?
     assert m.has_parameters?
     p = m.parameter(:param1)
@@ -161,7 +161,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_method_with_unstructured_doc
-    m = @codebase.objects.find("Foo::Bar#method_with_unstructured_doc")
+    m = @objects.find("Foo::Bar#method_with_unstructured_doc")
     assert m.has_doc?
     assert m.has_parameters?
     p = m.parameter(:param1)
@@ -172,7 +172,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_method_with_unstructured_doc_missing_params
-    m = @codebase.objects.find("Foo::Bar#method_with_unstructured_doc_missing_params")
+    m = @objects.find("Foo::Bar#method_with_unstructured_doc_missing_params")
     assert m.has_doc?
     assert m.has_parameters?
     p = m.parameter(:format)
@@ -183,7 +183,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_question_mark_method
-    m = @codebase.objects.find("InchTest#question_mark_method?")
+    m = @objects.find("InchTest#question_mark_method?")
     refute m.has_doc?
     refute m.has_parameters?
 
@@ -191,7 +191,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_question_mark_method_with_description
-    m = @codebase.objects.find("InchTest#question_mark_method_with_description?")
+    m = @objects.find("InchTest#question_mark_method_with_description?")
     refute m.has_doc?
     refute m.has_parameters?
 
@@ -200,7 +200,7 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_method_with_description_and_parameters
-    m = @codebase.objects.find("InchTest#method_with_description_and_parameters?")
+    m = @objects.find("InchTest#method_with_description_and_parameters?")
     refute m.has_doc?
     assert m.has_parameters?
 
@@ -208,59 +208,59 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
   end
 
   def test_depth
-    m = @codebase.objects.find("#root_method")
+    m = @objects.find("#root_method")
     assert_equal 1, m.depth
-    m = @codebase.objects.find("InchTest#getter")
+    m = @objects.find("InchTest#getter")
     assert_equal 2, m.depth
-    m = @codebase.objects.find("Foo::Bar#method_without_doc")
+    m = @objects.find("Foo::Bar#method_without_doc")
     assert_equal 3, m.depth
   end
 
   def test_getter
-    m = @codebase.objects.find("InchTest#getter")
+    m = @objects.find("InchTest#getter")
     assert m.getter?, "should be a getter"
     refute m.setter?
   end
 
   def test_setter
-    m = @codebase.objects.find("InchTest#attr_setter=")
+    m = @objects.find("InchTest#attr_setter=")
     refute m.getter?
     assert m.setter?, "should be a setter"
   end
 
   def test_setter2
-    m = @codebase.objects.find("InchTest#manual_setter=")
+    m = @objects.find("InchTest#manual_setter=")
     refute m.getter?
     assert m.setter?, "should be a setter"
   end
 
   def test_manual_getset
-    m = @codebase.objects.find("InchTest#manual_getset")
+    m = @objects.find("InchTest#manual_getset")
     assert m.getter?, "should be a getter"
     refute m.setter?
   end
 
   def test_manual_getset2
-    m = @codebase.objects.find("InchTest#manual_getset=")
+    m = @objects.find("InchTest#manual_getset=")
     refute m.getter?
     assert m.setter?, "should be a setter"
   end
 
   def test_attr_getset
-    m = @codebase.objects.find("InchTest#attr_getset")
+    m = @objects.find("InchTest#attr_getset")
     assert m.getter?, "should be a getter"
     refute m.setter?
   end
 
   def test_attr_getset2
-    m = @codebase.objects.find("InchTest#attr_getset=")
+    m = @objects.find("InchTest#attr_getset=")
     refute m.getter?
     assert m.setter?, "should be a setter"
   end
 
   def test_splat_parameter_notation
-    m1 = @codebase.objects.find("Foo#method_with_splat_parameter")
-    m2 = @codebase.objects.find("Foo#method_with_splat_parameter2")
+    m1 = @objects.find("Foo#method_with_splat_parameter")
+    m2 = @objects.find("Foo#method_with_splat_parameter2")
     assert_equal m1.score, m2.score
   end
 end

data/test/{inch → unit}/code_object/proxy_test.rb

@@ -2,48 +2,48 @@ require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
 describe ::Inch::CodeObject::Proxy::Base do
   before do
-    dir = fixture_path(:code_examples)
-    @codebase = Inch::Codebase.parse(dir, ["lib/**/*.rb"])
+    @codebase = test_codebase(:code_examples)
+    @objects = @codebase.objects
   end
 
   def test_inspect_gives_original_name
-    m = @codebase.objects.find("Foo::Bar#method_with_code_example")
+    m = @objects.find("Foo::Bar#method_with_code_example")
     assert_match /Foo::Bar#method_with_code_example/, m.inspect
   end
 
   def test_grade_is_not_nil
-    m = @codebase.objects.find("Foo::Bar#method_with_code_example")
+    m = @objects.find("Foo::Bar#method_with_code_example")
     assert m.grade
   end
 
   def test_method_with_code_example
-    m = @codebase.objects.find("Foo::Bar#method_with_code_example")
+    m = @objects.find("Foo::Bar#method_with_code_example")
     assert m.has_code_example?
   end
 
   def test_method_with_code_example2
-    m = @codebase.objects.find("Foo::Bar#method_with_code_example2")
+    m = @objects.find("Foo::Bar#method_with_code_example2")
     assert m.has_code_example?
   end
 
   def test_method_with_code_examples
-    m = @codebase.objects.find("Foo::Bar#method_with_one_example")
+    m = @objects.find("Foo::Bar#method_with_one_example")
     assert m.has_code_example?
     refute m.has_multiple_code_examples?
   end
 
   def test_method_with_code_examples
-    m = @codebase.objects.find("Foo::Bar#method_with_examples")
+    m = @objects.find("Foo::Bar#method_with_examples")
     assert m.has_multiple_code_examples?
   end
 
   def test_method_with_code_examples
-    m = @codebase.objects.find("Foo::Bar#method_with_tagged_example")
+    m = @objects.find("Foo::Bar#method_with_tagged_example")
     assert m.has_multiple_code_examples?
   end
 
   def test_method_with_code_examples
-    m = @codebase.objects.find("Foo::Bar#method_with_2tagged_examples")
+    m = @objects.find("Foo::Bar#method_with_2tagged_examples")
     assert m.has_multiple_code_examples?
   end
 end

data/test/{inch → unit}/codebase/objects_test.rb

@@ -2,9 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
 describe ::Inch::Codebase::Objects do
   before do
-    dir = fixture_path(:simple)
-    paths = ["lib/**/*.rb"]
-    @codebase = Inch::Codebase::Proxy.new dir, paths
+    @codebase = test_codebase(:simple)
     @objects = @codebase.objects
   end
 

data/test/{inch → unit}/codebase/proxy_test.rb

@@ -3,15 +3,15 @@ require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 describe ::Inch::Codebase::Proxy do
   it "should parse all objects" do
     dir = fixture_path(:simple)
-    paths = ["lib/**/*.rb"]
-    @codebase = Inch::Codebase::Proxy.new dir, paths
+    config = Inch::Config::Codebase.new(["lib/**/*.rb"])
+    @codebase = Inch::Codebase::Proxy.parse dir, config
     refute_nil @codebase.objects
   end
 
-  it "should parse all objects" do
+  it "should parse given paths" do
     dir = fixture_path(:simple)
-    paths = ["app/**/*.rb"]
-    @codebase = Inch::Codebase::Proxy.new dir, paths
+    config = Inch::Config::Codebase.new(["app/**/*.rb"])
+    @codebase = Inch::Codebase::Proxy.parse dir, config
     assert @codebase.objects.empty?
   end
 end

data/test/unit/config/codebase_test.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+describe ::Inch::Config::Codebase do
+  it "should parse .inch.yml" do
+    dir = fixture_path(:simple)
+    config = Inch::Config::Codebase.new
+    config.update_via_yaml(dir)
+    assert config.included_files.empty?
+    assert config.excluded_files.empty?
+  end
+
+  it "should parse .inch.yml" do
+    dir = fixture_path(:"inch-yml")
+    config = Inch::Config::Codebase.new
+    config.update_via_yaml(dir)
+    refute config.included_files.empty?
+    refute config.excluded_files.empty?
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2.rc1
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-28 00:00:00.000000000 Z
+date: 2014-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,6 +128,7 @@ files:
 - TODOS.md
 - bin/inch
 - config/defaults.rb
+- config/example.yml
 - inch.gemspec
 - lib/inch.rb
 - lib/inch/api.rb
@@ -194,6 +195,8 @@ files:
 - lib/inch/codebase/objects_filter.rb
 - lib/inch/codebase/proxy.rb
 - lib/inch/config.rb
+- lib/inch/config/base.rb
+- lib/inch/config/codebase.rb
 - lib/inch/core_ext.rb
 - lib/inch/core_ext/string.rb
 - lib/inch/evaluation.rb
@@ -223,6 +226,9 @@ files:
 - lib/inch/utils/weighted_list.rb
 - lib/inch/version.rb
 - test/fixtures/code_examples/lib/foo.rb
+- test/fixtures/inch-yml/.inch.yml
+- test/fixtures/inch-yml/foo/bar.rb
+- test/fixtures/inch-yml/foo/vendor/base.rb
 - test/fixtures/parameters/lib/foo.rb
 - test/fixtures/readme/lib/foo.rb
 - test/fixtures/really_good/lib/foo.rb
@@ -236,40 +242,41 @@ files:
 - test/fixtures/visibility/lib/foo.rb
 - test/fixtures/yardopts/.yardopts
 - test/fixtures/yardopts/foo/bar.rb
-- test/inch/api/filter_test.rb
-- test/inch/api/get_test.rb
-- test/inch/api/list_test.rb
-- test/inch/api/options/base_test.rb
-- test/inch/api/stats_test.rb
-- test/inch/api/suggest_test.rb
-- test/inch/cli/arguments_test.rb
-- test/inch/cli/command/base_test.rb
-- test/inch/cli/command/list_test.rb
-- test/inch/cli/command/options/base_list_test.rb
-- test/inch/cli/command/options/base_object_test.rb
-- test/inch/cli/command/options/base_test.rb
-- test/inch/cli/command/show_test.rb
-- test/inch/cli/command/stats_test.rb
-- test/inch/cli/command/suggest_test.rb
-- test/inch/cli/command_parser_test.rb
-- test/inch/cli/trace_helper_test.rb
-- test/inch/cli/yardopts_helper_test.rb
-- test/inch/code_object/converter_test.rb
-- test/inch/code_object/provider/yard/docstring_test.rb
-- test/inch/code_object/provider/yard/nodoc_helper_test.rb
-- test/inch/code_object/provider/yard_test.rb
-- test/inch/code_object/provider_test.rb
-- test/inch/code_object/proxy/method_object_test.rb
-- test/inch/code_object/proxy_test.rb
-- test/inch/codebase/objects_test.rb
-- test/inch/codebase/proxy_test.rb
-- test/inch/evaluation/role/base_test.rb
-- test/inch/utils/ui_test.rb
-- test/inch/utils/weighted_list_test.rb
+- test/integration/cli/command/list_test.rb
+- test/integration/cli/command/show_test.rb
+- test/integration/cli/command/stats_test.rb
+- test/integration/cli/command/suggest_test.rb
 - test/integration/stats_options_test.rb
 - test/integration/visibility_options_test.rb
 - test/shared/base_list.rb
 - test/test_helper.rb
+- test/unit/api/filter_test.rb
+- test/unit/api/get_test.rb
+- test/unit/api/list_test.rb
+- test/unit/api/options/base_test.rb
+- test/unit/api/stats_test.rb
+- test/unit/api/suggest_test.rb
+- test/unit/cli/arguments_test.rb
+- test/unit/cli/command/base_test.rb
+- test/unit/cli/command/options/base_list_test.rb
+- test/unit/cli/command/options/base_object_test.rb
+- test/unit/cli/command/options/base_test.rb
+- test/unit/cli/command_parser_test.rb
+- test/unit/cli/trace_helper_test.rb
+- test/unit/cli/yardopts_helper_test.rb
+- test/unit/code_object/converter_test.rb
+- test/unit/code_object/provider/yard/docstring_test.rb
+- test/unit/code_object/provider/yard/nodoc_helper_test.rb
+- test/unit/code_object/provider/yard_test.rb
+- test/unit/code_object/provider_test.rb
+- test/unit/code_object/proxy/method_object_test.rb
+- test/unit/code_object/proxy_test.rb
+- test/unit/codebase/objects_test.rb
+- test/unit/codebase/proxy_test.rb
+- test/unit/config/codebase_test.rb
+- test/unit/evaluation/role/base_test.rb
+- test/unit/utils/ui_test.rb
+- test/unit/utils/weighted_list_test.rb
 homepage: http://trivelop.de/inch/
 licenses:
 - MIT
@@ -285,17 +292,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Documentation measurement tool for Ruby
 test_files:
 - test/fixtures/code_examples/lib/foo.rb
+- test/fixtures/inch-yml/.inch.yml
+- test/fixtures/inch-yml/foo/bar.rb
+- test/fixtures/inch-yml/foo/vendor/base.rb
 - test/fixtures/parameters/lib/foo.rb
 - test/fixtures/readme/lib/foo.rb
 - test/fixtures/really_good/lib/foo.rb
@@ -309,38 +319,39 @@ test_files:
 - test/fixtures/visibility/lib/foo.rb
 - test/fixtures/yardopts/.yardopts
 - test/fixtures/yardopts/foo/bar.rb
-- test/inch/api/filter_test.rb
-- test/inch/api/get_test.rb
-- test/inch/api/list_test.rb
-- test/inch/api/options/base_test.rb
-- test/inch/api/stats_test.rb
-- test/inch/api/suggest_test.rb
-- test/inch/cli/arguments_test.rb
-- test/inch/cli/command/base_test.rb
-- test/inch/cli/command/list_test.rb
-- test/inch/cli/command/options/base_list_test.rb
-- test/inch/cli/command/options/base_object_test.rb
-- test/inch/cli/command/options/base_test.rb
-- test/inch/cli/command/show_test.rb
-- test/inch/cli/command/stats_test.rb
-- test/inch/cli/command/suggest_test.rb
-- test/inch/cli/command_parser_test.rb
-- test/inch/cli/trace_helper_test.rb
-- test/inch/cli/yardopts_helper_test.rb
-- test/inch/code_object/converter_test.rb
-- test/inch/code_object/provider/yard/docstring_test.rb
-- test/inch/code_object/provider/yard/nodoc_helper_test.rb
-- test/inch/code_object/provider/yard_test.rb
-- test/inch/code_object/provider_test.rb
-- test/inch/code_object/proxy/method_object_test.rb
-- test/inch/code_object/proxy_test.rb
-- test/inch/codebase/objects_test.rb
-- test/inch/codebase/proxy_test.rb
-- test/inch/evaluation/role/base_test.rb
-- test/inch/utils/ui_test.rb
-- test/inch/utils/weighted_list_test.rb
+- test/integration/cli/command/list_test.rb
+- test/integration/cli/command/show_test.rb
+- test/integration/cli/command/stats_test.rb
+- test/integration/cli/command/suggest_test.rb
 - test/integration/stats_options_test.rb
 - test/integration/visibility_options_test.rb
 - test/shared/base_list.rb
 - test/test_helper.rb
+- test/unit/api/filter_test.rb
+- test/unit/api/get_test.rb
+- test/unit/api/list_test.rb
+- test/unit/api/options/base_test.rb
+- test/unit/api/stats_test.rb
+- test/unit/api/suggest_test.rb
+- test/unit/cli/arguments_test.rb
+- test/unit/cli/command/base_test.rb
+- test/unit/cli/command/options/base_list_test.rb
+- test/unit/cli/command/options/base_object_test.rb
+- test/unit/cli/command/options/base_test.rb
+- test/unit/cli/command_parser_test.rb
+- test/unit/cli/trace_helper_test.rb
+- test/unit/cli/yardopts_helper_test.rb
+- test/unit/code_object/converter_test.rb
+- test/unit/code_object/provider/yard/docstring_test.rb
+- test/unit/code_object/provider/yard/nodoc_helper_test.rb
+- test/unit/code_object/provider/yard_test.rb
+- test/unit/code_object/provider_test.rb
+- test/unit/code_object/proxy/method_object_test.rb
+- test/unit/code_object/proxy_test.rb
+- test/unit/codebase/objects_test.rb
+- test/unit/codebase/proxy_test.rb
+- test/unit/config/codebase_test.rb
+- test/unit/evaluation/role/base_test.rb
+- test/unit/utils/ui_test.rb
+- test/unit/utils/weighted_list_test.rb
 has_rdoc: