lucarecord 0.2.13 → 0.2.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33dd0b5f2cd8a6ae4c94dbadf2d9aab09506cab0a2c4a39d73b5e0a961be6398
-  data.tar.gz: 49041749d990cf7e26febd8190f9e70779f6d126457fe33107e76b9f449a88c9
+  metadata.gz: 1b2e7e80da19b8c0adaebc6272a05e26f66c2e6a989fa416bfd77951ac5f88a0
+  data.tar.gz: 699708346c68e5fa32105eec0d8a82aae8fd85c452f005a402f80a9ff7b19b95
 SHA512:
-  metadata.gz: f4c10b61c7ed567bfe3609836a428b208cb25abefab2d666b3ece5db2316bfe575f53d16a3551ab12f9588148c8e829975cea7e94e51a07ba80a68230edcb0bb
-  data.tar.gz: 7427716901f0fa5c9a83055c22c7ff58819b4fbe013af187c8a2230239953fbcde22658a29b3f6e3e47c72ccc6eaec58a08ba47c47008c190be5ac3d55afd1d4
+  metadata.gz: 59217fdab9258c37ceab07e35118961ae3ac6d6d1587f84235b31169dacf8a82f968a2e8b00f0710c0f7e587836d7d4834f4bf8d2f51e5fbd6f30d1a3100ea7b
+  data.tar.gz: edbc54ec5c66e422a6975c8e53a33b32a063304d5c582ebf4f22596151d141de7d90404eaff8cdd7e8b10264f195da67803ba48a2e4426c6629d995f6cc03507

data/lib/luca_record/io.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'csv'
 require 'date'
 require 'fileutils'
@@ -6,11 +8,10 @@ require 'pathname'
 require 'luca_support/code'
 require 'luca_support/config'
 
-#
-# Low level API
-# manipulate files based on transaction date
-#
-module LucaRecord
+module LucaRecord # :nodoc:
+  # == IO
+  # Read / Write hash data with id and/or date.
+  # Manage both database & historical records.
   module IO
     include LucaSupport::Code
 
@@ -18,32 +19,15 @@ module LucaRecord
       klass.extend ClassMethods
     end
 
-    #
-    # Used @date for searching current settings
-    # query can be nested hash for other than 'val'
-    #
-    #   where(contract_status: 'active')
-    #   where(graded: {rank: 5})
-    #
-    def where(**query)
-      return enum_for(:where, **query) unless block_given?
-
-      query.each do |key, val|
-        v = val.respond_to?(:values) ? val.values.first : val
-        label = val.respond_to?(:keys) ? val.keys.first : 'val'
-        self.class.all do |data|
-          next unless data.keys.map(&:to_sym).include?(key)
-
-          processed = parse_current(data)
-          yield processed if v == processed.dig(key.to_s, label.to_s)
-        end
-      end
-    end
-
     module ClassMethods
-      #
+      #-----------------------------------------------------------------
+      # :section: Query Methods
+      # Provide sematic search interfaces.
+      # <tt>basedir</tt> is set by class instance variable <tt>@dirname</tt>
+      # of each concrete class.
+      #-----------------------------------------------------------------
+
       # find ID based record. Support uuid and encoded date.
-      #
       def find(id, basedir = @dirname)
         return enum_for(:find, id, basedir) unless block_given?
 
@@ -61,7 +45,6 @@ module LucaRecord
         end
       end
 
-      #
       # search date based record.
       #
       # * data hash
@@ -75,7 +58,6 @@ module LucaRecord
         end
       end
 
-      #
       # search with date params & code.
       #
       def search(year, month = nil, day = nil, code = nil, basedir = @dirname)
@@ -91,7 +73,6 @@ module LucaRecord
         end
       end
 
-      #
       # retrieve all data
       #
       def all(basedir = @dirname)
@@ -102,13 +83,53 @@ module LucaRecord
         end
       end
 
-      #
+      #-----------------------------------------------------------------
+      # :section: Write Methods
+      # <tt>basedir</tt> is set by class instance variable <tt>@dirname</tt>
+      # of each concrete class.
+      #-----------------------------------------------------------------
+
+      # create hash based record
+      def create(obj, basedir = @dirname)
+        id = LucaSupport::Code.issue_random_id
+        obj['id'] = id
+        open_hashed(basedir, id, 'w') do |f|
+          f.write(YAML.dump(obj.sort.to_h))
+        end
+        id
+      end
+
+      # define new transaction ID & write data at once
+      def create_record!(obj, date_obj, codes = nil, basedir = @dirname)
+        gen_record_file!(basedir, date_obj, codes) do |f|
+          f.write(YAML.dump(obj.sort.to_h))
+        end
+      end
+
+      def prepare_dir!(basedir, date_obj)
+        dir_name = (Pathname(basedir) + encode_dirname(date_obj)).to_s
+        FileUtils.mkdir_p(dir_name) unless Dir.exist?(dir_name)
+        dir_name
+      end
+
+      def add_status!(id, status, basedir = @dirname)
+        path = abs_path(basedir) / id2path(id)
+        origin = YAML.load_file(path, {})
+        newline = { status => DateTime.now.to_s }
+        origin['status'] = [] if origin['status'].nil?
+        origin['status'] << newline
+        File.write(path, YAML.dump(origin.sort.to_h))
+      end
+
+      #-----------------------------------------------------------------
+      # :section: Path Utilities
+      #-----------------------------------------------------------------
+
       # convert ID to file path. Normal argument is as follows:
       #
-      # * [2020H, V001]
-      # * "2020H/V001"
-      # * "a7b806d04a044c6dbc4ce72932867719"
-      #
+      #   [2020H, V001]
+      #   "2020H/V001"
+      #   "a7b806d04a044c6dbc4ce72932867719"
       def id2path(id)
         if id.is_a?(Array)
           id.join('/')
@@ -119,9 +140,7 @@ module LucaRecord
         end
       end
 
-      #
       # Directory separation for performance. Same as Git way.
-      #
       def encode_hashed_path(id, split_factor = 3)
         len = id.length
         if len <= split_factor
@@ -131,63 +150,22 @@ module LucaRecord
         end
       end
 
-      def add_status!(id, status, basedir = @dirname)
-        path = abs_path(basedir) / id2path(id)
-        origin = YAML.load_file(path, {})
-        newline = { status => DateTime.now.to_s }
-        origin['status'] = [] if origin['status'].nil?
-        origin['status'] << newline
-        File.write(path, YAML.dump(origin.sort.to_h))
-      end
-
-      #
-      # create hash based record
-      #
-      def create(obj, basedir = @dirname)
-        id = LucaSupport::Code.issue_random_id
-        obj['id'] = id
-        open_hashed(basedir, id, 'w') do |f|
-          f.write(YAML.dump(obj.sort.to_h))
-        end
-        id
-      end
-
-      #
-      # define new transaction ID & write data at once
-      #
-      def create_record!(date_obj, codes = nil, basedir = @dirname)
-        gen_record_file!(basedir, date_obj, codes) do |f|
-          f.write CSV.generate('', col_sep: "\t", headers: false) { |c| yield(c) }
-        end
+      def encode_dirname(date_obj)
+        date_obj.year.to_s + LucaSupport::Code.encode_month(date_obj)
       end
 
-      def gen_record_file!(basedir, date_obj, codes = nil)
-        d = prepare_dir!(abs_path(basedir), date_obj)
-        filename = LucaSupport::Code.encode_date(date_obj) + new_record_id(abs_path(basedir), date_obj)
-        if codes
-          filename += codes.inject('') { |fragment, code| "#{fragment}-#{code}" }
-        end
-        path = Pathname(d) + filename
-        File.open(path.to_s, 'w') { |f| yield(f) }
+      # test if having required dirs/files under exec path
+      def valid_project?(path = LucaSupport::Config::Pjdir)
+        project_dir = Pathname(path)
+        FileTest.file?((project_dir + 'config.yml').to_s) and FileTest.directory?( (project_dir + 'data').to_s)
       end
 
       def new_record_id(basedir, date_obj)
         LucaSupport::Code.encode_txid(new_record_no(basedir, date_obj))
       end
 
-      def prepare_dir!(basedir, date_obj)
-        dir_name = (Pathname(basedir) + encode_dirname(date_obj)).to_s
-        FileUtils.mkdir_p(dir_name) unless Dir.exist?(dir_name)
-        dir_name
-      end
-
-      def encode_dirname(date_obj)
-        date_obj.year.to_s + LucaSupport::Code.encode_month(date_obj)
-      end
-
       private
 
-      #
       # open records with 'basedir/month/date-code' path structure.
       # Glob pattern can be specified like folloing examples.
       #
@@ -198,7 +176,6 @@ module LucaRecord
       # 1. encoded month
       # 2. encoded day + record number of the day
       # 3. codes. More than 3 are all code set except first 2 parameters.
-      #
       def open_records(basedir, subdir, filename = nil, code = nil, mode = 'r')
         return enum_for(:open_records, basedir, subdir, filename, code, mode) unless block_given?
 
@@ -213,7 +190,6 @@ module LucaRecord
         end
       end
 
-      #
       # git object like structure
       #
       def open_hashed(basedir, id, mode = 'r')
@@ -225,7 +201,6 @@ module LucaRecord
         File.open((dirpath + filename).to_s, mode) { |f| yield f }
       end
 
-      #
       # scan through all files
       #
       def open_all(basedir, mode = 'r')
@@ -237,7 +212,6 @@ module LucaRecord
         end
       end
 
-      #
       # Decode basic format.
       # If specific decode is needed, override this method in each class.
       #
@@ -253,6 +227,16 @@ module LucaRecord
         end
       end
 
+      def gen_record_file!(basedir, date_obj, codes = nil)
+        d = prepare_dir!(abs_path(basedir), date_obj)
+        filename = LucaSupport::Code.encode_date(date_obj) + new_record_id(abs_path(basedir), date_obj)
+        if codes
+          filename += codes.inject('') { |fragment, code| "#{fragment}-#{code}" }
+        end
+        path = Pathname(d) + filename
+        File.open(path.to_s, 'w') { |f| yield(f) }
+      end
+
       # TODO: replace with data_dir method
       def abs_path(base_dir)
         Pathname(LucaSupport::Config::Pjdir) / 'data' / base_dir
@@ -282,25 +266,28 @@ module LucaRecord
       end
     end # end of ClassModules
 
-    def set_data_dir(dir_path = LucaSupport::Config::Pjdir)
-      if dir_path.nil?
-        raise 'No project path is specified'
-      elsif !valid_project?(dir_path)
-        raise 'Specified path is not for valid project'
-      else
-        project_dir = Pathname(dir_path)
-      end
+    # Used @date for searching current settings
+    # query can be nested hash for other than 'val'
+    #
+    #   where(contract_status: 'active')
+    #   where(graded: {rank: 5})
+    #
+    def where(**query)
+      return enum_for(:where, **query) unless block_given?
 
-      (project_dir + 'data/').to_s
-    end
+      query.each do |key, val|
+        v = val.respond_to?(:values) ? val.values.first : val
+        label = val.respond_to?(:keys) ? val.keys.first : 'val'
+        self.class.all do |data|
+          next unless data.keys.map(&:to_sym).include?(key)
 
-    def valid_project?(path)
-      project_dir = Pathname(path)
-      FileTest.file?((project_dir + 'config.yml').to_s) and FileTest.directory?( (project_dir + 'data').to_s)
+          processed = parse_current(data)
+          yield processed if v == processed.dig(key.to_s, label.to_s)
+        end
+      end
     end
 
-    #
-    # for date based records
+    # parse data dir and respond existing months
     #
     def scan_terms(base_dir, query = nil)
       pattern = query.nil? ? "*" : "#{query}*"
@@ -313,25 +300,11 @@ module LucaRecord
 
     def load_config(path = nil)
       path = path.to_s
-      if File.exists?(path)
+      if File.exist?(path)
         YAML.load_file(path, **{})
       else
         {}
       end
     end
-
-    def has_status?(dat, status)
-      return false if dat['status'].nil?
-
-      dat['status'].map { |h| h.key?(status) }
-        .include?(true)
-    end
-
-    def load_tsv(path)
-      return enum_for(:load_tsv, path) unless block_given?
-
-      data = CSV.read(path, headers: true, col_sep: "\t", encoding: 'UTF-8')
-      data.each { |row| yield row }
-    end
   end
 end

data/lib/luca_record/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LucaRecord
-  VERSION = '0.2.13'
+  VERSION = '0.2.14'
 end

data/lib/luca_support/code.rb

@@ -107,5 +107,12 @@ module LucaSupport
         target
       end
     end
+
+    def has_status?(dat, status)
+      return false if dat['status'].nil?
+
+      dat['status'].map { |h| h.key?(status) }
+        .include?(true)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucarecord
 version: !ruby/object:Gem::Version
-  version: 0.2.13
+  version: 0.2.14
 platform: ruby
 authors:
 - Chuma Takahiro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-05 00:00:00.000000000 Z
+date: 2020-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -87,12 +87,13 @@ files:
 - lib/luca_support/config.rb
 - lib/luca_support/mail.rb
 - lib/luca_support/view.rb
-homepage: https://github.com/chumaltd/luca/lucarecord
-licenses: []
+homepage: https://github.com/chumaltd/luca/tree/master/lucarecord
+licenses:
+- GPL
 metadata:
-  homepage_uri: https://github.com/chumaltd/luca/lucarecord
-  source_code_uri: https://github.com/chumaltd/luca/lucarecord
-  changelog_uri: https://github.com/chumaltd/luca/lucarecord/CHANGELOG.md
+  homepage_uri: https://github.com/chumaltd/luca/tree/master/lucarecord
+  source_code_uri: https://github.com/chumaltd/luca/tree/master/lucarecord
+  changelog_uri: https://github.com/chumaltd/luca/tree/master/lucarecord/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -101,7 +102,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="