Refactor api and release 1.2.0

Author: ngan

.code_manifest_test.yml

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    code_manifest (1.1.1)
+    code_manifest (1.2.0)
 
 GEM
   remote: https://rubygems.org/

Gemfile.lock

@@ -8,48 +8,47 @@
 module CodeManifest
   class Error < StandardError; end
 
-  DOTFILE = '.code_manifest.yml'
+  MANIFEST_FILE = '.code_manifest.yml'
   KEY_PATTERN = /[a-z_0-9]+/.freeze
 
   class << self
     def [](name)
       manifests[name.to_s]
     end
 
+    def root(start_path: Dir.pwd, reset: false)
+      @root = nil if reset
+      @root ||= find_root(start_path)
+    end
+
     private
 
     def manifests
       @manifests ||= begin
-        manifest_file = traverse_files(DOTFILE, Dir.pwd)
-
-        unless manifest_file
-          raise "#{DOTFILE} was not found in your project directory, please check README for instructions."
-        end
-
-        root = Pathname.new(manifest_file).dirname
+        manifest_file = root.join(MANIFEST_FILE)
 
         load_manifest(manifest_file).each_with_object({}) do |(name, patterns), collection|
           next unless name.match?(KEY_PATTERN)
 
-          raise ArgumentError, "#{name} defined multiple times in #{DOTFILE}" if collection.key?(name)
+          raise ArgumentError, "#{name} defined multiple times in #{MANIFEST_FILE}" if collection.key?(name)
 
-          collection[name] = Manifest.new(root, patterns.flatten)
+          collection[name] = Manifest.new(patterns.flatten)
         end
       end
     end
 
-    def traverse_files(filename, start_dir)
-      Pathname.new(start_dir).expand_path.ascend do |dir|
-        file = dir.join(filename)
-        return file.to_s if file.exist?
+    def find_root(path)
+      Pathname.new(path).expand_path.ascend do |dir|
+        return dir if dir.join(MANIFEST_FILE).exist?
       end
+
+      raise "#{MANIFEST_FILE} was not found in your project directory, please check README for instructions."
     end
 
     # https://stackoverflow.com/a/71192990
     def load_manifest(file)
       YAML.load_file(file, aliases: true)
     rescue ArgumentError
-      puts YAML.load_file(file)
       YAML.load_file(file)
     end
   end

lib/code_manifest.rb

@@ -7,12 +7,11 @@ module CodeManifest
   class Manifest
     GLOB_OPTIONS = File::FNM_PATHNAME | File::FNM_DOTMATCH | File::FNM_EXTGLOB
 
-    attr_reader :root, :rules
+    attr_reader :rules
 
-    def initialize(root, patterns)
-      @root = root
+    def initialize(patterns)
       @rules ||= patterns.map do |pattern|
-        Rule.new(root, pattern)
+        Rule.new(CodeManifest.root, pattern)
       end
     end
 
@@ -22,16 +21,20 @@ def files
 
     def digest
       @digest ||= begin
-        digests = files.map { |file| Digest::MD5.file(root.join(file)).hexdigest }
+        digests = files.map { |file| Digest::MD5.file(CodeManifest.root.join(file)).hexdigest }
         Digest::MD5.hexdigest(digests.join).freeze
       end
     end
 
     def matches(paths)
-      result_paths = paths.select { |path| inclusion_rules.any? { |rule| rule.match?(path) } }
-      result_paths.reject! { |path| exclusion_files.any? { |rule| rule.match?(path) } }
+      result_paths = paths.select do |path|
+        inclusion_rules.any? { |rule| rule.match?(path) }
+      end
+      result_paths.reject! do |path|
+        exclusion_files.any? { |rule| rule.match?(path) }
+      end
 
-      result_paths
+      result_paths.sort!
     end
 
     private
@@ -56,7 +59,8 @@ def files_with_relative_path(files)
       files.map do |file|
         pathname = Pathname.new(file)
         next if pathname.directory?
-        pathname.relative_path_from(root.expand_path).to_s
+
+        pathname.relative_path_from(CodeManifest.root).to_s
       end.compact
     end
   end

lib/code_manifest/manifest.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CodeManifest
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

lib/code_manifest/version.rb

@@ -0,0 +1,7 @@
+foo: &foo
+  - "/foo/**/*"
+bar:
+  - "/foo/bar.txt"
+no_bar:
+  - "*foo"
+  - "!spec/fixtures/foo/bar*"

spec/fixtures/project/.code_manifest.yml

@@ -4,38 +4,31 @@
 require 'fileutils'
 
 RSpec.describe CodeManifest::Manifest do
-  let(:root) { Pathname.new('tmp/manifest_spec').expand_path }
+  let(:root) { CodeManifest.root }
 
   describe '#files' do
-    let(:patterns) { ['/foo', 'bar/*', '!bar/exclude'] }
-    let(:manifest) { described_class.new(root.expand_path, patterns) }
+    let(:patterns) { ['/foo/foo.md', 'bar/*', '!bar/exclude'] }
+    let(:manifest) { described_class.new(patterns) }
 
     around do |example|
-      root.mkpath
-      FileUtils.touch(root.join('foo'))
       root.join('bar').mkpath
       FileUtils.touch(root.join('bar/include'))
       FileUtils.touch(root.join('bar/exclude'))
       example.run
-      root.rmtree
     end
 
     it 'returns only included files' do
-      expect(manifest.files).to match_array(['bar/include', 'foo'])
+      expect(manifest.files).to match_array(['bar/include', 'foo/foo.md'])
     end
 
     context 'with different type of globs' do
       let(:patterns) { ['dir_bar/**/*'] }
-      let(:manifest) { described_class.new(root.expand_path, patterns) }
+      let(:manifest) { described_class.new(patterns) }
 
       around do |example|
-        Dir.mktmpdir do |tmp_dir|
-          Dir.chdir(tmp_dir) do
-            FileUtils.mkdir(root.join('dir_bar'))
-            FileUtils.touch(root.join('dir_bar/foo'))
-            example.run
-          end
-        end
+        FileUtils.mkdir(root.join('dir_bar'))
+        FileUtils.touch(root.join('dir_bar/foo'))
+        example.run
       end
 
       it 'excludes directories' do
@@ -63,7 +56,7 @@
 
           expected = [
             'dir_bar/.bar',
-            'dir_bar/foo',
+            'dir_bar/foo'
           ]
 
           expect(manifest.files).to match_array(expected)
@@ -80,7 +73,7 @@
 
           expected = [
             'foo.x',
-            'foo.y',
+            'foo.y'
           ]
 
           expect(manifest.files).to match_array(expected)
@@ -91,7 +84,7 @@
 
   describe '#digest' do
     let(:patterns) { ['/foo', 'bar/*', '!bar/exclude'] }
-    let(:manifest) { described_class.new(root.expand_path, patterns) }
+    let(:manifest) { described_class.new(patterns) }
 
     around do |example|
       root.mkpath
@@ -104,13 +97,13 @@
     end
 
     it 'returns only included files' do
-      expect(manifest.digest).to eq('020eb29b524d7ba672d9d48bc72db455')
+      expect(manifest.digest).to eq('74be16979710d4c4e7c6647856088456')
     end
   end
 
   describe '#matches' do
     let(:patterns) { ['/foo', 'bar/*', '!bar/exclude'] }
-    let(:manifest) { described_class.new(root.expand_path, patterns) }
+    let(:manifest) { described_class.new(patterns) }
     let(:paths) do
       [
         'bar/exclude',
@@ -135,9 +128,9 @@
 
     it 'returns matched paths' do
       expect(manifest.matches(paths)).to match_array([
-        'bar/iniclude',
-        'foo',
-      ])
+                                                       'bar/iniclude',
+                                                       'foo'
+                                                     ])
     end
   end
 end