pad_utils 1.1.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6939b46b2b13a5954d87a24eebe598fd044e4af
-  data.tar.gz: 4d803c5b1fac23443d42b84e15a4e4b0e14d2dc3
+  metadata.gz: 0d994307acebee505edfb95deac3c785681b8595
+  data.tar.gz: 84663dbf244c403d7f20cb105b9756d7f2ccff44
 SHA512:
-  metadata.gz: 2f759bb5c6e0e96b5ce794df6301cf3cb3bd2002451a652680a799e1e4e48a5eda6081c328fdf78d5803dc3eef9979e3375ad24bd748f4c9bdfad1d78983c0b4
-  data.tar.gz: 64ef8ed6c014074b66c5eb63fc55cec26f2706e1c41aad78cc384ad9ebedb320319e30af515fa39a3fac627ea93a04b934238bd8676df4ef39725e04cfa0eb0f
+  metadata.gz: 1e350721bb28b31c559e34ac7ee2e728af50337a5624c5757cb61bfac56a57a66c0f3c4b924d4b61cf17944311bdeaa94e170b3003a55021eca2fbd54c0d697e
+  data.tar.gz: c91c8147eda9bda2bcd6888375a382a78698f1d6dfaff5c1c62cbef94981b75704befe0ad38928e7a95888641069b22ed273075d2d84f6f6981cc029cc762113

data/README.md

@@ -2,18 +2,22 @@
 
 PadUtils is a simple gem containing common utilities and shortcuts. It is used in the [Padstone](http://padstone.io) app builder but can be embedded in any other Ruby project.
 
+
 ## Installation
 
 It's a Ruby gem. Install it like any other gem!
 
 `gem install pad_utils`
 
+
 ## Usage
 
 Just `require 'pad_utils'` within your code to access the following methods.
 
+
 ### Build CLI menus
 
+
 #### 1. Yes/No menu
 
 Prompt user with a cli yes/no menu. Returns `true` or `false`.
@@ -23,12 +27,14 @@ Prompt user with a cli yes/no menu. Returns `true` or `false`.
 
 `PadUtils.yes_no_menu(question: "Question?", default: "y")`
 
+
 #### 2. Open question menu
 
 Prompt user with a cli open question menu. Returns a `string`.
 
 `PadUtils.question_menu(question)`
 
+
 #### 3. Multiple choice menu
 
 Prompt user with a multiple choice menu. Returns a `symbol`.
@@ -42,25 +48,36 @@ Prompt user with a multiple choice menu. Returns a `symbol`.
 
 ### Work with text
 
+
 #### 1. Convert a string to a Rubified name
 
 Convert a string into a proper "rubified" name. For example, 'app_name' will be converted to 'AppName'. Returns a `string`.
 
 `PadUtils.convert_to_ruby_name(value)`
 
-#### 2. Sanitize a string
+
+#### 2. Convert CamelCase to camel_case (underscores)
+
+Convert a `CamelCase` word to an underscored one, e.g. `camel_case`. Taken from the Rails [Inflector](http://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-underscore) class. Returns a `string`.
+
+`PadUtils.underscore(val)`
+
+
+#### 3. Sanitize a string
 
 Sanitize a string by replacing special characters (including spaces) with underscores. Returns a `string`.
 
 `PadUtils.sanitize(value)`
 
-#### 3. Replace a string in a file
+
+#### 4. Replace a string in a file
 
 Replace text within a file. `old_text` can either be a `string` or a `regex`. Doesn't return anything, overwrites `file`.
 
 `PadUtils.replace_in_file(file, old_text, new_text)`
 
-#### 4. Insert text before first occurence
+
+#### 5. Insert text before first occurence
 
 Insert text in a string or a file before the first occurence of a string. Returns a `string`. If `is_file` is `true`, overwrites `original` file.
 
@@ -71,7 +88,8 @@ Insert text in a string or a file before the first occurence of a string. Return
 
 `PadUtils.insert_before_first(original: nil, tag: nil, text: nil, is_file: true)`
 
-#### 5. Insert text before last occurence
+
+#### 6. Insert text before last occurence
 
 Insert text in a string or a file before the last occurence of a string. Returns a `string`. If `is_file` is `true`, overwrites `original` file.
 
@@ -82,7 +100,8 @@ Insert text in a string or a file before the last occurence of a string. Returns
 
 `PadUtils.insert_before_last(original: nil, tag: nil, text: nil, is_file: true)`
 
-#### 6. Insert text after first occurence
+
+#### 7. Insert text after first occurence
 
 Insert text in a string or a file after the first occurence of a string. Returns a `string`. If `is_file` is `true`, overwrites `original` file.
 
@@ -93,7 +112,8 @@ Insert text in a string or a file after the first occurence of a string. Returns
 
 `PadUtils.insert_after_first(original: nil, tag: nil, text: nil, is_file: true)`
 
-#### 7. Insert text after last occurence
+
+#### 8. Insert text after last occurence
 
 Insert text in a string or a file after the last occurence of a string. Returns a `string`. If `is_file` is `true`, overwrites `original` file.
 
@@ -104,28 +124,33 @@ Insert text in a string or a file after the last occurence of a string. Returns
 
 `PadUtils.insert_after_last(original: nil, tag: nil, text: nil, is_file: true)`
 
+
 ### JSON and Hash
 
 Few methods to convert JSON to deep symbolized hash and back.
 
+
 #### 1. Symbolize all keys in a hash
 
 Convert all keys and sub-keys to symbols in a hash. Emulates the `deep_symbolize_keys` found in [Rails](http://apidock.com/rails/Hash/deep_symbolize_keys). Returns a `Hash`.
 
 `PadUtils.deep_symbolize_hash_keys(hash)`
 
+
 #### 2. Convert a JSON string to a symbolized hash
 
 Returns a `Hash`.
 
 `PadUtils.json_to_hash(json)`
 
+
 #### 3. Load a JSON file and convert it to a symbolized hash
 
 Returns a `Hash`.
 
 `PadUtils.json_file_to_hash(json_filename)`
 
+
 #### 4. Convert a hash to JSON
 
 *Alias method on `to_json` for consistency.*
@@ -134,72 +159,85 @@ Returns a `string`.
 
 `PadUtils.hash_to_json(hash)`
 
+
 #### 5. Write a hash to a JSON file
 
 Returns the file content as a `string`.
 
 `PadUtils..hash_to_json_file(filename, hash)`
 
+
 ### Work with files
 
 Mostly, these are convenience methods aliasing existing Ruby methods. Implemented for consistency.
 
+
 #### 1. Delete a file
 
 Delete a file. If not found, doesn't raise any error.
 
 `delete_file(file_path)`
 
+
 #### 2. Does a file exist?
 
 Returns `true` or `false`.
 
 `PadUtils.file_exist?(file_path)`
 
+
 #### 3. Copy a file
 
 **Will override file if it already exists!**
 
 `PadUtils.copy_file(file_path, dest_dir)`
 
+
 #### 4. Move a file
 
 **Will not throw an error if original file doesn't exist!**
 
 `PadUtils.move_file(file_path, dest_file)`
 
+
 #### 5. Copy multiple files
 
 `PadUtils.copy_files(files_array, dest_dir)`
 
+
 #### 6. Copy all files
 
 Copy all files from a directory to another. *Will create destination if it doesn't exist*.
 
 `PadUtils.copy_all_files(source_dir, dest_dir)`
 
+
 #### 7. Create a directory
 
 Create a directory and subdirectories. **Won't complain if it already exists. Won't override content**.
 
 `PadUtils.create_directory(dir_name)`
 
+
 #### 8. Delete a directory and its content
 
 `PadUtils.delete_directory(dir_name)`
 
+
 #### 9. Read content of a file
 
 Returns a `string`.
 
 `PadUtils.get_file_content(filepath)`
 
+
 #### 10. Write to a file
 
 Write content to a file. Create it if it doesn't exist. **Overwrites it if it already exists!**.
 
 `PadUtils.write_to_file(filepath, content)`
 
+
 #### 11. Append to a file
 
 Append content to the end of a file. Create it if it doesn't exist.
@@ -209,6 +247,7 @@ set the `new_line` option to `false`**.
 
 `PadUtils.append_to_file(filepath, content, new_line = true)`
 
+
 ### Logging
 
 By default, logs will go to `~/pad_logs/logs.txt`.
@@ -220,40 +259,48 @@ To log a message, you call `log` and pass it a `message` string. Optionally, you
 
 `PadUtils.log(message, e = nil)`
 
+
 ### Some time methods
 
+
 #### 1. Time to string timestamp
 
 Returns a `string` timestamp with the format `YYYYMMDDHHmmss` from a `Time` object.
 
 `PadUtils.time_to_stamp(val)`
 
+
 #### 2. String to time
 
 Returns a `Time` object from a timestamp with the format `YYYYMMDDHHmmss`
 
 `PadUtils.stamp_to_time(val)`
 
+
 #### 3. Time to readable string
 
 Returns a `string` readable timestamp with format `YYYY-MM-DD HH:mm:ss` from a `Time` object.
 
 `PadUtils.time_to_readable_stamp(val)`
 
+
 #### 4. Readable timestamp to time
 
 Returns a `Time` object from a readable timestamp `string` with format `YYYY-MM-DD HH:mm:ss`
 
 `PadUtils.readable_stamp_to_time(val)`
 
+
 ## Contribute
 
 [Get in touch](https://twitter.com/nicoschuele) before submitting a pull request, I don't want to waste your time by rejecting it!
 
+
 ## Testing
 
 The test suite for PadUtils is currently outside of the gem itself. I may add it if I have time.
 
+
 ## License
 
 Copyright 2016 - Nico Schuele

data/lib/pad_utils/pad_text.rb

@@ -10,6 +10,18 @@ module PadUtils
     end
   end
 
+  # Convert a CamelCase word to an underscored one, e.g. camel_case
+  # Taken from the Rails Inflector class.
+  def self.underscore(val)
+    word = val.dup
+    word.gsub!(/::/, '/')
+    word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+    word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+    word.tr!("-", "_")
+    word.downcase!
+    word
+  end
+
   # Convert a string to only alphanumeric and underscores
   def self.sanitize(value)
     value.tr('^A-Za-z0-9', '_')

data/lib/pad_utils/version.rb

@@ -1,3 +1,3 @@
 module PadUtils
-  VERSION = "1.1.1"
+  VERSION = "1.2.1"
 end

metadata

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