fs_attachable 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b8f5b00ebbe7a812434530c24783474f2605546a284d23e15e36f673c9b33c82
+  data.tar.gz: 15815d5a9f5131509d8e875f554037dbb850d20da3ade68f51a62f5f54ddd8ac
+SHA512:
+  metadata.gz: 2a17180780a64f974856c4e910757fc0525074702f193b73a4c0fc8714cefa27c17c4ec86eb30e41f92fff26c2da8597009630e3ba242171031aa5de9cedf6b8
+  data.tar.gz: 3c91dd1effe33f83de9e6bc064e44de0c0414f7cc10bd17184d13e5982dd79af4c816a5807f05868cd7ea82fcfa5ccbeb3435f84cfaa40aeef5d5eb2da253c11

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/README.md

@@ -0,0 +1,31 @@
+# FsAttachable
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fs_attachable`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fs_attachable.

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+require 'release/gem'

data/lib/fs_attachable/attachable_config.rb

@@ -0,0 +1,59 @@
+
+require 'singleton'
+require 'fileutils'
+
+module FsAttachable
+  
+  class ConfigError < StandardError; end
+
+  class ConfigDomain
+    include TR::CondUtils
+
+    attr_reader :name
+    
+    def initialize(name, &block)
+      @name = name 
+      instance_eval(&block) if block
+    end
+
+    def store_root(path)
+      @root = path
+      FileUtils.mkdir_p(@root) if not File.exist?(@root)
+    end
+
+    def root
+      raise ConfigError, "FsAttachable storage root is not set. Please set it via store_root before using the class" if is_empty?(@root)
+      @root.freeze
+    end
+
+  end # class ConfigDomain
+
+  class Config
+    include TR::CondUtils
+    include Singleton
+
+    def parse(&block)
+      instance_eval(&block)
+    end
+
+    def domain(name, &block)
+      cd = ConfigDomain.new(name, &block)
+      domains[cd.name.to_sym] = cd
+      cd
+    end
+
+    def for_domain(name)
+      dom = domains[name.to_sym]
+      raise DomainNotSet, "Given domain '#{name}' is not avaialble" if dom.nil?
+      dom
+    end
+
+    private
+    def domains
+      if @_domains.nil?
+        @_domains = {}
+      end
+      @_domains
+    end
+  end
+end

data/lib/fs_attachable/version.rb

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

data/lib/fs_attachable.rb

@@ -0,0 +1,232 @@
+# frozen_string_literal: true
+
+require 'teLogger'
+require 'toolrack'
+
+require_relative "fs_attachable/version"
+require_relative "fs_attachable/attachable_config"
+
+module FsAttachable
+  include TR::CondUtils
+
+  class Error < StandardError; end
+  class SourceFileNotFound < StandardError; end
+  class DomainNotSet < StandardError; end
+
+  def self.config(&block)
+    Config.instance.parse(&block) 
+  end
+
+  def self.logger(tag = nil, &block)
+    if @_logger.nil?
+      @_logger = TeLogger::Tlogger.new
+    end
+
+    if block
+      if not_empty?(tag)
+        @_logger.with_tag(tag, &block)
+      else
+        @_logger.with_tag(@_logger.tag, &block)
+      end
+    else
+      if is_empty?(tag)
+        @_logger.tag = :fs_att
+        @_logger
+      else
+        # no block but tag is given? hmm
+        @_logger.tag = tag
+        @_logger
+      end
+    end
+
+  end # def logger
+
+
+  module ClassMethods
+    include TR::CondUtils
+
+    def domain(name)
+      @domain = name
+    end
+
+    def class_domain
+      @domain
+    end
+
+    def logger
+      FsAttachable.logger(:c_opLog)
+    end
+
+  end
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+
+  ## Instance methods
+  def has_attachments?(name = nil, opts = {})
+
+    if is_empty?(name)
+      tpath = config.root
+      if File.exist?(tpath)
+        files = Dir.entries(tpath)
+        logger.debug "Files at managed storage '#{tpath}' : #{files.length}"
+        files.length > 2
+      else
+        false
+      end
+    else
+      res, path, _ = find_attachment(name, opts) 
+      if res and File.directory?(path)
+        false
+      else
+        res
+      end
+    end
+  end 
+  alias_method :has_attachment?, :has_attachments?
+
+  # 
+  # Upload given path into managed storage
+  #
+  def upload_attachment(path, opts = {})
+
+    raise Error, "Source path must be given" if is_empty?(path)
+
+    opts = {} if opts.nil?
+    
+    if File.exist?(path) 
+    
+      dest_file_name = opts[:dest_file_name]
+      dest_file_name = File.basename(path) if is_empty?(dest_file_name)
+
+      if not_empty?(opts[:root])
+        pa = File.join(config.root, opts[:root], dest_file_name)
+        FileUtils.mkdir_p(File.dirname(pa)) if not File.exist?(File.dirname(pa))
+      else
+        pa = File.join(config.root, dest_file_name)
+      end
+
+      FileUtils.cp(path, pa)
+
+      if not_empty?(opts[:object_class]) and not_empty?(opts[:object_id])
+        attMeta = ModelFact.new_instance(:fsAtt_meta, true)
+        attMeta.objClass = opts[:object_class]
+        attMeta.objId = opts[:object_id]
+        attMeta.mstorage_path = pa
+        attMeta.save
+      end
+
+      pa
+
+    else
+      raise SourceFileNotFound, "Given file '#{path}' not found"
+    end
+  end
+
+  def open_attachment(dest_file_name, opts = { }, &block)
+
+    raise Error, "Block is required for open_attachment" if not block
+    raise Error, "Destination file name must be given" if is_empty?(dest_file_name)
+
+    opts = {  } if opts.nil?
+
+    if not_empty?(opts[:root])
+      pa = File.join(config.root, opts[:root], dest_file_name)
+      FileUtils.mkdir_p(File.dirname(pa)) if not File.exist?(File.dirname(pa))
+    else
+      pa = File.join(config.root, dest_file_name)
+    end
+
+    if block
+      File.open(pa,"wb") do |f|
+        block.call(f)
+      end
+
+      if not_empty?(opts[:object_class]) and not_empty?(opts[:object_id])
+        attMeta = ModelFact.new_instance(:fsAtt_meta, true)
+        attMeta.objClass = opts[:object_class]
+        attMeta.objId = opts[:object_id]
+        attMeta.mstorage_path = pa
+        attMeta.save
+      end
+    end
+
+    pa
+  end
+
+  def find_attachment(name, opts = { raise_if_not_found: false })
+
+    opts = {} if opts.nil?
+    raiseIfNotFound = opts[:raise_if_not_found]
+    raiseIfNotFound = false if is_empty?(raiseIfNotFound) or not_bool?(raiseIfNotFound)
+
+    objClass = opts[:object_class] || nil
+    objId = opts[:object_id] || nil
+
+    if not_empty?(objClass) and not_empty?(objId)
+      attMeta = ModelFact.class_instance(:fsAtt_meta, true)
+      rec = attMeta.record_with(objClass: objClass, objId: objId, name: name)
+      if not_empty?(rec)
+        @arec = rec.first
+        pa = @arec.mstorage_path
+      else
+        raise SourceFileNotFound, "File '#{name}' is not found in storage of object '#{objClass}' and ID '#{objId}'"
+      end
+    else
+      pa = File.join(config.root, name)
+    end
+
+    logger.debug "Looking for attachment at : #{pa}"
+    if File.exist?(pa)
+      [true, pa, @arec]
+    else
+      if raiseIfNotFound
+        raise SourceFileNotFound, "File '#{name}' is not found in storage"
+      else
+        [false, nil]
+      end
+    end
+
+  end
+
+  def remove_attachment(name, opts = {  })
+    
+    res, path, rec = find_attachment(name, opts)
+    if res
+      FileUtils.remove_entry_secure(path)
+      rec.destroy if not rec.nil?
+
+      dir = File.dirname(path)
+      if dir != "." and dir != config.root
+        FileUtils.remove_dir(dir) if Dir.entries(dir).length == 2
+      end
+    end
+    [res, path]
+  end
+
+  def remove_attachments
+    root = config.root
+    FileUtils.remove_entry_secure(root, true)
+  end
+
+  private
+  def logger
+    FsAttachable.logger(:opLog)
+  end
+
+  def verify_if_domain_set
+    if is_empty?(self.class.class_domain)
+      raise DomainNotSet, "Class '#{self.class}' has no domain set"
+    else
+      logger.debug "class domain : #{self.class.class_domain}"
+    end
+  end
+
+  def config
+    verify_if_domain_set
+    dom = Config.instance.for_domain(self.class.class_domain)
+    logger.debug "domain : #{dom}"
+    dom
+  end
+
+end

data/sig/fs_attachable.rbs

@@ -0,0 +1,4 @@
+module FsAttachable
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: fs_attachable
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Chris
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: toolrack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: teLogger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: release-gem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- chris@antrapol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- README.md
+- Rakefile
+- lib/fs_attachable.rb
+- lib/fs_attachable/attachable_config.rb
+- lib/fs_attachable/version.rb
+- sig/fs_attachable.rbs
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: ''
+test_files: []