tweek 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8c6ef673ab0665cb66d13f99dc0023475b897e7
-  data.tar.gz: 00de0099ebd776a88efd3179dc7ead5d5306d386
+  metadata.gz: a1e291275563c2896f9c59ee25c11486e0a891f7
+  data.tar.gz: e97cac8c95c5beda3dc9ec48a3c4ea418c5d6bbc
 SHA512:
-  metadata.gz: 276719adb0d4db1ed7c326a06b477676ae9a078b561ebe5a45df8b76cb4247a31f252cb0a40234008c76f83b6ba008f9d1b91644824729f64ddbd6dddbeac6b5
-  data.tar.gz: 73b5560399d4374b0b13b21c39eeeffc94fc9023851cbb7e6dc344214a2ecf8f2c6c53defd6dadc6f4c07528ea1f25c14a0e54f7ca7580475b9857de2942bb1b
+  metadata.gz: 49c42da3fcfa156d2f12cd6fdf561fb2a010982f7e272ec45ec00d49f7f829021606cd8f26bd78679791ad8c58125ff360118ce2a9a5a69890b7c9432ea6e59e
+  data.tar.gz: b2c84d89a856596c074c941e757d047b902877a4a4ad513ca0b22e42bc88fb4f196b0140e9fd0cb4aececd9200f3a746648899520c3fa8c345a36b5080f1fc8e

data/lib/tweek/entry.rb

@@ -0,0 +1,139 @@
+# A tweek file consists of lines represented by Tweek::Entry
+#
+# All of the entries in the file have a line number and optional comment
+# other attributes depend on the specific type.
+#
+# Lifecycle: An entry is created either directly or parsed from an input line,
+# then the 'condfail' method is called to see if it's relevant, if so
+# the actual values are filled in according to the section. Then the 'mismatch'
+# method can be used to see if it matched. Finally the 'generate' method
+# produces a human-readable output
+#
+require 'ostruct'
+
+class Tweek::Entry < OpenStruct
+
+  # Not all entries are settable: record if this entry was used to set/reset a value or not
+  attr_accessor :mode
+
+  # The type of this entry:
+  # :literal        With line attributes - single lines
+  # :section        With section type and list attributes
+  # :parameter      With parameter value and conditional attributes
+  #
+  attr_reader :type
+
+  def initialize section, type, h
+    raise "Invalid Entry type #{type}" unless [:literal, :parameter, :section].include? type
+    super h
+    @section = section
+    @type = type
+    @mode = :query
+    @condfail = nil
+    @mismatch = nil
+  end
+
+  # Parse an input line
+  #
+  def self.parse section, line
+
+    line.chomp!
+    comment = line.slice!(/#.*$/)
+    comment.slice!(/^#\s*/) if comment
+    entry = case
+            when line.empty?
+              Tweek::Entry.new( section, :literal, :line => line, :comment => comment )
+
+            when /^\s*([A-Z0-9]+)\s*(.*?)\s*$/ =~ line # We've hit a new section
+              Tweek::Entry.new( section, :section, :section_type => $1.to_sym, :list => $2,
+                                :comment => comment )
+
+            when /^\s*(.+?)\s*=\s*(.*?)\s*(\bif\b(.*))?$/ =~ line # A parameter line
+              param = $1
+              value = $2
+              raise "Missing condition after 'if'" if $4 and $4.strip.empty?
+              cond = $4.nil? ? nil : $4.strip
+              was = /\s*\[was\s+(.*)\]/.match(comment)
+              if was
+                comment = was.pre_match+was.post_match
+                was = was.captures.first
+              end
+              expected = /\s*\[expected\s+(.*)\]/.match(comment)
+              if expected
+                comment = expected.pre_match+was.post_match
+                expected = expected.captures.first
+              end
+              comment = nil if comment and comment.empty?
+              Tweek::Entry.new( section, :parameter, :param => param, :value => value,
+                                :cond => cond, :comment => comment,
+                                :was => was, :expected => expected )
+            else
+              raise "Unrecognized line"
+            end
+    return entry
+  end
+
+  # Check if any associated condition is true or false
+  #
+  def condfail
+    @condfail ||= @section.twf.condfail(cond)
+  end
+
+  # Check if the entry matches reality
+  #
+  def mismatch
+    raise "Value or Actual missing! Can't check for mismatch" if value.nil? or actual.nil?
+    @mismatch ||= !(value === actual)
+  end
+
+  # Generate an output line for this entry
+  #
+  def generate
+
+    outline = nil
+
+    case self.type
+
+    when :literal
+      outline = line
+      outline += "# #{comment}" if comment
+
+    when :section
+      if section_type.nil?
+        outline = nil
+      else
+        name = list_element || list
+        outline = "#{section_type} #{name} #{comment}"
+      end
+
+    when :parameter
+      condout = cond.nil? ? "": " if #{cond}"
+      if condfail
+        body = "#{param} = #{value}#{condout.colorize(:red)}"
+        note = nil
+      else
+        swap! if mode != :query
+        if mismatch
+          body = "#{param} = #{actual.colorize(:red)}#{condout.colorize(:green)}"
+          note = " [#{mode != :query ? 'was' : 'expected'} #{value.colorize(:yellow)}]"
+        else
+          body = "#{param} = #{actual}#{condout.colorize(:green)}"
+          note = nil
+        end
+      end
+      if comment.nil?
+        outline = (note ? (body + " #" + note) : body)
+      else
+        outline = (note ? (body + " # " + comment + note) : (body + " # " + comment))
+      end
+    end
+    return outline
+
+  end
+
+  # Method to toggle the actual and expected values, used for :query, :set, :reset
+  def swap!
+      self.actual, self.value = self.value, self.actual
+  end
+
+end

data/lib/tweek/version.rb

@@ -1,3 +1,3 @@
 module Tweek
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tweek
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Nick Townsend
@@ -79,6 +79,7 @@ files:
 - README.md
 - bin/tweek
 - lib/tweek.rb
+- lib/tweek/entry.rb
 - lib/tweek/file.rb
 - lib/tweek/section.rb
 - lib/tweek/version.rb