command-cacheable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88dad12c02550c892fa096ff0565f05c0597b9e8
+  data.tar.gz: 0538a70ce6428325e720184cceaf9fb49bdb48e4
+SHA512:
+  metadata.gz: 83a22f48f0137df50ddd7226d0f029f66683d4946f27c6f7f28c5e64bc1916195995f71c0cc4ea61e5c4ea2b81cb535db72d058d2f7aa9392ae2b9587cdad080
+  data.tar.gz: 93af6a869d61815bd36933b60afe2c6ede2095063dd5cd9c3bfce53b6fe4cd444ad25dc353ce5fe1f073770f032fa2c057ed6c113a8eaae44c950fed0cd78453

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in command-cacheable.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    command-cacheable (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    logue (1.0.8)
+      rainbow (~> 2.0, >= 2.0.0)
+    paramesan (0.1.1)
+    power_assert (1.1.1)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    test-unit (3.2.6)
+      power_assert
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  command-cacheable!
+  logue (~> 1.0)
+  paramesan (~> 0.1.1)
+  rake (~> 10.0)
+  test-unit (~> 3.1)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jeff Pace
+
+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,39 @@
+# Command::Cacheable
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/command/cacheable`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'command-cacheable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install command-cacheable
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 tags, 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/jpace/command-cacheable.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+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
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "command/cacheable"
+
+# 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/command-cacheable.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "command/cacheable/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "command-cacheable"
+  spec.version       = Command::Cacheable::VERSION
+  spec.authors       = ["Jeff Pace"]
+  spec.email         = ["jeugenepace@gmail.com"]
+
+  spec.summary       = %q{Command-line execution, caching results.}
+  spec.description   = %q{Executes on the command line, caching results for performance of repeated invocations.}
+  spec.homepage      = "http://www.github.com/jpace/arbolobra"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "test-unit", "~> 3.1"
+  spec.add_development_dependency "paramesan", "~> 0.1.1"
+  spec.add_development_dependency "logue", "~> 1.0"
+end

data/lib/command/cacheable.rb

@@ -0,0 +1,7 @@
+require "command/cacheable/version"
+
+module Command
+  module Cacheable
+    
+  end
+end

data/lib/command/cacheable/arg.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+module Command::Cacheable
+  class Argument < String
+    # just a string, but quotes itself
+
+    def to_s
+      '"' + super + '"'
+    end
+  end
+end

data/lib/command/cacheable/cachefile.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+# require 'command/cacheable/command'
+require 'command/cacheable/filename'
+require 'command/cacheable/gzpathname'
+
+module Command::Cacheable
+  # A file that has a pathname and output
+  #$$$ todo: cache error
+  class CacheFile
+    attr_reader :output
+    attr_reader :pathname
+    
+    def initialize cache_dir, args
+      @args     = args
+      basename  = FileName.new(args).name
+      fullname  = Pathname(cache_dir) + basename
+      @pathname = GzipPathname.new fullname
+      @output   = nil
+    end
+    
+    def read
+      @output = @pathname.exist? && @pathname.read_file
+    end
+
+    def save output
+      @pathname.save_file output
+    end
+
+    def to_s
+      @pathname.to_s
+    end
+  end
+end

data/lib/command/cacheable/caching.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'command/cacheable/command'
+require 'command/cacheable/cachefile'
+
+module Command::Cacheable
+  class CachingCommand < Command
+    # caches its input and values.
+
+    def initialize *args, debug: false, dir: nil
+      @args = args.dup
+      @dir = dir || '/tmp' + Pathname.new($0).expand_path.to_s
+    end
+
+    def cache_dir
+      @dir
+    end
+
+    def cache_file
+      CacheFile.new cache_dir, @args
+    end
+
+    def execute
+      cachefile = cache_file
+      @output = cachefile.read
+    end
+  end
+end

data/lib/command/cacheable/command.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'logue/loggable'
+require 'open3'
+require 'command/cacheable/cachefile'
+
+module Command
+  module Cacheable
+  end
+end
+
+module Command::Cacheable
+  # A command line executable, by default not caching.
+  class Command
+    include Logue::Loggable
+
+    CACHEDIR = "/tmp/cmdcache"
+
+    attr_reader :args
+    attr_reader :output
+    attr_reader :error
+    attr_reader :status
+
+    def initialize *args, debug: false, caching: false, cachedir: nil
+      @args     = args.dup
+      @caching  = caching
+      @cachedir = cachedir || CACHEDIR
+    end
+
+    def << arg
+      @args << arg
+    end
+
+    def execute
+      if @caching
+        read_cache_file
+      else
+        exec
+      end
+    end
+
+    def exec
+      cmd = to_command
+      Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thread|
+        @output = stdout.readlines
+        @error  = stderr.readlines
+        @status = wait_thread.value
+      end
+
+      #$$$ this functionality isn't in Logue yet (dump of one element per line):
+      # debug "output", @output
+      # debug "error", @error
+
+      debug "@status: #{@status}"      
+      
+      @output
+    end
+
+    def read_cache_file
+      cachefile = CacheFile.new @cachedir, @args
+      if cachefile.pathname.exist?
+        @output = cachefile.pathname.read_file
+      else
+        exec
+        cachefile.pathname.save_file @output
+        @output
+      end
+    end
+
+    def to_command
+      @args.join ' '
+    end
+  end
+end

data/lib/command/cacheable/filename.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+module Command
+  module Cacheable
+  end
+end
+
+module Command::Cacheable
+  class FileName
+    attr_reader :name
+
+    def initialize args
+      @name = args.join('-').gsub('/', '_slash_') + '.gz'
+    end
+
+    def to_s
+      @name
+    end
+  end
+end

data/lib/command/cacheable/gzpathname.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'zlib'
+require 'pathname'
+
+module Command
+end
+
+module Command::Cacheable
+  # A pathname (file) that reads and writes a list of lines, as gzipped
+  class GzipPathname < Pathname
+    def save_file content
+      parent.mkpath unless parent.exist?
+      unlink if exist?
+      Zlib::GzipWriter.open(to_s) do |gz|
+        gz.puts content
+      end
+    end
+
+    def read_file
+      content = nil
+      Zlib::GzipReader.open(to_s) do |gz|
+        content = gz.readlines
+      end
+    end
+  end
+end

data/lib/command/cacheable/version.rb

@@ -0,0 +1,5 @@
+module Command
+  module Cacheable
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: command-cacheable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeff Pace
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: paramesan
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: logue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Executes on the command line, caching results for performance of repeated
+  invocations.
+email:
+- jeugenepace@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- command-cacheable.gemspec
+- lib/command/cacheable.rb
+- lib/command/cacheable/arg.rb
+- lib/command/cacheable/cachefile.rb
+- lib/command/cacheable/caching.rb
+- lib/command/cacheable/command.rb
+- lib/command/cacheable/filename.rb
+- lib/command/cacheable/gzpathname.rb
+- lib/command/cacheable/version.rb
+homepage: http://www.github.com/jpace/arbolobra
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.3
+signing_key: 
+specification_version: 4
+summary: Command-line execution, caching results.
+test_files: []