fsorg 0.0.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9ce898448e087a0796e866079ed09a93621e0b9f6b6b8e81f649a63b7d7946a
-  data.tar.gz: 9b59d3e4832975ac5e9795225bfe59abc779cca86ef8a1fe2e6fa1c931ba2dd9
+  metadata.gz: ddcf3941d7eb4d9fc41fff221b3b178121564c52a8bfe29aabc2b30a8e0e70d7
+  data.tar.gz: a7b50828bdccb1a2afc8ed7911fec2c5ef6f4ebe846d86be774438c7480c8e10
 SHA512:
-  metadata.gz: fd51f3421a42c32328df76734f08f3de123004b71480fc0358592ac154fb9cd8a16486e1545ab2aa8b99c43d43a841d154d1dedf07dab5eaf17903644eb5221d
-  data.tar.gz: ebd92477d65bd0872a88be091bcfb8ce3b98da539ba0895dd67367a9af8d0b6813297070027056c838dd8ddc2a977a4cad42ed57ee504baeaea91a7a69919f48
+  metadata.gz: de9ff6a647a0640cac2cc1d7ea297834b70cc9eab702f2be37565acf340cfdaaa9d35353edd6a86979131c18686f348840d7716c597d7516613f1be5e937553f
+  data.tar.gz: 238a5c6b2d33689d66675ea1204b0babd74da5513471c8addd1f90263e8073680c464211d16b69bde824d11e49d7e6aa48a35cf6eb3af4f7b78653a8e4754450

data/bin/fsorg

@@ -1,4 +1,33 @@
 #!/usr/bin/env ruby
+require "docopt"
+require "yaml"
 require "fsorg"
 
+args = Docopt.docopt <<-DOC
+    Usage:
+        fsorg [options] <filepath>
+        fsorg [options] <data> <filepath>
 
+    Options:
+        -h --help                 Show this screen.
+        -r --root=ROOT_DIRECTORY  Set the root directory.
+        -n --dry-run              Show what would be done, but don't do it.
+        -q --quiet                Don't show actions performed.
+        -v --verbose              Show details about actions performed.
+    
+    Actions performed:
+        Paths are shown relative to the root directory.
+        +                         Create a directory
+        $                         Run a command
+        >                         Write a file
+DOC
+
+filepath = Pathname.new args["<filepath>"]
+document = File.new(filepath).read.strip
+data_raw = args["<data>"] || "{}"
+data = YAML.load data_raw, symbolize_names: true
+root_directory = Pathname.new(args["--root"] || "")
+
+fsorg = Fsorg.new root_directory, data, document, Pathname.new(Dir.pwd).join(filepath)
+fsorg.preprocess
+fsorg.walk args["--dry-run"], args["--quiet"], args["--verbose"]

data/lib/fsorg.rb

@@ -1,10 +1,9 @@
-require "docopt"
 require "colorize"
 require "set"
 require "shellwords"
 require "yaml"
 
-PERMISSIONS_PATTERN = /[ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+/
+PERMISSIONS_PATTERN = /[ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=]?[0-7]+/
 
 def d(thing)
   p thing
@@ -21,10 +20,11 @@ class Fsorg
     @data = { :HERE => @root_directory.to_s }.merge data
     @document = document
     @current_line = 0
+    @current_depth = -1
   end
 
-  def relative_to_root(path)
-    File.join(@root_directory, path)
+  def from_relative_to_root(path)
+    @root_directory / path
   end
 
   def depth_change(line)
@@ -38,35 +38,14 @@ class Fsorg
     change
   end
 
-  def self.from_command_line
-    args = Docopt.docopt <<-DOC
-      Usage:
-          fsorg [options] <filepath>
-          fsorg [options] <data> <filepath>
-
-      Options:
-          -h --help                 Show this screen.
-          -v --version              Show version.
-          -r --root=ROOT_DIRECTORY  Set the root directory.
-    DOC
-
-    filepath = Pathname.new args["<filepath>"]
-    document = File.new(filepath).read.strip
-    data_raw = args["<data>"] || "{}"
-    data = YAML.load data_raw, symbolize_names: true
-    root_directory = Pathname.new(args["--root"] || "")
-
-    return Fsorg.new root_directory, data, document, Pathname.new(Dir.pwd).join(filepath)
-  end
-
   def preprocess
     process_front_matter
+    strip_comments
     desugar
     process_includes
     # TODO process_see
     process_for
     process_if
-    turn_writes_into_runs
     turn_puts_into_runs
     ask_missing_variables
     process_root
@@ -103,15 +82,40 @@ class Fsorg
 
   def desugar
     output = []
+    inside_write_directive_shorthand = false
     @document.lines(chomp: true).each_with_index do |line, index|
       @current_line = index + 1
-      if /^\}(\s*ELSE\s*\{)$/.match line
+      if inside_write_directive_shorthand
+        if line.strip == "]"
+          inside_write_directive_shorthand = false
+          output << "}"
+        else
+          output << line
+        end
+      elsif /^\}(\s*ELSE\s*\{)$/.match line.strip
         output << "}"
         output << $~[1]
+      elsif /^FILE\s+(?<filename>.+?)$/ =~ line.strip
+        output << "RUN touch #{filename.shellescape}"
       elsif /^(\s*[^{]+?\{)([^{]+?)\}$/.match line.strip
         output << $~[1]
         output << $~[2]
         output << "}"
+      elsif /^(?<filename>.+?)\s*(\s+\((?<permissions>#{PERMISSIONS_PATTERN.to_s})\))?\s*\[$/.match line.strip
+        output << "WRITE #{$~[:filename]} " + ($~[:permissions] ? "MODE #{$~[:permissions]}" : "") + " {"
+        inside_write_directive_shorthand = true
+      else
+        output << line
+      end
+    end
+    @document = output.join "\n"
+  end
+
+  def strip_comments
+    output = []
+    @document.lines(chomp: true).each_with_index do |line, index|
+      if /^(?<content>.*)#\s.*$/ =~ line
+        output << content
       else
         output << line
       end
@@ -128,7 +132,7 @@ class Fsorg
         filepath = @document_path.parent.join(line.sub /^INCLUDE /, "")
         included_raw = File.new(filepath).read.strip
         included_fsorg = Fsorg.new(@root_directory, @data, included_raw, filepath)
-        included_fsorg.preprocess
+        included_fsorg.preprocess 
         @data = included_fsorg.data.merge @data
         output += included_fsorg.document.lines(chomp: true)
       else
@@ -139,39 +143,9 @@ class Fsorg
     @document = output.join "\n"
   end
 
-  def turn_writes_into_runs
+  def store_writes
     output = []
-    inside_write_directive = false
-    compact = nil
-    current_content = []
-    destination = nil
-    permissions = nil
-
-    @document.lines(chomp: true).each_with_index do |line, index|
-      @current_line = index + 1
-      if inside_write_directive
-        if line.strip == (compact ? "]" : "}")
-          inside_write_directive = false
-          content = deindent(current_content.join("\n")).gsub "\n", '\n'
-          content = content.shellescape.gsub('\{\{', "{{").gsub('\}\}', "}}")
-          output << "RUN" + (destination.include?("/") ? "mkdir -p #{Pathname.new(destination.strip).parent.to_s.shellescape}" : "") + "echo -ne #{content} > #{destination.strip.shellescape}" + (permissions ? " && chmod #{permissions} #{destination.strip.shellescape}" : "")
-        else
-          current_content << line
-        end
-      elsif /^WRITE(\s+INTO)?\s+(?<destination>.+?)(?:\s+MODE\s+(?<permissions>.+?))?\s*\{$/ =~ line.strip
-        inside_write_directive = true
-        compact = false
-      elsif /^(?<destination>.+)(\s*\((?<permissions>#{PERMISSIONS_PATTERN})\))?\s*\[$/ =~ line.strip
-        # Shouldn't be needed, as =~ should assign to destination, but heh, it doesn't work for some reason ¯\_(ツ)_/¯
-        if destination.nil?
-          destination = $~[:destination]
-        end
-        inside_write_directive = true
-        compact = true
-      else
-        output << line
-      end
-    end
+    
 
     @document = output.join "\n"
   end
@@ -181,8 +155,8 @@ class Fsorg
     @document.lines(chomp: true).each_with_index do |line, index|
       @current_line = index + 1
       if /^PUT\s+(?<source>.+?)(\s+AS\s+(?<destination>.+?))?(\s+MODE\s+(?<permissions>.+?))?$/.match(line.strip)
-        output << "RUN install -D \"$FSORG_ROOT/#{$~[:source]}\" #{($~[:destination] || $~[:source]).shellescape}" + (if $~[:permissions]
-          " -D #{$~[:permissions].shellescape}"
+        output << "RUN install -D \"$DOCUMENT_DIR/#{$~[:source]}\" #{($~[:destination] || $~[:source]).shellescape}" + (if $~[:permissions]
+          " -m #{$~[:permissions].shellescape}"
         else
           ""
         end)
@@ -344,29 +318,121 @@ class Fsorg
     @data[:HERE]
   end
 
-  def walk
+  def walk(dry_run, quiet, verbose)
     current_path = [@root_directory]
-    current_path_as_pathname = -> { current_path.reduce(Pathname.new "") { |path, fragment| path.join fragment } }
     @data[:HERE] = @root_directory
+    file_to_write = {}
+    inside_write_directive = -> { !file_to_write.keys.empty? }
+    current_path_as_pathname = -> { current_path.reduce(Pathname.new "") { |path, fragment| path.join fragment } }
+
+    if verbose
+      puts "Data is #{@data.except :HERE}".light_black
+    end
 
     @document.lines(chomp: true).each_with_index do |line, index|
       @current_line = index + 1
-      
+      @current_depth = current_path.length - 1
+
       @data.each do |key, value|
         line = line.gsub "{{#{key}}}", value.to_s
       end
 
-      if /^RUN\s+(?<command>.+?)$/ =~ line.strip
-        puts "run ".colorize(:cyan) + command + " at ".colorize(:blue) + current_location.to_s.colorize(:blue)
-      elsif line.strip == "}"
-        current_path.pop
+      if inside_write_directive.()
+        if line.strip == "}"
+          do_write file_to_write, dry_run, quiet
+          file_to_write = {}
+        else
+          file_to_write[:content] += line + "\n"
+        end
+      elsif /^WRITE(\s+INTO)?\s+(?<destination>.+?)(?:\s+MODE\s+(?<permissions>.+?))?\s*\{$/.match line.strip
+        file_to_write = $~.named_captures.transform_keys(&:to_sym)
+        file_to_write[:content] = ""
       elsif /^(?<leaf>.+?)\s+\{/ =~ line.strip
         current_path << leaf
         @data[:HERE] = current_path_as_pathname.()
-        puts "mk  ".colorize(:cyan) + current_location.to_s
+        if verbose
+          puts "currenly #{current_path.map { |fragment| fragment.to_s }.join " -> "}".light_black
+        end
+        do_mkpath current_location, dry_run, quiet
+      elsif line.strip == "}"
+        current_path.pop
+        @data[:HERE] = current_path_as_pathname.()
+        if verbose
+          puts "currenly #{current_path.map { |fragment| fragment.to_s }.join " -> "}".light_black
+        end
+      elsif /^RUN\s+(?<command>.+?)$/ =~ line.strip
+        environment = {
+          "FSORG_ROOT" => @root_directory.to_s,
+          "HERE" => @data[:HERE].relative_path_from(@root_directory).to_s,
+          "CWD" => Dir.pwd,
+          "DOCUMENT_DIR" => @document_path.parent.to_s,
+        }
+        do_run command, current_location, environment, dry_run, quiet, verbose
+      end
+    end
+  end
+
+  def do_mkpath(path, dry_run, quiet)
+    unless quiet
+      puts "#{"  " * @current_depth}+ ".cyan.bold + path.relative_path_from(@root_directory).to_s
+    end
+    unless dry_run
+      path.mkpath
+    end
+  end
+
+  def do_write(future_file, dry_run, quiet)
+    indentation = "  " * @current_depth
+    dest = from_relative_to_root(current_location) / future_file[:destination]
+    unless dest.parent.relative_path_from(@root_directory).to_s == "."
+      do_mkpath dest.parent, dry_run, quiet
+    end
+
+    unless quiet
+      puts "#{indentation}> ".cyan.bold + dest.relative_path_from(@root_directory).to_s + (future_file[:permissions] ? " mode #{future_file[:permissions]}".yellow : "")
+    end
+    unless dry_run
+      dest.write deindent replace_data future_file[:content]
+      # Not using dest.chmod as the syntax for permissions is more than just integers,
+      # and matches in fact the exact syntax of chmod's argument, per the manpage, chmod(1) (line "Each MODE is of the form…")
+      `chmod #{future_file[:permissions]} #{dest}` if future_file[:permissions]
+    end
+  end
+
+  def replace_data(content)
+    content.gsub /\{\{(?<variable>[^}]+?)\}\}/ do |interpolation| 
+      variable = interpolation[2..-3]
+      @data[variable.to_sym] 
+    end
+  end
+
+  def do_run(command, inside, environment, dry_run, quiet, verbose)
+    indentation = "  " * @current_depth
+    unless quiet
+      puts "#{indentation}$ ".cyan.bold + command + (verbose ? " at #{inside.relative_path_from(@root_directory)}".light_blue + " with ".light_black + (format_environment_hash environment) : "")
+    end
+    unless dry_run
+      stdout, stdout_w = IO.pipe
+      stderr, stderr_w = IO.pipe
+
+      system environment, command, { :chdir => inside.to_s, :out => stdout_w, :err => stderr_w }
+      stdout_w.close
+      stderr_w.close
+
+      stdout.read.each_line(chomp: true) do |line|
+        puts "  " + indentation + line
+      end
+      stderr.read.each_line(chomp: true) do |line|
+        puts "  " + indentation + line.red
       end
     end
   end
+
+  def format_environment_hash(environment)
+    "{ ".light_black + (environment.map do |key, value|
+      "$#{key}".red + "=".light_black + "\"#{value}\"".green
+    end.join ", ".light_black) + " }".light_black
+  end
 end
 
 def deindent(text)
@@ -386,6 +452,14 @@ def deindent(text)
   end.join "\n"
 end
 
-fsorg = Fsorg.from_command_line
-fsorg.preprocess
-fsorg.walk
+def capture_output
+  old_stdout = $stdout
+  old_stderr = $stderr
+  $stdout = StringIO.new
+  $stderr = StringIO.new
+  yield
+  return $stdout.string, $stderr.string
+ensure
+  $stdout = old_stdout
+  $stderr = old_stderr
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fsorg
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ewen Le Bihan
@@ -9,7 +9,63 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2022-04-27 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shellwords
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
 description:
 email: hey@ewen.works
 executables:
@@ -31,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="