rowdb 0.5.1 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39c1806858f1a8d306f1ee05349654b9d368a8236f67ac980263639a0ba799b5
-  data.tar.gz: 128eb45b82377dc04fa2ea226c1f962f18a494e7778f8da83c2fd0eaa0fa18cb
+  metadata.gz: ac3c5afe3b28edfd757cb704048e0c0a6d194a2392991997b5952ce021d31f92
+  data.tar.gz: 3e77f6c857320a74e9294fcfd1116ebd3107bb0ea9c96b526fbe06f6249d96b4
 SHA512:
-  metadata.gz: c3c28ad22face7a22ed466bfe3d61b2c82ef8aee4a22d8d275979b4d9bbbaa9bef9b7b1b32150449f321b3ed4ab745e52fe7cc48df27049b917d8f94c36da175
-  data.tar.gz: dd270b13e87c11753d2cdc50baf277c45cdd9fb637448e740ba3caeca40be4c107797b38fa9073b6bd71f3316d6462779d4e051849b566ccef55bd25c454d45f
+  metadata.gz: 444cc6e4d2b537e194c195bbeffe681966c19c159c0922c3c9db53eb9da4f5b93afa2d39fe01285539ef9fa674d1490e9666ad608af618d3e547578d2351fdbc
+  data.tar.gz: 8b0b6812b2bb219f288f80c512f2c737552d822e151c44c5fdba6ca77dd197bf95b7921fa35c9c4a99a1c60faeca08b5921b694b7cff0c3c108cbe964fca9b79

data/lib/adapters/adapter.rb

@@ -0,0 +1,93 @@
+class Rowdb
+  class Adapter
+
+    def initialize(file_path, js_var)
+
+      @source = normalize_path(file_path)
+      @format = find_format(file_path)
+      @prefix = "var #{js_var} = "
+      @suffix = ";"
+
+    end
+
+    ##
+    # Normalize path to absolute path.
+    #
+    # @param file_path [String] An absolute or relative path.
+    # @return [String] An absolute path.
+    ##
+    def normalize_path(file_path)
+
+      # Absolute path.
+      if file_path.start_with? '/'
+        return file_path
+      # Relative path.
+      else
+        # Get directory the script executed from.
+        return File.join(Dir.pwd, '/' + file_path)
+      end
+
+    end
+
+    ##
+    # Find the format of a file based on its extension.
+    #
+    # @parm file_path [String] The path to the file.
+    ##
+    def find_format(file_path)
+
+      extension = File.extname(file_path)
+
+      case extension
+      when ".json"
+        return :json
+      when ".js"
+        return :js
+      end
+
+      :json
+
+    end
+
+    ##
+    # Wrap JSON in a Javascript variable.
+    #
+    # @param json [String] The stringified JSON.
+    ##
+    def wrap()
+
+      new_file = ""
+
+      # Open file.
+      File.open(@source, 'r') do |file|
+        new_file = file.read
+        new_file.prepend(@prefix)
+        new_file << @suffix
+      end
+
+      # Overwrite file.
+      File.open(@source, 'w') do |file|
+        file.write(new_file)
+      end
+
+    end
+
+    ##
+    # Unwrap JSON from a Javascript variable.
+    #
+    # @param json [String] The stringified JSON.
+    ##
+    def unwrap(json)
+
+      # Deletes: var data = \"
+      json.delete_prefix!(@prefix + '"')
+
+      # Deletes: \";
+      # Deletes: \";\n
+      json.delete_suffix!('"' + @suffix)
+      json.delete_suffix!('"' + @suffix + "\n")
+
+    end
+
+  end
+end

data/lib/adapters/sync.rb

@@ -0,0 +1,62 @@
+require 'oj'
+require_relative 'adapter.rb'
+
+##
+# Synchronous file system.
+##
+class Rowdb
+  class Sync < Adapter
+
+    ##
+    # Load a JSON string from a file.
+    #
+    # @return Hash data
+    ##
+    def read()
+
+      json = nil
+
+      # Load JSON inside a Javascript variable.
+      if @format == :js && File.exist?(@source)
+        File.open(@source, 'r') do |file|
+          json = file.read
+          # Fix double encoding issue due to JSON string becoming Ruby string.
+          json.gsub!('\\"', '"')
+          unwrap(json)
+        end
+      # Load JSON string.
+      else
+        json = Oj.load_file(@source)
+      end
+
+      unless json.nil?
+
+        # Parse JSON.
+        data = Oj.load(json)
+        return data.transform_keys(&:to_sym)
+
+      end
+
+      return nil
+
+    end
+
+    ##
+    # Save a Hash to a file as a JSON string or JS.
+    #
+    # @param Hash data
+    ##
+    def write(data)
+
+      json = Oj.dump(data, mode: :compat)
+
+      Oj.to_file(@source, json)
+
+      if @format == :js
+        wrap()
+      end
+
+    end
+
+  end
+end

data/lib/rowdb.rb

@@ -1,12 +1,22 @@
+################################################################################
+# A local JSON database using Rudash for easy Hash traversal.
+#
+# @author Maedi Prichard
+################################################################################
+
 require 'rudash'
-require_relative 'adapters/Sync.rb'
+require_relative 'adapters/sync.rb'
 
 class Rowdb
 
-  def initialize(file_path, adapter = :sync)
-    @adapter = self.send(adapter, normalize_path(file_path))
+  def initialize(file_path, adapter = :sync, js_var = "db")
+
+    # Initialize the chosen adapter.
+    @adapter = self.send(adapter, file_path, js_var)
+
     @chain = R_.chain(@adapter.read())
     @get_path = nil
+
   end
 
   # Set default data.
@@ -33,7 +43,6 @@ class Rowdb
   end
 
   def push(value)
-
     if @get_path.nil?
       raise StandardError.new "You must get() before push()."
     end
@@ -54,27 +63,14 @@ class Rowdb
 
   private
 
-  def sync(file_path)
-    Sync.new(file_path)
-  end
-
   ##
-  # Normalize path.
+  # Adapters.
   #
-  # @param file_path - An absolute or relative path.
-  # @return An absolute path.
+  # The chosen adapter is initialized by the constructor.
   ##
-  def normalize_path(file_path)
-
-    # Absolute path.
-    if file_path.start_with? '/'
-      return file_path
-    # Relative path.
-    else
-      # Get directory the script executed from.
-      return File.join(Dir.pwd, '/' + file_path)
-    end
 
+  def sync(file_path, js_var)
+    Sync.new(file_path, js_var)
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rowdb
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.4
 platform: ruby
 authors:
 - Maedi Prichard
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-21 00:00:00.000000000 Z
+date: 2021-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -38,21 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A local JSON database for Ruby inspired by lowdb, using Rudash for easy
-  Hash traversal.
-email: maediprichard@gmailcom
+description: A local JSON database using Rudash for easy Hash traversal.
+email: maediprichard@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/adapters/Adapter.rb
-- lib/adapters/Sync.rb
+- lib/adapters/adapter.rb
+- lib/adapters/sync.rb
 - lib/rowdb.rb
 homepage: https://github.com/rowdb/rowdb
 licenses:
 - MPL-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -67,8 +66,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: A local JSON database.
 test_files: []

data/lib/adapters/Adapter.rb

@@ -1,7 +0,0 @@
-class Adapter
-
-  def initialize(source)
-    @source = source
-  end
-
-end

data/lib/adapters/Sync.rb

@@ -1,39 +0,0 @@
-require 'oj'
-require_relative 'Adapter.rb'
-
-##
-# Synchronous file system.
-##
-class Sync < Adapter
-
-  ##
-  # Load a JSON string from a file.
-  #
-  # @return Hash data
-  ##
-  def read()
-
-    json = Oj.load_file(@source)
-
-    unless json.nil?
-      data = Oj.load(json)
-      return data.transform_keys(&:to_sym)
-    end
-
-    return nil
-
-  end
-
-  ##
-  # Save a Hash to a file as JSON.
-  #
-  # @param Hash data
-  ##
-  def write(data)
-
-    json = Oj.dump(data, mode: :compat)
-    Oj.to_file(@source, json)
-
-  end
-
-end