shashi 0.1.0

data/lib/shashi.rb

@@ -0,0 +1,7 @@
+require "shashi/version"
+require "shashi/utils"
+require "shashi/cli"
+require "shashi/command"
+
+module Shashi
+end

data/lib/shashi/cli.rb

@@ -0,0 +1,121 @@
+require "optparse"
+
+module Shashi
+  module CLI
+
+    def self.perform(options:)
+      arguments = {
+        file: "./shashi__db.json",
+        path: [],
+        force: false,
+        echo: true,
+        deep: false,
+        index: nil,
+        count: 1,
+      }
+
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: shashi [options]"
+
+        opts.on("--setup", "Creates the storage file with an empty set.") do
+          arguments[:command] = :setup
+        end
+
+        opts.on("--file FILE", "Uses FILE as the desired file path for the storage. Defaults to `./shashi__db.json`.") do |file|
+          arguments[:file] = file
+        end
+
+        opts.on("--path PATH", "`PATH := List<KEY>[separator:.]`. Address the document's item by chaining a list of keys. For example: `key1.key2.key3`.") do |path|
+          arguments[:path] = path.split(".")
+        end
+
+        opts.on("--create-set NAME", "Creates an empty set. Asks for confirmation if the key NAME already exists.") do |name|
+          arguments[:command] = :create_set
+          arguments[:set_name] = name
+        end
+
+        opts.on("--set KEY:VALUE", "Sets the KEY to VALUE. Asks for confirmation if the key NAME already exists. If no VALUE is given, prompts for it.") do |pair|
+          arguments[:command] = :set_set
+          arguments[:key], arguments[:value] = pair.split(":")
+        end
+
+        opts.on("--show KEYS", "`KEYS := List<KEY>[separator:,]`. Shows the values associated with keys but not the content of sets/lists. For example: `name,e-mail`.") do |keys|
+          arguments[:command] = :show_keys
+          arguments[:keys] = keys.split(",")
+        end
+
+        opts.on("--delete KEY", "Deletes the item. Asks for confirmation if it's a non-empty set or list.") do |key|
+          arguments[:command] = :delete
+          arguments[:key] = key
+        end
+
+        opts.on("--create-list NAME", "Creates an empty list. Asks for confirmation if the key NAME already exists.") do |name|
+          arguments[:command] = :create_list
+          arguments[:list_name] = name
+        end
+
+        opts.on("--index INDEX", Integer, "`INDEX := (Integer >= 0)`. References the n-th element of a list. Defaults to the size of the list (ie: the last element).") do |index|
+          arguments[:index] = index
+        end
+
+        opts.on("--count COUNT", Integer, "`COUNT := (Integer > 0), defaults to 1`.") do |count|
+          arguments[:count] = count
+        end
+
+        opts.on("--list-push VALUES", "`VALUES := List<VALUE>[separator:,]`. Push VALUES into a list.") do |values|
+          arguments[:command] = :list_push
+          arguments[:values] = values.split(",")
+        end
+
+        opts.on("--list-show", "Shows `COUNT` elements of a list, starting from `INDEX`.") do
+          arguments[:command] = :list_show
+        end
+
+        opts.on("--list-delete", "Deletes `COUNT` elements from a list, starting from `INDEX`.") do
+          arguments[:command] = :list_delete
+        end
+
+        opts.on("--deep", "Shows the values associated with KEYS (recursively) even if they contain sets or lists.") do
+          arguments[:deep] = true
+        end
+
+        opts.on("--no-echo", "When prompted for a value, doesn't show it while typing.") do
+          arguments[:echo] = false
+        end
+
+        opts.on("--force", "Doesn't ask for confirmation.") do
+          arguments[:force] = true
+        end
+
+        opts.on("-h", "--help", "Prints this help") do
+          puts opts
+          exit
+        end
+      end
+
+      opt_parser.parse!(options)
+
+      if Utils.blank?(arguments[:command])
+        puts opt_parser
+        exit 1
+      end
+
+      if arguments[:index] && arguments[:index] < 0
+        puts "`INDEX` must be greater than or equal to 0."
+        puts opt_parser
+        exit 1
+      end
+
+      if arguments[:count] <= 0
+        puts "`COUNT` must be greater than 0."
+        puts opt_parser
+        exit 1
+      end
+
+      arguments[:file] = File.expand_path(arguments[:file])
+
+      Command.perform(arguments: arguments)
+    end
+
+  end
+end

data/lib/shashi/command.rb

@@ -0,0 +1,83 @@
+require_relative "command/setup"
+require_relative "command/create_set"
+require_relative "command/set_set"
+require_relative "command/show_keys"
+require_relative "command/set_delete"
+require_relative "command/create_list"
+require_relative "command/list_push"
+require_relative "command/list_show"
+require_relative "command/list_delete"
+
+module Shashi
+  module Command
+
+    def self.perform(arguments:)
+      case arguments[:command]
+      when :setup
+        Setup.perform(file: arguments[:file])
+      when :create_set
+        CreateSet.perform(
+          file: arguments[:file],
+          path: arguments[:path],
+          set_name: arguments[:set_name],
+          force: arguments[:force]
+        )
+      when :set_set
+        SetSet.perform(
+          file: arguments[:file],
+          path: arguments[:path],
+          key: arguments[:key],
+          value: arguments[:value],
+          force: arguments[:force],
+          echo: arguments[:echo]
+        )
+      when :show_keys
+        ShowKeys.perform(
+          file: arguments[:file],
+          path: arguments[:path],
+          keys: arguments[:keys],
+          deep: arguments[:deep],
+        )
+      when :delete
+        SetDelete.perform(
+          file: arguments[:file],
+          path: arguments[:path],
+          key: arguments[:key],
+          force: arguments[:force],
+        )
+      when :create_list
+        CreateList.perform(
+          file: arguments[:file],
+          path: arguments[:path],
+          list_name: arguments[:list_name],
+          force: arguments[:force]
+        )
+      when :list_push
+        ListPush.perform(
+          file: arguments[:file],
+          path: arguments[:path],
+          values: arguments[:values],
+          index: arguments[:index]
+        )
+      when :list_show
+        ListShow.perform(
+          file: arguments[:file],
+          path: arguments[:path],
+          index: arguments[:index],
+          count: arguments[:count]
+        )
+      when :list_delete
+        ListDelete.perform(
+          file: arguments[:file],
+          path: arguments[:path],
+          index: arguments[:index],
+          count: arguments[:count]
+        )
+      else
+        puts "Command `#{arguments[:command]}` is not recognized."
+        exit 1
+      end
+    end
+
+  end
+end

data/lib/shashi/command/create_list.rb

@@ -0,0 +1,39 @@
+module Shashi
+  module Command
+    module CreateList
+
+      def self.perform(file:, path:, list_name:, force:)
+        data = Utils::Database.read_database(file: file)
+        data_reference = Utils::Data.walk(data: data, path: path)
+        if data_reference.has_key?(list_name)
+          if force
+            update_data(file: file, data: data, data_reference: data_reference, list_name: list_name)
+          else
+            print "The key #{list_name} already exists at #{path.join(".")}, overwrite? [y/N] "
+            choice = gets
+            case choice.strip
+            when "y"
+              update_data(file: file, data: data, data_reference: data_reference, list_name: list_name)
+            when ""
+              # do nothing
+            when "N"
+              # do nothing
+            else
+              puts "Choice not understood, ignoring."
+            end
+          end
+        else
+          update_data(file: file, data: data, data_reference: data_reference, list_name: list_name)
+        end
+      end
+
+      private
+
+        def self.update_data(file:, data:, data_reference:, list_name:)
+          data_reference[list_name] = []
+          Utils::Database.write_database(file: file, data: data)
+        end
+
+    end
+  end
+end

data/lib/shashi/command/create_set.rb

@@ -0,0 +1,39 @@
+module Shashi
+  module Command
+    module CreateSet
+
+      def self.perform(file:, path:, set_name:, force:)
+        data = Utils::Database.read_database(file: file)
+        data_reference = Utils::Data.walk(data: data, path: path)
+        if data_reference.has_key?(set_name)
+          if force
+            update_data(file: file, data: data, data_reference: data_reference, set_name: set_name)
+          else
+            print "The key #{set_name} already exists at #{path.join(".")}, overwrite? [y/N] "
+            choice = gets
+            case choice.strip
+            when "y"
+              update_data(file: file, data: data, data_reference: data_reference, set_name: set_name)
+            when ""
+              # do nothing
+            when "N"
+              # do nothing
+            else
+              puts "Choice not understood, ignoring."
+            end
+          end
+        else
+          update_data(file: file, data: data, data_reference: data_reference, set_name: set_name)
+        end
+      end
+
+      private
+
+        def self.update_data(file:, data:, data_reference:, set_name:)
+          data_reference[set_name] = {}
+          Utils::Database.write_database(file: file, data: data)
+        end
+
+    end
+  end
+end

data/lib/shashi/command/list_delete.rb

@@ -0,0 +1,33 @@
+module Shashi
+  module Command
+    module ListDelete
+
+      def self.perform(file:, path:, index: 0, count: 1)
+        data = Utils::Database.read_database(file: file)
+        data_reference = Utils::Data.walk(data: data, path: path)
+        if Utils::Data.is_list?(data_reference)
+          if index
+            if data_reference.count <= index
+              puts "The index `#{index}` is too high, the highest possible index for this list is currently `#{data_reference.count - 1}`."
+              exit 1
+            end
+            if data_reference.count < index + count
+              puts "Starting from index `#{index}` you can delete to a maximum of `#{data_reference.count - index}`."
+              exit 1
+            end
+          else
+            index = 0;
+          end
+          data_reference.reject!.with_index do |value, i|
+            i >= index && i < index + count
+          end
+          Utils::Database.write_database(file: file, data: data)
+        else
+          puts "Path `#{path.join(".")}` doesn't lead to a list."
+          exit 1
+        end
+      end
+
+    end
+  end
+end

data/lib/shashi/command/list_push.rb

@@ -0,0 +1,27 @@
+module Shashi
+  module Command
+    module ListPush
+
+      def self.perform(file:, path:, values: [], index: -1)
+        data = Utils::Database.read_database(file: file)
+        data_reference = Utils::Data.walk(data: data, path: path)
+        if Utils::Data.is_list?(data_reference)
+          if index
+            if data_reference.count <= index
+              puts "The index `#{index}` is too high, the highest possible index for this list is currently `#{data_reference.count - 1}`."
+              exit 1
+            end
+          else
+            index = -1;
+          end
+          data_reference.insert(index, *values)
+          Utils::Database.write_database(file: file, data: data)
+        else
+          puts "Path `#{path.join(".")}` doesn't lead to a list."
+          exit 1
+        end
+      end
+
+    end
+  end
+end

data/lib/shashi/command/list_show.rb

@@ -0,0 +1,45 @@
+module Shashi
+  module Command
+    module ListShow
+
+      def self.perform(file:, path:, index: 0, count: 1)
+        data = Utils::Database.read_database(file: file)
+        data_reference = Utils::Data.walk(data: data, path: path)
+        if Utils::Data.is_list?(data_reference)
+          if index
+            if data_reference.count <= index
+              puts "The index `#{index}` is too high, the highest possible index for this list is currently `#{data_reference.count - 1}`."
+              exit 1
+            end
+            if data_reference.count < index + count
+              puts "Starting from index `#{index}` you can access to a maximum of `#{data_reference.count - index}`."
+              exit 1
+            end
+          else
+            index = 0;
+          end
+          range_string = if index == index + count - 1
+            index
+          else
+            "#{index}-#{index + count}"
+          end
+          puts "`#{path.join(".")}`[#{range_string}]:"
+          data_reference[index..(index + count - 1)].each do |item|
+            content = if Utils::Data.is_list?(item)
+              "#List#"
+            elsif Utils::Data.is_set?(item)
+              "#Set#"
+            else
+              item
+            end
+            puts "- #{content}"
+          end
+        else
+          puts "Path `#{path.join(".")}` doesn't lead to a list."
+          exit 1
+        end
+      end
+
+    end
+  end
+end

data/lib/shashi/command/set_delete.rb

@@ -0,0 +1,57 @@
+module Shashi
+  module Command
+    module SetDelete
+
+      def self.perform(file:, path:, key:, force:)
+        data = Utils::Database.read_database(file: file)
+        data_reference = Utils::Data.walk(data: data, path: path)
+        if data_reference.has_key?(key)
+          if force
+            update_data(file: file, data: data, data_reference: data_reference, key: key)
+          else
+            value = data_reference[key]
+            if Utils::Data.is_list?(value)
+              if confirms_deletion?(key: key, path: path, value_type: "#List#")
+                update_data(file: file, data: data, data_reference: data_reference, key: key)
+              end
+            elsif Utils::Data.is_set?(value)
+              if confirms_deletion?(key: key, path: path, value_type: "#Set#")
+                update_data(file: file, data: data, data_reference: data_reference, key: key)
+              end
+            else
+              update_data(file: file, data: data, data_reference: data_reference, key: key)
+            end
+          end
+        else
+          puts "There is no key `#{key}` at `#{path.join(".")}`"
+        end
+      end
+
+      private
+
+        def self.confirms_deletion?(key:, path:, value_type:)
+          print "The key `#{key}` at `#{path.join(".")}` contains a `#{value_type}`, confirm deletion? [y/N] "
+          choice = gets.strip
+          case choice
+          when "y"
+            true
+          when ""
+            # do nothing
+            false
+          when "N"
+            # do nothing
+            false
+          else
+            puts "Choice not understood, ignoring."
+            false
+          end
+        end
+
+        def self.update_data(file:, data:, data_reference:, key:)
+          data_reference.delete(key)
+          Utils::Database.write_database(file: file, data: data)
+        end
+
+    end
+  end
+end