code_manifest 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: be523e36c254ee8749c037a2e1c9fa57dd10d2e86d83b49aed3349f56da72bdb
+  data.tar.gz: 6741764dfc73fc92fa87f9c5acfbba1fae8650c617a5aa15efabafec25bb8dd0
+SHA512:
+  metadata.gz: fc9bd31b43bdc5637de024cb0063f88519c09a3120025f452a5733fff4dfca6d1f4f9c5067866fea82395c846e3a2027388cfe7a74d77f50c13665fde43d6303
+  data.tar.gz: e802a2695b4409eb40fac80e9a79a0f88b1fcac45a4549c4be1a496540b4769d99ebbed2389ccb7deeca4bc5a002b1a8515eedd82930c2881ab6e391dc638bbf

data/README.md

@@ -0,0 +1,42 @@
+# CodeManifest
+
+Simple manifest to fetch file by globs and generate digest.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add code_manifest
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install code_manifest
+
+## Usage
+
+Put a `.code_manifest.yml` config file under your project root, for example:
+
+```yml
+ruby:
+  - app/**/*.rb
+js:
+  - frontend/**/*.js
+```
+
+Then use it with:
+
+```ruby
+require 'code_manifest'
+
+# Returns a `Set` with filepaths
+CodeManifest['ruby'].files
+CodeManifest['js'].files
+
+# Returns a digest based on all files specified under same namespace
+CodeManifest['ruby'].digest
+CodeManifest['js'].digest
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/code_manifest.

data/lib/code_manifest/manifest.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'set'
+require 'digest/md5'
+require_relative 'rule'
+
+module CodeManifest
+  class Manifest
+    attr_reader :root
+
+    def initialize(root, patterns)
+      @root = root
+      @patterns = patterns.map(&:to_s)
+    end
+
+    def files
+      @files ||= (inclusion_rules.map(&:files).reduce(Set.new, :merge) - exclusion_rules.map(&:files).reduce(Set.new, :merge)).sort.to_set
+    end
+
+    def digest
+      @digest ||= begin
+        digests = files.map { |file| Digest::MD5.file(root.join(file)).hexdigest }
+        Digest::MD5.hexdigest(digests.join)
+      end
+    end
+
+    private
+
+    def rules
+      @rules ||= @patterns.each_with_object([]) do |pattern, rules|
+        pattern = pattern.strip
+        unless pattern.match?(/\A(#|\z)/)
+          rules << Rule.new(root, pattern)
+        end
+      end
+    end
+
+    def inclusion_rules
+      @inclusion_rules ||= rules.reject(&:exclude)
+    end
+
+    def exclusion_rules
+      @exclusion_rules ||= rules.select(&:exclude)
+    end
+  end
+end

data/lib/code_manifest/rule.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module CodeManifest
+  class Rule
+    GLOB_OPTIONS = File::FNM_PATHNAME | File::FNM_DOTMATCH | File::FNM_EXTGLOB
+
+    attr_reader :exclude
+    attr_reader :glob
+
+    def initialize(root, pattern)
+      @root = root
+      @exclude = false
+      @glob = @root
+
+      if pattern[0] == '!'
+        @exclude = true
+        pattern = pattern[1..-1]
+      end
+
+      if pattern.start_with?('/')
+        pattern = pattern[1..-1]
+      else
+        @glob = @glob.join('**')
+      end
+
+      @glob = @glob.join(pattern).to_s
+    end
+
+    def files
+      @files ||= begin
+        matched = Dir.glob(glob, GLOB_OPTIONS)
+        matched.map! { |file| Pathname.new(file) }
+        matched.reject!(&:directory?)
+        matched.map! { |file| file.relative_path_from(@root.expand_path).to_s }
+        Set.new(matched.sort!)
+      end
+    end
+
+    def match?(file)
+      file = Pathname.new(file)
+      file = @root.join(file) unless file.absolute?
+
+      File.fnmatch?(glob, file.to_s, GLOB_OPTIONS)
+    end
+  end
+end

data/lib/code_manifest/version.rb

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

data/lib/code_manifest.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require_relative "code_manifest/version"
+require_relative "code_manifest/manifest"
+
+module CodeManifest
+  class Error < StandardError; end
+
+  DOTFILE = '.code_manifest.yml'.freeze
+  KEY_PATTERN = /[a-z_0-9]+/.freeze
+
+  class << self
+    def [](name)
+      manifests[name.to_s]
+    end
+
+    private
+
+    def manifests
+      @manifests ||= begin
+        config_file = traverse_files(DOTFILE, Dir.pwd)
+
+        raise "#{DOTFILE} was not found in your project directory, please check README for instructions." unless config_file
+
+        root = Pathname.new(config_file).dirname
+
+        YAML.load_file(config_file).each_with_object({}) do |(name, patterns), collection|
+          next unless name.match?(KEY_PATTERN)
+
+          if collection.key?(name)
+            raise ArgumentError, "#{name} defined multiple times in #{DOTFILE}"
+          end
+
+          collection[name] = Manifest.new(root, patterns)
+        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?
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: code_manifest
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gusto Engineers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A code manifest
+email:
+- dev@gusto.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/code_manifest.rb
+- lib/code_manifest/manifest.rb
+- lib/code_manifest/rule.rb
+- lib/code_manifest/version.rb
+homepage: https://github.com/rubyatscale/code_manifest
+licenses: []
+metadata:
+  homepage_uri: https://github.com/rubyatscale/code_manifest
+  source_code_uri: https://github.com/rubyatscale/code_manifest
+  changelog_uri: https://github.com/rubyatscale/code_manifest/blob/main/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: A code manifest
+test_files: []