tmsu_file_db 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87c86606a333c58a62d8d6c1d6db1cdee4da35dc
-  data.tar.gz: fbae0484413b490c0e1c98f5a415b95e7ef46b0f
+  metadata.gz: 910c386ec16296462c430627b29d00ce9c718874
+  data.tar.gz: 60c51e32d1ddd33291fe0cbc930b09dd18c6f706
 SHA512:
-  metadata.gz: 220887318854f6a1a9037bf265edc70f547384f8acc44b4d75b7b3a5f00026fdf0c75c913e453c7d6800446f857cb357ac40d9ed2526817b185a42f7f39f6d11
-  data.tar.gz: f5fc16da123e6a2c8eb1eec9f476905e7d4a85193125298efac7e42119f41d2b33ea762da7902a8fbffaf1519599b83d22ce87a76c02c374beefe109b418aa5a
+  metadata.gz: a9f561e9efc1c6180264896d66d1bab28d8c8a5ac5b5b16c1f8ed1dd08c668e19f1b596e418ed7a0b288ebda99dfac566ff75066b834b7d50acaec78147f6b41
+  data.tar.gz: e81b583feb2a1bdadf8c433d38193c9f5965078a080c34e0a4c919c16e51e9e60e0bb12d016f200dc329d4aacd193840c9627e255c8d0518e4feeb83b1fc7683

data/README.md

@@ -0,0 +1,142 @@
+This is an ORM similar to ActiveRecord, but uses the filesystem instead.
+
+It uses TMSU which is a "non-hierarchical" filesystem tagging system.
+
+Usage:
+
+**Install the gem**
+
+```sh
+gem install tmsu_file_db
+```
+
+**Define a model**
+
+```rb
+require 'tmsu_file_db'
+
+class User < TmsuModel
+
+  # this configure block is optional, it defaults to the current directory
+  configure root_path: "./db/users"
+
+  # Validations must return an array
+  validate do |record|
+    record.name.nil? ? ["name can't be blank"] : []
+  end
+
+  # Specific attributes can be validated as well
+  validate(:email) do |email, record|
+    email&.include?("@") ? ["email isn't valid"] : []
+  end
+
+end
+```
+
+**Create instances**
+
+# create, update, and delete
+u = User.new name: "max"
+u.valid? # => false
+u.errors # => ["email isn't valid"]
+u.save # => false
+u.email = "maxpleaner@gmail.com"
+u.valid? # => true
+u.save # => true
+u.update(email: "max.pleaner@gmail.com") # => true
+u.update(email: "") # => false
+
+# There are getter/setter methods for convenience
+u.name # => "max"
+u["name"] # => "max"
+u[:name] # => "max"
+u.name = "max p."
+u[:name] # => "max p."
+
+# All these getter/setters are working on 'attributes' under the hood.
+u.attributes[:name] # => "max p."
+
+# each record is assigned a filesystem path
+u.path
+
+# creating a new record will create a new file in the root_path
+# but will not add anything to the file unless .write is called
+u.write "hello"
+
+# The content of the file is not part of the "attributes" i.e. name and email
+# Those are stored using TMSU tags
+u.tags # => { email: "max.pleaner@gmail.com", name: "max" }
+
+# Attributes can be deleted
+u.delete :name
+u.tags # => { email: "max.pleaner@gmail.com" }
+```
+
+**Use class-level query methods**
+
+_Note that this does not use Arel or any of that jazz. So chaining queries or using joins will not work._
+
+_Note also that there is no `id` on models, only `path`, which is an absolute path._
+
+```rb
+User.where(name: "max p.")[0].name == "max p." # => true
+User.find_by(name: "max p.").name == "max p." # => true
+User.update_all(name: "max") # => true
+User.all[0].name == "max" # => true
+
+# You can make arbitrary queries using TMSU syntax
+# e.g. select all users with email set that are not named melvin
+User.query("name != 'melvin' and email")[0].name == "max" # => true
+```
+
+You can also skip `TmsuModel` and use `TmsuRuby.file` instead. This does _not_ handle creation / deletion of files. It should only be used with files that already exist.
+
+Note that these methods are technically available on `TmsuModel` instances, callable on the `tmsu_file` attribute. But this shoudln't be done, because it will cause the in-memory attributes to be out of sync.
+
+```rb
+file_path = './my_pic.jpg' # this should already exist
+
+tmsu_file = TmsuRuby.file file_path
+tmsu_file.tags # => {}
+
+tmsu_file.tag "foo" # .tag can be passed a string
+tmsu_file.tags # => { foo: nil }
+
+tmsu_file.untag "foo"
+tmsu_file.tags # => { }
+
+tmsu_file.tag ["foo", "bar"] # .tag can also be passed an array
+tmsu_file.tags # => { foo: nil, bar: nil }
+
+tmsu_file.tag(a: 1, b: 2) # .tag can also be passed a hash
+tmsu_file.tags # => { foo: nil, bar: nil, a: 1, b: 2 }
+```
+
+It's also possible to use `TmsuRuby` to work on multiple files instead of just one:
+
+```rb
+glob_selector = "./**/*.jpg"
+
+tmsu_file = TmsuRuby.file glob_selector
+
+# there is a special method used to add tags in this case
+tmsu_file.tag_selector "foo"
+tmsu_file.tag_selector ["a", "b"]
+tmsu_file.tag_selector c: 1, d: 2
+
+# Simiarly to untag
+tmsu_file.untag_selector "c"
+
+# check that the tags were added to files
+TmsuRuby.file("./my_pic.jpg").tags
+# => { foo: nil, a: nil, b: nil, d: 2 }
+```
+
+Using `TmsuRuby.file` you can search by tag as well:
+
+```rb
+# Returns array of paths (files with the tag, systemwide)
+TmsuRuby.file("name")
+```
+
+

data/lib/tmsu_file_db.rb

@@ -18,7 +18,7 @@ class TmsuModel
 
   def self.configure(root_path:)
     Config[:root_path] = root_path || "./db".tap do |path|
-      `mkdir #{path}`
+      `mkdir -p #{path}`
     end
   end
 
@@ -51,16 +51,31 @@ class TmsuModel
     query opts_to_query opts
   end
 
+  def self.all
+
+  end
+
   def self.query string
-    TmsuFile.new(query_glob).paths_query(query)
+    TmsuFile.new(query_glob).paths_query(query).map do |path|
+      new TmsuFile.new(path).tags
+    end
   end
 
   def self.update_all opts={}
-    Dir.glob(query_glob).each { |path| new(path).update(opts) }
+    Dir.glob(query_glob).each do |path|
+      errors = new(path).tap { |inst| inst.update(opts) }.errors
+      unless errors.empty?
+        raise(
+          ArgumentError, "couldn't update all. Path #{path} caused errors: #{errors.join(", ")}"
+        )
+      end
+    end
+    true
   end
 
   def self.destroy_all opts={}
     Dir.glob(query_glob).each { |path| `rm #{path}` }
+    true
   end
 
   attr_reader :attributes, :errors, :path
@@ -92,7 +107,10 @@ class TmsuModel
   end
 
   def method_missing(sym, *arguments, &blk)
-    if attributes.keys.include? sym
+    attr_name = sym.to_s[0..-1]
+    if sym.to_s[-1] == "=" && attributes.keys.include?(attr_name)
+      attributes[attr_name] = arguments[0]
+    elsif attributes.keys.include? sym
       attributes[sym]
     else
       super
@@ -138,14 +156,22 @@ class TmsuModel
 
   def save
     ensure_persisted
+    return false unless valid?
     tag attributes
-    self
+    true
   end
 
   def update attrs={}
+    original_attrs = attributes.clone
     attrs.each_key { |k| self[k] = attrs[k] }
+    unless valid?
+      # rollback attribute change
+      self.attributes.clear
+      original_attrs.each { |k,v| self[k] = v }
+      return false
+    end
     save
-    self
+    true
   end
 
   def destroy
@@ -153,6 +179,12 @@ class TmsuModel
     self
   end
 
+  def delete(attr)
+    untag(attr)
+    attributes.delete attr
+    attr
+  end
+
 end
 
 module SystemPatch
@@ -172,7 +204,7 @@ module TmsuRubyInitializer
     puts "initializing tmsu"
     puts system "tmsu init"
     puts "making vfs_path #{vfs_path}"
-    puts system "mkdir #{vfs_path}"
+    puts system "mkdir -p #{vfs_path}"
     puts "mounting vfs path"
     puts system "tmsu mount #{vfs_path}"
   end
@@ -186,7 +218,6 @@ module TmsuFileAPI
   using SystemPatch
 
   def tags
-    ensure_persisted
     system("tmsu tags #{path}").split(" ")[1..-1].reduce({}) do |res, tag|
       key, val = tag.split("=")
       res.tap { res[key] = val }
@@ -202,7 +233,6 @@ module TmsuFileAPI
 
   def untag tag_list
     `touch #{path}` unless persisted?
-    attributes.delete
     system "tmsu untag #{path} #{tag_list}"
     tags
   end
@@ -231,6 +261,17 @@ module TmsuFileAPI
     files tag_obj
   end
 
+  def untag_selector(tag_obj)
+    tag_arg = case tag_obj
+    when String
+      tag_obj
+    when Array
+      tag_obj.join(" ")
+    end
+    system "tmsu tag --tags '#{build_tag_arg tag_obj}' #{path}"
+    files tag_obj
+  end
+
   def merge_tag(source, dest)
     source_files = files source
     dest_files = files dest

data/lib/version.rb

@@ -1,3 +1,3 @@
 module TmsuFileDb
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tmsu_file_db
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - maxpleaner
@@ -31,6 +31,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - bin/tmsu_file_db
 - lib/tmsu_file_db.rb
 - lib/version.rb