local_path_builder 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3840528ff167321fcf9505c37d5fd67b018d778807676a3bc40c4a3642931ee
-  data.tar.gz: 89574474708e933c497ca7402ebd2ac4c31c10aea80cd69573b0a30404cb24c8
+  metadata.gz: c8be58bca01933657c06bba76b05a333789e1a33db57f01983e6c9aadeacbd6f
+  data.tar.gz: 25871409964b23d9105a1ec8fef7ec385fb1b88d63a9819c2baaabf35c46b541
 SHA512:
-  metadata.gz: 3b3b9aa2caa57b218c8da11d4a64c9e8b874b82d11b01f836bbbd7ee9a7bcec5d4225ad3a03176ca8d686ccebc5b16d1c5059c3ff1fc169bdbbb5094bdf91a5f
-  data.tar.gz: 200de47f2b2ed1cdf37d023af4fcd2f75bb4c36871f04c76ac37b320286e258bdc80ccbd0815108091915de417159d65f7e3d7989460c135149d555612864b5a
+  metadata.gz: 562137e6103e7c85297656a175e0e397ffd332d20067f3e61f8d715208d49fa108608139bdb616e071905c838ab5a6850b4b0a07de4e650b1f55fa6d0e542600
+  data.tar.gz: 69fb1b1f1a91338ed63b41647b7667bdc0e38863d1c787b00d0a849b87a48717807af12bce78590829860812dbd84b6eeb856a5a0318e1ef98446087a0b899ed

data/.circleci/config.yml

@@ -0,0 +1,8 @@
+jobs:
+  build:
+    docker:
+      - image: cimg/ruby:3.0.2
+    steps:
+      - checkout
+      - run: bundle install
+      - run: ruby './test/circle_ci.rb'

data/Gemfile

@@ -7,6 +7,4 @@ gemspec
 
 gem "rake", "~> 13.0"
 
-gem "rubocop", "~> 1.7"
-
-gem 'fileutils', "~> 1.5.0"
+gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    local_path_builder (0.1.0)
+    local_path_builder (0.1.1)
       fileutils (~> 1.5.0)
 
 GEM
@@ -9,32 +9,31 @@ GEM
   specs:
     ast (2.4.2)
     fileutils (1.5.0)
-    parallel (1.20.1)
-    parser (3.0.1.1)
+    parallel (1.21.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (13.0.3)
+    rake (13.0.6)
     regexp_parser (2.1.1)
     rexml (3.2.5)
-    rubocop (1.17.0)
+    rubocop (1.22.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.7.0)
+    rubocop-ast (1.12.0)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   x86_64-darwin-20
 
 DEPENDENCIES
-  fileutils (~> 1.5.0)
   local_path_builder!
   rake (~> 13.0)
   rubocop (~> 1.7)

data/README.md

@@ -1,43 +1,44 @@
 <a href="#table-of-contents">
-<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/local-path-builder.svg" height="55px" name="local-path-builder" alt="# Local Path Builder for Ruby">
+<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/local-path-builder.svg" height="45px" name="headline" alt="# Local Path Builder for Ruby">
 </a>
 
 Usefull helper to build all paths in one hash to local files and folders.
+
 <br>
-<br>
-<br>
-<a href="#table-of-contents">
-<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/table-of-contents.svg" height="55px" name="table-of-contents" alt="Table of Contents">
+
+<a href="#headline">
+<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/table-of-contents.svg" height="38px" name="table-of-contents" alt="Table of Contents">
 </a>
 <br>
 
-1. [Quickstart](#quickstart)<br>
-2. [Setup](#setup)<br>
-3. [Methods](#methods)<br>
-4. [Tree Structure](#tree-structure)<br>
-5. [Console](#console)<br>
-6. [Contributing](#contributing)<br>
-7. [Limitations](#limitations)<br>
-8. [License](#license)<br>
-9. [Code of Conduct](#code-of-conduct)<br>
-10. [Support my Work](#support-my-work)<br>
+1. [Quickstart](#quickstart) 
+2. [Setup](#setup)
+3. [Methods](#methods)
+4. [Tree Structure](#tree-structure)
+5. [Console Output](#console)
+6. [Contributing](#contributing)
+7. [Limitations](#limitations)
+8. [License](#license)
+9. [Code of Conduct](#code-of-conduct)
+10. [Support my Work](#support-my-work)
 
 <br>
-<br>
+
 <a href="#table-of-contents">
-<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/quickstart.svg" height="55px" name="quickstart" alt="Quickstart">
+<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/quickstart.svg" height="38px" name="quickstart" alt="Quickstart">
 </a>
 
 ```ruby
-    require '../lib/local_path_builder'
-    
-    struct = LocalPathBuilder.helper()
-    LocalPathBuilder.generate( struct, :both )
+require 'local_path_builder'
+
+struct = LocalPathBuilder.helper()
+LocalPathBuilder.generate( struct, :both )
 ```
+
 <br>
-<br>
+
 <a href="#table-of-contents">
-<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/setup.svg" height="55px" name="setup" alt="Setup">
+<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/setup.svg" height="38px" name="setup" alt="Setup">
 </a>
 
 Add this line to your application's Gemfile:
@@ -59,30 +60,31 @@ On Rubygems:
 - Gem: https://rubygems.org/gems/local_path_builder
 - Profile: https://rubygems.org/profiles/a6b8
 
-
-<br>
 <br>
+
 <a href="#table-of-contents">
-<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/methods.svg" height="55px" name="methods" alt="Methods">
+<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/methods.svg" height="38px" name="methods" alt="Methods">
 </a>
 
 ### .helper()
 
 ```ruby
-    hash = LocalPathBuilder.helper()
-    # => { path: 
+require 'local_path_builder'
+
+hash = LocalPathBuilder.helper()
+# => { path: 
 ```
 
 ### .generate( struct[:path], key )
 
 ```ruby
-    require 'local_path_builder'
+require 'local_path_builder'
 
-    hash = LocalPathBuilder.generate( 
-        path_tree, 
-        console_mode,  
-        salt 
-    )
+hash = LocalPathBuilder.generate( 
+    path_tree, 
+    console_mode,  
+    salt 
+)
 ```
 
 **Input**
@@ -94,11 +96,11 @@ On Rubygems:
 
 **Return**<br>
 Hash (See also Console Output)
+
 <br>
-<br>
-<br>
+
 <a href="#table-of-contents">
-<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/tree-structure.svg" height="55px" name="tree-structure" alt="Tree Structure">
+<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/tree-structure.svg" height="38px" name="tree-structure" alt="Tree Structure">
 </a>
 
 A struct input is required to generate all paths. Use the following as reference to design your own tree
@@ -106,53 +108,53 @@ A struct input is required to generate all paths. Use the following as reference
 **Example Tree**
 
 ```ruby
-    {
-      root: './',
-      name: '1',
-      children: {
-        entry: {
-          name: '0-entry',
-          files: {
-            tsv: {
-              name: 'rest-{{SALT}}.tsv',
+{
+    root: './',
+    name: '1',
+    children: {
+    entry: {
+        name: '0-entry',
+        files: {
+        tsv: {
+            name: 'rest-{{SALT}}.tsv',
+        }
+        }
+    },
+    converted: {
+        name: '1-converted',
+        children: {
+            json_folder: {
+                name: '0-json',
+                files: {
+                    json: {
+                        name: 'data-{{SALT}}.json',
+                    }
+                }
+            },
+            tsv_folder: {
+                name: '0-tsv',
+                files: {
+                    tsv: {
+                        name: 'data-{{SALT}}.json',
+                    }
+                }
             }
-          }
         },
-        converted: {
-          name: '1-converted',
-          children: {
-              json_folder: {
-                  name: '0-json',
-                  files: {
-                      json: {
-                          name: 'data-{{SALT}}.json',
-                      }
-                  }
-              },
-              tsv_folder: {
-                  name: '0-tsv',
-                  files: {
-                      tsv: {
-                          name: 'data-{{SALT}}.json',
-                      }
-                  }
-              }
-          },
-          files: {
-            json: {
-              name: 'data-{{SALT}}.json',
-            } 
-          }
+        files: {
+        json: {
+            name: 'data-{{SALT}}.json',
+        } 
         }
-      }
     }
+    }
+}
 ```
 ```LocalPathBuiler.helper()``` will give you the same output.
 
 <br>
-<br>
+
 <a href="#table-of-contents">
-<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/console.svg" height="55px" name="console" alt="Console Output">
+<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/console.svg" height="38px" name="console" alt="Console Output">
 </a>
 
 The second parameter of the ```.generate()``` function expects a symbol. you can choose between ```:silent```, ```:hash```, ```path``` and ```both```. 
@@ -164,37 +166,37 @@ Console stays silent.
 Console log all variables which are available.
 
 ```txt
-    LocalPathBuilder.generate( struct, :hash )
-
-    TREE OVERVIEW
-        hash[:path][:full]
-        ┗━ hash[:path][:children][:entry][:full]
-        ┗━ hash[:path][:children][:entry][:files][:tsv][:full]
-        ┗━ hash[:path][:children][:converted][:full]
-        ┗━ hash[:path][:children][:converted][:files][:json][:full]
-            ┗━ hash[:path][:children][:converted][:children][:json_folder][:full]
-            ┗━ hash[:path][:children][:converted][:children][:json_folder][:files][:json][:full]
-            ┗━ hash[:path][:children][:converted][:children][:tsv_folder][:full]
-            ┗━ hash[:path][:children][:converted][:children][:tsv_folder][:files][:tsv][:full]
+LocalPathBuilder.generate( struct, :hash )
+
+TREE OVERVIEW
+    hash[:path][:full]
+    ┗━ hash[:path][:children][:entry][:full]
+    ┗━ hash[:path][:children][:entry][:files][:tsv][:full]
+    ┗━ hash[:path][:children][:converted][:full]
+    ┗━ hash[:path][:children][:converted][:files][:json][:full]
+        ┗━ hash[:path][:children][:converted][:children][:json_folder][:full]
+        ┗━ hash[:path][:children][:converted][:children][:json_folder][:files][:json][:full]
+        ┗━ hash[:path][:children][:converted][:children][:tsv_folder][:full]
+        ┗━ hash[:path][:children][:converted][:children][:tsv_folder][:files][:tsv][:full]
 ```
 
 
 ### :path
 Console log all path which were created.
 
-```txt
-    LocalPathBuilder.generate( struct, :path )
-
-    TREE OVERVIEW
-        ./1/
-            ./1/0-entry/
-            ./1/0-entry/rest-1624263104.tsv
-            ./1/1-converted/
-            ./1/1-converted/data-1624263104.json
-                ./1/1-converted/0-json/
-                ./1/1-converted/0-json/data-1624263104.json
-                ./1/1-converted/0-tsv/
-                ./1/1-converted/0-tsv/data-1624263104.json
+```
+LocalPathBuilder.generate( struct, :path )
+
+TREE OVERVIEW
+    ./1/
+        ./1/0-entry/
+        ./1/0-entry/rest-1624263104.tsv
+        ./1/1-converted/
+        ./1/1-converted/data-1624263104.json
+            ./1/1-converted/0-json/
+            ./1/1-converted/0-json/data-1624263104.json
+            ./1/1-converted/0-tsv/
+            ./1/1-converted/0-tsv/data-1624263104.json
 ```
 
 
@@ -202,64 +204,65 @@ Console log all path which were created.
 Console log hash variable and the corresponding file path.
 
 ```txt
-    LocalPathBuilder.generate( struct, :both )
-
-    TREE OVERVIEW
-        hash[:path][:full]
-        ./1/
-        ┗━ hash[:path][:children][:entry][:full]
-            ./1/0-entry/
-        ┗━ hash[:path][:children][:entry][:files][:tsv][:full]
-            ./1/0-entry/rest-1624263104.tsv
-        ┗━ hash[:path][:children][:converted][:full]
-            ./1/1-converted/
-        ┗━ hash[:path][:children][:converted][:files][:json][:full]
-            ./1/1-converted/data-1624263104.json
-            ┗━ hash[:path][:children][:converted][:children][:json_folder][:full]
-                ./1/1-converted/0-json/
-            ┗━ hash[:path][:children][:converted][:children][:json_folder][:files][:json][:full]
-                ./1/1-converted/0-json/data-1624263104.json
-            ┗━ hash[:path][:children][:converted][:children][:tsv_folder][:full]
-                ./1/1-converted/0-tsv/
-            ┗━ hash[:path][:children][:converted][:children][:tsv_folder][:files][:tsv][:full]
-                ./1/1-converted/0-tsv/data-1624263104.json
+LocalPathBuilder.generate( struct, :both )
+
+TREE OVERVIEW
+    hash[:path][:full]
+    ./1/
+    ┗━ hash[:path][:children][:entry][:full]
+        ./1/0-entry/
+    ┗━ hash[:path][:children][:entry][:files][:tsv][:full]
+        ./1/0-entry/rest-1624263104.tsv
+    ┗━ hash[:path][:children][:converted][:full]
+        ./1/1-converted/
+    ┗━ hash[:path][:children][:converted][:files][:json][:full]
+        ./1/1-converted/data-1624263104.json
+        ┗━ hash[:path][:children][:converted][:children][:json_folder][:full]
+            ./1/1-converted/0-json/
+        ┗━ hash[:path][:children][:converted][:children][:json_folder][:files][:json][:full]
+            ./1/1-converted/0-json/data-1624263104.json
+        ┗━ hash[:path][:children][:converted][:children][:tsv_folder][:full]
+            ./1/1-converted/0-tsv/
+        ┗━ hash[:path][:children][:converted][:children][:tsv_folder][:files][:tsv][:full]
+            ./1/1-converted/0-tsv/data-1624263104.json
 ```
 
 <br>
-<br>
+
 <a href="#table-of-contents">
-<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/contributing.svg" height="55px" name="contributing" alt="Contributing">
+<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/contributing.svg" height="38px" name="contributing" alt="Contributing">
 </a>
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/a6b8/statosio-for-wordpress. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/a6b8/statosio/blob/master/CODE_OF_CONDUCT.md).
+
 <br>
-<br>
-<br>
+
 <a href="#table-of-contents">
-<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/limitations.svg" height="55px" name="limitations" alt="Limitations">
+<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/limitations.svg" height="38px" name="limitations" alt="Limitations">
 </a>
+
 - Only three levels of folders are supported
   
 <br>
-<br>
+
 <a href="#table-of-contents">
-<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/license.svg" height="55px" name="license" alt="License">
+<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/license.svg" height="38px" name="license" alt="License">
 </a>
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
 <br>
-<br>
-<br>
+
 <a href="#table-of-contents">
-<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/code-of-conduct.svg" height="55px" name="code-of-conduct" alt="Code of Conduct">
+<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/code-of-conduct.svg" height="38px" name="code-of-conduct" alt="Code of Conduct">
 </a>
     
 Everyone interacting in the LocalPathBuilder project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/a6b8/local-path-builder-for-ruby/blob/master/CODE_OF_CONDUCT.md).
+
 <br>
-<br>
-<br>
+
 <a href="#table-of-contents">
-<img href="#table-of-contents" src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/support-my-work.svg" height="55px" name="support-my-work" alt="Support my Work">
+<img href="#table-of-contents" src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/support-my-work.svg" height="38px" name="support-my-work" alt="Support my Work">
 </a>
     
 Donate by [https://www.paypal.com](https://www.paypal.com/donate?hosted_button_id=XKYLQ9FBGC4RG)

data/lib/local_path_builder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LocalPathBuilder
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/local_path_builder.rb

@@ -1,50 +1,42 @@
 # frozen_string_literal: true
 
 require_relative "local_path_builder/version"
-require 'FileUtils'
+require 'fileutils'
 
 
 module LocalPathBuilder
   class Error < StandardError; end
-  # Your code goes here...
 
+  
   def self.helper()
     result = {
       root: './',
       name: '1',
-      full: nil,
       children: {
         entry: {
           name: '0-entry',
-          full: nil,
           files: {
             tsv: {
               name: 'rest-{{SALT}}.tsv',
-              full: nil
             }
           }
         },
         converted: {
           name: '1-converted',
-          full: nil,
           children: {
               json_folder: {
                   name: '0-json',
-                  full: nil,
                   files: {
                       json: {
                           name: 'data-{{SALT}}.json',
-                          full: nil
                       }
                   }
               },
               tsv_folder: {
                   name: '0-tsv',
-                  full: nil,
                   files: {
                       tsv: {
                           name: 'data-{{SALT}}.json',
-                          full: nil
                       }
                   }
               }
@@ -52,7 +44,6 @@ module LocalPathBuilder
           files: {
             json: {
               name: 'data-{{SALT}}.json',
-              full: nil
             } 
           }
         }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: local_path_builder
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - a6b8
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-21 00:00:00.000000000 Z
+date: 2021-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fileutils
@@ -31,6 +31,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - CHANGELOG.md