skippable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7436193085c629482c33f7acdf38ec89098989c30e4acf8b004df1259bb1ba9e
+  data.tar.gz: 8d49e82b9f2aef5af0fe6c9b77787a25c7edaaffdf54e3e5c07cc12c6e70c6cc
+SHA512:
+  metadata.gz: 2ee921b830b2eaefdcdffce2dfdc3dbab01b5a7261a460a0d747bb1e20f56ba9997091e96886263d2ae4851b33a583d51b0dcdef9742901beccfed058872d767
+  data.tar.gz: d02a4e9b981f3a2cb3fb8c9f5c619b830e7e416644c012862aabc15e8184cb3ac788e90236ae3bcb3eb8a72eb7ef070ec4b08b9553c83eaeb216de45d1025150

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+/spec/examples.txt

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in skippable.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "pry"
+
+group :test do
+  gem "rspec", "~> 3.0"
+  gem "jet_black"
+end

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    skippable (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    jet_black (0.6.0)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jet_black
+  pry
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  skippable!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Oliver Peate
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# Skippable
+
+Skippable helps you skip slow commands unless certain files changed. This can be
+handy on CI, where valuable time, money, and CO₂ are often wasted by repeatedly
+running the same command when nothing changed.
+
+For example [License Finder](https://github.com/pivotal/LicenseFinder) takes ~45
+seconds to run on a project with Ruby gems and NPM dependencies. In this example
+there's no need to check the licenses if the dependency lockfiles didn't change.
+
+## Usage
+
+Add Skippable to your Gemfile:
+
+```ruby
+group :development do
+  gem "skippable", require: false
+end
+```
+
+Setup a `.skippable.yml` config file with one or more tasks:
+
+```yaml
+tasks:
+  expensive_op:
+    command: bundle exec my_slow_command
+    paths:
+      - lockfile_a
+      - lockfile_b
+```
+
+Run the task using `skippable`:
+
+```
+bundle exec skippable expensive_op
+```
+
+- If the cache was cold OR the lockfiles changed, the specified command will
+be run
+- If the cache is warm, and the lockfiles haven't changed, the command
+will be skipped
+
+Finally, cache the following directory to persist state across builds:
+
+```
+tmp/skippable
+```
+
+## Example
+
+```yaml
+# .skippable.yml
+tasks:
+  license_finder:
+    command: bundle exec license_finder
+    paths:
+      - Gemfile.lock
+      - yarn.lock
+```
+
+Invocation:
+
+```
+bundle exec skippable license_finder
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/exe/skippable

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "skippable/task_loader"
+
+task = Skippable::TaskLoader.new.by_name(ARGV.first)
+exit task.call

data/lib/skippable.rb

@@ -0,0 +1,5 @@
+require "skippable/version"
+
+module Skippable
+  class Error < StandardError; end
+end

data/lib/skippable/file_digest.rb

@@ -0,0 +1,40 @@
+require "digest"
+require "fileutils"
+
+module Skippable
+  class FileDigest
+    def initialize(path:)
+      @path = path
+    end
+
+    def changed?
+      current_digest != cached_digest
+    end
+
+    def update_cached_digest
+      unless File.directory?(File.dirname(cached_digest_path))
+        FileUtils.mkdir_p(File.dirname(cached_digest_path))
+      end
+
+      File.write(cached_digest_path, current_digest)
+    end
+
+    private
+
+    attr_reader :path
+
+    def current_digest
+      @current_digest ||= Digest::SHA256.file(path).hexdigest
+    end
+
+    def cached_digest
+      if File.exist?(cached_digest_path)
+        File.read(cached_digest_path)
+      end
+    end
+
+    def cached_digest_path
+      File.join("tmp", "skippable", path)
+    end
+  end
+end

data/lib/skippable/task.rb

@@ -0,0 +1,38 @@
+require "skippable/file_digest"
+
+module Skippable
+  class Task
+    def initialize(name:, command:, paths:)
+      @name = name
+      @command = command
+      @paths = paths
+    end
+
+    def call
+      if file_digests.none?(&:changed?)
+        puts "Skipping #{name}..."
+        return 0
+      end
+
+      execute_command
+
+      if $?.success?
+        file_digests.each(&:update_cached_digest)
+      end
+
+      $?.exitstatus
+    end
+
+    private
+
+    attr_reader :name, :command, :paths
+
+    def execute_command
+      system(command)
+    end
+
+    def file_digests
+      @file_digests ||= paths.map { |path| FileDigest.new(path: path) }
+    end
+  end
+end

data/lib/skippable/task_loader.rb

@@ -0,0 +1,22 @@
+require "yaml"
+require "skippable/task"
+
+module Skippable
+  class TaskLoader
+    def by_name(task_name)
+      task_config = config.fetch("tasks").fetch(task_name)
+
+      Task.new(
+        name: task_name,
+        command: task_config.fetch("command"),
+        paths: task_config.fetch("paths"),
+      )
+    end
+
+    private
+
+    def config
+      @config ||= YAML.load_file(".skippable.yml")
+    end
+  end
+end

data/lib/skippable/version.rb

@@ -0,0 +1,3 @@
+module Skippable
+  VERSION = "0.1.0"
+end

data/skippable.gemspec

@@ -0,0 +1,25 @@
+require_relative "lib/skippable/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "skippable"
+  spec.version = Skippable::VERSION
+  spec.authors = ["Oliver Peate"]
+
+  spec.summary = "Skip a command unless file(s) changed"
+  spec.homepage = "https://github.com/odlp/skippable"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: skippable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oliver Peate
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-12-22 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+executables:
+- skippable
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/skippable
+- lib/skippable.rb
+- lib/skippable/file_digest.rb
+- lib/skippable/task.rb
+- lib/skippable/task_loader.rb
+- lib/skippable/version.rb
+- skippable.gemspec
+homepage: https://github.com/odlp/skippable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/odlp/skippable
+  source_code_uri: https://github.com/odlp/skippable
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Skip a command unless file(s) changed
+test_files: []