compath 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db1088c56006f4e8bcbfc910a58e7f1b42a1db1f
-  data.tar.gz: 00a2e3283fdfb1e8da6ecb3fb05330df34abfa58
+  metadata.gz: 81145d6e4ff289cabb7850889c6ee6d8b3af8892
+  data.tar.gz: 0bc1060c4f3108641a7ac76e38c4329a1cb7f85e
 SHA512:
-  metadata.gz: 2b62dace41df7c5911709aa5dccd65a7b73258becac6287f990fe93a2bba8511ebb381911c768b1e3d45371075bec39bf66f70c01d546090e70c72168f5b4da2
-  data.tar.gz: 5947e8bd948198cb120acdf10a5e0cb0cce5a6260ddbcba436d0531c2dd1b7b697742f8f21738b87ce7682ce8f67d128f0400a3ccfd283a5c8d067c855a64039
+  metadata.gz: 86252244473fc34c9cdc716512b421a0ffe2c5b6f49c3dfd9ccd3b66b89b05448a8ee4cd4aaec84bed6e2f811547dde7f88c02fb7d4900d81120963bb8463782
+  data.tar.gz: aa4c1de3a9cd719af1811274194c63331303c7760b208ae27b9cda32861c4c87413169a32a5b9aedac70c4cadf710ee340dcb937cf7f604702fe92a5412db07c

data/.compath.yml

@@ -2,7 +2,5 @@
 bin/: 
 exe/: 
 lib/: 
-lib/compath/:
-  desc: 
-  scan: false
+lib/compath/**/*: 
 spec/: 

data/README.md

@@ -13,35 +13,45 @@ Compath generates a guide of directory structure in the project.
 It creates or updates `.compath.yml`.
 
 ```yaml
-- ".gitignore":
-    desc:
-- bin/:
-    desc:
-- bin/console:
-    desc:
-- bin/setup:
-    desc:
+---
+bin/:
+exe/:
+lib/:
+lib/compath/:
+spec/:
 
 ...
 ```
 
-Each object of sequences has a key to object structure.
-The key means path, and the object is only able to have `desc` or `scan/` keys.
-`desc` is to describe what the path means.
-`scan` is to switch scanning files or not for the directory by configuring boolean value (`true`, `false`).
+The top level object of yaml is mapping. Each key of objects means path, and each value of objects means description.
+Additional convention of configuration is that the path (key) which is end with `**/*` or `*` tells Compath to stop scanning of children of the directory.
 
 With the following config, `compath` does not scan files of `bin/` directory.
 
 ```yaml
-- ".gitignore":
-    desc:
-- bin/:
-    desc:
-    scan: false
+---
+bin/:
+exe/:
+lib/**/*:   # Modified!
+lib/compath/:
+spec/:
 
 ...
 ```
 
+will be updated to the following content by compath.
+
+```yaml
+---
+bin/:
+exe/:
+lib/**/*:
+spec/:
+
+...
+```
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/meganemura/compath.

data/lib/compath/config_loader.rb

@@ -1,6 +1,9 @@
 module Compath
   module ConfigLoader
     module_function
+
+    SCAN_FALSE_REGEXP = %r{(?<new_path>[^\*]*)(/\*\*)?/\*$}
+
     def load(config)
       conf = YAML.load(config)
 
@@ -18,6 +21,12 @@ module Compath
           }
         end
 
+        # if path is end with `/` character, it represents `scan_children is false`.
+        if m = SCAN_FALSE_REGEXP.match(path)
+          path = m[:new_path]
+          options[:scan] = false
+        end
+
         # TODO: Bad interface...
         Guide.new(path, **options)
       end

data/lib/compath/guide.rb

@@ -35,21 +35,18 @@ module Compath
 
     def object_key
       if directory?
-        pathname.to_s + '/'
+        if @scan_children
+          pathname.to_s + '/'
+        else
+          pathname.to_s + '/**/*'
+        end
       else
         pathname.to_s
       end
     end
 
     def object_value
-      if !directory? || @scan_children
-        @description
-      else
-        {
-          'desc' => @description,
-          'scan' => @scan_children,
-        }
-      end
+      @description
     end
   end
 end

data/lib/compath/version.rb

@@ -1,3 +1,3 @@
 module Compath
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: compath
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - meganemura