MuranoCLI 3.0.0 → 3.0.1

data/lib/MrMurano/Solution-Users.rb

@@ -1,4 +1,4 @@
-# Last Modified: 2017.08.17 /coding: utf-8
+# Last Modified: 2017.08.22 /coding: utf-8
 # frozen_string_literal: true
 
 # Copyright © 2016-2017 Exosite LLC.
@@ -34,11 +34,13 @@ module MrMurano
     end
 
     def remove(id)
+      return unless remove_item_allowed(id)
       delete('/' + id.to_s)
     end
 
     # @param modify Bool: True if item exists already and this is changing it
     def upload(_local, remote, _modify)
+      return unless upload_item_allowed(remote[@itemkey])
       # Roles cannot be modified, so must delete and post.
       delete('/' + remote[@itemkey]) do |request, http|
         response = http.request(request)
@@ -59,9 +61,6 @@ module MrMurano
       # for now, we'll read, modify, write
       here = []
       if local.exist?
-        # FIXME/2017-07-18: Security/YAMLLoad: Prefer using YAML.safe_load over YAML.load.
-        #   Disabling [rubo]cop for now.
-        # rubocop:disable Security/YAMLLoad
         local.open('rb') { |io| here = YAML.load(io) }
         here = [] if here == false
       end
@@ -69,6 +68,7 @@ module MrMurano
         Hash.transform_keys_to_symbols(i)[@itemkey] == item[@itemkey]
       end
       here << item.reject { |k, _v| %i[synckey synctype].include? k }
+      return unless download_item_allowed(item[@itemkey])
       local.open('wb') do |io|
         io.write here.map { |i| Hash.transform_keys_to_strings(i) }.to_yaml
       end
@@ -79,7 +79,6 @@ module MrMurano
       # for now, we'll read, modify, write
       here = []
       if local.exist?
-        # FIXME/2017-07-18: Security/YAMLLoad: Prefer using YAML.safe_load over YAML.load.
         local.open('rb') { |io| here = YAML.load(io) }
         here = [] if here == false
       end
@@ -87,6 +86,7 @@ module MrMurano
       here.delete_if do |it|
         Hash.transform_keys_to_symbols(it)[key] == item[key]
       end
+      return unless removelocal_item_allowed(item[key])
       local.open('wb') do |io|
         io.write here.map { |i| Hash.transform_keys_to_strings(i) }.to_yaml
       end
@@ -109,7 +109,6 @@ module MrMurano
 
       # MAYBE/2017-07-03: Do we care if there are duplicate keys in the yaml? See dup_count.
       here = []
-      # FIXME/2017-07-18: Security/YAMLLoad: Prefer using YAML.safe_load over YAML.load.
       from.open { |io| here = YAML.load(io) }
       here = [] if here == false
 
@@ -152,10 +151,11 @@ module MrMurano
     end
 
     # @param modify Bool: True if item exists already and this is changing it
-    def upload(_local, _remote, _modify)
+    def upload(local, _remote, _modify)
       # TODO: figure out APIs for updating users.
       warning %(Updating Users is not yet implemented.)
       # post does work if the :password field is set.
+      return unless upload_item_allowed(local)
     end
 
     def synckey(item)

data/lib/MrMurano/Solution.rb

@@ -1,4 +1,4 @@
-# Last Modified: 2017.08.17 /coding: utf-8
+# Last Modified: 2017.08.23 /coding: utf-8
 # frozen_string_literal: true
 
 # Copyright © 2016-2017 Exosite LLC.
@@ -96,7 +96,7 @@ module MrMurano
             #query.push ['limit', 20]
             query.push ['offset', total - remaining]
           elsif remaining != 0
-            warning "Unexpected: negative remaining: ‘#{total}’"
+            warning "Unexpected: negative remaining: #{fancy_ticks(total)}"
             remaining = 0
           end
           if aggregate.nil?
@@ -127,6 +127,8 @@ module MrMurano
       #     the results.
       #path = path || '?select=id,service'
       matches = list(path)
+      # 2017-08-21: The only caller so far is the link command,
+      #   which passes the Solution ID as svc_name.
       matches.select { |match| match[:service] == svc_name }
     end
 
@@ -240,23 +242,35 @@ module MrMurano
         end
       end
       unless @sid.to_s.empty? || sid.to_s == @sid.to_s
-        warning "#{type_name} ID mismatch. Server says ‘#{sid}’, but config says ‘#{@sid}’."
+        warning(
+          "#{type_name} ID mismatch. Server says #{fancy_ticks(sid)}, " \
+          "but config says #{fancy_ticks(@sid)}."
+        )
       end
       self.sid = sid
       # Verify/set the name.
       unless @name.to_s.empty? || @meta[:name].to_s == @name.to_s
-        warning "Name mismatch. Server says ‘#{@meta[:name]}’, but config says ‘#{@name}’."
+        warning(
+          "Name mismatch. Server says #{fancy_ticks(@meta[:name])}, " \
+          "but config says #{fancy_ticks(@name)}."
+        )
       end
       if !@meta[:name].to_s.empty?
         set_name(@meta[:name])
         unless @valid_name || type == :solution
-          warning "Unexpected: Server returned invalid name: ‘#{@meta[:name]}’"
+          warning(
+            "Unexpected: Server returned invalid name: #{fancy_ticks(@meta[:name])}"
+          )
         end
       elsif @meta[:domain]
         # This could be a pre-ADC/pre-Murano business.
-        warning "Unexpected: Server returned no name for domain: ‘#{@meta[:domain]}’"
+        warning(
+          "Unexpected: Server returned no name for domain: #{fancy_ticks(@meta[:domain])}"
+        )
       else
-        warning "Unexpected: Server returned no name for solution: ‘#{@meta}’"
+        warning(
+          "Unexpected: Server returned no name for solution: #{fancy_ticks(@meta)}"
+        )
       end
     end
 
@@ -322,7 +336,7 @@ module MrMurano
       if @name.to_s.empty?
         ''
       else
-        "‘#{@name}’"
+        fancy_ticks(@name)
       end
     end
 

data/lib/MrMurano/SolutionId.rb

@@ -1,14 +1,18 @@
-# Last Modified: 2017.08.17 /coding: utf-8
+# Last Modified: 2017.08.23 /coding: utf-8
 # frozen_string_literal: true
 
 # Copyright © 2016-2017 Exosite LLC.
 # License: MIT. See LICENSE.txt.
 #  vim:tw=0:ts=2:sw=2:et:ai
 
+require 'MrMurano/verbosing'
+
 module MrMurano
   module SolutionId
     INVALID_SID = '-1'
-    UNEXPECTED_TYPE_OR_ERROR_MSG = 'Unexpected result type or error: assuming empty instead'
+    UNEXPECTED_TYPE_OR_ERROR_MSG = (
+      'Unexpected result type or error: assuming empty instead'
+    )
 
     attr_reader :sid
     attr_reader :valid_sid
@@ -41,7 +45,9 @@ module MrMurano
 
     def sid=(sid)
       sid = INVALID_SID if sid.nil? || !sid.is_a?(String) || sid.empty?
-      @valid_sid = false if sid.to_s.empty? || sid == INVALID_SID || (defined?(@sid) && sid != @sid)
+      if sid.to_s.empty? || sid == INVALID_SID || (defined?(@sid) && sid != @sid)
+        @valid_sid = false
+      end
       @sid = sid
       # MAGIC_NUMBER: The 2nd element is the solution ID, e.g., solution/<sid>/...
       raise "Unexpected @uriparts_sidex #{@uriparts_sidex}" unless @uriparts_sidex == 1
@@ -65,7 +71,7 @@ module MrMurano
     def endpoint(_path='')
       # This is hopefully just a DEV error, and not something user will ever see!
       return unless @uriparts[@uriparts_sidex] == INVALID_SID
-      error("Solution ID missing! Invalid ‘#{@solntype}’")
+      error("Solution ID missing! Invalid #{MrMurano::Verbose.fancy_ticks(@solntype)}")
       exit 2
     end
   end

data/lib/MrMurano/SubCmdGroupContext.rb

@@ -1,16 +1,23 @@
+# Last Modified: 2017.08.21 /coding: utf-8
+# frozen_string_literal: true
+
+# Copyright © 2016-2017 Exosite LLC.
+# License: MIT. See LICENSE.txt.
+#  vim:tw=0:ts=2:sw=2:et:ai
 
 module MrMurano
   class SubCmdGroupHelp
-    attr :name, :description
+    attr_reader :description
+    attr_reader :name
 
     def initialize(command)
       @name = command.syntax.to_s
       @description = command.description.to_s
       @runner = ::Commander::Runner.instance
       prefix = /^#{command.name.to_s} /
-      cmds = @runner.instance_variable_get(:@commands).select{|n,_| n.to_s =~ prefix}
+      cmds = @runner.instance_variable_get(:@commands).select { |n, _| n.to_s =~ prefix }
       @commands = cmds
-      als = @runner.instance_variable_get(:@aliases).select{|n,_| n.to_s =~ prefix}
+      als = @runner.instance_variable_get(:@aliases).select { |n, _| n.to_s =~ prefix }
       @aliases = als
 
       @options = {}
@@ -24,6 +31,8 @@ module MrMurano
         @description
       when :help
         nil
+      # rubocop:disable Style/EmptyElse: "Redundant else-clause."
+      # Rubocop seems incorrect about this one.
       else
         nil
       end
@@ -37,6 +46,8 @@ module MrMurano
       @commands[name.to_s]
     end
 
+    # rubocop:disable Style/AccessorMethodName
+    # "Do not prefix reader method names with get_."
     def get_help
       hf = @runner.program(:help_formatter).new(self)
       pc = Commander::HelpFormatter::ProgramContext.new(self).get_binding
@@ -45,5 +56,3 @@ module MrMurano
   end
 end
 
-
-#  vim: set ai et sw=2 ts=2 :

data/lib/MrMurano/SyncAllowed.rb

@@ -0,0 +1,42 @@
+# Last Modified: 2017.08.23 /coding: utf-8
+# frozen_string_literal: true
+
+# Copyright © 2016-2017 Exosite LLC.
+# License: MIT. See LICENSE.txt.
+#  vim:tw=0:ts=2:sw=2:et:ai
+
+#require 'MrMurano/progress'
+#require 'MrMurano/verbosing'
+#require 'MrMurano/hash'
+
+module MrMurano
+  module SyncAllowed
+    def sync_item_allowed(actioning, item_name)
+      if $cfg['tool.dry']
+        MrMurano::Verbose.whirly_interject do
+          say("--dry: Not #{actioning} item: #{fancy_ticks(item_name)}")
+        end
+        false
+      else
+        true
+      end
+    end
+
+    def remove_item_allowed(id)
+      sync_item_allowed('removing', id)
+    end
+
+    def upload_item_allowed(id)
+      sync_item_allowed('uploading', id)
+    end
+
+    def download_item_allowed(id)
+      sync_item_allowed('downloading', id)
+    end
+
+    def removelocal_item_allowed(id)
+      sync_item_allowed('removing-local', id)
+    end
+  end
+end
+

data/lib/MrMurano/SyncUpDown.rb

@@ -1,4 +1,4 @@
-# Last Modified: 2017.08.18 /coding: utf-8
+# Last Modified: 2017.08.23 /coding: utf-8
 # frozen_string_literal: true
 
 # Copyright © 2016-2017 Exosite LLC.
@@ -18,6 +18,7 @@ require 'MrMurano/verbosing'
 require 'MrMurano/hash'
 #require 'MrMurano/Config'
 #require 'MrMurano/ProjectFile'
+require 'MrMurano/SyncAllowed'
 ##require 'MrMurano/SyncRoot'
 
 module MrMurano
@@ -27,6 +28,8 @@ module MrMurano
   # pulling those things.
   #
   module SyncUpDown
+    include SyncAllowed
+
     # This is one item that can be synced.
     class Item
       # @return [String] The name of this item.
@@ -49,8 +52,6 @@ module MrMurano
       attr_accessor :synckey
       # @return [String] The syncable type.
       attr_accessor :synctype
-      # @return [String] For device2, the event type.
-      attr_accessor :type
       # @return [String] The updated_at time from the server is used to detect changes.
       attr_accessor :updated_at
       # @return [Integer] Positive if multiple conflicting files found for same item.
@@ -295,11 +296,10 @@ module MrMurano
     # @param local [Pathname] Full path of where to download to
     # @param item [Item] The item to download
     def download(local, item)
-#      if item[:bundled]
-#        warning "Not downloading into bundled item #{synckey(item)}"
-#        return
-#      end
-      local.dirname.mkpath
+      #if item[:bundled]
+      #  warning "Not downloading into bundled item #{synckey(item)}"
+      #  return
+      #end
       id = item[@itemkey.to_sym]
       if id.nil?
         debug "!!! Missing '#{@itemkey}', using :id instead!"
@@ -307,9 +307,14 @@ module MrMurano
         id = item[:id]
         raise "Both #{@itemkey} and id in item are nil!" if id.nil?
       end
+
+      relpath = local.relative_path_from(Pathname.pwd).to_s
+      return unless download_item_allowed(relpath)
+
+      local.dirname.mkpath
       local.open('wb') do |io|
         fetch(id) do |chunk|
-          io.write chunk
+          io.write config_vars_encode chunk
         end
       end
       update_mtime(local, item)
@@ -390,6 +395,7 @@ module MrMurano
     # @param dest [Pathname] Full path of item to be removed
     # @param item [Item] Full details of item to be removed
     def removelocal(dest, _item)
+      return unless removelocal_item_allowed(dest)
       dest.unlink if dest.exist?
     end
 
@@ -408,7 +414,9 @@ module MrMurano
     end
 
     def diff_item_write(io, merged, _local, _remote)
-      io << merged[:local_path].read
+      contents = merged[:local_path].read
+      contents = config_vars_decode(contents)
+      io << contents
     end
 
     #
@@ -458,33 +466,36 @@ module MrMurano
         # Get a list of SyncUpDown::Item's, or a class derived thereof.
         bitems = localitems(location)
         # Use synckey for quicker merging.
-        # 2017-07-02: Argh. If two files have the same identity, this
-        # simple loop masks that there are two files with the same identity!
         #bitems.each { |b| items[synckey(b)] = b }
-        warns = {}
+        # 2017-07-02: If two files have the same identity, the simple loop
+        #   masks that there are two files with the same identity. So check
+        #   first for duplicates, and then process each item.
+        seen = {}
         bitems.each do |item|
           skey = synckey(item)
-          if items.key? skey
-            warns[skey] = 0 unless warns.key?(skey)
-            if warns[skey].zero?
-              items[skey][:dup_count] = warns[skey]
-              # The dumb_synckey is just so we don't overwrite the
-              # original item, or other duplicates, in the hash.
-              dumb_synckey = "#{skey}-#{warns[skey]}"
-              # This just sets the alias for the output, so duplicates look unique.
-              item[@itemkey.to_sym] = dumb_synckey
-              # Don't delete the original item, so that other dupes see it.
-              #items.delete(skey)
-              msg = "Duplicate local file(s) found for ‘#{skey}’"
-              msg += " for ‘#{self.class.description}’" if self.class.description.to_s != ''
-              #msg += '!'
-              warning(msg)
+          seen[skey] = seen.key?(skey) && seen[skey] + 1 || 1
+        end
+        counts = {}
+        bitems.each do |item|
+          skey = synckey(item)
+          if seen[skey] > 1
+            if items[skey].nil?
+              items[skey] = MrMurano::EventHandler::EventHandlerItem.new(item)
+              items[skey][:dup_count] = 0
             end
-            warns[skey] += 1
-            item[:dup_count] = warns[skey]
-            dumb_synckey = "#{skey}-#{warns[skey]}"
-            item[@itemkey.to_sym] = dumb_synckey
-            items[dumb_synckey] = item
+            counts[skey] = counts.key?(skey) && counts[skey] + 1 || 1
+            # Use a unique synckey so all duplicates make it in the list.
+            uniq_synckey = "#{skey}-#{counts[skey]}"
+            item[:dup_count] = counts[skey]
+            # This sets the alias for the output, so duplicates look unique.
+            item[@itemkey.to_sym] = uniq_synckey
+            items[uniq_synckey] = item
+            msg = "Duplicate definition found for #{fancy_ticks(skey)}"
+            if self.class.description.to_s != ''
+              msg += " for #{fancy_ticks(self.class.description)}"
+            end
+            warning(msg)
+            warning(" #{item.local_path}")
           else
             items[skey] = item
           end
@@ -495,9 +506,10 @@ module MrMurano
           # MEH/2017-07-31: This message is a little misleading on syncdown,
           #   e.g., in rspec ./spec/cmd_syncdown_spec.rb, one test blows away
           #   local directories and does a syncdown, and on stderr you'll see
-          #     Skipping missing location ‘/tmp/d20170731-3150-1f50uj4/project/specs/resources.yaml’ (Resources)
+          #     Skipping missing location
+          #      ‘/tmp/d20170731-3150-1f50uj4/project/specs/resources.yaml’ (Resources)
           #   but then later in the syncdown, that directory and file gets created.
-          msg = "Skipping missing location ‘#{location}’"
+          msg = "Skipping missing location #{fancy_ticks(location)}"
           unless self.class.description.to_s.empty?
             msg += " (#{Inflecto.pluralize(self.class.description)})"
           end
@@ -605,7 +617,21 @@ module MrMurano
         pattern = pattern.gsub(%r{^\*\*\/}, '')
       end
 
-      ::File.fnmatch(pattern, path)
+      ignore = ::File.fnmatch(pattern, path)
+      debug "Excluded #{path}" if ignore
+      ignore
+    end
+
+    def resolve_config_var_usage!(there, local)
+      # pass; derived classes should implement.
+    end
+
+    def config_vars_decode(script)
+      script
+    end
+
+    def config_vars_encode(script)
+      script
     end
 
     #######################################################################
@@ -669,16 +695,11 @@ module MrMurano
 
     def syncup_item(item, options, action, verbage)
       if options[action]
-        if !$cfg['tool.dry']
-          prog_msg = "#{verbage.capitalize} item #{item[:synckey]}"
-          prog_msg += " (#{item[:synctype]})" if $cfg['tool.verbose']
-          sync_update_progress(prog_msg)
-          yield item
-        else
-          MrMurano::Verbose.whirly_interject do
-            say("--dry: Not #{verbage.downcase} item #{item[:synckey]}")
-          end
-        end
+        # It's up to the callback to check and honor $cfg['tool.dry'].
+        prog_msg = "#{verbage.capitalize} item #{item[:synckey]}"
+        prog_msg += " (#{item[:synctype]})" if $cfg['tool.verbose']
+        sync_update_progress(prog_msg)
+        yield item
       elsif $cfg['tool.verbose']
         MrMurano::Verbose.whirly_interject do
           say("--no-#{action}: Not #{verbage.downcase} item #{item[:synckey]}")
@@ -734,15 +755,11 @@ module MrMurano
 
     def syncdown_item(item, into, options, action, verbage)
       if options[action]
-        if !$cfg['tool.dry']
-          prog_msg = "#{verbage.capitalize} item #{item[:synckey]}"
-          prog_msg += " (#{item[:synctype]})" if $cfg['tool.verbose']
-          sync_update_progress(prog_msg)
-          dest = tolocalpath(into, item)
-          yield dest, item
-        else
-          say("--dry: Not #{verbage.downcase} item #{item[:synckey]}")
-        end
+        prog_msg = "#{verbage.capitalize} item #{item[:synckey]}"
+        prog_msg += " (#{item[:synctype]})" if $cfg['tool.verbose']
+        sync_update_progress(prog_msg)
+        dest = tolocalpath(into, item)
+        yield dest, item
       elsif $cfg['tool.verbose']
         say("--no-#{action}: Not #{verbage.downcase} item #{item[:synckey]}")
       end
@@ -760,7 +777,7 @@ module MrMurano
       tlcl = Tempfile.new([tolocalname(merged, @itemkey) + '_local_', '.lua'])
       Pathname.new(tlcl.path).open('wb') do |io|
         if merged.key?(:script)
-          io << merged[:script]
+          io << config_vars_decode(merged[:script])
         else
           # For most items, read the local file.
           # For resources, it's a bit trickier.
@@ -864,15 +881,25 @@ module MrMurano
 
       tomod, unchg = items_mods_and_chgs(options, therebox, localbox)
 
+      clash = items_cull_clashes!([toadd, todel, tomod, unchg])
+
       if options[:unselected]
-        { toadd: toadd, todel: todel, tomod: tomod, unchg: unchg, skipd: [] }
+        {
+          toadd: toadd,
+          todel: todel,
+          tomod: tomod,
+          unchg: unchg,
+          skipd: [],
+          clash: clash,
+        }
       else
         {
-          toadd: toadd.select { |i| i[:selected] }.map { |i| i.delete(:selected); i },
-          todel: todel.select { |i| i[:selected] }.map { |i| i.delete(:selected); i },
-          tomod: tomod.select { |i| i[:selected] }.map { |i| i.delete(:selected); i },
-          unchg: unchg.select { |i| i[:selected] }.map { |i| i.delete(:selected); i },
+          toadd: select_selected(toadd),
+          todel: select_selected(todel),
+          tomod: select_selected(tomod),
+          unchg: select_selected(unchg),
           skipd: [],
+          clash: select_selected(clash),
         }
       end
     end
@@ -928,7 +955,7 @@ module MrMurano
         skip_sol = true if tested && !passed
       end
       return nil unless skip_sol
-      ret = { toadd: [], todel: [], tomod: [], unchg: [], skipd: [] }
+      ret = { toadd: [], todel: [], tomod: [], unchg: [], skipd: [], clash: [] }
       ret[:skipd] << { synckey: self.class.description }
       ret
     end
@@ -945,8 +972,11 @@ module MrMurano
     def items_lists(options, selected)
       # Fetch arrays of items there, and items here/local.
       there = list
-      there = _matcher(there, selected)
       local = locallist(skip_warn: options[:skip_missing_warning])
+
+      resolve_config_var_usage!(there, local)
+
+      there = _matcher(there, selected)
       local = _matcher(local, selected)
 
       therebox = {}
@@ -960,10 +990,12 @@ module MrMurano
       local.each do |item|
         skey = synckey(item)
         # 2017-07-02: Check for local duplicates.
-        skey += "-#{item[:dup_count]}" unless item[:dup_count].nil?
+        unless item[:dup_count].nil? || item[:dup_count].zero?
+          skey += "-#{item[:dup_count]}"
+        end
         item[:synckey] = skey
         item[:synctype] = self.class.description
-        localbox[item[:synckey]] = item
+        localbox[skey] = item
       end
 
       # Some items are considered "undeletable", meaning if a
@@ -990,6 +1022,8 @@ module MrMurano
       unchg = []
 
       (localbox.keys & therebox.keys).each do |key|
+        # Skip this item if it's got duplicate conflicts.
+        next if !localbox[key].is_a?(Hash) && localbox[key].dup_count == 0
         # Want 'local' to override 'there' except for itemkey.
         if options[:asdown]
           mrg = therebox[key].reject { |k, _v| k == @itemkey.to_sym }
@@ -1021,6 +1055,29 @@ module MrMurano
         list.sort_by(&:name)
       end
     end
+
+    def select_selected(items)
+      items.select { |i| i[:selected] }.map { |i| i.delete(:selected); i }
+    end
+
+    def items_cull_clashes!(items_list)
+      items_list = [items_list] unless items_list.is_a?(Array)
+      clash = []
+      items_list.each do |items|
+        items.select! do |item|
+          if item[:dup_count].nil?
+            true
+          elsif item[:dup_count].zero?
+            # This is the control item.
+            false
+          else
+            clash.push(item)
+            false
+          end
+        end
+      end
+      clash
+    end
   end
 end