pmlcode 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: abfc5fd353c408017aed3442d35e2ce4568a200f
+  data.tar.gz: 9b63d608dfb25a6592a0fb692b821b9506c1ee4c
+SHA512:
+  metadata.gz: b9f02ef23745fccf84493f91d9b9df1632f9318c8c6f546d00d28d1be6614750d6d613c184edaef7ade0f463ca2abc2eab7ebdf475ed5604d71aa065b7a4ccbf
+  data.tar.gz: 6e9fc8e886d2fc8529064bba49f4fecc55ec923cb42754d74bc18d798c3d14d18275378ffa38d835ef351e49ac00eeca75fb18a8e9d3f76c4234fdff8efda055

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4

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 pmlcode.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Bruce Williams
+
+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,37 @@
+# pmlcode
+
+A utility for downloading code files referenced by `.pml` files.
+
+## Installation
+
+    $ gem install pmlcode
+
+## Usage
+
+See `pmlcode --help`
+
+### Example
+
+Assuming `Chapter.pml` has an embed for
+`code/02-testing/01-start/test/some_test.exs`:
+
+This command:
+
+    $ pmlcode Chapter.pml -a /path/to/git/working/copy
+
+Will generate the referenced file, extracting it from the
+`origin/02-testing.01-start` ref of `/path/to/git/working/copy`.
+
+You can also extract the entire branch using the `-t full` option,
+process as many `.pml` files as you like at once, customize the
+pattern used to extract the metadata from filename, and more.
+
+See `pmlcode --help` for more details.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bruce/pmlcode.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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 "pmlcode"
+
+# 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/exe/pmlcode

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+
+require "pmlcode"
+
+PMLCode::CLI.run(ARGV)

data/lib/pmlcode/cli.rb

@@ -0,0 +1,154 @@
+require 'ostruct'
+require 'optparse'
+
+module PMLCode::CLI
+
+  USAGE =<<-EOU
+  ## USAGE
+
+      pmlcode [PML_PATH, ...] [OPTIONS]
+
+  ## SYNOPSIS
+
+  Looks for `<embed>` tags whose `file` attribute match `--pattern`, extracting the
+  following metadata:
+
+  - `coderoot`: The relative path from the source PML's directory
+  - `chapter`: A chapter identifier
+  - `snapshot`: A snapshot of the code at a specific point in the chapter
+  - `path`: The path to the file within the target `--application-directory` project
+
+  For example, given this embed, using the default --pattern:
+
+    <embed file="code/02-testing/01-start/test/some_test.exs"/>
+
+  This is the metadata:
+
+  coderoot
+  : `code`
+
+  chapter
+  : `02-testing`
+
+  snapshot
+  : `01-start`
+
+  path
+  : `test/some_test.exs`
+
+  This file will be extracted by looking at the repository located at --application-directory,
+  and trying to find a ref _on its remote origin_ that matches the `chapter.snapshot`, i.e.:
+
+      `origin/02-testing.01-start`
+
+  Then pulling `test/some_test.exs` (or the entire branch, if `--type full` is being used).
+
+  ## ENVIRONMENT VARIABLES
+
+  PMLCODE_APP_DIR
+  : An optional working copy directory path, sets the default
+    for `--application-directory`
+
+  PMLCODE_PATTERN
+  : An optional pattern, sets the default for `--pattern`
+
+  ## CUSTOM PATTERNS
+
+  Any custom pattern must have named captures for `coderoot`, `chapter`, `snapshot`, and `path`.
+
+  ## CUSTOM BRANCH/REFS
+
+  Currently the ref retrieved from git repositories is always in the form `chapter.snapshot`,
+  using the information matched using the --pattern.
+
+  EOU
+
+  REQUIRED_PATTERN_CAPTURES = %w(coderoot chapter snapshot path)
+  DEFAULT_PATTERN = /^(?<coderoot>[^\/]+)\/(?<chapter>[^\/]+)\/(?<snapshot>[^\/]+)\/(?<path>.+)$/
+
+  DEFAULTS = {
+    type: :sparse,
+    app: ENV["PMLCODE_APP_DIR"],
+    pattern: ENV["PMLCODE_PATTERN"] ? Regexp.new(ENV["PMLCODE_PATTERN"]) : DEFAULT_PATTERN
+  }.freeze
+
+  def self.run(args)
+    options = OpenStruct.new(DEFAULTS)
+    # Parse arguments
+    parser = build_parser(options)
+    parser.parse!(args)
+
+    files = prepare(options, parser, args)
+
+    files.each do |pml|
+      options.pml = pml
+      options.output = File.dirname(pml)
+      update!(options)
+    end
+
+  end
+
+  private
+
+  def self.update!(options)
+    updater = PMLCode::Updater.find(options)
+    unless updater
+      $stderr.puts "No updater found. --type '#{options.type}' may not be supported."
+      $stderr.puts parser
+      exit
+    end
+    updater.run(options)
+  end
+
+  def self.prepare(options, parser, args)
+    if args.empty?
+      $stderr.puts "No PML files given."
+      $stderr.puts parser
+      exit
+    end
+    unless options.app
+      $stderr.puts "No --application-directory given."
+      $stderr.puts parser
+      exit
+    end
+    unless REQUIRED_PATTERN_CAPTURES.all? { |cap| options.pattern.named_captures.key?(cap) }
+      $stderr.puts "Pattern does not define one or more required named captures: #{REQUIRED_NAMED_CAPTURES}"
+      $stderr.puts "Check your use of --pattern or the PMLCODE_PATTERN environment variable"
+      $stderr.puts parser
+      exit
+    end
+    files = args.map { |pml| File.expand_path(pml) }
+    missing = files.select { |pml| !File.exists?(pml) }
+    unless missing.empty?
+      $stderr.puts "PML files #{missing} not found"
+      puts parser
+      exit
+    end
+    files
+  end
+
+  def self.build_parser(options)
+    OptionParser.new do |opts|
+      opts.banner = USAGE
+
+      opts.on("-t [TYPE]", "--type", [:sparse, :full], "Export type (sparse, full)") do |value|
+        options.type = value
+      end
+
+      opts.on("-a [PATH]", "--application-directory", "Application directory (default: #{options.app}") do |value|
+        options.app = value
+      end
+
+      opts.on("-p [PATTERN]", "--pattern", "Pattern (default: #{options.pattern.source}") do |value|
+        options.pattern = Regexp.new(value)
+      end
+
+      opts.on_tail("-h", "--help", "Show this message") do
+        puts opts
+        exit
+      end
+
+    end
+  end
+
+end

data/lib/pmlcode/updater.rb

@@ -0,0 +1,96 @@
+class PMLCode::Updater
+
+  class << self
+
+    def inherited(plugin)
+      plugins << plugin
+    end
+
+    def plugins
+      @plugins ||= []
+    end
+
+    def load_plugins!
+      Dir.glob(File.expand_path("../updaters/*.rb", __FILE__)) do |filename|
+        require filename
+      end
+    end
+
+    def handle_check
+      @handle_check ||= ->(x) { false }
+    end
+
+    def handles(&check)
+      @handle_check = check
+    end
+
+    def handles?(criteria)
+      handle_check.(criteria)
+    end
+
+    def find(criteria)
+      load_plugins!
+      plugins.find do |plugin|
+        plugin.handles?(criteria)
+      end
+    end
+
+    def run(options)
+      new(options).run
+    end
+
+  end
+
+  def initialize(options)
+    @pml = options.pml
+    @options = options
+    @current_prefix = nil
+    @wrote = {}
+  end
+
+  def embeds
+    @embeds ||= begin
+      doc = Nokogiri::XML(File.read(@pml))
+      doc.css('embed')
+    end
+  end
+
+  def log(location, text)
+    $stderr.puts "#{location}#{text}"
+  end
+
+  def run
+    embeds.each do |embed|
+      location = File.basename(@pml) + ":#{embed.line}:"
+      match = @options.pattern.match(embed[:file])
+      if match
+        dedup(location, match) { update(match) }
+      else
+        log location, "NOMATCH #{embed[:file]}"
+      end
+    end
+  end
+
+  def dedup(location, match, &block)
+    id = generate_update_id(match)
+    if @wrote[id]
+      log location, "SKIP #{id} (WROTE by #{@wrote[id][0..-2]})"
+    else
+      if block.()
+        @wrote[id] = location
+        log location, "WROTE #{id}"
+      else
+        log location, "INVALID #{id}"
+      end
+    end
+  end
+
+  def generate_update_id(match)
+    raise NotImplemented, "Override #{self.class}#generate_update_id"
+  end
+
+  def directory(match)
+    File.expand_path(File.join(@options.output, match[:coderoot], match[:chapter], match[:snapshot]))
+  end
+
+end

data/lib/pmlcode/updaters/full_updater.rb

@@ -0,0 +1,24 @@
+class PMLCode::FullUpdater < PMLCode::Updater
+
+  handles do |criteria|
+    criteria.type == :full
+  end
+
+  private
+
+  def update(match)
+    full_path = directory(match)
+    FileUtils.mkdir_p(full_path)
+    success = false
+    Dir.chdir(@options.app) do
+      system "git archive '#{match[:chapter]}.#{match[:snapshot]}' | tar -x -C '#{full_path}'"
+      success = $?.success?
+    end
+    success
+  end
+
+  def generate_update_id(match)
+    "#{match[:chapter]}.#{match[:snapshot]}"
+  end
+
+end

data/lib/pmlcode/updaters/sparse_updater.rb

@@ -0,0 +1,32 @@
+require 'fileutils'
+
+class PMLCode::SparseUpdater < PMLCode::Updater
+
+  handles do |criteria|
+    criteria.type == :sparse
+  end
+
+  private
+
+  def update(match)
+    success = false
+    content = nil
+    Dir.chdir(@options.app) do
+      content = `git show origin/#{match[:chapter]}.#{match[:snapshot]}:#{match[:path]}`
+      success = $?.success?
+    end
+    if success
+      full_path = File.join(directory(match), match[:path])
+      FileUtils.mkdir_p(File.dirname(full_path))
+      File.open(full_path, 'w') do |f|
+        f.write(content)
+      end
+      true
+    end
+  end
+
+  def generate_update_id(match)
+    "#{match[:chapter]}.#{match[:snapshot]}/#{match[:path]}"
+  end
+
+end

data/lib/pmlcode/version.rb

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

data/lib/pmlcode.rb

@@ -0,0 +1,8 @@
+require "pmlcode/version"
+
+require "nokogiri"
+
+module PMLCode
+  autoload :CLI,     'pmlcode/cli'
+  autoload :Updater, 'pmlcode/updater'
+end

data/pmlcode.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pmlcode/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pmlcode"
+  spec.version       = PMLCode::VERSION
+  spec.authors       = ["Bruce Williams"]
+  spec.email         = ["brwcodes@gmail.com"]
+
+  spec.summary       = %q{Utility for managing PML code embeds}
+  spec.homepage      = "https://github.com/bruce/pmlcode"
+  spec.license       = "MIT"
+
+  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_runtime_dependency 'nokogiri', '~> 1.8', '>= 1.8.0'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: pmlcode
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bruce Williams
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- brwcodes@gmail.com
+executables:
+- pmlcode
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/pmlcode
+- lib/pmlcode.rb
+- lib/pmlcode/cli.rb
+- lib/pmlcode/updater.rb
+- lib/pmlcode/updaters/full_updater.rb
+- lib/pmlcode/updaters/sparse_updater.rb
+- lib/pmlcode/version.rb
+- pmlcode.gemspec
+homepage: https://github.com/bruce/pmlcode
+licenses:
+- MIT
+metadata: {}
+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.11
+signing_key: 
+specification_version: 4
+summary: Utility for managing PML code embeds
+test_files: []