pmlcode 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 454dcaffe9ac7b63687a11ae68c4542be8b72676
-  data.tar.gz: febd592ae42c593fcdfe1d2152f09092e8b44839
+  metadata.gz: f7c9d54c8aff1abb04b6b9c83b086c937cc95faa
+  data.tar.gz: 05225b9edfdfa6ea2eeff33bca12b24bea7e5098
 SHA512:
-  metadata.gz: 220ab845e2e4432e435d1bd4acb5a8456ec55f55f2f0d08e8adc2db1f2752d07858de5b99fa9355fd987c4da0ccef7dab89240d7116338e75bc68ba31eb8000d
-  data.tar.gz: 834b6644bc03c7ee1bfd07711641a0e4d21f8833f83af4466f9a2b0d3c07c17584ed54a1f810c2ac0932af49e6341ad227089abe62127647e98c38e4f1c02358
+  metadata.gz: f7bc407d5a5a7b7edb8fc1fad07d616fc7609dbcc3dfdb4c216d1eed5d05e59b13f6250415223bf5471425782635228d0ac852faba56a04fc80b32f75b4eb7a0
+  data.tar.gz: 192249c2ab7b04ebfa7441f20facdc4300771834104437c723d12344098faff726667b9acf2e28597dbbfc141f3b6e17e468a977b776f233d71fb284c121e45c

data/README.md

@@ -23,15 +23,19 @@ 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.
+process as many `.pml` files as you like at once, be warned of missing
+parts, see the file content (incl highlights), customize the
+pattern used to extract the metadata from the filename, and more.
 
-See `pmlcode --help` for more details.
+See `pmlcode --help` for more details (or read `USAGE`
+and the options in [PMLCode::CLI](./lib/pmlcode/cli.rb)).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/bruce/pmlcode.
+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).
+The gem is available as open source under the terms of
+the [MIT License](http://opensource.org/licenses/MIT).

data/lib/pmlcode.rb

@@ -1,8 +1,14 @@
-require "pmlcode/version"
-
 require "nokogiri"
+require "rainbow"
+
+require "fileutils"
+
+require "pmlcode/version"
 
 module PMLCode
   autoload :CLI,     'pmlcode/cli'
   autoload :Updater, 'pmlcode/updater'
+  autoload :Content, 'pmlcode/content'
+  autoload :Display, 'pmlcode/display'
+  autoload :Source,  'pmlcode/source'
 end

data/lib/pmlcode/cli.rb

@@ -8,6 +8,8 @@ module PMLCode::CLI
 
       pmlcode [PML_PATH, ...] [OPTIONS]
 
+  PML_PATHs can optionally include a :LINENUM suffix.
+
   ## SYNOPSIS
 
   Looks for `<embed>` tags whose `file` attribute match `--pattern`, extracting the
@@ -80,11 +82,11 @@ module PMLCode::CLI
     parser = build_parser(options)
     parser.parse!(args)
 
-    files = prepare(options, parser, args)
+    sources = prepare(options, parser, args)
 
-    files.each do |pml|
-      options.pml = pml
-      options.output = File.dirname(pml)
+    sources.each do |source|
+      options.source = source
+      options.output = File.dirname(source.path)
       update!(options)
     end
 
@@ -119,14 +121,14 @@ module PMLCode::CLI
       $stderr.puts parser
       exit
     end
-    files = args.map { |pml| File.expand_path(pml) }
-    missing = files.select { |pml| !File.exists?(pml) }
+    sources = args.map { |pml| PMLCode::Source.parse(pml) }
+    missing = sources.select(&:missing?)
     unless missing.empty?
-      $stderr.puts "PML files #{missing} not found"
+      $stderr.puts "PML sources #{missing} not found"
       puts parser
       exit
     end
-    files
+    sources
   end
 
   def self.build_parser(options)
@@ -145,6 +147,18 @@ module PMLCode::CLI
         options.pattern = Regexp.new(value)
       end
 
+      opts.on('-c', '--content', "Show content") do
+        options.content = true
+      end
+
+      opts.on("-V", "--verbose", "Verbose output (Only useful with --content)") do
+        options.verbose = true
+      end
+
+      opts.on('-x', '--dry-run', "Dry run (do not write files)") do
+        options.dry_run = true
+      end
+
       opts.on_tail("-h", "--help", "Show this message") do
         puts opts
         exit

data/lib/pmlcode/content.rb

@@ -0,0 +1,98 @@
+class PMLCode::Content
+  include Enumerable
+
+  def self.parse(text)
+    parser = Parser.new(text)
+    new(parser.result)
+  end
+
+  def initialize(lines)
+    @lines = lines
+  end
+
+  def has_part?(name)
+    @lines.any? { |l| l.in_part?(name) }
+  end
+
+  def each(&block)
+    @lines.each(&block)
+  end
+
+  def to_s
+    @lines.map(&:text)
+  end
+
+  class Line
+
+    attr_reader :text
+
+    def initialize(text, parts = [], highlighted = false)
+      @text = text
+      @parts = parts
+      @highlighted = highlighted
+    end
+
+    def in_part?(part = nil)
+      if part
+        @parts.include?(part)
+      else
+        !@parts.empty?
+      end
+    end
+
+    def highlighted?
+      @highlighted
+    end
+
+  end
+
+  class Parser
+
+    PART_START = /START:\s?(\S+)/
+    PART_END = /END:\s?(\S+)/
+
+    HL_START = /START_HIGHLIGHT/
+    HL_END = /END_HIGHLIGHT/
+
+    def initialize(raw)
+      @raw = raw
+    end
+
+    def result
+      @result ||= run
+    end
+
+    private
+
+    def run
+      @parts = []
+      @highlighted = nil
+      lines.map(&method(:process)).compact
+    end
+
+    def process(text)
+      case text
+      when PART_START
+        @parts << $1
+        nil
+      when PART_END
+        @parts.reject! { |part| part == $1 }
+        nil
+      when HL_START
+        @highlighted = true
+        nil
+      when HL_END
+        @highlighted = false
+        nil
+      else
+        Line.new(text, @parts.dup, @highlighted)
+      end
+    end
+
+    def lines
+      @raw.split(/\r?\n/)
+    end
+
+  end
+
+end

data/lib/pmlcode/display.rb

@@ -0,0 +1,31 @@
+class PMLCode::Display
+
+  INDENT = " " * 4
+
+  def initialize(content, part, options)
+    @content = content
+    @part = part
+    @options = options
+  end
+
+  def to_s
+    INDENT + "```\n" + \
+    @content.map(&method(:format_line)).compact.map { |l| INDENT + l }.join("\n") + "\n" + \
+    INDENT + "```"
+  end
+
+  private
+
+  def format_line(line)
+    if @part && !line.in_part?(@part) && @options.verbose
+      Rainbow(line.text).black
+    elsif !@part || (@part && line.in_part?(@part))
+      if line.highlighted?
+        Rainbow(line.text).yellow.bold
+      else
+        line.text
+      end
+    end
+  end
+
+end

data/lib/pmlcode/source.rb

@@ -0,0 +1,25 @@
+class PMLCode::Source
+
+  PATTERN = /^(?<path>.+?)(:(?<line>\d+):?)?$/
+
+  def self.parse(text)
+    if (match = text.match(PATTERN))
+      new(match[:path], match[:line] ? Integer(match[:line]) : nil)
+    end
+  end
+
+  attr_reader :path, :line
+  def initialize(path, line)
+    @path = File.expand_path(path)
+    @line = line
+  end
+
+  def missing?
+    !File.exists?(@path)
+  end
+
+  def to_s
+    [@path, @line].join(":")
+  end
+
+end

data/lib/pmlcode/updater.rb

@@ -42,47 +42,84 @@ class PMLCode::Updater
   end
 
   def initialize(options)
-    @pml = options.pml
+    @source = options.source
     @options = options
     @current_prefix = nil
     @wrote = {}
+    @files = {}
   end
 
   def embeds
     @embeds ||= begin
-      doc = Nokogiri::XML(File.read(@pml))
-      doc.css('embed')
+      doc = Nokogiri::XML(File.read(@source.path))
+      doc.css('embed').select do |embed|
+        if @source.line
+          embed.line == @source.line
+        else
+          true
+        end
+      end
     end
   end
 
-  def log(location, text)
-    $stderr.puts "#{location}#{text}"
-  end
-
   def run
     embeds.each do |embed|
-      location = File.basename(@pml) + ":#{embed.line}:"
+      puts Rainbow(File.basename(@source.path) + ":#{embed.line} ").bold.underline
       match = @options.pattern.match(embed[:file])
       if match
-        dedup(location, match) { update(match) }
+        text = dedup(match) { |already_wrote| update(match, already_wrote) }
+        if text
+          print Rainbow("OK").green
+          puts " : FILE #{embed[:file]} #{write_flag}"
+          check_part!(text, embed[:part])
+        else
+          print Rainbow("ERROR").red
+          puts " : FILE #{embed[:file]}"
+        end
       else
-        log location, "NOMATCH #{embed[:file]}"
+        print Rainbow("BAD MATCH").red
+        puts " : FILE #{embed[:file]}"
       end
+      puts
     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}"
+  def dedup(match, &block)
+    update_id = generate_update_id(match)
+    content_id = generate_content_id(match)
+    @files[content_id] ||= block.(@wrote[update_id])
+    @wrote[update_id] = true
+    @files[content_id]
+  end
+
+  def check_part!(text, part)
+    content = PMLCode::Content.parse(text)
+    if part
+      if content.has_part?(part)
+        print Rainbow("OK").green
       else
-        log location, "INVALID #{id}"
+        print Rainbow("MISSING").red
       end
+    else
+      print Rainbow("--").gray
     end
+    puts " : PART #{part}"
+    puts "\n"
+    if @options.content
+      puts PMLCode::Display.new(content, part, @options)
+    end
+  end
+
+  def write_flag
+    if @options.dry_run
+      Rainbow("  DRY RUN  ").green.inverse
+    else
+      Rainbow("  WRITTEN  ").yellow.inverse
+    end
+  end
+
+  def generate_content_id(match)
+    match.string
   end
 
   def generate_update_id(match)

data/lib/pmlcode/updaters/full_updater.rb

@@ -6,15 +6,21 @@ class PMLCode::FullUpdater < PMLCode::Updater
 
   private
 
-  def update(match)
+  def update(match, already_wrote)
     full_path = directory(match)
     FileUtils.mkdir_p(full_path)
     success = false
+    content = nil
     Dir.chdir(@options.app) do
-      system "git archive '#{match[:chapter]}.#{match[:snapshot]}' | tar -x -C '#{full_path}'"
-      success = $?.success?
+      content = `git show origin/#{match[:chapter]}.#{match[:snapshot]}:#{match[:path]}`
+      if already_wrote || @options.dry_run
+        success = true
+      else
+        system "git archive '#{match[:chapter]}.#{match[:snapshot]}' | tar -x -C '#{full_path}'"
+        success = $?
+      end
     end
-    success
+    success ? content : nil
   end
 
   def generate_update_id(match)

data/lib/pmlcode/updaters/sparse_updater.rb

@@ -1,5 +1,3 @@
-require 'fileutils'
-
 class PMLCode::SparseUpdater < PMLCode::Updater
 
   handles do |criteria|
@@ -8,7 +6,7 @@ class PMLCode::SparseUpdater < PMLCode::Updater
 
   private
 
-  def update(match)
+  def update(match, already_wrote)
     success = false
     content = nil
     Dir.chdir(@options.app) do
@@ -16,12 +14,14 @@ class PMLCode::SparseUpdater < PMLCode::Updater
       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)
+      unless already_wrote || @options.dry_run
+        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
       end
-      true
+      content
     end
   end
 

data/lib/pmlcode/version.rb

@@ -1,3 +1,3 @@
 module PMLCode
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/pmlcode.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency 'nokogiri', '~> 1.8', '>= 1.8.0'
+  spec.add_runtime_dependency 'rainbow', '~> 2.2'
 
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pmlcode
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Bruce Williams
@@ -30,6 +30,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +105,9 @@ files:
 - exe/pmlcode
 - lib/pmlcode.rb
 - lib/pmlcode/cli.rb
+- lib/pmlcode/content.rb
+- lib/pmlcode/display.rb
+- lib/pmlcode/source.rb
 - lib/pmlcode/updater.rb
 - lib/pmlcode/updaters/full_updater.rb
 - lib/pmlcode/updaters/sparse_updater.rb