oktags 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68dace0200066373c4f27abc74ffb4fbb5faa9599b6a2771bf436d89ce92dcbe
-  data.tar.gz: 1f50358bc643e20f55fa8d9f909f12e43600a44460cbb8b2c82dee6e3ce0c7e3
+  metadata.gz: e7c1bf8fa36aa3489c778e0b12a19d353ddfd05df9fc21ef1a86e9b207a094ee
+  data.tar.gz: c9c873a9d5db3d4703544d95eb8f1bfa3b86903ba85dcd46ad4030766a1ad5da
 SHA512:
-  metadata.gz: b6213c7ff2043dcec1246a771b9919212098152672ab590fc89c3910094a940b984be2ca7b67acda67e78d21db54461036b378f6de33327f399cedb9216eb5c8
-  data.tar.gz: 19e306cf0c524f9f67ca951606bbad2aed2342346b0c85b0c4cbba028eb47a8ccabf7375a42e4d0719c4db0595ed662ee8b362479b077d5421ba4bf7a60fa937
+  metadata.gz: 792329f1c8911835393d37e47b7f6c40f3f8ce8108ac38320178704f830be794a35cf1a6bb639006f6024543e89ed19ab144ad0fb64cbdd469c5986b19b1e9d5
+  data.tar.gz: 49fc86f66ba0634bc4d3f7344f432a14aa67e270ea15158ccbc0cd716d8c452a4dd68125796db6ba8e4ebc4d11065e48cdb1fcb26d03735fdda136610e91ab05

data/.github/workflows/{ruby.yml → ci.yml}

@@ -5,7 +5,7 @@
 # This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
 # For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
 
-name: Ruby
+name: CI
 
 on:
   push:

data/README.org

@@ -7,6 +7,9 @@
                      |___/
 #+end_example
 
+#+html: <img src="https://github.com/200ok-ch/oktags/workflows/CI/badge.svg"/>
+#+html: <a href="https://rubygems.org/gems/oktags"> <img src="https://badge.fury.io/rb/oktags.svg"/></a>
+
 * NAME
 
 =oktags= - manage tags on plain old files
@@ -26,10 +29,10 @@
 
 * DESCRIPTION
 
-=oktags= helps you organize your files by managing tags on them.
-It works by adding/removing tags at the end of the filename after a
-=--= qualifier. The implementation is OS-agnostic, so it should work
-on Linux, macOS and Windows.
+=oktags= helps you organize your files by managing tags on them. It
+works by adding/removing at the end of the filename into a
+=--[tag1,tag2]= construct. The implementation is OS-agnostic, so it
+should work on Linux, macOS and Windows.
 
 * EXAMPLES
 
@@ -38,8 +41,8 @@ Listing all tags in the current folder.
   #+begin_example
     $ touch foo
     $ touch bar.txt
-    $ touch foobar--tag1,tag2.pdf
-    $ touch baz--tag1.txt
+    $ touch foobar--[tag1,tag2].pdf
+    $ touch baz--[tag1].txt
     $ oktags -l
     tag1(2)
     tag2(1)
@@ -55,9 +58,9 @@ Listing all tags for a given path glob (assuming the same data set as above).
 Adding tags to a file. NB: Tags are always unique.
 
 #+begin_example
-  oktags -a tag3,tag2 foobar--tag1,tag2.pdf
+  oktags -a tag3,tag2 foobar--[tag1,tag2].pdf
   $ ls foobar*
-  foobar--tag1,tag2,tag3.pdf
+  foobar--[tag1,tag2,tag3].pdf
 #+end_example
 
 Interactively adding tags (with auto-completion through readline) to a file.
@@ -68,7 +71,7 @@ Interactively adding tags (with auto-completion through readline) to a file.
   tag1  tag2  tag3
   > tag2, new tag
   $ ls foo* | grep new
-  foo--new tag,tag2
+  foo--[new tag,tag2]
 #+end_example
 
 Renaming tags.
@@ -88,10 +91,10 @@ Remove a tag from a file.
 
 #+begin_example
   $ find . | grep business_card | head -n 1
-  ./archiv/Cyrill_Schwitter--business_card,somedia,seo.pdf
-  $ oktags -d seo ./archiv/Cyrill_Schwitter--business_card,somedia,seo.pdf
+  ./archiv/Cyrill_Schwitter--[business_card,somedia,seo].pdf
+  $ oktags -d seo ./archiv/Cyrill_Schwitter--[business_card,somedia,seo].pdf
   $ find . | grep business_card | head -n 1
-  ./archiv/Cyrill_Schwitter--business_card,somedia.pdf
+  ./archiv/Cyrill_Schwitter--[business_card,somedia].pdf
 #+end_example
 
 * INSTALLATION
@@ -111,8 +114,8 @@ You can also run =bin/console= for an interactive prompt that will
 allow you to experiment.
 
 To install this gem onto your local machine, run =bundle exec rake
-install=. To release a new version, update the version number in
-=version.rb=, and then run =bundle exec rake release=, which will
+install=. To publish a new version, update the version number in
+=version.rb=, and then run =bundle exec rake publish=, which will
 create a git tag for the version, push git commits and tags, and push
 the =.gem= file to [[https://rubygems.org][rubygems.org]].
 
@@ -121,11 +124,10 @@ the =.gem= file to [[https://rubygems.org][rubygems.org]].
   Tests are implemented with [[https://rspec.info/][RSpec]] and can be run like this:
 
 #+begin_src shell
-  $ rpsec spec
-  .....
+  ......
 
-  Finished in 0.00351 seconds (files took 0.06834 seconds to load)
-  5 examples, 0 failures
+  Finished in 0.00408 seconds (files took 0.07109 seconds to load)
+  6 examples, 0 failures
 #+end_src
 
 * NOTES

data/lib/ok/tags.rb

@@ -10,33 +10,41 @@ module OK
     class Error < StandardError; end
     extend self
 
-    def find_tags_for(path)
+    # oktags uses --[] as the place to save tags. [] does have special
+    # meaning for Ruby Dir.glob, though. Hence, it's escaped.
+    def escape_glob(s)
+      s&.gsub(/[\[\]]/) { |x| "\\" + x }
+    end
+
+    def find_tags_for(path = '**/*')
       tags = []
-      Dir.glob(path).each do |file|
-        file = File.basename(file, ".*")
-        file_tags = file.split('--')[1]&.split(',')&.map(&:strip)&.map(&:downcase)
+      Dir.glob(escape_glob(path)).each do |file|
+        file = File.basename(file, '.*')
+        file_tags =
+          file.match(/--\[(.*)\]/)&.to_a&.at(1)&.split(',')&.map(&:strip)&.map(
+            &:downcase
+          )
         tags << file_tags if file_tags
       end
 
-      tags = tags.flatten.compact
+      tags.flatten.compact.sort
     end
 
     def count_tags(tags)
-      tags.inject({}) { |acc, tag|
+      tags.inject({}) do |acc, tag|
         acc[tag] = acc[tag].to_i + 1
         acc
-      }
+      end
     end
 
-    def list_pretty_tags(path = nil)
-      tags = find_tags_for(path || '**/*')
+    def list_pretty_tags(path = '**/*')
+      tags = find_tags_for(path)
       counts = count_tags(tags)
 
-      pretty_counts = counts.sort_by { |tag, count| count }
-                        .reverse
-                        .map do |tag, count|
-        "#{tag}(#{count})"
-      end
+      pretty_counts =
+        counts.sort_by { |tag, count| count }.reverse.map do |tag, count|
+          "#{tag}(#{count})"
+        end
 
       puts pretty_counts
     end
@@ -44,58 +52,75 @@ module OK
     def filename_with_tags(file, tags)
       dirname = File.dirname(file)
       ext = File.extname(file)
-      basename = File.basename(file, ".*").split('--')[0]
-      File.join(dirname, "#{basename}--#{tags.join(',')}#{ext}")
+
+      basename = File.basename(file, '.*')
+      tag_part = basename.match(/--\[(.*)\]/)&.to_a&.at(0)
+      basename = basename.gsub(tag_part, '') if tag_part
+      File.join(dirname, "#{basename}--[#{tags.join(',')}]#{ext}")
     end
 
     def add_tags_to_file(new_tags, file)
-      (puts "Needs a FILE input; i.e. `-a tag filename`"; exit) unless file
+      unless file
+        (
+          puts 'Needs a FILE input; i.e. `-a tag filename`'
+          exit
+        )
+      end
 
       tags = find_tags_for(file)
       tags << new_tags.split(',')&.map(&:strip)&.map(&:downcase)
       tags = tags.flatten.uniq.sort
 
       new_filename = filename_with_tags(file, tags)
-      if file != new_filename
-        FileUtils.mv(file, new_filename)
-      end
+      FileUtils.mv(file, new_filename) if file != new_filename
 
       new_filename
     end
 
-    def read_and_add_tags_for(file, tags_path = nil)
-      (puts "File '#{file}' does not exist."; exit 1) unless File.exist?(file)
-
-      tags = find_tags_for(tags_path || '**/*')
-      Readline.completion_proc = proc do |input|
-        tags.select { |tag| tag.start_with?(input) }
+    def read_and_add_tags_for(file, tags_path = '**/*')
+      unless File.exist?(file)
+        (
+          puts "File '#{file}' does not exist."
+          exit 1
+        )
       end
 
-      puts "Add new tags:"
-      new_tags = Readline.readline("> ", false)
+      tags = find_tags_for(tags_path)
+      Readline.completion_proc =
+        proc { |input| tags.select { |tag| tag.start_with?(input) } }
+
+      puts 'Add new tags:'
+      new_tags = Readline.readline('> ', false)
       new_filename = add_tags_to_file(new_tags, file)
       [new_tags, new_filename]
     end
 
     def delete_tag_from_file(tag, file)
-      (puts "Needs a FILE input; i.e. `-d tag1 filename`"; exit) unless file
+      unless file
+        (
+          puts 'Needs a FILE input; i.e. `-d tag1 filename`'
+          exit
+        )
+      end
 
       tags = find_tags_for(file)
       tags = tags.reject { |t| t == tag }
 
       new_filename = filename_with_tags(file, tags)
-      if file != new_filename
-        FileUtils.mv(file, new_filename)
-      end
+      FileUtils.mv(file, new_filename) if file != new_filename
 
       new_filename
     end
 
-
     def rename_tag(path, old_tag, new_tag)
-      (puts "Needs a NEW_TAG input; i.e. `-r old_tag new_tag`"; exit) unless new_tag
+      unless new_tag
+        (
+          puts 'Needs a NEW_TAG input; i.e. `-r old_tag new_tag`'
+          exit
+        )
+      end
 
-      Dir.glob("#{path}/**/*--*#{old_tag}*").each do |file|
+      Dir.glob("#{path}/**/*--\\[*#{old_tag}*\\]*").each do |file|
         file = add_tags_to_file(new_tag, file)
         delete_tag_from_file(old_tag, file)
       end
@@ -104,28 +129,47 @@ module OK
     def main
       OptionParser.new do |opts|
         opts.banner = 'Usage: oktags [options]'
-        opts.on('-l', "--list [PATH]", 'List file tags (optionally for PATH)') do |path|
-          list_pretty_tags(path)
+        opts.on(
+          '-l',
+          '--list [PATH]',
+          'List file tags (optionally for PATH)'
+        ) do |path|
+          path ? list_pretty_tags(path) : list_pretty_tags
           exit
         end
-        opts.on('-a', '--add-tags TAGS FILE', 'Add comma-separated TAGS to FILE') do |tags|
+        opts.on(
+          '-a',
+          '--add-tags TAGS FILE',
+          'Add comma-separated TAGS to FILE'
+        ) do |tags|
           add_tags_to_file(tags, ARGV[0])
           exit
         end
-        opts.on('-i', '--add-tags-interactively FILE', 'Auto-complete tags and add them to FILE') do |file|
+        opts.on(
+          '-i',
+          '--add-tags-interactively FILE',
+          'Auto-complete tags and add them to FILE'
+        ) do |file|
           read_and_add_tags_for(file)
           exit
         end
-        opts.on('-r', '--rename-tag OLD_TAG NEW_TAG', 'Rename OLD_TAG to NEW_TAG(S) recursively for all files') do |old_tag|
+        opts.on(
+          '-r',
+          '--rename-tag OLD_TAG NEW_TAG',
+          'Rename OLD_TAG to NEW_TAG(S) recursively for all files'
+        ) do |old_tag|
           rename_tag('.', old_tag, ARGV[0])
           exit
         end
-        opts.on('-d', '--delete-tag-from-file TAG FILE', 'Delete TAG from FILE') do |tag|
+        opts.on(
+          '-d',
+          '--delete-tag-from-file TAG FILE',
+          'Delete TAG from FILE'
+        ) do |tag|
           delete_tag_from_file(tag, ARGV[0])
           exit
         end
       end.parse!
-
     end
   end
 end

data/lib/ok/version.rb

@@ -1,5 +1,5 @@
 module OK
   module Tags
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oktags
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alain M. Lafon
@@ -20,7 +20,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ruby.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"