pad_utils 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 670f14eb8e988c3a250ef6968c75d43255afe3dc
-  data.tar.gz: 794a1ff4059c81f06cf53cc4d707c73146493ceb
+  metadata.gz: 46369e29476640a59df9f7c0a8ac5864bbc24361
+  data.tar.gz: c5a3ac14efe6a8d7700c0afc3e0420ecbe986cc2
 SHA512:
-  metadata.gz: e9967be3fb3dda66afa9328fb4702f13512a14f14557a60432a5bcc638410e76cf4f421b54b776ed621c43beca1c2e2c0a502bc766e00105d83aae9e917580a8
-  data.tar.gz: cc4ec2ca116fc036c0786ef5aaf1159ff715dd59d44656dce9b7ad62842875818ee9313a5435c66206cef7535598a67206b4998130d25d49a876a301748dcf1b
+  metadata.gz: 2da2c9f8d35ec72b2246a398f4560e8b94fe010190c6f7a61f3b7b9680a5f76772145e2474e040c4cf8fc407a504ea3aac9a99b6e9e5e3d880fb076e575c880a
+  data.tar.gz: 0fa3dd9e8a963b0e8fff13bae15a1816fc6a8a0f9ed1a479784bf40b65573f31cf9fb431764387cc50b65d4afe7026516ca1ec810233f3da3449770d750baaad

data/lib/pad_utils/pad_text.rb

@@ -90,8 +90,113 @@ module PadUtils
     PadUtils.log("Error replacing #{old_text} in #{file} with #{new_text}", e)
   end
 
-  # TODO: A method to get the value of an option. E.g. get :foo from Config.Bar = :foo inside a file.
-  # TODO: A method to set the value of an option in a file. Change the value if it exists, create it if it doesn't.
+  # Gets a value from a Ruby config file.
+  #
+  # *This method is some kind of UFO but it is heavily used in Padstone.
+  #   It is made to retrieve the value inside a Rails config file or initializer
+  #   such as getting the value of `config.eager_load` in `production.rb`.
+  #   Everything gets returned as a string or as nil if not found.*
+  #
+  # Will log errors using {PadUtils.log PadUtils.log}.
+  #
+  # @param key [String] the config key to look for
+  # @param file [String] the file path and name containing the key
+  # @return [String, nil] the value returned as a string or nil
+  # @example
+  #   PadUtils.get_config_value("config.eager_load", "production.rb") # => 'true'
+  def self.get_config_value(key, file)
+    content = PadUtils.get_file_content(file)
+    content.each_line do |line|
+      if line.strip.start_with? key
+        return line.gsub(key, "").gsub("=","").strip
+      end
+    end
+    nil
+  rescue Exception => e
+    PadUtils.log("Error in get_config_value", e)
+  end
+
+  # Sets a value in a Ruby config file.
+  #
+  # *This is another method typically used by Padstone to write
+  #   new config values in Rails config files such as `production.rb` or
+  #   overwrite existing ones.*
+  #
+  # Will log errors using {PadUtils.log PadUtils.log}.
+  #
+  # @param key [String] the config key to find (or create)
+  # @param value [String] the value to set
+  # @param file [String] the file path and name of the file to overwrite
+  # @param comment [String] the optional comment to add before the key
+  # @return [Void] nothing
+  # @example
+  #   key = "config.assets.digest"
+  #   value = "false"
+  #   file = "production.rb"
+  #   PadUtils.set_config_value(key, value, file, "Overwritten with PadUtils")
+  def self.set_config_value(key, value, file, comment = nil)
+    # read the config file
+    content = PadUtils.get_file_content(file)
+
+    # set some vars
+    found = false
+    new_content = ""
+
+    # for each line in the file, check if one contains the key.
+    # If the key is found, get its position so we can indent the
+    # config line properly.
+    content.each_line do |line|
+      position = line.index(key)
+      if position != nil
+        new_line = ""
+        (0..position - 1).each do |p|
+          new_line << " "
+        end
+        if comment != nil
+          new_content << "#{new_line}# #{comment}\n"
+        end
+        new_content << "#{new_line}#{key} = #{value}\n"
+        found = true
+      else
+        new_content << line
+      end
+    end
+
+    # If the config key was not found, we'll insert it before the last end,
+    # indented with two spaces
+    if !found
+      PadUtils.insert_before_last(original: file, tag: 'end', text: "\n\n  # #{comment == nil ? key : comment}\n  #{key} = #{value}\n")
+    else
+      PadUtils.write_to_file(file, new_content)
+    end
+  rescue Exception => e
+    PadUtils.log("Error in set_config_value", e)
+  end
+
+  # Replaces a line in a file containing a specific value.
+  #
+  # Will log errors using {PadUtils.log PadUtils.log}.
+  #
+  # @param value [String] the value to search for in a line
+  # @param in_file [String] the file path and name where to search
+  # @param new_value [String] the value replacing the line
+  # @return [Void] nothing
+  # @example
+  #   PadUtils.replace_line_containing("Config.port", in_file: "config.rb", new_value: "Config.port = 232")
+  def self.replace_line_containing(value, in_file: nil, new_value: nil)
+    content = PadUtils.get_file_content(in_file)
+    new_content = ""
+    content.each_line do |line|
+      if line.include? value
+        new_content << "#{new_value}\n"
+      else
+        new_content << line
+      end
+    end
+    PadUtils.write_to_file(in_file, new_content)
+  rescue Exception => e
+    PadUtils.log("Error in replace_line_containing", e)
+  end
 
   # Inserts text before the first occurence of a string.
   #

data/lib/pad_utils/version.rb

@@ -1,4 +1,4 @@
 module PadUtils
   # PadUtils version number
-  VERSION = "1.3.1"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pad_utils
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Nico Schuele