rake-file-content 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c45b6a172da6ba79adcdaec29c3cdbb36699232f1909ba50c39b40aadd0252a
+  data.tar.gz: 07d124fff743d8efda802d268ab415f6f84c014cb8de276dedefdcb4fc372748
+SHA512:
+  metadata.gz: 108dad1e1e320678815267ffed95e05176b5afdb753159e80b4e2b6de76fc69191e7f423a45f0d11eafe2000752f658759beb72c1d02cc7a4cc81c0f199d0808
+  data.tar.gz: 67143b41f0fbe436122fc7f0268fb1d78658f45b0a6967e80c6ec2b7105549fb82dbbf4f4bcc697b594ba09826370fd34993908dd693928531112726945ebb20

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+https://twitter.com/mattie.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    rake-file-content (0.1.0)
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    minitest (5.15.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.3.0)
+    rexml (3.2.5)
+    rubocop (1.27.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rake-file-content!
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.22

data/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2022, Matt Massicotte
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,41 @@
+# rake-file-content
+
+By default, rake's `file` tasks determine dependencies and requirements by file modification date. This gem makes it possible to compute requirements by file contents. It's a little slower in the best case, but avoids many correctness pitfalls that a date-only implementation suffers from.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rake-file-content'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rake-file-content
+
+## Usage
+
+You can simply replace the `file` Rake DSL method with `file_content`. It behaves the same, but will output a a `.content_hash` file with the same name next to the output. This file will be used to determine if the task is needed in the future. It will be triggered if the hashes change.
+
+A potential gotcha with standard rake `file` is when you remove dependencies. At this point, your file might not be rebuilt, but since `file` has no memory between rake invocations, it will not be invoked. A `file_content` task will.
+
+Internally, `file_content` will work with any rake task that responds to `content_hash`. This gem adds this to `file` tasks, and the [rake-remote-file](https://github.com/mattmassicotte/rake-remote-file) does it too, just in case that's of interest.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mattmassicotte/rake-file-content. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rake-file-content/blob/main/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the rake-file-content project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rake-file-content/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rake/file/content"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rake-file-content/content_hash.rb

@@ -0,0 +1,11 @@
+require 'digest/md5'
+
+module Rake
+  class FileTask
+    def content_hash
+      Digest::MD5.hexdigest(File.read(name))
+    rescue
+      nil
+    end
+  end
+end

data/lib/rake-file-content/dependency_list.rb

@@ -0,0 +1,41 @@
+module RakeContentFile
+  class DependencyList
+    attr_accessor :list
+
+    def initialize
+      @list = []
+    end
+
+    def ==(other)
+      sorted_list == other.sorted_list
+    end
+
+    def sorted_list
+      list.sort_by(&:first)
+    end
+    
+    def add(name, hash)
+      list << [name, hash]
+    end
+
+    def serialize
+      data = ""
+
+      sorted_list.each do |dep_name, hash|
+        data << "#{dep_name}: #{hash}\n"
+      end
+
+      data
+    end
+
+    def self.deserialize(data)
+      deps = self.new
+
+      data.lines do |line|
+        deps.list << line.chomp.split(": ")
+      end
+      
+      deps
+    end
+  end
+end

data/lib/rake-file-content/dsl.rb

@@ -0,0 +1,14 @@
+require 'rake'
+
+module RakeFileContent
+  module DSL
+    include Rake::DSL
+
+    def file_content(*args, &block)
+      RakeContentFile::Task.define_task(*args, &block)
+    end
+
+  end
+end
+
+extend RakeFileContent::DSL

data/lib/rake-file-content/task.rb

@@ -0,0 +1,67 @@
+require_relative "dependency_list"
+
+module RakeContentFile
+  class Task < Rake::FileTask
+    attr_accessor :source_file
+    
+    def initialize(task_name, app)
+      super(task_name, app)
+    end
+    
+    def needed?
+      dependent_contents_changed?
+    end
+
+    def execute(args=nil)
+      super
+
+      File.open(cache_file, "w") do |f|
+        f << dep_list.serialize
+      end
+    end
+
+    def dependent_contents_changed?
+      return true if cached_dep_list.nil?
+
+      dep_list != cached_dep_list
+    end
+
+    def cache_file
+      name + ".content_hash"
+    end
+
+    private
+    def dep_list
+      @dep_list ||= make_dep_list
+    end
+
+    def cached_dep_list
+      @cached_dep_list ||= read_cached_dep_list
+    end
+
+    def read_cached_dep_list
+      return nil unless File.exist?(cache_file)
+
+      data = File.open(cache_file).read
+
+      DependencyList.deserialize(data)
+    end
+    
+    def make_dep_list
+      list = DependencyList.new
+
+      dependent_content_tasks.each do |task|
+        list.add(task.name, task.content_hash)
+      end
+
+      list
+    end
+    
+    def dependent_content_tasks
+      all_prerequisite_tasks.filter do |prereq|
+        prereq_task = application[prereq, @scope]
+        prereq_task.respond_to?(:content_hash)
+      end
+    end
+  end
+end

data/lib/rake-file-content/version.rb

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

data/lib/rake-file-content.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'rake-file-content/version'
+require 'rake-file-content/dsl'
+require 'rake-file-content/task'
+require 'rake-file-content/content_hash'

data/rake-file-content.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/rake-file-content/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rake-file-content"
+  spec.version       = RakeFileContent::VERSION
+  spec.authors       = ["Matthew Massicotte"]
+
+  spec.summary       = "Rake DSL extensions for managing file dependencies by content"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/mattmassicotte/rake-file-content"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rake"
+
+  spec.add_development_dependency "minitest"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: rake-file-content
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthew Massicotte
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rake DSL extensions for managing file dependencies by content
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rake-file-content.rb
+- lib/rake-file-content/content_hash.rb
+- lib/rake-file-content/dependency_list.rb
+- lib/rake-file-content/dsl.rb
+- lib/rake-file-content/task.rb
+- lib/rake-file-content/version.rb
+- rake-file-content.gemspec
+homepage: https://github.com/mattmassicotte/rake-file-content
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/mattmassicotte/rake-file-content
+  source_code_uri: https://github.com/mattmassicotte/rake-file-content
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Rake DSL extensions for managing file dependencies by content
+test_files: []