aro 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 682703a5e353fa13a2f91f36a0c6fbd40d374a353f299fcf8a8c3798e7c9db52
-  data.tar.gz: bcda82c4f2258058b4b068c7870db95877860462e6bf847eb82531141671f117
+  metadata.gz: a276927c911f1781041e6d5c274c1611f0a23a948edb9b0fb6bc17518d22eee5
+  data.tar.gz: 415a4ad29297c5c8815127fb4bae7c5dc97f4f8eb12cda4aacf2235997cb895e
 SHA512:
-  metadata.gz: 0027f44c6addc94631040f867814e184ce4ac8ad60c6cb1c8db67ae0722bd2170f77694f3613381c86071525c6b0cc7b4dc780481a8e19818d05af0e622dc1b3
-  data.tar.gz: 0c1385bea70f6e4b0d4ea715d09ba1eca90e90d30a45d948faf5a00c097c8ad352aed0abb2ebeff42e45d5fecd4768c31dfd224d8f42106936689840639520df
+  metadata.gz: a91cb814964c27d4aa6c53aea311dc530ecd897d4534f19b3295ad8954c7611268102b8113dc4ecaea52d23fb975dbf890bcfbcfc575727741c497942f3ea36f
+  data.tar.gz: b8270db12a879b8738d014f748929641d234234f61cbba5cc351907319d5616bfef2ae1f58616827930673703258841c2ee6c70d732ab247ae87941cf1bf0073

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+.aro
+.aro_test
+.name
+*.sql
+*.log

data/.release

@@ -0,0 +1,20 @@
+# helper script for consistency when doing releases
+
+# start on latest develop branch
+
+# 1) update version and release notes (manually)
+# 2) test and build
+#     $ rake make
+# 3) build checksum
+#     $ rake build:checksum 
+# 4) create a commit
+# 5) generate tag
+#     tag message format:
+#       vx.x.x
+#       <release_note_text>
+#     $ gitaga vx.x.x && gush tag vx.x.x
+# 6) push develop
+# 7) pull request develop -> master & merge
+# 8) checkout and pull master
+# 9) publish to rubygems
+#     $ gem push pkg/aro-x.x.x.gem

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.4.7

data/Gemfile

@@ -0,0 +1,5 @@
+source :"https://rubygems.org".to_s
+gemspec
+
+# do not modify
+# add dependencies to the gemspec

data/Gemfile.lock

@@ -0,0 +1,105 @@
+PATH
+  remote: .
+  specs:
+    aro (0.1.3)
+      activerecord (~> 8.1, >= 8.1.1)
+      i18n (~> 1.14, >= 1.14.7)
+      sqlite3 (~> 2.8, >= 2.8.0)
+      tty-prompt (~> 0.23.1, >= 0.23.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (8.1.1)
+      activesupport (= 8.1.1)
+    activerecord (8.1.1)
+      activemodel (= 8.1.1)
+      activesupport (= 8.1.1)
+      timeout (>= 0.4.0)
+    activesupport (8.1.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    base64 (0.3.0)
+    bigdecimal (3.3.1)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.4)
+    diff-lcs (1.6.2)
+    drb (2.2.3)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    json (2.16.0)
+    logger (1.7.0)
+    minitest (5.26.1)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    rake (13.3.1)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.7)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.6)
+    securerandom (0.4.1)
+    sqlite3 (2.8.0-aarch64-linux-gnu)
+    sqlite3 (2.8.0-aarch64-linux-musl)
+    sqlite3 (2.8.0-arm-linux-gnu)
+    sqlite3 (2.8.0-arm-linux-musl)
+    sqlite3 (2.8.0-arm64-darwin)
+    sqlite3 (2.8.0-x86-linux-gnu)
+    sqlite3 (2.8.0-x86-linux-musl)
+    sqlite3 (2.8.0-x86_64-darwin)
+    sqlite3 (2.8.0-x86_64-linux-gnu)
+    sqlite3 (2.8.0-x86_64-linux-musl)
+    timeout (0.4.4)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    uri (1.1.1)
+    wisper (2.0.1)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  aro!
+  bundler (~> 2.7, >= 2.7.2)
+  rake (~> 13.3, >= 13.3.1)
+  rspec (~> 3.13, >= 3.13.2)
+
+BUNDLED WITH
+   2.7.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (C) 2025 Scot Reichman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this
+software and associated documentation files (the “Software”), to deal in the Software
+without restriction, including without limitation the rights to use, copy, modify,
+merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be included in all copies
+or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
+OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,70 @@
+# aro
+>__a cli for tarot__ - follow the way of the aro eht.
+
+##### __current version:__
+[![Gem Version](https://badge.fury.io/rb/aro.svg)](https://badge.fury.io/rb/aro)
+
+aro is a command line interface that allows you to manage multiple tarot decks.
+
+
+### install
+
+```bash
+$ gem install aro
+```
+
+### use
+
+```bash
+$ aro -h
+```
+
+[usage documentation](https://raw.githubusercontent.com/i2097i/aro/refs/heads/master/locale/en.usage.yml)
+
+
+[card definitions](https://raw.githubusercontent.com/i2097i/aro/refs/heads/master/locale/en.cards.yml)
+
+
+### develop
+
+[rubygems.org guides](https://guides.rubygems.org)
+
+```ruby
+# the Rakefile contains bundler's gem_tasks,
+# which are used for gem development.
+
+# Rakefile
+require "bundler/gem_tasks"
+```
+
+```bash
+# list tasks
+$ rake --tasks
+
+# build gem
+$ rake build
+
+# build and install
+$ rake install
+```
+
+### test
+
+```bash
+$ rspec
+```
+
+#### pre-commit hook:
+```bash
+: cat .git/hooks/pre-commit
+#!/bin/sh
+
+echo "running pre-commit hooks"
+echo "exec rspec -f d -o ./spec/spec.log"
+exec rspec -f d -o ./spec/spec.log
+```
+
+[license](http://opensource.org/licenses/MIT)
+[issues](https://github.com/i2097i/aro/issues)
+
+>aro by i2097i is copyright (2025)

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+task :default => :rspec
+
+Rake.add_rakelib :"tasks".to_s

data/aro.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+
+require :aro.to_s
+
+Gem::Specification.new do |spec|
+  spec.name          = "aro"
+  spec.version       = Aro::VERSION
+  spec.authors       = ["i2097i"]
+  spec.email         = ["i2097i@hotmail.com"]
+  spec.description   = "a cli for tarot."
+  spec.summary       = "follow the way of the aro eht."
+  spec.homepage      = "https://github.com/i2097i/aro"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split("\n").reject{|f| f.match(%r{^(spec)/})}
+  spec.bindir        = "bin"
+  spec.executables   = ["aro"]
+  spec.require_paths = ["lib", "bin/cli"]
+
+  # development gems
+  spec.add_development_dependency "bundler",      "~> 2.7", ">= 2.7.2"
+  spec.add_development_dependency "rake",         "~> 13.3", ">= 13.3.1"
+  spec.add_development_dependency "rspec",        "~> 3.13", ">= 3.13.2"
+
+  # runtime gems
+  spec.add_runtime_dependency     "i18n",         "~> 1.14", ">= 1.14.7"
+  spec.add_runtime_dependency     "activerecord", "~> 8.1", ">= 8.1.1"
+  spec.add_runtime_dependency     "sqlite3",      "~> 2.8", ">= 2.8.0"
+  spec.add_runtime_dependency     "tty-prompt",   "~> 0.23.1", ">= 0.23.1"
+end

data/bin/aro

@@ -10,50 +10,20 @@
 
 =end
 
-require :aro.to_s
-[
-  :cli,
-].each do |dir|
-  Dir[
-    File.join(
-      __dir__,
-      dir.to_s,
-      :"**/*.rb".to_s
-    )
-  ].each { |file| require file}
-end
-
-# set environment variable
-ENV[:ARO_ENV.to_s] = :production.to_s
-# ENV[:ARO_ENV.to_s] = :development.to_s
+require_relative :cli.to_s
 
 # todo: add tab completion using abbrev gem
 # https://stackoverflow.com/a/11627931
 
-# todo: response formats 
-# text (default)
-# json
-# 
-
 module CLI
-  
-  if CLI::LOAD_DECK_ACTIONS.keys.map{|k| k.downcase.to_sym}.include?(ARGV[0]&.to_sym)
-    # enable deck shortcut (skip typing deck while in-game)
-    ARGV0 = :deck
-    ARGV1 = ARGV[0]&.to_sym
-    ARGV2 = ARGV[1]&.to_sym
-  else
-    # default
-    ARGV0 = ARGV[0]&.to_sym
-    ARGV1 = ARGV[1]&.to_sym
-    ARGV2 = ARGV[2]&.to_sym
-  end
-
   if CLI::FLAGS[:VERSION].include?(CLI::ARGV0)
-    Aro::P.p.say(Aro::VERSION)
+    Aro::P.say(Aro::VERSION)
     exit(CLI::EXIT_CODES[:SUCCESS])
   end
 
+  # initialize config
+  CLI::Config.instance
+
   # cli parser
   case CLI::ARGV0
   when :create
@@ -62,7 +32,7 @@ module CLI
     CLI::deck
   else
     unless Aro::Mancy.game.nil? || CLI::FLAGS[:HELP].include?(CLI::ARGV0)
-      Aro::P.p.say(I18n.t("cli.messages.welcome", name: "#{Aro::Mancy.name}.game.show"))
+      Aro::P.say(I18n.t("cli.messages.welcome", name: "#{Aro::Mancy.name}.game.show"))
       Aro::Mancy.game.show
       exit(CLI::EXIT_CODES[:SUCCESS])
     end
@@ -70,5 +40,5 @@ module CLI
     CLI::usage
     exit(CLI::EXIT_CODES[:SUCCESS])
   end
-  
+
 end

data/bin/cli/config.rb

@@ -0,0 +1,223 @@
+module CLI
+  class Config
+    include Singleton
+
+    VAR_PREFIX = :ARO_CONFIG_
+
+    CONFIG_FILE = :".config".to_s
+    CONFIG_FILE_PATH = "#{Aro::Db.base_aro_dir(Aro::Db.get_name_from_namefile)}/#{CLI::Config::CONFIG_FILE}"
+
+    INTS = {
+      O:       0,
+      I:       1,
+      VII:     7,
+      XXII:    22,
+      MMXCVII: Aro::Mancy::I2097I[1..4].to_i,
+    }
+
+    # possible formats
+    # 
+    # example usage:
+    # CLI::Config::FORMATS[:TEXT]
+    FORMATS = {
+      TEXT: :text,
+      JSON: :json,
+    }
+
+    # possible dimensions
+    # 
+    # example usage:
+    # CLI::Config::DMS[:DEV_TAROT]
+    DMS = {
+      DEV_TAROT: :dev_tarot,
+      RUBY_FACOT: :ruby_facot,
+    }
+
+    # types used in definition
+    # 
+    # example usage:
+    # CLI::Config::DEF_TYPES[:INT][:validator].call(unvalid, CLI::Config::DEF[:DIMENSION])
+    DEF_TYPES = {
+      INT: {
+        name: :int,
+        description: I18n.t("cli.config.type_int_description"),
+        validator: Proc.new{|unvalid, deff, key|
+          CLI::Config.def_valid?(deff, key) &&
+          CLI::Config.int_valid?(unvalid)   &&
+          unvalid.to_i <= deff[:min]        &&
+          unvalid.to_i >= deff[:max]
+        }
+      },
+      VALUES: {
+        name: :values,
+        description: I18n.t("cli.config.type_values_description"),
+        validator: Proc.new{|unvalid, deff, key|
+          CLI::Config.def_valid?(deff, key) &&
+          deff[:possible_values].keys.include?(unvalid.to_sym)
+        }
+      },
+    }
+
+    # adapts I18n translations to generate bash environment vars.
+    # 
+    # example usage:
+    # CLI::Config::DEF[:Z_MAX]
+    DEF = {
+      FORMAT: {
+        type: :values,
+        description: I18n.t(
+          "cli.config.format_description",
+          possible_values: CLI::Config::FORMATS.values.join(", ")
+        ),
+        value: :text,
+        possible_values: {
+          text: I18n.t("cli.config.text_format_description"),
+          json: I18n.t("cli.config.json_format_description")
+        }
+      },
+      DIMENSION: {
+        type: :values,
+        description: I18n.t(
+          "cli.config.dimension_description",
+          possible_values: CLI::Config::DMS.values.join(", ")
+         ),
+        value: :dev_tarot,
+        possible_values: {
+          dev_tarot: I18n.t("cli.config.dimension_dev_tarot_description"),
+          ruby_facot: I18n.t("cli.config.dimension_ruby_facot_description"),
+        }
+      },
+      # not implemented. replace Aro::Deck::DRAW_COUNT with this
+      # DRAW_COUNT: {
+      #   type: :int,
+      #   description: I18n.t(
+      #     "cli.config.draw_count_description",
+      #     min: CLI::Config::INTS[:I],
+      #     max: CLI::Config::INTS[:XXII],
+      #   ),
+      #   value: CLI::Config::INTS[:VII],
+      #   min: CLI::Config::INTS[:I],
+      #   max: CLI::Config::INTS[:XXII],
+      # },
+      Z: {
+        type: :int,
+        description: I18n.t(
+          "cli.config.z_description",
+          min: CLI::Config::INTS[:I],
+          max: CLI::Config::INTS[:MMXCVII],
+        ),
+        value: CLI::Config::INTS[:I],
+        min: CLI::Config::INTS[:I],
+        max: CLI::Config::INTS[:MMXCVII],
+      },
+      Z_MAX: {
+        type: :int,
+        description: I18n.t(
+          "cli.config.z_max_description",
+          min: CLI::Config::INTS[:I],
+          max: CLI::Config::INTS[:XXII],
+        ),
+        value: CLI::Config::INTS[:VII],
+        min: CLI::Config::INTS[:I],
+        max: CLI::Config::INTS[:XXII],
+      },
+
+      # ...
+    }
+
+    def generate_config
+      # todo: localize generated config text
+      Aro::P.say(I18n.t("cli.config.generating_default_config", name: CLI::Config::CONFIG_FILE_PATH))
+      File.open(CLI::Config::CONFIG_FILE_PATH, "w+") do |file|
+        file.write("# #{Aro::Mancy::PS1} configuration file.\n")
+        file.write("# this file was auto generated by the aro cli.\n")
+        Aro::Mancy::OS.times do
+          file.write("#\n")
+        end
+        file.write("# CLI::Config::DEF_TYPES\n")
+        file.write("# describes the possible types of variables.\n")
+        CLI::Config::DEF_TYPES.each{|k, v|
+          file.write("# #{k}: #{v[:description]}\n")
+        }
+        Aro::Mancy::OS.times do
+          file.write("#\n")
+        end
+        file.write("# CLI::Config::DEF\n")
+        file.write("# define & expose an aro bash api via ENV variables.\n")
+        file.write("# modifying them in this file will change aro's behavior.\n")
+        Aro::Mancy::OS.times do
+          file.write("#\n")
+        end
+        CLI::Config::DEF.each{|k, v|
+          var_name = CLI::Config.var_key_with_suffix(k)
+          file.write("# [#{var_name}]\n")
+          file.write("#   => #{I18n.t("cli.config.def_type")}: #{v[:type]}\n")
+          case v[:type]
+          when CLI::Config::DEF_TYPES[:INT][:name]
+            file.write("#   => #{I18n.t("cli.config.minimum")}: #{v[:min]}\n")
+            file.write("#   => #{I18n.t("cli.config.maximum")}: #{v[:max]}\n")
+          when CLI::Config::DEF_TYPES[:VALUES][:name]
+            file.write("#   => #{I18n.t("cli.config.possible_values")}:\n")
+            v[:possible_values].each{|name, description|
+              file.write("#   => #{name} - #{description}\n")
+            }
+          end
+          file.write("export #{var_name}=#{v[:value]}\n\n")
+        }
+        file.write("\n")
+      end
+    end
+
+    def initialize
+      return unless Aro::Mancy.is_aro_dir?
+      unless File.exist?(CLI::Config::CONFIG_FILE_PATH)
+        generate_config
+      end
+
+      source_config
+    end
+
+    def self.def_valid?(deff, key)
+      deff == CLI::Config::DEF[key]
+    end
+
+    def self.int_valid?(unvalid)
+      return !unvalid.nil? && (
+        unvalid.kind_of?(Integer) ||
+        ("0" != unvalid && unvalid.respond_to?(:to_i))
+      )
+    end
+
+    def self.var_value_with_suffix(suffix)
+      ENV[CLI::Config.var_key_with_suffix(suffix)]
+    end
+
+    def self.var_key_with_suffix(suffix)
+      "#{CLI::Config::VAR_PREFIX}#{suffix}"
+    end
+
+    def source_config
+      invalid_defs = validate_config
+      Aro::P.say(I18n.t("cli.config.sourcing_config", name: CLI::Config::CONFIG_FILE_PATH))
+      system("source #{CLI::Config::CONFIG_FILE_PATH}")
+      CLI::Config::DEF.keys.each{|dfk|
+        next if invalid_defs.include?(dfk)
+        Aro::P.say("$#{CLI::Config.var_key_with_suffix(dfk)}=#{CLI::Config.var_value_with_suffix(dfk)}")
+      }
+
+      # todo: set all invalid_refs to default in ENV
+    end
+
+    def validate_config
+      invalid_defs = []
+      CLI::Config::DEF.each{|k, v|
+        var_value = CLI::Config.var_value_with_suffix(k)
+        is_valid = CLI::Config::DEF_TYPES[v[:type].to_s.upcase.to_sym][:validator]
+          .call(var_value, v, k)
+        invalid_defs << k unless is_valid
+      }
+      invalid_defs
+    end
+
+  end
+end

data/bin/cli/constants.rb

@@ -11,8 +11,10 @@
 module CLI
 
   FLAGS = {
-    HELP:     [:"-h", :"--help"],
-    VERSION:  [:"-v", :"--version"],
+    HELP:         [:"-h", :"--help"],
+    SHOW_COUNT:   [:"-n", :"--count"],
+    SHOW_ORDER:   [:"-o", :"--order"],
+    VERSION:      [:"-v", :"--version"],
   }
 
   EXIT_CODES = {

data/bin/cli/create.rb

@@ -10,8 +10,13 @@
 
 module CLI
   def self.create
-    name = CLI::ARGV1.to_s || I18n.t("cli.messages.invalid_name")
-    Aro::P.p.say(I18n.t("cli.messages.creation_attempt", name: name))
-    Aro::Create.new(name)
+    CLI::Aroface.exit_error_missing_args! if CLI::ARGV1.nil?
+    name = CLI::ARGV1&.to_s
+    Aro::P.say(I18n.t("cli.messages.creation_attempt", name: name))
+    if Aro::Create.new(name).initialized
+      Aro::P.say(I18n.t("cli.messages.creation_success", name: name))
+    else
+      Aro::P.say(I18n.t("cli.messages.creation_failure", name: name))
+    end
   end
 end