oktags 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a89cb6486aade586eadf73e6357523224302d7d4034a2dd3bef56a560d6e8f6c
-  data.tar.gz: 0d103fef3b089a96eb954b0d3fce4709f93a2c11b2c0a938519a9886fa60593e
+  metadata.gz: 627114b53a234963a6e1547602f9bdabbd2e91814b6d7b07de8d2f07989170c4
+  data.tar.gz: 16fe1866c9793190c90af178b5125685b4afd4645cb2e43574c952466408bb5b
 SHA512:
-  metadata.gz: f94eef23e1e45da986d19b664ec370869bdb9fe9230ddc6bd95cc46d7cd552d2c86a96781e23ef15591ca10453c56539b4a6af513dc35cb501972cd6703841f0
-  data.tar.gz: 6bbfbe8fc72f800293af14782d373fa7eb882ee98c970b72c63816d6e31af2cc8e4d891d49812fac5c14182283cb1ba3cccbefe7e95afc7a5b6275882768764b
+  metadata.gz: d85747e3fd8ccad82fa328a853a3aea67e4ae6d2116474e34f61599fe535624f89ba8d540e296a847e652b5273bbcb60e95c340d236039ac4124a9d79b0bf983
+  data.tar.gz: 5d606c25adf29ace1025ce67a2287f4078775254c3dba57768dcdfc8e79a5390abdddd8976e3c4d6a37f45dd60e417271d9a3093a2db6d4dfbabe5812cc18530

data/Gemfile

@@ -2,7 +2,9 @@ source 'https://rubygems.org' do
   # Specify your gem's dependencies in oktags.gemspec
   gemspec
 
-  gem "rake", "~> 12.0"
-
-  gem 'rspec'
+  group :development, :test do
+    gem 'rake', '~> 12.0'
+    gem 'rspec'
+    gem 'byebug'
+  end
 end

data/Gemfile.lock

@@ -6,6 +6,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    byebug (11.1.3)
     diff-lcs (1.4.4)
     rake (12.3.2)
     rspec (3.9.0)
@@ -26,6 +27,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  byebug!
   oktags!
   rake (~> 12.0)!
   rspec!

data/README.org

@@ -18,13 +18,15 @@
 
   #+begin_example
     Usage: oktags [options]
-        -l, --list [PATH]                List file tags (optionally for PATH)
         -a, --add-tags TAGS FILE         Add comma-separated TAGS to FILE
+        -d TAG FILE,                     Delete TAG from FILE
+            --delete-tag-from-file
         -i FILE,                         Auto-complete tags and add them to FILE
             --add-tags-interactively
+        -l, --list [PATH]                List file tags (optional PATH)
         -r, --rename-tag OLD_TAG NEW_TAG Rename OLD_TAG to NEW_TAG(S) recursively for all files
-        -d TAG FILE,                     Delete TAG from FILE
-            --delete-tag-from-file
+        -s TAGS [PATH],                  Search files which include (comma-separated) tags recursively (optional PATH)
+            --search-files-with-tags
   #+end_example
 
 * DESCRIPTION
@@ -37,34 +39,32 @@ it should work on Linux, macOS and Windows.
 
 * EXAMPLES
 
-Listing all tags in the current folder.
-
-  #+begin_example
-    $ touch foo
-    $ touch bar.txt
-    $ touch foobar--[tag1,tag2].pdf
-    $ touch baz--[tag1].txt
-    $ oktags -l
-    tag1(2)
-    tag2(1)
-  #+end_example
-
-Listing all tags for a given path glob (assuming the same data set as above).
+Add tags to a file. Tags are always unique.
 
 #+begin_example
-  $ oktags -l '*txt'
-  tag1(1)
+  $ touch foobar
+  $ oktags -a tag1 foobar
+  $ ls foobar*
+  foobar--[tag1]
+  $ oktags -a tag2 foobar--\[tag1\]
+  $ ls foobar*
+  foobar--[tag1,tag2]
+  $ oktags -a tag3,tag2 foobar--[tag1,tag2].pdf
+  $ ls foobar*
+  foobar--[tag1,tag2,tag3].pdf
 #+end_example
 
-Adding tags to a file. NB: Tags are always unique.
+Delete a tag from a file.
 
 #+begin_example
-  oktags -a tag3,tag2 foobar--[tag1,tag2].pdf
-  $ ls foobar*
-  foobar--[tag1,tag2,tag3].pdf
+  $ find . | grep business_card | head -n 1
+  ./archiv/Reto_Huber--[business_card,somedia,seo].pdf
+  $ oktags -d seo ./archiv/Reto_Huber--[business_card,somedia,seo].pdf
+  $ find . | grep business_card | head -n 1
+  ./archiv/Reto_Huber--[business_card,somedia].pdf
 #+end_example
 
-Interactively adding tags (with auto-completion through readline) to a file.
+Interactively add tags (with auto-completion through readline) to a file.
 
 #+begin_example
   $ oktags -i foo
@@ -72,30 +72,50 @@ 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
+
+List all tags in the current folder.
+
+#+begin_example
+  $ touch foo
+  $ touch bar.txt
+  $ touch foobar--[tag1,tag2].pdf
+  $ touch baz--[tag1].txt
+  $ oktags -l
+  tag1(2)
+  tag2(1)
+#+end_example
+
+List all tags for a given path glob (assuming the same data set as above).
+
+#+begin_example
+  $ oktags -l '*txt'
+  tag1(1)
 #+end_example
 
-Renaming tags.
+Rename tag.
 
 #+begin_example
   $ oktags -l
   200ok_expense(8)
   business_card(4)
-  $ oktags -r 200ok_expense "200ok,expense"
+  $ oktags -r 200ok_expense 200ok,expense
   $ oktags -l
   expense(8)
   200ok(8)
   business_card(4)
 #+end_example
 
-Remove a tag from a file.
+Search files with tags.
 
 #+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
-  $ find . | grep business_card | head -n 1
-  ./archiv/Cyrill_Schwitter--[business_card,somedia].pdf
+  $ oktags -s somedia,seo,business_card
+  archiv/Reto_Huber--[business_card,seo,somedia].pdf
+  archiv/Reto_Huber--[business_card,seo,somedia].txt
+  $ oktags -s business_card '**/*pdf'
+  archiv/Reto_Huber--[business_card,seo,somedia].pdf
+  archiv/Stefan_Schmidt--[business_card,lawoon].pdf
 #+end_example
 
 * INSTALLATION
@@ -122,20 +142,14 @@ the =.gem= file to [[https://rubygems.org][rubygems.org]].
 
 * TESTS
 
-  Tests are implemented with [[https://rspec.info/][RSpec]] and can be run like this:
-
-#+begin_src shell
-  ......
-
-  Finished in 0.00408 seconds (files took 0.07109 seconds to load)
-  6 examples, 0 failures
-#+end_src
+Tests are implemented with [[https://rspec.info/][RSpec]] and can be run with =bundle exec
+rspec spec=.
 
 * NOTES
 
 Software systems come and go. It is easy to lose important data in
-(proprietary) legacy systems. Plain old files are boring and therefore
-are here to stay; at least they [[https://en.wikipedia.org/wiki/Computer_file#Storage][have been around since 1961]].
+(proprietary) legacy systems. Plain old files are boring and are
+therefore here to stay; at least they [[https://en.wikipedia.org/wiki/Computer_file#Storage][have been around since 1961]].
 Additional benefits of using plain old files are:
 
 - They are (mostly) platform independent.
@@ -146,14 +160,14 @@ Additional benefits of using plain old files are:
 - They can be transported independently from the software that captured/created them.
 - They are not proprietary.
 
-=oktags= is decidedly built to be just as boring as plain old
-files. It's written in a language that's been proven for shell scripts
-([[https://www.ruby-lang.org/en/][Ruby]]) rather than using something more 'cool' like Clojure (with
-[[https://github.com/borkdude/babashka][babashka]] or [[https://github.com/anmonteiro/lumo][lumo]]). It also only uses Ruby primitives and has
-dependencies (apart from the test framework). =oktags= is
-therefore boring and here to stay. The idea is to tag your files once
-and for all, so you don't loose your important data in something that
-will become an unsupported legacy system at some point.
+=oktags= is decidedly built to be just as boring as plain old files.
+It's written in a language that's been proven for shell scripts ([[https://www.ruby-lang.org/en/][Ruby]])
+rather than using something more 'cool'/'interesting'. It also only
+uses Ruby built-ins and has no dependencies when run as a CLI or
+library. =oktags= is therefore boring and here to stay. The idea is to
+tag your files once and for all, so you will not loose your important
+data in something that will become an unsupported legacy system at
+some point.
 
 At [[https://200ok.ch/][200ok]], we develop various Free Software projects that work on plain
 old files:

data/bin/oktags

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
-require 'oktags'
+require File.expand_path(File.join(%w[.. .. lib ok tags]), __FILE__)
 OK::Tags.main

data/lib/hash.rb

@@ -0,0 +1,15 @@
+class Hash
+  # like invert but not lossy. possibly a good blog post.
+  def safe_invert
+    inject({}) do |acc, (k, v)|
+      if v.is_a? Array
+        v.each do |vx|
+          acc[vx] = acc[vx].nil? ? k : [acc[vx], k].flatten
+        end
+      else
+        acc[v] = acc[v].nil? ? k : [acc[v], k].flatten
+      end
+      acc
+    end
+  end
+end

data/lib/ok/tags.rb

@@ -5,25 +5,7 @@ require 'optparse'
 require 'set'
 require 'readline'
 require 'fileutils'
-require 'byebug'
-
-# TODO: Put this into it's own file
-class Hash
-  # like invert but not lossy. possibly a good blog post.
-  def safe_invert
-    inject({}) do |acc, (k, v)|
-      if v.is_a? Array
-        v.each do |vx|
-          acc[vx] = acc[vx].nil? ? k : [acc[vx], k].flatten
-        end
-      else
-        acc[v] = acc[v].nil? ? k : [acc[v], k].flatten
-      end
-      acc
-    end
-  end
-end
-
+require File.expand_path(File.join(%w[.. .. hash]), __FILE__)
 
 module OK
   module Tags
@@ -204,7 +186,7 @@ module OK
         opts.on(
           '-l',
           '--list [PATH]',
-          'List file tags (optional PATH)'
+          'List file tags recursively (at optional PATH)'
         ) do |path|
           path ? list_pretty_tags(path) : list_pretty_tags
           exit
@@ -220,7 +202,7 @@ module OK
         opts.on(
           '-s',
           '--search-files-with-tags TAGS [PATH]',
-          'Search files which include (comma-separated) tags recursively (optional PATH)'
+          'Search files which include (comma-separated) TAGS recursively (at optional PATH)'
         ) do |tags|
           if ARGV[0]
             list_files_with_tags(tags, ARGV[0])
@@ -234,4 +216,4 @@ module OK
   end
 end
 
-OK::Tags.main
+OK::Tags.main if $0 == __FILE__

data/lib/ok/version.rb

@@ -1,5 +1,5 @@
 module OK
   module Tags
-    VERSION = '0.2.1'
+    VERSION = '0.2.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oktags
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Alain M. Lafon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-15 00:00:00.000000000 Z
+date: 2020-10-19 00:00:00.000000000 Z
 dependencies: []
 description: 'oktags helps you organize your files by managing tags on them. It works
   by adding/removing at the end of the filename. Given a file ''cat.jpg'', when adding
@@ -33,6 +33,7 @@ files:
 - bin/console
 - bin/oktags
 - bin/setup
+- lib/hash.rb
 - lib/ok/tags.rb
 - lib/ok/version.rb
 - lib/oktags.rb